@refinitiv-ui/elements 5.7.0 → 5.8.0

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.
Files changed (161) hide show
  1. package/CHANGELOG.md +19 -0
  2. package/lib/autosuggest/custom-elements.json +14 -4
  3. package/lib/autosuggest/custom-elements.md +21 -14
  4. package/lib/autosuggest/index.d.ts +4 -0
  5. package/lib/autosuggest/index.js +4 -0
  6. package/lib/calendar/custom-elements.json +4 -2
  7. package/lib/calendar/custom-elements.md +2 -2
  8. package/lib/calendar/index.d.ts +2 -0
  9. package/lib/calendar/index.js +2 -0
  10. package/lib/canvas/custom-elements.json +7 -5
  11. package/lib/canvas/custom-elements.md +8 -8
  12. package/lib/canvas/index.d.ts +1 -0
  13. package/lib/canvas/index.js +1 -0
  14. package/lib/card/custom-elements.json +3 -1
  15. package/lib/card/custom-elements.md +5 -5
  16. package/lib/card/index.d.ts +2 -0
  17. package/lib/card/index.js +2 -0
  18. package/lib/chart/custom-elements.json +1 -1
  19. package/lib/chart/custom-elements.md +4 -4
  20. package/lib/checkbox/custom-elements.json +8 -4
  21. package/lib/checkbox/custom-elements.md +2 -2
  22. package/lib/checkbox/index.d.ts +3 -1
  23. package/lib/checkbox/index.js +2 -0
  24. package/lib/clock/custom-elements.json +8 -4
  25. package/lib/clock/custom-elements.md +9 -9
  26. package/lib/clock/index.d.ts +2 -0
  27. package/lib/clock/index.js +2 -0
  28. package/lib/clock/themes/halo/dark/index.js +1 -1
  29. package/lib/clock/themes/halo/light/index.js +1 -1
  30. package/lib/clock/themes/solar/charcoal/index.js +1 -1
  31. package/lib/clock/themes/solar/pearl/index.js +1 -1
  32. package/lib/color-dialog/custom-elements.json +21 -8
  33. package/lib/color-dialog/custom-elements.md +22 -22
  34. package/lib/color-dialog/index.d.ts +8 -8
  35. package/lib/color-dialog/index.js +8 -8
  36. package/lib/combo-box/custom-elements.json +19 -10
  37. package/lib/combo-box/custom-elements.md +20 -20
  38. package/lib/combo-box/index.d.ts +10 -2
  39. package/lib/combo-box/index.js +10 -1
  40. package/lib/combo-box/themes/halo/dark/index.js +1 -1
  41. package/lib/combo-box/themes/halo/light/index.js +1 -1
  42. package/lib/combo-box/themes/solar/charcoal/index.js +1 -1
  43. package/lib/combo-box/themes/solar/pearl/index.js +1 -1
  44. package/lib/counter/custom-elements.json +8 -4
  45. package/lib/counter/custom-elements.md +4 -4
  46. package/lib/counter/index.d.ts +2 -0
  47. package/lib/counter/index.js +2 -0
  48. package/lib/datetime-picker/custom-elements.json +48 -19
  49. package/lib/datetime-picker/custom-elements.md +36 -28
  50. package/lib/datetime-picker/index.d.ts +15 -4
  51. package/lib/datetime-picker/index.js +15 -4
  52. package/lib/dialog/custom-elements.json +30 -8
  53. package/lib/dialog/custom-elements.md +16 -16
  54. package/lib/dialog/index.d.ts +7 -10
  55. package/lib/dialog/index.js +7 -10
  56. package/lib/email-field/custom-elements.json +80 -93
  57. package/lib/email-field/custom-elements.md +22 -20
  58. package/lib/email-field/index.d.ts +43 -115
  59. package/lib/email-field/index.js +44 -244
  60. package/lib/flag/custom-elements.md +4 -4
  61. package/lib/flag/index.d.ts +2 -0
  62. package/lib/flag/index.js +2 -0
  63. package/lib/icon/custom-elements.md +4 -4
  64. package/lib/icon/index.d.ts +2 -0
  65. package/lib/icon/index.js +2 -0
  66. package/lib/interactive-chart/custom-elements.json +6 -10
  67. package/lib/interactive-chart/custom-elements.md +6 -7
  68. package/lib/interactive-chart/index.d.ts +5 -2
  69. package/lib/interactive-chart/index.js +5 -2
  70. package/lib/item/custom-elements.json +8 -6
  71. package/lib/item/custom-elements.md +14 -14
  72. package/lib/item/index.d.ts +2 -1
  73. package/lib/item/index.js +2 -1
  74. package/lib/led-gauge/custom-elements.json +4 -4
  75. package/lib/led-gauge/custom-elements.md +2 -2
  76. package/lib/led-gauge/index.d.ts +1 -0
  77. package/lib/led-gauge/index.js +1 -0
  78. package/lib/list/custom-elements.json +18 -5
  79. package/lib/list/custom-elements.md +12 -10
  80. package/lib/list/helpers/list-renderer.js +2 -0
  81. package/lib/list/index.d.ts +19 -2
  82. package/lib/list/index.js +34 -1
  83. package/lib/multi-input/custom-elements.json +3 -2
  84. package/lib/multi-input/custom-elements.md +16 -16
  85. package/lib/multi-input/index.d.ts +4 -0
  86. package/lib/multi-input/index.js +4 -0
  87. package/lib/number-field/custom-elements.json +97 -52
  88. package/lib/number-field/custom-elements.md +27 -22
  89. package/lib/number-field/index.d.ts +92 -47
  90. package/lib/number-field/index.js +113 -80
  91. package/lib/overlay/custom-elements.json +23 -13
  92. package/lib/overlay/custom-elements.md +29 -29
  93. package/lib/overlay/elements/overlay.d.ts +5 -0
  94. package/lib/overlay-menu/custom-elements.json +66 -14
  95. package/lib/overlay-menu/custom-elements.md +19 -19
  96. package/lib/overlay-menu/index.d.ts +13 -11
  97. package/lib/overlay-menu/index.js +13 -11
  98. package/lib/password-field/custom-elements.json +62 -67
  99. package/lib/password-field/custom-elements.md +19 -11
  100. package/lib/password-field/index.d.ts +42 -94
  101. package/lib/password-field/index.js +48 -194
  102. package/lib/pill/custom-elements.json +4 -2
  103. package/lib/pill/custom-elements.md +1 -1
  104. package/lib/pill/index.d.ts +1 -1
  105. package/lib/pill/index.js +1 -1
  106. package/lib/radio-button/custom-elements.json +8 -6
  107. package/lib/radio-button/custom-elements.md +3 -3
  108. package/lib/radio-button/index.d.ts +6 -5
  109. package/lib/radio-button/index.js +5 -4
  110. package/lib/search-field/custom-elements.json +70 -74
  111. package/lib/search-field/custom-elements.md +24 -16
  112. package/lib/search-field/index.d.ts +43 -100
  113. package/lib/search-field/index.js +46 -215
  114. package/lib/select/custom-elements.json +3 -2
  115. package/lib/select/custom-elements.md +10 -10
  116. package/lib/select/index.d.ts +11 -3
  117. package/lib/select/index.js +65 -26
  118. package/lib/sidebar-layout/custom-elements.json +2 -6
  119. package/lib/sidebar-layout/custom-elements.md +5 -6
  120. package/lib/sidebar-layout/index.d.ts +2 -1
  121. package/lib/slider/custom-elements.json +2 -2
  122. package/lib/slider/custom-elements.md +1 -1
  123. package/lib/slider/index.d.ts +1 -1
  124. package/lib/slider/index.js +1 -1
  125. package/lib/sparkline/custom-elements.json +4 -4
  126. package/lib/sparkline/custom-elements.md +2 -2
  127. package/lib/sparkline/index.d.ts +3 -1
  128. package/lib/sparkline/index.js +2 -0
  129. package/lib/swing-gauge/custom-elements.json +5 -3
  130. package/lib/swing-gauge/custom-elements.md +11 -11
  131. package/lib/swing-gauge/index.d.ts +3 -1
  132. package/lib/swing-gauge/index.js +3 -1
  133. package/lib/text-field/custom-elements.json +76 -87
  134. package/lib/text-field/custom-elements.md +24 -26
  135. package/lib/text-field/index.d.ts +50 -92
  136. package/lib/text-field/index.js +81 -230
  137. package/lib/time-picker/custom-elements.md +3 -3
  138. package/lib/time-picker/index.d.ts +3 -0
  139. package/lib/time-picker/index.js +3 -0
  140. package/lib/toggle/custom-elements.json +4 -2
  141. package/lib/toggle/custom-elements.md +1 -1
  142. package/lib/toggle/index.d.ts +2 -1
  143. package/lib/toggle/index.js +1 -0
  144. package/lib/tree/custom-elements.json +2 -1
  145. package/lib/tree/custom-elements.md +1 -1
  146. package/lib/tree/elements/tree.d.ts +1 -0
  147. package/lib/tree/elements/tree.js +1 -0
  148. package/lib/tree/themes/halo/dark/index.js +1 -1
  149. package/lib/tree/themes/halo/light/index.js +1 -1
  150. package/lib/tree/themes/solar/charcoal/index.js +1 -1
  151. package/lib/tree/themes/solar/pearl/index.js +1 -1
  152. package/lib/tree-select/custom-elements.json +8 -4
  153. package/lib/tree-select/custom-elements.md +3 -3
  154. package/lib/tree-select/index.d.ts +5 -3
  155. package/lib/tree-select/index.js +3 -2
  156. package/lib/tree-select/themes/halo/dark/index.js +1 -1
  157. package/lib/tree-select/themes/halo/light/index.js +1 -1
  158. package/lib/tree-select/themes/solar/charcoal/index.js +1 -1
  159. package/lib/tree-select/themes/solar/pearl/index.js +1 -1
  160. package/lib/version.js +1 -1
  161. package/package.json +10 -10
