# Picker 选择器

此选择器有四种弹出模式

  1. 一是时间模式,可以配置年,日,月,时,分,秒参数
  2. 二是地区模式,可以配置省,市,区参数
  3. 三是单列模式
  4. 四是多列模式

提示

由于右侧的演示是通过iframe标签引入的,缺少了手机端运行的相关API,或者因为演示区域太小,或者电脑分别率不够高 ,导致演示可能会有问题,手机端有不会这些问题,请在右上角的"演示"中用手机扫码查看对应的效果。

# 平台差异说明

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

# 基本使用

  • 通过mode参数设置为timeregionselectormultiSelector,区分时间、地区、单列,多列模式。
  • 通过v-model双向绑定一个值为布尔值的变量,来打开或者收起picker。
<template>
	<u-picker v-model="show" mode="time"></u-picker>
</template>

<script>
	export default {
		data() {
			return {
				show: false
			}
		}
	}
</script>

# 一、时间和地区模式

# 1. 设置默认值

  • 如果modetime,可以通过default-time参数设置打开时的默认时间,格式如"2025-07-02 13:01:00"、"2025-07-02 13:01"
  • 如果moderegion,可以通过default-region(Array格式)中文的省市区名称,如:["河北省", "秦皇岛市", "北戴河区"],或者代号的 省市区,如:["13", "1303", "130304"]

注意:这些省市区的名称和代码,须是uView的Picker组件自身提供的,否则可能无法匹配

<template>
	<u-picker mode="time" v-model="show"  default-time="2025-07-02 13:01"></u-picker>
	
	<u-picker mode="region" v-model="show"  :area-code='["13", "1303", "130304"]'></u-picker>
</template>

# 2. 设置需要显示的参数

  • 时间模式时:通过params参数传入一个对象给组件,给需要显示的参数属性置为true,可选的参数有:yearmonthdayhourminutesecond。 其中,hourminutesecond值默认为false,其他值默认为true
  • 地区模式时:可选的参数有:provincecityarea,默认都为true

下方示例时间模式,只会显示年,月,日3个参数可供选择:

<template>
	<u-picker mode="time" v-model="show" :params="params"></u-picker>
</template>

<script>
	export default {
		data() {
			return {
				params: {
					year: true,
					month: true,
					day: true,
					hour: false,
					minute: false,
					second: false
				},
				show: false
			}
		}
	}
</script>

# 3. 回调参数

当点击picker的"取消"或者"确定"按钮时,会分别产生回调事件cancelconfirm,均为会返回组件内部的当前值。回调的参数为一个对象,属性和传递给picker组件的params对象为true的属性一致。

注意:moderegion时,回调对象属性为一个对象,分别有labelvalue属性,见如下说明:

// 组件内部parmas参数默认值:
let params = {
	year: true,
	month: true,
	day: true,
	hour: false,
	minute: false,
	second: false,
	province: true,
	city: true,
	area: true
}


// 如果params值如下(时间选择模式)::
let params = {
	year: true,
	month: true,
	day: true,
	hour: false,
	minute: false,
	second: false
}

// 那么回调的参数可能如下:
{
	year: '2020',
	month: '05',
	day: '10'
}


// 如果params值如下(地区选择模式):
let params = {
	province: true,
	city: true,
	area: true
}

// 那么回调的参数可能如下:
{
	area: {
		label: "宝安区",
		value: "440306"
	},
	city: {
		label: "深圳市",
		value: "4403"
	},
	province: {
		label: "广东省",
		value: "44"
	},
}

# 二、单列和多列模式

# 1. 设置默认值

  • 如果modeselector(单列),可以通过设置default-selector为单元素的数组,表示选中单列中的第几个(索引从0开始),如: [1]表示选中单列的第二个。
  • 如果modemultiSelector(多列),可以通过设置default-selector为多元素的数组(元素数量等于列数),分别表示选中每一列的第几个(索引从0开始),如[0, 1, 2] 表示共有3列,分别选中第一列的第一个,第二列的第二个,第三列的第三个。
<template>
	<u-picker mode="selector" v-model="show"  :default-selector="[0]"></u-picker>
	
	<u-picker mode="multiSelector" v-model="show"  :default-selector='[0, 1, 3]'></u-picker>
