Skip to content

Commit 18204a1

Browse files
author
Nathan Reyes
committed
Update README
1 parent cb1ed61 commit 18204a1

File tree

1 file changed

+12
-6
lines changed

1 file changed

+12
-6
lines changed

README.md

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -356,6 +356,16 @@ export default {
356356
</html>
357357
```
358358

359+
### Polyfill
360+
361+
`v-calendar` is transpiled for ES5, but it still needs a polyfill for `Array.prototype.find` if you wish to target older browsers (IE11). Two options for accomplishing this are:
362+
1. **Easy way:**
363+
Insert the following script into your html before loading `v-calendar`. The polyfill will get loaded automatically *only if* the browser needs it.
364+
365+
`<script src="https://cdn.polyfill.io/v2/polyfill.min.js?features=Array.prototype.find" />`
366+
367+
2. In Node/Browserify/Webpack environments, use [babel-polyfill](https://babeljs.io/docs/usage/polyfill/) to insert the polyfill for you.
368+
359369
## Custom Defaults
360370

361371
Custom defaults can be provided on initialization. Note that almost all of these defaults can be overridden by props on `v-calendar` or `v-date-picker` components.
@@ -369,7 +379,7 @@ Vue.use(VCalendar, {
369379

370380
| Property Name | Type | Description | Default |
371381
| ------------- | ---- | ----------- | ------- |
372-
| `componentPrefix` | String | Custom prefix to use for plugin components | `"v"` |
382+
| `componentPrefix` | String | Custom prefix to use for plugin components. Replace if `v-calendar` and `v-date-picker` interfere with other component libraries. | `"v"` |
373383
| `firstDayOfWeek` | Number | Day number for the first day of the week (1: Sun - 7: Sat) | `1` |
374384
| `monthLabels` | Array | Month labels displayed in header (localized) | `["January", "February", "March", "April", "May", "June", "July", "August", "September", "October", "November", "December"]` |
375385
| `weekdayLabels` | Array | Weekday labels displayed in header. Start with Sunday, even if Sunday isn\'t set as the first day of the week. (localized) | `["S", "M", "T", "W", "T", "F", "S"]` |
@@ -379,11 +389,7 @@ Vue.use(VCalendar, {
379389
| `weeksTransition` | String | Transition type for weeks when navigating to a new page (`"slide-h"`, `"slide-v"`, `"fade"`, `"none"`) | `"slide-h"` |
380390
| `dateFormatter` | Function | Converts date object to preferred text format | `d => d.toLocaleDateString()` |
381391
| `dateParser` | Function | Converts string to date object | `s => new Date(Date.parse(s))` |
382-
| `datePickerInputClass` | String | Class to apply to input element. Not applicable for inline date-pickers. | `undefined` |
383-
| `datePickerInputStyle` | Object | Style to apply to input element. Not applicable for inline date-pickers. | `undefined` |
384-
| `datePickerInputPlaceholder` | String | Placeholder for input element. Not applicable for inline date pickers. | `undefined` |
385-
| `datePickerSelectColor` | String | Background color of the highlighted select region. | `"#66B3CC"` |
386-
| `datePickerDragColor` | String | Background color of the highlighted drag region. Only valid when `mode === "range"` | `""#9FCFDF""` |
392+
| `datePickerTintColor` | String | Background color of the selected and dragged highlighted regions (`opacity: 0.5` for dragged). This setting is overridden by `select-attribute` and `drag-attribute` if specified. | `"#66B3CC"` |
387393
| `datePickerShowCaps` | Boolean | Show caps and the end of the highlighted and dragged regions when `mode === "range"` | `false` |
388394
| `datePickerShowPopover` | Boolean | Show popover for dragged and selected regions | `true` |
389395
| `popoverExpanded` | Boolean | Popover wrapper for input or slot is expanded to the full width of its container. | `false` |

0 commit comments

Comments
 (0)