CngxStepperI18n

Interface

projects/common/stepper/i18n/stepper-i18n.ts

Info
API

Import#

import { CngxStepperI18n } from '@cngx/common/stepper'

Description#

Stepper i18n surface. Library defaults are English; locales come from consumer overrides via provideStepperI18n. Sibling of CNGX_TABS_I18N / CNGX_CHART_I18N.

Index#

Properties

commitFailedRetry commitInFlight commitRolledBackTo nextStep previousStep selectedStep statusLabels stepCompleted stepErrored stepHasErrors stepIndicatorRoleDescription stepperLabel stepRolledBackSuffix textStepperFormat

Instance Properties#

commitFailedRetry#string

Readonly

Superseded by {@link commitRolledBackTo}. Retained as defensive fallback in `liveAnnouncement` when the origin label is unresolvable (unlabeled step, or `commitState` driven outside `select()`).

defensive fallback in liveAnnouncement when the origin label is unresolvable (unlabeled step, or commitState driven outside select()).

commitInFlight#string

Readonly

Polite SR announcement on idle → pending. Pillar 2.

commitRolledBackTo#function

Readonly

Origin-aware rollback phrase. Read on pending → error when both lastFailedIndex and originIndexDuringCommit resolve. Receives the safe-harbour label, yields e.g. Reverted to step "Customer"..

nextStep#string

Readonly

previousStep#string

Readonly

selectedStep#function

Readonly

statusLabels#CngxStepperStatusLabels

Readonly

Per-state pill labels surfaced by the stripe-status-rich skin (and any future skin / variant that paints a state pill). English defaults; consumer partial overrides via withStepperI18nLabels keep un-overridden keys intact.

stepCompleted#string

Readonly

stepErrored#string

Readonly

stepHasErrors#function

Readonly

stepIndicatorRoleDescription#string

Readonly

Landmark aria-roledescription for compact step-indicator surfaces such as the dot stepper and the mobile-dot collapse fallback. Mirrors the W3C APG step-indicator pattern.

stepperLabel#string

Readonly

stepRolledBackSuffix#string

Readonly

Persistent suffix on the per-step aria-describedby while presenter.lastFailedIndex() matches the step. Distinct from commitRolledBackTo (transient live-region phrase) - this suffix is reachable when AT users navigate back to the rejected step after the announcement has faded. Pillar 2.

textStepperFormat#function

Readonly

Short progress format used by CngxProgressBarStepper's optional step-count subtext and by CngxTextStepper. Receives the 1-based current position and total step count; default (current, total) => 'Step ${current} of ${total}'.