@aotearoan/neon
Version:
Neon is a lightweight design library of Vue 3 components with minimal dependencies.
130 lines (129 loc) • 4.49 kB
TypeScript
import { NeonAlertLevel } from '@/common/enums/NeonAlertLevel';
import { NeonAlertPlacement } from '@/common/enums/NeonAlertPlacement';
import { NeonVerticalPosition } from '@/common/enums/NeonVerticalPosition';
/**
* NeonAlert is a component for presenting temporary notifications to the user. Place the component once inside your app
* and use <strong>NeonAlertService</strong> to send events to the component.
*/
declare const _default: import("vue").DefineComponent<{
/**
* Whether alert messages are dismissible by clicking on them. This can also be set per alert message.
*/
dismissible: {
type: BooleanConstructor;
default: boolean;
};
/**
* Duration to display messages before removing them. This can also be set per alert message. Set the duration to 0 to
* disable the duration timer, NOTE: this requires the user to dismiss the alert by clicking on it.
*/
duration: {
type: NumberConstructor;
default: number;
};
}, {
topLeft: import("vue").Ref<{
id: number;
level: NeonAlertLevel;
title?: string | undefined;
message?: string | undefined;
placement?: NeonAlertPlacement | undefined;
duration?: number | undefined;
dismissible?: boolean | undefined;
primaryAction?: {
label: string;
callback: () => void;
} | undefined;
secondaryAction?: {
label: string;
callback: () => void;
} | undefined;
}[]>;
topRight: import("vue").Ref<{
id: number;
level: NeonAlertLevel;
title?: string | undefined;
message?: string | undefined;
placement?: NeonAlertPlacement | undefined;
duration?: number | undefined;
dismissible?: boolean | undefined;
primaryAction?: {
label: string;
callback: () => void;
} | undefined;
secondaryAction?: {
label: string;
callback: () => void;
} | undefined;
}[]>;
bottomLeft: import("vue").Ref<{
id: number;
level: NeonAlertLevel;
title?: string | undefined;
message?: string | undefined;
placement?: NeonAlertPlacement | undefined;
duration?: number | undefined;
dismissible?: boolean | undefined;
primaryAction?: {
label: string;
callback: () => void;
} | undefined;
secondaryAction?: {
label: string;
callback: () => void;
} | undefined;
}[]>;
bottomRight: import("vue").Ref<{
id: number;
level: NeonAlertLevel;
title?: string | undefined;
message?: string | undefined;
placement?: NeonAlertPlacement | undefined;
duration?: number | undefined;
dismissible?: boolean | undefined;
primaryAction?: {
label: string;
callback: () => void;
} | undefined;
secondaryAction?: {
label: string;
callback: () => void;
} | undefined;
}[]>;
top: import("vue").Ref<{
id: number;
level: NeonAlertLevel;
title: string;
placement?: NeonVerticalPosition | undefined;
duration?: number | undefined;
dismissible?: boolean | undefined;
}[]>;
bottom: import("vue").Ref<{
id: number;
level: NeonAlertLevel;
title: string;
placement?: NeonVerticalPosition | undefined;
duration?: number | undefined;
dismissible?: boolean | undefined;
}[]>;
}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
/**
* Whether alert messages are dismissible by clicking on them. This can also be set per alert message.
*/
dismissible: {
type: BooleanConstructor;
default: boolean;
};
/**
* Duration to display messages before removing them. This can also be set per alert message. Set the duration to 0 to
* disable the duration timer, NOTE: this requires the user to dismiss the alert by clicking on it.
*/
duration: {
type: NumberConstructor;
default: number;
};
}>>, {
dismissible: boolean;
duration: number;
}, {}>;
export default _default;