@aotearoan/neon
Version:
Neon is a lightweight design library of Vue 3 components with minimal dependencies.
92 lines (91 loc) • 2.76 kB
TypeScript
import { NeonFunctionalColor } from '@/common/enums/NeonFunctionalColor';
/**
* NeonNote is a component for displaying important information to the user, such as - notes, hints or quotes.
*/
declare const _default: import("vue").DefineComponent<{
/**
* An optional title to be displayed above the note description (aka slot contents).
*/
title: {
type: StringConstructor;
};
/**
* The color of the note. In the case of the colors info, success, warn and error an icon will also be displayed to
* further enhance user comprehension.
*/
color: {
type: () => NeonFunctionalColor;
default: NeonFunctionalColor;
};
/**
* Whether the note has a close button
*/
closable: {
type: BooleanConstructor;
default: boolean;
};
/**
* Display the associated icon for info, success, warn and error colors.
*/
icon: {
type: BooleanConstructor;
default: boolean;
};
/**
* Note close button aria label.
*/
ariaLabelCloseNote: {
type: StringConstructor;
default: string;
};
}, {
iconName: import("vue").ComputedRef<"info-circle" | "check-circle" | "exclamation-circle" | "times-circle" | undefined>;
slots: Readonly<{
[name: string]: import("vue").Slot<any> | undefined;
}>;
closeNote: () => void;
}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, "close-note"[], "close-note", import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
/**
* An optional title to be displayed above the note description (aka slot contents).
*/
title: {
type: StringConstructor;
};
/**
* The color of the note. In the case of the colors info, success, warn and error an icon will also be displayed to
* further enhance user comprehension.
*/
color: {
type: () => NeonFunctionalColor;
default: NeonFunctionalColor;
};
/**
* Whether the note has a close button
*/
closable: {
type: BooleanConstructor;
default: boolean;
};
/**
* Display the associated icon for info, success, warn and error colors.
*/
icon: {
type: BooleanConstructor;
default: boolean;
};
/**
* Note close button aria label.
*/
ariaLabelCloseNote: {
type: StringConstructor;
default: string;
};
}>> & {
"onClose-note"?: ((...args: any[]) => any) | undefined;
}, {
icon: boolean;
color: NeonFunctionalColor;
closable: boolean;
ariaLabelCloseNote: string;
}, {}>;
export default _default;