Skip to content

Side Pane Stage 2: Add baseline content for each major section#57928

Closed
blazejkustra wants to merge 11 commits intoExpensify:mainfrom
software-mansion-labs:fix-side-pane/rhp
Closed

Side Pane Stage 2: Add baseline content for each major section#57928
blazejkustra wants to merge 11 commits intoExpensify:mainfrom
software-mansion-labs:fix-side-pane/rhp

Conversation

@blazejkustra
Copy link
Contributor

@blazejkustra blazejkustra commented Mar 6, 2025

Explanation of Change

Design doc: https://docs.google.com/document/d/1prFcvgUlEGRuL3zE-JH-lhv_BWX2lL2YNw61w4YVnyY/edit?tab=t.0

This PR expands the Help Pane by adding initial content for key sections and ensuring users always see relevant information.

Key Changes:

  • Contextual Help Content: Implemented a content map to show help content based on the current route, falling back to the closest parent if none is available.
  • Initial Content Added: Covers /r, /search, /settings, /settings/workspaces, and /settings/workspaces/:policyID.
  • Handling Missing Content:
    • On staging, missing content shows diagnostic info.
    • On production, the parent page content remains visible instead of an empty panel.
  • Testing & Deployment: Button visibility is still controlled via NVP on production, and all logic remains client-side (no backend integration yet).
    • On staging Help Button and Side Pane will be visible to anyone

Fixed Issues

$ #57860
PROPOSAL: N/A

Tests

Staging & Development

  1. Verify that Side Pane and HelpButton is displayed, no matter if nvp_sidePane is set in the console:
    Onyx.get('nvp_sidePane')
  2. Verify that help content is changed dynamically based on the route
  3. Verify that diagnostic data is displayed at the top of the section if there is no help content for that specific route
  • For example /settings/workspaces/:policyID content exists but child like /settings/workspaces/:policyID/members does not and it should display its parent content

Production

  1. Verify that Side Pane and HelpButton is displayed only if nvp_sidePane is defined in the console:
    Onyx.set('nvp_sidePane', {})
  2. Verify that help content is changed dynamically based on the route
  3. Verify that no 'diagnostic data' is displayed in the help pane for any route that starts with:
  • /r/...
  • /settings/...
  • /search/...

Offline tests

N/A

QA Steps

Same as tests

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 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

@blazejkustra blazejkustra changed the title SidePane navigation fixes WIP: Stage 2 Mar 6, 2025
@github-actions
Copy link
Contributor

github-actions bot commented Mar 6, 2025

⚠️ This PR is possibly changing native code, it may cause problems with HybridApp. Please run an AdHoc build to verify that HybridApp will not break. ⚠️

@github-actions
Copy link
Contributor

github-actions bot commented Mar 7, 2025

⚠️ This PR is possibly changing native code and/or updating libraries, it may cause problems with HybridApp. Please check if any patch updates are required in the HybridApp repo and run an AdHoc build to verify that HybridApp will not break. Ask Contributor Plus for help if you are not sure how to handle this. ⚠️

@blazejkustra blazejkustra changed the title WIP: Stage 2 Side Pane Stage 2: Add baseline content for each major section, tested on staging Mar 7, 2025
@blazejkustra blazejkustra changed the title Side Pane Stage 2: Add baseline content for each major section, tested on staging Side Pane Stage 2: Add baseline content for each major section Mar 7, 2025
@blazejkustra
Copy link
Contributor Author

I messed up git history on this branch, moving to #58004

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant