17004 - add new ESLint rules to enforce use of accessible pressable components #20363

Skalakid · 2023-06-07T13:37:43Z

Details

Fixed Issues

$ #17004
PROPOSAL: #17004

Tests

Open up your editor
Try to import a component that uses a different Pressable then PressableWithFeedback/PressableWithoutFeedback
Check if the ESlint error occurs
Find any accessible element and remove accessibility props from it, and check if the error appears
Check linting by using npm run lint if there are no errors connected with accessibility. Currently, there should be about 7 errors in components that will be migrated but in other tasks

In this PR I also included the migration of the last components to PressableWithoutFeedback:

Badge
1. I wasn't able to find any components that are using Badge with a pressable={true} prop, to test it add a pressable prop to any Badge component
ThreePaneView
1. Log in
2. Enter settings (click your avatar at the top)
3. Click the dimmed area that is on the right of the opened settings, verify the behavior
FloatingActionButton
1. Log in
2. Click the floating "+" button, verify the styling and behavior of the component
Verify that no errors appear in the JS console

Offline tests

Same as Tests

QA Steps

Same as Tests

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Web

web.mov

Mobile Web - Chrome

mWeb-chrome.mov

Mobile Web - Safari

mWeb-safari.mov

Desktop

desktop.mov

iOS

ios.mov

Android

android.mov

melvin-bot · 2023-06-23T17:04:29Z

Hey! I see that you made changes to our Form component. Make sure to update the docs in FORMS.md accordingly. Cheers!

melvin-bot · 2023-06-26T09:15:03Z

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

rushatgabhane

Code LGTM and tests well. I don't think this needs a C+ review tho.
@roryabraham

melvin-bot · 2023-06-27T17:34:09Z

We did not find an internal engineer to review this PR, trying to assign a random engineer to #17004... Please reach out for help on Slack if no one gets assigned!

roryabraham · 2023-06-29T14:14:06Z

src/components/TextInput/TextInputLabel/index.js

