@aotearoan/neon
Version:
Neon is a lightweight design library of Vue 3 components with minimal dependencies.
110 lines (109 loc) • 2.97 kB
TypeScript
import { NeonToggleChipSize } from '@/common/enums/NeonToggleChipSize';
import { NeonFunctionalColor } from '@/common/enums/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<{
/**
* 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>;
emitInput: (value: boolean) => void;
toggleChip: () => void;
}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, "update:modelValue"[], "update:modelValue", import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, 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;
};
}>> & {
"onUpdate:modelValue"?: ((...args: any[]) => any) | undefined;
}, {
disabled: boolean;
size: NeonToggleChipSize;
color: NeonFunctionalColor;
showCheck: boolean;
}, {}>;
export default _default;