Interface AnnounceData

Represents data, that can be used to announce text to screen reader.

Hierarchy

AnnounceData

Index

Properties

Properties

Optional ariaLiveMode

ariaLiveMode: "assertive" | "polite" | "off"

optional: if provided, will set the ariaLive property of the announce container element to the provided value.
see: https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Attributes/aria-live#values

Optional defaultStrings

defaultStrings: KnownAnnounceStrings

optional: Default announce strings built in Rooster

Optional formatStrings

formatStrings: string[]

optional: if provided, will attempt to replace {n} with each of the values inside of the array.

Optional text

text: string

optional: string to announce from this Content Changed event, will be the fallback value if default string is not provided or if it is not found in the strings map.

Generated using TypeDoc