Skip to content

Dropdown 下拉菜单

15:53

该组件一般用于向下展开菜单,同时可切换多个选项卡的场景。

平台差异说明

AppH5微信小程序支付宝小程序百度小程序头条小程序QQ小程序

基本使用

使用前说明:

  • 该组件必须结合u-dorpdownu-dropdown-item一起使用,展开的内容由u-dropdown-item通过传递参数或者slot提供
  • 组件的菜单栏标题由u-dropdown-item通过title参数提供
  • u-dropdown-item带有默认的单选展示功能,通过options(见下方说明)配置,传入slot则会覆盖默认功能,通过v-model双向绑定options选中项的value
html
<template>
	<view class="">
		<u-dropdown>
			<u-dropdown-item v-model="value1" title="距离" :options="options1"></u-dropdown-item>
			<u-dropdown-item v-model="value2" title="温度" :options="options2"></u-dropdown-item>
		</u-dropdown>
	</view>
</template>

<script setup lang="ts">
import { ref } from 'vue'

// 定义响应式数据
const value1 = ref<number>(1)
const value2 = ref<number>(2)

// 定义选项数据
const options1 = ref<Array<{ label: string; value: number }>>([
  {
    label: '默认排序',
    value: 1,
  },
  {
    label: '距离优先',
    value: 2,
  },
  {
    label: '价格优先',
    value: 3,
  }
])

const options2 = ref<Array<{ label: string; value: number }>>([
  {
    label: '去冰',
    value: 1,
  },
  {
    label: '加冰',
    value: 2,
  },
])
</script>

配置选项卡默认功能

如上所示,u-dropdown-item具有默认的单选功能,这里主要讲解其optionsv-model参数:

options参数为一个数组,元素为对象,其中label为需要展示的提示文字,value为点击时双向绑定给v-model的值,v-model初始化时如果设置 某个options中的value,则该条目将会被默认选中:

js
let options = [
	{
		label: '蜀道难',
		value: 1
	},
	{
		label: '难以上青天',
		value: 2
	}
]

配置选项卡自定义功能

在选项卡默认的单选功能无法满足的时候,我们可以给u-dropw-item传递slot来自定义需要展示的内容。

问:如果自定义内容,如何实现点击其中的按钮关闭下拉菜单?

答:在u-dropdown中,有一个close()方法,可以通过ref获取实例,并调用方法进行关闭即可。

html
<template>
	<view class="">
		<u-dropdown ref="uDropdownRef">
			<u-dropdown-item title="属性">
				<view class="slot-content">
					<view class="u-text-center u-content-color u-m-t-20 u-m-b-20">其他自定义内容</view>
					<u-button type="primary" @click="closeDropdown">确定</u-button>
				</view>
			</u-dropdown-item>
		</u-dropdown>
	</view>
</template>

<script setup lang="ts">
import { ref } from 'vue'
// 假设 u-dropdown 组件实例类型,实际使用时需要根据具体组件定义
const uDropdownRef = ref<any>(null)

const closeDropdown = () => {
	uDropdownRef.value.close()
}
</script>

配置选项卡内容可滚动

如果我们想给自定义内容的选项中局部内容可滚动,可以通过嵌入scroll-view元素实现,需要注意的是scroll-view必须声明高度才有效,大概如下:

html
<template>
	<view class="">
		<u-dropdown ref="uDropdownRef">
			<u-dropdown-item title="属性">
				<view class="slot-content" style="background-color: #FFFFFF;">
					<scroll-view scroll-y="true" style="height: 200rpx;">
						<view class="u-text-center u-content-color u-m-t-20 u-m-b-20">无言独上西楼</view>
						<view class="u-text-center u-content-color u-m-t-20 u-m-b-20">月如钩</view>
						<view class="u-text-center u-content-color u-m-t-20 u-m-b-20">寂寞梧桐深院锁清秋</view>
						<view class="u-text-center u-content-color u-m-t-20 u-m-b-20">剪不断</view>
						<view class="u-text-center u-content-color u-m-t-20 u-m-b-20">理还乱</view>
						<view class="u-text-center u-content-color u-m-t-20 u-m-b-20">是离愁</view>
						<view class="u-text-center u-content-color u-m-t-20 u-m-b-20">别是一般滋味在心头</view>
					</scroll-view>
					<u-button type="primary" @click="closeDropdown">确定</u-button>
				</view>
			</u-dropdown-item>
		</u-dropdown>
	</view>
</template>

<script setup lang="ts">
import { ref } from 'vue'
// 假设 u-dropdown 组件实例类型,实际使用时需要根据具体组件定义
const uDropdownRef = ref<any>(null)

