@fiestaboard/ui 2.2.4 → 2.2.6

package/dist/components/board/board-display.d.ts

@@ -94,5 +94,17 @@ export interface BoardDisplayProps {
     emptyLabel?: string;
     /** Builds the accessible label for a shown message (color markup already stripped). */
     messageLabel?: (message: string) => string;
+    /** Announce message changes to assistive tech through a polite live region
+     *  (issue #206).
+     *
+     *  Off by default, and it has to be: this board's `aria-label` changing is
+     *  silent to a screen reader — only a change *inside* a live region is
+     *  announced — but a live region is only correct for a genuinely live
+     *  display, which only the consuming app knows. In an editor or a thumbnail
+     *  the message changes on every keystroke and the announcements would be
+     *  intolerable. Turn it on for a mirrored board (transit times, weather,
+     *  alerts) where a change is news. `polite`, never `assertive`: a board
+     *  update is informational. Same opt-in shape as `EmptyState`'s `announce`. */
+    announceUpdates?: boolean;
 }
-export declare const BoardDisplay: import("react").MemoExoticComponent<({ message, isLoading, size, className, boardType, deviceType, isStatic, notesWide, notesTall, emitCellMetadata, animationsEnabled, flapSpeed, loadingLabel, emptyLabel, messageLabel, }: BoardDisplayProps) => import("react").JSX.Element>;
+export declare const BoardDisplay: import("react").MemoExoticComponent<({ message, isLoading, size, className, boardType, deviceType, isStatic, notesWide, notesTall, emitCellMetadata, animationsEnabled, flapSpeed, loadingLabel, emptyLabel, messageLabel, announceUpdates, }: BoardDisplayProps) => import("react").JSX.Element>;