Web SDK documentation
  1. Interfaces
  2. Step

File

core/stepper/stepper.model.ts

Description

Steps of a stepper component.

Example:

providers: [{
  provide: HOOK_STEPPER,
  useValue: {
     id: Steppers.SETUP,
     label: 'Register devices',
     component: YourRegisterDeviceForm,
     priority: -1000
  },
  multi: true
}]

Index

Properties

Properties

component
component: Type<any>
Type : Type<any>

The component to render. You can inject the C8yStepper to manage steps or use the existing NgForm to validate the content of the form before the user can go on.

Example:

viewProviders: [{ provide: ControlContainer, useExisting: NgForm }]
injector
injector: Injector
Type : Injector
Optional

The injector to use. If not set, default injector will be used.
label
label: string
Type : string
Optional

The label to display.
priority
priority: number
Type : number
Optional

High priority will show the step sooner, low priority will show the step later. All hooked step are ordered first by priority then by name.
required
required: boolean
Type : boolean
Optional

Marks the step as required to complete the stepper.
stepperId
stepperId: string
Type : string

The id of the stepper outlet where the step should be attached to.

results matching ""

    No results matching ""