@@ -21,6 +21,7 @@ export declare class Counter extends BasicElement {
21
21
  /**
22
22
  * The value of counter as string number
23
23
  * @param value counter value
24
+ * @default -
24
25
  */
25
26
  set value(value: string);
26
27
  /**
@@ -32,6 +33,7 @@ export declare class Counter extends BasicElement {
32
33
  * Set maximum counter value.
33
34
  * This value will be displayed with suffix `+` if count value is larger than max.
34
35
  * @param value counter value
36
+ * @default -
35
37
  */
36
38
  set max(value: string);
37
39
  /**
@@ -30,6 +30,7 @@ let Counter = class Counter extends BasicElement {
30
30
  /**
31
31
  * The value of counter as string number
32
32
  * @param value counter value
33
+ * @default -
33
34
  */
34
35
  set value(value) {
35
36
  value = this.validateValue(value, 'value');
@@ -50,6 +51,7 @@ let Counter = class Counter extends BasicElement {
50
51
  * Set maximum counter value.
51
52
  * This value will be displayed with suffix `+` if count value is larger than max.
52
53
  * @param value counter value
54
+ * @default -
53
55
  */
54
56
  set max(value) {
55
57
  value = this.validateValue(value, 'max');
@@ -8,12 +8,14 @@
8
8
  {
9
9
  "name": "min",
10
10
  "description": "Set minimum date",
11
- "type": "string"
11
+ "type": "string",
12
+ "default": "\"\""
12
13
  },
13
14
  {
14
15
  "name": "max",
15
16
  "description": "Set maximum date",
16
- "type": "string"
17
+ "type": "string",
18
+ "default": "\"\""
17
19
  },
18
20
  {
19
21
  "name": "weekdays-only",
@@ -41,12 +43,14 @@
41
43
  {
42
44
  "name": "value",
43
45
  "description": "Current date time value",
44
- "type": "string"
46
+ "type": "string",
47
+ "default": "\"\""
45
48
  },
46
49
  {
47
50
  "name": "values",
48
51
  "description": "Set multiple selected values",
49
- "type": "string[]"
52
+ "type": "string[]",
53
+ "default": "[]"
50
54
  },
51
55
  {
52
56
  "name": "am-pm",
@@ -63,7 +67,8 @@
63
67
  {
64
68
  "name": "placeholder",
65
69
  "description": "Placeholder to display when no value is set",
66
- "type": "string"
70
+ "type": "string",
71
+ "default": "\"\""
67
72
  },
68
73
  {
69
74
  "name": "opened",
@@ -104,7 +109,8 @@
104
109
  {
105
110
  "name": "format",
106
111
  "description": "Set the datetime format\nBased on dane-fns datetime formats",
107
- "type": "string"
112
+ "type": "string",
113
+ "default": "\"\""
108
114
  },
109
115
  {
110
116
  "name": "timepicker",
@@ -120,7 +126,8 @@
120
126
  {
121
127
  "name": "view",
122
128
  "description": "Set the current calendar view.\nAccepted format: 'yyyy-MM'",
123
- "type": "string"
129
+ "type": "string",
130
+ "default": "\"\""
124
131
  },
125
132
  {
126
133
  "name": "readonly",
@@ -140,13 +147,15 @@
140
147
  "name": "min",
141
148
  "attribute": "min",
142
149
  "description": "Set minimum date",
143
- "type": "string"
150
+ "type": "string",
151
+ "default": "\"\""
144
152
  },
145
153
  {
146
154
  "name": "max",
147
155
  "attribute": "max",
148
156
  "description": "Set maximum date",
149
- "type": "string"
157
+ "type": "string",
158
+ "default": "\"\""
150
159
  },
151
160
  {
152
161
  "name": "weekdaysOnly",
@@ -180,21 +189,19 @@
180
189
  "type": "boolean",
181
190
  "default": "false"
182
191
  },
183
- {
184
- "name": "multiple",
185
- "type": "boolean"
186
- },
187
192
  {
188
193
  "name": "value",
189
194
  "attribute": "value",
190
195
  "description": "Current date time value",
191
- "type": "string"
196
+ "type": "string",
197
+ "default": "\"\""
192
198
  },
193
199
  {
194
200
  "name": "values",
195
201
  "attribute": "values",
196
202
  "description": "Set multiple selected values",
197
- "type": "string[]"
203
+ "type": "string[]",
204
+ "default": "[]"
198
205
  },
199
206
  {
200
207
  "name": "amPm",
@@ -214,7 +221,8 @@
214
221
  "name": "placeholder",
215
222
  "attribute": "placeholder",
216
223
  "description": "Placeholder to display when no value is set",
217
- "type": "string"
224
+ "type": "string",
225
+ "default": "\"\""
218
226
  },
219
227
  {
220
228
  "name": "opened",
@@ -262,7 +270,8 @@
262
270
  "name": "format",
263
271
  "attribute": "format",
264
272
  "description": "Set the datetime format\nBased on dane-fns datetime formats",
265
- "type": "string"
273
+ "type": "string",
274
+ "default": "\"\""
266
275
  },
267
276
  {
268
277
  "name": "timepicker",
@@ -281,12 +290,14 @@
281
290
  "name": "view",
282
291
  "attribute": "view",
283
292
  "description": "Set the current calendar view.\nAccepted format: 'yyyy-MM'",
284
- "type": "string"
293
+ "type": "string",
294
+ "default": "\"\""
285
295
  },
286
296
  {
287
297
  "name": "views",
288
298
  "description": "Set the current calendar views for duplex mode\nAccepted format: 'yyyy-MM'",
289
- "type": "string[]"
299
+ "type": "string[]",
300
+ "default": "[]"
290
301
  },
291
302
  {
292
303
  "name": "readonly",
@@ -321,6 +332,24 @@
321
332
  "description": "Dispatched when internal view changes"
322
333
  }
323
334
  ],
335
+ "slots": [
336
+ {
337
+ "name": "header",
338
+ "description": "Slot to add custom contents at the top of popup"
339
+ },
340
+ {
341
+ "name": "right",
342
+ "description": "Slot to add custom contents at the right of popup"
343
+ },
344
+ {
345
+ "name": "footer",
346
+ "description": "Slot to add custom contents at the bottom of popup"
347
+ },
348
+ {
349
+ "name": "left",
350
+ "description": "Slot to add custom contents at the left of popup"
351
+ }
352
+ ],
324
353
  "methods": [
325
354
  {
326
355
  "name": "validateInput",
@@ -4,34 +4,33 @@ Control to pick date and time
4
4
 
5
5
  ## Properties
6
6
 
7
- | Property | Attribute | Modifiers | Type | Default | Description |
8
- |------------------------|--------------------------|-----------|----------------------------------|---------|--------------------------------------------------|
9
- | `amPm` | `am-pm` | | `boolean` | false | Toggles 12hr time display |
10
- | `disabled` | `disabled` | | `boolean` | false | Set disabled state |
11
- | `duplex` | `duplex` | | `"" \| "consecutive" \| "split"` | null | Display two calendar pickers. |
12
- | `error` | `error` | | `boolean` | false | Set state to error |
13
- | `filter` | | | `DatetimePickerFilter \| null` | null | Custom filter, used for enabling/disabling certain dates |
14
- | `firstDayOfWeek` | `first-day-of-week` | | `number \| undefined` | | Set the first day of the week.<br />0 - for Sunday, 6 - for Saturday |
15
- | `format` | `format` | | `string` | | Set the datetime format<br />Based on dane-fns datetime formats |
16
- | `inputDisabled` | `input-disabled` | | `boolean` | false | Disable input part of the picker |
17
- | `inputTriggerDisabled` | `input-trigger-disabled` | | `boolean` | false | Only open picker panel when calendar icon is clicked.<br />Clicking on the input will no longer open the picker. |
18
- | `max` | `max` | | `string` | | Set maximum date |
19
- | `min` | `min` | | `string` | | Set minimum date |
20
- | `multiple` | | readonly | `boolean` | | |
21
- | `opened` | `opened` | | `boolean` | false | Toggles the opened state of the list |
22
- | `placeholder` | `placeholder` | | `string` | | Placeholder to display when no value is set |
23
- | `popupDisabled` | `popup-disabled` | | `boolean` | false | Disable the popup |
24
- | `range` | `range` | | `boolean` | false | Set to switch to range select mode |
25
- | `readonly` | `readonly` | | `boolean` | false | Set readonly state |
26
- | `showSeconds` | `show-seconds` | | `boolean` | false | Flag to show seconds time segment in display.<br />Seconds are automatically shown when `hh:mm:ss` time format is provided as a value. |
27
- | `timepicker` | `timepicker` | | `boolean` | false | Toggle to display the time picker |
28
- | `value` | `value` | | `string` | | Current date time value |
29
- | `values` | `values` | | `string[]` | | Set multiple selected values |
30
- | `view` | `view` | | `string` | | Set the current calendar view.<br />Accepted format: 'yyyy-MM' |
31
- | `views` | | | `string[]` | | Set the current calendar views for duplex mode<br />Accepted format: 'yyyy-MM' |
32
- | `warning` | `warning` | | `boolean` | false | Set state to warning |
33
- | `weekdaysOnly` | `weekdays-only` | | `boolean` | false | Only enable weekdays |
34
- | `weekendsOnly` | `weekends-only` | | `boolean` | false | Only enable weekends |
7
+ | Property | Attribute | Type | Default | Description |
8
+ |------------------------|--------------------------|----------------------------------|---------|--------------------------------------------------|
9
+ | `amPm` | `am-pm` | `boolean` | false | Toggles 12hr time display |
10
+ | `disabled` | `disabled` | `boolean` | false | Set disabled state |
11
+ | `duplex` | `duplex` | `"" \| "consecutive" \| "split"` | null | Display two calendar pickers. |
12
+ | `error` | `error` | `boolean` | false | Set state to error |
13
+ | `filter` | | `DatetimePickerFilter \| null` | null | Custom filter, used for enabling/disabling certain dates |
14
+ | `firstDayOfWeek` | `first-day-of-week` | `number \| undefined` | | Set the first day of the week.<br />0 - for Sunday, 6 - for Saturday |
15
+ | `format` | `format` | `string` | "" | Set the datetime format<br />Based on dane-fns datetime formats |
16
+ | `inputDisabled` | `input-disabled` | `boolean` | false | Disable input part of the picker |
17
+ | `inputTriggerDisabled` | `input-trigger-disabled` | `boolean` | false | Only open picker panel when calendar icon is clicked.<br />Clicking on the input will no longer open the picker. |
18
+ | `max` | `max` | `string` | "" | Set maximum date |
19
+ | `min` | `min` | `string` | "" | Set minimum date |
20
+ | `opened` | `opened` | `boolean` | false | Toggles the opened state of the list |
21
+ | `placeholder` | `placeholder` | `string` | "" | Placeholder to display when no value is set |
22
+ | `popupDisabled` | `popup-disabled` | `boolean` | false | Disable the popup |
23
+ | `range` | `range` | `boolean` | false | Set to switch to range select mode |
24
+ | `readonly` | `readonly` | `boolean` | false | Set readonly state |
25
+ | `showSeconds` | `show-seconds` | `boolean` | false | Flag to show seconds time segment in display.<br />Seconds are automatically shown when `hh:mm:ss` time format is provided as a value. |
26
+ | `timepicker` | `timepicker` | `boolean` | false | Toggle to display the time picker |
27
+ | `value` | `value` | `string` | "" | Current date time value |
28
+ | `values` | `values` | `string[]` | [] | Set multiple selected values |
29
+ | `view` | `view` | `string` | "" | Set the current calendar view.<br />Accepted format: 'yyyy-MM' |
30
+ | `views` | | `string[]` | [] | Set the current calendar views for duplex mode<br />Accepted format: 'yyyy-MM' |
31
+ | `warning` | `warning` | `boolean` | false | Set state to warning |
32
+ | `weekdaysOnly` | `weekdays-only` | `boolean` | false | Only enable weekdays |
33
+ | `weekendsOnly` | `weekends-only` | `boolean` | false | Only enable weekends |
35
34
 
36
35
  ## Methods
37
36
 
@@ -47,3 +46,12 @@ Control to pick date and time
47
46
  | `opened-changed` | Dispatched when when opened attribute changes internally |
48
47
  | `value-changed` | Dispatched when value changes |
49
48
  | `view-changed` | Dispatched when internal view changes |
49
+
50
+ ## Slots
51
+
52
+ | Name | Description |
53
+ |----------|--------------------------------------------------|
54
+ | `footer` | Slot to add custom contents at the bottom of popup |
55
+ | `header` | Slot to add custom contents at the top of popup |
56
+ | `left` | Slot to add custom contents at the left of popup |
57
+ | `right` | Slot to add custom contents at the right of popup |
@@ -22,10 +22,10 @@ export type { DatetimePickerFilter, DatetimePickerDuplex };
22
22
  * @attr {boolean} disabled - Set disabled state
23
23
  * @prop {boolean} [disabled=false] - Set disabled state
24
24
  *
25
- * @slots header - Header slot
26
- * @slots right - Right slot
27
- * @slots footer - Footer slot
28
- * @slots left - Left slot
25
+ * @slot header - Slot to add custom contents at the top of popup
26
+ * @slot right - Slot to add custom contents at the right of popup
27
+ * @slot footer - Slot to add custom contents at the bottom of popup
28
+ * @slot left - Slot to add custom contents at the left of popup
29
29
  */
30
30
  export declare class DatetimePicker extends ControlElement implements MultiValue {
31
31
  /**
@@ -50,6 +50,7 @@ export declare class DatetimePicker extends ControlElement implements MultiValue
50
50
  /**
51
51
  * Set minimum date
52
52
  * @param min date
53
+ * @default -
53
54
  */
54
55
  set min(min: string);
55
56
  get min(): string;
@@ -58,6 +59,7 @@ export declare class DatetimePicker extends ControlElement implements MultiValue
58
59
  /**
59
60
  * Set maximum date
60
61
  * @param max date
62
+ * @default -
61
63
  */
62
64
  set max(max: string);
63
65
  get max(): string;
@@ -90,10 +92,14 @@ export declare class DatetimePicker extends ControlElement implements MultiValue
90
92
  * @param multiple Multiple
91
93
  */
92
94
  set multiple(multiple: boolean);
95
+ /**
96
+ * @ignore
97
+ */
93
98
  get multiple(): boolean;
94
99
  /**
95
100
  * Current date time value
96
101
  * @param value Calendar value
102
+ * @default -
97
103
  */
98
104
  set value(value: string);
99
105
  get value(): string;
@@ -103,6 +109,7 @@ export declare class DatetimePicker extends ControlElement implements MultiValue
103
109
  * Set multiple selected values
104
110
  * @param values Values to set
105
111
  * @type {string[]}
112
+ * @default []
106
113
  */
107
114
  set values(values: string[]);
108
115
  get values(): string[];
@@ -119,6 +126,7 @@ export declare class DatetimePicker extends ControlElement implements MultiValue
119
126
  /**
120
127
  * Placeholder to display when no value is set
121
128
  * @param placeholder Placeholder
129
+ * @default -
122
130
  */
123
131
  set placeholder(placeholder: string);
124
132
  get placeholder(): string;
@@ -152,6 +160,7 @@ export declare class DatetimePicker extends ControlElement implements MultiValue
152
160
  * Set the datetime format
153
161
  * Based on dane-fns datetime formats
154
162
  * @param format Date format
163
+ * @default -
155
164
  */
156
165
  set format(format: string);
157
166
  get format(): string;
@@ -168,6 +177,7 @@ export declare class DatetimePicker extends ControlElement implements MultiValue
168
177
  * Set the current calendar view.
169
178
  * Accepted format: 'yyyy-MM'
170
179
  * @param view view date
180
+ * @default -
171
181
  */
172
182
  set view(view: string);
173
183
  get view(): string;
@@ -177,6 +187,7 @@ export declare class DatetimePicker extends ControlElement implements MultiValue
177
187
  * Accepted format: 'yyyy-MM'
178
188
  * @param views view dates
179
189
  * @type {string[]}
190
+ * @default []
180
191
  */
181
192
  set views(views: string[]);
182
193
  get views(): string[];
@@ -41,10 +41,10 @@ const INPUT_FORMAT = {
41
41
  * @attr {boolean} disabled - Set disabled state
42
42
  * @prop {boolean} [disabled=false] - Set disabled state
43
43
  *
44
- * @slots header - Header slot
45
- * @slots right - Right slot
46
- * @slots footer - Footer slot
47
- * @slots left - Left slot
44
+ * @slot header - Slot to add custom contents at the top of popup
45
+ * @slot right - Slot to add custom contents at the right of popup
46
+ * @slot footer - Slot to add custom contents at the bottom of popup
47
+ * @slot left - Slot to add custom contents at the left of popup
48
48
  */
49
49
  let DatetimePicker = class DatetimePicker extends ControlElement {
50
50
  constructor() {
@@ -182,6 +182,7 @@ let DatetimePicker = class DatetimePicker extends ControlElement {
182
182
  /**
183
183
  * Set minimum date
184
184
  * @param min date
185
+ * @default -
185
186
  */
186
187
  set min(min) {
187
188
  if (!this.isValidValue(min)) {
@@ -201,6 +202,7 @@ let DatetimePicker = class DatetimePicker extends ControlElement {
201
202
  /**
202
203
  * Set maximum date
203
204
  * @param max date
205
+ * @default -
204
206
  */
205
207
  set max(max) {
206
208
  if (!this.isValidValue(max)) {
@@ -226,12 +228,16 @@ let DatetimePicker = class DatetimePicker extends ControlElement {
226
228
  set multiple(multiple) {
227
229
  new WarningNotice('multiple is not currently supported').show();
228
230
  }
231
+ /**
232
+ * @ignore
233
+ */
229
234
  get multiple() {
230
235
  return false;
231
236
  }
232
237
  /**
233
238
  * Current date time value
234
239
  * @param value Calendar value
240
+ * @default -
235
241
  */
236
242
  set value(value) {
237
243
  this.values = value ? [value] : [];
@@ -243,6 +249,7 @@ let DatetimePicker = class DatetimePicker extends ControlElement {
243
249
  * Set multiple selected values
244
250
  * @param values Values to set
245
251
  * @type {string[]}
252
+ * @default []
246
253
  */
247
254
  set values(values) {
248
255
  const oldValues = this._values;
@@ -258,6 +265,7 @@ let DatetimePicker = class DatetimePicker extends ControlElement {
258
265
  /**
259
266
  * Placeholder to display when no value is set
260
267
  * @param placeholder Placeholder
268
+ * @default -
261
269
  */
262
270
  set placeholder(placeholder) {
263
271
  const oldPlaceholder = this._placeholder;
@@ -273,6 +281,7 @@ let DatetimePicker = class DatetimePicker extends ControlElement {
273
281
  * Set the datetime format
274
282
  * Based on dane-fns datetime formats
275
283
  * @param format Date format
284
+ * @default -
276
285
  */
277
286
  set format(format) {
278
287
  const oldFormat = this._format;
@@ -292,6 +301,7 @@ let DatetimePicker = class DatetimePicker extends ControlElement {
292
301
  * Set the current calendar view.
293
302
  * Accepted format: 'yyyy-MM'
294
303
  * @param view view date
304
+ * @default -
295
305
  */
296
306
  set view(view) {
297
307
  this.views = view ? [view] : [];
@@ -304,6 +314,7 @@ let DatetimePicker = class DatetimePicker extends ControlElement {
304
314
  * Accepted format: 'yyyy-MM'
305
315
  * @param views view dates
306
316
  * @type {string[]}
317
+ * @default []
307
318
  */
308
319
  set views(views) {
309
320
  const oldViews = this._views;
@@ -22,15 +22,32 @@
22
22
  "type": "boolean",
23
23
  "default": "false"
24
24
  },
25
+ {
26
+ "name": "no-cancel-on-esc-key",
27
+ "description": "Prevents dialog to close when user presses ESC key",
28
+ "type": "boolean",
29
+ "default": "false"
30
+ },
25
31
  {
26
32
  "name": "x",
27
33
  "description": "Set a specific x coordinate of dialog",
28
- "type": "string"
34
+ "type": "string | undefined"
29
35
  },
30
36
  {
31
37
  "name": "y",
32
38
  "description": "Set a specific y coordinate of dialog",
33
- "type": "string"
39
+ "type": "string | undefined"
40
+ },
41
+ {
42
+ "name": "full-screen",
43
+ "description": "Set dialog to full screen",
44
+ "type": "boolean",
45
+ "default": "false"
46
+ },
47
+ {
48
+ "name": "position-target",
49
+ "description": "Set position of dialog i.e. `top`, `right`, `left`, `bottom`, `center` or combination of theme e.g. `top right`.",
50
+ "type": "string | undefined"
34
51
  },
35
52
  {
36
53
  "name": "no-cancel-on-esc-key",
@@ -46,7 +63,7 @@
46
63
  {
47
64
  "name": "position-target",
48
65
  "description": "Set position of dialog i.e. `top`, `right`, `left`, `bottom`, `center` or combination of theme e.g. `top right`.",
49
- "type": "string"
66
+ "type": "string | undefined"
50
67
  }
51
68
  ],
52
69
  "properties": [
@@ -66,7 +83,8 @@
66
83
  {
67
84
  "name": "noCancelOnOutsideClick",
68
85
  "description": "Prevents dialog to close when user clicks outside the dialog.",
69
- "type": "boolean"
86
+ "type": "boolean",
87
+ "default": "true"
70
88
  },
71
89
  {
72
90
  "name": "opened",
@@ -77,6 +95,7 @@
77
95
  },
78
96
  {
79
97
  "name": "noCancelOnEscKey",
98
+ "attribute": "no-cancel-on-esc-key",
80
99
  "description": "Prevents dialog to close when user presses ESC key",
81
100
  "type": "boolean",
82
101
  "default": "false"
@@ -85,23 +104,26 @@
85
104
  "name": "x",
86
105
  "attribute": "x",
87
106
  "description": "Set a specific x coordinate of dialog",
88
- "type": "string"
107
+ "type": "string | undefined"
89
108
  },
90
109
  {
91
110
  "name": "y",
92
111
  "attribute": "y",
93
112
  "description": "Set a specific y coordinate of dialog",
94
- "type": "string"
113
+ "type": "string | undefined"
95
114
  },
96
115
  {
97
116
  "name": "fullScreen",
117
+ "attribute": "full-screen",
98
118
  "description": "Set dialog to full screen",
99
- "type": "boolean"
119
+ "type": "boolean",
120
+ "default": "false"
100
121
  },
101
122
  {
102
123
  "name": "positionTarget",
124
+ "attribute": "position-target",
103
125
  "description": "Set position of dialog i.e. `top`, `right`, `left`, `bottom`, `center` or combination of theme e.g. `top right`.",
104
- "type": "string"
126
+ "type": "string | undefined"
105
127
  }
106
128
  ],
107
129
  "events": [
@@ -6,25 +6,25 @@ and also allows custom footers and control buttons to be used.
6
6
 
7
7
  ## Attributes
8
8
 
9
- | Attribute | Type | Default | Description |
10
- |------------------------|-----------|---------|--------------------------------------------------|
11
- | `full-screen` | `boolean` | | Set dialog to full screen |
12
- | `no-cancel-on-esc-key` | `boolean` | false | Prevents dialog to close when user presses ESC key |
13
- | `position-target` | `string` | | Set position of dialog i.e. `top`, `right`, `left`, `bottom`, `center` or combination of theme e.g. `top right`. |
9
+ | Attribute | Type | Default | Description |
10
+ |------------------------|-----------------------|---------|--------------------------------------------------|
11
+ | `full-screen` | `boolean` | | Set dialog to full screen |
12
+ | `no-cancel-on-esc-key` | `boolean` | false | Prevents dialog to close when user presses ESC key |
13
+ | `position-target` | `string \| undefined` | | Set position of dialog i.e. `top`, `right`, `left`, `bottom`, `center` or combination of theme e.g. `top right`. |
14
14
 
15
15
  ## Properties
16
16
 
17
- | Property | Attribute | Type | Default | Description |
18
- |--------------------------|-------------|------------------|---------|--------------------------------------------------|
19
- | `draggable` | `draggable` | `boolean` | false | Should the dialog be draggable |
20
- | `fullScreen` | | `boolean` | | Set dialog to full screen |
21
- | `header` | `header` | `string \| null` | null | Set Header/Title of the dialog |
22
- | `noCancelOnEscKey` | | `boolean` | false | Prevents dialog to close when user presses ESC key |
23
- | `noCancelOnOutsideClick` | | `boolean` | | Prevents dialog to close when user clicks outside the dialog. |
24
- | `opened` | `opened` | `boolean` | false | Set dialog to open |
25
- | `positionTarget` | | `string` | | Set position of dialog i.e. `top`, `right`, `left`, `bottom`, `center` or combination of theme e.g. `top right`. |
26
- | `x` | `x` | `string` | | Set a specific x coordinate of dialog |
27
- | `y` | `y` | `string` | | Set a specific y coordinate of dialog |
17
+ | Property | Attribute | Type | Default | Description |
18
+ |--------------------------|------------------------|-----------------------|---------|--------------------------------------------------|
19
+ | `draggable` | `draggable` | `boolean` | false | Should the dialog be draggable |
20
+ | `fullScreen` | `full-screen` | `boolean` | false | Set dialog to full screen |
21
+ | `header` | `header` | `string \| null` | null | Set Header/Title of the dialog |
22
+ | `noCancelOnEscKey` | `no-cancel-on-esc-key` | `boolean` | false | Prevents dialog to close when user presses ESC key |
23
+ | `noCancelOnOutsideClick` | | `boolean` | true | Prevents dialog to close when user clicks outside the dialog. |
24
+ | `opened` | `opened` | `boolean` | false | Set dialog to open |
25
+ | `positionTarget` | `position-target` | `string \| undefined` | | Set position of dialog i.e. `top`, `right`, `left`, `bottom`, `center` or combination of theme e.g. `top right`. |
26
+ | `x` | `x` | `string \| undefined` | | Set a specific x coordinate of dialog |
27
+ | `y` | `y` | `string \| undefined` | | Set a specific y coordinate of dialog |
28
28
 
29
29
  ## Methods
30
30
 
@@ -20,17 +20,17 @@ import '@refinitiv-ui/phrasebook/lib/locale/en/dialog.js';
20
20
  * @attr {boolean} [no-cancel-on-esc-key=false] - Prevents dialog to close when user presses ESC key
21
21
  * @prop {boolean} [noCancelOnEscKey=false] - Prevents dialog to close when user presses ESC key
22
22
  *
23
- * @attr {string} x - Set a specific x coordinate of dialog
24
- * @prop {string} x - Set a specific x coordinate of dialog
23
+ * @attr {string | undefined} x - Set a specific x coordinate of dialog
24
+ * @prop {string | undefined} x - Set a specific x coordinate of dialog
25
25
  *
26
- * @attr {string} y - Set a specific y coordinate of dialog
27
- * @prop {string} y - Set a specific y coordinate of dialog
26
+ * @attr {string | undefined} y - Set a specific y coordinate of dialog
27
+ * @prop {string | undefined} y - Set a specific y coordinate of dialog
28
28
  *
29
29
  * @attr {boolean} full-screen - Set dialog to full screen
30
- * @prop {boolean} fullScreen - Set dialog to full screen
30
+ * @prop {boolean} [fullScreen=false] - Set dialog to full screen
31
31
  *
32
- * @attr {string} position-target - Set position of dialog i.e. `top`, `right`, `left`, `bottom`, `center` or combination of theme e.g. `top right`.
33
- * @prop {string} positionTarget - Set position of dialog i.e. `top`, `right`, `left`, `bottom`, `center` or combination of theme e.g. `top right`.
32
+ * @attr {string | undefined} position-target - Set position of dialog i.e. `top`, `right`, `left`, `bottom`, `center` or combination of theme e.g. `top right`.
33
+ * @prop {string | undefined} positionTarget - Set position of dialog i.e. `top`, `right`, `left`, `bottom`, `center` or combination of theme e.g. `top right`.
34
34
  *
35
35
  * @fires opened-changed - Fired when value of `opened` property is changed. Prevent default to stop default action
36
36
  * @fires confirm - Fired when dialog is closed by user clicked a default OK button. Prevent default to stop default action
@@ -79,9 +79,6 @@ export declare class Dialog extends Overlay {
79
79
  * Footer Element
80
80
  */
81
81
  private footerElement;
82
- /**
83
- * @ignore
84
- */
85
82
  noCancelOnOutsideClick: boolean;
86
83
  /**
87
84
  * @ignore