Skip to content
On this page

PickerView 选择器视图

基本用法

单列选择器,给 columns 传入一个数值数组,设置 v-model 绑定值。选项可以为字符串,也可以为对象,如果为对象则默认取选项 label 属性为选项内容进行渲染,v-model 获取的值为选项 value 属性的值,如果选项 value 属性不存在,则取选项 label 的值。

html
<wd-picker-view :columns="columns" v-model="value" @change="onChange" />
typescript
import { useToast } from '@/uni_modules/wot-design-uni'
const toast = useToast()
const columns = ref(['选项1', '选项2', '选项3', '选项4', '选项5', '选项6', '选项7'])
const value3 = ref<string>('')
function onChange({picker, value, index}) {
  toast.show(`当前选中项: ${value}, 下标: ${index}`)
}

columns 选项为对象时,其数据结构为:

参数类型说明最低版本
valuestring / number / boolean选项值,如果 value 属性不存在,则使用 label 作为选项的值-
labelstring选项文本内容-
disabledboolean选项是否禁用-

禁用选项

选项可以为对象,设置 disabled 属性。

html
<wd-picker-view :columns="columns" v-model="value" disabled />
typescript
const columns = ref(['选项1', '选项2', '选项3', '选项4', '选项5', '选项6', '选项7'])
const value = ref('选项3')

加载中

设置 loading 属性。

html
<wd-picker-view :columns="columns" loading />

多列

columns 属性设置为二维数组,value 为数组。

html
<wd-picker-view :columns="columns" v-model="value" />
typescript
const value = ref(['中南大学', '软件工程'])

const columns = ref([
  ['中山大学', '中南大学', '华南理工大学'],
  ['计算机科学与技术', '软件工程', '通信工程', '法学', '经济学']
])

多级联动

传入 column-change 属性,其类型为 function,接收 pickerView 实例、选中项、当前修改列的下标、resolve 作为入参,根据选中项和列下标进行判断,通过 pickerView 实例暴露出来的 setColumnData 方法修改其他列的数据源,当修改完成后需要执行 resolve() 告知组件修改完成以继续执行,如果 column-change 包含异步操作,也可以使组件按照异步顺序进行执行。

html
<wd-picker-view :columns="columns" v-model="value" :column-change="onChangeDistrict" />
typescript
const district = {
  '0': [{ label: '北京', value: '110000' }, { label: '广东省', value: '440000' }],
  '110000': [{ label: '北京', value: '110100' }],
  '440000': [{ label: '广州市', value: '440100' }, { label: '韶关市', value: '440200' }, { label: '深圳市', value: '440300' }, { label: '珠海市', value: '440400' }, { label: '汕头市', value: '440500' }],
  '110100': [{ label: '东城区', value: '110101' }, { label: '西城区', value: '110102' }, { label: '朝阳区', value: '110105' }, { label: '丰台区', value: '110106' }, { label: '石景山区', value: '110107' }],
  '440100': [{ label: '荔湾区', value: '440103' }, { label: '越秀区', value: '440104' }, { label: '海珠区', value: '440105'}],
  '440200': [{ label: '武江区', value: '440203'}],
  '440300': [{ label: '罗湖区', value: '440303' }, { label: '福田区', value: '440304' }],
  '440400': [{ label: '香洲区', value: '440402' }, { label: '斗门区', value: '440403' }, { label: '金湾区', value: '440404' }],
  '440500': [{ label: '龙湖区', value: '440507' }, { label: '金平区', value: '440511' }]
}

const value = ref(['110000', '110100', '110102'])
const columns = ref([district[0], district[district[0][0].value], district[district[district[0][0].value][0].value]])


const onChangeDistrict = (pickerView, value, columnIndex, resolve) => {
  const item = value[columnIndex]
  if (columnIndex === 0) {
    pickerView.setColumnData(1, district[item.value])
    pickerView.setColumnData(2, district[district[item.value][0].value])
  } else if (columnIndex === 1) {
    pickerView.setColumnData(2, district[item.value])
  }
  resolve()
}

Attributes

参数说明类型可选值默认值最低版本
v-model选中项,如果为多列选择器,则其类型应为数组string / number / boolean / array---
columns选择器数据,可以为字符串数组,也可以为对象数组,如果为二维数组,则为多列选择器array---
loading加载中boolean-false-
loading-color加载的颜色,只能使用十六进制的色值写法,且不能使用缩写string-#4D80F0-
columns-heightpicker内部滚筒高number-231-
value-key选项对象中,value对应的 keystring-value-
label-key选项对象中,展示的文本对应的 keystring-label-
column-change接收 pickerView 实例、选中项、当前修改列的下标、resolve 作为入参,根据选中项和列下标进行判断,通过 pickerView 实例暴露出来的 setColumnData 方法修改其他列的数据源。function---
nameform 表单中的字段名string---

Methods

方法名称说明参数最低版本
getLabels获取所有列选中项的文本,返回值为一个数组-
getColumnIndex获取某一列的选中项下标columnIndex-
getColumnData获取某一列的选项columnIndex-
setColumnData设置某一列的选项columnIndex, values-

Events

事件名称说明参数最低版本
change选项值修改时触发event = { value, picker, index }, 单列: picker实例, 选中项值, 选中项下标; 多列: picker实例, 所有列选中项值, 当前列的下标-
pickstart当滚动选择开始时候触发事件--
pickend当滚动选择结束时候触发事件--

外部样式类

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

Released under the MIT License.

Released under the MIT License.