Skip to content

Commit 05c8d24

Browse files
committed
docs: update README & demo
1 parent e9190cd commit 05c8d24

16 files changed

+40
-10367
lines changed

.cache/14/6f395d15f9dc37506e797b5013e01d.json

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

.cache/19/a11ff129f125dbd9da80ae2c08e1ec.json

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

.cache/46/bdfe0594aaed1ad9c8a6bc7a2f81f1.json

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

.cache/58/f95208b488a3cd6a857b6f95727c5b.json

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
{"id":"epB2","dependencies":[{"name":"d:\\WebS\\el-calendar\\package.json","includedInParent":true,"mtime":1581850719951},{"name":"vue","loc":{"line":1,"column":16},"parent":"d:\\WebS\\el-calendar\\dev\\main.js","resolved":"d:\\WebS\\el-calendar\\node_modules\\vue\\dist\\vue.runtime.esm.js"},{"name":"./App.vue","loc":{"line":2,"column":16},"parent":"d:\\WebS\\el-calendar\\dev\\main.js","resolved":"d:\\WebS\\el-calendar\\dev\\App.vue"}],"generated":{"js":"\"use strict\";var e=r(require(\"vue\")),u=r(require(\"./App.vue\"));function r(e){return e&&e.__esModule?e:{default:e}}new e.default({render:function(e){return e(u.default)}}).$mount(\"#app\");"},"sourceMaps":{"js":{"mappings":[{"source":"main.js","original":{"line":4,"column":0},"generated":{"line":1,"column":0}},{"source":"main.js","original":{"line":1,"column":0},"generated":{"line":1,"column":13}},{"source":"main.js","original":{"line":1,"column":0},"generated":{"line":1,"column":17}},{"source":"main.js","original":{"line":1,"column":0},"generated":{"line":1,"column":19}},{"source":"main.js","original":{"line":1,"column":0},"generated":{"line":1,"column":21}},{"source":"main.js","original":{"line":1,"column":0},"generated":{"line":1,"column":29}},{"source":"main.js","original":{"line":2,"column":0},"generated":{"line":1,"column":37}},{"source":"main.js","original":{"line":2,"column":0},"generated":{"line":1,"column":39}},{"source":"main.js","original":{"line":2,"column":0},"generated":{"line":1,"column":41}},{"source":"main.js","original":{"line":2,"column":0},"generated":{"line":1,"column":49}},{"source":"main.js","original":{"line":4,"column":0},"generated":{"line":1,"column":63}},{"source":"main.js","original":{"line":4,"column":0},"generated":{"line":1,"column":72}},{"source":"main.js","original":{"line":4,"column":0},"generated":{"line":1,"column":74}},{"source":"main.js","original":{"line":4,"column":0},"generated":{"line":1,"column":77}},{"source":"main.js","original":{"line":4,"column":0},"generated":{"line":1,"column":84}},{"source":"main.js","original":{"line":4,"column":0},"generated":{"line":1,"column":87}},{"source":"main.js","original":{"line":4,"column":0},"generated":{"line":1,"column":89}},{"source":"main.js","original":{"line":4,"column":0},"generated":{"line":1,"column":100}},{"source":"main.js","original":{"line":4,"column":0},"generated":{"line":1,"column":102}},{"source":"main.js","original":{"line":4,"column":0},"generated":{"line":1,"column":103}},{"source":"main.js","original":{"line":4,"column":0},"generated":{"line":1,"column":111}},{"source":"main.js","original":{"line":4,"column":0},"generated":{"line":1,"column":114}},{"source":"main.js","name":"Vue","original":{"line":4,"column":4},"generated":{"line":1,"column":118}},{"source":"main.js","original":{"line":4,"column":0},"generated":{"line":1,"column":120}},{"source":"main.js","original":{"line":4,"column":8},"generated":{"line":1,"column":128}},{"source":"main.js","name":"render","original":{"line":5,"column":2},"generated":{"line":1,"column":129}},{"source":"main.js","original":{"line":5,"column":10},"generated":{"line":1,"column":136}},{"source":"main.js","name":"h","original":{"line":5,"column":10},"generated":{"line":1,"column":145}},{"source":"main.js","name":"h","original":{"line":5,"column":15},"generated":{"line":1,"column":148}},{"source":"main.js","name":"h","original":{"line":5,"column":15},"generated":{"line":1,"column":155}},{"source":"main.js","name":"App","original":{"line":5,"column":17},"generated":{"line":1,"column":157}},{"source":"main.js","original":{"line":5,"column":16},"generated":{"line":1,"column":159}},{"source":"main.js","name":"$mount","original":{"line":6,"column":3},"generated":{"line":1,"column":171}},{"source":"main.js","original":{"line":6,"column":10},"generated":{"line":1,"column":178}}],"sources":{"main.js":"import Vue from 'vue'\r\nimport App from './App.vue'\r\n\r\nnew Vue({\r\n render: h => h(App)\r\n}).$mount('#app')\r\n"},"lineCount":null}},"error":null,"hash":"291ceef6a66ec7b312a08cc1e40e2d84","cacheData":{"env":{}}}
1+
{"id":"epB2","dependencies":[{"name":"d:\\WebS\\el-calendar\\package.json","includedInParent":true,"mtime":1581851683953},{"name":"vue","loc":{"line":1,"column":16},"parent":"d:\\WebS\\el-calendar\\dev\\main.js","resolved":"d:\\WebS\\el-calendar\\node_modules\\vue\\dist\\vue.runtime.esm.js"},{"name":"./App.vue","loc":{"line":2,"column":16},"parent":"d:\\WebS\\el-calendar\\dev\\main.js","resolved":"d:\\WebS\\el-calendar\\dev\\App.vue"}],"generated":{"js":"\"use strict\";var e=r(require(\"vue\")),u=r(require(\"./App.vue\"));function r(e){return e&&e.__esModule?e:{default:e}}new e.default({render:function(e){return e(u.default)}}).$mount(\"#app\");"},"sourceMaps":{"js":{"mappings":[{"source":"main.js","original":{"line":4,"column":0},"generated":{"line":1,"column":0}},{"source":"main.js","original":{"line":1,"column":0},"generated":{"line":1,"column":13}},{"source":"main.js","original":{"line":1,"column":0},"generated":{"line":1,"column":17}},{"source":"main.js","original":{"line":1,"column":0},"generated":{"line":1,"column":19}},{"source":"main.js","original":{"line":1,"column":0},"generated":{"line":1,"column":21}},{"source":"main.js","original":{"line":1,"column":0},"generated":{"line":1,"column":29}},{"source":"main.js","original":{"line":2,"column":0},"generated":{"line":1,"column":37}},{"source":"main.js","original":{"line":2,"column":0},"generated":{"line":1,"column":39}},{"source":"main.js","original":{"line":2,"column":0},"generated":{"line":1,"column":41}},{"source":"main.js","original":{"line":2,"column":0},"generated":{"line":1,"column":49}},{"source":"main.js","original":{"line":4,"column":0},"generated":{"line":1,"column":63}},{"source":"main.js","original":{"line":4,"column":0},"generated":{"line":1,"column":72}},{"source":"main.js","original":{"line":4,"column":0},"generated":{"line":1,"column":74}},{"source":"main.js","original":{"line":4,"column":0},"generated":{"line":1,"column":77}},{"source":"main.js","original":{"line":4,"column":0},"generated":{"line":1,"column":84}},{"source":"main.js","original":{"line":4,"column":0},"generated":{"line":1,"column":87}},{"source":"main.js","original":{"line":4,"column":0},"generated":{"line":1,"column":89}},{"source":"main.js","original":{"line":4,"column":0},"generated":{"line":1,"column":100}},{"source":"main.js","original":{"line":4,"column":0},"generated":{"line":1,"column":102}},{"source":"main.js","original":{"line":4,"column":0},"generated":{"line":1,"column":103}},{"source":"main.js","original":{"line":4,"column":0},"generated":{"line":1,"column":111}},{"source":"main.js","original":{"line":4,"column":0},"generated":{"line":1,"column":114}},{"source":"main.js","name":"Vue","original":{"line":4,"column":4},"generated":{"line":1,"column":118}},{"source":"main.js","original":{"line":4,"column":0},"generated":{"line":1,"column":120}},{"source":"main.js","original":{"line":4,"column":8},"generated":{"line":1,"column":128}},{"source":"main.js","name":"render","original":{"line":5,"column":2},"generated":{"line":1,"column":129}},{"source":"main.js","original":{"line":5,"column":10},"generated":{"line":1,"column":136}},{"source":"main.js","name":"h","original":{"line":5,"column":10},"generated":{"line":1,"column":145}},{"source":"main.js","name":"h","original":{"line":5,"column":15},"generated":{"line":1,"column":148}},{"source":"main.js","name":"h","original":{"line":5,"column":15},"generated":{"line":1,"column":155}},{"source":"main.js","name":"App","original":{"line":5,"column":17},"generated":{"line":1,"column":157}},{"source":"main.js","original":{"line":5,"column":16},"generated":{"line":1,"column":159}},{"source":"main.js","name":"$mount","original":{"line":6,"column":3},"generated":{"line":1,"column":171}},{"source":"main.js","original":{"line":6,"column":10},"generated":{"line":1,"column":178}}],"sources":{"main.js":"import Vue from 'vue'\r\nimport App from './App.vue'\r\n\r\nnew Vue({\r\n render: h => h(App)\r\n}).$mount('#app')\r\n"},"lineCount":null}},"error":null,"hash":"291ceef6a66ec7b312a08cc1e40e2d84","cacheData":{"env":{}}}