const closeDropdown = () => {
	uDropdownRef.value.close()
}
</script>

如何保持菜单高亮

有时候,我们可能会希望下拉菜单收起之后,标题部分可以保持高亮,组件内部可以做到这样的要求,但是如果通过自定义slot传入了内容,那么组件就不知道 收起的时候,是否该保持菜单的高亮了,因为组件不知道您在自定义的内容中是否进行了"操作",所以我们提供了一个手动通过ref设置的highlight(index)方法, 让您自主决定是否让某个菜单高亮,可以自行结合change(dropdown-item)、open(dropdown)、close(dropdown)事件进行组合操作。

html
<template>
	<view class="">
		<u-dropdown ref="uDropdownRef" @open="open" @close="close">
			<u-dropdown-item v-model="value1" title="距离" :options="options1" @change="change"></u-dropdown-item>
			<u-dropdown-item v-model="value2" title="温度" :options="options2"></u-dropdown-item>
		</u-dropdown>
	</view>
</template>

<script setup lang="ts">
import { ref } from 'vue'

// 定义响应式数据
const value1 = ref<number>(1)
const value2 = ref<number>(2)

// 定义选项数据
const options1 = ref<Array<{ label: string; value: number }>>([
	{
		label: '默认排序',
		value: 1,
	},
	{
		label: '距离优先',
		value: 2,
	}
])

const options2 = ref<Array<{ label: string; value: number }>>([
	{
		label: '去冰',
		value: 1,
	},
	{
		label: '加冰',
		value: 2,
	},
])

// 定义组件引用
const uDropdownRef = ref<any>(null)

// 定义事件处理函数
const open = (index: number) => {
	// 展开某个下来菜单时,先关闭原来的其他菜单的高亮
	// 同时内部会自动给当前展开项进行高亮
	uDropdownRef.value?.highlight()
}

const close = (index: number) => {
	// 关闭的时候,给当前项加上高亮
	// 当然,您也可以通过监听dropdown-item的@change事件进行处理
	uDropdownRef.value?.highlight(index)
}

const change = (value: any) => {
	// 更多的细节,如有需要请自行根据业务逻辑进行处理
	// uDropdownRef.value?.highlight(xxx)
}
</script>

Fixed 定位模式 v0.6.3+

设置fixed属性后,下拉菜单使用fixed定位固定在视窗顶部,自动适配状态栏和导航栏高度,并生成占位区域防止页面塌陷。不受父容器overflow: hidden裁剪或transform影响,适用于在滚动视图、弹窗或复杂布局中使用。

定位计算

实际顶部偏移 = statusBarHeight + navbarHeight + offsetTop
参与计算的参数说明
statusBarHeight系统状态栏高度,由组件自动获取
navbarHeight导航栏高度。默认不设置时自动计算(44px),微信小程序 iOS 端 44px、Android 端 48px;设置任意数值(包括0)则使用指定值
offsetTop额外顶部偏移量,默认0,用于用户微调位置

行为说明

行为说明
展开下拉内容以fixed定位显示在视窗中,菜单栏下方的区域由遮罩层覆盖,点击遮罩可关闭
收起下拉内容完全隐藏(display: none),不会遮挡下方页面元素的点击和触摸事件
占位fixed定位后组件脱离文档流,默认自动生成同等高度的占位区域防止页面塌陷。开启immersive后不生成占位区域

参数说明

  • offset-top:在自动计算偏移量的基础上增加额外顶部偏移。例如页面顶部有自定义元素时,可通过此参数下移菜单位置
  • navbar-height:组件默认自动计算状态栏+导航栏高度。如果页面导航栏高度非标准(44px),可通过此参数指定精确高度。设置为0可完全取消顶部偏移
  • immersive:沉浸式模式,开启后不生成占位区域,允许页面内容延伸到下拉菜单下方,适用于沉浸式导航栏场景
  • z-index:自定义fixed定位时的层叠值,默认为985,当页面有其他固定元素遮挡时可调整

配合参数使用

html
<!-- 结合 border-bottom、active-color、offset-top 等参数使用 -->
<u-dropdown
    fixed
    border-bottom
    active-color="#ff9900"
    :offset-top="10"
    :navbar-height="44"
    :z-index="999"
>
    <u-dropdown-item v-model="value1" title="距离" :options="options1"></u-dropdown-item>
    <u-dropdown-item v-model="value2" title="排序" :options="options2"></u-dropdown-item>
</u-dropdown>

完整示例

