Skip to content

DropMenu 下拉菜单

代码演示

基础用法

基础用法需要绑定 v-model 值以及 options 属性。

options 属性是一个一维对象数组,数组项的数据结构为:label(选项文本),value(选项值),tip(选项说明)。

因为uni-app组件无法监听点击自己以外的地方,为了在点击页面其他地方时,可以自动关闭 dropmenu ,建议使用组件库的 useQueue hook(会关闭所有 dropmenu、popover、toast、swipeAction、fab),在页面的根元素上监听点击事件的冒泡。

WARNING

如果存在用户手动点击 dropmenu 以外某个地方如按钮弹出 dropmenu 的场景,则需要在点击的元素(在这里上按钮)加上 @click 阻止事件冒泡到根元素上,避免触发 closeOutside 把要手动打开的 dropmenu 关闭了。

html
<view @click="closeOutside">
  <wd-drop-menu>
    <wd-drop-menu-item v-model="value1" :options="option1" @change="handleChange1" />
    <wd-drop-menu-item v-model="value2" :options="option2" @change="handleChange2" />
  </wd-drop-menu>
</view>
typescript
import { useQueue } from '@/uni_modules/wot-design-uni'

const { closeOutside } = useQueue()
const value1 = ref<number>(0)
const value2 = ref<number>(0)

const option1 = ref<Record<string, any>>([
  { label: '全部商品', value: 0 },
  { label: '新款商品', value: 1 },
  { label: '活动商品', value: 2 }
])
const option2 = ref<Record<string, any>>([
  { label: '综合', value: 0 },
  { label: '销量', value: 1 },
  { label: '上架时间', value: 2 }
])

function handleChange1({ value }) {
  console.log(value)
}
function handleChange2({ value }) {
  console.log(value)
}

自定义菜单内容

通过插槽 default 可以自定义 DropMenuItem 的内容,此时需要使用实例上的 close 方法手动控制菜单的关闭。

可以通过 title 设置菜单标题。

这时候不要传入 options 和 value

html
<wd-drop-menu>
  <wd-drop-menu-item v-model="value" :options="option" @change="handleChange" />
  <wd-drop-menu-item title="筛选" ref="dropMenu" @opened="handleOpened">
    <view>
      <wd-slider v-model="sliderValue" ref="slider" />
      <wd-cell title="标题文字" value="内容" />
      <wd-cell title="标题文字" label="描述信息" value="内容" />
      <wd-button block size="large" suck @click="confirm">主要按钮</wd-button>
    </view>
  </wd-drop-menu-item>
</wd-drop-menu>
typescript
const dropMenu = ref()
const slider = ref<SliderInstance>() // slider 1.2.25支持

const value = ref<number>(0)
const sliderValue = ref<number>(30)
const option = ref<Record<string, any>>([
  { label: '全部商品', value: 0 },
  { label: '新款商品', value: 1 },
  { label: '活动商品', value: 2 }
])
function handleChange({ value }) {
  console.log(value)
}

function confirm() {
  dropMenu.value.close()
}

function handleOpened() {
  slider.value?.initSlider()
}

自定义菜单选项

自己通过 flex 布局做自定义筛选展示。

html
<view style="display: flex; background: #fff; text-align: center;">
  <wd-drop-menu style="flex: 1; min-width: 0;">
    <wd-drop-menu-item v-model="value1" :options="option" @change="handleChange1" />
  </wd-drop-menu>
  <view style="flex: 1;">
    <wd-sort-button v-model="value2" title="上架时间" @change="handleChange2" />
  </view>
</view>

自定义菜单图标1.3.7

可以通过 icon 设置菜单右侧图标,等同于 <wd-icon />name 属性。通过 icon-size 设置图标尺寸,等同于 <wd-icon />size 属性。

html
<wd-drop-menu>
  <wd-drop-menu-item title="地图" icon="location" icon-size="24px" />
</wd-drop-menu>

异步打开/关闭1.3.7

