element/packages/date-picker/README.md

65 lines
2.3 KiB
Markdown
Raw Normal View History

2016-12-15 15:15:46 +08:00
# element-datepicker
2016-07-27 14:15:02 +08:00
2016-10-13 17:51:14 +08:00
## Installation
```shell
2016-12-15 15:15:46 +08:00
npm i element-datepicker -S
2016-10-13 17:51:14 +08:00
```
2016-07-27 14:15:02 +08:00
2016-10-13 17:51:14 +08:00
## Usage
2016-07-27 14:15:02 +08:00
2016-10-13 17:51:14 +08:00
A:
2016-07-27 14:15:02 +08:00
```javascript
2016-10-13 17:51:14 +08:00
import Vue from 'vue'
2016-12-15 15:15:46 +08:00
import ElDatePicker from 'element-datepicker'
2016-07-27 14:15:02 +08:00
2016-10-13 17:51:14 +08:00
Vue.use(ElDatePicker)
2016-07-27 14:15:02 +08:00
```
2016-10-13 17:51:14 +08:00
B:
```javascript
import Vue from 'vue'
2016-12-15 15:15:46 +08:00
import { DatePicker, TimePicker, TimeSelect } from 'element-datepicker'
2016-07-27 14:15:02 +08:00
2016-10-13 17:51:14 +08:00
Vue.component(DatePicker.name, DatePicker);
Vue.component(TimePicker.name, TimePicker);
Vue.component(TimeSelect.name, TimeSelect);
```
2016-07-27 14:15:02 +08:00
2016-10-13 17:51:14 +08:00
C:
```html
<script src="path/to/vue/dist/vue.js"></script>
2016-12-15 15:15:46 +08:00
<script src="path/to/el-datepicker/index.js"></script>
2016-10-13 17:51:14 +08:00
<script>
Vue.use(ElDatePicker);
</script>
2016-07-27 14:15:02 +08:00
```
2016-12-15 15:15:46 +08:00
### Attributes
| 参数 | 说明 | 类型 | 可选值 | 默认值 |
|---------- |-------------- |---------- |-------------------------------- |-------- |
| readonly | 完全只读 | boolean | — | false |
| disabled | 禁用 | boolean | - | false |
| editable | 文本框可输入 | boolean | - | true |
| size | 输入框尺寸 | string | large, small, mini | — |
| placeholder | 占位内容 | string | — | — |
| type | 显示类型 | string | year/month/date/week/ datetime/datetimerange/daterange | date |
2017-12-09 01:21:31 +08:00
| format | 时间日期格式化 | string | 年 `yyyy`,月 `MM`,日 `dd`,小时 `HH`,分 `mm`,秒 `ss`AM/PM `A` | yyyy-MM-dd |
2016-12-15 15:15:46 +08:00
| align | 对齐方式 | string | left, center, right | left |
|picker-options | 当前时间日期选择器特有的选项参考下表 | object | — | {} |
### Picker Options
| 参数 | 说明 | 类型 | 可选值 | 默认值 |
|---------- |-------------- |---------- |-------------------------------- |-------- |
| shortcuts | 设置快捷选项,需要传入 { text, onClick } 对象用法参考 demo 或下表 | Object[] | - | - |
| disabledDate | 设置禁用状态,参数为当前日期,要求返回 Boolean | Function | - | - |
### Shortcuts
| 参数 | 说明 | 类型 | 可选值 | 默认值 |
|---------- |-------------- |---------- |-------------------------------- |-------- |
| text | 标题文本 | string | — | — |
| onClick | 选中后的回调函数,参数是 vm可通过触发 'pick' 事件设置选择器的值。例如 vm.$emit('pick', new Date()) | function | — | — |
2016-10-13 17:51:14 +08:00
## License
MIT