@refinitiv-ui/elements 7.6.1 → 7.7.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 (123) hide show
  1. package/CHANGELOG.md +17 -0
  2. package/lib/accordion/custom-elements.json +2 -2
  3. package/lib/accordion/custom-elements.md +2 -2
  4. package/lib/accordion/index.d.ts +2 -2
  5. package/lib/accordion/index.js +2 -2
  6. package/lib/appstate-bar/custom-elements.json +2 -2
  7. package/lib/appstate-bar/custom-elements.md +4 -4
  8. package/lib/appstate-bar/index.d.ts +1 -1
  9. package/lib/appstate-bar/index.js +1 -1
  10. package/lib/autosuggest/custom-elements.json +14 -9
  11. package/lib/autosuggest/custom-elements.md +15 -15
  12. package/lib/autosuggest/index.d.ts +9 -4
  13. package/lib/autosuggest/index.js +9 -4
  14. package/lib/button/custom-elements.json +6 -6
  15. package/lib/button/custom-elements.md +3 -3
  16. package/lib/button/index.d.ts +3 -4
  17. package/lib/button/index.js +3 -4
  18. package/lib/chart/custom-elements.json +1 -9
  19. package/lib/chart/custom-elements.md +8 -8
  20. package/lib/chart/elements/chart.d.ts +3 -3
  21. package/lib/chart/elements/chart.js +4 -4
  22. package/lib/checkbox/custom-elements.json +2 -2
  23. package/lib/checkbox/custom-elements.md +6 -6
  24. package/lib/checkbox/index.d.ts +1 -1
  25. package/lib/checkbox/index.js +1 -1
  26. package/lib/clock/custom-elements.json +6 -17
  27. package/lib/clock/custom-elements.md +1 -7
  28. package/lib/clock/index.d.ts +4 -2
  29. package/lib/clock/index.js +4 -2
  30. package/lib/collapse/custom-elements.json +2 -2
  31. package/lib/collapse/custom-elements.md +2 -2
  32. package/lib/collapse/index.d.ts +2 -2
  33. package/lib/collapse/index.js +2 -2
  34. package/lib/color-dialog/custom-elements.json +36 -6
  35. package/lib/color-dialog/custom-elements.md +24 -22
  36. package/lib/color-dialog/index.d.ts +3 -2
  37. package/lib/color-dialog/index.js +3 -2
  38. package/lib/combo-box/custom-elements.json +10 -21
  39. package/lib/combo-box/custom-elements.md +3 -4
  40. package/lib/combo-box/index.d.ts +4 -6
  41. package/lib/combo-box/index.js +4 -6
  42. package/lib/configuration/custom-elements.json +11 -1
  43. package/lib/configuration/custom-elements.md +3 -3
  44. package/lib/configuration/elements/configuration.d.ts +3 -0
  45. package/lib/configuration/elements/configuration.js +3 -0
  46. package/lib/counter/custom-elements.json +1 -1
  47. package/lib/counter/custom-elements.md +1 -1
  48. package/lib/counter/index.d.ts +1 -1
  49. package/lib/counter/index.js +1 -1
  50. package/lib/datetime-picker/custom-elements.json +5 -5
  51. package/lib/datetime-picker/custom-elements.md +3 -3
  52. package/lib/datetime-picker/index.d.ts +3 -3
  53. package/lib/datetime-picker/index.js +3 -3
  54. package/lib/header/custom-elements.json +2 -2
  55. package/lib/header/custom-elements.md +2 -2
  56. package/lib/header/index.d.ts +2 -2
  57. package/lib/header/index.js +2 -2
  58. package/lib/heatmap/custom-elements.json +1 -1
  59. package/lib/heatmap/custom-elements.md +3 -3
  60. package/lib/heatmap/index.d.ts +2 -2
  61. package/lib/heatmap/index.js +2 -2
  62. package/lib/interactive-chart/custom-elements.md +3 -3
  63. package/lib/interactive-chart/index.d.ts +1 -1
  64. package/lib/interactive-chart/index.js +1 -1
  65. package/lib/item/custom-elements.json +2 -1
  66. package/lib/item/custom-elements.md +1 -1
  67. package/lib/item/helpers/types.d.ts +4 -0
  68. package/lib/item/index.d.ts +1 -0
  69. package/lib/item/index.js +1 -0
  70. package/lib/label/custom-elements.json +4 -4
  71. package/lib/label/custom-elements.md +2 -2
  72. package/lib/label/index.d.ts +2 -2
  73. package/lib/label/index.js +2 -2
  74. package/lib/list/custom-elements.md +8 -8
  75. package/lib/list/elements/list.d.ts +1 -1
  76. package/lib/list/elements/list.js +1 -1
  77. package/lib/multi-input/custom-elements.json +4 -4
  78. package/lib/multi-input/custom-elements.md +2 -2
  79. package/lib/multi-input/index.d.ts +2 -2
  80. package/lib/multi-input/index.js +2 -2
  81. package/lib/number-field/index.d.ts +27 -0
  82. package/lib/number-field/index.js +37 -7
  83. package/lib/overlay/custom-elements.json +10 -6
  84. package/lib/overlay/custom-elements.md +29 -29
  85. package/lib/overlay/elements/overlay.d.ts +6 -0
  86. package/lib/overlay/elements/overlay.js +6 -0
  87. package/lib/overlay-menu/custom-elements.json +4 -2
  88. package/lib/overlay-menu/custom-elements.md +1 -1
  89. package/lib/overlay-menu/index.d.ts +1 -1
  90. package/lib/overlay-menu/index.js +1 -1
  91. package/lib/pagination/custom-elements.json +12 -8
  92. package/lib/pagination/custom-elements.md +5 -5
  93. package/lib/pagination/index.d.ts +4 -2
  94. package/lib/pagination/index.js +4 -2
  95. package/lib/password-field/index.d.ts +23 -1
  96. package/lib/password-field/index.js +45 -3
  97. package/lib/pill/custom-elements.json +2 -2
  98. package/lib/pill/custom-elements.md +8 -8
  99. package/lib/pill/index.d.ts +1 -1
  100. package/lib/pill/index.js +1 -1
  101. package/lib/select/custom-elements.json +5 -5
  102. package/lib/select/custom-elements.md +10 -10
  103. package/lib/select/index.d.ts +3 -3
  104. package/lib/select/index.js +3 -3
  105. package/lib/slider/custom-elements.json +2 -2
  106. package/lib/slider/custom-elements.md +1 -1
  107. package/lib/slider/index.d.ts +1 -1
  108. package/lib/slider/index.js +1 -1
  109. package/lib/swing-gauge/custom-elements.json +8 -4
  110. package/lib/swing-gauge/custom-elements.md +2 -2
  111. package/lib/swing-gauge/index.d.ts +2 -0
  112. package/lib/swing-gauge/index.js +2 -0
  113. package/lib/time-picker/custom-elements.json +6 -4
  114. package/lib/time-picker/custom-elements.md +3 -3
  115. package/lib/time-picker/index.d.ts +4 -1
  116. package/lib/time-picker/index.js +4 -1
  117. package/lib/toggle/custom-elements.json +2 -2
  118. package/lib/toggle/custom-elements.md +7 -7
  119. package/lib/toggle/index.d.ts +1 -1
  120. package/lib/toggle/index.js +1 -1
  121. package/lib/tree/helpers/types.d.ts +4 -0
  122. package/lib/version.js +1 -1
  123. package/package.json +14 -14
