Reference describe()

describe()

Creates a screen reader-accessible description of the canvas.

The first parameter, text, is the description of the canvas.

The second parameter, display, is optional. It determines how the description is displayed. If LABEL is passed, as in describe('A description.', LABEL), the description will be visible in a div element next to the canvas. If FALLBACK is passed, as in describe('A description.', FALLBACK), the description will only be visible to screen readers. This is the default mode.

Read Writing accessible canvas descriptions to learn more about making sketches accessible.

Examples

Syntax

describe(text, [display])

Parameters

text
String:

description of the canvas.

display
Constant:

either LABEL or FALLBACK.

Notice any errors or typos? Please let us know. Please feel free to edit src/accessibility/describe.js and open a pull request!

Related References