@aotearoan/neon
Version:
Neon is a lightweight design library of Vue 3 components with minimal dependencies.
115 lines (114 loc) • 2.91 kB
TypeScript
import { NeonFunctionalColor } from '@/common/enums/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<{
/**
* The label text to render.
*/
label: {
type: StringConstructor;
required: true;
};
/**
* 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;
};
/**
* Message to display below the input field.
*/
message: {
type: StringConstructor;
default: null;
};
/**
* The color of message displayed under input. Can be any functional color.
*/
messageColor: {
type: () => NeonFunctionalColor;
default: NeonFunctionalColor;
};
}, unknown, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
/**
* The label text to render.
*/
label: {
type: StringConstructor;
required: true;
};
/**
* 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;
};
/**
* Message to display below the input field.
*/
message: {
type: StringConstructor;
default: null;
};
/**
* The color of message displayed under input. Can be any functional color.
*/
messageColor: {
type: () => NeonFunctionalColor;
default: NeonFunctionalColor;
};
}>>, {
disabled: boolean;
message: string;
optional: boolean;
labelFor: string;
optionalLabel: string;
messageColor: NeonFunctionalColor;
}, {}>;
export default _default;