.cache/fb/0f38cce2a05f032a90e21dff53696f.json

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

README.md

Lines changed: 26 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ yarn add @mrhanson/el-calendar
2424

2525
```html
2626
<template>
27-
<Calendar ref="calendar" v-model="selectedDate" comment="*some comment"></Calendar>
27+
<Calendar ref="calendar" v-model="selectedDate"></Calendar>
2828
</template>
2929

3030
<script>
@@ -44,62 +44,36 @@ yarn add @mrhanson/el-calendar
4444

4545
## Props
4646

47-
### value/v-model
47+
| Name | Type | Default | Options | Description |
48+
| ------------------------- | -------------- | ------------ | ------------------------------------------------------------------- | ----------------------- |
49+
| value/v-model | Date | `new Date()` | -- | Selected Date value |
50+
| today | Date | `new Date()` | -- | Used to set server time |
51+
| locale | string | `'cn'` | `'cn'`,`'en'` | i18n |
52+
| dotArr | Array<boolean> | `[]` | show dot under date or not, Notice:length of dotArr must be same as |
53+
| max date of current month |
4854

49-
- type: Date
50-
- default: `new Date()`
51-
52-
Selected Date value
53-
54-
### today
55-
56-
- type: Date
57-
- default: `new Date()`
58-
59-
### weekText
60-
61-
- type: Array
62-
- default: `['日', '一', '二', '三', '四', '五', '六']`
63-
64-
### bannerYearText
65-
66-
- type: String
67-
- default: `'年'`
68-
69-
### bannerMonthText
70-
71-
- type: String
72-
- default: `'月'`
73-
74-
### markArr
75-
76-
show mark under date or not
77-
78-
- type: Array<boolean>
79-
- default: `[]`
80-
81-
> Notice: The length of `markArr` must be same as the value of current month's max date
82-
83-
### comment
84-
85-
- type: String
86-
- default: `''`
55+
''`
8756

