[NOQA] Updating NewHelp for mobile layout #52683

quinthar · 2024-11-17T21:21:35Z

Explanation of Change

Updating NewHelp to support a mobile layout. This required some extensive refactoring of the header, as it wasn't really envisioned for narrow screens. Also, took this opportunity to split up the css/html/js into different files.

Fixed Issues

n/a

Tests

This has been tested in my dev environment using Chrome, but pushing to a PR so I can test on a real phone using the staging branch in CF.

Offline tests

n/a

QA Steps

n/a

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 verified the translation was requested/reviewed 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.js 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.
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.

Mobile screenshots

Desktop screenshots

melvin-bot · 2024-11-17T21:22:02Z

@Julesssss 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]

github-actions · 2024-11-17T21:22:31Z

Your New Help changes have been deployed to https://203e413d.newhelp.pages.dev ⚡️

github-actions · 2024-11-18T04:03:20Z

🚀Deployed to NewHelp production! 🚀

(View deploy workflow run)

github-actions · 2024-11-19T01:23:35Z

🚀 Deployed to staging by https://github.com/dubielzyk-expensify in version: 9.0.64-0 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	success ✅
🕸 web 🕸	success ✅
🤖🔄 android HybridApp 🤖🔄	success ✅
🍎🔄 iOS HybridApp 🍎🔄	failure ❌

github-actions · 2024-11-21T01:17:32Z

🚀 Deployed to production by https://github.com/chiragsalian in version: 9.0.64-4 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	success ✅
🕸 web 🕸	success ✅
🤖🔄 android HybridApp 🤖🔄	failure ❌
🍎🔄 iOS HybridApp 🍎🔄	failure ❌

tgolen

Just noticed a few things while I was doing some CAP SW reviews

tgolen · 2024-12-17T18:33:13Z

help/_layouts/default.html

+        </div>
+        <div id="search-container">
+            <!-- Search Input styled as button -->
+            <span id="search-icon" style="cursor: pointer; font-size: 24px;">🔍</span>


Please place all styles in the CSS file and apply them with classes or IDs as necessary.

tgolen · 2024-12-17T18:36:52Z

help/default.js

+                    const contextBefore = doc.content.substring(Math.max(0, searchTermIndex - 30), searchTermIndex);
+                    const contextAfter = doc.content.substring(searchTermIndex + query.length, Math.min(doc.content.length, searchTermIndex + query.length + 30));
+                    const searchResultHtml = `
+                        <div class="search-result">


Please move HTML templates to the HTML file. Consider using https://developer.mozilla.org/en-US/docs/Web/HTML/Element/template

tgolen · 2024-12-17T18:37:37Z

help/default.js

+                }
+            });
+        });
+        g_searchResults.style.display = 'block';


Styles should only be applied by classes or IDs. I suggest having some classes like display-block and display-none

tgolen · 2024-12-17T18:41:21Z

help/_layouts/default.html

+                    <div id="search-results" tabindex="0" style="display:none;"></div>
+
+                    <!-- Footer with shortcut info -->
+                    <div id="search-footer" style="text-align: center; margin-top: 10px; font-size: 14px; color: #586069;">


quinthar added 7 commits November 16, 2024 20:16

Updating mobile layout

40f47d7

More moblie tweaks

4669708

Updating product list

0ecfdad

Cleaned up mobile nav

c85795b

More mobile stylings

fef8016

Consolidating search code in prep for splitting out JS/CSS

c3ba0de

Split up files

5cb6da7

quinthar requested a review from a team as a code owner November 17, 2024 21:21

melvin-bot bot requested review from Julesssss and removed request for a team November 17, 2024 21:22

quinthar added 6 commits November 17, 2024 14:23

Prettified the JS

efdebef

Fixed a lot of lint errors

cdb71f3

Prettied the code

7b4eebf

fixing more lint/pretty issues

e8e3ce2

More lint fixes

6bce953

Even more lint fixes

4715f2e

dubielzyk-expensify self-requested a review November 18, 2024 03:38

dubielzyk-expensify approved these changes Nov 18, 2024

View reviewed changes

dubielzyk-expensify changed the title ~~[HOLD] [WIP] [NOQA] Updating NewHelp for mobile layout~~ [NOQA] Updating NewHelp for mobile layout Nov 18, 2024

dubielzyk-expensify merged commit d5e7a5a into main Nov 18, 2024
16 of 17 checks passed

dubielzyk-expensify deleted the dbarrett_MobileLayout branch November 18, 2024 04:02

github-actions bot mentioned this pull request Nov 19, 2024

Deploy Checklist: New Expensify 2024-11-19 #52733

Closed

54 tasks

tgolen reviewed Dec 17, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[NOQA] Updating NewHelp for mobile layout #52683

[NOQA] Updating NewHelp for mobile layout #52683

quinthar commented Nov 17, 2024 •

edited

Loading

melvin-bot bot commented Nov 17, 2024

github-actions bot commented Nov 17, 2024 •

edited

Loading

github-actions bot commented Nov 18, 2024

github-actions bot commented Nov 19, 2024

github-actions bot commented Nov 21, 2024

tgolen left a comment

tgolen Dec 17, 2024

tgolen Dec 17, 2024

tgolen Dec 17, 2024

tgolen Dec 17, 2024

[NOQA] Updating NewHelp for mobile layout #52683

[NOQA] Updating NewHelp for mobile layout #52683

Conversation

quinthar commented Nov 17, 2024 • edited Loading

Explanation of Change

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Mobile screenshots

Desktop screenshots

melvin-bot bot commented Nov 17, 2024

github-actions bot commented Nov 17, 2024 • edited Loading

github-actions bot commented Nov 18, 2024

github-actions bot commented Nov 19, 2024

github-actions bot commented Nov 21, 2024

tgolen left a comment

Choose a reason for hiding this comment

tgolen Dec 17, 2024

Choose a reason for hiding this comment

tgolen Dec 17, 2024

Choose a reason for hiding this comment

tgolen Dec 17, 2024

Choose a reason for hiding this comment

tgolen Dec 17, 2024

Choose a reason for hiding this comment

quinthar commented Nov 17, 2024 •

edited

Loading

github-actions bot commented Nov 17, 2024 •

edited

Loading