Implement localization for ContextMenu options #26841
Conversation
melvin-bot
bot
requested review from
situchan
and removed request for
a team
| disposeContextMenu(); | ||
| disposeContextMenu = createContextMenu(updatedLocale); |
There was a problem hiding this comment.
First line will dispose the old context menu. Second line will reassign it. Is there any alternative solution you'd like to suggest?
There was a problem hiding this comment.
What's the root cause? Why not work on the first call?
There was a problem hiding this comment.
The first call will initialize the context menu. This second call will run whever the user changes the language
desktop/main.js
Outdated
| * @returns {Function} A dispose function to clean up the created context menu. | ||
| */ | ||
|
|
||
| function createContextMenu(preferredLocale) { |
There was a problem hiding this comment.
| function createContextMenu(preferredLocale) { | |
| function createContextMenu(preferredLocale = LOCALES.DEFAULT) { |
and import LOCALES like this:
const {DESKTOP_SHORTCUT_ACCELERATOR, LOCALES} = CONST;
desktop/main.js
Outdated
| }); | ||
| } | ||
|
|
||
| let disposeContextMenu = createContextMenu(CONST.LOCALES.DEFAULT); |
There was a problem hiding this comment.
Initialization is already done here, isn't it?
There was a problem hiding this comment.
Yes, this will initialize the menu. And the below will recreate it when the user changes the language
There was a problem hiding this comment.
Still trying to understand.
createContextMenu is called 3 times total right?
There was a problem hiding this comment.
2 times. One at line 72 during initialization. One at line 541 when user changes the language
There was a problem hiding this comment.
let disposeContextMenu = createContextMenu(CONST.LOCALES.DEFAULT);callscreateContextMenuon app start
after changing language:
disposeContextMenu();callscreateContextMenu- and then
disposeContextMenu = createContextMenu(updatedLocale);callscreateContextMenuagain
There was a problem hiding this comment.
disposeContextMenu will not call createContextMenu. It will call the returned value of createContextMenu which will dispose the event listeners
The return value of contextMenu() is a function that disposes of the created event listeners
https://www.npmjs.com/package/electron-context-menu
There was a problem hiding this comment.
contextMenu function inside createContextMenu creates the actual contextMenu and returns a function that will dispose the contextMenu when you want to recreate it
There was a problem hiding this comment.
The disposeContextMenu is a function like the one you return in useEffect to clear the event listeners
Co-authored-by: Situ Chandra Shil <108292595+situchan@users.noreply.github.com>
There was a problem hiding this comment.
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 Issuessection 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
Testssection - I verified the steps for Staging and/or Production testing are in the
QA stepssection - 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 verified the steps for local testing are in the
- 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 / Chrome
- iOS / native
- iOS / 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.
toggleReportand notonIconClick). - I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g.
myBool && <MyComponent />. - 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 approved by marketing by adding the
Waiting for Copylabel for a copy review on the original GH to get the correct copy. - 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
- 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.
- 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 usingAvatarhave 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
thisproperly so there are no scoping issues (i.e. foronClick={this.submit}the methodthis.submitshould be bound tothisin the constructor) - Any internal methods bound to
thisare necessary to be bound (i.e. avoidthis.submit = this.submit.bind(this);ifthis.submitis never passed to a component event handler likeonClick) - 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(themeColors.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
Avataris modified, I verified thatAvataris 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 a new page is added, I verified it's using the
ScrollViewcomponent to make it scrollable when more elements are added to the page. - If the
mainbranch was merged into this PR after a review, I tested again and verified the outcome was still expected according to theTeststeps. - I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.
Screenshots/Videos
Web
Mobile Web - Chrome
Mobile Web - Safari
Desktop
Screen.Recording.2023-09-07.at.11.47.11.PM.mov
iOS
Android
|
Congrats, that’s your 5th PR merged! 🎉 Do you know about the ContributorPlus role? It’s an opportunity to earn more in the Expensify Open Source community. Keep up the great work - thanks! |
|
✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release. |
|
🚀 Deployed to staging by https://github.com/neil-marcellini in version: 1.3.68-0 🚀
|
|
#25704 is reproduced in web. |
|
🚀 Deployed to production by https://github.com/Julesssss in version: 1.3.68-17 🚀
|
Details
Fixed Issues
$ #25704
PROPOSAL: #25704 (comment)
Tests
Offline tests
Same as tests
QA Steps
Same as tests
PR Author Checklist
### Fixed Issuessection aboveTestssectionOffline stepssectionQA stepssectiontoggleReportand notonIconClick)myBool && <MyComponent />.src/languages/*files and using the translation methodWaiting for Copylabel for a copy review on the original GH to get the correct copy.STYLE.md) were followedAvatar, I verified the components usingAvatarare working as expected)/** comment above it */thisproperly so there are no scoping issues (i.e. foronClick={this.submit}the methodthis.submitshould be bound tothisin the constructor)thisare necessary to be bound (i.e. avoidthis.submit = this.submit.bind(this);ifthis.submitis never passed to a component event handler likeonClick)StyleUtils.getBackgroundAndBorderStyle(themeColors.componentBG))Avataris modified, I verified thatAvataris working as expected in all cases)ScrollViewcomponent to make it scrollable when more elements are added to the page.mainbranch was merged into this PR after a review, I tested again and verified the outcome was still expected according to theTeststeps.Screenshots/Videos
Web
Mobile Web - Chrome
Mobile Web - Safari
Desktop
desktop.context.menu.translations.mp4
iOS
Android