config.configuration.accessibility.headings.question - Initialization - Items API

Items API Initialization

question

This option controls whether the screen reader headings are displayed, or not. You can also customize the level of the headings.

Values

Attribute path config.configuration.accessibility.headings.question

  • Type boolean

    A boolean value indicating whether screen reader-only Question headings should be rendered.

    If this value omitted, or set to true, then each Question will be preceded by a <h3> heading by default. The first such heading will be the initial focused element when the learner navigates to a screen reader Item.

    If this value is set to false, then the screen reader-only Question headings will not be rendered; and as such, the Item wrapper will be the initial focused element when the learner navigates to a screen reader Item.

    Note This works as long as there isn't also a Feature with accessibility headings enabled as the first Widget in an Item.

    This Item wrapper will have a customizable aria-label keyed by aria.item in the internationalization label bundle.

  • Type object

    Options for customizing the screen reader-only Question accessibility headings.

    • level number

      A number between 1 and 6, indicating the section level of the screen reader-only Question accessibility heading elements. This will override the default <h3> heading elements.

Versioning

Version added: v2023.3.LTS

Was this article helpful?

Did you arrive here by accident? If so, learn more about Learnosity.