@vaadin/date-picker 24.0.0-alpha7 → 24.0.0-alpha9

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/web-types.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "$schema": "https://json.schemastore.org/web-types",
3
3
  "name": "@vaadin/date-picker",
4
- "version": "24.0.0-alpha7",
4
+ "version": "24.0.0-alpha9",
5
5
  "description-markup": "markdown",
6
6
  "contributions": {
7
7
  "html": {
@@ -10,6 +10,134 @@
10
10
  "name": "vaadin-date-picker-light",
11
11
  "description": "`<vaadin-date-picker-light>` is a customizable version of the `<vaadin-date-picker>` providing\nonly the scrollable month calendar view and leaving the input field definition to the user.\n\nTo create a custom input field, you need to add a child element which has a two-way\ndata-bindable property representing the input value. The property name is expected\nto be `bindValue` by default. See the example below for a simplest possible example\nusing an `<input>` element.\n\n```html\n<vaadin-date-picker-light attr-for-value=\"value\">\n <input class=\"input\">\n</vaadin-date-picker-light>\n```\n\n### Styling\n\nSee [Styling Components](https://vaadin.com/docs/latest/styling/custom-theme/styling-components) documentation.\n\nIn addition to `<vaadin-date-picker-light>` itself, the following\ninternal components are themable:\n\n- `<vaadin-date-picker-overlay>`\n- `<vaadin-date-picker-overlay-content>`\n- `<vaadin-month-calendar>`\n\nNote: the `theme` attribute value set on `<vaadin-date-picker-light>`\nis propagated to the internal themable components listed above.",
12
12
  "attributes": [
13
+ {
14
+ "name": "disabled",
15
+ "description": "If true, the user cannot interact with this element.",
16
+ "value": {
17
+ "type": [
18
+ "boolean",
19
+ "null",
20
+ "undefined"
21
+ ]
22
+ }
23
+ },
24
+ {
25
+ "name": "autofocus",
26
+ "description": "Specify that this control should have input focus when the page loads.",
27
+ "value": {
28
+ "type": [
29
+ "boolean",
30
+ "null",
31
+ "undefined"
32
+ ]
33
+ }
34
+ },
35
+ {
36
+ "name": "value",
37
+ "description": "Selected date.\n\nSupported date formats:\n- ISO 8601 `\"YYYY-MM-DD\"` (default)\n- 6-digit extended ISO 8601 `\"+YYYYYY-MM-DD\"`, `\"-YYYYYY-MM-DD\"`",
38
+ "value": {
39
+ "type": [
40
+ "string"
41
+ ]
42
+ }
43
+ },
44
+ {
45
+ "name": "invalid",
46
+ "description": "Set to true when the field is invalid.",
47
+ "value": {
48
+ "type": [
49
+ "boolean",
50
+ "null",
51
+ "undefined"
52
+ ]
53
+ }
54
+ },
55
+ {
56
+ "name": "required",
57
+ "description": "Specifies that the user must fill in a value.",
58
+ "value": {
59
+ "type": [
60
+ "boolean",
61
+ "null",
62
+ "undefined"
63
+ ]
64
+ }
65
+ },
66
+ {
67
+ "name": "overlay-class",
68
+ "description": "A space-delimited list of CSS class names to set on the overlay element.\nThis property does not affect other CSS class names set manually via JS.\n\nNote, if the CSS class name was set with this property, clearing it will\nremove it from the overlay, even if the same class name was also added\nmanually, e.g. by using `classList.add()` in the `renderer` function.",
69
+ "value": {
70
+ "type": [
71
+ "string",
72
+ "null",
73
+ "undefined"
74
+ ]
75
+ }
76
+ },
77
+ {
78
+ "name": "initial-position",
79
+ "description": "Date which should be visible when there is no value selected.\n\nThe same date formats as for the `value` property are supported.",
80
+ "value": {
81
+ "type": [
82
+ "string",
83
+ "null",
84
+ "undefined"
85
+ ]
86
+ }
87
+ },
88
+ {
89
+ "name": "opened",
90
+ "description": "Set true to open the date selector overlay.",
91
+ "value": {
92
+ "type": [
93
+ "boolean",
94
+ "null",
95
+ "undefined"
96
+ ]
97
+ }
98
+ },
99
+ {
100
+ "name": "auto-open-disabled",
101
+ "description": "Set true to prevent the overlay from opening automatically.",
102
+ "value": {
103
+ "type": [
104
+ "boolean",
105
+ "null",
106
+ "undefined"
107
+ ]
108
+ }
109
+ },
110
+ {
111
+ "name": "show-week-numbers",
112
+ "description": "Set true to display ISO-8601 week numbers in the calendar. Notice that\ndisplaying week numbers is only supported when `i18n.firstDayOfWeek`\nis 1 (Monday).",
113
+ "value": {
114
+ "type": [
115
+ "boolean",
116
+ "null",
117
+ "undefined"
118
+ ]
119
+ }
120
+ },
121
+ {
122
+ "name": "min",
123
+ "description": "The earliest date that can be selected. All earlier dates will be disabled.\n\nSupported date formats:\n- ISO 8601 `\"YYYY-MM-DD\"` (default)\n- 6-digit extended ISO 8601 `\"+YYYYYY-MM-DD\"`, `\"-YYYYYY-MM-DD\"`",
124
+ "value": {
125
+ "type": [
126
+ "string",
127
+ "undefined"
128
+ ]
129
+ }
130
+ },
131
+ {
132
+ "name": "max",
133
+ "description": "The latest date that can be selected. All later dates will be disabled.\n\nSupported date formats:\n- ISO 8601 `\"YYYY-MM-DD\"` (default)\n- 6-digit extended ISO 8601 `\"+YYYYYY-MM-DD\"`, `\"-YYYYYY-MM-DD\"`",
134
+ "value": {
135
+ "type": [
136
+ "string",
137
+ "undefined"
138
+ ]
139
+ }
140
+ },
13
141
  {
14
142
  "name": "attr-for-value",
15
143
  "description": "Name of the two-way data-bindable property representing the\nvalue of the custom input field.",
@@ -33,6 +161,143 @@
33
161
  ],
34
162
  "js": {
35
163
  "properties": [
164
+ {
165
+ "name": "disabled",
166
+ "description": "If true, the user cannot interact with this element.",
167
+ "value": {
168
+ "type": [
169
+ "boolean",
170
+ "null",
171
+ "undefined"
172
+ ]
173
+ }
174
+ },
175
+ {
176
+ "name": "autofocus",
177
+ "description": "Specify that this control should have input focus when the page loads.",
178
+ "value": {
179
+ "type": [
180
+ "boolean",
181
+ "null",
182
+ "undefined"
183
+ ]
184
+ }
185
+ },
186
+ {
187
+ "name": "value",
188
+ "description": "Selected date.\n\nSupported date formats:\n- ISO 8601 `\"YYYY-MM-DD\"` (default)\n- 6-digit extended ISO 8601 `\"+YYYYYY-MM-DD\"`, `\"-YYYYYY-MM-DD\"`",
189
+ "value": {
190
+ "type": [
191
+ "string"
192
+ ]
193
+ }
194
+ },
195
+ {
196
+ "name": "invalid",
197
+ "description": "Set to true when the field is invalid.",
198
+ "value": {
199
+ "type": [
200
+ "boolean",
201
+ "null",
202
+ "undefined"
203
+ ]
204
+ }
205
+ },
206
+ {
207
+ "name": "required",
208
+ "description": "Specifies that the user must fill in a value.",
209
+ "value": {
210
+ "type": [
211
+ "boolean",
212
+ "null",
213
+ "undefined"
214
+ ]
215
+ }
216
+ },
217
+ {
218
+ "name": "overlayClass",
219
+ "description": "A space-delimited list of CSS class names to set on the overlay element.\nThis property does not affect other CSS class names set manually via JS.\n\nNote, if the CSS class name was set with this property, clearing it will\nremove it from the overlay, even if the same class name was also added\nmanually, e.g. by using `classList.add()` in the `renderer` function.",
220
+ "value": {
221
+ "type": [
222
+ "string",
223
+ "null",
224
+ "undefined"
225
+ ]
226
+ }
227
+ },
228
+ {
229
+ "name": "initialPosition",
230
+ "description": "Date which should be visible when there is no value selected.\n\nThe same date formats as for the `value` property are supported.",
231
+ "value": {
232
+ "type": [
233
+ "string",
234
+ "null",
235
+ "undefined"
236
+ ]
237
+ }
238
+ },
239
+ {
240
+ "name": "opened",
241
+ "description": "Set true to open the date selector overlay.",
242
+ "value": {
243
+ "type": [
244
+ "boolean",
245
+ "null",
246
+ "undefined"
247
+ ]
248
+ }
249
+ },
250
+ {
251
+ "name": "autoOpenDisabled",
252
+ "description": "Set true to prevent the overlay from opening automatically.",
253
+ "value": {
254
+ "type": [
255
+ "boolean",
256
+ "null",
257
+ "undefined"
258
+ ]
259
+ }
260
+ },
261
+ {
262
+ "name": "showWeekNumbers",
263
+ "description": "Set true to display ISO-8601 week numbers in the calendar. Notice that\ndisplaying week numbers is only supported when `i18n.firstDayOfWeek`\nis 1 (Monday).",
264
+ "value": {
265
+ "type": [
266
+ "boolean",
267
+ "null",
268
+ "undefined"
269
+ ]
270
+ }
271
+ },
272
+ {
273
+ "name": "i18n",
274
+ "description": "The object used to localize this component.\nTo change the default localization, replace the entire\n`i18n` object with a custom one.\n\nTo update individual properties, extend the existing i18n object like so:\n```\ndatePicker.i18n = { ...datePicker.i18n, {\n formatDate: date => { ... },\n parseDate: value => { ... },\n}};\n```\n\nThe object has the following JSON structure and default values:\n\n```\n{\n // An array with the full names of months starting\n // with January.\n monthNames: [\n 'January', 'February', 'March', 'April', 'May',\n 'June', 'July', 'August', 'September',\n 'October', 'November', 'December'\n ],\n\n // An array of weekday names starting with Sunday. Used\n // in screen reader announcements.\n weekdays: [\n 'Sunday', 'Monday', 'Tuesday', 'Wednesday',\n 'Thursday', 'Friday', 'Saturday'\n ],\n\n // An array of short weekday names starting with Sunday.\n // Displayed in the calendar.\n weekdaysShort: [\n 'Sun', 'Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat'\n ],\n\n // An integer indicating the first day of the week\n // (0 = Sunday, 1 = Monday, etc.).\n firstDayOfWeek: 0,\n\n // Translation of the Today shortcut button text.\n today: 'Today',\n\n // Translation of the Cancel button text.\n cancel: 'Cancel',\n\n // Used for adjusting the year value when parsing dates with short years.\n // The year values between 0 and 99 are evaluated and adjusted.\n // Example: for a referenceDate of 1970-10-30;\n // dateToBeParsed: 40-10-30, result: 1940-10-30\n // dateToBeParsed: 80-10-30, result: 1980-10-30\n // dateToBeParsed: 10-10-30, result: 2010-10-30\n // Supported date format: ISO 8601 `\"YYYY-MM-DD\"` (default)\n // The default value is the current date.\n referenceDate: '',\n\n // A function to format given `Object` as\n // date string. Object is in the format `{ day: ..., month: ..., year: ... }`\n // Note: The argument month is 0-based. This means that January = 0 and December = 11.\n formatDate: d => {\n // returns a string representation of the given\n // object in 'MM/DD/YYYY' -format\n },\n\n // A function to parse the given text to an `Object` in the format `{ day: ..., month: ..., year: ... }`.\n // Must properly parse (at least) text formatted by `formatDate`.\n // Setting the property to null will disable keyboard input feature.\n // Note: The argument month is 0-based. This means that January = 0 and December = 11.\n parseDate: text => {\n // Parses a string in 'MM/DD/YY', 'MM/DD' or 'DD' -format to\n // an `Object` in the format `{ day: ..., month: ..., year: ... }`.\n }\n\n // A function to format given `monthName` and\n // `fullYear` integer as calendar title string.\n formatTitle: (monthName, fullYear) => {\n return monthName + ' ' + fullYear;\n }\n}\n```",
275
+ "value": {
276
+ "type": [
277
+ "DatePickerI18n"
278
+ ]
279
+ }
280
+ },
281
+ {
282
+ "name": "min",
283
+ "description": "The earliest date that can be selected. All earlier dates will be disabled.\n\nSupported date formats:\n- ISO 8601 `\"YYYY-MM-DD\"` (default)\n- 6-digit extended ISO 8601 `\"+YYYYYY-MM-DD\"`, `\"-YYYYYY-MM-DD\"`",
284
+ "value": {
285
+ "type": [
286
+ "string",
287
+ "undefined"
288
+ ]
289
+ }
290
+ },
291
+ {
292
+ "name": "max",
293
+ "description": "The latest date that can be selected. All later dates will be disabled.\n\nSupported date formats:\n- ISO 8601 `\"YYYY-MM-DD\"` (default)\n- 6-digit extended ISO 8601 `\"+YYYYYY-MM-DD\"`, `\"-YYYYYY-MM-DD\"`",
294
+ "value": {
295
+ "type": [
296
+ "string",
297
+ "undefined"
298
+ ]
299
+ }
300
+ },
36
301
  {
37
302
  "name": "attrForValue",
38
303
  "description": "Name of the two-way data-bindable property representing the\nvalue of the custom input field.",
@@ -43,12 +308,33 @@
43
308
  }
44
309
  }
45
310
  ],
46
- "events": []
311
+ "events": [
312
+ {
313
+ "name": "validated",
314
+ "description": "Fired whenever the field is validated."
315
+ },
316
+ {
317
+ "name": "change",
318
+ "description": "Fired when the user commits a value change."
319
+ },
320
+ {
321
+ "name": "opened-changed",
322
+ "description": "Fired when `opened` property value changes."
323
+ },
324
+ {
325
+ "name": "value-changed",
326
+ "description": "Fired when `value` property value changes."
327
+ },
328
+ {
329
+ "name": "invalid-changed",
330
+ "description": "Fired when the `invalid` property changes."
331
+ }
332
+ ]
47
333
  }
48
334
  },
49
335
  {
50
336
  "name": "vaadin-date-picker",
51
- "description": "`<vaadin-date-picker>` is an input field that allows to enter a date by typing or by selecting from a calendar overlay.\n\n```html\n<vaadin-date-picker label=\"Birthday\"></vaadin-date-picker>\n```\n```js\ndatePicker.value = '2016-03-02';\n```\n\nWhen the selected `value` is changed, a `value-changed` event is triggered.\n\n### Styling\n\nThe following custom properties are available for styling:\n\nCustom property | Description | Default\n-------------------------------|----------------------------|---------\n`--vaadin-field-default-width` | Default width of the field | `12em`\n\n`<vaadin-date-picker>` provides the same set of shadow DOM parts and state attributes as `<vaadin-text-field>`.\nSee [`<vaadin-text-field>`](https://cdn.vaadin.com/vaadin-web-components/24.0.0-alpha7/#/elements/vaadin-text-field) for the styling documentation.\n\nIn addition to `<vaadin-text-field>` parts, the following parts are available for theming:\n\nPart name | Description\n----------------------|--------------------\n`toggle-button` | Toggle button\n\nIn addition to `<vaadin-text-field>` state attributes, the following state attributes are available for theming:\n\nAttribute | Description | Part name\n-----------|--------------------------------------------------|-----------\n`opened` | Set when the date selector overlay is opened | :host\n\nIf you want to replace the default `<input>` and its container with a custom implementation to get full control\nover the input field, consider using the [`<vaadin-date-picker-light>`](https://cdn.vaadin.com/vaadin-web-components/24.0.0-alpha7/#/elements/vaadin-date-picker-light) element.\n\n### Internal components\n\nIn addition to `<vaadin-date-picker>` itself, the following internal\ncomponents are themable:\n\n- `<vaadin-date-picker-overlay>` - has the same API as [`<vaadin-overlay>`](https://cdn.vaadin.com/vaadin-web-components/24.0.0-alpha7/#/elements/vaadin-overlay).\n- `<vaadin-date-picker-overlay-content>`\n- `<vaadin-date-picker-month-scroller>`\n- `<vaadin-date-picker-year-scroller>`\n- `<vaadin-date-picker-year>`\n- `<vaadin-month-calendar>`\n- [`<vaadin-input-container>`](https://cdn.vaadin.com/vaadin-web-components/24.0.0-alpha7/#/elements/vaadin-input-container) - an internal element wrapping the input.\n\nIn order to style the overlay content, use `<vaadin-date-picker-overlay-content>` shadow DOM parts:\n\nPart name | Description\n----------------------|--------------------\n`overlay-header` | Fullscreen mode header\n`label` | Fullscreen mode value/label\n`clear-button` | Fullscreen mode clear button\n`toggle-button` | Fullscreen mode toggle button\n`years-toggle-button` | Fullscreen mode years scroller toggle\n`toolbar` | Footer bar with slotted buttons\n\nThe following state attributes are available on the `<vaadin-date-picker-overlay-content>` element:\n\nAttribute | Description\n----------------|-------------------------------------------------\n`desktop` | Set when the overlay content is in desktop mode\n`fullscreen` | Set when the overlay content is in fullscreen mode\n`years-visible` | Set when the year scroller is visible in fullscreen mode\n\nIn order to style the month calendar, use `<vaadin-month-calendar>` shadow DOM parts:\n\nPart name | Description\n----------------------|--------------------\n`month-header` | Month title\n`weekdays` | Weekday container\n`weekday` | Weekday element\n`week-numbers` | Week numbers container\n`week-number` | Week number element\n`date` | Date element\n`disabled` | Disabled date element\n`focused` | Focused date element\n`selected` | Selected date element\n`today` | Date element corresponding to the current day\n\nIn order to style year scroller elements, use `<vaadin-date-picker-year>` shadow DOM parts:\n\nPart name | Description\n----------------------|--------------------\n`year-number` | Year number\n`year-separator` | Year separator\n\nNote: the `theme` attribute value set on `<vaadin-date-picker>` is\npropagated to the internal components listed above.\n\nSee [Styling Components](https://vaadin.com/docs/latest/styling/custom-theme/styling-components) documentation.",
337
+ "description": "`<vaadin-date-picker>` is an input field that allows to enter a date by typing or by selecting from a calendar overlay.\n\n```html\n<vaadin-date-picker label=\"Birthday\"></vaadin-date-picker>\n```\n```js\ndatePicker.value = '2016-03-02';\n```\n\nWhen the selected `value` is changed, a `value-changed` event is triggered.\n\n### Styling\n\nThe following custom properties are available for styling:\n\nCustom property | Description | Default\n-------------------------------|----------------------------|---------\n`--vaadin-field-default-width` | Default width of the field | `12em`\n\n`<vaadin-date-picker>` provides the same set of shadow DOM parts and state attributes as `<vaadin-text-field>`.\nSee [`<vaadin-text-field>`](https://cdn.vaadin.com/vaadin-web-components/24.0.0-alpha9/#/elements/vaadin-text-field) for the styling documentation.\n\nIn addition to `<vaadin-text-field>` parts, the following parts are available for theming:\n\nPart name | Description\n----------------------|--------------------\n`toggle-button` | Toggle button\n\nIn addition to `<vaadin-text-field>` state attributes, the following state attributes are available for theming:\n\nAttribute | Description | Part name\n-----------|--------------------------------------------------|-----------\n`opened` | Set when the date selector overlay is opened | :host\n\nIf you want to replace the default `<input>` and its container with a custom implementation to get full control\nover the input field, consider using the [`<vaadin-date-picker-light>`](https://cdn.vaadin.com/vaadin-web-components/24.0.0-alpha9/#/elements/vaadin-date-picker-light) element.\n\n### Internal components\n\nIn addition to `<vaadin-date-picker>` itself, the following internal\ncomponents are themable:\n\n- `<vaadin-date-picker-overlay>` - has the same API as [`<vaadin-overlay>`](https://cdn.vaadin.com/vaadin-web-components/24.0.0-alpha9/#/elements/vaadin-overlay).\n- `<vaadin-date-picker-overlay-content>`\n- `<vaadin-date-picker-month-scroller>`\n- `<vaadin-date-picker-year-scroller>`\n- `<vaadin-date-picker-year>`\n- `<vaadin-month-calendar>`\n- [`<vaadin-input-container>`](https://cdn.vaadin.com/vaadin-web-components/24.0.0-alpha9/#/elements/vaadin-input-container) - an internal element wrapping the input.\n\nIn order to style the overlay content, use `<vaadin-date-picker-overlay-content>` shadow DOM parts:\n\nPart name | Description\n----------------------|--------------------\n`overlay-header` | Fullscreen mode header\n`label` | Fullscreen mode value/label\n`clear-button` | Fullscreen mode clear button\n`toggle-button` | Fullscreen mode toggle button\n`years-toggle-button` | Fullscreen mode years scroller toggle\n`toolbar` | Footer bar with slotted buttons\n\nThe following state attributes are available on the `<vaadin-date-picker-overlay-content>` element:\n\nAttribute | Description\n----------------|-------------------------------------------------\n`desktop` | Set when the overlay content is in desktop mode\n`fullscreen` | Set when the overlay content is in fullscreen mode\n`years-visible` | Set when the year scroller is visible in fullscreen mode\n\nIn order to style the month calendar, use `<vaadin-month-calendar>` shadow DOM parts:\n\nPart name | Description\n----------------------|--------------------\n`month-header` | Month title\n`weekdays` | Weekday container\n`weekday` | Weekday element\n`week-numbers` | Week numbers container\n`week-number` | Week number element\n`date` | Date element\n`disabled` | Disabled date element\n`focused` | Focused date element\n`selected` | Selected date element\n`today` | Date element corresponding to the current day\n\nIn order to style year scroller elements, use `<vaadin-date-picker-year>` shadow DOM parts:\n\nPart name | Description\n----------------------|--------------------\n`year-number` | Year number\n`year-separator` | Year separator\n\nNote: the `theme` attribute value set on `<vaadin-date-picker>` is\npropagated to the internal components listed above.\n\nSee [Styling Components](https://vaadin.com/docs/latest/styling/custom-theme/styling-components) documentation.",
52
338
  "attributes": [
53
339
  {
54
340
  "name": "disabled",
@@ -129,12 +415,10 @@
129
415
  },
130
416
  {
131
417
  "name": "value",
132
- "description": "The value of the field.",
418
+ "description": "Selected date.\n\nSupported date formats:\n- ISO 8601 `\"YYYY-MM-DD\"` (default)\n- 6-digit extended ISO 8601 `\"+YYYYYY-MM-DD\"`, `\"-YYYYYY-MM-DD\"`",
133
419
  "value": {
134
420
  "type": [
135
- "string",
136
- "null",
137
- "undefined"
421
+ "string"
138
422
  ]
139
423
  }
140
424
  },
@@ -215,6 +499,81 @@
215
499
  ]
216
500
  }
217
501
  },