8857
## Events
8958

90-
### premonth
91-
92-
emit when vision moves to previous month
59+
| Name | Params | Description |
60+
| --------- | ------ | ---------------------------------------- |
61+
| premonth | | emit when vision moves to previous month |
62+
| nextmonth | | emit when vision moves to next month |
63+
| preyear | | emit when vision moves to previous year |
64+
| nextyear | | emit when vision moves to next year |
9365

94-
### nextmonth
66+
## Methods
9567

96-
emit when vision moves to next month
68+
| Methods | Params | Description |
69+
| --------------------------------- | ----------------------------------------------- | ----------------------------------- |
70+
| backToToday() | | set value & vision back to today |
71+
| toPreMonth() | | set vision to previous month |
72+
| toNextMonth() | | set vision to previous month |
73+
| toSpecificDate(year, month, date) | year: `number`, month: `number`, date: `number` | set value & vision to specific date |
9774

98-
## Methods
75+
## Slots
9976

100-
| Methods | Params | Description |
101-
| --------------------------------- | ----------------------------------------------- | ---------------------------------------- |
102-
| backToToday() | | set value & month visision back to today |
103-
| toPreMonth() | | set vision to previous month |
104-
| toNextMonth() | | set vision to previous month |
105-
| toSpecificDate(year, month, date) | year: `number`, month: `number`, date: `number` | |
77+
| name | Description |
78+
| ------- | --------------------------------------- |
79+
| comment | Used to add some comment under calendar |

docs/index.html

Lines changed: 1 addition & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1 @@
1-
<!DOCTYPE html>
2-
<html lang="en">
3-
<head>
4-
<meta charset="UTF-8">
5-
<meta name="viewport" content="width=device-width, initial-scale=1.0">
6-
<title>Vue-calendar</title>
7-
<link rel="stylesheet" href="/main.1f19ae8e.css"></head>
8-
<body>
9-
<div id="app"></div>
10-
<script src="/main.1f19ae8e.js"></script>
11-
</body>
12-
</html>
1+
<!DOCTYPE html><html lang="en"><head><meta charset="UTF-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><title>Vue-calendar</title><link rel="stylesheet" href="/main.8af463c3.css"></head><body> <div id="app"></div> <script src="/main.a14fad1f.js"></script> </body></html>

docs/main.1f19ae8e.css

Lines changed: 0 additions & 202 deletions
This file was deleted.

0 commit comments

Comments
 (0)