@siemens/element-ng 47.2.0 → 47.3.0

package/wizard/si-wizard-step.component.d.ts

@@ -0,0 +1,21 @@
+import * as i0 from "@angular/core";
+export declare class SiWizardStepComponent {
+    /** @defaultValue '' */
+    readonly heading: import("@angular/core").InputSignal<string>;
+    /** @defaultValue true */
+    readonly isValid: import("@angular/core").InputSignalWithTransform<boolean, unknown>;
+    /** @defaultValue true */
+    readonly isNextNavigable: import("@angular/core").InputSignalWithTransform<boolean, unknown>;
+    /** @defaultValue false */
+    readonly failed: import("@angular/core").InputSignalWithTransform<boolean, unknown>;
+    readonly next: import("@angular/core").OutputEmitterRef<void>;
+    readonly back: import("@angular/core").OutputEmitterRef<void>;
+    readonly save: import("@angular/core").OutputEmitterRef<void>;
+    /**
+     * Whether this step is currently active or not.
+     * @defaultValue false
+     */
+    readonly isActive: import("@angular/core").WritableSignal<boolean>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<SiWizardStepComponent, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<SiWizardStepComponent, "si-wizard-step", never, { "heading": { "alias": "heading"; "required": false; "isSignal": true; }; "isValid": { "alias": "isValid"; "required": false; "isSignal": true; }; "isNextNavigable": { "alias": "isNextNavigable"; "required": false; "isSignal": true; }; "failed": { "alias": "failed"; "required": false; "isSignal": true; }; }, { "next": "next"; "back": "back"; "save": "save"; }, never, ["*"], true, never>;
+}

package/wizard/si-wizard.component.d.ts

