@aotearoan/neon/dist/src/components/presentation/label/NeonLabel.d.ts

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

import { NeonLabelSize } from '@/model/presentation/label/NeonLabelSize';
import { NeonFunctionalColor } from '@/model/common/color/NeonFunctionalColor';
import { NeonHorizontalPosition } from '@/model/common/position/NeonHorizontalPosition';
/**
 * Labels are used to tag or emphasize properties of an item in the UI. Labels can be text only, icon only or contain both text and icons.
 */
declare const _default: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
    /**
     * The label text
     */
    label: {
        type: StringConstructor;
        required: true;
    };
    /**
     * The name of the optional label icon
     */
    icon: {
        type: StringConstructor;
        default: null;
    };
    /**
     * The icon position if there is also text in the label. This is either left or right.
     */
    iconPosition: {
        type: () => NeonHorizontalPosition;
        default: NeonHorizontalPosition;
    };
    /**
     * The label size
     */
    size: {
        type: () => NeonLabelSize;
        default: NeonLabelSize;
    };
    /**
     * Display the label as disabled
     */
    disabled: {
        type: BooleanConstructor;
        default: boolean;
    };
    /**
     * The label color
     */
    color: {
        type: () => NeonFunctionalColor;
        default: NeonFunctionalColor;
    };
    /**
     * Alternate color for creating gradient labels. NOTE: can also be the same color as 'color'.
     */
    alternateColor: {
        type: () => NeonFunctionalColor;
        default: null;
    };
}>, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
    /**
     * The label text
     */
    label: {
        type: StringConstructor;
        required: true;
    };
    /**
     * The name of the optional label icon
     */
    icon: {
        type: StringConstructor;
        default: null;
    };
    /**
     * The icon position if there is also text in the label. This is either left or right.
     */
    iconPosition: {
        type: () => NeonHorizontalPosition;
        default: NeonHorizontalPosition;
    };
    /**
     * The label size
     */
    size: {
        type: () => NeonLabelSize;
        default: NeonLabelSize;
    };
    /**
     * Display the label as disabled
     */
    disabled: {
        type: BooleanConstructor;
        default: boolean;
    };
    /**
     * The label color
     */
    color: {
        type: () => NeonFunctionalColor;
        default: NeonFunctionalColor;
    };
    /**
     * Alternate color for creating gradient labels. NOTE: can also be the same color as 'color'.
     */
    alternateColor: {
        type: () => NeonFunctionalColor;
        default: null;
    };
}>> & Readonly<{}>, {
    color: NeonFunctionalColor;
    icon: string;
    disabled: boolean;
    size: NeonLabelSize;
    alternateColor: NeonFunctionalColor;
    iconPosition: NeonHorizontalPosition;
}, {}, {
    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;