</template>

# 2. 设置数据

由于单列和多列模式不像时间和地区模式,没有内置数据,故需要您手动传入可选值,通过range参数(数组)传入对应的数据,单列时为一维数组,多列时为二维数组。

如果您数组中的元素为对象的话,可以通过指定range-key参数,让组件内部知道您想把对象的哪个属性当做要显示的值。

<template>
	<view class="">
		<u-picker mode="selector" v-model="show"  :default-selector="[0]" :range="selector"></u-picker>
		
		<u-picker mode="selector" v-model="show"  :default-selector="[0]" :range="selectorObj" range-key="cateName"></u-picker>
		
		<u-picker mode="multiSelector" v-model="show"  :default-selector='[0, 1]' :range="multiSelector"></u-picker>
	</view>
</template>

<script>
	export default {
		data() {
			return {
				show: true,
				selector: [1, 2, 3],
				multiSelector: [
					[1, 2, 3], 
					[4, 5, 6]
				],
				// 这种情况需要指定range-key为cateName,否则组件不知道该显示对象的哪个属性
				selectorObj: [
					{
						cateName: '1',
						id: 1
					},
					{
						cateName: '2',
						id: 2
					}
				]
			}
		}
	}
</script>

# 3. 回调参数

当点击picker的"取消"或者"确定"按钮时,会分别产生回调事件cancelconfirm,均为会返回组件内部的当前值。回调的参数为一个数组,分别表示 当前各列选中的列索引值(从0开始)。

  • 单列模式

回调参数可能为[3],表示选中传入数组的第四个值(从0开始)

  • 多列模式

回调参数可能为[1, 0, 3],表示3列中,第一列选中了第二个值,第二列选中了第一个值,第三列算中了第四个值。

其中,我们使用多列模式,一般都需要联动选择,在多列模式下,有一个columnchange事件,任意列改变都会触发该事件,回调参数为{column: column, index: index}column表示第几列发生了变化(从0开始),index表示当前的下标值,如{column: 1, index: 2}表示第二列(从0开始)发生了变化,下标变成了2,您可以 根据这个回调,对应的修改default-selector参数,让多列中的其他列联动起来。

此处演示较为复杂,请见uView的演示代码,在安装页下载演示项目方式,内有所有演示的示例,是一个完整的HX工程。

# API

# Props

注意:props中没有控制Picker打开与收起的参数,因为这是通过v-model绑定变量实现的,见上方说明。

参数 说明 类型 默认值 可选值
params 需要显示的参数,见上方说明,mode=region或mode=time时有效 Object - -
mode 模式选择,region-地区模式,time-时间模式,selector-单列模式,multiSelector-多列模式 String time region / selector / multiSelector
start-year 可选的开始年份,mode=time时有效 String | Number 1950 -
end-year 可选的结束年份,mode=time时有效 String | Number 2050 -
safe-area-inset-bottom 是否开启底部安全区适配 Boolean false true
cancel-color 取消按钮的颜色 String #606266 -
confirm-color 确认按钮的颜色 String #2979ff -
default-time 默认选中的时间,mode=time时有效 String - -
default-region 默认选中的地区,中文形式,mode=region时有效 Array - -
area-code 默认选中的地区,编号形式,mode=region时有效 Array - -
default-selector 数组形式,其中每一项表示选择了range对应项中的第几个(下标从0开始),见上方说明 Array [] -
mask-close-able 是否允许通过点击遮罩关闭Picker Boolean true false
show-time-tag 时间模式时,是否显示后面的年月日中文提示 Boolean true false
z-index 弹出时的z-index String | Number 1075 -
range 自定义选择的数据,mode=selector或mode=multiSelector时有效 Array [] -
range-key range参数的元素为对象时,指定Object中的哪个key的值作为选择器显示内容,见上方说米 String - -

# Events

事件名 说明 回调参数 版本
confirm 点击确定按钮,返回当前选择的值 Object: 见上方"回调参数"部分说明 -
cancel 点击取消按钮,返回当前选择的值 Object: 见上方"回调参数"部分说明 -
columnchange 列发生改变时触发,只对mode = multiSelector时有效 {column: column, index: index}: 见上方"回调参数"部分说明 -