Skip to content

Commit e4c6c44

Browse files
author
Marc Mulcahy
committed
Add additional accessibility roles and states.
1 parent 19e82b7 commit e4c6c44

File tree

1 file changed

+24
-3
lines changed

1 file changed

+24
-3
lines changed

docs/accessibility.md

Lines changed: 24 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ Inverting screen colors is an Accessibility feature that makes the iPhone and iP
7575

7676
#### accessibilityRole (iOS, Android)
7777

78-
Accessibility Role tells a person using either VoiceOver on iOS or TalkBack on Android the type of element that is focused on. To use, set the `accessibilityRole` property to one of the following strings:
78+
Accessibility Role tells a person using either VoiceOver on iOS or TalkBack on Android the purpose or role of a given element. To use, set the `accessibilityRole` property to one of the following strings:
7979

8080
- **none** Used when the element has no role.
8181
- **button** Used when the element should be treated as a button.
@@ -88,15 +88,36 @@ Accessibility Role tells a person using either VoiceOver on iOS or TalkBack on A
8888
- **imagebutton** Used when the element should be treated as a button and is also an image.
8989
- **header** Used when an element acts as a header for a content section (e.g. the title of a navigation bar).
9090
- **summary** Used when an element can be used to provide a quick summary of current conditions in the app when the app first launches.
91+
- **alert** Used when an element contains important text to be presented to the user.
92+
- **checkbox** Used when an element represents a checkbox which can be checked, unchecked, or have mixed checked state.
93+
- **combobox** Used when an element represents a combo box, which allows the user to select among several choices.
94+
- **menu** Used when the component is a menu of choices.
95+
- **menubar** Used when a component is a container of multiple menus.
96+
- **menuitem** Used to represent an item within a menu.
97+
- **progressbar** Used to represent a component which indicates progress of a task.
98+
- **radio** Used to represent a radio button.
99+
- **radiogroup** Used to represent a group of radio buttons.
100+
- **scrollbar** Used to represent a scroll bar.
101+
- **spinbutton** Used to represent a button which opens a list of choices.
102+
- **switch** Used to represent a switch which can be turned on and off.
103+
- **tab** Used to represent a tab.
104+
- **tablist** Used to represent a list of tabs.
105+
- **timer** Used to represent a timer.
106+
- **toolbar** Used to represent a tool bar (a container of action buttons or components).
91107

92108
#### accessibilityStates (iOS, Android)
93109

94-
Accessibility State tells a person using either VoiceOver on iOS or TalkBack on Android the state of the element currently focused on. The state of the element can be set either to `selected` or `disabled` or both:
110+
Accessibility State tells a person using either VoiceOver on iOS or TalkBack on Android the state of an element. The state of the element can be set either to `selected` or `disabled` or both:
95111

96112
- **selected** Used when the element is in a selected state. For example, a button is selected.
97113
- **disabled** Used when the element is disabled and cannot be interacted with.
114+
- **checked** Used to indicate that a checkable element is currently checked.
115+
- **unchecked** Used to indicate that a checkable element is not currently checked.
116+
- **busy** Used to indicate that an element is currently busy.
117+
- **expanded** Used to indicate that an expandable element is currently expanded.
118+
- **collapsed** Used to indicate that an expandable element is currently collapsed.
98119

99-
To use, set the `accessibilityStates` to an array containing either `selected`, `disabled`, or both.
120+
To use, set the `accessibilityStates` to an array containing the list of current states.
100121

101122
#### accessibilityViewIsModal (iOS)
102123

0 commit comments

Comments
 (0)