设置 before-toggle 函数,在下拉菜单打开或者关闭前执行特定的逻辑,实现状态变更前校验、异步打开/关闭的目的,before-toggle接收 { status: 当前操作类型:true 打开下拉菜单,false 关闭下拉菜单, resolve },可以对操作进行校验,并通过 resolve 函数告知组件是否确定通过,resolve 接受 1 个 boolean 值,resolve(true) 表示选项通过,resolve(false) 表示选项不通过,不通过时不会执行关闭或展开操作。

提示

before-toggle 函数无法阻止其他drop-menu或其他drop-menu-item的展开/关闭操作,仅限当前drop-menu-item的展开/关闭操作。

html
<wd-message-box></wd-message-box>
<wd-drop-menu>
  <wd-drop-menu-item v-model="value" :options="option" :before-toggle="handleBeforeToggle" />
</wd-drop-menu>
typescript

import { useMessage } from '@/uni_modules/wot-design-uni'
const messageBox = useMessage()

const value = ref<number>(0)

const option = ref<Record<string, any>>([
  { label: '全部商品', value: 0 },
  { label: '新款商品', value: 1 },
  { label: '活动商品', value: 2 }
])
 
// 通过对话框确认是否打开/关闭下拉菜单
const handleBeforeToggle: DropMenuItemBeforeToggle = ({ status, resolve }) => {
  messageBox
    .confirm({
      title: `异步${status ? '打开' : '关闭'}`,
      msg: `确定要${status ? '打开' : '关闭'}下拉菜单吗?`
    })
    .then(() => {
      resolve(true)
    })
    .catch(() => {
      resolve(false)
    })
}

向上展开

direction 属性值设置为 up,菜单即可向上展开

html
<wd-drop-menu direction="up">
  <wd-drop-menu-item v-model="value1" :options="option1" @change="handleChange1" />
  <wd-drop-menu-item v-model="value2" :options="option2" @change="handleChange2" />
</wd-drop-menu>

禁用菜单

html
<wd-drop-menu>
  <wd-drop-menu-item v-model="value1" disabled :options="option2" @change="handleChange1" />
  <wd-drop-menu-item v-model="value2" :options="option1" @change="handleChange2" />
</wd-drop-menu>

DropMenu Attributes

参数说明类型可选值默认值最低版本
direction菜单展开方向,可选值为updownstringup / downdown-
modal是否展示蒙层boolean-true-
close-on-click-modal是否点击蒙层时关闭boolean-true-
duration菜单展开收起动画时间,单位 msnumber-200-

DropMenuItem Attributes

参数说明类型可选值默认值最低版本
v-model当前选中项对应选中的 valuestring / number---
disabled禁用菜单boolean-false-
options列表数据,对应数据结构 [{text: '标题', value: '0', tip: '提示文字'}]array---
icon-name选中的图标名称(可选名称在 wd-icon 组件中)string-check-
title菜单标题string---
icon菜单图标string-arrow-down-
icon-size菜单图标尺寸string-14px_
before-toggle下拉菜单打开或者关闭前触发,reslove(true)时继续执行打开或关闭操作function({ status, resolve })--1.3.7
value-key选项对象中,value 对应的 keystring-value-
label-key选项对象中,展示的文本对应的 keystring-label-
tip-key选项对象中,选项说明对应的 keystring-tip-
方法名说明参数最低版本
change绑定值变化时触发event.detail = { value, selectedItem }, value 为选中值,selectedItem 为选中项-
close关闭菜单--
open展开菜单--
closed菜单完全关闭--
opened菜单展开完成--

通过设置 ref 可以获取到 DropdownItem 实例并调用实例方法

方法名说明参数返回值最低版本
close关闭菜单---
open展开菜单---

DropMenu Slot

name说明最低版本
default菜单内容-

DropMenuItem Slot

name说明最低版本
default菜单自定义内部内容-

DropMenu 外部样式类

类名说明最低版本
custom-classDropMenu 根节点样式-

DropMenuItem 外部样式类

类名说明最低版本
custom-classDropMenuItem 根节点样式-
custom-titleDropMenuItem 左侧文字样式-
custom-iconDropMenuItem 右侧 icon 样式-

Released under the MIT License.

Released under the MIT License.