Skip to content
页面目录

抽屉 Drawer

触发命令后,从屏幕一侧滑出的抽屉式的面板。

基本用法

点击触发按钮抽屉从右侧滑出,点击遮罩区关闭。

抽屉位置

自定义位置,设置 palcement 取值则抽屉从相应的位置滑出。

 

自定义节点

通过设置 headerfooterfalsehideCanceltrue 来控制显示或隐藏。

嵌套抽屉

在抽屉内打开新的抽屉。

API

参数名描述类型默认值
visible (v-model)对话框是否可见booleanfalse
placement抽屉放置的位置`'top''right'
top对话框的距离顶部的高度,居中显示开启的情况下不生效number | 'center'-
title标题string-
mask是否显示遮罩层booleantrue
mask-closable点击遮罩层是否可以关闭booleantrue
closable是否展示关闭按钮
booleantrue
ok-text确认按钮的内容string-
cancel-text取消按钮的内容string-
okButtonProps确认按钮的Propsobject-
cancelButtonProps取消按钮的Propsboolean-
width抽屉的宽度(仅在placement为right,left时可用)number | string250
height抽屉的高度(仅在placement为top,bottom时可用)number | string250
drawerStyle抽屉的样式CSSProperties-
on-before-ok触发 ok 事件前的回调函数。如果返回 false 则不会触发后续事件,也可使用 done 进行异步关闭。( done: (closed: boolean) => void) => void | boolean | Promise<void | boolean>-
on-before-cancel触发 cancel 事件前的回调函数。如果返回 false 则不会触发后续事件
( done: (closed: boolean) => void) => void | boolean | Promise<void | boolean>-
header是否展示头部部分booleantrue
footer是否展示底部部分booleantrue
hide-cancel是否隐藏取消按钮booleanfalse

<drawer> Events

事件名描述参数
ok点击确定按钮时触发-
cancel点击取消、关闭按钮时触发-
open对话框打开后(动画结束)触发-
close对话框关闭后(动画结束)触发-
before-open对话框打开前触发-
before-close对话框关闭前触发-

<drawer> Slots

插槽名描述参数
header页眉-
title标题-
footer页脚-

DrawerConfig

参数名描述类型默认值
placement抽屉放置的位置`'top''right'
title标题RenderContent-
content内容RenderContent-
mask是否显示遮罩层booleantrue
maskClosable点击遮罩层是否可以关闭
booleantrue
closable是否展示关闭按钮booleantrue
okText确认按钮的内容string-
cancelText取消按钮的内容string-
okButtonProps确认按钮的PropsButtonProps-
cancelButtonProps取消按钮的PropsButtonProps-
width抽屉的宽度(仅在placement为right,left时可用)number | string250
height抽屉的高度(仅在placement为top,bottom时可用)number | string250
drawerStyle抽屉的样式CSSProperties-
onOk点击确定按钮时触发() => void-
onCancel点击取消、关闭按钮时触发() => void-
onBeforeOk触发 ok 事件前的回调函数。如果返回 false 则不会触发后续事件,也可使用 done 进行异步关闭。( done: (closed: boolean) => void ) => void | boolean | Promise<void | boolean>-
onBeforeCancel触发 cancel 事件前的回调函数。如果返回 false 则不会触发后续事件。() => boolean-
onOpen抽屉打开后(动画结束)触发
() => void-
onClose抽屉关闭后(动画结束)触发
() => void-
onBeforeOpen抽屉打开前触发
() => void-
onBeforeClose抽屉关闭前触发
() => void-
header是否展示头部部分booleantrue
footer是否展示底部部分booleantrue
hide-cancel是否隐藏取消按钮booleanfalse

DrawerReturn

参数名描述类型默认值
close关闭抽屉() => void-

DrawerMethod

参数名描述类型默认值
open打开抽屉(config: DrawerConfig, appContext?: AppContext) => DrawerReturn-

在第五届青训营的契机下,本组件库由 Seven 团队协作完成开发并遵守 MIT 许可证