16 KiB
Date-picker(date-picker)
日付の入力にはdate-pickerを使用します。
日付の入力
'日'で計測する基本的なdate-picker。
:::demo 測定は type
属性で決定されます。クイックオプションを有効にするには、shortcuts
プロパティを持つ picker-options
オブジェクトを作成する。無効な日付は関数 disabledDate
で設定する。
<template>
<div class="block">
<span class="demonstration">Default</span>
<el-date-picker
v-model="value1"
type="date"
placeholder="Pick a day">
</el-date-picker>
</div>
<div class="block">
<span class="demonstration">Picker with quick options</span>
<el-date-picker
v-model="value2"
type="date"
placeholder="Pick a day"
:picker-options="pickerOptions">
</el-date-picker>
</div>
</template>
<script>
export default {
data() {
return {
pickerOptions: {
disabledDate(time) {
return time.getTime() > Date.now();
},
shortcuts: [{
text: 'Today',
onClick(picker) {
picker.$emit('pick', new Date());
}
}, {
text: 'Yesterday',
onClick(picker) {
const date = new Date();
date.setTime(date.getTime() - 3600 * 1000 * 24);
picker.$emit('pick', date);
}
}, {
text: 'A week ago',
onClick(picker) {
const date = new Date();
date.setTime(date.getTime() - 3600 * 1000 * 24 * 7);
picker.$emit('pick', date);
}
}]
},
value1: '',
value2: '',
};
}
};
</script>
:::
その他の測定
標準のdate-pickerコンポーネントを拡張することで、週、月、年、または複数の日付を選択することができます。
:::demo
<div class="container">
<div class="block">
<span class="demonstration">Week</span>
<el-date-picker
v-model="value1"
type="week"
format="Week WW"
placeholder="Pick a week">
</el-date-picker>
</div>
<div class="block">
<span class="demonstration">Month</span>
<el-date-picker
v-model="value2"
type="month"
placeholder="Pick a month">
</el-date-picker>
</div>
</div>
<div class="container">
<div class="block">
<span class="demonstration">Year</span>
<el-date-picker
v-model="value3"
type="year"
placeholder="Pick a year">
</el-date-picker>
</div>
<div class="block">
<span class="demonstration">Dates</span>
<el-date-picker
type="dates"
v-model="value4"
placeholder="Pick one or more dates">
</el-date-picker>
</div>
</div>
<script>
export default {
data() {
return {
value1: '',
value2: '',
value3: '',
value4: ''
};
}
};
</script>
:::
日付範囲
日付範囲のピックに対応しています。
:::demo 範囲モードの場合、デフォルトでは左右のパネルはリンクされています。2つのパネルを独立して現在の月を切り替えたい場合は、unlink-panels
属性を使うことができます。
<template>
<div class="block">
<span class="demonstration">Default</span>
<el-date-picker
v-model="value1"
type="daterange"
range-separator="To"
start-placeholder="Start date"
end-placeholder="End date">
</el-date-picker>
</div>
<div class="block">
<span class="demonstration">With quick options</span>
<el-date-picker
v-model="value2"
type="daterange"
align="right"
unlink-panels
range-separator="To"
start-placeholder="Start date"
end-placeholder="End date"
:picker-options="pickerOptions">
</el-date-picker>
</div>
</template>
<script>
export default {
data() {
return {
pickerOptions: {
shortcuts: [{
text: 'Last week',
onClick(picker) {
const end = new Date();
const start = new Date();
start.setTime(start.getTime() - 3600 * 1000 * 24 * 7);
picker.$emit('pick', [start, end]);
}
}, {
text: 'Last month',
onClick(picker) {
const end = new Date();
const start = new Date();
start.setTime(start.getTime() - 3600 * 1000 * 24 * 30);
picker.$emit('pick', [start, end]);
}
}, {
text: 'Last 3 months',
onClick(picker) {
const end = new Date();
const start = new Date();
start.setTime(start.getTime() - 3600 * 1000 * 24 * 90);
picker.$emit('pick', [start, end]);
}
}]
},
value1: '',
value2: ''
};
}
};
</script>
:::
月の範囲
月の範囲のピッキングに対応しています。
:::demo 範囲モードの場合、デフォルトでは左右のパネルはリンクされています。2つのパネルを独立して現在の年を切り替えたい場合は、unlink-panels
属性を使うことができます。
<template>
<div class="block">
<span class="demonstration">Default</span>
<el-date-picker
v-model="value1"
type="monthrange"
range-separator="To"
start-placeholder="Start month"
end-placeholder="End month">
</el-date-picker>
</div>
<div class="block">
<span class="demonstration">With quick options</span>
<el-date-picker
v-model="value2"
type="monthrange"
align="right"
unlink-panels
range-separator="To"
start-placeholder="Start month"
end-placeholder="End month"
:picker-options="pickerOptions">
</el-date-picker>
</div>
</template>
<script>
export default {
data() {
return {
pickerOptions: {
shortcuts: [{
text: 'This month',
onClick(picker) {
picker.$emit('pick', [new Date(), new Date()]);
}
}, {
text: 'This year',
onClick(picker) {
const end = new Date();
const start = new Date(new Date().getFullYear(), 0);
picker.$emit('pick', [start, end]);
}
}, {
text: 'Last 6 months',
onClick(picker) {
const end = new Date();
const start = new Date();
start.setMonth(start.getMonth() - 6);
picker.$emit('pick', [start, end]);
}
}]
},
value1: '',
value2: ''
};
}
};
</script>
:::
デフォルト値
ユーザが日付を指定していない場合は、デフォルトで今日のカレンダーを表示する。別の日付を設定するには default-value
を用いることができる。その値は new Date()
で解析可能でなければならない。
型が daterange
の場合、default-value
は左側のカレンダーを設定する。
:::demo
<template>
<div class="block">
<span class="demonstration">date</span>
<el-date-picker
v-model="value1"
type="date"
placeholder="Pick a date"
default-value="2010-10-01">
</el-date-picker>
</div>
<div class="block">
<span class="demonstration">daterange</span>
<el-date-picker
v-model="value2"
type="daterange"
align="right"
start-placeholder="Start Date"
end-placeholder="End Date"
default-value="2010-10-01">
</el-date-picker>
</div>
</template>
<script>
export default {
data() {
return {
value1: '',
value2: ''
};
}
};
</script>
:::
日付のフォーマット
入力ボックスに表示されるテキストの書式を制御するには format
を用いる。値の書式を制御するには value-format
を用いる。
デフォルトでは、コンポーネントは Date
オブジェクトを受け入れて出力します。以下に UTC 2017-01-02 03:04:05 を例に、サポートされているフォーマット文字列を示します。
:::warning 大文字化に注意 :::
format | meaning | note | example | |
---|---|---|---|---|
yyyy |
年 | 2017 | ||
M |
月 | no leading 0 | 1 | |
MM |
月 | 01 | ||
MMM |
月 | Jan | ||
MMMM |
月 | January | ||
W |
月 | only for week picker's format ; no leading 0 |
1 | |
WW |
週 | only for week picker's format |
01 | |
d |
日 | no leading 0 | 2 | |
dd |
日 | 02 | ||
H |
時 | 24-hour clock; no leading 0 | 3 | |
HH |
時 | 24-hour clock | 03 | |
h |
時 | 12-hour clock; must be used with A or a ; no leading 0 |
3 | |
hh |
時 | 12-hour clock; must be used with A or a |
03 | |
m |
分 | no leading 0 | 4 | |
mm |
分 | 04 | ||
s |
秒 | no leading 0 | 5 | |
ss |
秒 | 05 | ||
A |
午前/午後 | only for format , uppercased |
AM | |
a |
午前/午後 | only for format , lowercased |
am | |
timestamp |
JS タイムスタンプ | only for value-format ; binding value will be a number |
1483326245000 | |
[MM] |
エスケープしない文字 | To escape characters, wrap them in square brackets (e.g. [A] [MM]) | MM |
:::demo
<template>
<div class="block">
<span class="demonstration">Emits Date object</span>
<div class="demonstration">Value: {{ value1 }}</div>
<el-date-picker
v-model="value1"
type="date"
placeholder="Pick a Date"
format="yyyy/MM/dd">
</el-date-picker>
</div>
<div class="block">
<span class="demonstration">Use value-format</span>
<div class="demonstration">Value: {{ value2 }}</div>
<el-date-picker
v-model="value2"
type="date"
placeholder="Pick a Date"
format="yyyy/MM/dd"
value-format="yyyy-MM-dd">
</el-date-picker>
</div>
<div class="block">
<span class="demonstration">Timestamp</span>
<div class="demonstration">Value:{{ value3 }}</div>
<el-date-picker
v-model="value3"
type="date"
placeholder="Pick a Date"
format="yyyy/MM/dd"
value-format="timestamp">
</el-date-picker>
</div>
</template>
<script>
export default {
data() {
return {
value1: '',
value2: '',
value3: ''
};
}
};
</script>
:::
開始日と終了日のデフォルト時刻
日付範囲を選択する際に、開始日と終了日に時間部分を割り当てることができます。
:::demo デフォルトでは、開始日と終了日の時刻部分はともに 00:00:00
である。default-time
を設定することで、それぞれの時刻を変更することができる。12:00:00` の形式で最大2つの文字列の配列を受け付ける。最初の文字列には開始日の時刻を、2番目の文字列には終了日の時刻を設定する。
<template>
<div class="block">
<p>Component value:{{ value }}</p>
<el-date-picker
v-model="value"
type="daterange"
start-placeholder="Start date"
end-placeholder="End date"
:default-time="['00:00:00', '23:59:59']">
</el-date-picker>
</div>
</template>
<script>
export default {
data() {
return {
value: ''
};
}
};
</script>
:::
属性
Attribute | Description | Type | Accepted Values | Default |
---|---|---|---|---|
value / v-model | バインディング値 | date(DatePicker) / array(DateRangePicker) | — | — |
readonly | date-pickerが読み取り専用かどうか | boolean | — | false |
disabled | date-pickerが無効かどうか | boolean | — | false |
size | インプットサイズ | string | large/small/mini | — |
editable | 入力は編集可能かどうか | boolean | — | true |
clearable | クリアボタンをみせるかどうか | boolean | — | true |
placeholder | 非範囲モード時のプレースホルダ | string | — | — |
start-placeholder | 範囲モードでの開始日のプレースホルダ | string | — | — |
end-placeholder | 範囲終了日のプレースホルダ | string | — | — |
type | ピッカーのタイプ | string | year/month/date/dates/datetime/ week/datetimerange/daterange/ monthrange | date |
format | 入力ボックスの表示値のフォーマット | string | see date formats | yyyy-MM-dd |
align | アライメント | left/center/right | left | |
popper-class | date-pickerのドロップダウン用カスタムクラス名 | string | — | — |
picker-options | その他のオプションについては、以下の表を参照してください。 | object | — | {} |
range-separator | 範囲セパレータ | string | — | '-' |
default-value | オプション、カレンダーのデフォルトの日付 | Date | anything accepted by new Date() |
— |
default-time | オプション、日付範囲を選択する際に使用する時間値 | string[] | Array with length 2, each item is a string like 12:00:00 . The first item for the start date and then second item for the end date |
— |
value-format | オプションで、バインディング値のフォーマットを指定します。指定しない場合、バインディング値は Date オブジェクトになります。 | string | see date formats | — |
name | ネイティブ入力の name と同じ |
string | — | — |
unlink-panels | 範囲ピッカーで2つのデータパネルのリンクを解除する | boolean | — | false |
prefix-icon | カスタムプレフィックスアイコン | string | — | el-icon-date |
clear-icon | カスタムクリアアイコンクラス | string | — | el-icon-circle-close |
validate-event | フォームバリデーションをトリガするかどうか | boolean | - | true |
ピッカーオプション
Attribute | Description | Type | Accepted Values | Default |
---|---|---|---|---|
shortcuts | ショートカットオプションを設定するための { text, onClick } オブジェクトの配列は、以下の表を確認してください。 | object[] | — | — |
disabledDate | 日付をパラメータとして、その日付が無効化されているかどうかを判断する関数です。ブーリアンを返す必要があります。 | function | — | — |
cellClassName | セットカスタムクラス名 | Function(Date) | — | — |
firstDayOfWeek | 週の初日 | Number | 1 to 7 | 7 |
onPick | 選択された日付が変更されたときにトリガーするコールバックです。daterange と datetimerange のみ。 |
Function({ maxDate, minDate }) | - | - |
ショートカット
Attribute | Description | Type | Accepted Values | Default |
---|---|---|---|---|
text | ショートカットのタイトル | string | — | — |
onClick | コールバック関数は、ショートカットがクリックされたときに vm をパラメータとしてトリガーします。pickイベントを発行することでピッカーの値を変更することができます。例: vm.$emit('pick', new Date())` |
function | — | — |
イベント
Event Name | Description | Parameters |
---|---|---|
change | ユーザーが値を確認したときにトリガされます。 | component's binding value |
blur | インプットがぼやけたときされます | component instance |
focus | 入力がフォーカスされているときにトリガされます。 | component instance |
方法
Method | Description | Parameters |
---|---|---|
focus | インプットコンポーネントにフォーカス | — |
スロット
Name | Description |
---|---|
range-separator | カスタム範囲区切りコンテンツ |