@aotearoan/neon
Version:
Neon is a lightweight design library of Vue 3 components with minimal dependencies.
73 lines (72 loc) • 2.11 kB
TypeScript
/**
* A modal dialog component. This will be rendered above the content of the main window and can either be dismissed by the user or configured to require user interaction before dismissal.
*/
declare const _default: import("vue").DefineComponent<{
/**
* Whether the modal is currently open.
*/
open: {
type: BooleanConstructor;
required: true;
};
/**
* Whether the user is allowed to dismiss the modal by clicking outside the modal or pressing escape.
*/
dismissible: {
type: BooleanConstructor;
default: boolean;
};
/**
* Increase the opacity so that the page behind the modal is no longer visible
*/
opaque: {
type: BooleanConstructor;
default: boolean;
};
/**
* Keep the top nav visible when the modal is open
*/
showTopNav: {
type: BooleanConstructor;
default: boolean;
};
}, {
modal: import("vue").Ref<null>;
close: () => void;
}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, "close"[], "close", import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
/**
* Whether the modal is currently open.
*/
open: {
type: BooleanConstructor;
required: true;
};
/**
* Whether the user is allowed to dismiss the modal by clicking outside the modal or pressing escape.
*/
dismissible: {
type: BooleanConstructor;
default: boolean;
};
/**
* Increase the opacity so that the page behind the modal is no longer visible
*/
opaque: {
type: BooleanConstructor;
default: boolean;
};
/**
* Keep the top nav visible when the modal is open
*/
showTopNav: {
type: BooleanConstructor;
default: boolean;
};
}>> & {
onClose?: ((...args: any[]) => any) | undefined;
}, {
dismissible: boolean;
opaque: boolean;
showTopNav: boolean;
}, {}>;
export default _default;