mirror of
https://github.com/tenrok/vue2-datepicker.git
synced 2026-06-07 00:42:25 +03:00
mxie
83 lines
3.2 KiB
Markdown
83 lines
3.2 KiB
Markdown
# vue2-datepicker
|
|
|
|
> A Datepicker Component For Vue2
|
|
|
|
## Demo
|
|
<https://mengxiong10.github.io/vue2-datepicker/>
|
|
|
|
|
|
|
|
## Install
|
|
|
|
```bash
|
|
$ npm install vue2-datepicker --save
|
|
```
|
|
|
|
## Usage
|
|
|
|
```html
|
|
<script>
|
|
import DatePicker from 'vue2-datepicker'
|
|
|
|
export default {
|
|
components: { DatePicker },
|
|
data() {
|
|
return {
|
|
time1: '',
|
|
time2: '',
|
|
shortcuts: [
|
|
{
|
|
text: 'Today',
|
|
start: new Date(),
|
|
end: new Date()
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
</script>
|
|
|
|
<template>
|
|
<div>
|
|
<date-picker v-model="time1" :first-day-of-week="1"></date-picker>
|
|
<date-picker v-model="time2" range :shortcuts="shortcuts"></date-picker>
|
|
</div>
|
|
</template>
|
|
```
|
|
## Attributes
|
|
|
|
| Prop | Type | Default | Description |
|
|
|-------------------|---------------|-------------|---------------------------------------------------|
|
|
| type | String | 'date' | select datepicker or datetimepicker(date/datetime)|
|
|
| range | Boolean | false | if true, the type is daterange or datetimerange |
|
|
| confirm | Boolean | false | if true, need click the button to change the value|
|
|
| format | String | yyyy-MM-dd | Date formatting string |
|
|
| lang | String | zh | Translation (en/zh/es/pt-br/fr/ru/de/it/cs) |
|
|
| placeholder | String | | input placeholder text |
|
|
| width | String/Number | 210 | input size |
|
|
| disabled-days | Array | [] | Days in YYYY-MM-DD format to disable |
|
|
| not-before | String/Date | '' | Disable all dates before new Date(not-before) |
|
|
| not-after | String/Date | '' | Disable all dates after new Date(not-after) |
|
|
| shortcuts | Boolean/Array | true | the shortcuts for the range picker |
|
|
| first-day-of-week | Number | 7 | set the first day of week (1-7) |
|
|
| minute-step | Number | 0 | if > 0 don't show the second picker(0 - 60) |
|
|
| input-class | String | 'mx-input' | the input class name |
|
|
| confirm-text | String | 'OK' | the default text to display on confirm button |
|
|
|
|
|
|
## shortcuts
|
|
* true - show the default shortcuts
|
|
* false - hide the shortcuts
|
|
* Object[] - custom shortcuts, [{text, start, end}]
|
|
|
|
| Prop | Type | Description |
|
|
|-----------------|---------------|------------------------|
|
|
| text | String | Text |
|
|
| start | Date | Start Date |
|
|
| end | Date | End Date |
|
|
|
|
## Events
|
|
| Name | Description | Callback Arguments |
|
|
|-----------------|------------------------------|------------------------|
|
|
| confirm | When you click 'OK' button | the currentValue |
|