injectStepperConfig Inject
provideStepperConfig Provider
provideStepperConfigAt Provider
withDotStepperDotTemplate Feature
withStepBadgeTemplate Feature
withStepBusySpinnerTemplate Feature
withStepErrorTemplate Feature
withStepGroupHeaderTemplate Feature
withStepIndicatorTemplate Feature
withStepperAriaLabels Feature
withStepperCommitMode Feature
withStepperConnectors Feature
withStepperDefaultOrientation Feature
withStepperDensity Feature
withStepperEmptyTemplate Feature
withStepperFallbackLabels Feature
withStepperGroupCollapse Feature
withStepperGroupCollapseSummary Feature
withStepperHeaderNavigation Feature
withStepperLinear Feature
withStepperMobileCollapse Feature
withStepperMobileIndicatorPosition Feature
withStepperMobileSwipe Feature
withStepperRouterSync Feature
withStepperSkin Feature
withStepRejectionTemplate Feature
Inject the resolved stepper config in an injection context.
provideStepperConfig(...features: undefined)
Root-level provider for the stepper config. Apply once in the
application providers array. Sibling of provideTabsConfig /
provideSelectConfig.
provideStepperConfigAt#Provider[] provideStepperConfigAt(...features: undefined)
Component-scoped config override. Spread the returned Provider[]
into providers or viewProviders - viewProviders cannot accept
opaque EnvironmentProviders, so the twin returns a list.
Sibling of provideTabsConfigAt.
Resolution priority: per-instance Input > viewProviders (At) >
root provider > library default.
withDotStepperDotTemplate(template: TemplateRef)
Override the default *cngxDotStepperDot template app-wide. The
<cngx-dot-stepper> variant resolves the cascade per dot:
per-instance directive > this feature > built-in empty body
(the dot fill is painted by .cngx-dot-stepper__dot regardless).
withStepBadgeTemplate(template: TemplateRef)
Override the default *cngxStepBadge template app-wide.
withStepBusySpinnerTemplate(template: TemplateRef)
Override the default *cngxStepBusySpinner template app-wide.
withStepErrorTemplate(template: TemplateRef)
Override the default *cngxStepError template app-wide. The slot
renders the per-step validation reason on the skins with a label area
(classic / stripe-status-rich). Per-instance directive still wins;
this moves the cascade middle tier.
withStepIndicatorTemplate(template: TemplateRef)
Override the default *cngxStepIndicator template app-wide.
Per-instance directive still wins; this only moves the cascade
middle tier.
withStepperAriaLabels(labels: CngxStepperAriaLabels)
Merge ARIA labels into the cascade. Keys not provided keep their
library defaults; per-instance overrides on the stepper still win.
withStepperCommitMode(mode)
Override the default commit mode for async step transitions.
'optimistic' advances on action dispatch and rolls back on error;
'pessimistic' waits for success. Per-instance [commitMode]
Input still wins.
withStepperConnectors(on: boolean)
Opt the classic <cngx-stepper> skin into the connector-rail
presentation: a solid completed/upcoming rail between adjacent step
indicators, horizontal and vertical, with per-segment coloring driven
by the preceding step's [data-state]. The rule is double-scoped on
[data-skin='classic']; the four other skins each ship their own
inter-step decoration and ignore this flag. Per-instance
[connectors] Input still wins.
withStepperDefaultOrientation(orientation)
Override the default orientation. Per-instance [orientation]
Input still wins; this only moves the cascade default.
withStepperDensity(mode: CngxStepperDensity, breakpoints?: CngxStepperDensityBreakpoints)
Set the app-wide space-driven density policy for the classic
<cngx-stepper> strip. 'auto' degrades labels on the strip's own
container width (full -> compact -> minimal); 'comfortable'
(library default) keeps full labels at every width. The optional
second argument overrides the per-step px thresholds (default
STEPPER_DEFAULT_DENSITY_BREAKPOINTS). Orthogonal to the
mobileCollapse axis; the Material twin ignores this setting.
withStepperEmptyTemplate(template: TemplateRef)
Override the default *cngxStepperEmpty template app-wide.
withStepperFallbackLabels(labels: CngxStepperFallbackLabels)
Merge fallback role descriptions (groupRoleDescription /
stepRoleDescription) into the cascade. These feed the strip's
aria-roledescription attributes when the consumer supplies none.
withStepperGroupCollapse(mode: CngxStepperGroupCollapse)
Set the app-wide focus-driven group-collapse policy for grouped
<cngx-stepper> flows. 'expand-active' collapses every non-active
cngxStepGroup branch to its header node and expands only the group
holding the active step; 'off' (library default) keeps the full
strip. Orthogonal to the mobileCollapse axis. The Material twin
ignores this setting.
withStepperGroupCollapseSummary(mode: CngxStepperGroupSummary)
Choose what a collapsed cngxStepGroup header shows beside its label
under groupCollapse: 'expand-active'. 'progress' (library default)
shows completed/total steps; 'count' the step count; 'status' a
status dot coloured by the group's rolled-up state; 'off' the bare
label. No effect unless groupCollapse is 'expand-active'.
withStepperLinear(linear: boolean)
Override the default linear-progression setting. Per-instance
[linear] Input still wins.
withStepperMobileCollapse(mode: CngxStepperMobileCollapse)
Configure the mobile auto-collapse target for <cngx-stepper>. Below
30rem of the stepper's own container width, the classic strip swaps
to the chosen variant - 'text' (default) renders
<cngx-text-stepper>, 'dots' renders <cngx-dot-stepper>, 'off'
keeps the classic strip. The Material twin <cngx-mat-stepper> ignores
this setting.
withStepperMobileIndicatorPosition(position: CngxStepperMobileIndicatorPosition)
Set the app-wide default position of the mobile auto-collapse
indicator relative to panel content. 'top' keeps the indicator
above (library default); 'bottom' flips it below so panel content
reads first and the navigation cue sits at thumb height. Per-
instance [mobileIndicatorPosition] on <cngx-stepper> still
wins.
withStepperMobileSwipe(enabled: boolean)
Toggle the built-in horizontal-swipe navigation on <cngx-stepper>
in mobile-collapse mode. Default true - the 'dots' and 'text'
variants read as carousels, so users expect to swipe. Per-instance
[mobileSwipe] Input still wins; the classic strip is unaffected.
withStepperRouterSync(mode, param: string)
Configure router synchronisation for the active step. mode chooses
the URL surface (URL fragment or query parameter); param names the
key (default 'step').
withStepperSkin(skin: CngxStepperSkin)
Select the visual skin for the cngx-standard <cngx-stepper>. The
default is 'classic'. Per-instance [skin] Input still wins; this
moves the cascade default. Structure, slots, ARIA, and keyboard
behaviour are identical across skins - only the [data-skin] host
attribute changes the CSS layer that paints the strip.
withStepRejectionTemplate(template: TemplateRef)
Override the default *cngxStepRejection template app-wide.
Symmetric with the upcoming tabs cngxTabRejectionIcon (Phase 4).