div-accessibility

Accessibility settings.

Parameters

Parameters	Description
`description`	string Element description. It is used as the main description for screen reading applications. Available platforms: Android, iOS, web.
`hint`	string A tooltip of what will happen during interaction. If Speak Hints is enabled in the VoiceOver settings on iOS, a tooltip is played after `description`. Available platforms: Android, iOS.
`is_checked`	bool_int Indicates the current status of the checkbox or radio button. `true` is selected, `false` is not selected. Available platforms: web.
`mode`	string The way the accessibility tree is organized. In the `merge` mode the accessibility service perceives an element together with a subtree as a whole. In the `exclude` mode an element together with a subtree isn't available for accessibility. Possible values: `default`, `merge`, `exclude`. Default value: `default`. Available platforms: Android, iOS.
`mute_after_action`	bool_int Mutes the screen reader sound after interacting with the element. Default value: `false`. Available platforms: iOS.
`state_description`	string Description of the current state of an element. For example, in the description you can specify a selected date for a date selection element and an on/off state for a switch. Available platforms: Android, iOS.
`type`	string Element role. Used to correctly identify an element by the accessibility service. For example, the `list` element is used to group list elements into one element. Possible values: `none`, `button`, `image`, `text`, `edit_text`, `header`, `tab_bar`, `list`, `select`, `checkbox`, `radio`, `auto`. Default value: `auto`. Available platforms: Android, iOS, web.

JSON

{
  description: "string",
  hint: "string",
  is_checked: "bool_int",
  mode: "string",
  mute_after_action: "bool_int",
  state_description: "string",
  type: "string"
}

div-accessibility

Parameters

Was the article helpful?