Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Documentation] Adding accessibilityErrorMessage prop to TextInput #3010

Open
wants to merge 18 commits into
base: main
Choose a base branch
from
Open

[Documentation] Adding accessibilityErrorMessage prop to TextInput #3010

Changes from 15 commits
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
aa1b36f
adding android_errorMessage prop to TextInput
fabOnReact Mar 16, 2022
3c568d7
remove explanation on how to internally control state
fabOnReact Mar 16, 2022
662f123
Merge branch 'main' into text-input-errors
fabOnReact Apr 5, 2022
4c1b0db
updating prop name to errorMessageAndroid
fabOnReact Apr 5, 2022
d797729
Merge branch 'main' into text-input-errors
fabOnReact Apr 11, 2022
426b89b
update prop name
fabOnReact Apr 11, 2022
b11f51a
update order for props in textinput
fabOnReact Apr 21, 2022
7e9c171
Merge branch 'main' into text-input-errors
fabOnReact May 23, 2022
d058984
the prop is available for iOS now
fabOnReact May 23, 2022
1f0fe27
updates based on latest change to PR
fabOnReact Jun 7, 2022
df95c28
Merge branch 'main' into text-input-errors
fabOnReact Jun 7, 2022
1ac301b
fix circleci lint tests
fabOnReact Jun 7, 2022
c862e50
Merge branch 'main' into text-input-errors
fabOnReact Aug 12, 2022
04af500
grammarly
fabOnReact Aug 12, 2022
868301b
alphabetical order
fabOnReact Aug 12, 2022
8510e8c
code review from lunaleaps
fabOnReact Aug 30, 2022
b7e7661
minor change
fabOnReact Aug 30, 2022
cb44627
minor change
fabOnReact Aug 30, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions docs/textinput.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,29 @@ Inherits [View Props](view.md#props).

---

### `accessibilityErrorMessage`

String read by screenreaders to indicate an error state of a TextInput.
Setting accessibilityInvalid to true activates the error message.
Copy link
Contributor

@lunaleaps lunaleaps Aug 29, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we also reference the web specification about this? Or that this follows the web spec? Or does that make things more unclear since it's not exactly following aria-errormessage? See my comment here: facebook/react-native#33468 (comment)

Copy link
Contributor

@lunaleaps lunaleaps Aug 29, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
String read by screenreaders to indicate an error state of a TextInput.
Setting accessibilityInvalid to true activates the error message.
String read by screenreaders to indicate an error state of a TextInput.
Setting accessibilityInvalid to true activates the error message.
Note: This prop models [`aria-errormessage`](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Attributes/aria-errormessage#description) but differs in that it does not provide an element id.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I replied in facebook/react-native#33468 (comment)


| Type |
| ------ |
| string |

---

### `accessibilityInvalid`

Setting accessibilityInvalid to true activates the accessibilityErrorMessage.
Setting accessibilityInvalid to false removes the accessibilityErrorMessage.
The default value is `false`.

| Type |
| ---- |
| bool |

---

### `allowFontScaling`

Specifies whether fonts should scale to respect Text Size accessibility settings. The default is `true`.
Expand Down