city-casereport/miniprogram_npm/tdesign-miniprogram/drawer/README.md
2023-12-06 14:22:42 +08:00

3.5 KiB
Raw Blame History

title description spline isComponent
Drawer 抽屉 用作一组平行关系页面/内容的切换器相较于Tab同屏可展示更多的选项数量。。 message true

该组件于 0.7.2 版本上线,请留意版本。

引入

全局引入,在 miniprogram 根目录下的app.json中配置,局部引入,在需要引入的页面或组件的index.json中配置。

"usingComponents": {
  "t-drawer": "tdesign-miniprogram/drawer/drawer"
}

代码演示

基础抽屉

{{ base }}

带图标的抽屉

{{ icon-drawer }}

Drawer的 visible 是受控的,需要手动设置 visibletrue 才会开启抽屉

API

Drawer Props

名称 类型 默认值 说明 必传
close-on-overlay-click Boolean true 点击蒙层时是否触发抽屉关闭事件 N
destroy-on-close Boolean false 抽屉关闭时是否销毁节点 N
footer Slot - 0.29.0。抽屉的底部 N
items Array - 抽屉里的列表项。TS 类型:DrawerItem[] interface DrawerItem { title: string; icon: string; }详细类型定义 N
placement String right 抽屉方向。可选项left/right N
show-overlay Boolean true 是否显示遮罩层 N
title String / Slot - 0.29.0。抽屉的标题 N
visible Boolean false 组件是否可见 N
z-index Number 11500 抽屉层级,样式默认为 11500 N

Drawer Events

名称 参数 描述
close (trigger: TriggerSource) 关闭时触发。详细类型定义
type TriggerSource = 'overlay'
item-click (index: number; item: DrawerItem) 点击抽屉里的列表项
overlay-click - 如果蒙层存在,点击蒙层时触发

CSS 变量

组件提供了下列 CSS 变量,可用于自定义样式。

名称 默认值 描述
--td-drawer-bg-color @bg-color-container -
--td-drawer-border-color @border-color -
--td-drawer-footer-padding-bottom 40rpx -
--td-drawer-hover-color @bg-color-secondarycontainer -
--td-drawer-item-height 48rpx -
--td-drawer-item-icon-size 48rpx -
--td-drawer-item-padding 32rpx -
--td-drawer-sidebar-height 70vh -
--td-drawer-title-color --td-drawer-title-color -
--td-drawer-title-color @drawer-title-color -
--td-drawer-title-color @font-gray-1 -
--td-drawer-title-font-size 36rpx -
--td-drawer-title-padding 48rpx 32rpx 16rpx -
--td-drawer-width 560rpx -