Skip to content

Commit 5e0d225

Browse files
authored
Merge pull request #20 from mazipan/master
Add Props docs
2 parents c12ac42 + 4cfb8dc commit 5e0d225

File tree

1 file changed

+25
-1
lines changed

1 file changed

+25
-1
lines changed

README.md

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,13 @@
11
# VueRangedatePicker
22

3-
[![npm](https://img.shields.io/npm/v/vue-rangedate-picker.svg)](https://www.npmjs.com/package/vue-rangedate-picker) [![vue2](https://img.shields.io/badge/vue-2.x-brightgreen.svg)](https://vuejs.org/)
3+
[![npm](https://img.shields.io/npm/v/vue-rangedate-picker.svg)](https://www.npmjs.com/package/vue-rangedate-picker) [![vue2](https://img.shields.io/badge/vue-2.x-brightgreen.svg)](https://vuejs.org/) [![Travis](https://img.shields.io/travis/bliblidotcom/vue-rangedate-picker.svg)](https://travis-ci.org/bliblidotcom/vue-rangedate-picker)
44

55
> Date picker with range selection
66
7+
## Demo
8+
9+
[https://bliblidotcom.github.io/vue-rangedate-picker/demo/](https://bliblidotcom.github.io/vue-rangedate-picker/demo/)
10+
711
## Installation
812

913
```bash
@@ -36,6 +40,26 @@ Vue.use(VueRangedatePicker)
3640
<script src="https://unpkg.com/vue-rangedate-picker"></script>
3741
```
3842

43+
### Available Props
44+
45+
46+
| Props Name | Type | Default Value | Description |
47+
|--------------------------- |------------------|--------------- | ------------------------------------ |
48+
| configs | Object | - | - |
49+
| i18n | String | - | - |
50+
| months | Array | - | - |
51+
| shortDays | Array | - | - |
52+
| captions | Object | - | - |
53+
| format | String | 'DD MMM YYYY' | - |
54+
| styles | Object | - | - |
55+
| initRange | Object | - | - |
56+
| startActiveMonth | Number | `new Date().getMonth()` | - |
57+
| startActiveYear | Number | `new Date().getFullYear()` | - |
58+
| presetRanges | Object | - | - |
59+
| compact | String | 'false' | - |
60+
| righttoleft | String | 'false' | - |
61+
62+
3963
## Development
4064

4165
### Launch visual tests

0 commit comments

Comments
 (0)