502
+ {
503
+ "name": "overlay-class",
504
+ "description": "A space-delimited list of CSS class names to set on the overlay element.\nThis property does not affect other CSS class names set manually via JS.\n\nNote, if the CSS class name was set with this property, clearing it will\nremove it from the overlay, even if the same class name was also added\nmanually, e.g. by using `classList.add()` in the `renderer` function.",
505
+ "value": {
506
+ "type": [
507
+ "string",
508
+ "null",
509
+ "undefined"
510
+ ]
511
+ }
512
+ },
513
+ {
514
+ "name": "initial-position",
515
+ "description": "Date which should be visible when there is no value selected.\n\nThe same date formats as for the `value` property are supported.",
516
+ "value": {
517
+ "type": [
518
+ "string",
519
+ "null",
520
+ "undefined"
521
+ ]
522
+ }
523
+ },
524
+ {
525
+ "name": "opened",
526
+ "description": "Set true to open the date selector overlay.",
527
+ "value": {
528
+ "type": [
529
+ "boolean",
530
+ "null",
531
+ "undefined"
532
+ ]
533
+ }
534
+ },
535
+ {
536
+ "name": "auto-open-disabled",
537
+ "description": "Set true to prevent the overlay from opening automatically.",
538
+ "value": {
539
+ "type": [
540
+ "boolean",
541
+ "null",
542
+ "undefined"
543
+ ]
544
+ }
545
+ },
546
+ {
547
+ "name": "show-week-numbers",
548
+ "description": "Set true to display ISO-8601 week numbers in the calendar. Notice that\ndisplaying week numbers is only supported when `i18n.firstDayOfWeek`\nis 1 (Monday).",
549
+ "value": {
550
+ "type": [
551
+ "boolean",
552
+ "null",
553
+ "undefined"
554
+ ]
555
+ }
556
+ },
557
+ {
558
+ "name": "min",
559
+ "description": "The earliest date that can be selected. All earlier dates will be disabled.\n\nSupported date formats:\n- ISO 8601 `\"YYYY-MM-DD\"` (default)\n- 6-digit extended ISO 8601 `\"+YYYYYY-MM-DD\"`, `\"-YYYYYY-MM-DD\"`",
560
+ "value": {
561
+ "type": [
562
+ "string",
563
+ "undefined"
564
+ ]
565
+ }
566
+ },
567
+ {
568
+ "name": "max",
569
+ "description": "The latest date that can be selected. All later dates will be disabled.\n\nSupported date formats:\n- ISO 8601 `\"YYYY-MM-DD\"` (default)\n- 6-digit extended ISO 8601 `\"+YYYYYY-MM-DD\"`, `\"-YYYYYY-MM-DD\"`",
570
+ "value": {
571
+ "type": [
572
+ "string",
573
+ "undefined"
574
+ ]
575
+ }
576
+ },
218
577
  {
219
578
  "name": "theme",
220
579
  "description": "The theme variants to apply to the component.",
@@ -229,44 +588,6 @@
229
588
  ],
