Picker 选择器

介绍

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

引入

通过以下方式来全局注册组件，更多注册方式请参考组件注册。

import { createApp } from 'vue';
import { Picker } from 'vant';
const app = createApp();
app.use(Picker);

代码演示

基础用法

选项配置

Picker 组件通过 columns 属性配置选项数据，columns 是一个包含字符串或对象的数组。

顶部栏

顶部栏包含标题、确认按钮和取消按钮，点击确认按钮触发 confirm 事件，点击取消按钮触发 cancel 事件。

<van-picker
  title="标题"
  :columns="columns"
  @confirm="onConfirm"
  @cancel="onCancel"
  @change="onChange"
/>

import { Toast } from 'vant';
export default {
  setup() {
    const columns = ['杭州', '宁波', '温州', '绍兴', '湖州', '嘉兴', '金华'];
    const onConfirm = (value, index) => {
      Toast(`当前值: ${value}, 当前索引: ${index}`);
    };
    const onChange = (value, index) => {
      Toast(`当前值: ${value}, 当前索引: ${index}`);
    };
    const onCancel = () => Toast('取消');
    return {
      columns,
      onChange,
      onCancel,
      onConfirm,
    };
  },
};

默认选中项

单列选择时，可以通过 default-index 属性设置初始选中项的索引。

<van-picker title="标题" :columns="columns" :default-index="2" />

多列选择

columns 属性可以通过对象数组的形式配置多列选择，对象中可以配置选项数据、初始选中项等，详细格式见下方表格。

<van-picker title="标题" :columns="columns" />

export default {
  setup() {
    const columns = [
      // 第一列
      {
        values: ['周一', '周二', '周三', '周四', '周五'],
        defaultIndex: 2,
      },
      // 第二列
      {
        values: ['上午', '下午', '晚上'],
        defaultIndex: 1,
      },
    ];
    return { columns };
  },
};

级联选择

使用 columns 的 children 字段可以实现选项级联的效果。如果级联层级较多，推荐使用 Cascader 级联选项组件。

<van-picker title="标题" :columns="columns" />

export default {
  setup() {
    const columns = [
      {
        text: '浙江',
        children: [
          {
            text: '杭州',
            children: [{ text: '西湖区' }, { text: '余杭区' }],
          },
          {
            text: '温州',
            children: [{ text: '鹿城区' }, { text: '瓯海区' }],
          },
        ],
      },
      {
        text: '福建',
        children: [
          {
            text: '福州',
            children: [{ text: '鼓楼区' }, { text: '台江区' }],
          },
          {
            text: '厦门',
            children: [{ text: '思明区' }, { text: '海沧区' }],
          },
        ],
      },
    ];
    return { columns };
  },
};

级联选择的数据嵌套深度需要保持一致，如果部分选项没有子选项，可以使用空字符串进行占位。

禁用选项

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

<van-picker :columns="columns" />

export default {
  setup() {
    const columns = [
      { text: '杭州', disabled: true },
      { text: '宁波' },
      { text: '温州' },
    ];
    return { columns };
  },
};

动态设置选项

通过 Picker 上的实例方法可以更灵活地控制选择器，比如使用 setColumnValues 方法实现多列联动。

<van-picker ref="picker" :columns="columns" @change="onChange" />

import { ref } from 'vue';
export default {
  setup() {
    const picker = ref(null);
    const cities = {
      浙江: ['杭州', '宁波', '温州', '嘉兴', '湖州'],
      福建: ['福州', '厦门', '莆田', '三明', '泉州'],
    };
    const columns = [
      { values: Object.keys(cities) },
      { values: cities['浙江'] },
    ];
    const onChange = (values) => {
      picker.value.setColumnValues(1, cities[values[0]]);
    };
    return {
      picker,
      columns,
      onChange,
    };
  },
};

加载状态

若选择器数据是异步获取的，可以通过 loading 属性显示加载提示。

<van-picker :columns="columns" :loading="loading" />

import { ref } from 'vue';
export default {
  setup() {
    const columns = ref([]);
    const loading = ref(true);
    setTimeout(() => {
      columns.value = ['选项'];
      loading.value = false;
    }, 1000);
    return { columns, loading };
  },
};

搭配弹出层使用

在实际场景中，Picker 通常作为用于辅助表单填写，可以搭配 Popup 和 Field 实现该效果。

<van-field
  v-model="value"
  is-link
  readonly
  label="城市"
  placeholder="选择城市"
  @click="showPicker = true"
/>
<van-popup v-model:show="showPicker" round position="bottom">
  <van-picker
    :columns="columns"
    @cancel="showPicker = false"
    @confirm="onConfirm"
  />
</van-popup>

import { ref } from 'vue';
export default {
  setup() {
    const columns = ['杭州', '宁波', '温州', '绍兴', '湖州', '嘉兴', '金华'];
    const result = ref('');
    const showPicker = ref(false);
    const onConfirm = (value) => {
      result.value = value;
      showPicker.value = false;
    };
    return {
      result,
      columns,
      onConfirm,
      showPicker,
    };
  },
};

自定义 Columns 的结构

<van-picker
  :title="标题"
  :columns="columns"
  :columns-field-names="customFieldName"
/>

export default {
  setup() {
    const columns = [
      {
        cityName: '浙江',
        cities: [
          {
            cityName: '杭州',
            cities: [{ cityName: '西湖区' }, { cityName: '余杭区' }],
          },
          {
            cityName: '温州',
            cities: [{ cityName: '鹿城区' }, { cityName: '瓯海区' }],
          },
        ],
      },
      {
        cityName: '福建',
        cities: [
          {
            cityName: '福州',
            cities: [{ cityName: '鼓楼区' }, { cityName: '台江区' }],
          },
          {
            cityName: '厦门',
            cities: [{ cityName: '思明区' }, { cityName: '海沧区' }],
          },
        ],
      },
    ];
    const customFieldName = {
      text: 'cityName',
      children: 'cities',
    };
    return {
      columns,
      customFieldName,
    };
  },
};

API

Props

Events

当选择器有多列时，事件回调参数会返回数组。

Slots

Column 数据结构

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

方法

通过 ref 可以获取到 Picker 实例并调用实例方法，详见组件实例方法。

类型定义

组件导出以下类型定义：

import type {
  PickerProps,
  PickerColumn,
  PickerOption,
  PickerInstance,
  PickerFieldNames,
  PickerObjectColumn,
  PickerObjectOption,
  PickerToolbarPosition,
} from 'vant';

PickerInstance 是组件实例的类型，用法如下：

import { ref } from 'vue';
import type { PickerInstance } from 'vant';
const pickerRef = ref<PickerInstance>();
pickerRef.value?.confirm();

主题定制

样式变量

组件提供了下列 CSS 变量，可用于自定义样式，使用方法请参考 ConfigProvider 组件。

常见问题

在桌面端无法操作组件？

参见桌面端适配。