Skip to content

Nav/navigation md #229

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 1 commit into from
Jun 11, 2025
Merged

Nav/navigation md #229

merged 1 commit into from
Jun 11, 2025
+1,071 −114

Conversation

WojtekBoman
Copy link

Explanation of Change

Fixed Issues

$
PROPOSAL:

Tests

  • Verify that no errors appear in the JS console

Offline tests

QA Steps

// TODO: These must be filled out, or the issue title must include "[No QA]."

  • Verify that no errors appear in the JS console

PR Author Checklist

  • I linked the correct issue in the ### Fixed Issues section above
  • I wrote clear testing steps that cover the changes made in this PR
    • I added steps for local testing in the Tests section
    • I added steps for the expected offline behavior in the Offline steps section
    • I added steps for Staging and/or Production testing in the QA steps section
    • I added steps to cover 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 tested this PR with a High Traffic account against the staging or production API to ensure there are no regressions (e.g. long loading states that impact usability).
  • I included screenshots or videos for tests on all platforms
  • I ran the tests on all platforms & verified they passed on:
    • Android: Native
    • Android: mWeb Chrome
    • iOS: Native
    • iOS: mWeb Safari
    • MacOS: Chrome / Safari
    • MacOS: Desktop
  • I verified there are no console errors (if there's a console error not related to the PR, report it or open an issue for it to be fixed)
  • I verified there are no new alerts related to the canBeMissing param for useOnyx
  • I followed proper code patterns (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
      • If any non-english text was added/modified, I used JaimeGPT to get English > Spanish translation. I then posted it in #expensify-open-source and it was approved by an internal Expensify engineer. Link to Slack message:
    • 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 followed the guidelines as stated in the Review Guidelines
  • I tested other components that can be impacted by my changes (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar are working as expected)
  • 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.ts or at the top of the file that uses the constant) are defined as such
  • I verified that if a function's arguments changed that all usages have also been updated correctly
  • 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.
  • I added unit tests for any new feature or bug fix in this PR to help automatically prevent regressions in this user flow.
  • 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.

Screenshots/Videos

Android: Native
Android: mWeb Chrome
iOS: Native
iOS: mWeb Safari
MacOS: Chrome / Safari
MacOS: Desktop

@WojtekBoman WojtekBoman force-pushed the nav/navigation-md branch 2 times, most recently from a05c4a8 to 4cff415 Compare June 5, 2025 09:12
Kicu
Kicu requested changes Jun 5, 2025
View reviewed changes
Copy link
Member

@Kicu Kicu left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey very nice job, I know nobody likes to write docs but someone has to 😆 🚀

Since this is a lot of comments I tried to mark several as [nitpick] so feel free to ignore these if you don't agree - these are mostly my opinions.
As far as the rest, they fall mostly into 2 categories:

  • typos/grammar
  • too long sentences, some I think fall into the "run-on sentence" category I think.

One general comment is that sometimes I think we could use more md headings deeper inside the code (docs). I would suggest you "hoist" the nesting of whole doc 1 level up (so you could make ToC and every top level point a h1 (#) and then maybe you could use more heading below these.

As far as content I think this gives a great deep dive into how navigation works 👍
Good job

contributingGuides/NAVIGATION.md Outdated

- `Dismiss` - Closes any modals (outside the navigation hierarchy) or pops a nested stack of screens off returning the user to the previous screen in the main stack.
`Navigation.navigate` is used to go to a specific screen in the app or replace the existing one. This function works based on an extended implementation of the `linkTo` method. Because of this, there are some differences between using our function and `navigate` returned from `useNavigation` hook.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
`Navigation.navigate` is used to go to a specific screen in the app or replace the existing one. This function works based on an extended implementation of the `linkTo` method. Because of this, there are some differences between using our function and `navigate` returned from `useNavigation` hook.
`Navigation.navigate` is used to go to a specific screen in the app or replace an existing one. This function works based on an extended implementation of the `linkTo` method. Because of this, there are some differences between using our function and the original `navigate` returned from `useNavigation` hook.

contributingGuides/NAVIGATION.md Outdated
## Adding RHP flows
> [!NOTE]
> The most relevant differences between our implementation of `Navigation.navigate` and `navigate` returned from `useNavigation`:
> 1. We pass `route` instead of a screen name, because our implementation of `Navigation.navigate` is based on `linkTo` method which accepts `route` as a parameter
Copy link
Member

@Kicu Kicu Jun 5, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

When reading this directly top to bottom, the part about linkTo seems like a direct repeat of similar line: This function works based on an extended implementation of the 'linkTo' method.

Maybe thats not a problem, but it seemed kinda redundant. Maybe just keep the info about usage of linkTo here and removed from higher up? But I don't have strong opinions about this.

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am wondering if mentioning the linkTo function is relevant at all

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I know it's mentioned twice in the same paragraph, but I believe this will make it more visible

contributingGuides/NAVIGATION.md Outdated
> The most relevant differences between our implementation of `Navigation.navigate` and `navigate` returned from `useNavigation`:
> 1. We pass `route` instead of a screen name, because our implementation of `Navigation.navigate` is based on `linkTo` method which accepts `route` as a parameter
> 2. We import Navigation object from `@libs/Navigation/Navigation` not get it from the hook
> 3. Our method uses `PUSH` not `NAVIGATE` by default!!
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
> 3. Our method uses `PUSH` not `NAVIGATE` by default!!
> 3. Our method uses `PUSH` instead of `NAVIGATE` by default!!

contributingGuides/NAVIGATION.md Outdated
> [!NOTE]
> The most relevant differences between our implementation of `Navigation.navigate` and `navigate` returned from `useNavigation`:
> 1. We pass `route` instead of a screen name, because our implementation of `Navigation.navigate` is based on `linkTo` method which accepts `route` as a parameter
> 2. We import Navigation object from `@libs/Navigation/Navigation` not get it from the hook
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
> 2. We import Navigation object from `@libs/Navigation/Navigation` not get it from the hook
> 2. We import Navigation object from `@libs/Navigation/Navigation` instead of getting it from the hook

contributingGuides/NAVIGATION.md Outdated

- Since each of those flows is kind of a modal stack, if you want to add a page to the existing flow, you should just add a page to the correct stack in `ModalStackNavigators.tsx`.
To navigate back, we use the `Navigation.goBack` function. We can call this function without any parameters, but the most common case is to call it with `backToRoute`. It is worth remembering that it is possible to deep link to any page in the application, and then we may lose a page to which we should go back from the navigation state. In such a case, we can simply use the mentioned parameter to indicate which page should be opened when going back.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The sentence:

It is worth remembering that it is possible to deep link to any page in the application, and then we may lose a page to which we should go back from the navigation state.

is quite hard to parse in my head :D it has like 3 parts. I suggest rewriting or splitting into two sentences

contributingGuides/NAVIGATION.md Outdated
> [!NOTE]
> When nested routes are not rendered their state is lost and when returning to these screens it has to be recreated. To do this the state is saved in the `preservedNavigatorStates` object using the `usePreserveNavigatorState` hook.

### State persistance after page refresh
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

typo - persistence

contributingGuides/NAVIGATION.md Outdated

These navigators cover the entire screen and do not have transparent overlay. Each of them has a navigation tab bar icon that is highlighted when that screen is at the top of the navigation stack or visible under the mdal navigator overlay.

It is worth noting that despite the navigation tab is displayed, the application does not use `BottomTabNavigator`. When one of the navigation tab bar buttons is pressed, a new full screen is pushed onto the root stack. `StackNavigator` was used to implement this groups of screens as it has more flexibility and preserves navigation history in the browser.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more. 

It is worth noting that despite the navigation tab is displayed, the application does not use `BottomTabNavigator`.

Something is no-yes with this sentence ;)

contributingGuides/NAVIGATION.md Outdated
> [!NOTE]
> To check if a route belongs to a specific group, it is worth using the functions available in `@libs/Navigation/helpers/isNavigatorName`. For example, to check if a route is a `FullScreenNavigator` you can use the `isFullScreenName` function.

#### When we need to adapt the split navigator state (function `adaptStateIfNecessary`)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

not sure if I'm correct, but should this be:

When >do< we need to adapt the [...]

?

contributingGuides/NAVIGATION.md Outdated

#### `NAVIGATORS.REPORTS_SPLIT_NAVIGATOR` (Inbox tab)

It includes the `HOME` screen (`<BaseSidebarScreen />` component) with a list of reports as a sidebar screen and the `REPORT` screen displayed as a central one. There can be multiple report screens in the stack with different report IDs.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
It includes the `HOME` screen (`<BaseSidebarScreen />` component) with a list of reports as a sidebar screen and the `REPORT` screen displayed as a central one. There can be multiple report screens in the stack with different report IDs.
It displays the `HOME` screen (`<BaseSidebarScreen />` component) with a list of reports as a sidebar screen and the `REPORT` screen displayed as a central one. There can be multiple report screens in the stack with different report IDs.

contributingGuides/NAVIGATION.md Outdated

These screens / navigators have a transparent overlay underneath.

On wide layout we have functionality that ensures that there is at least one full screen under the modal on the stack that will be visible under overlay.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more. 

[...] that ensures that there is at least one full screen under the modal >>on the stack that will be visible<< under overlay.

Kinda reads like it will be the stack that will be visible under. I would rephrase this somehow.

adamgrzybowski
adamgrzybowski reviewed Jun 9, 2025
View reviewed changes
contributingGuides/NAVIGATION.md Outdated
/**
* Builds a URL with an encoded URI component for the `backTo` param which can be added to the end of URLs
*/
function getUrlWithBackToParam<TUrl extends string>(url: TUrl, backTo?: string, shouldEncodeURIComponent = true): `${TUrl}` {
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sue if we need to show implementation of the getUrlWithBackToParam. I would only add a comment to just use this funciton

adamgrzybowski
adamgrzybowski reviewed Jun 9, 2025
View reviewed changes
contributingGuides/NAVIGATION.md Outdated
}
```

To optimize the number of routes rendered in `RootStackNavigator` we limit the number of `FullScreenNavigators` rendered to 2.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe it's worth mentioning that we use last two instead of just one to make sure animations works properly

@WojtekBoman WojtekBoman force-pushed the nav/navigation-md branch 5 times, most recently from 831a9f8 to 06e1474 Compare June 10, 2025 08:38
@WojtekBoman WojtekBoman merged commit 1cd33a2 into main Jun 11, 2025
11 of 18 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Kicu Kicu Kicu requested changes

@adamgrzybowski adamgrzybowski adamgrzybowski left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@WojtekBoman @Kicu @adamgrzybowski