230
589
  "js": {
231
590
  "properties": [
232
- {
233
- "name": "rootPath",
234
- "description": "",
235
- "value": {
236
- "type": [
237
- "string"
238
- ]
239
- }
240
- },
241
- {
242
- "name": "importPath",
243
- "description": "",
244
- "value": {
245
- "type": [
246
- "string"
247
- ]
248
- }
249
- },
250
- {
251
- "name": "root",
252
- "description": "",
253
- "value": {
254
- "type": [
255
- "StampedTemplate",
256
- "HTMLElement",
257
- "ShadowRoot"
258
- ]
259
- }
260
- },
261
- {
262
- "name": "$",
263
- "description": "",
264
- "value": {
265
- "type": [
266
- "Object.<string, Element>"
267
- ]
268
- }
269
- },
270
591
  {
271
592
  "name": "disabled",
272
593
  "description": "If true, the user cannot interact with this element.",
@@ -346,12 +667,10 @@
346
667
  },
347
668
  {
348
669
  "name": "value",
349
- "description": "The value of the field.",
670
+ "description": "Selected date.\n\nSupported date formats:\n- ISO 8601 `\"YYYY-MM-DD\"` (default)\n- 6-digit extended ISO 8601 `\"+YYYYYY-MM-DD\"`, `\"-YYYYYY-MM-DD\"`",
350
671
  "value": {
351
672
  "type": [
352
- "string",
353
- "null",
354
- "undefined"
673
+ "string"
355
674
  ]
356
675
  }
357
676
  },
@@ -431,6 +750,90 @@
431
750
  "undefined"
432
751
  ]
433
752
  }
