Skip to main content

ariaLabel

Optional. Sets the accessible name of the grid, which a screen reader announces when focus enters the grid

Usage​

ariaLabel?: string;

Example​

const grid = new dhx.Grid("grid_container", {
columns: [
// columns config
],
data: dataset,
ariaLabel: "Orders"
});

The value is rendered as the aria-label attribute of the element with the grid role (the treegrid role in the TreeGrid mode). Use the property to tell several grids on one page apart. If the property is not set, the grid has no accessible name.

An aria-label attribute set on the container of the grid does not name the grid, because the element with the grid role is nested inside the container.

Related article: Grid accessibility

Change log:

added in v9.4