@@ -15,7 +15,6 @@ class TextInputLabel extends PureComponent {
        return (
            <Animated.Text
                pointerEvents="none"
-                accessibilityRole="label"


Why did we remove this?

label accessibility role doesn't exist. In the latest commit, I changed it to text value

roryabraham

NAB but is there an easy way to configure a global default accessibilityRole for TextInput? Every time it seems we use accessibilityRole={CONST.ACCESSIBILITY_ROLE.TEXT} and wonder if we can DRY things up by using a lightweight TextInput wrapper that adds a default accessibility role. And then add a new ESLint rule to enforce that we use our own TextInput rather than the default from RN

roryabraham · 2023-07-06T18:39:57Z

src/libs/Navigation/AppNavigator/createResponsiveStackNavigator/ThreePaneView.js

@@ -9,6 +9,8 @@ import * as StyleUtils from '../../../../styles/StyleUtils';
 import {withNavigationPropTypes} from '../../../../components/withNavigation';
 import styles from '../../../../styles/styles';
 import CONST from '../../../../CONST';
+import PressableWithoutFeedback from '../../../../components/Pressable/PressableWithoutFeedback';
+import withLocalize, {withLocalizePropTypes} from '../../../../components/withLocalize';


Can we use the useLocalize hook instead of withLocalize HOC?

Skalakid · 2023-07-07T10:31:58Z

@roryabraham I don't know if it is possible. The plugin that we are using is checking components only by names. So it is checking both react-native and our custom TextInput because these have the same name and require us to pass accessibilityRole prop.

I think we can fix that by just changing the name of our TextInput component, and then pass accessibilityRole="text" and accessibilityLabel={label} by default inside it. But idk if it is the best workaround

roryabraham · 2023-07-07T22:14:46Z

@Skalakid ok no worries, we can proceed without the default accessibilityRole. Not a big deal to have to include it!

roryabraham · 2023-07-07T22:16:09Z

Conflicts

Skalakid · 2023-07-10T10:18:44Z

@roryabraham I just fixed the conflicts

roryabraham · 2023-07-10T20:44:38Z

@Skalakid Sorry, conflicts were back by the time I got to this.

Skalakid · 2023-07-10T20:49:25Z

@roryabraham I fixed conflicts again ;)

roryabraham · 2023-07-10T20:54:37Z

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

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

OSBotify · 2023-07-10T21:07:55Z

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

OSBotify · 2023-07-11T00:19:04Z

🚀 Deployed to staging by https://github.com/roryabraham in version: 1.3.39-0 🚀

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

mvtglobally · 2023-07-11T02:42:36Z

@Skalakid @roryabraham @rushatgabhane Can you pls help with a more understandable QA steps. Current tests are move Dev specific.

Skalakid · 2023-07-11T07:34:18Z

@mvtglobally this PR is really DEV-specific because we are adding ESlint rules so that developers can see errors in their IDE while coding

situchan · 2023-07-11T10:43:53Z

src/components/TextInput/TextInputLabel/index.js

                ref={(el) => (this.label = el)}
+                pointerEvents="none"
+                accessibilityRole={CONST.ACCESSIBILITY_ROLE_TEXT}


Suggested change

accessibilityRole={CONST.ACCESSIBILITY_ROLE_TEXT}

accessibilityRole={CONST.ACCESSIBILITY_ROLE.TEXT}

@Skalakid we missed this and need to make this change ASAP

@situchan @roryabraham I'm not sure what the suggested change is, can you explain?

CONST.ACCESSIBILITY_ROLE_TEXT is undefined. It should be CONST.ACCESSIBILITY_ROLE.TEXT

@Skalakid please look with 🦅's 👁️ to find diff 😄

OSBotify · 2023-07-13T01:43:06Z

🚀 Deployed to production by https://github.com/francoisl in version: 1.3.39-11 🚀

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

aimane-chnaif · 2023-08-25T14:14:47Z

src/components/AmountTextInput.js

@@ -49,6 +49,7 @@ function AmountTextInput(props) {
            blurOnSubmit={false}
            selection={props.selection}
            onSelectionChange={props.onSelectionChange}
+            accessibilityRole={CONST.ACCESSIBILITY_ROLE.TEXT}


Coming from #24482 (comment):
Do we need accessibilityRole for text input?

cc: @roryabraham @Skalakid @getusha

@aimane-chnaif It is a crucial prop from the accessibility perspective. It is needed to avoid ESlint errors since all accessibility components are required to have accessibilityRole

@Skalakid can we change it to presentation which means none if it is just to avoid ESlint errors?

@getusha I think you can try or you can change accessibilityRole to accessibilityLabel if you want. But it's strange that such an error appears since according to the documentation text role exists

@Skalakid accessibility* props are deprecated we are trying to change it to the role prop check it here: https://reactnative.dev/docs/accessibility#role

added new eslint rules

cdd0c97

Skalakid mentioned this pull request Jun 23, 2023

[HOLD for payment 2023-07-21] [HOLD for payment 2023-07-20] [Accessible Pressables] Add new ESLint rules to enforce use of accessible pressable components #17004

Closed

6 tasks

Skalakid added 3 commits June 23, 2023 15:55

Merge branch 'main' into 17004-add-pressable-ESLint-rules

704fb2c

fixed TextInput eslint errors

804b5be

added ignoring eslint rules in main file of new Pressables

05912b4

Merge branch 'main' into 17004-add-pressable-ESLint-rules

140e058

Skalakid marked this pull request as ready for review June 26, 2023 09:14

Skalakid requested a review from a team as a code owner June 26, 2023 09:14

melvin-bot bot requested review from rushatgabhane and removed request for a team June 26, 2023 09:15

rushatgabhane approved these changes Jun 27, 2023

View reviewed changes

Skalakid added 2 commits June 28, 2023 09:21

Merge branch 'main' into 17004-add-pressable-ESLint-rules

d1f80da

Merge branch 'main' into 17004-add-pressable-ESLint-rules

c8f1395

Skalakid requested a review from rushatgabhane June 28, 2023 13:41

Merge branch 'main' into 17004-add-pressable-ESLint-rules

fed9ec3

roryabraham requested changes Jun 29, 2023

View reviewed changes

Skalakid added 6 commits July 3, 2023 10:46

Merge branch 'main' into 17004-add-pressable-ESLint-rules

29043a4

updated TextInputLabel accessibilityRole

5ce4f90

migrated Badge component to PressableWithoutFeedabck

92044a7

migrated ThreePaneView to PressableWithoutFeedback

26f9d7f

migrated FloatingActionButton to PressableWithoutFeedback

e87dab4

migrated FloatingActionButton to PressableWithFeedback

5349a34

Skalakid requested a review from roryabraham July 3, 2023 11:59

Skalakid added 2 commits July 5, 2023 11:00

Merge branch 'main' into 17004-add-pressable-ESLint-rules

c242925

Merge branch 'main' into 17004-add-pressable-ESLint-rules

858654f

roryabraham requested changes Jul 6, 2023

View reviewed changes

review changes + bug fix

4881be4

Skalakid requested a review from roryabraham July 7, 2023 10:32

Merge branch 'main' into 17004-add-pressable-ESLint-rules

b5e309c

roryabraham mentioned this pull request Jul 7, 2023

[Tracking] Migrate away from Touchables and create a standardized, accessible button library using Pressables #14589

Closed

20 tasks

Merge branch 'main' into 17004-add-pressable-ESLint-rules

48db262

Merge branch 'main' into 17004-add-pressable-ESLint-rules

5127c92

roryabraham approved these changes Jul 10, 2023

View reviewed changes

roryabraham merged commit 08fa90c into Expensify:main Jul 10, 2023

OSBotify mentioned this pull request Jul 10, 2023

Deploy Checklist: New Expensify 2023-07-10 #22598

Closed

76 tasks

situchan reviewed Jul 11, 2023

View reviewed changes

Skalakid mentioned this pull request Jul 12, 2023

17004 - add accessibility and Pressable ESLint rules follow up #22732

Merged

58 tasks

situchan mentioned this pull request Jul 12, 2023

[HOLD for payment 2023-07-18] Codebase uses constant ACCESSIBILITY_ROLE_TEXT which does not exists #22764

Closed

6 tasks

aimane-chnaif reviewed Aug 25, 2023

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

17004 - add new ESLint rules to enforce use of accessible pressable components #20363

17004 - add new ESLint rules to enforce use of accessible pressable components #20363

Skalakid commented Jun 7, 2023 •

edited

Loading

melvin-bot bot commented Jun 23, 2023

melvin-bot bot commented Jun 26, 2023

rushatgabhane left a comment

melvin-bot bot commented Jun 27, 2023

roryabraham Jun 29, 2023

Skalakid Jul 3, 2023 •

edited

Loading

roryabraham left a comment

roryabraham Jul 6, 2023

Skalakid commented Jul 7, 2023

roryabraham commented Jul 7, 2023

roryabraham commented Jul 7, 2023

Skalakid commented Jul 10, 2023

roryabraham commented Jul 10, 2023

Skalakid commented Jul 10, 2023

roryabraham commented Jul 10, 2023 •

edited

Loading

OSBotify commented Jul 10, 2023

OSBotify commented Jul 11, 2023

mvtglobally commented Jul 11, 2023

Skalakid commented Jul 11, 2023

situchan Jul 11, 2023

roryabraham Jul 11, 2023

Skalakid Jul 11, 2023

roryabraham Jul 11, 2023

situchan Jul 11, 2023

OSBotify commented Jul 13, 2023

aimane-chnaif Aug 25, 2023

aimane-chnaif Aug 25, 2023

Skalakid Aug 28, 2023

getusha Aug 28, 2023

Skalakid Aug 28, 2023

getusha Aug 28, 2023

	accessibilityRole={CONST.ACCESSIBILITY_ROLE_TEXT}
	accessibilityRole={CONST.ACCESSIBILITY_ROLE.TEXT}

17004 - add new ESLint rules to enforce use of accessible pressable components #20363

17004 - add new ESLint rules to enforce use of accessible pressable components #20363

Conversation

Skalakid commented Jun 7, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Jun 23, 2023

melvin-bot bot commented Jun 26, 2023

rushatgabhane left a comment

Choose a reason for hiding this comment

melvin-bot bot commented Jun 27, 2023

Choose a reason for hiding this comment

Skalakid Jul 3, 2023 • edited Loading

Choose a reason for hiding this comment

roryabraham left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Skalakid commented Jul 7, 2023

roryabraham commented Jul 7, 2023

roryabraham commented Jul 7, 2023

Skalakid commented Jul 10, 2023

roryabraham commented Jul 10, 2023

Skalakid commented Jul 10, 2023

roryabraham commented Jul 10, 2023 • edited Loading

Reviewer Checklist

Screenshots/Videos

OSBotify commented Jul 10, 2023

OSBotify commented Jul 11, 2023

mvtglobally commented Jul 11, 2023

Skalakid commented Jul 11, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

OSBotify commented Jul 13, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Skalakid commented Jun 7, 2023 •

edited

Loading

Skalakid Jul 3, 2023 •

edited

Loading

roryabraham commented Jul 10, 2023 •

edited

Loading