div-accessibility

Accessibility settings.

Parameters

Parameters Description
description

string

Element description. It is used as the main description for screen reading applications.

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.

is_checked

bool_int

Shows the current status of the checkbox or toggle: true means it's selected, false means it isn't selected.

menu

array

Named commands added to the accessibility service's action menu. The element's primary activation (for example, a VoiceOver double-tap) continues to execute its regular actions. Selecting a menu item executes only that item's actions, without falling back to the element's actions. If a menu item's actions list is empty or all its actions are disabled, that item is excluded from the commands available for execution. In merge mode, only the merging element's menu items are exposed; descendant menu items are not collected automatically. If exclude mode is set on the element or any of its ancestors, the element's menu items are hidden from the accessibility service.

Available platforms: iOS.

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.

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.

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.

JSON
{
  description: "string",
  hint: "string",
  is_checked: "bool_int",
  menu: [
    {
      actions*: [
        {
          download_callbacks: {
            on_fail_actions: [ div-action, ... ],
            on_success_actions: [ div-action, ... ]
          },
          is_enabled: "bool_int",
          log_id: "string",
          log_url: "string",
          menu_items: [
            {
              action: div-action,
              actions: [ div-action, ... ],
              text*: "string"
            },
            ...
          ],
          payload: "object",
          referer: "string",
          scope_id: "string",
          target: "string",
          typed: div-action-typed,
          url: "string"
        },
        ...
      ],
      label*: "string"
    },
    ...
  ],
  mode: "string",
  mute_after_action: "bool_int",
  state_description: "string",
  type: "string"
}