@aotearoan/neon/dist/src/components/navigation/stepper/NeonStepper.d.ts

Neon is a lightweight design library of Vue 3 components with minimal dependencies.

import { NeonFunctionalColor } from '@/model/common/color/NeonFunctionalColor';
/**
 * A stepper component for assisting users in navigating through complex flows.
 */
declare const _default: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
    /**
     * An ordered list of the step names, these values are used for display purposes.
     */
    steps: {
        type: () => Array<string>;
        required: true;
    };
    /**
     * The index of the highest completed step (regardless of the current step the user has selected).
     * This is used to display the completed steps to the user.
     */
    completedIndex: {
        type: NumberConstructor;
        default: number;
    };
    /**
     * The index of the step that is currently selected.
     */
    modelValue: {
        type: NumberConstructor;
        default: number;
    };
    /**
     * The color of the Stepper component.
     */
    color: {
        type: () => NeonFunctionalColor;
        default: NeonFunctionalColor;
    };
}>, {
    emit: (event: "update:modelValue", ...args: any[]) => void;
}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, "update:modelValue"[], "update:modelValue", import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
    /**
     * An ordered list of the step names, these values are used for display purposes.
     */
    steps: {
        type: () => Array<string>;
        required: true;
    };
    /**
     * The index of the highest completed step (regardless of the current step the user has selected).
     * This is used to display the completed steps to the user.
     */
    completedIndex: {
        type: NumberConstructor;
        default: number;
    };
    /**
     * The index of the step that is currently selected.
     */
    modelValue: {
        type: NumberConstructor;
        default: number;
    };
    /**
     * The color of the Stepper component.
     */
    color: {
        type: () => NeonFunctionalColor;
        default: NeonFunctionalColor;
    };
}>> & Readonly<{
    "onUpdate:modelValue"?: ((...args: any[]) => any) | undefined;
}>, {
    color: NeonFunctionalColor;
    modelValue: number;
    completedIndex: number;
}, {}, {
    NeonIcon: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
        name: {
            type: StringConstructor;
            required: true;
        };
        id: {
            type: StringConstructor;
            default: null;
        };
        color: {
            type: () => NeonFunctionalColor;
            default: null;
        };
        inverse: {
            type: BooleanConstructor;
            default: boolean;
        };
        disabled: {
            type: BooleanConstructor;
            default: boolean;
        };
    }>, {
        sanitizedAttributes: import("vue").ComputedRef<{
            [x: string]: unknown;
        }>;
        icon: import("vue").ComputedRef<string | undefined>;
    }, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
        name: {
            type: StringConstructor;
            required: true;
        };
        id: {
            type: StringConstructor;
            default: null;
        };
        color: {
            type: () => NeonFunctionalColor;
            default: null;
        };
        inverse: {
            type: BooleanConstructor;
            default: boolean;
        };
        disabled: {
            type: BooleanConstructor;
            default: boolean;
        };
    }>> & Readonly<{}>, {
        color: NeonFunctionalColor;
        id: string;
        inverse: boolean;
        disabled: boolean;
    }, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
export default _default;