Skip to content

basic documentation for new roles and traits #3287

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

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

basic documentation for new roles and traits #3287

Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
4db63e5
basic documentation for new roles and traits
fabOnReact Aug 30, 2022
b947e55
adding documentation from AOSP
fabOnReact Aug 30, 2022
50f574d
ScrollView update
fabOnReact Aug 30, 2022
134cbed
Merge branch 'main' into roles-and-traits
fabOnReact Sep 7, 2022
24203fc
removing roles
fabOnReact Sep 7, 2022
a499b62
adding Android notation
fabOnReact Sep 7, 2022
e522e07
adding more info
fabOnReact Sep 7, 2022
8aff045
adding more info
fabOnReact Sep 7, 2022
c21e05b
minor change
fabOnReact Sep 7, 2022
8ee9325
finalize docs
fabOnReact Sep 7, 2022
3c31316
remove Android notation from roles that use default View impl
fabOnReact Sep 7, 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: 18 additions & 5 deletions docs/accessibility.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -133,10 +133,11 @@ In the above example method `addOne` changes the state variable `count`. As soon

`accessibilityRole` can be one of the following:

- **adjustable** Used when an element can be "adjusted" (e.g. a slider).
- **adjustable** Used when an element can be "adjusted" (e.g. a slider, seekcontrol).
- **alert** Used when an element contains important text to be presented to the user.
- **button** Used when the element should be treated as a button.
- **checkbox** Used when an element represents a checkbox which can be checked, unchecked, or have mixed checked state.
- **dropdownlist** Used to represent a dropdownlist (Spinner). A view that displays one child at a time and lets the user pick among them (Android).
- **checkbox** Used when an element represents a checkbox which can be checked, unchecked, or have mixed checked state (Android).
- **combobox** Used when an element represents a combo box, which allows the user to select among several choices.
- **header** Used when an element acts as a header for a content section (e.g. the title of a navigation bar).
- **image** Used when the element should be treated as an image. Can be combined with button or link, for example.
Expand All @@ -148,11 +149,11 @@ In the above example method `addOne` changes the state variable `count`. As soon
- **menuitem** Used to represent an item within a menu.
- **none** Used when the element has no role.
- **progressbar** Used to represent a component which indicates progress of a task.
- **radio** Used to represent a radio button.
- **radio** Used to represent a radio button (Android).
- **radiogroup** Used to represent a group of radio buttons.
- **scrollbar** Used to represent a scroll bar.
- **search** Used when the text field element should also be treated as a search field.
- **spinbutton** Used to represent a button which opens a list of choices.
- **spinbutton** Used to represent a button which opens a list of choices (Android).
- **summary** Used when an element can be used to provide a quick summary of current conditions in the app when the app first launches.
- **switch** Used to represent a switch which can be turned on and off.
- **tab** Used to represent a tab.
Expand All @@ -161,7 +162,19 @@ In the above example method `addOne` changes the state variable `count`. As soon
- **timer** Used to represent a timer.
- **togglebutton** Used to represent a toggle button. Should be used with accessibilityState checked to indicate if the button is toggled on or off.
- **toolbar** Used to represent a tool bar (a container of action buttons or components).
- **grid** Used with ScrollView, VirtualizedList, FlatList, or SectionList to represent a grid. Adds the in/out of grid announcements to the android GridView.
- **list** Base class that can be used to implement virtualized lists of items.
A list does not have a spatial definition here. For instance, subclasses of
this class can display the content of the list in a grid, in a carousel, as
stack, etc. (Android).
- **grid** Used with ScrollView, VirtualizedList, FlatList, or SectionList to represent a grid. Adds the in/out of grid announcements to the android GridView (Android).
- **pager** Used to represent a pager. Layout manager that allows the user to flip left and right through pages of data (Android).
- **scrollview** Used to represent a ScrollView. ScrollView is a view group that allows the view hierarchy placed within it to be scrolled (Android).
- **horizontalscrollview** Used to represent a HorizontalScrollView (Android).
- **viewgroup** Used to represent a ViewGroup. ViewGroup is a special view that can contain other views (called children.) The view group is the base class for layouts and views containers (Android).
- **webview** Used to represent a webview (Android).
- **drawerlayout** Used to represent a drawerlayout. Announces Drawer on the left or right (Android).
- **slidingdrawer** Used to represent a slidingdrawer. Announces Sliding drawer opened (Android).
- **iconmenu** Used to represent a iconmenu. Announces Options, Drawer on the left or right (Android).

### `accessibilityState`

Expand Down