fix: navigation bar color management by kirillzyusko · Pull Request #51956 · Expensify/App

kirillzyusko · 2024-11-04T14:28:35Z

Explanation of Change

Previously we didn't specify navigationBarColor at all. It was working well on some devices such as Pixel that manages navigationBarColor in a consistent way (on Pixel devices this navigationBar will be always dark, no matter which device theme is set).

However some device manufacturers are managing it differently, for example Samsung - they make navigationBar to match the color of the device theme (i. e. it will be white if device theme is "light", and will be black if device theme is "dark"). While it sounds pretty logical it produces conflicts in Expensify app: if device theme is "light" but user selected "dark" theme in Expensify app, then the app will be shown in dark mode, but navigation bar will be white. This is exactly what we got in: #51673

From above it's clear, that we should manage navigationBarColor inside the app and don't rely on default OS management as it may vary depending on manufacturers.

This is what this PR brings. Mainly it affects 3 areas (to match closely to iOS):

when splash screen is shown, then navigationBar color should match splash screen color (i. e. to be green);
login page should always have dark navigationBar (since this screen supports only dark theme);
when user is logged in, then we should manage navigationBar color depending on theme.

To achieve first item (and partially second) I changed styles.xml for SplashScreen theme and added default navigationBar color as #000.

To change color in runtime we need to use additional libs. Mainly I was considering two variants:

react-native-navigation-bar-color - was a pretty popular package back in times, but at the moment doesn't receive constant updates, popularity is moving down, most likely this package doesn't support Fabric/bridgeless mode etc.
expo-navigation-bar - offers extended API, has 40k weekly downloads (4x more popular than a previous lib), has Fabric support, constantly receives updates.

So the choice was pretty obvious - I chose expo-navigation-bar (we probably need to open an issue for new library).

Fixed Issues

$ #51673
PROPOSAL: N/A

Tests

Perform tests at least on two platforms, for example Android 9 (old and popular) and Android 14 (new and popular).

open app and be sure navigation bar color is green
be sure login page is opened with dark navigation bar
login into app and be sure navigation bar has the same theme as main app
go to settings -> preferences -> theme and toggle all themes. Be sure that nav bar color is the same as main app
log out and be sure navigation bar color is dark

Offline tests

N/A

QA Steps

Perform tests at least on two platforms, for example Android 9 (old and popular) and Android 14 (new and popular).

open app and be sure navigation bar color is green
be sure login page is opened with dark navigation bar
login into app and be sure navigation bar has the same theme as main app
go to settings -> preferences -> theme and toggle all themes. Be sure that nav bar color is the same as main app
log out and be sure navigation bar color is dark

Highly desirable to test at least one Samsung (new and popular) device. I tested on S21 Ultra with Android 14.

PR Author Checklist

Screenshots/Videos

Android: Native

telegram-cloud-document-2-5280970699148649310.mp4

Screen.Recording.2024-11-04.at.16.44.26.mov

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

melvin-bot · 2024-11-04T14:28:41Z

@mananjadhav Please copy/paste the Reviewer Checklist from here into a new comment on this PR and complete it. If you have the K2 extension, you can simply click: [this button]

kirillzyusko · 2024-11-04T14:33:41Z

Opened an issue with library review here: #51957

shawnborton · 2024-11-04T14:35:57Z

android/app/src/main/res/values/styles.xml

        <item name="popupTheme">@style/AppTheme.Popup</item>
        <item name="android:spinnerDropDownItemStyle">@style/TextViewSpinnerDropDownItem</item>
        <item name="android:alertDialogTheme">@style/AlertDialogTheme</item>
+        <item name="android:navigationBarColor">@color/black</item>


Just curious, at what point do we want black and why?

@kirillzyusko can you confirm ?

This is just by default to override all automatic OS color manipulations 🙃

But this color is used on login page - do you want to choose a different one?

The reason why I decided that black is good enough is because below we have an illustration so monochromatic green color may look a little bit inconsistent.

Ah I got it. What do we use for the rest of the app when we are in dark mode?

@shawnborton productDark100 which is #061B09. And in light mode we use produceLight100 which is #FCFBF9

Okay @shawnborton
Let me re-work it and push new changes 👀

This is the diff between black and brand color:

Black productDark100

Nice, I think productDark100 looks great personally - cc @Expensify/design for a gut check here, but I say let's do that instead of black.

I'm into it too!

Same. Dig it

Cool, looks like everyone agree to use productDark100 - I pushed these changes, so this PR is ready for review then 😊

shawnborton · 2024-11-04T14:36:32Z

Not sure if you need a review from design or not but the video generally looks good to me. Pretty wild how slow the app seems though?

kirillzyusko · 2024-11-04T15:10:00Z

Pretty wild how slow the app seems though?

This is how the app runs on low end device in debug mode 🙈 In this case it's super slow 😅 But in release variant it's pretty fast for this old device!

Not sure if you need a review from design or not but the video generally looks good to me.

Well, if you can also download the app on Android and test it, then it would definitely help! ❤️

mananjadhav · 2024-11-04T15:23:38Z

@kirillzyusko most of the code looks good. Can you please check one of the pending author checklist item?

kirillzyusko · 2024-11-04T16:03:05Z

most of the code looks good. Can you please check one of the pending author checklist item?

@mananjadhav done 🙌

kirillzyusko · 2024-11-05T16:56:39Z

@mananjadhav would you mind to review this PR?

mananjadhav · 2024-11-05T17:32:11Z

Just finishing a deploy blocker and then getting to this.

kirillzyusko · 2024-11-08T09:17:32Z