@@ -4,12 +4,12 @@ Form control for selecting one or several options
4
4
 
5
5
  ## Properties
6
6
 
7
- | Property | Attribute | Type | Default | Description |
8
- |-----------------|-----------------|-----------|---------|----------------------------|
9
- | `checked` | `checked` | `boolean` | false | Value of checkbox |
10
- | `disabled` | `disabled` | `boolean` | false | Set disabled state |
11
- | `indeterminate` | `indeterminate` | `boolean` | false | Set state to indeterminate |
12
- | `readonly` | `readonly` | `boolean` | false | Set readonly state |
7
+ | Property | Attribute | Type | Default | Description |
8
+ |-----------------|-----------------|-----------|---------|-------------------------|
9
+ | `checked` | `checked` | `boolean` | false | Value of checkbox |
10
+ | `disabled` | `disabled` | `boolean` | false | Set disabled state |
11
+ | `indeterminate` | `indeterminate` | `boolean` | false | Set indeterminate state |
12
+ | `readonly` | `readonly` | `boolean` | false | Set readonly state |
13
13
 
14
14
  ## Events
15
15
 
@@ -30,7 +30,7 @@ export declare class Checkbox extends ControlElement {
30
30
  */
31
31
  checked: boolean;
32
32
  /**
33
- * Set state to indeterminate
33
+ * Set indeterminate state
34
34
  */
35
35
  indeterminate: boolean;
36
36
  /**
@@ -25,7 +25,7 @@ let Checkbox = class Checkbox extends ControlElement {
25
25
  */
26
26
  this.checked = false;
27
27
  /**
28
- * Set state to indeterminate
28
+ * Set indeterminate state
29
29
  */
30
30
  this.indeterminate = false;
31
31
  }
