Skip to content

Properties

PropertiesTypesDescription
variantstring(optional) Can be text for text messages or content for whole application content. Defaults to text.
prioritystring(optional) Priority of the announcement. Can be low or high. Defaults to low.
delaynumber(optional) Delay in milliseconds before the announcement is made. Defaults to 1000.
disabledboolean(optional) If true, the announcement will not be made. Defaults to false.
atomicboolean(optional) If true, assistive technologies will present the entire region as a whole. If false, only additions will be announced.
politenessstring(optional) The politeness setting for the announcement. Can be polite or assertive.
relevantstring(optional) A space-separated list of the types of changes that should be announced. Can be additions, removals, text, or all.
showAnnouncementboolean(optional) Whether to show the children or not.
childrenReactNodeThe content that will be announced to the user.