Vant3 Picker 選擇器

介紹

提供多個選項集合供用戶選擇，支持單列選擇和多列級聯(lián)，通常與彈出層組件配合使用。

實例演示

引入

通過以下方式來全局注冊組件，更多注冊方式請參考組件注冊。

import { createApp } from 'vue';
import { Picker } from 'vant';

const app = createApp();
app.use(Picker);

代碼演示

基礎(chǔ)用法

選項配置

Picker 組件通過 columns 屬性配置選項數(shù)據(jù)，columns 是一個包含字符串或?qū)ο蟮臄?shù)組。

頂部欄

頂部欄包含標(biāo)題、確認(rèn)按鈕和取消按鈕，點擊確認(rèn)按鈕觸發(fā) confirm 事件，點擊取消按鈕觸發(fā) cancel 事件。

<van-picker
  title="標(biāo)題"
  :columns="columns"
  @confirm="onConfirm"
  @cancel="onCancel"
  @change="onChange"
/>

import { Toast } from 'vant';

export default {
  setup() {
    const columns = ['杭州', '寧波', '溫州', '紹興', '湖州', '嘉興', '金華'];

    const onConfirm = (value, index) => {
      Toast(`當(dāng)前值: ${value}, 當(dāng)前索引: ${index}`);
    };
    const onChange = (value, index) => {
      Toast(`當(dāng)前值: ${value}, 當(dāng)前索引: ${index}`);
    };
    const onCancel = () => Toast('取消');

    return {
      columns,
      onChange,
      onCancel,
      onConfirm,
    };
  },
};

默認(rèn)選中項

單列選擇時，可以通過 default-index 屬性設(shè)置初始選中項的索引。

<van-picker title="標(biāo)題" :columns="columns" :default-index="2" />

多列選擇

columns 屬性可以通過對象數(shù)組的形式配置多列選擇，對象中可以配置選項數(shù)據(jù)、初始選中項等，詳細(xì)格式見下方表格。

<van-picker title="標(biāo)題" :columns="columns" />

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

    return { columns };
  },
};

級聯(lián)選擇

使用 columns 的 children 字段可以實現(xiàn)選項級聯(lián)的效果。如果級聯(lián)層級較多，推薦使用 Cascader 級聯(lián)選項組件。

<van-picker title="標(biāo)題" :columns="columns" />

export default {
  setup() {
    const columns = [
      {
        text: '浙江',
        children: [
          {
            text: '杭州',
            children: [{ text: '西湖區(qū)' }, { text: '余杭區(qū)' }],
          },
          {
            text: '溫州',
            children: [{ text: '鹿城區(qū)' }, { text: '甌海區(qū)' }],
          },
        ],
      },
      {
        text: '福建',
        children: [
          {
            text: '福州',
            children: [{ text: '鼓樓區(qū)' }, { text: '臺江區(qū)' }],
          },
          {
            text: '廈門',
            children: [{ text: '思明區(qū)' }, { text: '海滄區(qū)' }],
          },
        ],
      },
    ];

    return { columns };
  },
};

級聯(lián)選擇的數(shù)據(jù)嵌套深度需要保持一致，如果部分選項沒有子選項，可以使用空字符串進(jìn)行占位。

禁用選項

選項可以為對象結(jié)構(gòu)，通過設(shè)置 disabled 來禁用該選項。

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

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

    return { columns };
  },
};

動態(tài)設(shè)置選項

通過 Picker 上的實例方法可以更靈活地控制選擇器，比如使用 setColumnValues 方法實現(xiàn)多列聯(lián)動。

<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,
    };
  },
};

加載狀態(tài)

若選擇器數(shù)據(jù)是異步獲取的，可以通過 loading 屬性顯示加載提示。

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

import { reactive } from 'vue';

export default {
  setup() {
    const state = reactive({
      columns: [],
      loading: true,
    });

    setTimeout(() => {
      state.loading = false;
      state.columns = ['選項'];
    }, 1000);

    return { state };
  },
};

搭配彈出層使用

在實際場景中，Picker 通常作為用于輔助表單填寫，可以搭配 Popup 和 Field 實現(xiàn)該效果。

<van-field
  v-model="state.value"
  readonly
  clickable
  label="城市"
  placeholder="選擇城市"
  @click="state.showPicker = true"
/>
<van-popup v-model:show="state.showPicker" round position="bottom">
  <van-picker
    :columns="columns"
    @cancel="state.showPicker = false"
    @confirm="onConfirm"
  />
</van-popup>

import { reactive } from 'vue';

export default {
  setup() {
    const columns = ['杭州', '寧波', '溫州', '紹興', '湖州', '嘉興', '金華'];
    const state = reactive({
      value: '',
      showPicker: false,
    });

    const onConfirm = (value) => {
      state.value = value;
      state.showPicker = false;
    };

    return {
      state,
      columns,
      onConfirm,
    };
  },
};

自定義 Columns 的結(jié)構(gòu)

<van-picker
  :title="標(biāo)題"
  :columns="columns"
  :columns-field-names="customFieldName"
/>

export default {
  setup() {
    const columns = [
      {
        cityName: '浙江',
        cities: [
          {
            cityName: '杭州',
            cities: [{ cityName: '西湖區(qū)' }, { cityName: '余杭區(qū)' }],
          },
          {
            cityName: '溫州',
            cities: [{ cityName: '鹿城區(qū)' }, { cityName: '甌海區(qū)' }],
          },
        ],
      },
      {
        cityName: '福建',
        cities: [
          {
            cityName: '福州',
            cities: [{ cityName: '鼓樓區(qū)' }, { cityName: '臺江區(qū)' }],
          },
          {
            cityName: '廈門',
            cities: [{ cityName: '思明區(qū)' }, { cityName: '海滄區(qū)' }],
          },
        ],
      },
    ];

    const customFieldName = {
      text: 'cityName',
      children: 'cities',
    };

    return {
      columns,
      customFieldName,
    };
  },
};

API

Props

Events

當(dāng)選擇器有多列時，事件回調(diào)參數(shù)會返回數(shù)組。

Slots

Column 數(shù)據(jù)結(jié)構(gòu)

當(dāng)傳入多列數(shù)據(jù)時，columns 為一個對象數(shù)組，數(shù)組中的每一個對象配置每一列，每一列有以下 key:

方法

通過 ref 可以獲取到 Picker 實例并調(diào)用實例方法，詳見組件實例方法。

樣式變量

組件提供了下列 CSS 變量，可用于自定義樣式，使用方法請參考 ConfigProvider 組件。

常見問題

在桌面端無法操作組件？

參見桌面端適配。