@aotearoan/neon/dist/src/components/user-input/field/NeonField.d.ts

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

import { NeonFunctionalColor } from '@/model/common/color/NeonFunctionalColor';
/**
 * An HTML label implementation supporting optional labels. Use in the same way as an HTML label either wrapping the input
 * or using the label alongside the input.
 */
declare const _default: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
    /**
     * The label text to render.
     */
    label: {
        type: StringConstructor;
    };
    /**
     * The equivalent of the <em>for</em> attribute on an HTML label.
     */
    labelFor: {
        type: StringConstructor;
        default: null;
    };
    /**
     * Display an "optional" indicator with the label.
     */
    optional: {
        type: BooleanConstructor;
        default: boolean;
    };
    /**
     * Display label with disabled state.
     */
    disabled: {
        type: BooleanConstructor;
        default: boolean;
    };
    /**
     * The default "optional" label text.
     */
    optionalLabel: {
        type: StringConstructor;
        default: string;
    };
    /**
     * Remove empty message space below input. By default, a blank message will be displayed below each input which
     * helps simplify form layouts.
     */
    noMessage: {
        type: BooleanConstructor;
        default: boolean;
    };
    /**
     * Message to display below the input field.
     */
    message: {
        type: StringConstructor;
        default: string;
    };
    /**
     * The color of message displayed under input. Can be any functional color.
     */
    messageColor: {
        type: () => NeonFunctionalColor;
        default: NeonFunctionalColor;
    };
}>, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
    /**
     * The label text to render.
     */
    label: {
        type: StringConstructor;
    };
    /**
     * The equivalent of the <em>for</em> attribute on an HTML label.
     */
    labelFor: {
        type: StringConstructor;
        default: null;
    };
    /**
     * Display an "optional" indicator with the label.
     */
    optional: {
        type: BooleanConstructor;
        default: boolean;
    };
    /**
     * Display label with disabled state.
     */
    disabled: {
        type: BooleanConstructor;
        default: boolean;
    };
    /**
     * The default "optional" label text.
     */
    optionalLabel: {
        type: StringConstructor;
        default: string;
    };
    /**
     * Remove empty message space below input. By default, a blank message will be displayed below each input which
     * helps simplify form layouts.
     */
    noMessage: {
        type: BooleanConstructor;
        default: boolean;
    };
    /**
     * Message to display below the input field.
     */
    message: {
        type: StringConstructor;
        default: string;
    };
    /**
     * The color of message displayed under input. Can be any functional color.
     */
    messageColor: {
        type: () => NeonFunctionalColor;
        default: NeonFunctionalColor;
    };
}>> & Readonly<{}>, {
    disabled: boolean;
    message: string;
    optional: boolean;
    labelFor: string;
    optionalLabel: string;
    noMessage: boolean;
    messageColor: NeonFunctionalColor;
}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
export default _default;