@@ -13,8 +13,9 @@
13
13
  },
14
14
  {
15
15
  "name": "offset",
16
- "description": "Get offset value",
17
- "type": "number"
16
+ "description": "number of seconds that the display time should be offset from the original value",
17
+ "type": "number",
18
+ "default": "\"0\""
18
19
  },
19
20
  {
20
21
  "name": "tick",
@@ -58,8 +59,9 @@
58
59
  {
59
60
  "name": "offset",
60
61
  "attribute": "offset",
61
- "description": "Get offset value",
62
- "type": "number"
62
+ "description": "number of seconds that the display time should be offset from the original value",
63
+ "type": "number",
64
+ "default": "\"0\""
63
65
  },
64
66
  {
65
67
  "name": "tick",
@@ -106,19 +108,6 @@
106
108
  "name": "offset-changed",
107
109
  "description": "Fired when the user offsets the clock in `interactive` mode. The event is not triggered if `offset` property is changed programmatically."
108
110
  }
109
- ],
110
- "methods": [
111
- {
112
- "name": "resizedCallback",
113
- "description": "Called when the element's dimension have changed",
114
- "params": [
115
- {
116
- "name": "size",
117
- "description": "Element size",
118
- "type": "ElementSize"
119
- }
120
- ]
121
- }
122
111
  ]
123
112
  }
124
113
  ]
@@ -9,17 +9,11 @@ Display hours, minutes and seconds as clock interface
9
9
  | `amPm` | `am-pm` | `boolean` | false | Display the digital clock in 12hr format. |
10
10
  | `analogue` | `analogue` | `boolean` | false | Display clock in analogue style. |
11
11
  | `interactive` | `interactive` | `boolean` | false | Enable interactive mode. Allowing the user to offset the value. |
12
- | `offset` | `offset` | `number` | | Get offset value |
12
+ | `offset` | `offset` | `number` | "0" | number of seconds that the display time should be offset from the original value |
13
13
  | `showSeconds` | `show-seconds` | `boolean` | false | Display the seconds segment. |
14
14
  | `tick` | `tick` | `boolean` | false | Toggles clock ticking function. |
15
15
  | `value` | `value` | `string` | "00:00:00" | Get time value in format `hh:mm:ss` |
16
16
 
17
- ## Methods
18
-
19
- | Method | Type | Description |
20
- |-------------------|---------------------|--------------------------------------------------|
21
- | `resizedCallback` | `(size: any): void` | Called when the element's dimension have changed<br /><br />**size**: Element size |
22
-
23
17
  ## Events
24
18
 
25
19
  | Event | Description |