753
+ },
754
+ {
755
+ "name": "overlayClass",
756
+ "description": "A space-delimited list of CSS class names to set on the overlay element.\nThis property does not affect other CSS class names set manually via JS.\n\nNote, if the CSS class name was set with this property, clearing it will\nremove it from the overlay, even if the same class name was also added\nmanually, e.g. by using `classList.add()` in the `renderer` function.",
757
+ "value": {
758
+ "type": [
759
+ "string",
760
+ "null",
761
+ "undefined"
762
+ ]
763
+ }
764
+ },
765
+ {
766
+ "name": "initialPosition",
767
+ "description": "Date which should be visible when there is no value selected.\n\nThe same date formats as for the `value` property are supported.",
768
+ "value": {
769
+ "type": [
770
+ "string",
771
+ "null",
772
+ "undefined"
773
+ ]
774
+ }
775
+ },
776
+ {
777
+ "name": "opened",
778
+ "description": "Set true to open the date selector overlay.",
779
+ "value": {
780
+ "type": [
781
+ "boolean",
782
+ "null",
783
+ "undefined"
784
+ ]
785
+ }
786
+ },
787
+ {
788
+ "name": "autoOpenDisabled",
789
+ "description": "Set true to prevent the overlay from opening automatically.",
790
+ "value": {
791
+ "type": [
792
+ "boolean",
793
+ "null",
794
+ "undefined"
795
+ ]
796
+ }
797
+ },
798
+ {
799
+ "name": "showWeekNumbers",
800
+ "description": "Set true to display ISO-8601 week numbers in the calendar. Notice that\ndisplaying week numbers is only supported when `i18n.firstDayOfWeek`\nis 1 (Monday).",
801
+ "value": {
802
+ "type": [
803
+ "boolean",
804
+ "null",
805
+ "undefined"
806
+ ]
807
+ }
808
+ },
809
+ {
810
+ "name": "i18n",
811
+ "description": "The object used to localize this component.\nTo change the default localization, replace the entire\n`i18n` object with a custom one.\n\nTo update individual properties, extend the existing i18n object like so:\n```\ndatePicker.i18n = { ...datePicker.i18n, {\n formatDate: date => { ... },\n parseDate: value => { ... },\n}};\n```\n\nThe object has the following JSON structure and default values:\n\n```\n{\n // An array with the full names of months starting\n // with January.\n monthNames: [\n 'January', 'February', 'March', 'April', 'May',\n 'June', 'July', 'August', 'September',\n 'October', 'November', 'December'\n ],\n\n // An array of weekday names starting with Sunday. Used\n // in screen reader announcements.\n weekdays: [\n 'Sunday', 'Monday', 'Tuesday', 'Wednesday',\n 'Thursday', 'Friday', 'Saturday'\n ],\n\n // An array of short weekday names starting with Sunday.\n // Displayed in the calendar.\n weekdaysShort: [\n 'Sun', 'Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat'\n ],\n\n // An integer indicating the first day of the week\n // (0 = Sunday, 1 = Monday, etc.).\n firstDayOfWeek: 0,\n\n // Translation of the Today shortcut button text.\n today: 'Today',\n\n // Translation of the Cancel button text.\n cancel: 'Cancel',\n\n // Used for adjusting the year value when parsing dates with short years.\n // The year values between 0 and 99 are evaluated and adjusted.\n // Example: for a referenceDate of 1970-10-30;\n // dateToBeParsed: 40-10-30, result: 1940-10-30\n // dateToBeParsed: 80-10-30, result: 1980-10-30\n // dateToBeParsed: 10-10-30, result: 2010-10-30\n // Supported date format: ISO 8601 `\"YYYY-MM-DD\"` (default)\n // The default value is the current date.\n referenceDate: '',\n\n // A function to format given `Object` as\n // date string. Object is in the format `{ day: ..., month: ..., year: ... }`\n // Note: The argument month is 0-based. This means that January = 0 and December = 11.\n formatDate: d => {\n // returns a string representation of the given\n // object in 'MM/DD/YYYY' -format\n },\n\n // A function to parse the given text to an `Object` in the format `{ day: ..., month: ..., year: ... }`.\n // Must properly parse (at least) text formatted by `formatDate`.\n // Setting the property to null will disable keyboard input feature.\n // Note: The argument month is 0-based. This means that January = 0 and December = 11.\n parseDate: text => {\n // Parses a string in 'MM/DD/YY', 'MM/DD' or 'DD' -format to\n // an `Object` in the format `{ day: ..., month: ..., year: ... }`.\n }\n\n // A function to format given `monthName` and\n // `fullYear` integer as calendar title string.\n formatTitle: (monthName, fullYear) => {\n return monthName + ' ' + fullYear;\n }\n}\n```",
812
+ "value": {
813
+ "type": [
814
+ "DatePickerI18n"
815
+ ]
816
+ }
817
+ },
818
+ {
819
+ "name": "min",
820
+ "description": "The earliest date that can be selected. All earlier dates will be disabled.\n\nSupported date formats:\n- ISO 8601 `\"YYYY-MM-DD\"` (default)\n- 6-digit extended ISO 8601 `\"+YYYYYY-MM-DD\"`, `\"-YYYYYY-MM-DD\"`",
821
+ "value": {
822
+ "type": [
823
+ "string",
824
+ "undefined"
825
+ ]
826
+ }
827
+ },
828
+ {
829
+ "name": "max",
830
+ "description": "The latest date that can be selected. All later dates will be disabled.\n\nSupported date formats:\n- ISO 8601 `\"YYYY-MM-DD\"` (default)\n- 6-digit extended ISO 8601 `\"+YYYYYY-MM-DD\"`, `\"-YYYYYY-MM-DD\"`",
831
+ "value": {
832
+ "type": [
833
+ "string",
834
+ "undefined"
835
+ ]
836
+ }
434
837
  }
435
838
  ],
436
839
  "events": [
@@ -447,12 +850,16 @@
447
850
  "description": "Fired when the value is changed by the user: on every typing keystroke,\nand the value is cleared using the clear button."
448
851
  },
449
852
  {
450
- "name": "invalid-changed",
451
- "description": "Fired when the `invalid` property changes."
853
+ "name": "opened-changed",
854
+ "description": "Fired when `opened` property value changes."
452
855
  },
453
856
  {
454
857
  "name": "value-changed",
455
- "description": "Fired when the `value` property changes."
858
+ "description": "Fired when `value` property value changes."
859
+ },
860
+ {
861
+ "name": "invalid-changed",
862
+ "description": "Fired when the `invalid` property changes."
456
863
  }
457
864
  ]
458
865
  }