@aotearoan/neon
Version:
Neon is a lightweight design library of Vue 3 components with minimal dependencies.
90 lines (89 loc) • 2.62 kB
TypeScript
import { NeonPosition } from '@/common/enums/NeonPosition';
/**
* A drawer is a slide out panel for representing data which may be secondary or not fit on the main screen. Examples
* are a responsive navigation menu, more details of a selected item on the page. Drawers can be opened from top,
* bottom, left or right and an overlay covers the screen to focus more attention on the drawer contents.
*/
declare const _default: import("vue").DefineComponent<{
/**
* Set the drawer to visible.
*/
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;
};
/**
* If true, remove the padding applied to the drawer.
*/
fullWidth: {
type: BooleanConstructor;
default: boolean;
};
/**
* The location of the drawer.
*/
position: {
type: () => NeonPosition;
default: NeonPosition;
};
/**
* Display a semi-transparent overlay under the drawer, but over the rest of the page.
*/
overlay: {
type: BooleanConstructor;
default: boolean;
};
}, {
drawer: import("vue").Ref<HTMLDivElement | null>;
}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, "close"[], "close", import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
/**
* Set the drawer to visible.
*/
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;
};
/**
* If true, remove the padding applied to the drawer.
*/
fullWidth: {
type: BooleanConstructor;
default: boolean;
};
/**
* The location of the drawer.
*/
position: {
type: () => NeonPosition;
default: NeonPosition;
};
/**
* Display a semi-transparent overlay under the drawer, but over the rest of the page.
*/
overlay: {
type: BooleanConstructor;
default: boolean;
};
}>> & {
onClose?: ((...args: any[]) => any) | undefined;
}, {
dismissible: boolean;
fullWidth: boolean;
position: NeonPosition;
overlay: boolean;
}, {}>;
export default _default;