refactor: SelectionListRadio #21048

thiagobrez · 2023-06-19T15:54:59Z

Details

Phase 1 of 3, regarding selection lists refactor. Tracker issue: #11795

This PR creates a new clean component (SelectionListRadio) for lists with single selection, and replaces usages of OptionsSelector and OptionsList with this new component in the following pages:

TimezoneSelectPage
PronounsPage
YearPickerPage
PriorityModePage
LanguagePage

Most of the code was transported from the old components and simplified to the new one. All the previous features are maintained.

Previously there were 5 levels of hierarchy: OptionsSelector -> BaseOptionsSelector -> OptionsList -> BaseOptionsList -> OptionRow

And now there is 2: SelectionListRadio -> BaseSelectionListRadio, which greatly simplifies usage and understanding.

Also, there was a lot of props removed regarding customisation of the lists appearance, which were often small paddings. These props were removed, further simplifying the component logic and standardising the look and feel across all single selection lists.

Finally, storybook stories were created for the variations, as well as performance tests.

Fixed Issues

$ #20352
PROPOSAL: #11795 (comment)

Tests

Verify that no errors appear in the JS console
Go to Settings -> Profile -> Timezone. Verify that the timezone list is working correctly
Go to Settings -> Profile -> Pronouns. Verify that the pronouns list is working correctly
Go to Settings -> Profile -> Personal Details -> Date of birth. Verify that the year of birth list is working correctly
Go to Settings -> Preferences -> Priority Mode. Verify that the priority mode list is working correctly
Go to Settings -> Preferences -> Language. Verify that the language list is working correctly

Offline tests

QA Steps

Verify that no errors appear in the JS console
Go to Settings -> Profile -> Timezone. Verify that the timezone list is working correctly
Go to Settings -> Profile -> Pronouns. Verify that the pronouns list is working correctly
Go to Settings -> Profile -> Personal Details -> Date of birth. Verify that the year of birth list is working correctly
Go to Settings -> Preferences -> Priority Mode. Verify that the priority mode list is working correctly
Go to Settings -> Preferences -> Language. Verify that the language list is working correctly

PR Author Checklist

Screenshots/Videos

Web - Chrome

web.chrome.mov

Web - Safari

web.safari.mov

Mobile Web - Chrome

android.web.mov

Mobile Web - Safari

ios.web.mp4

Desktop

desktop.mov

iOS

ios.native.mp4

Android

android.native.mov

src/pages/YearPickerPage.js

ios/Podfile.lock

src/components/SelectionListRadio/BaseSelectionListRadio.js

src/pages/YearPickerPage.js

src/pages/settings/Preferences/LanguagePage.js

src/pages/settings/Preferences/PriorityModePage.js

src/pages/settings/Profile/PronounsPage.js

thiagobrez · 2023-07-04T17:21:52Z

@Santhosh-Sellavel Yep, tried on all platforms

Santhosh-Sellavel · 2023-07-04T18:54:02Z

@thiagobrez

You can see the warning here, follow what I do in the recording. Also, I see this bug still occurs. You can find that also in the video attached below when the keyboard is active, thanks!

Go to Settings -> Profile -> Timezone
Disable automatic select if not done
Now open the timezone selection list
Change the option and scroll through the list, you will see a warning.

Screen.Recording.2023-07-05.at.12.18.31.AM.mov

thiagobrez · 2023-07-05T14:34:56Z

@Santhosh-Sellavel Sorry for the inconvenience. I wasn't indeed able to see it yesterday but I can today 🤷🏻

That said, this warning is not caused by my implementation. It seems to come from ScreenWrapper and affects all pages that use it. It is also happening in latest main

For reference, the warning in the 2FA page, that also uses ScreenWrapper:

Details

thiagobrez · 2023-07-05T14:37:35Z

Regarding the blank area on top of the keyboard, it was being caused by a safe area and that was not listening to the keyboard change. Should be good now :)

