@ux-aspects/ux-aspects
Version:
Open source user interface framework for building modern, responsive, mobile big data applications
45 lines (44 loc) • 2.32 kB
TypeScript
import { EventEmitter } from '@angular/core';
import * as i0 from "@angular/core";
export declare class WizardStepComponent {
private readonly _wizardService;
private readonly _changeDetector;
/** The text to be displayed in the wizard step tab. */
header: string;
/**
* If set to `true` the 'Next' or 'Finish' button will become disabled when the current step is invalid.
* This will override the value set on the `ux-wizard`.
*/
disableNextWhenInvalid: boolean | undefined;
/**
* Defines whether a step is valid. The user will not be able to proceed to the next step if this property has a value of false.
* If the new value is false is will also set the visited value to false.
*/
_valid: boolean;
set valid(value: boolean);
get valid(): boolean;
/**
* A custom function which returns the validation status for the step. This function will be called when 'Next' or
* 'Finish' is clicked. A promise may be returned if asynchronous validation is required. If using this property,
* ensure that `disableNextWhenInvalid` is false.
*/
validator: () => boolean | Promise<boolean>;
/**
* Defines whether or not this step has previously been visited.
* A visited step can be clicked on and jumped to at any time.
* By default, steps will become 'visited' when the user navigates to a step for the first time.
*/
visited: boolean;
/** Emits when visited changes. */
visitedChange: EventEmitter<boolean>;
set active(value: boolean);
get active(): boolean;
/**
* Defines the currently visible step.
*/
_active: boolean;
setVisitedAndEmitChangeEvent(value: boolean): void;
protected setValid(value: boolean): void;
static ɵfac: i0.ɵɵFactoryDeclaration<WizardStepComponent, never>;
static ɵcmp: i0.ɵɵComponentDeclaration<WizardStepComponent, "ux-wizard-step", never, { "header": { "alias": "header"; "required": false; }; "disableNextWhenInvalid": { "alias": "disableNextWhenInvalid"; "required": false; }; "valid": { "alias": "valid"; "required": false; }; "validator": { "alias": "validator"; "required": false; }; "visited": { "alias": "visited"; "required": false; }; }, { "visitedChange": "visitedChange"; }, never, ["*"], false, never>;
}