This is a lower-level API. Lower-level APIs are not recommended for most projects, and may not be available on all plans. See our page on recommended deployment patterns for more information.
Initialization Option Assess API

headings

This object provides options for customizing screen reader-only headings for Questions and Features headings by default. This makes it easier for students using screen readers to navigate an assessment without losing their place in the current Item.

Examples

var initializationOptions = {
    "configuration": {
        "accessibility": {
            "headings": {
                "question": {
                    "level": 4 // Render as <h4> instead of default <h3>
                },
                "feature": false // Disable Feature headings
            }
        }
    }
};

Values

Request object key configuration.accessibility.headings

Default: null

Type object

This object has the following properties which can be configured.

  • question boolean object

    This option controls whether the screen reader headings are displayed, or not.

  • feature boolean object

    This option controls whether the screen reader headings are displayed, or not.

Versioning

Version added: v2023.3.LTS

Was this article helpful?