Interface Options

packages/dom/src/core/plugins/accessibility/Accessibility.ts:17–46

import {createLiveRegion} from './LiveRegion.ts';

interface Options {
  /**
   * Optional id that should be used for the accessibility plugin's screen reader instructions and announcements.
   */
  id?: string;
  /**
   * Optional id prefix to use for the accessibility plugin's screen reader instructions and announcements.
   */
  idPrefix?: {
    description?: string;
    announcement?: string;
  };
  /**
   * The announcements to use for the accessibility plugin.
   */
  announcements?: Announcements;
  /**
   * The screen reader instructions to use for the accessibility plugin.
   */
  screenReaderInstructions?: ScreenReaderInstructions;
  /**
   * The number of milliseconds to debounce the announcement updates.
   *
   * @remarks
   * Only the `dragover` and `dragmove` announcements are debounced.
   *
   * @default 500
   */
  debounce?: number;
}

const debouncedEvents = ['dragover', 'dragmove'];