@aotearoan/neon/dist/src/components/user-input/toggle-chip/NeonToggleChip.d.ts

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

import { NeonToggleChipSize } from '@/model/user-input/toggle/NeonToggleChipSize';
import { NeonFunctionalColor } from '@/model/common/color/NeonFunctionalColor';
/**
 * <p>
 * A Toggle chip component used to indicate an on/off state in form inputs. This is equivalent to a checkbox. This is a
 * variation of a checkbox/switch which can be used as an on/off button to trigger an action or used in a group for
 * filtering.
 * </p>
 */
declare const _default: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
    /**
     * The toggle chip model.
     */
    modelValue: {
        type: BooleanConstructor;
        required: true;
    };
    /**
     * The toggle label. Required unless overriding the slot contents.
     */
    label: {
        type: StringConstructor;
    };
    /**
     * The size of the toggle chip.
     */
    size: {
        type: () => NeonToggleChipSize;
        default: NeonToggleChipSize;
    };
    /**
     * The toggle chip color.
     */
    color: {
        type: () => NeonFunctionalColor;
        default: NeonFunctionalColor;
    };
    /**
     * Whether to display a checked icon on the toggle chip when it is 'on'.
     */
    showCheck: {
        type: BooleanConstructor;
        default: boolean;
    };
    /**
     * Disabled state of the toggle chip.
     */
    disabled: {
        type: BooleanConstructor;
        default: boolean;
    };
}>, {
    sanitizedAttributes: import("vue").ComputedRef<{
        [x: string]: unknown;
    }>;
    toggleChipLabel: import("vue").Ref<HTMLLabelElement | null, HTMLLabelElement | null>;
    emitInput: (value: boolean) => void;
    toggleChip: () => void;
}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, "update:modelValue"[], "update:modelValue", import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
    /**
     * The toggle chip model.
     */
    modelValue: {
        type: BooleanConstructor;
        required: true;
    };
    /**
     * The toggle label. Required unless overriding the slot contents.
     */
    label: {
        type: StringConstructor;
    };
    /**
     * The size of the toggle chip.
     */
    size: {
        type: () => NeonToggleChipSize;
        default: NeonToggleChipSize;
    };
    /**
     * The toggle chip color.
     */
    color: {
        type: () => NeonFunctionalColor;
        default: NeonFunctionalColor;
    };
    /**
     * Whether to display a checked icon on the toggle chip when it is 'on'.
     */
    showCheck: {
        type: BooleanConstructor;
        default: boolean;
    };
    /**
     * Disabled state of the toggle chip.
     */
    disabled: {
        type: BooleanConstructor;
        default: boolean;
    };
}>> & Readonly<{
    "onUpdate:modelValue"?: ((...args: any[]) => any) | undefined;
}>, {
    color: NeonFunctionalColor;
    disabled: boolean;
    size: NeonToggleChipSize;
    showCheck: boolean;
}, {}, {
    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;