@@ -66,12 +66,13 @@ export declare class Clock extends ResponsiveElement {
66
66
  set value(value: string);
67
67
  private _offset;
68
68
  /**
69
- * Get offset value
69
+ * number of seconds that the display time should be offset from the original value
70
+ * @default 0
70
71
  * @returns offset
71
72
  */
72
73
  get offset(): number;
73
74
  /**
74
- * Amount to offset value in seconds.
75
+ * Shifts displayed time by seconds without changing the original value
75
76
  * @param offset new offset value
76
77
  * @returns {void}
77
78
  */
@@ -286,6 +287,7 @@ export declare class Clock extends ResponsiveElement {
286
287
  /**
287
288
  * Called when the element's dimension have changed
288
289
  * @param size Element size
290
+ * @ignore
289
291
  * @returns {void}
290
292
  */
291
293
  resizedCallback(size: ElementSize): void;
@@ -153,14 +153,15 @@ let Clock = class Clock extends ResponsiveElement {
153
153
  }
154
154
  }
155
155
  /**
156
- * Get offset value
156
+ * number of seconds that the display time should be offset from the original value
157
+ * @default 0
157
158
  * @returns offset
158
159
  */
159
160
  get offset() {
160
161
  return this._offset;
161
162
  }
162
163
  /**
163
- * Amount to offset value in seconds.
164
+ * Shifts displayed time by seconds without changing the original value
164
165
  * @param offset new offset value
165
166
  * @returns {void}
166
167
  */
@@ -508,6 +509,7 @@ let Clock = class Clock extends ResponsiveElement {
508
509
  /**
509
510
  * Called when the element's dimension have changed
510
511
  * @param size Element size
512
+ * @ignore
511
513
  * @returns {void}
512
514
  */
513
515
  resizedCallback(size) {
@@ -69,11 +69,11 @@
69
69
  "slots": [
70
70
  {
71
71
  "name": "header-left",
72
- "description": "Slot to add custom contents to the left side of header e.g. ef-icon, ef-checkbox"
72
+ "description": "Slot to add custom contents to the left side of header"
73
73
  },
74
74
  {
75
75
  "name": "header-right",
76
- "description": "Slot to add custom contents to the right side of header e.g. ef-icon, ef-checkbox"
76
+ "description": "Slot to add custom contents to the right side of header"
77
77
  }
78
78
  ]
79
79
  }
@@ -23,5 +23,5 @@ for their primary displays.
23
23
 
24
24
  | Name | Description |
25
25
  |----------------|--------------------------------------------------|
26
- | `header-left` | Slot to add custom contents to the left side of header e.g. ef-icon, ef-checkbox |
27
- | `header-right` | Slot to add custom contents to the right side of header e.g. ef-icon, ef-checkbox |
26
+ | `header-left` | Slot to add custom contents to the left side of header |
27
+ | `header-right` | Slot to add custom contents to the right side of header |
@@ -10,8 +10,8 @@ import '../panel/index.js';
10
10
  *
11
11
  * @fires expanded-changed - Fired when the user expands or collapses the control. The event is not triggered if `expanded` property is changed programmatically.
12
12
  *
13
- * @slot header-left - Slot to add custom contents to the left side of header e.g. ef-icon, ef-checkbox
14
- * @slot header-right - Slot to add custom contents to the right side of header e.g. ef-icon, ef-checkbox
13
+ * @slot header-left - Slot to add custom contents to the left side of header
14
+ * @slot header-right - Slot to add custom contents to the right side of header
15
15
  */
16
16
  export declare class Collapse extends BasicElement {
17
17
  /**
@@ -15,8 +15,8 @@ import { VERSION } from '../version.js';
15
15
  *
16
16
  * @fires expanded-changed - Fired when the user expands or collapses the control. The event is not triggered if `expanded` property is changed programmatically.
17
17
  *
18
- * @slot header-left - Slot to add custom contents to the left side of header e.g. ef-icon, ef-checkbox
19
- * @slot header-right - Slot to add custom contents to the right side of header e.g. ef-icon, ef-checkbox
18
+ * @slot header-left - Slot to add custom contents to the left side of header
19
+ * @slot header-right - Slot to add custom contents to the right side of header
20
20
  */
21
21
  let Collapse = class Collapse extends BasicElement {
22
22
  constructor() {
@@ -73,6 +73,24 @@
73
73
  "description": "Set position of dialog i.e. `top`, `right`, `left`, `bottom`, `center` or combination of theme e.g. `top right`.",
74
74
  "type": "string | undefined"
75
75
  },
76
+ {
77
+ "name": "no-cancel-on-outside-click",
78
+ "description": "Prevents dialog to close when user clicks outside the dialog.",
79
+ "type": "boolean",
80
+ "default": "true"
81
+ },
82
+ {
83
+ "name": "with-backdrop",
84
+ "description": "False to hide backdrop.",
85
+ "type": "boolean",
86
+ "default": "true"
87
+ },
88
+ {
89
+ "name": "with-shadow",
90
+ "description": "False to remove shadow for dialog component.",
91
+ "type": "boolean",
92
+ "default": "true"
93
+ },
76
94
  {
77
95
  "name": "no-cancel-on-esc-key",
78
96
  "description": "Prevents dialog to close when user presses ESC key",
@@ -83,6 +101,21 @@
83
101
  "name": "position-target",
84
102
  "description": "Set position of dialog i.e. `top`, `right`, `left`, `bottom`, `center` or combination of theme e.g. `top right`.",
85
103
  "type": "string | undefined"
104
+ },
105
+ {
106
+ "name": "no-cancel-on-outside-click",
107
+ "description": "Prevents dialog to close when user clicks outside the dialog.",
108
+ "type": "boolean"
109
+ },
110
+ {
111
+ "name": "with-backdrop",
112
+ "description": "False to hide backdrop.",
113
+ "type": "boolean"
114
+ },
115
+ {
116
+ "name": "with-shadow",
117
+ "description": "False to remove shadow for dialog component.",
118
+ "type": "boolean"
86
119
  }
87
120
  ],
88
121
  "properties": [
@@ -168,24 +201,21 @@
168
201
  },
169
202
  {
170
203
  "name": "noCancelOnOutsideClick",
204
+ "attribute": "no-cancel-on-outside-click",
171
205
  "description": "Prevents dialog to close when user clicks outside the dialog.",
172
206
  "type": "boolean",
173
207
  "default": "true"
174
208
  },
175
209
  {
176
210
  "name": "withBackdrop",
211
+ "attribute": "with-backdrop",
177
212
  "description": "False to hide backdrop.",
178
213
  "type": "boolean",
179
214
  "default": "true"
180
215
  },
181
- {
182
- "name": "draggable",
183
- "description": "False to make the dialog not draggable.",
184
- "type": "boolean",
185
- "default": "true"
186
- },
187
216
  {
188
217
  "name": "withShadow",
218
+ "attribute": "with-shadow",
189
219
  "description": "False to remove shadow for dialog component.",
190
220
  "type": "boolean",
191
221
  "default": "true"
@@ -5,31 +5,33 @@ for selecting a predefined range of colours.
5
5
 
6
6
  ## Attributes
7
7
 
8
- | Attribute | Type | Default | Description |
9
- |------------------------|-----------------------|---------|--------------------------------------------------|
10
- | `no-cancel-on-esc-key` | `boolean` | false | Prevents dialog to close when user presses ESC key |
11
- | `position-target` | `string \| undefined` | | Set position of dialog i.e. `top`, `right`, `left`, `bottom`, `center` or combination of theme e.g. `top right`. |
8
+ | Attribute | Type | Default | Description |
9
+ |------------------------------|-----------------------|---------|--------------------------------------------------|
10
+ | `no-cancel-on-esc-key` | `boolean` | false | Prevents dialog to close when user presses ESC key |
11
+ | `no-cancel-on-outside-click` | `boolean` | | Prevents dialog to close when user clicks outside the dialog. |
12
+ | `position-target` | `string \| undefined` | | Set position of dialog i.e. `top`, `right`, `left`, `bottom`, `center` or combination of theme e.g. `top right`. |
13
+ | `with-backdrop` | `boolean` | | False to hide backdrop. |
14
+ | `with-shadow` | `boolean` | | False to remove shadow for dialog component. |
12
15
 
13
16
  ## Properties
14
17
 
15
- | Property | Attribute | Type | Default | Description |
16
- |--------------------------|------------------------|-----------------------|---------|--------------------------------------------------|
17
- | `allowNocolor` | `allow-nocolor` | `boolean` | false | Set the palettes to activate no-color option |
18
- | `blue` | `blue` | `string` | "" | Blue value from 0 to 255 |
19
- | `draggable` | | `boolean` | true | False to make the dialog not draggable. |
20
- | `green` | `green` | `string` | "" | Green value from 0 to 255 |
21
- | `header` | `header` | `string \| null` | null | Set Header/Title of the color dialog |
22
- | `hex` | `hex` | `string` | "" | Value of hex without # sign, supports both 3-digits shorthand hex and regular 6-digits hex |
23
- | `noCancelOnEscKey` | `no-cancel-on-esc-key` | `boolean` | false | Prevents dialog to close when user presses ESC key |
24
- | `noCancelOnOutsideClick` | | `boolean` | true | Prevents dialog to close when user clicks outside the dialog. |
25
- | `opened` | `opened` | `boolean` | false | Set dialog to open |
26
- | `positionTarget` | `position-target` | `string \| undefined` | | Set position of dialog i.e. `top`, `right`, `left`, `bottom`, `center` or combination of theme e.g. `top right`. |
27
- | `red` | `red` | `string` | "" | Red value from 0 to 255 |
28
- | `value` | `value` | `string` | "" | Value of selected color from color dialog will be written here as hex value<br />e.g. "#00f" or "#0000ff" |
29
- | `withBackdrop` | | `boolean` | true | False to hide backdrop. |
30
- | `withShadow` | | `boolean` | true | False to remove shadow for dialog component. |
31
- | `x` | `x` | `string \| undefined` | | Set a specific x coordinate of dialog |
32
- | `y` | `y` | `string \| undefined` | | Set a specific y coordinate of dialog |
18
+ | Property | Attribute | Type | Default | Description |
19
+ |--------------------------|------------------------------|-----------------------|---------|--------------------------------------------------|
20
+ | `allowNocolor` | `allow-nocolor` | `boolean` | false | Set the palettes to activate no-color option |
21
+ | `blue` | `blue` | `string` | "" | Blue value from 0 to 255 |
22
+ | `green` | `green` | `string` | "" | Green value from 0 to 255 |
23
+ | `header` | `header` | `string \| null` | null | Set Header/Title of the color dialog |
24
+ | `hex` | `hex` | `string` | "" | Value of hex without # sign, supports both 3-digits shorthand hex and regular 6-digits hex |
25
+ | `noCancelOnEscKey` | `no-cancel-on-esc-key` | `boolean` | false | Prevents dialog to close when user presses ESC key |
26
+ | `noCancelOnOutsideClick` | `no-cancel-on-outside-click` | `boolean` | true | Prevents dialog to close when user clicks outside the dialog. |
27
+ | `opened` | `opened` | `boolean` | false | Set dialog to open |
28
+ | `positionTarget` | `position-target` | `string \| undefined` | | Set position of dialog i.e. `top`, `right`, `left`, `bottom`, `center` or combination of theme e.g. `top right`. |
29
+ | `red` | `red` | `string` | "" | Red value from 0 to 255 |
30
+ | `value` | `value` | `string` | "" | Value of selected color from color dialog will be written here as hex value<br />e.g. "#00f" or "#0000ff" |
31
+ | `withBackdrop` | `with-backdrop` | `boolean` | true | False to hide backdrop. |
32
+ | `withShadow` | `with-shadow` | `boolean` | true | False to remove shadow for dialog component. |
33
+ | `x` | `x` | `string \| undefined` | | Set a specific x coordinate of dialog |
34
+ | `y` | `y` | `string \| undefined` | | Set a specific y coordinate of dialog |
33
35
 
34
36
  ## Events
35
37
 
@@ -33,12 +33,13 @@ import './elements/grayscale-palettes.js';
33
33
  * @attr {string | undefined} position-target - Set position of dialog i.e. `top`, `right`, `left`, `bottom`, `center` or combination of theme e.g. `top right`.
34
34
  * @prop {string | undefined} positionTarget - Set position of dialog i.e. `top`, `right`, `left`, `bottom`, `center` or combination of theme e.g. `top right`.
35
35
  *
36
+ * @attr {boolean} [no-cancel-on-outside-click] - Prevents dialog to close when user clicks outside the dialog.
36
37
  * @prop {boolean} [noCancelOnOutsideClick=true] - Prevents dialog to close when user clicks outside the dialog.
37
38
  *
39
+ * @attr {boolean} [with-backdrop] - False to hide backdrop.
38
40
  * @prop {boolean} [withBackdrop=true] - False to hide backdrop.
39
41
  *
40
- * @prop {boolean} [draggable=true] - False to make the dialog not draggable.
41
- *
42
+ * @attr {boolean} [with-shadow] - False to remove shadow for dialog component.
42
43
  * @prop {boolean} [withShadow=true] - False to remove shadow for dialog component.
43
44
  */
44
45
  export declare class ColorDialog extends Dialog {
@@ -40,12 +40,13 @@ import { ValueModel } from './helpers/value-model.js';
40
40
  * @attr {string | undefined} position-target - Set position of dialog i.e. `top`, `right`, `left`, `bottom`, `center` or combination of theme e.g. `top right`.
41
41
  * @prop {string | undefined} positionTarget - Set position of dialog i.e. `top`, `right`, `left`, `bottom`, `center` or combination of theme e.g. `top right`.
42
42
  *
43
+ * @attr {boolean} [no-cancel-on-outside-click] - Prevents dialog to close when user clicks outside the dialog.
43
44
  * @prop {boolean} [noCancelOnOutsideClick=true] - Prevents dialog to close when user clicks outside the dialog.
44
45
  *
46
+ * @attr {boolean} [with-backdrop] - False to hide backdrop.
45
47
  * @prop {boolean} [withBackdrop=true] - False to hide backdrop.
46
48
  *
47
- * @prop {boolean} [draggable=true] - False to make the dialog not draggable.
48
- *
49
+ * @attr {boolean} [with-shadow] - False to remove shadow for dialog component.
49
50
  * @prop {boolean} [withShadow=true] - False to remove shadow for dialog component.
50
51
  */
51
52
  let ColorDialog = class ColorDialog extends Dialog {
@@ -37,20 +37,21 @@
37
37
  },
38
38
  {
39
39
  "name": "error",
40
- "description": "Set state to error",
40
+ "description": "Set error state",
41
41
  "type": "boolean",
42
42
  "default": "false"
43
43
  },
44
44
  {
45
45
  "name": "warning",
46
- "description": "Set state to warning",
46
+ "description": "Set warning state",
47
47
  "type": "boolean",
48
48
  "default": "false"
49
49
  },
50
50
  {
51
51
  "name": "query-debounce-rate",
52
- "description": "Control query rate, defaults to 0",
53
- "type": "number"
52
+ "description": "Control query rate in milliseconds",
53
+ "type": "number",
54
+ "default": "\"0\""
54
55
  },
55
56
  {
56
57
  "name": "value",
@@ -69,12 +70,6 @@
69
70
  "description": "Set disabled state",
70
71
  "type": "boolean",
71
72
  "default": "false"
72
- },
73
- {
74
- "name": "name",
75
- "description": "Set name of the element",
76
- "type": "string",
77
- "default": "\"\""
78
73
  }
79
74
  ],
80
75
  "properties": [
@@ -128,22 +123,23 @@
128
123
  {
129
124
  "name": "error",
130
125
  "attribute": "error",
131
- "description": "Set state to error",
126
+ "description": "Set error state",
132
127
  "type": "boolean",
133
128
  "default": "false"
134
129
  },
135
130
  {
136
131
  "name": "warning",
137
132
  "attribute": "warning",
138
- "description": "Set state to warning",
133
+ "description": "Set warning state",
139
134
  "type": "boolean",
140
135
  "default": "false"
141
136
  },
142
137
  {
143
138
  "name": "queryDebounceRate",
144
139
  "attribute": "query-debounce-rate",
145
- "description": "Control query rate, defaults to 0",
146
- "type": "number"
140
+ "description": "Control query rate in milliseconds",
141
+ "type": "number",
142
+ "default": "\"0\""
147
143
  },
148
144
  {
149
145
  "name": "data",
@@ -188,13 +184,6 @@
188
184
  "description": "Set disabled state",
189
185
  "type": "boolean",
190
186
  "default": "false"
191
- },
192
- {
193
- "name": "name",
194
- "attribute": "name",
195
- "description": "Set name of the element",
196
- "type": "string",
197
- "default": "\"\""
198
187
  }
199
188
  ],
200
189
  "events": [
@@ -9,21 +9,20 @@ Combines a popup with a filterable selection list
9
9
  | `clears` | `clears` | `boolean` | false | Show clears button |
10
10
  | `data` | | `ComboBoxData<T>` | [] | Data array to be displayed |
11
11
  | `disabled` | `disabled` | `boolean` | false | Set disabled state |
12
- | `error` | `error` | `boolean` | false | Set state to error |
12
+ | `error` | `error` | `boolean` | false | Set error state |
13
13
  | `filter` | | `ComboBoxFilter<T> \| null` | "defaultFilter<T>(this)" | Custom filter for static data<br />Set this to null when data is filtered externally, eg XHR |
14
14
  | `freeText` | `free-text` | `boolean` | false | Allow to enter any value |
15
15
  | `label (readonly)` | | `string` | "" | Label of selected value |
16
16
  | `multiple` | `multiple` | `boolean` | false | Multiple selection mode |
17
- | `name` | `name` | `string` | "" | Set name of the element |
18
17
  | `opened` | `opened` | `boolean` | false | Track opened state of popup |
19
18
  | `placeholder` | `placeholder` | `string` | "" | Placeholder for input field |
20
19
  | `query` | | `string \| null` | null | Query string applied to combo-box<br />Set via internal input |
21
- | `queryDebounceRate` | `query-debounce-rate` | `number` | | Control query rate, defaults to 0 |
20
+ | `queryDebounceRate` | `query-debounce-rate` | `number` | "0" | Control query rate in milliseconds |
22
21
  | `readonly` | `readonly` | `boolean` | false | Set readonly state |
23
22
  | `renderer` | | `ComboBoxRenderer` | "new ComboBoxRenderer(this)" | Renderer used to render list item elements |
24
23
  | `value` | `value` | `string` | "" | Returns the first selected item value.<br />Use `values` when multiple selection mode is enabled. |
25
24
  | `values` | | `string[]` | [] | Returns a values collection of the currently<br />selected item values |
26
- | `warning` | `warning` | `boolean` | false | Set state to warning |
25
+ | `warning` | `warning` | `boolean` | false | Set warning state |
27
26
 
28
27
  ## Events
29
28
 
@@ -25,9 +25,6 @@ export { ComboBoxRenderer };
25
25
  * @attr {boolean} disabled - Set disabled state
26
26
  * @prop {boolean} [disabled=false] - Set disabled state
27
27
  *
28
- * @attr {string} name - Set name of the element
29
- * @prop {string} [name=''] - Set name of the element
30
- *
31
28
  * @fires value-changed - Fired when the user commits a value change. The event is not triggered if `value` property is changed programmatically.
32
29
  * @fires query-changed - Fired when the user changes value in the input to change a query word. If `query-debounce-rate` is set, this event will be triggered after debounce completion. The event is not triggered if `query` property is changed programmatically.
33
30
  * @fires opened-changed - Fired when the user opens or closes control's popup. The event is not triggered if `opened` property is changed programmatically.
@@ -85,17 +82,18 @@ export declare class ComboBox<T extends DataItem = ItemData> extends FormFieldEl
85
82
  set freeText(freeText: boolean);
86
83
  get freeText(): boolean;
87
84
  /**
88
- * Set state to error
85
+ * Set error state
89
86
  */
90
87
  error: boolean;
91
88
  /**
92
- * Set state to warning
89
+ * Set warning state
93
90
  */
94
91
  warning: boolean;
95
92
  private _queryDebounceRate;
96
93
  private queryDebouncer;
97
94
  /**
98
- * Control query rate, defaults to 0
95
+ * Control query rate in milliseconds
96
+ * @default 0
99
97
  */
100
98
  get queryDebounceRate(): number;
101
99
  set queryDebounceRate(value: number);
@@ -38,9 +38,6 @@ const freeTextMultipleWarning = new WarningNotice('"free-text" mode is not compa
38
38
  * @attr {boolean} disabled - Set disabled state
39
39
  * @prop {boolean} [disabled=false] - Set disabled state
40
40
  *
41
- * @attr {string} name - Set name of the element
42
- * @prop {string} [name=''] - Set name of the element
43
- *
44
41
  * @fires value-changed - Fired when the user commits a value change. The event is not triggered if `value` property is changed programmatically.
45
42
  * @fires query-changed - Fired when the user changes value in the input to change a query word. If `query-debounce-rate` is set, this event will be triggered after debounce completion. The event is not triggered if `query` property is changed programmatically.
46
43
  * @fires opened-changed - Fired when the user opens or closes control's popup. The event is not triggered if `opened` property is changed programmatically.
@@ -74,11 +71,11 @@ let ComboBox = class ComboBox extends FormFieldElement {
74
71
  this.clears = false;
75
72
  this._freeText = false;
76
73
  /**
77
- * Set state to error
74
+ * Set error state
78
75
  */
79
76
  this.error = false;
80
77
  /**
81
- * Set state to warning
78
+ * Set warning state
82
79
  */
83
80
  this.warning = false;
84
81
  // Internal reference to debounce rate
@@ -202,7 +199,8 @@ let ComboBox = class ComboBox extends FormFieldElement {
202
199
  return this._freeText;
203
200
  }
204
201
  /**
205
- * Control query rate, defaults to 0
202
+ * Control query rate in milliseconds
203
+ * @default 0
206
204
  */
207
205
  get queryDebounceRate() {
208
206
  return this._queryDebounceRate;
@@ -3,11 +3,21 @@
3
3
  "tags": [
4
4
  {
5
5
  "name": "ef-configuration",
6
+ "attributes": [
7
+ {
8
+ "name": "-",
9
+ "description": "Configuration data",
10
+ "type": "Config",
11
+ "default": "\"{icon: { map: {} }}\""
12
+ }
13
+ ],
6
14
  "properties": [
7
15
  {
8
16
  "name": "config",
17
+ "attribute": "-",
9
18
  "description": "Configuration data",
10
- "default": "\"DEFAULT_CONFIG\""
19
+ "type": "Config",
20
+ "default": "\"{icon: { map: {} }}\""
11
21
  }
12
22
  ]
13
23
  }
@@ -2,6 +2,6 @@
2
2
 
3
3
  ## Properties
4
4
 
5
- | Property | Default | Description |
6
- |----------|------------------|--------------------|
7
- | `config` | "DEFAULT_CONFIG" | Configuration data |
5
+ | Property | Attribute | Type | Default | Description |
6
+ |----------|-----------|----------|-----------------------|--------------------|
7
+ | `config` | `-` | `Config` | "{icon: { map: {} }}" | Configuration data |
@@ -14,6 +14,9 @@ export declare class Configuration extends BasicElement {
14
14
  protected createRenderRoot(): this;
15
15
  /**
16
16
  * Configuration data
17
+ * @type {Config}
18
+ * @attr -
19
+ * @default {icon: { map: {} }}
17
20
  */
18
21
  config: Config;
19
22
  /**
@@ -10,6 +10,9 @@ let Configuration = class Configuration extends BasicElement {
10
10
  super(...arguments);
11
11
  /**
12
12
  * Configuration data
13
+ * @type {Config}
14
+ * @attr -
15
+ * @default {icon: { map: {} }}
13
16
  */
14
17
  this.config = DEFAULT_CONFIG;
15
18
  }
@@ -3,7 +3,7 @@
3
3
  "tags": [
4
4
  {
5
5
  "name": "ef-counter",
6
- "description": "Counter is an item count badge,\nsupport maximun display number and notation of large numbers.",
6
+ "description": "Counter is an item count badge,\nsupport maximum display number and notation of large numbers.",
7
7
  "attributes": [
8
8
  {
9
9
  "name": "value",
@@ -1,7 +1,7 @@
1
1
  # ef-counter
2
2
 
3
3
  Counter is an item count badge,
4
- support maximun display number and notation of large numbers.
4
+ support maximum display number and notation of large numbers.
5
5
 
6
6
  ## Properties
7
7