@@ -0,0 +1,196 @@
+import { AfterContentInit, ElementRef, OnDestroy } from '@angular/core';
+import { SiWizardStepComponent } from './si-wizard-step.component';
+import * as i0 from "@angular/core";
+interface StepItem {
+    index: number;
+    step: SiWizardStepComponent;
+}
+export declare class SiWizardComponent implements AfterContentInit, OnDestroy {
+    private wizardSteps;
+    protected readonly containerSteps: import("@angular/core").Signal<ElementRef<HTMLDivElement> | undefined>;
+    /**
+     * Description of back button.
+     *
+     * @defaultValue
+     * ```
+     * $localize`:@@SI_WIZARD.BACK:Back`
+     * ```
+     */
+    readonly backText: import("@angular/core").InputSignal<import("@siemens/element-translate-ng/translate").TranslatableString>;
+    /**
+     * Description of next button.
+     *
+     * @defaultValue
+     * ```
+     * $localize`:@@SI_WIZARD.NEXT:Next`
+     * ```
+     */
+    readonly nextText: import("@angular/core").InputSignal<import("@siemens/element-translate-ng/translate").TranslatableString>;
+    /**
+     * @deprecated Use {@link hideNavigation} instead.
+     *
+     * @defaultValue true
+     */
+    readonly hasNavigation: import("@angular/core").InputSignalWithTransform<boolean, unknown>;
+    /**
+     * Hide the navigation buttons previous/next.
+     *
+     * @defaultValue false
+     */
+    readonly hideNavigation: import("@angular/core").InputSignalWithTransform<boolean, unknown>;
+    /**
+     * Description of save button.
+     *
+     * @defaultValue
+     * ```
+     * $localize`:@@SI_WIZARD.SAVE:Save`
+     * ```
+     */
+    readonly saveText: import("@angular/core").InputSignal<import("@siemens/element-translate-ng/translate").TranslatableString>;
+    /**
+     * Hide the save button.
+     *
+     * @defaultValue false
+     */
+    readonly hideSave: import("@angular/core").InputSignalWithTransform<boolean, unknown>;
+    /**
+     * Text shown if you complete the wizard.
+     *
+     * @defaultValue
+     * ```
+     * $localize`:@@SI_WIZARD.COMPLETED:Wizard completed!`
+     * ```
+     */
+    readonly completionText: import("@angular/core").InputSignal<import("@siemens/element-translate-ng/translate").TranslatableString>;
+    /**
+     * Description of cancel button.
+     *
+     * @defaultValue
+     * ```
+     * $localize`:@@SI_WIZARD.CANCEL:Cancel`
+     * ```
+     */
+    readonly cancelText: import("@angular/core").InputSignal<import("@siemens/element-translate-ng/translate").TranslatableString>;
+    /**
+     * Show the cancel button
+     *
+     * @defaultValue false
+     */
+    readonly hasCancel: import("@angular/core").InputSignalWithTransform<boolean, unknown>;
+    /**
+     * Display a predefined page by the end of the wizard.
+     *
+     * @defaultValue false
+     */
+    readonly enableCompletionPage: import("@angular/core").InputSignalWithTransform<boolean, unknown>;
+    /**
+     * Define how many milliseconds the completion page is visible.
+     *
+     * @defaultValue 3000
+     */
+    readonly completionPageVisibleTime: import("@angular/core").InputSignal<number>;
+    /**
+     * Class name of icon shown for current and upcoming steps.
+     *
+     * @defaultValue 'elementNotChecked'
+     */
+    readonly stepIcon: import("@angular/core").InputSignal<string>;
+    /**
+     * Class name of icon shown for the active step.
+     *
+     * @defaultValue 'elementRadioChecked'
+     */
+    readonly stepActiveIcon: import("@angular/core").InputSignal<string>;
+    /**
+     * Class name of icon shown when a step was completed.
+     *
+     * @defaultValue 'elementCheckedFilled'
+     */
+    readonly stepCompletedIcon: import("@angular/core").InputSignal<string>;
+    /**
+     * Class name of icon shown when a step had an error.
+     *
+     * @defaultValue 'elementWarningFilled'
+     */
+    readonly stepFailedIcon: import("@angular/core").InputSignal<string>;
+    /**
+     * Set the orientation of the wizard to vertical.
+     *
+     * @defaultValue false
+     */
+    readonly verticalLayout: import("@angular/core").InputSignalWithTransform<boolean, unknown>;
+    /**
+     * Set false to show navigation buttons in footer instead of inline.
+     *
+     * @defaultValue true
+     */
+    readonly inlineNavigation: import("@angular/core").InputSignalWithTransform<boolean, unknown>;
+    /**
+     * Use number representation for steps.
+     *
+     * @defaultValue false
+     */
+    readonly showStepNumbers: import("@angular/core").InputSignalWithTransform<boolean, unknown>;
+    /**
+     * Set to true to display a divider between the steps and the content in the vertical
+     *
+     * @defaultValue false
+     */
+    readonly showVerticalDivider: import("@angular/core").InputSignalWithTransform<boolean, unknown>;
+    /** Set the wizard step container min size in vertical layout. */
+    readonly verticalMinSize: import("@angular/core").InputSignal<string | undefined>;
+    /** Set the wizard step container max size in vertical layout. */
+    readonly verticalMaxSize: import("@angular/core").InputSignal<string | undefined>;
+    /** Callback function triggered after the wizard has been completed. */
+    readonly completionAction: import("@angular/core").OutputEmitterRef<void>;
+    /** Callback function triggered if the wizard has been canceled. */
+    readonly wizardCancel: import("@angular/core").OutputEmitterRef<void>;
+    /**
+     * Callback function triggered if the wizard has been canceled.
+     * @deprecated use {@link wizardCancel} instead
+     */
+    readonly cancel: import("@angular/core").OutputEmitterRef<void>;
+    /** Get the current step wizard step index. */
+    get index(): number;
+    /** Get number of wizard steps. */
+    get stepCount(): number;
+    /** Get current visible wizard step. */
+    get currentStep(): SiWizardStepComponent | undefined;
+    protected steps: SiWizardStepComponent[];
+    protected visibleSteps: number;
+    protected readonly showCompletionPage: import("@angular/core").WritableSignal<boolean>;
+    /** The list of visible steps. */
+    protected readonly activeSteps: import("@angular/core").WritableSignal<StepItem[]>;
+    protected readonly shouldHideNavigation: import("@angular/core").Signal<boolean>;
+    private readonly _index;
+    private readonly _currentStep;
+    protected readonly icons: Record<"elementNotChecked" | "elementRadioChecked" | "elementCheckedFilled" | "elementWarningFilled" | "elementCancel" | "elementChecked" | "elementLeft4" | "elementRight4", string>;
+    private destroyer;
+    ngAfterContentInit(): void;
+    ngOnDestroy(): void;
+    protected canActivate(stepIndex: number): boolean;
+    protected activateStep(event: Event, stepIndex: number): void;
+    protected getStateClass(stepIndex: number): string;
+    protected getAriaDisabled(stepIndex: number): string;
+    protected getAriaCurrent(stepIndex: number): string;
+    /**
+     * Go to the next wizard step.
+     * @param delta - optional number of steps to move forward.
+     */
+    next(delta?: number): void;
+    /**
+     * Go to the previous wizard step.
+     * @param delta - optional number of steps to move backwards.
+     */
+    back(delta?: number): void;
+    /** Triggers the save action to complete the wizard. */
+    save(): void;
+    protected getState(step: SiWizardStepComponent, stepIndex: number): string;
+    private activate;
+    protected calculateNumberOfVisibleSteps(): void;
+    private updateSteps;
+    private updateVisibleSteps;
+    static ɵfac: i0.ɵɵFactoryDeclaration<SiWizardComponent, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<SiWizardComponent, "si-wizard", never, { "backText": { "alias": "backText"; "required": false; "isSignal": true; }; "nextText": { "alias": "nextText"; "required": false; "isSignal": true; }; "hasNavigation": { "alias": "hasNavigation"; "required": false; "isSignal": true; }; "hideNavigation": { "alias": "hideNavigation"; "required": false; "isSignal": true; }; "saveText": { "alias": "saveText"; "required": false; "isSignal": true; }; "hideSave": { "alias": "hideSave"; "required": false; "isSignal": true; }; "completionText": { "alias": "completionText"; "required": false; "isSignal": true; }; "cancelText": { "alias": "cancelText"; "required": false; "isSignal": true; }; "hasCancel": { "alias": "hasCancel"; "required": false; "isSignal": true; }; "enableCompletionPage": { "alias": "enableCompletionPage"; "required": false; "isSignal": true; }; "completionPageVisibleTime": { "alias": "completionPageVisibleTime"; "required": false; "isSignal": true; }; "stepIcon": { "alias": "stepIcon"; "required": false; "isSignal": true; }; "stepActiveIcon": { "alias": "stepActiveIcon"; "required": false; "isSignal": true; }; "stepCompletedIcon": { "alias": "stepCompletedIcon"; "required": false; "isSignal": true; }; "stepFailedIcon": { "alias": "stepFailedIcon"; "required": false; "isSignal": true; }; "verticalLayout": { "alias": "verticalLayout"; "required": false; "isSignal": true; }; "inlineNavigation": { "alias": "inlineNavigation"; "required": false; "isSignal": true; }; "showStepNumbers": { "alias": "showStepNumbers"; "required": false; "isSignal": true; }; "showVerticalDivider": { "alias": "showVerticalDivider"; "required": false; "isSignal": true; }; "verticalMinSize": { "alias": "verticalMinSize"; "required": false; "isSignal": true; }; "verticalMaxSize": { "alias": "verticalMaxSize"; "required": false; "isSignal": true; }; }, { "completionAction": "completionAction"; "wizardCancel": "wizardCancel"; }, ["wizardSteps"], ["*"], true, never>;
+}
+export {};

package/wizard/si-wizard.module.d.ts

@@ -0,0 +1,8 @@
+import * as i0 from "@angular/core";
+import * as i1 from "./si-wizard.component";
+import * as i2 from "./si-wizard-step.component";
+export declare class SiWizardModule {
+    static ɵfac: i0.ɵɵFactoryDeclaration<SiWizardModule, never>;
+    static ɵmod: i0.ɵɵNgModuleDeclaration<SiWizardModule, never, [typeof i1.SiWizardComponent, typeof i2.SiWizardStepComponent], [typeof i1.SiWizardComponent, typeof i2.SiWizardStepComponent]>;
+    static ɵinj: i0.ɵɵInjectorDeclaration<SiWizardModule>;
+}