@coreui/vue
Version:
UI Components Library for Vue.js
130 lines (129 loc) • 3.73 kB
TypeScript
import { RendererElement } from 'vue';
declare const COffcanvas: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
/**
* Apply a backdrop on body while offcanvas is open.
*
* @values boolean | 'static'
*/
backdrop: {
type: (StringConstructor | BooleanConstructor)[];
default: boolean;
validator: (value: boolean | string) => boolean;
};
/**
* Sets a darker color scheme.
*/
dark: BooleanConstructor;
/**
* Closes the offcanvas when escape key is pressed.
*/
keyboard: {
type: BooleanConstructor;
default: boolean;
};
/**
* Components placement, there’s no default placement.
*
* @values 'start', 'end', 'top', 'bottom'
*/
placement: {
type: StringConstructor;
require: boolean;
validator: (value: string) => boolean;
};
/**
* Responsive offcanvas property hide content outside the viewport from a specified breakpoint and down.
*
* @values boolean | 'sm' | 'md' | 'lg' | 'xl' | 'xxl'
* @since 4.7.0
*/
responsive: {
type: (StringConstructor | BooleanConstructor)[];
default: boolean;
validator: (value: boolean | string) => boolean;
};
/**
* Allow body scrolling while offcanvas is open
*/
scroll: {
type: BooleanConstructor;
default: boolean;
};
/**
* Toggle the visibility of offcanvas component.
*/
visible: {
type: BooleanConstructor;
default: boolean;
};
}>, () => (false | "" | import("vue").VNode<import("vue").RendererNode, RendererElement, {
[key: string]: any;
}>)[], {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, ("hide" | "show")[], "hide" | "show", import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
/**
* Apply a backdrop on body while offcanvas is open.
*
* @values boolean | 'static'
*/
backdrop: {
type: (StringConstructor | BooleanConstructor)[];
default: boolean;
validator: (value: boolean | string) => boolean;
};
/**
* Sets a darker color scheme.
*/
dark: BooleanConstructor;
/**
* Closes the offcanvas when escape key is pressed.
*/
keyboard: {
type: BooleanConstructor;
default: boolean;
};
/**
* Components placement, there’s no default placement.
*
* @values 'start', 'end', 'top', 'bottom'
*/
placement: {
type: StringConstructor;
require: boolean;
validator: (value: string) => boolean;
};
/**
* Responsive offcanvas property hide content outside the viewport from a specified breakpoint and down.
*
* @values boolean | 'sm' | 'md' | 'lg' | 'xl' | 'xxl'
* @since 4.7.0
*/
responsive: {
type: (StringConstructor | BooleanConstructor)[];
default: boolean;
validator: (value: boolean | string) => boolean;
};
/**
* Allow body scrolling while offcanvas is open
*/
scroll: {
type: BooleanConstructor;
default: boolean;
};
/**
* Toggle the visibility of offcanvas component.
*/
visible: {
type: BooleanConstructor;
default: boolean;
};
}>> & Readonly<{
onHide?: ((...args: any[]) => any) | undefined;
onShow?: ((...args: any[]) => any) | undefined;
}>, {
scroll: boolean;
visible: boolean;
dark: boolean;
backdrop: string | boolean;
keyboard: boolean;
responsive: string | boolean;
}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
export { COffcanvas };