Picker 选择器

介绍

提供多个选项集合供用户选择，支持单列选择和多列级联，通常与 弹出层 组件配合使用。

引入

在app.json或index.json中引入组件，详细介绍见快速上手。

"usingComponents": {
  "van-picker": "@vant/weapp/picker/index"
}

代码演示

基础用法

<van-picker columns="{{ columns }}" bind:change="onChange" />

import Toast from 'path/to/@vant/weapp/dist/toast/toast';
Page({
  data: {
    columns: ['杭州', '宁波', '温州', '嘉兴', '湖州'],
  },
  onChange(event) {
    const { picker, value, index } = event.detail;
    Toast(`当前值：${value}, 当前索引：${index}`);
  },
});

默认选中项

单列选择器可以直接通过default-index属性设置初始选中项的索引值。

<van-picker
  columns="{{ columns }}"
  default-index="{{ 2 }}"
  bind:change="onChange"
/>

展示顶部栏

<van-picker
  show-toolbar
  title="标题"
  columns="{{ columns }}"
  bind:cancel="onCancel"
  bind:confirm="onConfirm"
/>

import Toast from 'path/to/@vant/weapp/dist/toast/toast';
Page({
  data: {
    columns: ['杭州', '宁波', '温州', '嘉兴', '湖州'],
  },
  onConfirm(event) {
    const { picker, value, index } = event.detail;
    Toast(`当前值：${value}, 当前索引：${index}`);
  },
  onCancel() {
    Toast('取消');
  },
});

多列联动

<van-picker columns="{{ columns }}" bind:change="onChange" />

const citys = {
  浙江: ['杭州', '宁波', '温州', '嘉兴', '湖州'],
  福建: ['福州', '厦门', '莆田', '三明', '泉州'],
};
Page({
  data: {
    columns: [
      {
        values: Object.keys(citys),
        className: 'column1',
      },
      {
        values: citys['浙江'],
        className: 'column2',
        defaultIndex: 2,
      },
    ],
  },
  onChange(event) {
    const { picker, value, index } = event.detail;
    picker.setColumnValues(1, citys[value[0]]);
  },
});

禁用选项

选项可以为对象结构，通过设置 disabled 来禁用该选项。

<van-picker columns="{{ columns }}" />

Page({
  data: {
    columns: [
      { text: '杭州', disabled: true },
      { text: '宁波' },
      { text: '温州' },
    ],
  },
});

加载状态

当 Picker 数据是通过异步获取时，可以通过 loading 属性显示加载提示。

<van-picker columns="{{ columns }}" loading />

API

Props

Events

Picker 组件的事件会根据 columns 是单列或多列返回不同的参数。

Columns 数据结构

当传入多列数据时，columns为一个对象数组，数组中的每一个对象配置每一列，每一列有以下key。

外部样式类

方法

通过 selectComponent 可以获取到 picker 实例并调用实例方法。