@mananjadhav any updates here?..

mananjadhav · 2024-11-08T10:32:53Z

I was able to test it on Android 13 but but not on Android 9. I tried my emulator keeps crashing.

mananjadhav · 2024-11-08T10:40:42Z

Reviewer Checklist

I have verified the author checklist is complete (all boxes are checked off).
I verified the correct issue is linked in the ### Fixed Issues section above
I verified testing steps are clear and they cover the changes made in this PR
- I verified the steps for local testing are in the Tests section
- I verified the steps for Staging and/or Production testing are in the QA steps section
- I verified the steps cover any possible failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
- I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
I checked that screenshots or videos are included for tests on all platforms
I included screenshots or videos for tests on all platforms
I verified tests pass on all platforms & I tested again on:
- Android: Native
- Android: mWeb Chrome
- iOS: Native
- iOS: mWeb Safari
- MacOS: Chrome / Safari
- MacOS: Desktop
If there are any errors in the console that are unrelated to this PR, I either fixed them (preferred) or linked to where I reported them in Slack
I verified proper code patterns were followed (see Reviewing the code)
- I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick).
- I verified that comments were added to code that is not self explanatory
- I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
- I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
- I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
- I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
- I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
- I verified the JSDocs style guidelines (in STYLE.md) were followed
If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
I verified that this PR follows the guidelines as stated in the Review Guidelines
I verified other components that can be impacted by these changes have been tested, and I retested again (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar have been tested & I retested again)
I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
I verified any variables that can be defined as constants (ie. in CONST.js or at the top of the file that uses the constant) are defined as such
If a new component is created I verified that:
- A similar component doesn't exist in the codebase
- All props are defined accurately and each prop has a /** comment above it */
- The file is named correctly
- The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
- The only data being stored in the state is data necessary for rendering and nothing else
- For Class Components, any internal methods passed to components event handlers are bound to this properly so there are no scoping issues (i.e. for onClick={this.submit} the method this.submit should be bound to this in the constructor)
- Any internal methods bound to this are necessary to be bound (i.e. avoid this.submit = this.submit.bind(this); if this.submit is never passed to a component event handler like onClick)
- All JSX used for rendering exists in the render method
- The component has the minimum amount of code necessary for its purpose, and it is broken down into smaller components in order to separate concerns and functions
If any new file was added I verified that:
- The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
If a new CSS style is added I verified that:
- A similar style doesn't already exist
- The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(theme.componentBG)
If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
If the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
If the PR modifies the UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label and/or tagged @Expensify/design so the design team can review the changes.
If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.
I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Android: Native

android-nav-bar-2.mov

android-nav-bar-1.mov

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

mananjadhav

I tested this in a few recent versions but couldn't test it on Android 9.

mountiny

HOLDing this as we did not agree internally yet to use this library, instead, we would like to ideally just use only the piece of native code that handles the dynamic colours #51957 cc @jasperhuangg

mountiny · 2024-11-15T13:58:09Z

@kirillzyusko Should we put this PR on hold or close it as you will be able to reuse a lot of the code once edge-to-edge support is added?

kirillzyusko · 2024-11-15T14:14:28Z

Should we put this PR on hold or close it as you will be able to reuse a lot of the code once edge-to-edge support is added?

Let's close it in favour of #52392

kirillzyusko requested review from a team as code owners November 4, 2024 14:28

melvin-bot bot requested review from mananjadhav and removed request for a team November 4, 2024 14:28

shawnborton reviewed Nov 4, 2024

View reviewed changes

kirillzyusko added 2 commits November 4, 2024 16:27

fix: navigation bar management

dfef5a8

fix: navigation bar management

d646e9a

kirillzyusko force-pushed the fix/navigation-bar-management branch from dcfb3fe to d646e9a Compare November 4, 2024 15:28

fix: use product colors instead of black

2b8416a

kirillzyusko changed the title ~~fix: navigation bar management~~ fix: navigation bar color management Nov 7, 2024

mananjadhav approved these changes Nov 8, 2024

View reviewed changes

melvin-bot bot requested a review from mountiny November 8, 2024 10:47

mountiny assigned kirillzyusko Nov 8, 2024

mountiny requested changes Nov 8, 2024

View reviewed changes

kirillzyusko mentioned this pull request Nov 12, 2024

feat: edge-to-edge mode on Android #52392

Merged

47 tasks

kirillzyusko closed this Nov 15, 2024

Conversation

kirillzyusko commented Nov 4, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Explanation of Change

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Uh oh!

melvin-bot bot commented Nov 4, 2024

Uh oh!

kirillzyusko commented Nov 4, 2024

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

shawnborton commented Nov 4, 2024

Uh oh!

kirillzyusko commented Nov 4, 2024

Uh oh!

mananjadhav commented Nov 4, 2024

Uh oh!

kirillzyusko commented Nov 4, 2024

Uh oh!

kirillzyusko commented Nov 5, 2024

Uh oh!

mananjadhav commented Nov 5, 2024

Uh oh!

kirillzyusko commented Nov 8, 2024

Uh oh!

mananjadhav commented Nov 8, 2024

Uh oh!

mananjadhav commented Nov 8, 2024

Reviewer Checklist

Screenshots/Videos

Uh oh!

mananjadhav left a comment

Choose a reason for hiding this comment

Uh oh!

mountiny left a comment

Choose a reason for hiding this comment

Uh oh!

mountiny commented Nov 15, 2024

Uh oh!

kirillzyusko commented Nov 15, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

kirillzyusko commented Nov 4, 2024 •

edited

Loading