2
0
mirror of https://github.com/tenrok/vue2-datepicker.git synced 2026-06-07 14:52:28 +03:00

添加中文README

This commit is contained in:
mxie
2017-12-29 22:36:30 +08:00
parent 517d524efe
commit b61dd6d641
2 changed files with 97 additions and 1 deletions
+3 -1
View File
@@ -1,5 +1,7 @@
# vue2-datepicker
[中文版](https://github.com/mengxiong10/vue2-datepicker/blob/master/README_CN.md)
> A Datepicker Component For Vue2
## Demo
@@ -77,7 +79,7 @@ export default {
| end | Date | End Date |
## time-picker-options
* Object[] - custom shortcuts, [{start, step, end}]
* Object[] - custom time-picker, [{start, step, end}]
| Prop | Type | Description |
|-----------------|---------------|------------------------|
+94
View File
@@ -0,0 +1,94 @@
# vue2-datepicker
[English Version](https://github.com/mengxiong10/vue2-datepicker/blob/master/README_CN.md)
> 一个基于Vue2.x的日期时间选择组件
## 线上Demo
<https://mengxiong10.github.io/vue2-datepicker/>
![image](https://github.com/mengxiong10/vue2-datepicker/raw/master/screenshot/demo.PNG)
## 安装
```bash
$ npm install vue2-datepicker --save
```
## 用法
```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>
```
## Props
| 名称 | 类型 | 默认 | 说明
|---------------------|---------------|-------------|-------------------------------------------
| type | String | 'date' | 选择日期或日期时间(可选:date,datetime)
| range | Boolean | false | 如果是true, 显示日历范围选择
| confirm | Boolean | false | 如果是true, 显示确认按钮且需要确认才更新时间
| format | String | yyyy-MM-dd | 自定义显示在输入框上的格式(yyyy-MM-dd HH:mm:ss)
| lang | String | zh | 选择语言 (en/zh/es/pt-br/fr/ru/de/it/cs)
| placeholder | String | | placeholder的值
| width | String/Number | 210 | 输入框的width
| disabled-days | Array | [] | 禁止选择的日期 (['2018-1-1'])
| not-before | String/Date | '' | 禁止选择这个时间之前的时间
| not-after | String/Date | '' | 禁止选择这个时间之后的时间
| shortcuts | Boolean/Array | true | 自定义范围选择的时候快捷选项(见下表)
| time-picker-options | Object | {} | 自定义时间选择的开始,结束,步进(见下表)
| minute-step | Number | 0 | 分钟的步进,设置time-picker-options,这项无效
| first-day-of-week | Number | 7 | 设置日历星期几开头(1-7)
| input-class | String | 'mx-input' | 自定义输入框的类名
| confirm-text | String | 'OK' | 确认按钮的名称
## shortcuts
* true - 显示默认快捷选择
* false - 隐藏快捷选择
* Object[] - 自定义快捷选择, 格式:[{text, start, end}]
| 名称 | 类型 | 说明 |
|-----------------|---------------|----------------|
| text | String | 显示文字 |
| start | Date | 开始日期 |
| end | Date | 结束日期 |
## time-picker-options
* Object[] - 自定义时间选择, 格式:[{start, step, end}]
| 名称 | 类型 | 说明 |
|-----------------|---------------|-----------------------|
| start | String | 开始时间 (eg '00:00') |
| step | String | 步进时间 (eg '00:30') |
| end | String | 结束时间 (eg '23:30') |
## Events
| Name | 说明 | 回调参数 |
|-----------------|------------------------------|-------------|
| confirm | 点击确认按钮触发的事件 | 选择的日期 |