Santhosh-Sellavel · 2023-07-05T19:49:25Z

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 / 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. toggleReport and not onIconClick).
- 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 Copy label 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
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(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 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 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

Web

Screen.Recording.2023-07-06.at.1.40.25.AM.mov

Mobile Web - Chrome

Screen.Recording.2023-07-06.at.1.35.37.AM.mov

Mobile Web - Safari

Screen.Recording.2023-07-06.at.1.32.15.AM.mov

Desktop

Screen.Recording.2023-07-06.at.1.39.09.AM.mov

iOS

Screen.Recording.2023-07-06.at.1.33.51.AM.mov

Android

Screen.Recording.2023-07-06.at.1.36.57.AM.mov

Santhosh-Sellavel

LGTM, all yours @cristipaval!

cristipaval

Great work! 🚀
Thank you for adding it to Storybook and for adding tests! ❤️

OSBotify · 2023-07-06T08:36:47Z

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

Santhosh-Sellavel · 2023-07-06T09:08:15Z

@cristipaval Assign me issue for tracking, thanks!

cristipaval · 2023-07-06T11:09:08Z

@cristipaval Assign me issue for tracking, thanks!

done

OSBotify · 2023-07-07T10:45:12Z

🚀 Deployed to staging by https://github.com/cristipaval in version: 1.3.38-0 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	success ✅
🕸 web 🕸	success ✅

OSBotify · 2023-07-11T00:00:14Z

🚀 Deployed to production by https://github.com/francoisl in version: 1.3.38-7 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	success ✅
🕸 web 🕸	success ✅

fedirjh · 2023-08-01T18:55:58Z

src/components/SelectionListRadio/BaseSelectionListRadio.js

+                            maxToRenderPerBatch={5}
+                            windowSize={5}
+                            viewabilityConfig={{viewAreaCoveragePercentThreshold: 95}}
+                            onLayout={() => scrollToIndex(focusedIndex, false)}


This line caused a regression in #22689, On mweb, whenever the keyboard is shown, it triggers a layout change which in turn causes the list to scroll back to the focused index.

cubuspl42 · 2023-08-07T08:47:07Z

I really like this refactor, it makes a lot of sense.

What's the short and long term plan for the OptionsSelector? While this refactor is a great improvement, it left us with both "the old thing" and "the new thing".

thiagobrez · 2023-08-07T10:57:49Z

Thanks @cubuspl42! Yeah, the plan is to remove all usages of OptionsSelector, OptionsList and OptionRow when the refactor is complete. This PR was Phase 1. Phase 2 is open here, and Phase 3 is in the works.

You can get a short overview in this comment:
#11795 (comment)

Santhosh-Sellavel · 2023-08-08T19:30:29Z

src/components/SelectionListRadio/BaseSelectionListRadio.js

+                        {Boolean(props.headerMessage) && (
+                            <View style={[styles.ph5, styles.pb5]}>
+                                <Text style={[styles.textLabel, styles.colorMuted]}>{props.headerMessage}</Text>
+                            </View>
+                        )}


This block leads to this bug. We still intended to keep consistent spacing for headerMessage as it was in the other list.

ArekChr · 2023-10-04T07:23:54Z

src/components/SelectionListRadio/index.js

+import * as DeviceCapabilities from '../../libs/DeviceCapabilities';
+
+const SelectionListRadio = forwardRef((props, ref) => {
+    const [isScreenTouched, setIsScreenTouched] = useState(false);


Small performance improvement, this could be rewritten to useRef, as isScreenTouched is not used on UI so we don't need to re-render.

@ArekChr Cool, I agree! It's like this because it was just copied from the old implementation. ccing @lukemorawski as he will be continuing with the refactor

thiagobrez added 15 commits June 19, 2023 16:48

chore: copy OptionsSelector and port to functional

814ce89

chore: wip

48f7254

chore: wip

4dc7127

chore: Timezone list fully working

8aaddaa

chore: Timezone list fully working

cf0556d

chore: Pronouns list working

59c262b

chore: Year Picker list working

d3eccd5

chore: Priority Mode list working

e40f55f

chore: Language list working

037dae5

chore: add storybook stories

1b6f1c5

chore: cleanup

7496be6

chore: cleanup

385ba7f

chore: cleanup

8f328e2

chore: replace customIcon and boldStyle

776fce2

chore: cleanup

16532f8

gedu reviewed Jun 20, 2023

View reviewed changes

src/pages/YearPickerPage.js Show resolved Hide resolved

burczu reviewed Jun 20, 2023

View reviewed changes

ios/Podfile.lock Outdated Show resolved Hide resolved

ArekChr reviewed Jun 20, 2023

View reviewed changes

thiagobrez added 7 commits June 20, 2023 13:07

chore: remove flattenedSections useMemo

05fd8a8

chore: cleanup BaseSelectionListRadio

cb13c23

chore: cleanup pages

fa4648a

chore: restore lockfile

58a5c7a

chore: fix storybook

594100a

chore: improve performance test

f4f41b8

chore: add useKeyboardShortcut

3e7a9ef

thiagobrez mentioned this pull request Jun 20, 2023

[HOLD for payment 2023-07-17] Selection List Refactor: Radio Button List #20352

Closed

thiagobrez marked this pull request as ready for review June 20, 2023 15:49

thiagobrez requested a review from a team as a code owner June 20, 2023 15:49

melvin-bot bot requested review from Santhosh-Sellavel and removed request for a team June 20, 2023 15:49

thiagobrez added 2 commits July 5, 2023 14:35

Merge branch 'main' into refactor/selection_list/radio_button_list

05da119

chore: fix safe area on keyboard

35602db

chore: cleanup

43c4443

Santhosh-Sellavel approved these changes Jul 5, 2023

View reviewed changes

cristipaval approved these changes Jul 6, 2023

View reviewed changes

cristipaval merged commit a6ae94d into Expensify:main Jul 6, 2023
13 checks passed

OSBotify mentioned this pull request Jul 7, 2023

Deploy Checklist: New Expensify 2023-07-07 #22399

Closed

64 tasks

aimane-chnaif mentioned this pull request Jul 7, 2023

Update App to React Native 0.72 version #18507

Merged

57 tasks

thiagobrez mentioned this pull request Jul 13, 2023

[$1000] Web – Announce Room - Inconsistency in highlighting the selected option. #22553

Closed

6 tasks

fedirjh reviewed Aug 1, 2023

View reviewed changes

fedirjh mentioned this pull request Aug 1, 2023

[HOLD for payment 2023-08-01] [$1000] Date of birth - Year list is scrolled back to current selection when keyboard disappears #22689

Closed

6 tasks

cubuspl42 mentioned this pull request Aug 7, 2023

Select focused pronouns when the text input is submitted #24202

Merged

58 tasks

Santhosh-Sellavel reviewed Aug 8, 2023

View reviewed changes

Santhosh-Sellavel mentioned this pull request Aug 8, 2023

[HOLD for payment 2023-08-07] [$1000] Web – Profile – Inconsistency of padding above “No result found” error in “Pronouns” section. #22560

Closed

6 tasks

bernhardoj mentioned this pull request Aug 14, 2023

[Awaiting Miro Payment] [$1000] Timezone select page does not navigate back to timezone initial page after user changes timezone to automatic from another device #24516

Closed

6 tasks

sobitneupane mentioned this pull request Sep 25, 2023

[HOLD for payment 2023-09-27] [$500] Workspaces - Auto select member after invite #26667

Closed

6 tasks

ArekChr reviewed Oct 4, 2023

View reviewed changes

bernhardoj mentioned this pull request May 9, 2024

[$250] "Next" and "split" button moves a bit when navigate back #41855

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

refactor: SelectionListRadio #21048

refactor: SelectionListRadio #21048

thiagobrez commented Jun 19, 2023 •

edited

thiagobrez commented Jul 4, 2023

Santhosh-Sellavel commented Jul 4, 2023

thiagobrez commented Jul 5, 2023 •

edited

thiagobrez commented Jul 5, 2023 •

edited

Santhosh-Sellavel commented Jul 5, 2023 •

edited

Santhosh-Sellavel left a comment

cristipaval left a comment

OSBotify commented Jul 6, 2023

Santhosh-Sellavel commented Jul 6, 2023

cristipaval commented Jul 6, 2023

OSBotify commented Jul 7, 2023

OSBotify commented Jul 11, 2023

fedirjh Aug 1, 2023

cubuspl42 commented Aug 7, 2023

thiagobrez commented Aug 7, 2023

Santhosh-Sellavel Aug 8, 2023

ArekChr Oct 4, 2023

thiagobrez Oct 4, 2023

refactor: SelectionListRadio #21048

refactor: SelectionListRadio #21048

Conversation

thiagobrez commented Jun 19, 2023 • edited

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

thiagobrez commented Jul 4, 2023

Santhosh-Sellavel commented Jul 4, 2023

thiagobrez commented Jul 5, 2023 • edited

thiagobrez commented Jul 5, 2023 • edited

Santhosh-Sellavel commented Jul 5, 2023 • edited

Reviewer Checklist

Screenshots/Videos

Santhosh-Sellavel left a comment

Choose a reason for hiding this comment

cristipaval left a comment

Choose a reason for hiding this comment

OSBotify commented Jul 6, 2023

Santhosh-Sellavel commented Jul 6, 2023

cristipaval commented Jul 6, 2023

OSBotify commented Jul 7, 2023

OSBotify commented Jul 11, 2023

fedirjh Aug 1, 2023

Choose a reason for hiding this comment

cubuspl42 commented Aug 7, 2023

thiagobrez commented Aug 7, 2023

Santhosh-Sellavel Aug 8, 2023

Choose a reason for hiding this comment

ArekChr Oct 4, 2023

Choose a reason for hiding this comment

thiagobrez Oct 4, 2023

Choose a reason for hiding this comment

thiagobrez commented Jun 19, 2023 •

edited

thiagobrez commented Jul 5, 2023 •

edited

thiagobrez commented Jul 5, 2023 •

edited

Santhosh-Sellavel commented Jul 5, 2023 •

edited