← Stepper API

Interface · v2.6.0

NgbStepperStep

Label, state and optional metadata for one step.

Import

import type { NgbStepperStep } from '@angular-bootstrap/ngbootstrap';

Declaration

interface NgbStepperStep

Properties

id

Optional string ID used to generate header and content IDs. The index is used when absent.

id?: string

label

Visible step label.

label?: string

description

Optional secondary description.

description?: string

state

Optional explicit visual state, which takes precedence over inferred states.

errorMessage

Error text displayed for the selected step. Error indicator inference requires the step to have been visited.

errorMessage?: string | null

optional

Displays the optional label; does not change application validation.

optional?: boolean

disabled

Disables header selection. An explicit, active or earlier-index state may still determine the indicator.

disabled?: boolean

Referenced types

Source: types/angular-bootstrap-ngbootstrap.d.ts in the installed @angular-bootstrap/ngbootstrap package. Angular compiler metadata and private members are omitted.

This project is not affiliated with ng-bootstrap or ngx-bootstrap. Those projects focus mainly on Bootstrap components for Angular. ngbootstrap focuses on Angular UI for data-heavy apps, especially Data Grid, Angular-native Form Builder, drag and drop workflows, documentation examples, and performance-focused Angular patterns.