Skip to main content
cngx-src documentation

CngxStep

DirectivePrimaryv0.1.0WCAG AA

projects/common/stepper/step.directive.ts

Import#

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

Description#

Single-step atom. Registers with the nearest host - either a CngxStepGroup (CNGX_STEP_GROUP_HOST) or the root CngxStepperPresenter (CNGX_STEPPER_HOST).

state is a linkedSignal over [disabled], [completed], and the optional [errorAggregator]'s hasError().

https://cngxjs.github.io/cngx/examples/#/ui/stepper/stepper-step-content/typed-lazy-panels

Metadata#

Index#

Inputs#

completed#boolean
input()
default false
disabled#boolean
input()
default false
error#string | boolean
input()

Direct error flag for the common "this step is invalid" case - no errorAggregator boilerplate required. true or a non-empty string drives the error state; a string doubles as the inline message (surfaced via the *cngxStepError slot and the mini-skin aggregate line). false / '' clear it. The aggregator stays the rich multi-source forms path; the two channels compose (either errors).

default false
input()
default nextUid('cngx-step')
label#string
input()
default ''

Instance Properties#

contentSlot#unknown
contentChild()ProtectedReadonly
contentChild(CngxStepContent)
contentTemplate#unknown
Readonly
this.contentSlot
labelSlot#unknown
contentChild()ProtectedReadonly
contentChild(CngxStepLabel)
labelTemplate#unknown
Readonly
this.labelSlot