@aotearoan/neon
Version:
Neon is a lightweight design library of Vue 3 components with minimal dependencies.
106 lines (105 loc) • 2.88 kB
TypeScript
import type { NeonTabModel } from '@/common/models/NeonTabModel';
import { NeonFunctionalColor } from '@/common/enums/NeonFunctionalColor';
import { NeonTabsStyle } from '@/common/enums/NeonTabsStyle';
import { NeonSize } from '@/common/enums/NeonSize';
/**
* A component for displaying tabbed content.
*/
declare const _default: import("vue").DefineComponent<{
/**
* The list of tabs to display.
* */
tabs: {
type: () => Array<NeonTabModel>;
required: true;
};
/**
* The key of the selected tab.
*/
modelValue: {
type: StringConstructor;
required: true;
};
/**
* The tab button style.
*/
tabsStyle: {
type: () => NeonTabsStyle;
default: NeonTabsStyle;
};
/**
* The tab highlight color (excludes low-contrast).
*/
color: {
type: () => NeonFunctionalColor;
default: NeonFunctionalColor;
};
/**
* The tab size (NOTE: web style only)
*/
size: {
type: () => NeonSize;
default: NeonSize;
};
/**
* Display a border underlining all tabs. When tabs are in an element with a border-bottom it is preferable to omit the tabs border-bottom
*/
underline: {
type: BooleanConstructor;
default: boolean;
};
}, {
onClick: (key: string, changeFocus?: boolean) => void;
NeonTabsStyle: typeof NeonTabsStyle;
}, 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 list of tabs to display.
* */
tabs: {
type: () => Array<NeonTabModel>;
required: true;
};
/**
* The key of the selected tab.
*/
modelValue: {
type: StringConstructor;
required: true;
};
/**
* The tab button style.
*/
tabsStyle: {
type: () => NeonTabsStyle;
default: NeonTabsStyle;
};
/**
* The tab highlight color (excludes low-contrast).
*/
color: {
type: () => NeonFunctionalColor;
default: NeonFunctionalColor;
};
/**
* The tab size (NOTE: web style only)
*/
size: {
type: () => NeonSize;
default: NeonSize;
};
/**
* Display a border underlining all tabs. When tabs are in an element with a border-bottom it is preferable to omit the tabs border-bottom
*/
underline: {
type: BooleanConstructor;
default: boolean;
};
}>> & {
"onUpdate:modelValue"?: ((...args: any[]) => any) | undefined;
}, {
size: NeonSize;
color: NeonFunctionalColor;
tabsStyle: NeonTabsStyle;
underline: boolean;
}, {}>;
export default _default;