Expo UI and Router for iOSExpo SDK 57 and later, iOS only
Modifiers

accessibilityElement

Controls how a view's child accessibility elements are exposed, mirroring SwiftUI's accessibilityElement(children:). It creates a new accessibility element (or modifies the existing one) and applies the chosen behavior to the subtree.

accessibilityElement(children)

ParameterTypeDescription
children(optional)'contain' | 'ignore' | 'combine'How the child accessibility elements are treated
  • ignore - hide the children; the new element starts with no properties, so pair it with accessibilityLabel (default).
  • combine - merge the children's accessibility properties into the new element.
  • contain - keep the children as accessible elements, grouped in the new element as a container (navigated in order).

. Default: 'ignore' |

Controls how a view's child accessibility elements are exposed, mirroring SwiftUI's accessibilityElement(children:). It creates a new accessibility element (or modifies the existing one) and applies the chosen behavior to the subtree.

Complements accessibilityHidden, which hides a single leaf, by acting on the whole subtree.

Returns: ModifierConfig

See: Official SwiftUI documentation.

Works with

You can add accessibilityElement to any view. It changes what you see on 20 of the 39 components.

No visible effect

These components accept it, but you see no change.

ComponentWhy nothing happens
SpacerIt joins the child views into one accessibility element, and Spacer takes no child views.
DividerIt joins the child views into one accessibility element, and Divider takes no child views.
ButtonIt joins the child views into one accessibility element, and Button takes no child views.
ToggleIt joins the child views into one accessibility element, and Toggle takes no child views.
CheckboxIt joins the child views into one accessibility element, and Checkbox takes no child views.
SliderIt joins the child views into one accessibility element, and Slider takes no child views.
PickerIt joins the child views into one accessibility element, and Picker takes no child views.
DatePickerIt joins the child views into one accessibility element, and DatePicker takes no child views.
ColorPickerIt joins the child views into one accessibility element, and ColorPicker takes no child views.
LinkIt joins the child views into one accessibility element, and Link takes no child views.
MenuIt joins the child views into one accessibility element, and Menu takes no child views.
TextFieldIt joins the child views into one accessibility element, and TextField takes no child views.
SecureFieldIt joins the child views into one accessibility element, and SecureField takes no child views.
TextIt joins the child views into one accessibility element, and Text takes no child views.
LabelIt joins the child views into one accessibility element, and Label takes no child views.
ImageIt joins the child views into one accessibility element, and Image takes no child views.
ProgressViewIt joins the child views into one accessibility element, and ProgressView takes no child views.
GaugeIt joins the child views into one accessibility element, and Gauge takes no child views.
AccessoryWidgetBackgroundIt joins the child views into one accessibility element, and AccessoryWidgetBackground takes no child views.

Sources

The original Expo docs for this page:

On this page