Skip to main content

announce()

sends a message to the grid's live region so a screen reader announces a status change that happened without moving focus

Usage​

announce(message: string): void;

Parameters:

  • message: string - the message to announce. Pass an empty string to clear the region without announcing anything

Example​

const grid = new dhx.Grid("grid_container", { columns, data });

// announce the result of a filter applied outside the grid
grid.data.filter(item => item.country === "Italy");
grid.announce(`${grid.data.getLength()} rows match the filter`);

The Grid announces its own sorting, filtering, data loading and editor validation. Use announce() for status changes that your code makes, such as a filter applied from an external control.

Related articles:

Change log:

added in v9.4