Skip to main content

Interface: LiveDescriptors

Live descriptors are written in an aria live region describing the state of the tree to accessibility readers. They are displayed in a visually hidden area at the bottom of the tree. Each descriptor composes a HTML string. Variables in the form of {variableName} can be used.

The {keybinding:bindingname} variable refers to a specific keybinding, i.e. {keybinding:primaryAction} is a valid variable.

See the implementation of the defaultLiveDescriptors for more details.

Properties

introduction

introduction: string

Supports the following variables: {treeLabel} {keybinding:bindingname}

Defined in

types.ts:493


programmaticallyDragging

programmaticallyDragging: string

Supports the following variables: {dropTarget} {dragItems} {keybinding:bindingname}

Defined in

types.ts:511


programmaticallyDraggingTarget

programmaticallyDraggingTarget: string

Will be displayed in addition to the programmaticallyDragging description, but with the aria-live attribute assertive.

Supports the following variables: {dropTarget} {dragItems} {keybinding:bindingname}

Defined in

types.ts:520


renamingItem

renamingItem: string

Supports the following variables: {renamingItem} {keybinding:bindingname}

Defined in

types.ts:499


searching

searching: string

Supports the following variables: {keybinding:bindingname}

Defined in

types.ts:505