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.

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

added documentation for aria-valuemax aria-valuemin aria-valuenow aria-valuetext #3318

Merged
merged 3 commits into from
Sep 23, 2022
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
16 changes: 16 additions & 0 deletions docs/accessibility.md
Original file line number Diff line number Diff line change
Expand Up @@ -204,6 +204,22 @@ A Boolean value indicating whether the accessibility elements contained within t

For example, in a window that contains sibling views `A` and `B`, setting `accessibilityElementsHidden` to `true` on view `B` causes VoiceOver to ignore the elements in the view `B`. This is similar to the Android property `importantForAccessibility="no-hide-descendants"`.

### `aria-valuemax`

It Represents the maximum value for range-based components, such as sliders and progress bars.

### `aria-valuemin`

It Represents the maximum value for range-based components, such as sliders and progress bars.

### `aria-valuenow`

It Represents the current value for range-based components, such as sliders and progress bars.

### `aria-valuetext`

It is the textual description of the component.

### `importantForAccessibility` <div class="label android">Android</div>

In the case of two overlapping UI components with the same parent, default accessibility focus can have unpredictable behavior. The `importantForAccessibility` property will resolve this by controlling if a view fires accessibility events and if it is reported to accessibility services. It can be set to `auto`, `yes`, `no` and `no-hide-descendants` (the last value will force accessibility services to ignore the component and all of its children).
Expand Down
40 changes: 40 additions & 0 deletions docs/touchablewithoutfeedback.md
Original file line number Diff line number Diff line change
Expand Up @@ -219,6 +219,46 @@ See the [Accessibility guide](accessibility.md#accessibilityvalue-ios-android) f

---

### `aria-valuemax`

It Represents the maximum value for range-based components, such as sliders and progress bars. Has precedence over the `accessibilityValue.max` prop.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
It Represents the maximum value for range-based components, such as sliders and progress bars. Has precedence over the `accessibilityValue.max` prop.
Represents the maximum value for range-based components, such as sliders and progress bars. Has precedence over the `max` value in the `accessibilityValue` prop.

Please remove "It" at the beginning of each description, ensure that case is correct and rephrase the precedence sentence as seen above in other entries added.


| Type |
| ------ |
| number |

---

### `aria-valuemin`

It Represents the maximum value for range-based components, such as sliders and progress bars. Has precedence over the `accessibilityValue.min` prop.

| Type |
| ------ |
| number |

---

### `aria-valuenow`

It Represents the current value for range-based components, such as sliders and progress bars. Has precedence over the `accessibilityValue.now` prop.

| Type |
| ------ |
| number |

---

### `aria-valuetext`

It is the textual description of the component. Has precedence over the `accessibilityValue.text` prop.

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

---

### `delayLongPress`

Duration (in milliseconds) from `onPressIn` before `onLongPress` is called.
Expand Down
40 changes: 40 additions & 0 deletions docs/view.md
Original file line number Diff line number Diff line change
Expand Up @@ -249,6 +249,46 @@ When `true`, indicates that the view is an accessibility element. By default, al

---

### `aria-valuemax`

It Represents the maximum value for range-based components, such as sliders and progress bars. Has precedence over the `accessibilityValue.max` prop.

| Type |
| ------ |
| number |

---

### `aria-valuemin`

It Represents the maximum value for range-based components, such as sliders and progress bars. Has precedence over the `accessibilityValue.min` prop.

| Type |
| ------ |
| number |

---

### `aria-valuenow`

It Represents the current value for range-based components, such as sliders and progress bars. Has precedence over the `accessibilityValue.now` prop.

| Type |
| ------ |
| number |

---

### `aria-valuetext`

It is the textual description of the component. Has precedence over the `accessibilityValue.text` prop.

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

---

### `collapsable` <div class="label android">Android</div>

Views that are only used to layout their children or otherwise don't draw anything may be automatically removed from the native hierarchy as an optimization. Set this property to `false` to disable this optimization and ensure that this `View` exists in the native view hierarchy.
Expand Down