@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.
179 lines (178 loc) • 4.48 kB
TypeScript
declare const _default: import("vue").DefineComponent<{
/**
* The active state of the nav item
* @type Boolean
* @default false
* @name active
*/
active: {
type: BooleanConstructor;
default: boolean;
};
/**
* The disabled state of the nav item
* @type Boolean
* @default false
* @name disabled
*/
disabled: {
type: BooleanConstructor;
default: boolean;
};
/**
* Renders the component as an anchor link with a `href` attribute
* @type String
* @default undefined
* @name to
*/
href: {
type: StringConstructor;
default: undefined;
};
/**
* Used to close the nearest navbar or sidebar by propagating the onClick event
* @type Boolean
* @default false
* @name stopPropagation
*/
stopPropagation: {
type: BooleanConstructor;
default: boolean;
};
/**
* Set the HTML tag to be used for rendering the nav item
* @type String
* @default div
* @name tag
*/
tag: {
type: StringConstructor;
default: string;
};
/**
* The tabindex of the list group item
* @type Number | String
* @default 0
* @name tabindex
*/
tabindex: {
type: (StringConstructor | NumberConstructor)[];
default: number;
};
/**
* Renders the component as a Router Link component with a `to` attribute
* @type String
* @default undefined
* @name to
*/
to: {
type: (ObjectConstructor | StringConstructor)[];
default: undefined;
};
}, {
bindings: import("vue").ComputedRef<{
role: string | null;
tabindex: string | number;
'aria-disabled': string | null;
disabled?: true | undefined;
to: string | Record<string, any>;
} | {
role: string | null;
tabindex: string | number;
'aria-disabled': string | null;
disabled?: true | undefined;
href: string;
} | {
role: string | null;
tabindex: string | number;
'aria-disabled': string | null;
disabled?: true | undefined;
}>;
classes: import("vue").ComputedRef<{
'-active': boolean;
'-disabled': boolean;
}>;
tag: any;
currentTag: import("vue").Ref<string>;
onClick: (event: Event) => void;
}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
/**
* The active state of the nav item
* @type Boolean
* @default false
* @name active
*/
active: {
type: BooleanConstructor;
default: boolean;
};
/**
* The disabled state of the nav item
* @type Boolean
* @default false
* @name disabled
*/
disabled: {
type: BooleanConstructor;
default: boolean;
};
/**
* Renders the component as an anchor link with a `href` attribute
* @type String
* @default undefined
* @name to
*/
href: {
type: StringConstructor;
default: undefined;
};
/**
* Used to close the nearest navbar or sidebar by propagating the onClick event
* @type Boolean
* @default false
* @name stopPropagation
*/
stopPropagation: {
type: BooleanConstructor;
default: boolean;
};
/**
* Set the HTML tag to be used for rendering the nav item
* @type String
* @default div
* @name tag
*/
tag: {
type: StringConstructor;
default: string;
};
/**
* The tabindex of the list group item
* @type Number | String
* @default 0
* @name tabindex
*/
tabindex: {
type: (StringConstructor | NumberConstructor)[];
default: number;
};
/**
* Renders the component as a Router Link component with a `to` attribute
* @type String
* @default undefined
* @name to
*/
to: {
type: (ObjectConstructor | StringConstructor)[];
default: undefined;
};
}>>, {
disabled: boolean;
active: boolean;
href: string;
tabindex: string | number;
tag: string;
to: string | Record<string, any>;
stopPropagation: boolean;
}, {}>;
export default _default;