Vant3 DatetimePicker 時間選擇

介紹

時間選擇器，支持日期、年月、時分等維度，通常與彈出層組件配合使用。

實例演示

引入

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

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

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

代碼演示

選擇年月日

DatetimePicker 通過 type 屬性來定義需要選擇的時間類型，type 為 date 表示選擇年月日。通過 min-date 和 max-date 屬性可以確定可選的時間范圍。

<van-datetime-picker
  v-model="currentDate"
  type="date"
  title="選擇年月日"
  :min-date="minDate"
  :max-date="maxDate"
/>

import { ref } from 'vue';

export default {
  setup() {
    const currentDate = ref(new Date(2021, 0, 17));
    return {
      minDate: new Date(2020, 0, 1),
      maxDate: new Date(2025, 10, 1),
      currentDate,
    };
  },
};

選擇年月

將 type 設(shè)置為 year-month 即可選擇年份和月份。通過傳入 formatter 函數(shù)，可以對選項文字進行格式化處理。

<van-datetime-picker
  v-model="currentDate"
  type="year-month"
  title="選擇年月"
  :min-date="minDate"
  :max-date="maxDate"
  :formatter="formatter"
/>

import { ref } from 'vue';

export default {
  setup() {
    const currentDate = ref(new Date());

    const formatter = (type, val) => {
      if (type === 'year') {
        return `${val}年`;
      }
      if (type === 'month') {
        return `${val}月`;
      }
      return val;
    };

    return {
      minDate: new Date(2020, 0, 1),
      maxDate: new Date(2025, 10, 1),
      formatter,
      currentDate,
    };
  },
};

選擇月日

將 type 設(shè)置為 month-day 即可選擇月份和日期。

<van-datetime-picker
  v-model="currentDate"
  type="month-day"
  title="選擇月日"
  :min-date="minDate"
  :max-date="maxDate"
  :formatter="formatter"
/>

import { ref } from 'vue';

export default {
  setup() {
    const currentDate = ref(new Date());

    const formatter = (type, val) => {
      if (type === 'month') {
        return `${val}月`;
      }
      if (type === 'day') {
        return `${val}日`;
      }
      return val;
    };

    return {
      minDate: new Date(2020, 0, 1),
      maxDate: new Date(2025, 10, 1),
      formatter,
      currentDate,
    };
  },
};

選擇時間

將 type 設(shè)置為 time 即可選擇時間（小時和分鐘）。

<van-datetime-picker
  v-model="currentTime"
  type="time"
  title="選擇時間"
  :min-hour="10"
  :max-hour="20"
/>

import { ref } from 'vue';

export default {
  setup() {
    const currentTime = ref('12:00');
    return { currentTime };
  },
};

選擇完整時間

將 type 設(shè)置為 datetime 即可選擇完整時間，包括年月日和小時、分鐘。

<van-datetime-picker
  v-model="currentDate"
  type="datetime"
  title="選擇完整時間"
  :min-date="minDate"
  :max-date="maxDate"
/>

import { ref } from 'vue';

export default {
  setup() {
    const currentDate = ref(new Date());
    return {
      minDate: new Date(2020, 0, 1),
      maxDate: new Date(2025, 10, 1),
      currentDate,
    };
  },
};

選擇年月日小時

將 type 設(shè)置為 datehour 即可選擇日期和小時，包括年月日和小時。

<van-datetime-picker
  v-model="currentDate"
  type="datehour"
  title="選擇年月日小時"
  :min-date="minDate"
  :max-date="maxDate"
/>

import { ref } from 'vue';

export default {
  setup() {
    const currentDate = ref(new Date());
    return {
      minDate: new Date(2020, 0, 1),
      maxDate: new Date(2025, 10, 1),
      currentDate,
    };
  },
};

選項過濾器

通過傳入 filter 函數(shù)，可以對選項數(shù)組進行過濾，實現(xiàn)自定義時間間隔。

<van-datetime-picker v-model="currentTime" type="time" :filter="filter" />

import { ref } from 'vue';

export default {
  setup() {
    const currentTime = ref('12:00');

    const filter = (type, options) => {
      if (type === 'minute') {
        return options.filter((option) => Number(option) % 5 === 0);
      }
      return options;
    };

    return {
      filter,
      currentTime,
    };
  },
};

自定義列排序

<van-datetime-picker
  v-model="currentDate"
  type="date"
  title="自定義列排序"
  :columns-order="['month', 'day', 'year']"
  :formatter="formatter"
/>

import { ref } from 'vue';

export default {
  setup() {
    const currentDate = ref(new Date());

    const formatter = (type, val) => {
      if (type === 'year') {
        return val + '年';
      }
      if (type === 'month') {
        return val + '月';
      }
      if (type === 'day') {
        return val + '日';
      }
      return val;
    };

    return {
      formatter,
      currentDate,
    };
  },
};

API

Props

DatePicker Props

當時間選擇器類型為 date 或 datetime 時，支持以下 props:

TimePicker Props

當時間選擇器類型為 time 時，支持以下 props:

Events

Slots

方法

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

常見問題

設(shè)置 min-date 或 max-date 后出現(xiàn)頁面卡死的情況？

請注意不要在模板中直接使用類似min-date="new Date()"的寫法，這樣會導致每次渲染組件時傳入一個新的 Date 對象，而傳入新的數(shù)據(jù)會觸發(fā)下一次渲染，從而陷入死循環(huán)。

正確的做法是將min-date作為一個數(shù)據(jù)定義在data函數(shù)中。

在 iOS 系統(tǒng)上初始化組件失?。?/h2>

如果你遇到了在 iOS 上無法渲染組件的問題，請確認在創(chuàng)建 Date 對象時沒有使用new Date('2020-01-01')這樣的寫法，iOS 不支持以中劃線分隔的日期格式，正確寫法是new Date('2020/01/01')。

對此問題的詳細解釋：stackoverflow。

在桌面端無法操作組件？

參見桌面端適配。

是否有年份或月份選擇器？

如果僅需要選擇年份或者月份，建議直接使用 Picker 組件。