@microsoft/windows-admin-center-sdk/angular/src/controls/wizard/models/wizard-step.d.ts

Microsoft - Windows Admin Center Shell

import { Type } from '@angular/core';
import { WizardStepOptions } from './wizard-step-options';
/**
 * The representation of a step in the wizard component.
 */
export declare class WizardStep {
    readonly dynamicStepComponent: Type<any>;
    /**
     * The display name of the step.
     */
    name: string;
    /**
     * Whether or not the step is completed.
     */
    private isCompleted;
    /**
     * Whether or not the step is disabled.
     */
    private isDisabled;
    /**
     * Initializes a new instance of the WizardStep class.
     *
     * @param dynamicStepComponent - The component to dynamically render when the step is selected.
     * @param options - The options to supply the step with data.
     */
    constructor(dynamicStepComponent: Type<any>, options: WizardStepOptions);
    /**
     * Gets whether or not the step is completed.
     */
    get completed(): boolean;
    /**
     * Sets whether or not the step is completed.
     */
    set completed(value: boolean);
    /**
     * Gets whether or not the step is disabled.
     */
    get disabled(): boolean;
    /**
     * Sets whether or not the step is disabled.
     */
    set disabled(value: boolean);
    /**
     * Completes the step.
     */
    complete(): void;
    /**
     * Fails the step.
     */
    fail(): void;
}