Reference describeElement()

describeElement()

Creates a screen reader-accessible description of elements in the canvas.

Elements are shapes or groups of shapes that create meaning together. For example, a few overlapping circles could make an "eye" element.

The first parameter, name, is the name of the element.

The second parameter, text, is the description of the element.

The third 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. Using LABEL creates unhelpful duplicates for screen readers. Only use LABEL during development. 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

describeElement(name, text, [display])

Parameters

name
String:

name of the element.

text
String:

description of the element.

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