@inkline/inkline
Version:
Inkline is the intuitive UI Components library that gives you a developer-friendly foundation for building high-quality, accessible, and customizable Vue.js 3 Design Systems.
271 lines (270 loc) • 6.85 kB
TypeScript
import type { PropType } from 'vue';
declare const _default: import("vue").DefineComponent<{
/**
* The default button props of the checkbox buttons
* @type Object
* @default {}
* @name buttonProps
*/
buttonProps: {
type: PropType<CheckboxButtonOption>;
default: () => {};
};
/**
* The fallback label of the checkbox buttons. Can be a string, number, render function, or component
* @type String | Number | Boolean | Function | Object
* @default undefined
* @name label
*/
label: {
type: PropType<CheckboxButtonOption>;
default: undefined;
};
/**
* The color variant of the checkbox buttons
* @type light | dark
* @default
* @name color
*/
color: {
type: StringConstructor;
default: undefined;
};
/**
* The disabled state of the checkbox buttons
* @type Boolean
* @default false
* @name disabled
*/
disabled: {
type: BooleanConstructor;
default: boolean;
};
/**
* The error state of the checkbox, computed based on schema by default.
* @type Boolean | Array
* @default ['touched', 'dirty', 'invalid']
* @TODO use propDefaultValue to set default value
* @name error
*/
error: {
type: PropType<boolean | string[]>;
default: () => string[];
};
/**
* Used to set the checkbox buttons value
* @default []
* @name modelValue
*/
modelValue: {
type: PropType<CheckboxButtonOption[]>;
default: () => never[];
};
/**
* The unique identifier of the checkbox buttons
* @type String
* @default uid()
* @name name
*/
name: {
type: StringConstructor;
default: () => string;
};
/**
* The options to be rendered as checkbox buttons
* @type Array
* @default []
* @name options
*/
options: {
type: PropType<CheckboxButtonOption[]>;
default: () => never[];
};
/**
* The readonly state of the checkbox buttons
* @type Boolean
* @default false
* @name readonly
*/
readonly: {
type: BooleanConstructor;
default: boolean;
};
/**
* The size variant of the checkbox buttons
* @type sm | md | lg
* @default
* @name size
*/
size: {
type: StringConstructor;
default: undefined;
};
/**
* Enable checkbox buttons validation using schema
* @type Boolean
* @default true
* @name validateSchema
*/
validate: {
type: BooleanConstructor;
default: boolean;
};
/**
* The style variant of the checkbox buttons
* @type default | button-group
* @default default
* @name variant
*/
variant: {
type: PropType<CheckableButtonGroupVariant>;
default: string;
};
}, {
classes: import("vue").ComputedRef<{
[x: string]: any;
'-disabled': boolean;
'-readonly': boolean;
'-error': any;
}>;
value: import("vue").ComputedRef<any>;
onChange: (value: CheckboxButtonOption) => void;
onBlur: (event: FocusEvent) => 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 default button props of the checkbox buttons
* @type Object
* @default {}
* @name buttonProps
*/
buttonProps: {
type: PropType<CheckboxButtonOption>;
default: () => {};
};
/**
* The fallback label of the checkbox buttons. Can be a string, number, render function, or component
* @type String | Number | Boolean | Function | Object
* @default undefined
* @name label
*/
label: {
type: PropType<CheckboxButtonOption>;
default: undefined;
};
/**
* The color variant of the checkbox buttons
* @type light | dark
* @default
* @name color
*/
color: {
type: StringConstructor;
default: undefined;
};
/**
* The disabled state of the checkbox buttons
* @type Boolean
* @default false
* @name disabled
*/
disabled: {
type: BooleanConstructor;
default: boolean;
};
/**
* The error state of the checkbox, computed based on schema by default.
* @type Boolean | Array
* @default ['touched', 'dirty', 'invalid']
* @TODO use propDefaultValue to set default value
* @name error
*/
error: {
type: PropType<boolean | string[]>;
default: () => string[];
};
/**
* Used to set the checkbox buttons value
* @default []
* @name modelValue
*/
modelValue: {
type: PropType<CheckboxButtonOption[]>;
default: () => never[];
};
/**
* The unique identifier of the checkbox buttons
* @type String
* @default uid()
* @name name
*/
name: {
type: StringConstructor;
default: () => string;
};
/**
* The options to be rendered as checkbox buttons
* @type Array
* @default []
* @name options
*/
options: {
type: PropType<CheckboxButtonOption[]>;
default: () => never[];
};
/**
* The readonly state of the checkbox buttons
* @type Boolean
* @default false
* @name readonly
*/
readonly: {
type: BooleanConstructor;
default: boolean;
};
/**
* The size variant of the checkbox buttons
* @type sm | md | lg
* @default
* @name size
*/
size: {
type: StringConstructor;
default: undefined;
};
/**
* Enable checkbox buttons validation using schema
* @type Boolean
* @default true
* @name validateSchema
*/
validate: {
type: BooleanConstructor;
default: boolean;
};
/**
* The style variant of the checkbox buttons
* @type default | button-group
* @default default
* @name variant
*/
variant: {
type: PropType<CheckableButtonGroupVariant>;
default: string;
};
}>> & {
"onUpdate:modelValue"?: ((...args: any[]) => any) | undefined;
}, {
color: string;
size: string;
options: CheckboxButtonOption[];
name: string;
label: CheckboxButtonOption;
error: boolean | string[];
disabled: boolean;
readonly: boolean;
modelValue: CheckboxButtonOption[];
validate: boolean;
buttonProps: CheckboxButtonOption;
variant: CheckableButtonGroupVariant;
}, {}>;
export default _default;