139 lines
6.0 KiB
Markdown
139 lines
6.0 KiB
Markdown
---
|
||
title: DropdownMenu 下拉菜单
|
||
description: 菜单呈现数个并列的选项类目，用于整个页面的内容筛选，由菜单面板和菜单选项组成。
|
||
spline: message
|
||
isComponent: true
|
||
---
|
||
|
||
<span class="coverages-badge" style="margin-right: 10px"><img src="https://img.shields.io/badge/coverages%3A%20lines-95%25-blue" /></span><span class="coverages-badge" style="margin-right: 10px"><img src="https://img.shields.io/badge/coverages%3A%20functions-100%25-blue" /></span><span class="coverages-badge" style="margin-right: 10px"><img src="https://img.shields.io/badge/coverages%3A%20statements-94%25-blue" /></span><span class="coverages-badge" style="margin-right: 10px"><img src="https://img.shields.io/badge/coverages%3A%20branches-83%25-blue" /></span>
|
||
|
||
<div style="background: #ecf2fe; display: flex; align-items: center; line-height: 20px; padding: 14px 24px; border-radius: 3px; color: #555a65">
|
||
<svg fill="none" viewBox="0 0 16 16" width="16px" height="16px" style="margin-right: 5px">
|
||
<path fill="#0052d9" d="M8 15A7 7 0 108 1a7 7 0 000 14zM7.4 4h1.2v1.2H7.4V4zm.1 2.5h1V12h-1V6.5z" fillOpacity="0.9"></path>
|
||
</svg>
|
||
该组件于 0.8.0 版本上线，请留意版本。
|
||
</div>
|
||
|
||
## 引入
|
||
|
||
### 引入组件
|
||
|
||
在 `app.json` 或 `page.json` 中引入组件：
|
||
|
||
```json
|
||
"usingComponents": {
|
||
"t-dropdown-menu": "tdesign-miniprogram/dropdown-menu/dropdown-menu",
|
||
"t-dropdown-item": "tdesign-miniprogram/dropdown-item/dropdown-item"
|
||
}
|
||
```
|
||
|
||
## 代码演示
|
||
|
||
<a href="https://developers.weixin.qq.com/s/T58agimj75SB" title="在开发者工具中预览效果" target="_blank" rel="noopener noreferrer"> 在开发者工具中预览效果 </a>
|
||
|
||
<blockquote style="background-color: #d9e1ff; font-size: 15px; line-height: 26px;margin: 16px 0 0;padding: 16px; border-radius: 6px; color: #0052d9" >
|
||
<p>Tips: 请确保开发者工具为打开状态。导入开发者工具后，依次执行：npm i > 构建npm包 > 勾选 "将JS编译成ES5"</p>
|
||
</blockquote>
|
||
|
||
### 单选下拉菜单
|
||
|
||
{{ single }}
|
||
|
||
### 多列下拉菜单
|
||
|
||
{{ multi }}
|
||
|
||
### 树形下拉菜单
|
||
|
||
{{ tree }}
|
||
|
||
## API
|
||
|
||
### DropdownMenu Props
|
||
|
||
名称 | 类型 | 默认值 | 描述 | 必传
|
||
-- | -- | -- | -- | --
|
||
style | Object | - | 样式 | N
|
||
custom-style | Object | - | 样式，一般用于开启虚拟化组件节点场景 | N
|
||
arrow-icon | String / Object | 'caret-down-small' | 自定义箭头图标 | N
|
||
close-on-click-overlay | Boolean | true | 是否在点击遮罩层后关闭菜单 | N
|
||
duration | String / Number | 200 | 动画时长 | N
|
||
show-overlay | Boolean | true | 是否显示遮罩层 | N
|
||
z-index | Number | 11600 | 菜单栏 z-index 层级 | N
|
||
|
||
### DropdownMenu Events
|
||
|
||
名称 | 参数 | 描述
|
||
-- | -- | --
|
||
close | \- | 菜单关闭时触发
|
||
open | \- | 菜单展开时触发
|
||
|
||
### DropdownMenu External Classes
|
||
|
||
类名 | 描述
|
||
-- | --
|
||
t-class | 根节点样式类
|
||
t-class-icon | 图标样式类
|
||
t-class-item | 选项样式类
|
||
t-class-label | 标签样式类
|
||
|
||
|
||
### DropdownItem Props
|
||
|
||
名称 | 类型 | 默认值 | 描述 | 必传
|
||
-- | -- | -- | -- | --
|
||
style | Object | - | 样式 | N
|
||
custom-style | Object | - | 样式，一般用于开启虚拟化组件节点场景 | N
|
||
disabled | Boolean | false | 是否禁用操作项 | N
|
||
footer | Slot | - | 底部。[通用类型定义](https://github.com/Tencent/tdesign-miniprogram/blob/develop/src/common/common.ts) | N
|
||
keys | Object | - | 用来定义 value / label 在 `options` 中对应的字段别名。TS 类型：`KeysType`。[通用类型定义](https://github.com/Tencent/tdesign-miniprogram/blob/develop/src/common/common.ts) | N
|
||
label | String | - | 标题 | N
|
||
multiple | Boolean | false | 是否多选 | N
|
||
options | Array | [] | 选项数据。TS 类型：`Array<DropdownOption>` `interface DropdownOption { label: string; disabled: boolean; value: DropdownValue; }`。[详细类型定义](https://github.com/Tencent/tdesign-miniprogram/tree/develop/src/dropdown-item/type.ts) | N
|
||
options-columns | String / Number | 1 | 选项分栏（1-3） | N
|
||
options-layout | String | columns | 已废弃。选项排列；不再支持 tree 布局，可与 treeSelect 配合使用 | N
|
||
placement | String | left | 复选框和内容相对位置，仅单选菜单栏有效。可选项：left/right | N
|
||
value | String / Number / Array | undefined | 选中值。TS 类型：`DropdownValue ` `type DropdownValue = string \| number \| Array<DropdownValue>;`。[详细类型定义](https://github.com/Tencent/tdesign-miniprogram/tree/develop/src/dropdown-item/type.ts) | N
|
||
default-value | String / Number / Array | undefined | 选中值。非受控属性。TS 类型：`DropdownValue ` `type DropdownValue = string \| number \| Array<DropdownValue>;`。[详细类型定义](https://github.com/Tencent/tdesign-miniprogram/tree/develop/src/dropdown-item/type.ts) | N
|
||
|
||
### DropdownItem Events
|
||
|
||
名称 | 参数 | 描述
|
||
-- | -- | --
|
||
change | `(value: DropdownValue)` | 值改变时触发
|
||
close | \- | 关闭时触发
|
||
confirm | `(value: DropdownValue)` | 点击确认时触发
|
||
reset | \- | 点击重置时触发
|
||
|
||
### DropdownItem External Classes
|
||
|
||
类名 | 描述
|
||
-- | --
|
||
t-class | 根节点样式类
|
||
t-class-column | 菜单列样式类
|
||
t-class-column-item | 菜单列选项样式类
|
||
t-class-column-item-label | 菜单列选项标签样式类
|
||
t-class-content | 内容样式类
|
||
t-class-footer | 底部样式类
|
||
|
||
### CSS Variables
|
||
|
||
组件提供了下列 CSS 变量，可用于自定义样式。
|
||
名称 | 默认值 | 描述
|
||
-- | -- | --
|
||
--td-dropdown-menu-active-color | @brand-color | -
|
||
--td-dropdown-menu-bg-color | @bg-color-container | -
|
||
--td-dropdown-menu-border-width | 1px | -
|
||
--td-dropdown-menu-color | @text-color-primary | -
|
||
--td-dropdown-menu-disabled-color | @text-color-disabled | -
|
||
--td-dropdown-menu-font-size | 28rpx | -
|
||
--td-dropdown-menu-height | 96rpx | -
|
||
--td-dropdown-menu-icon-size | 40rpx | -
|
||
--td-dropdown-body-max-height | 560rpx | -
|
||
--td-dropdown-menu-bg-color | @bg-color-container | -
|
||
--td-tree-bg-color | @bg-color-container | -
|
||
--td-tree-item-active-color | @brand-color | -
|
||
--td-tree-item-font-size | 32rpx | -
|
||
--td-tree-item-height | 96rpx | -
|
||
--td-tree-root-bg-color | @bg-color-secondarycontainer | -
|