html
<template>
    <view class="">
        <!-- 模拟滚动区域 -->
        <scroll-view scroll-y style="height: 60vh;">
            <view class="u-m-p-50">
                <view class="u-demo-scroll-item" v-for="i in 6" :key="i">滚动区域内容第 {{ i }} 项</view>
            </view>
            <!-- 在滚动区域内的下拉菜单,使用 fixed 避免内容被裁剪 -->
            <u-dropdown fixed border-bottom>
                <u-dropdown-item v-model="value1" title="距离" :options="options1"></u-dropdown-item>
                <u-dropdown-item v-model="value2" title="排序" :options="options2"></u-dropdown-item>
            </u-dropdown>
        </scroll-view>
    </view>
</template>

<script setup lang="ts">
import { ref } from 'vue'

const value1 = ref(1)
const value2 = ref('')

const options1 = ref([
    { label: '默认排序', value: 1 },
    { label: '距离优先', value: 2 },
    { label: '价格优先', value: 3 }
])

const options2 = ref([
    { label: '综合排序', value: 1 },
    { label: '最新发布', value: 2 },
    { label: '销量优先', value: 3 },
    { label: '好评优先', value: 4 }
])
</script>

兼容性

  • 由于头条小程序的兼容性原因,如果u-dropdown父元素设置了display: flex,您可能需要给组件添加u-dropdown类,如下:
html
<u-dropdown class="u-dropdown"></u-dropdown>

API

Props Dropdown

参数说明类型默认值可选值版本
active-color标题和选项卡选中的颜色String#2979ff--
inactive-color标题和选项卡未选中的颜色String#606266--
close-on-click-mask点击遮罩是否关闭菜单Booleantruefalse-
close-on-click-self点击当前激活项标题是否关闭菜单Booleantruefalse-
duration选项卡展开和收起的过渡时间,单位msString | Number300--
height标题菜单的高度,单位任意,数值默认为rpx单位String | Number80--
border-bottom标题菜单是否显示下边框Booleanfalsetrue-
title-size标题的字体大小,单位任意,数值默认为rpx单位String | Number28--
border-radius菜单展开内容下方的圆角值,单位任意String | Number0--
menu-icon标题菜单右侧的图标Stringarrow-downarrow-down-fill-
menu-icon-size标题菜单右侧的图标的大小,单位任意,数值默认为rpx单位String | Number26--
fixed是否使用fixed定位,开启后下拉菜单固定在顶部,自动适配状态栏和导航栏高度,并生成占位区域防止页面塌陷Booleanfalsetruev0.6.3+
offset-topfixed定位时,在自动计算的偏移量基础上的额外顶部偏移量(px),用于用户微调位置。实际top = statusBarHeight + navbarHeight + offsetTopString | Number0-v0.6.3+
navbar-heightfixed定位时,状态栏和导航栏所占的总高度(px)。默认不设置(空字符串),组件会自动获取系统状态栏高度+默认导航栏高度(44px/48px)。设置任意数值(包括0)则使用用户指定值,不再自动计算String | Number''-v0.6.3+
immersive沉浸式模式,仅在fixed下生效。开启后不生成占位区域,允许页面内容延伸到dropdown下方(类似沉浸式导航栏)Booleanfalsetruev0.6.3+
z-indexfixed定位时的z-index值String | Number985-v0.6.3+

Events Dropdown

事件名说明回调参数
open下拉菜单被打开时触发(index) - 当前被打开菜单的索引
close下拉菜单被关闭时触发(index) - 当前被关闭菜单的索引

Props DropdownItem

参数说明类型默认值可选值版本
v-model双向绑定选项卡选择值String | Number---
title菜单项标题String---
options选项数据,如果传入了默认slot,此参数无效,数据结构见上方说明Array[Object]---
disabled是否禁用此选项卡Booleanfalsetrue-
height弹窗下拉内容的高度(内容超出将会滚动),slot自定义内容时无效(自行使用scroll-view处理),单位任意,默认rpxString | Numberauto--
show是否显示此选项卡Booleanfalsetruev0.3.15+

Slots DropdownItem

名称说明
default自定义选项卡内容

Events DropdownItem

事件名说明回调参数
change每个u-dropdown均有此回调,点击某个options选项时触发(value) - 点击项绑定的value属性值

Methods Dropdown

这些为组件内部的方法,需要通过ref调用

方法名说明
close()关闭下拉菜单
open(index)打开指定索引的下拉菜单,index为菜单项的索引
highlight(index)index为需要设置高亮的菜单项的索引(从0开始),不写表示清空内部的高亮

最后更新于: