Skip to main content
cngx-src documentation

AnnouncementPhraseOptions

Interface

projects/core/utils/announcement-phrase.ts

Import#

import { AnnouncementPhraseOptions } from '@cngx/core/utils'

Description#

Index#

Instance Properties#

Readonly

Returns the phrase for a voiced transition between two snapshots, or null when this change carries nothing to announce. An empty string is a valid phrase (it arms "silence") - only null falls through to the spend check.

ReadonlyOptional

Phrase at mount, before any transition. Defaults to the empty string so initial state is visible, never announced.

source#function
Readonly

Reactive snapshot the phrase derives from.

ReadonlyOptional

true when a transition must expire (spend) an armed phrase - e.g. a busy-state start whose later clear would otherwise re-announce the stale phrase through an aria-atomic region. Checked only when arm returned null.