/
package.json
328 lines (328 loc) · 12.5 KB
/
package.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
{
"name": "@bootstrap-vue/calendar",
"version": "1.0.0",
"meta": {
"title": "Calendar",
"slug": "calendar",
"version": "2.5.0",
"description": "BootstrapVue custom calendar widget for selecting dates and controlling other components, fully WAI-ARIA accessible (a11y) and supports internationalization (i18n)",
"components": [
{
"component": "BCalendar",
"version": "2.5.0",
"props": [
{
"prop": "value",
"description": "Initially selected date value. Accepts either a `YYYY-MM-DD` string or a `Date` object"
},
{
"prop": "valueAsDate",
"description": "Returns a `Date` object for the v-model instead of a `YYYY-MM-DD` string"
},
{
"prop": "initialDate",
"version": "2.7.0",
"description": "When a `value` is not specified, sets the initial calendar month date that will be presented to the user. Accepts a value in `YYYY-MM-DD` format or a `Date` object. Defaults to the current date (or min or max if the current date is out of range)"
},
{
"prop": "disabled",
"description": "Places the calendar in a non-interactive disabled state"
},
{
"prop": "readonly",
"description": "Places the calendar in an interactive readonly state. Disables updating the v-model, while still allowing date navigation"
},
{
"prop": "selectedVariant",
"settings": true,
"description": "Theme color variant to use for the selected date button"
},
{
"prop": "todayVariant",
"settings": true,
"description": "Theme color variant to use for highlighting todays date button. Defaults to the `selectedVariant` prop"
},
{
"prop": "navButtonVariant",
"version": "2.17.0",
"settings": true,
"description": "Theme color variant to use for the navigation buttons"
},
{
"prop": "noHighlightToday",
"description": "Disabled the highlighting of todays date in the calendar"
},
{
"prop": "startWeekday",
"description": "Day of week to start the calendar. `0` for Sunday, `1` for Monday, `6` for Saturday, etc."
},
{
"prop": "locale",
"description": "Locale (or locales) for the calendar to use. When passing an array of locales, the order of the locales is from most preferred to least preferred"
},
{
"prop": "direction",
"description": "Set to the string 'rtl' or 'ltr' to explicitly force the calendar to render in right-to-left or left-ro-right (respectively) mode. Defaults to the resolved locale's directionality"
},
{
"prop": "min",
"description": "The minimum date the calendar will show"
},
{
"prop": "max",
"description": "The maximum date the calendar will show"
},
{
"prop": "dateDisabledFn",
"description": "Set to a function reference which returns `true` if the date is disabled, or `false` if the date should be enabled. See documentation for details"
},
{
"prop": "dateInfoFn",
"description": "Set to a function reference which returns a class (string), or classes (array of strings) to apply to the date cell. See documentation for details"
},
{
"prop": "width",
"description": "The width of the calendar. Has no effect if prop `block` is set"
},
{
"prop": "block",
"description": "Makes the calendar full width"
},
{
"prop": "ariaControls",
"description": "If the calendar controls another component/element, set this prop to the ID of the element the calendar controls"
},
{
"prop": "hideHeader",
"description": "When `true`, visually hides the selected date header"
},
{
"prop": "showDecadeNav",
"version": "2.11.0",
"description": "When `true`, shows the +/- decade navigation buttons"
},
{
"prop": "roleDescription",
"description": "Sets a value for the `role-description` attribute on the component"
},
{
"prop": "hidden",
"description": "When `true`, renders a comment node instead of the calendar widget while keeping the Vue instance active. Mainly used when implementing a custom date picker"
},
{
"prop": "labelPrevDecade",
"version": "2.11.0",
"settings": true,
"description": "Value of the `aria-label` and `title` attributes on the optional `Previous Decade` navigation button"
},
{
"prop": "labelPrevYear",
"settings": true,
"description": "Value of the `aria-label` and `title` attributes on the `Previous Year` navigation button"
},
{
"prop": "labelPrevMonth",
"settings": true,
"description": "Value of the `aria-label` and `title` attributes on the `Previous Month` navigation button"
},
{
"prop": "labelCurrentMonth",
"settings": true,
"description": "Value of the `aria-label` and `title` attributes on the `Current Month` navigation button"
},
{
"prop": "labelNextMonth",
"settings": true,
"description": "Value of the `aria-label` and `title` attributes on the `Next Month` navigation button"
},
{
"prop": "labelNextYear",
"settings": true,
"description": "Value of the `aria-label` and `title` attributes on the `Next Year` navigation button"
},
{
"prop": "labelNextDecade",
"version": "2.11.0",
"settings": true,
"description": "Value of the `aria-label` and `title` attributes on the optional `Next Decade` navigation button"
},
{
"prop": "labelSelected",
"settings": true,
"description": "Value of the `aria-label` attribute set on the calendar grid date button that is selected"
},
{
"prop": "labelToday",
"settings": true,
"description": "Value of the `aria-label` attribute for the calendar grid date button to signify that the date is today's date"
},
{
"prop": "labelNoDateSelected",
"settings": true,
"description": "Label to use when no date is currently selected"
},
{
"prop": "labelCalendar",
"settings": true,
"description": "Value of the `aria-label` and `role-description` attributes applied to the calendar grid"
},
{
"prop": "labelNav",
"settings": true,
"description": "Value of the `aria-label` attribute on to the calendar navigation button wrapper"
},
{
"prop": "labelHelp",
"settings": true,
"description": "Help text that appears at the bottom of the calendar grid"
},
{
"prop": "dateFormatOptions",
"version": "2.6.0",
"description": "Format object for displayed text string that is passed to `Intl.DateTimeFormat`"
},
{
"prop": "weekdayHeaderFormat",
"version": "2.12.0",
"description": "Format to use for the calendar weekday headings. Possible values are `long`, `short` (default), or `narrow`"
}
],
"events": [
{
"event": "input",
"description": "Emitted when updating the v-model",
"args": [
{
"arg": "date",
"description": "Either a string in the format of `YYYY-MM-DD` or a `Date` object (if `value-as-date` prop is `true`)",
"type": [
"String",
"Date"
]
}
]
},
{
"event": "selected",
"description": "Emitted when user has selected (clicked) a date. Note this event will also be emitted if the user clicks on the currently selected date",
"args": [
{
"arg": "ymd",
"description": "The selected date as a string in the format of `YYYY-MM-DD`",
"type": "String"
},
{
"arg": "date",
"description": "The selected date as a `Date` object",
"type": "Date"
}
]
},
{
"event": "context",
"description": "Emitted when when the user changes the active date via date navigation buttons or cursor control",
"args": [
{
"arg": "context",
"description": "The context object. See documentaion for details",
"type": [
"Object"
]
}
]
}
],
"slots": [
{
"name": "default",
"description": "Used to place custom controls at the bottom of the calendar component"
},
{
"name": "nav-prev-decade",
"version": "2.12.0",
"description": "Used to place custom content in the previous decade navigation button",
"scope": [
{
"prop": "isRTL",
"type": "Boolean",
"description": "Will be `true` if the nav bar is rendered right to left"
}
]
},
{
"name": "nav-prev-year",
"version": "2.12.0",
"description": "Used to place custom content in the previous year navigation button",
"scope": [
{
"prop": "isRTL",
"type": "Boolean",
"description": "Will be `true` if the date navigation bar is rendered right to left"
}
]
},
{
"name": "nav-prev-month",
"version": "2.12.0",
"description": "Used to place custom content in the previous month navigation button",
"scope": [
{
"prop": "isRTL",
"type": "Boolean",
"description": "Will be `true` if the date navigation bar is rendered right to left"
}
]
},
{
"name": "nav-this-month",
"version": "2.12.0",
"description": "Used to place custom content in the this month/day navigation button",
"scope": [
{
"prop": "isRTL",
"type": "Boolean",
"description": "Will be `true` if the date navigation bar is rendered right to left"
}
]
},
{
"name": "nav-next-month",
"version": "2.12.0",
"description": "Used to place custom content in the next month navigation button",
"scope": [
{
"prop": "isRTL",
"type": "Boolean",
"description": "Will be `true` if the date navigation bar is rendered right to left"
}
]
},
{
"name": "nav-next-year",
"version": "2.12.0",
"description": "Used to place custom content in the next year navigation button",
"scope": [
{
"prop": "isRTL",
"type": "Boolean",
"description": "Will be `true` if the date navigation bar is rendered right to left"
}
]
},
{
"name": "nav-next-decade",
"version": "2.12.0",
"description": "Used to place custom content in the next decade navigation button",
"scope": [
{
"prop": "isRTL",
"type": "Boolean",
"description": "Will be `true` if the date navigation bar is rendered right to left"
}
]
}
]
}
]
}
}