Skip to main content

blockly > FieldCheckbox > getAriaValue

FieldCheckbox.getAriaValue() method​

Gets an ARIA-friendly label representation of this field's value.

Implementations are responsible for, and encouraged to, return a localized version of the ARIA representation of the field's value.

The FieldCheckbox implementation is not used for the actual ARIA label of the field, since the checked state is already included in the ARIA checked state, but it is used for the ARIA label of its source block.

Signature:

getAriaValue(): string | null;

Returns:

string | null

An ARIA representation of the field's text.