@momentum-design/components 0.76.0 → 0.76.2

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 (28) hide show
  1. package/dist/browser/index.js +140 -128
  2. package/dist/browser/index.js.map +2 -2
  3. package/dist/components/checkbox/checkbox.component.d.ts +1 -1
  4. package/dist/components/checkbox/checkbox.component.js +3 -3
  5. package/dist/components/formfieldwrapper/formfieldwrapper.component.d.ts +4 -5
  6. package/dist/components/formfieldwrapper/formfieldwrapper.component.js +11 -15
  7. package/dist/components/formfieldwrapper/formfieldwrapper.styles.js +4 -0
  8. package/dist/components/input/input.component.js +2 -2
  9. package/dist/components/listitem/listitem.component.d.ts +27 -0
  10. package/dist/components/listitem/listitem.component.js +40 -2
  11. package/dist/components/menuitem/menuitem.component.js +8 -2
  12. package/dist/components/progressspinner/progressspinner.component.js +1 -1
  13. package/dist/components/radio/radio.component.js +3 -3
  14. package/dist/components/radio/radio.styles.js +1 -1
  15. package/dist/components/radiogroup/radiogroup.component.js +2 -2
  16. package/dist/components/searchfield/searchfield.component.js +1 -1
  17. package/dist/components/select/select.component.d.ts +5 -2
  18. package/dist/components/select/select.component.js +7 -4
  19. package/dist/components/textarea/textarea.component.d.ts +1 -1
  20. package/dist/components/textarea/textarea.component.js +3 -3
  21. package/dist/components/toggle/toggle.component.d.ts +3 -1
  22. package/dist/components/toggle/toggle.component.js +5 -3
  23. package/dist/custom-elements.json +807 -703
  24. package/dist/react/index.d.ts +2 -2
  25. package/dist/react/index.js +2 -2
  26. package/dist/react/textarea/index.d.ts +1 -1
  27. package/dist/react/textarea/index.js +1 -1
  28. package/package.json +1 -1
@@ -4,754 +4,754 @@
4
4
  "modules": [
5
5
  {
6
6
  "kind": "javascript-module",
7
- "path": "components/appheader/appheader.component.js",
7
+ "path": "components/alertchip/alertchip.component.js",
8
8
  "declarations": [
9
9
  {
10
10
  "kind": "class",
11
- "description": "The `mdc-appheader` component provides a structured and accessible app header layout.\nIt consists of three primary sections: leading, center, and trailing.\n\n- The **leading section** typically holds a **brand logo**, **brand name** or **menu icon**.\n- The **center section** can contain a **search bar**, **icons** or action controls.\n- The **trailing section** generally includes a **profile avatar**, **additional icons** or **action controls**.",
12
- "name": "Appheader",
13
- "cssParts": [
11
+ "description": "mdc-alertchip component is an interactive chip that consumers can use to represent an alert.\n\n- It supports a leading icon along with label.\n- It supports 5 variants of alerts - neutral, warning, error, success, and informational\n\nThis component is built by extending Buttonsimple.",
12
+ "name": "AlertChip",
13
+ "cssProperties": [
14
14
  {
15
- "description": "The main container for styling the header.",
16
- "name": "container"
15
+ "description": "The color of the label text",
16
+ "name": "--mdc-chip-color"
17
17
  },
18
18
  {
19
- "description": "The leading section of the header.",
20
- "name": "leading-section"
19
+ "description": "The color of the icon",
20
+ "name": "--mdc-chip-icon-color"
21
21
  },
22
22
  {
23
- "description": "The center section of the header.",
24
- "name": "center-section"
23
+ "description": "The border color of the alertchip",
24
+ "name": "--mdc-chip-border-color"
25
25
  },
26
26
  {
27
- "description": "The trailing section of the header.",
28
- "name": "trailing-section"
27
+ "description": "The background color of the alertchip",
28
+ "name": "--mdc-chip-background-color"
29
29
  }
30
30
  ],
31
- "slots": [
32
- {
33
- "description": "Slot for the leading section (e.g., brand logo, brand name).",
34
- "name": "leading"
35
- },
31
+ "members": [
36
32
  {
37
- "description": "Slot for the center section (e.g., search bar, icons).",
38
- "name": "center"
33
+ "kind": "field",
34
+ "name": "variant",
35
+ "type": {
36
+ "text": "VariantType"
37
+ },
38
+ "description": "The variant of the alertchip. It supports 5 variants\n- neutral\n- warning\n- error\n- success\n- informational",
39
+ "default": "neutral",
40
+ "attribute": "variant"
39
41
  },
40
- {
41
- "description": "Slot for the trailing section (e.g., profile avatar, icons).",
42
- "name": "trailing"
43
- }
44
- ],
45
- "members": [],
46
- "superclass": {
47
- "name": "Component",
48
- "module": "/src/models"
49
- },
50
- "tagName": "mdc-appheader",
51
- "jsDoc": "/**\n * The `mdc-appheader` component provides a structured and accessible app header layout.\n * It consists of three primary sections: leading, center, and trailing.\n *\n * - The **leading section** typically holds a **brand logo**, **brand name** or **menu icon**.\n * - The **center section** can contain a **search bar**, **icons** or action controls.\n * - The **trailing section** generally includes a **profile avatar**, **additional icons** or **action controls**.\n *\n * @tagname mdc-appheader\n *\n * @slot leading - Slot for the leading section (e.g., brand logo, brand name).\n * @slot center - Slot for the center section (e.g., search bar, icons).\n * @slot trailing - Slot for the trailing section (e.g., profile avatar, icons).\n *\n * @csspart container - The main container for styling the header.\n * @csspart leading-section - The leading section of the header.\n * @csspart center-section - The center section of the header.\n * @csspart trailing-section - The trailing section of the header.\n */",
52
- "customElement": true
53
- }
54
- ],
55
- "exports": [
56
- {
57
- "kind": "js",
58
- "name": "default",
59
- "declaration": {
60
- "name": "Appheader",
61
- "module": "components/appheader/appheader.component.js"
62
- }
63
- }
64
- ]
65
- },
66
- {
67
- "kind": "javascript-module",
68
- "path": "components/animation/animation.component.js",
69
- "declarations": [
70
- {
71
- "kind": "class",
72
- "description": "The `mdc-animation` component is a wrapper around the Lottie animation library.\nIt fetches the animation data dynamically based on the provided name and renders it.\nThis is a display only component that does not have any interactive functionality.\nFrom accessibility perspective, (by default) it is a decorative image component.",
73
- "name": "Animation",
74
- "members": [
75
42
  {
76
43
  "kind": "field",
77
- "name": "name",
44
+ "name": "label",
78
45
  "type": {
79
- "text": "AnimationNames | undefined"
46
+ "text": "string"
80
47
  },
81
- "description": "Name of the animation (= filename)",
82
- "attribute": "name",
83
- "reflects": true
48
+ "default": "''",
49
+ "description": "The visible label text of the alertchip.\n\nWe recommend limiting the <b>maximum length of the label text to 20 characters</b>,\nincluding empty spaces to split words.",
50
+ "attribute": "label"
84
51
  },
85
52
  {
86
53
  "kind": "field",
87
- "name": "loop",
54
+ "name": "tabIndex",
88
55
  "type": {
89
- "text": "LoopType | undefined"
56
+ "text": "number"
90
57
  },
91
- "description": "How many times to loop the animation\n- \"true\" - infinite\n- \"false\" - no loop\n- number - number of times to loop",
92
- "attribute": "loop",
93
- "reflects": true
58
+ "default": "0",
59
+ "description": "This property specifies the tab order of the element.",
60
+ "attribute": "tabIndex",
61
+ "reflects": true,
62
+ "inheritedFrom": {
63
+ "name": "TabIndexMixin",
64
+ "module": "utils/mixins/TabIndexMixin.js"
65
+ }
94
66
  },
95
67
  {
96
68
  "kind": "field",
97
- "name": "autoplay",
69
+ "name": "disabled",
98
70
  "type": {
99
71
  "text": "boolean | undefined"
100
72
  },
101
- "description": "Weather start the animation automatically",
102
- "attribute": "autoplay",
103
- "reflects": true
73
+ "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
74
+ "default": "undefined",
75
+ "attribute": "disabled",
76
+ "reflects": true,
77
+ "inheritedFrom": {
78
+ "name": "DisabledMixin",
79
+ "module": "utils/mixins/DisabledMixin.js"
80
+ }
104
81
  },
105
82
  {
106
83
  "kind": "field",
107
- "name": "ariaLabel",
84
+ "name": "active",
108
85
  "type": {
109
- "text": "string | null"
86
+ "text": "boolean | undefined"
110
87
  },
111
- "default": "null",
112
- "description": "Aria-label attribute to be set for accessibility",
113
- "attribute": "aria-label"
88
+ "description": "The button's active state indicates whether it is currently toggled on (active) or off (inactive).\nWhen the active state is true, the button is considered to be in an active state, meaning it is toggled on.\nConversely, when the active state is false, the button is in an inactive state, indicating it is toggled off.\n\nThis attribute is used to set the provided `ariaStateKey` to true or false.",
89
+ "default": "undefined",
90
+ "attribute": "active",
91
+ "reflects": true,
92
+ "inheritedFrom": {
93
+ "name": "Buttonsimple",
94
+ "module": "components/buttonsimple/buttonsimple.component.js"
95
+ }
114
96
  },
115
97
  {
116
98
  "kind": "field",
117
- "name": "ariaLabelledBy",
99
+ "name": "softDisabled",
118
100
  "type": {
119
- "text": "string | null"
101
+ "text": "boolean | undefined"
120
102
  },
121
- "default": "null",
122
- "description": "Aria-labelledby attribute to be set for accessibility",
123
- "attribute": "aria-labelledby"
103
+ "description": "Indicates whether the button is soft disabled.\nWhen set to `true`, the button appears visually disabled but still allows\nfocus, click, and keyboard actions to be passed through.\n\n**Important:** When using soft disabled, consumers must ensure that\nthe button behaves like a disabled button, allowing only focus and\npreventing any interactions (clicks or keyboard actions) from triggering unintended actions.",
104
+ "default": "undefined",
105
+ "attribute": "soft-disabled",
106
+ "reflects": true,
107
+ "inheritedFrom": {
108
+ "name": "Buttonsimple",
109
+ "module": "components/buttonsimple/buttonsimple.component.js"
110
+ }
124
111
  },
125
112
  {
126
113
  "kind": "field",
127
- "name": "lottieInstance",
114
+ "name": "size",
128
115
  "type": {
129
- "text": "AnimationItem | undefined"
116
+ "text": "ButtonSize"
130
117
  },
131
- "privacy": "private",
132
- "description": "Lottie animation instance"
118
+ "description": "Simplebutton size is a super set of all the sizes supported by children components.",
119
+ "default": "32",
120
+ "attribute": "size",
121
+ "reflects": true,
122
+ "inheritedFrom": {
123
+ "name": "Buttonsimple",
124
+ "module": "components/buttonsimple/buttonsimple.component.js"
125
+ }
133
126
  },
134
127
  {
135
128
  "kind": "field",
136
- "name": "containerRef",
129
+ "name": "role",
130
+ "description": "This property defines the ARIA role for the element. By default, it is set to 'button'.\nConsumers should override this role when:\n- The element is being used in a context where a different role is more appropriate.\n- Custom behaviors are implemented that require a specific ARIA role for accessibility purposes.",
131
+ "default": "button",
132
+ "attribute": "role",
133
+ "reflects": true,
134
+ "inheritedFrom": {
135
+ "name": "Buttonsimple",
136
+ "module": "components/buttonsimple/buttonsimple.component.js"
137
+ }
138
+ },
139
+ {
140
+ "kind": "field",
141
+ "name": "ariaStateKey",
137
142
  "type": {
138
- "text": "Ref<HTMLDivElement>"
143
+ "text": "string | undefined"
139
144
  },
140
- "privacy": "private",
141
- "description": "Container for the animation"
145
+ "description": "This property defines the ARIA state key, which will be toggled when the\nButton is set to `active`.\nThe default value is 'aria-pressed', which is commonly used for toggle buttons.\n\nConsumers can override this property to use a different ARIA state key if needed.\nIn case multiple aria attributes should be toggled, they can be passed in as\na comma separated string.\nFor example: `aria-pressed,aria-expanded`",
146
+ "default": "'aria-pressed' (when)",
147
+ "attribute": "ariaStateKey",
148
+ "reflects": true,
149
+ "inheritedFrom": {
150
+ "name": "Buttonsimple",
151
+ "module": "components/buttonsimple/buttonsimple.component.js"
152
+ }
142
153
  },
143
154
  {
144
155
  "kind": "field",
145
- "name": "animation",
146
- "description": "Exposed API of the animation library (lottie)",
147
- "readonly": true
156
+ "name": "type",
157
+ "type": {
158
+ "text": "ButtonType"
159
+ },
160
+ "description": "This property defines the type attribute for the button element.\nThe type attribute specifies the behavior of the button when it is clicked.\n- **submit**: The button submits the form data to the server.\n- **reset**: The button resets the form data to its initial state.\n- **button**: The button does nothing when clicked.",
161
+ "default": "button",
162
+ "attribute": "type",
163
+ "reflects": true,
164
+ "inheritedFrom": {
165
+ "name": "Buttonsimple",
166
+ "module": "components/buttonsimple/buttonsimple.component.js"
167
+ }
148
168
  },
149
169
  {
150
170
  "kind": "method",
151
- "name": "getLoopValue",
152
- "privacy": "private"
171
+ "name": "executeAction",
172
+ "privacy": "protected",
173
+ "inheritedFrom": {
174
+ "name": "Buttonsimple",
175
+ "module": "components/buttonsimple/buttonsimple.component.js"
176
+ }
153
177
  },
154
178
  {
155
179
  "kind": "method",
156
- "name": "onLoadSuccessHandler",
157
- "privacy": "private",
180
+ "name": "setActive",
181
+ "privacy": "protected",
158
182
  "parameters": [
159
183
  {
160
- "name": "animationData",
184
+ "name": "element",
161
185
  "type": {
162
- "text": "any"
163
- }
186
+ "text": "HTMLElement"
187
+ },
188
+ "description": "The button element"
189
+ },
190
+ {
191
+ "name": "active",
192
+ "optional": true,
193
+ "type": {
194
+ "text": "boolean"
195
+ },
196
+ "description": "The active state of the element"
164
197
  }
165
198
  ],
166
- "description": "Create new lotty instance for the loaded data"
199
+ "description": "Sets the ariaStateKey attributes based on the active state of the button.",
200
+ "inheritedFrom": {
201
+ "name": "Buttonsimple",
202
+ "module": "components/buttonsimple/buttonsimple.component.js"
203
+ }
167
204
  },
168
205
  {
169
206
  "kind": "method",
170
- "name": "onLoadFailHandler",
207
+ "name": "setSoftDisabled",
171
208
  "privacy": "private",
172
209
  "parameters": [
173
210
  {
174
- "name": "error",
211
+ "name": "element",
175
212
  "type": {
176
- "text": "Error"
177
- }
213
+ "text": "HTMLElement"
214
+ },
215
+ "description": "The button element."
216
+ },
217
+ {
218
+ "name": "softDisabled",
219
+ "optional": true,
220
+ "type": {
221
+ "text": "boolean"
222
+ },
223
+ "description": "The soft-disabled state."
178
224
  }
179
225
  ],
180
- "description": "Error handler for animation loading"
226
+ "description": "Sets the soft-disabled attribute for the button.\nWhen soft-disabled, the button looks to be disabled but remains focusable and clickable.\nAlso sets/removes aria-disabled attribute.",
227
+ "inheritedFrom": {
228
+ "name": "Buttonsimple",
229
+ "module": "components/buttonsimple/buttonsimple.component.js"
230
+ }
181
231
  },
182
232
  {
183
233
  "kind": "method",
184
- "name": "getAnimationData",
234
+ "name": "setDisabled",
185
235
  "privacy": "private",
186
- "description": "Import animation data dynamically"
187
- },
188
- {
189
- "kind": "field",
190
- "name": "onCompleteHandler",
191
- "description": "Re-dispatch the complete event from the animation library\n\nThis handler called with the animation instance instead of the component instance\nso we need to bind it to the component instance. The arrow function just does that."
192
- }
193
- ],
194
- "events": [
195
- {
196
- "name": "load",
197
- "type": {
198
- "text": "CustomEvent"
199
- },
200
- "description": "(React: onLoad) This event is dispatched when the animation is loaded",
201
- "reactName": "onLoad"
202
- },
203
- {
204
- "description": "(React: onComplete) This event is dispatched when all animation loops completed",
205
- "name": "complete",
206
- "reactName": "onComplete"
207
- },
208
- {
209
- "description": "(React: onError) This event is dispatched when animation loading failed",
210
- "name": "error",
211
- "reactName": "onError"
212
- }
213
- ],
214
- "attributes": [
215
- {
216
- "name": "name",
217
- "type": {
218
- "text": "AnimationNames | undefined"
219
- },
220
- "description": "Name of the animation (= filename)",
221
- "fieldName": "name"
222
- },
223
- {
224
- "name": "loop",
225
- "type": {
226
- "text": "LoopType | undefined"
227
- },
228
- "description": "How many times to loop the animation\n- \"true\" - infinite\n- \"false\" - no loop\n- number - number of times to loop",
229
- "fieldName": "loop"
230
- },
231
- {
232
- "name": "autoplay",
233
- "type": {
234
- "text": "boolean | undefined"
235
- },
236
- "description": "Weather start the animation automatically",
237
- "fieldName": "autoplay"
238
- },
239
- {
240
- "name": "aria-label",
241
- "type": {
242
- "text": "string | null"
243
- },
244
- "default": "null",
245
- "description": "Aria-label attribute to be set for accessibility",
246
- "fieldName": "ariaLabel"
236
+ "parameters": [
237
+ {
238
+ "name": "element",
239
+ "type": {
240
+ "text": "HTMLElement"
241
+ },
242
+ "description": "The button element."
243
+ },
244
+ {
245
+ "name": "disabled",
246
+ "type": {
247
+ "text": "boolean"
248
+ },
249
+ "description": "The disabled state."
250
+ }
251
+ ],
252
+ "description": "Sets the disabled attribute for the button.\nWhen disabled, the button is not focusable or clickable, and tabindex is set to -1.\nThe previous tabindex is stored and restored when enabled.\nAlso sets/removes aria-disabled attribute.",
253
+ "inheritedFrom": {
254
+ "name": "Buttonsimple",
255
+ "module": "components/buttonsimple/buttonsimple.component.js"
256
+ }
247
257
  },
248
258
  {
249
- "name": "aria-labelledby",
250
- "type": {
251
- "text": "string | null"
252
- },
253
- "default": "null",
254
- "description": "Aria-labelledby attribute to be set for accessibility",
255
- "fieldName": "ariaLabelledBy"
256
- }
257
- ],
258
- "superclass": {
259
- "name": "Component",
260
- "module": "/src/models"
261
- },
262
- "tagName": "mdc-animation",
263
- "jsDoc": "/**\n * The `mdc-animation` component is a wrapper around the Lottie animation library.\n * It fetches the animation data dynamically based on the provided name and renders it.\n * This is a display only component that does not have any interactive functionality.\n * From accessibility perspective, (by default) it is a decorative image component.\n *\n * @tagname mdc-animation\n *\n * @event load - (React: onLoad) This event is dispatched when the animation is loaded\n * @event complete - (React: onComplete) This event is dispatched when all animation loops completed\n * @event error - (React: onError) This event is dispatched when animation loading failed\n */",
264
- "customElement": true
265
- }
266
- ],
267
- "exports": [
268
- {
269
- "kind": "js",
270
- "name": "default",
271
- "declaration": {
272
- "name": "Animation",
273
- "module": "components/animation/animation.component.js"
274
- }
275
- }
276
- ]
277
- },
278
- {
279
- "kind": "javascript-module",
280
- "path": "components/alertchip/alertchip.component.js",
281
- "declarations": [
282
- {
283
- "kind": "class",
284
- "description": "mdc-alertchip component is an interactive chip that consumers can use to represent an alert.\n\n- It supports a leading icon along with label.\n- It supports 5 variants of alerts - neutral, warning, error, success, and informational\n\nThis component is built by extending Buttonsimple.",
285
- "name": "AlertChip",
286
- "cssProperties": [
287
- {
288
- "description": "The color of the label text",
289
- "name": "--mdc-chip-color"
259
+ "kind": "method",
260
+ "name": "triggerClickEvent",
261
+ "privacy": "private",
262
+ "inheritedFrom": {
263
+ "name": "Buttonsimple",
264
+ "module": "components/buttonsimple/buttonsimple.component.js"
265
+ }
290
266
  },
291
267
  {
292
- "description": "The color of the icon",
293
- "name": "--mdc-chip-icon-color"
268
+ "kind": "method",
269
+ "name": "handleBlur",
270
+ "privacy": "private",
271
+ "description": "In case the button is pressed and the focus is lost while pressing,\nthe pressed class is removed.",
272
+ "inheritedFrom": {
273
+ "name": "Buttonsimple",
274
+ "module": "components/buttonsimple/buttonsimple.component.js"
275
+ }
294
276
  },
295
277
  {
296
- "description": "The border color of the alertchip",
297
- "name": "--mdc-chip-border-color"
278
+ "kind": "method",
279
+ "name": "handleKeyDown",
280
+ "privacy": "private",
281
+ "parameters": [
282
+ {
283
+ "name": "event",
284
+ "type": {
285
+ "text": "KeyboardEvent"
286
+ },
287
+ "description": "The keyboard event."
288
+ }
289
+ ],
290
+ "description": "Handles the keydown event on the button.\nIf the key is 'Enter' or 'Space', the button is pressed.\nIf the key is 'Enter', the button is pressed. The native HTML button works in the same way.\nIf the key is 'Space', the button's default is prevent to avoid scrolling etc in the host application.",
291
+ "inheritedFrom": {
292
+ "name": "Buttonsimple",
293
+ "module": "components/buttonsimple/buttonsimple.component.js"
294
+ }
298
295
  },
299
296
  {
300
- "description": "The background color of the alertchip",
301
- "name": "--mdc-chip-background-color"
297
+ "kind": "method",
298
+ "name": "handleKeyUp",
299
+ "privacy": "private",
300
+ "parameters": [
301
+ {
302
+ "name": "event",
303
+ "type": {
304
+ "text": "KeyboardEvent"
305
+ },
306
+ "description": "The keyboard event."
307
+ }
308
+ ],
309
+ "description": "Handles the keyup event on the button.\nIf the key is 'Enter' or 'Space', the button is clicked.\nIf the key is 'Space', the button is pressed. The native HTML button works in the same way.",
310
+ "inheritedFrom": {
311
+ "name": "Buttonsimple",
312
+ "module": "components/buttonsimple/buttonsimple.component.js"
313
+ }
302
314
  }
303
315
  ],
304
- "members": [
316
+ "attributes": [
305
317
  {
306
- "kind": "field",
307
318
  "name": "variant",
308
319
  "type": {
309
320
  "text": "VariantType"
310
321
  },
311
322
  "description": "The variant of the alertchip. It supports 5 variants\n- neutral\n- warning\n- error\n- success\n- informational",
312
323
  "default": "neutral",
313
- "attribute": "variant"
324
+ "fieldName": "variant"
314
325
  },
315
326
  {
316
- "kind": "field",
317
327
  "name": "label",
318
328
  "type": {
319
329
  "text": "string"
320
330
  },
321
331
  "default": "''",
322
332
  "description": "The visible label text of the alertchip.\n\nWe recommend limiting the <b>maximum length of the label text to 20 characters</b>,\nincluding empty spaces to split words.",
323
- "attribute": "label"
333
+ "fieldName": "label"
324
334
  },
325
335
  {
326
- "kind": "field",
327
336
  "name": "tabIndex",
328
337
  "type": {
329
338
  "text": "number"
330
339
  },
331
340
  "default": "0",
332
341
  "description": "This property specifies the tab order of the element.",
333
- "attribute": "tabIndex",
334
- "reflects": true,
342
+ "fieldName": "tabIndex",
335
343
  "inheritedFrom": {
336
344
  "name": "TabIndexMixin",
337
- "module": "utils/mixins/TabIndexMixin.js"
345
+ "module": "src/utils/mixins/TabIndexMixin.ts"
338
346
  }
339
347
  },
340
348
  {
341
- "kind": "field",
342
349
  "name": "disabled",
343
350
  "type": {
344
351
  "text": "boolean | undefined"
345
352
  },
346
353
  "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
347
354
  "default": "undefined",
348
- "attribute": "disabled",
349
- "reflects": true,
355
+ "fieldName": "disabled",
350
356
  "inheritedFrom": {
351
357
  "name": "DisabledMixin",
352
- "module": "utils/mixins/DisabledMixin.js"
358
+ "module": "src/utils/mixins/DisabledMixin.ts"
353
359
  }
354
360
  },
355
361
  {
356
- "kind": "field",
357
362
  "name": "active",
358
363
  "type": {
359
364
  "text": "boolean | undefined"
360
365
  },
361
366
  "description": "The button's active state indicates whether it is currently toggled on (active) or off (inactive).\nWhen the active state is true, the button is considered to be in an active state, meaning it is toggled on.\nConversely, when the active state is false, the button is in an inactive state, indicating it is toggled off.\n\nThis attribute is used to set the provided `ariaStateKey` to true or false.",
362
367
  "default": "undefined",
363
- "attribute": "active",
364
- "reflects": true,
368
+ "fieldName": "active",
365
369
  "inheritedFrom": {
366
370
  "name": "Buttonsimple",
367
- "module": "components/buttonsimple/buttonsimple.component.js"
371
+ "module": "src/components/buttonsimple/buttonsimple.component.ts"
368
372
  }
369
373
  },
370
374
  {
371
- "kind": "field",
372
- "name": "softDisabled",
375
+ "name": "soft-disabled",
373
376
  "type": {
374
377
  "text": "boolean | undefined"
375
378
  },
376
379
  "description": "Indicates whether the button is soft disabled.\nWhen set to `true`, the button appears visually disabled but still allows\nfocus, click, and keyboard actions to be passed through.\n\n**Important:** When using soft disabled, consumers must ensure that\nthe button behaves like a disabled button, allowing only focus and\npreventing any interactions (clicks or keyboard actions) from triggering unintended actions.",
377
380
  "default": "undefined",
378
- "attribute": "soft-disabled",
379
- "reflects": true,
381
+ "fieldName": "softDisabled",
380
382
  "inheritedFrom": {
381
383
  "name": "Buttonsimple",
382
- "module": "components/buttonsimple/buttonsimple.component.js"
384
+ "module": "src/components/buttonsimple/buttonsimple.component.ts"
383
385
  }
384
386
  },
385
387
  {
386
- "kind": "field",
387
388
  "name": "size",
388
389
  "type": {
389
390
  "text": "ButtonSize"
390
391
  },
391
392
  "description": "Simplebutton size is a super set of all the sizes supported by children components.",
392
393
  "default": "32",
393
- "attribute": "size",
394
- "reflects": true,
394
+ "fieldName": "size",
395
395
  "inheritedFrom": {
396
396
  "name": "Buttonsimple",
397
- "module": "components/buttonsimple/buttonsimple.component.js"
397
+ "module": "src/components/buttonsimple/buttonsimple.component.ts"
398
398
  }
399
399
  },
400
400
  {
401
- "kind": "field",
402
401
  "name": "role",
403
402
  "description": "This property defines the ARIA role for the element. By default, it is set to 'button'.\nConsumers should override this role when:\n- The element is being used in a context where a different role is more appropriate.\n- Custom behaviors are implemented that require a specific ARIA role for accessibility purposes.",
404
403
  "default": "button",
405
- "attribute": "role",
406
- "reflects": true,
404
+ "fieldName": "role",
407
405
  "inheritedFrom": {
408
406
  "name": "Buttonsimple",
409
- "module": "components/buttonsimple/buttonsimple.component.js"
407
+ "module": "src/components/buttonsimple/buttonsimple.component.ts"
410
408
  }
411
409
  },
412
410
  {
413
- "kind": "field",
414
411
  "name": "ariaStateKey",
415
412
  "type": {
416
413
  "text": "string | undefined"
417
414
  },
418
415
  "description": "This property defines the ARIA state key, which will be toggled when the\nButton is set to `active`.\nThe default value is 'aria-pressed', which is commonly used for toggle buttons.\n\nConsumers can override this property to use a different ARIA state key if needed.\nIn case multiple aria attributes should be toggled, they can be passed in as\na comma separated string.\nFor example: `aria-pressed,aria-expanded`",
419
416
  "default": "'aria-pressed' (when)",
420
- "attribute": "ariaStateKey",
421
- "reflects": true,
417
+ "fieldName": "ariaStateKey",
422
418
  "inheritedFrom": {
423
419
  "name": "Buttonsimple",
424
- "module": "components/buttonsimple/buttonsimple.component.js"
420
+ "module": "src/components/buttonsimple/buttonsimple.component.ts"
425
421
  }
426
422
  },
427
423
  {
428
- "kind": "field",
429
424
  "name": "type",
430
425
  "type": {
431
426
  "text": "ButtonType"
432
427
  },
433
428
  "description": "This property defines the type attribute for the button element.\nThe type attribute specifies the behavior of the button when it is clicked.\n- **submit**: The button submits the form data to the server.\n- **reset**: The button resets the form data to its initial state.\n- **button**: The button does nothing when clicked.",
434
429
  "default": "button",
435
- "attribute": "type",
436
- "reflects": true,
430
+ "fieldName": "type",
437
431
  "inheritedFrom": {
438
432
  "name": "Buttonsimple",
439
- "module": "components/buttonsimple/buttonsimple.component.js"
433
+ "module": "src/components/buttonsimple/buttonsimple.component.ts"
440
434
  }
441
- },
435
+ }
436
+ ],
437
+ "superclass": {
438
+ "name": "Buttonsimple",
439
+ "module": "/src/components/buttonsimple/buttonsimple.component"
440
+ },
441
+ "tagName": "mdc-alertchip",
442
+ "jsDoc": "/**\n * mdc-alertchip component is an interactive chip that consumers can use to represent an alert.\n *\n * - It supports a leading icon along with label.\n * - It supports 5 variants of alerts - neutral, warning, error, success, and informational\n *\n * This component is built by extending Buttonsimple.\n *\n * @tagname mdc-alertchip\n *\n * @dependency mdc-icon\n * @dependency mdc-text\n *\n * @cssproperty --mdc-chip-color - The color of the label text\n * @cssproperty --mdc-chip-icon-color - The color of the icon\n * @cssproperty --mdc-chip-border-color - The border color of the alertchip\n * @cssproperty --mdc-chip-background-color - The background color of the alertchip\n *\n */",
443
+ "customElement": true,
444
+ "events": [
442
445
  {
443
- "kind": "method",
444
- "name": "executeAction",
445
- "privacy": "protected",
446
+ "description": "(React: onClick) This event is dispatched when the button is clicked.",
447
+ "name": "click",
448
+ "reactName": "onClick",
446
449
  "inheritedFrom": {
447
450
  "name": "Buttonsimple",
448
- "module": "components/buttonsimple/buttonsimple.component.js"
451
+ "module": "src/components/buttonsimple/buttonsimple.component.ts"
449
452
  }
450
453
  },
451
454
  {
452
- "kind": "method",
453
- "name": "setActive",
454
- "privacy": "protected",
455
- "parameters": [
456
- {
457
- "name": "element",
458
- "type": {
459
- "text": "HTMLElement"
460
- },
461
- "description": "The button element"
462
- },
463
- {
464
- "name": "active",
465
- "optional": true,
466
- "type": {
467
- "text": "boolean"
468
- },
469
- "description": "The active state of the element"
470
- }
471
- ],
472
- "description": "Sets the ariaStateKey attributes based on the active state of the button.",
455
+ "description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the button.",
456
+ "name": "keydown",
457
+ "reactName": "onKeyDown",
473
458
  "inheritedFrom": {
474
459
  "name": "Buttonsimple",
475
- "module": "components/buttonsimple/buttonsimple.component.js"
460
+ "module": "src/components/buttonsimple/buttonsimple.component.ts"
476
461
  }
477
462
  },
478
463
  {
479
- "kind": "method",
480
- "name": "setSoftDisabled",
481
- "privacy": "private",
482
- "parameters": [
483
- {
484
- "name": "element",
485
- "type": {
486
- "text": "HTMLElement"
487
- },
488
- "description": "The button element."
489
- },
490
- {
491
- "name": "softDisabled",
492
- "optional": true,
493
- "type": {
494
- "text": "boolean"
495
- },
496
- "description": "The soft-disabled state."
497
- }
498
- ],
499
- "description": "Sets the soft-disabled attribute for the button.\nWhen soft-disabled, the button looks to be disabled but remains focusable and clickable.\nAlso sets/removes aria-disabled attribute.",
464
+ "description": "(React: onKeyUp) This event is dispatched when a key is released on the button.",
465
+ "name": "keyup",
466
+ "reactName": "onKeyUp",
500
467
  "inheritedFrom": {
501
468
  "name": "Buttonsimple",
502
- "module": "components/buttonsimple/buttonsimple.component.js"
469
+ "module": "src/components/buttonsimple/buttonsimple.component.ts"
503
470
  }
504
471
  },
505
472
  {
506
- "kind": "method",
507
- "name": "setDisabled",
508
- "privacy": "private",
509
- "parameters": [
510
- {
511
- "name": "element",
512
- "type": {
513
- "text": "HTMLElement"
514
- },
515
- "description": "The button element."
516
- },
517
- {
518
- "name": "disabled",
519
- "type": {
520
- "text": "boolean"
521
- },
522
- "description": "The disabled state."
523
- }
524
- ],
525
- "description": "Sets the disabled attribute for the button.\nWhen disabled, the button is not focusable or clickable, and tabindex is set to -1.\nThe previous tabindex is stored and restored when enabled.\nAlso sets/removes aria-disabled attribute.",
473
+ "description": "(React: onFocus) This event is dispatched when the button receives focus.",
474
+ "name": "focus",
475
+ "reactName": "onFocus",
526
476
  "inheritedFrom": {
527
477
  "name": "Buttonsimple",
528
- "module": "components/buttonsimple/buttonsimple.component.js"
478
+ "module": "src/components/buttonsimple/buttonsimple.component.ts"
529
479
  }
480
+ }
481
+ ]
482
+ }
483
+ ],
484
+ "exports": [
485
+ {
486
+ "kind": "js",
487
+ "name": "default",
488
+ "declaration": {
489
+ "name": "AlertChip",
490
+ "module": "components/alertchip/alertchip.component.js"
491
+ }
492
+ }
493
+ ]
494
+ },
495
+ {
496
+ "kind": "javascript-module",
497
+ "path": "components/animation/animation.component.js",
498
+ "declarations": [
499
+ {
500
+ "kind": "class",
501
+ "description": "The `mdc-animation` component is a wrapper around the Lottie animation library.\nIt fetches the animation data dynamically based on the provided name and renders it.\nThis is a display only component that does not have any interactive functionality.\nFrom accessibility perspective, (by default) it is a decorative image component.",
502
+ "name": "Animation",
503
+ "members": [
504
+ {
505
+ "kind": "field",
506
+ "name": "name",
507
+ "type": {
508
+ "text": "AnimationNames | undefined"
509
+ },
510
+ "description": "Name of the animation (= filename)",
511
+ "attribute": "name",
512
+ "reflects": true
530
513
  },
531
514
  {
532
- "kind": "method",
533
- "name": "triggerClickEvent",
515
+ "kind": "field",
516
+ "name": "loop",
517
+ "type": {
518
+ "text": "LoopType | undefined"
519
+ },
520
+ "description": "How many times to loop the animation\n- \"true\" - infinite\n- \"false\" - no loop\n- number - number of times to loop",
521
+ "attribute": "loop",
522
+ "reflects": true
523
+ },
524
+ {
525
+ "kind": "field",
526
+ "name": "autoplay",
527
+ "type": {
528
+ "text": "boolean | undefined"
529
+ },
530
+ "description": "Weather start the animation automatically",
531
+ "attribute": "autoplay",
532
+ "reflects": true
533
+ },
534
+ {
535
+ "kind": "field",
536
+ "name": "ariaLabel",
537
+ "type": {
538
+ "text": "string | null"
539
+ },
540
+ "default": "null",
541
+ "description": "Aria-label attribute to be set for accessibility",
542
+ "attribute": "aria-label"
543
+ },
544
+ {
545
+ "kind": "field",
546
+ "name": "ariaLabelledBy",
547
+ "type": {
548
+ "text": "string | null"
549
+ },
550
+ "default": "null",
551
+ "description": "Aria-labelledby attribute to be set for accessibility",
552
+ "attribute": "aria-labelledby"
553
+ },
554
+ {
555
+ "kind": "field",
556
+ "name": "lottieInstance",
557
+ "type": {
558
+ "text": "AnimationItem | undefined"
559
+ },
534
560
  "privacy": "private",
535
- "inheritedFrom": {
536
- "name": "Buttonsimple",
537
- "module": "components/buttonsimple/buttonsimple.component.js"
538
- }
561
+ "description": "Lottie animation instance"
539
562
  },
540
563
  {
541
- "kind": "method",
542
- "name": "handleBlur",
564
+ "kind": "field",
565
+ "name": "containerRef",
566
+ "type": {
567
+ "text": "Ref<HTMLDivElement>"
568
+ },
543
569
  "privacy": "private",
544
- "description": "In case the button is pressed and the focus is lost while pressing,\nthe pressed class is removed.",
545
- "inheritedFrom": {
546
- "name": "Buttonsimple",
547
- "module": "components/buttonsimple/buttonsimple.component.js"
548
- }
570
+ "description": "Container for the animation"
571
+ },
572
+ {
573
+ "kind": "field",
574
+ "name": "animation",
575
+ "description": "Exposed API of the animation library (lottie)",
576
+ "readonly": true
549
577
  },
550
578
  {
551
579
  "kind": "method",
552
- "name": "handleKeyDown",
580
+ "name": "getLoopValue",
581
+ "privacy": "private"
582
+ },
583
+ {
584
+ "kind": "method",
585
+ "name": "onLoadSuccessHandler",
553
586
  "privacy": "private",
554
587
  "parameters": [
555
588
  {
556
- "name": "event",
589
+ "name": "animationData",
557
590
  "type": {
558
- "text": "KeyboardEvent"
559
- },
560
- "description": "The keyboard event."
591
+ "text": "any"
592
+ }
561
593
  }
562
594
  ],
563
- "description": "Handles the keydown event on the button.\nIf the key is 'Enter' or 'Space', the button is pressed.\nIf the key is 'Enter', the button is pressed. The native HTML button works in the same way.\nIf the key is 'Space', the button's default is prevent to avoid scrolling etc in the host application.",
564
- "inheritedFrom": {
565
- "name": "Buttonsimple",
566
- "module": "components/buttonsimple/buttonsimple.component.js"
567
- }
595
+ "description": "Create new lotty instance for the loaded data"
568
596
  },
569
597
  {
570
598
  "kind": "method",
571
- "name": "handleKeyUp",
599
+ "name": "onLoadFailHandler",
572
600
  "privacy": "private",
573
601
  "parameters": [
574
602
  {
575
- "name": "event",
603
+ "name": "error",
576
604
  "type": {
577
- "text": "KeyboardEvent"
578
- },
579
- "description": "The keyboard event."
605
+ "text": "Error"
606
+ }
580
607
  }
581
608
  ],
582
- "description": "Handles the keyup event on the button.\nIf the key is 'Enter' or 'Space', the button is clicked.\nIf the key is 'Space', the button is pressed. The native HTML button works in the same way.",
583
- "inheritedFrom": {
584
- "name": "Buttonsimple",
585
- "module": "components/buttonsimple/buttonsimple.component.js"
586
- }
587
- }
588
- ],
589
- "attributes": [
590
- {
591
- "name": "variant",
592
- "type": {
593
- "text": "VariantType"
594
- },
595
- "description": "The variant of the alertchip. It supports 5 variants\n- neutral\n- warning\n- error\n- success\n- informational",
596
- "default": "neutral",
597
- "fieldName": "variant"
609
+ "description": "Error handler for animation loading"
598
610
  },
599
611
  {
600
- "name": "label",
601
- "type": {
602
- "text": "string"
603
- },
604
- "default": "''",
605
- "description": "The visible label text of the alertchip.\n\nWe recommend limiting the <b>maximum length of the label text to 20 characters</b>,\nincluding empty spaces to split words.",
606
- "fieldName": "label"
612
+ "kind": "method",
613
+ "name": "getAnimationData",
614
+ "privacy": "private",
615
+ "description": "Import animation data dynamically"
607
616
  },
608
617
  {
609
- "name": "tabIndex",
610
- "type": {
611
- "text": "number"
612
- },
613
- "default": "0",
614
- "description": "This property specifies the tab order of the element.",
615
- "fieldName": "tabIndex",
616
- "inheritedFrom": {
617
- "name": "TabIndexMixin",
618
- "module": "src/utils/mixins/TabIndexMixin.ts"
619
- }
620
- },
618
+ "kind": "field",
619
+ "name": "onCompleteHandler",
620
+ "description": "Re-dispatch the complete event from the animation library\n\nThis handler called with the animation instance instead of the component instance\nso we need to bind it to the component instance. The arrow function just does that."
621
+ }
622
+ ],
623
+ "events": [
621
624
  {
622
- "name": "disabled",
625
+ "name": "load",
623
626
  "type": {
624
- "text": "boolean | undefined"
627
+ "text": "CustomEvent"
625
628
  },
626
- "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
627
- "default": "undefined",
628
- "fieldName": "disabled",
629
- "inheritedFrom": {
630
- "name": "DisabledMixin",
631
- "module": "src/utils/mixins/DisabledMixin.ts"
632
- }
629
+ "description": "(React: onLoad) This event is dispatched when the animation is loaded",
630
+ "reactName": "onLoad"
633
631
  },
634
632
  {
635
- "name": "active",
636
- "type": {
637
- "text": "boolean | undefined"
638
- },
639
- "description": "The button's active state indicates whether it is currently toggled on (active) or off (inactive).\nWhen the active state is true, the button is considered to be in an active state, meaning it is toggled on.\nConversely, when the active state is false, the button is in an inactive state, indicating it is toggled off.\n\nThis attribute is used to set the provided `ariaStateKey` to true or false.",
640
- "default": "undefined",
641
- "fieldName": "active",
642
- "inheritedFrom": {
643
- "name": "Buttonsimple",
644
- "module": "src/components/buttonsimple/buttonsimple.component.ts"
645
- }
633
+ "description": "(React: onComplete) This event is dispatched when all animation loops completed",
634
+ "name": "complete",
635
+ "reactName": "onComplete"
646
636
  },
647
637
  {
648
- "name": "soft-disabled",
638
+ "description": "(React: onError) This event is dispatched when animation loading failed",
639
+ "name": "error",
640
+ "reactName": "onError"
641
+ }
642
+ ],
643
+ "attributes": [
644
+ {
645
+ "name": "name",
649
646
  "type": {
650
- "text": "boolean | undefined"
647
+ "text": "AnimationNames | undefined"
651
648
  },
652
- "description": "Indicates whether the button is soft disabled.\nWhen set to `true`, the button appears visually disabled but still allows\nfocus, click, and keyboard actions to be passed through.\n\n**Important:** When using soft disabled, consumers must ensure that\nthe button behaves like a disabled button, allowing only focus and\npreventing any interactions (clicks or keyboard actions) from triggering unintended actions.",
653
- "default": "undefined",
654
- "fieldName": "softDisabled",
655
- "inheritedFrom": {
656
- "name": "Buttonsimple",
657
- "module": "src/components/buttonsimple/buttonsimple.component.ts"
658
- }
649
+ "description": "Name of the animation (= filename)",
650
+ "fieldName": "name"
659
651
  },
660
652
  {
661
- "name": "size",
653
+ "name": "loop",
662
654
  "type": {
663
- "text": "ButtonSize"
655
+ "text": "LoopType | undefined"
664
656
  },
665
- "description": "Simplebutton size is a super set of all the sizes supported by children components.",
666
- "default": "32",
667
- "fieldName": "size",
668
- "inheritedFrom": {
669
- "name": "Buttonsimple",
670
- "module": "src/components/buttonsimple/buttonsimple.component.ts"
671
- }
657
+ "description": "How many times to loop the animation\n- \"true\" - infinite\n- \"false\" - no loop\n- number - number of times to loop",
658
+ "fieldName": "loop"
672
659
  },
673
660
  {
674
- "name": "role",
675
- "description": "This property defines the ARIA role for the element. By default, it is set to 'button'.\nConsumers should override this role when:\n- The element is being used in a context where a different role is more appropriate.\n- Custom behaviors are implemented that require a specific ARIA role for accessibility purposes.",
676
- "default": "button",
677
- "fieldName": "role",
678
- "inheritedFrom": {
679
- "name": "Buttonsimple",
680
- "module": "src/components/buttonsimple/buttonsimple.component.ts"
681
- }
661
+ "name": "autoplay",
662
+ "type": {
663
+ "text": "boolean | undefined"
664
+ },
665
+ "description": "Weather start the animation automatically",
666
+ "fieldName": "autoplay"
682
667
  },
683
668
  {
684
- "name": "ariaStateKey",
669
+ "name": "aria-label",
685
670
  "type": {
686
- "text": "string | undefined"
671
+ "text": "string | null"
687
672
  },
688
- "description": "This property defines the ARIA state key, which will be toggled when the\nButton is set to `active`.\nThe default value is 'aria-pressed', which is commonly used for toggle buttons.\n\nConsumers can override this property to use a different ARIA state key if needed.\nIn case multiple aria attributes should be toggled, they can be passed in as\na comma separated string.\nFor example: `aria-pressed,aria-expanded`",
689
- "default": "'aria-pressed' (when)",
690
- "fieldName": "ariaStateKey",
691
- "inheritedFrom": {
692
- "name": "Buttonsimple",
693
- "module": "src/components/buttonsimple/buttonsimple.component.ts"
694
- }
673
+ "default": "null",
674
+ "description": "Aria-label attribute to be set for accessibility",
675
+ "fieldName": "ariaLabel"
695
676
  },
696
677
  {
697
- "name": "type",
678
+ "name": "aria-labelledby",
698
679
  "type": {
699
- "text": "ButtonType"
680
+ "text": "string | null"
700
681
  },
701
- "description": "This property defines the type attribute for the button element.\nThe type attribute specifies the behavior of the button when it is clicked.\n- **submit**: The button submits the form data to the server.\n- **reset**: The button resets the form data to its initial state.\n- **button**: The button does nothing when clicked.",
702
- "default": "button",
703
- "fieldName": "type",
704
- "inheritedFrom": {
705
- "name": "Buttonsimple",
706
- "module": "src/components/buttonsimple/buttonsimple.component.ts"
707
- }
682
+ "default": "null",
683
+ "description": "Aria-labelledby attribute to be set for accessibility",
684
+ "fieldName": "ariaLabelledBy"
708
685
  }
709
686
  ],
710
687
  "superclass": {
711
- "name": "Buttonsimple",
712
- "module": "/src/components/buttonsimple/buttonsimple.component"
688
+ "name": "Component",
689
+ "module": "/src/models"
713
690
  },
714
- "tagName": "mdc-alertchip",
715
- "jsDoc": "/**\n * mdc-alertchip component is an interactive chip that consumers can use to represent an alert.\n *\n * - It supports a leading icon along with label.\n * - It supports 5 variants of alerts - neutral, warning, error, success, and informational\n *\n * This component is built by extending Buttonsimple.\n *\n * @tagname mdc-alertchip\n *\n * @dependency mdc-icon\n * @dependency mdc-text\n *\n * @cssproperty --mdc-chip-color - The color of the label text\n * @cssproperty --mdc-chip-icon-color - The color of the icon\n * @cssproperty --mdc-chip-border-color - The border color of the alertchip\n * @cssproperty --mdc-chip-background-color - The background color of the alertchip\n *\n */",
716
- "customElement": true,
717
- "events": [
691
+ "tagName": "mdc-animation",
692
+ "jsDoc": "/**\n * The `mdc-animation` component is a wrapper around the Lottie animation library.\n * It fetches the animation data dynamically based on the provided name and renders it.\n * This is a display only component that does not have any interactive functionality.\n * From accessibility perspective, (by default) it is a decorative image component.\n *\n * @tagname mdc-animation\n *\n * @event load - (React: onLoad) This event is dispatched when the animation is loaded\n * @event complete - (React: onComplete) This event is dispatched when all animation loops completed\n * @event error - (React: onError) This event is dispatched when animation loading failed\n */",
693
+ "customElement": true
694
+ }
695
+ ],
696
+ "exports": [
697
+ {
698
+ "kind": "js",
699
+ "name": "default",
700
+ "declaration": {
701
+ "name": "Animation",
702
+ "module": "components/animation/animation.component.js"
703
+ }
704
+ }
705
+ ]
706
+ },
707
+ {
708
+ "kind": "javascript-module",
709
+ "path": "components/appheader/appheader.component.js",
710
+ "declarations": [
711
+ {
712
+ "kind": "class",
713
+ "description": "The `mdc-appheader` component provides a structured and accessible app header layout.\nIt consists of three primary sections: leading, center, and trailing.\n\n- The **leading section** typically holds a **brand logo**, **brand name** or **menu icon**.\n- The **center section** can contain a **search bar**, **icons** or action controls.\n- The **trailing section** generally includes a **profile avatar**, **additional icons** or **action controls**.",
714
+ "name": "Appheader",
715
+ "cssParts": [
718
716
  {
719
- "description": "(React: onClick) This event is dispatched when the button is clicked.",
720
- "name": "click",
721
- "reactName": "onClick",
722
- "inheritedFrom": {
723
- "name": "Buttonsimple",
724
- "module": "src/components/buttonsimple/buttonsimple.component.ts"
725
- }
717
+ "description": "The main container for styling the header.",
718
+ "name": "container"
726
719
  },
727
720
  {
728
- "description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the button.",
729
- "name": "keydown",
730
- "reactName": "onKeyDown",
731
- "inheritedFrom": {
732
- "name": "Buttonsimple",
733
- "module": "src/components/buttonsimple/buttonsimple.component.ts"
734
- }
721
+ "description": "The leading section of the header.",
722
+ "name": "leading-section"
735
723
  },
736
724
  {
737
- "description": "(React: onKeyUp) This event is dispatched when a key is released on the button.",
738
- "name": "keyup",
739
- "reactName": "onKeyUp",
740
- "inheritedFrom": {
741
- "name": "Buttonsimple",
742
- "module": "src/components/buttonsimple/buttonsimple.component.ts"
743
- }
725
+ "description": "The center section of the header.",
726
+ "name": "center-section"
744
727
  },
745
728
  {
746
- "description": "(React: onFocus) This event is dispatched when the button receives focus.",
747
- "name": "focus",
748
- "reactName": "onFocus",
749
- "inheritedFrom": {
750
- "name": "Buttonsimple",
751
- "module": "src/components/buttonsimple/buttonsimple.component.ts"
752
- }
729
+ "description": "The trailing section of the header.",
730
+ "name": "trailing-section"
753
731
  }
754
- ]
732
+ ],
733
+ "slots": [
734
+ {
735
+ "description": "Slot for the leading section (e.g., brand logo, brand name).",
736
+ "name": "leading"
737
+ },
738
+ {
739
+ "description": "Slot for the center section (e.g., search bar, icons).",
740
+ "name": "center"
741
+ },
742
+ {
743
+ "description": "Slot for the trailing section (e.g., profile avatar, icons).",
744
+ "name": "trailing"
745
+ }
746
+ ],
747
+ "members": [],
748
+ "superclass": {
749
+ "name": "Component",
750
+ "module": "/src/models"
751
+ },
752
+ "tagName": "mdc-appheader",
753
+ "jsDoc": "/**\n * The `mdc-appheader` component provides a structured and accessible app header layout.\n * It consists of three primary sections: leading, center, and trailing.\n *\n * - The **leading section** typically holds a **brand logo**, **brand name** or **menu icon**.\n * - The **center section** can contain a **search bar**, **icons** or action controls.\n * - The **trailing section** generally includes a **profile avatar**, **additional icons** or **action controls**.\n *\n * @tagname mdc-appheader\n *\n * @slot leading - Slot for the leading section (e.g., brand logo, brand name).\n * @slot center - Slot for the center section (e.g., search bar, icons).\n * @slot trailing - Slot for the trailing section (e.g., profile avatar, icons).\n *\n * @csspart container - The main container for styling the header.\n * @csspart leading-section - The leading section of the header.\n * @csspart center-section - The center section of the header.\n * @csspart trailing-section - The trailing section of the header.\n */",
754
+ "customElement": true
755
755
  }
756
756
  ],
757
757
  "exports": [
@@ -759,8 +759,8 @@
759
759
  "kind": "js",
760
760
  "name": "default",
761
761
  "declaration": {
762
- "name": "AlertChip",
763
- "module": "components/alertchip/alertchip.component.js"
762
+ "name": "Appheader",
763
+ "module": "components/appheader/appheader.component.js"
764
764
  }
765
765
  }
766
766
  ]
@@ -6362,7 +6362,7 @@
6362
6362
  "kind": "method",
6363
6363
  "name": "manageRequired",
6364
6364
  "privacy": "private",
6365
- "description": "Manages the required state of the checkbox.\nIf the checkbox is not checked and the requiredLabel property is set, then the checkbox is invalid."
6365
+ "description": "Manages the required state of the checkbox.\nIf the checkbox is not checked and the required property is set, then the checkbox is invalid."
6366
6366
  },
6367
6367
  {
6368
6368
  "kind": "method",
@@ -6565,12 +6565,13 @@
6565
6565
  },
6566
6566
  {
6567
6567
  "kind": "field",
6568
- "name": "requiredLabel",
6568
+ "name": "required",
6569
6569
  "type": {
6570
- "text": "string | undefined"
6570
+ "text": "boolean"
6571
6571
  },
6572
- "description": "The required label of the input field.\nWhen an appropriate string value is set,\nthe input field is marked as required and the label is appended with this text.",
6573
- "attribute": "required-label",
6572
+ "default": "false",
6573
+ "description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
6574
+ "attribute": "required",
6574
6575
  "reflects": true,
6575
6576
  "inheritedFrom": {
6576
6577
  "name": "FormfieldWrapper",
@@ -6634,15 +6635,6 @@
6634
6635
  "module": "components/formfieldwrapper/formfieldwrapper.component.js"
6635
6636
  }
6636
6637
  },
6637
- {
6638
- "kind": "method",
6639
- "name": "renderRequiredLabel",
6640
- "privacy": "protected",
6641
- "inheritedFrom": {
6642
- "name": "FormfieldWrapper",
6643
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
6644
- }
6645
- },
6646
6638
  {
6647
6639
  "kind": "method",
6648
6640
  "name": "renderHelpTextIcon",
@@ -6826,12 +6818,13 @@
6826
6818
  }
6827
6819
  },
6828
6820
  {
6829
- "name": "required-label",
6821
+ "name": "required",
6830
6822
  "type": {
6831
- "text": "string | undefined"
6823
+ "text": "boolean"
6832
6824
  },
6833
- "description": "The required label of the input field.\nWhen an appropriate string value is set,\nthe input field is marked as required and the label is appended with this text.",
6834
- "fieldName": "requiredLabel",
6825
+ "default": "false",
6826
+ "description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
6827
+ "fieldName": "required",
6835
6828
  "inheritedFrom": {
6836
6829
  "name": "FormfieldWrapper",
6837
6830
  "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
@@ -10893,12 +10886,13 @@
10893
10886
  },
10894
10887
  {
10895
10888
  "kind": "field",
10896
- "name": "requiredLabel",
10889
+ "name": "required",
10897
10890
  "type": {
10898
- "text": "string | undefined"
10891
+ "text": "boolean"
10899
10892
  },
10900
- "description": "The required label of the input field.\nWhen an appropriate string value is set,\nthe input field is marked as required and the label is appended with this text.",
10901
- "attribute": "required-label",
10893
+ "default": "false",
10894
+ "description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
10895
+ "attribute": "required",
10902
10896
  "reflects": true,
10903
10897
  "inheritedFrom": {
10904
10898
  "name": "FormfieldWrapper",
@@ -10962,15 +10956,6 @@
10962
10956
  "module": "components/formfieldwrapper/formfieldwrapper.component.js"
10963
10957
  }
10964
10958
  },
10965
- {
10966
- "kind": "method",
10967
- "name": "renderRequiredLabel",
10968
- "privacy": "protected",
10969
- "inheritedFrom": {
10970
- "name": "FormfieldWrapper",
10971
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
10972
- }
10973
- },
10974
10959
  {
10975
10960
  "kind": "method",
10976
10961
  "name": "renderHelpTextIcon",
@@ -11085,12 +11070,13 @@
11085
11070
  }
11086
11071
  },
11087
11072
  {
11088
- "name": "required-label",
11073
+ "name": "required",
11089
11074
  "type": {
11090
- "text": "string | undefined"
11075
+ "text": "boolean"
11091
11076
  },
11092
- "description": "The required label of the input field.\nWhen an appropriate string value is set,\nthe input field is marked as required and the label is appended with this text.",
11093
- "fieldName": "requiredLabel",
11077
+ "default": "false",
11078
+ "description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
11079
+ "fieldName": "required",
11094
11080
  "inheritedFrom": {
11095
11081
  "name": "FormfieldWrapper",
11096
11082
  "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
@@ -11174,12 +11160,13 @@
11174
11160
  },
11175
11161
  {
11176
11162
  "kind": "field",
11177
- "name": "requiredLabel",
11163
+ "name": "required",
11178
11164
  "type": {
11179
- "text": "string | undefined"
11165
+ "text": "boolean"
11180
11166
  },
11181
- "description": "The required label of the input field.\nWhen an appropriate string value is set,\nthe input field is marked as required and the label is appended with this text.",
11182
- "attribute": "required-label",
11167
+ "default": "false",
11168
+ "description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
11169
+ "attribute": "required",
11183
11170
  "reflects": true
11184
11171
  },
11185
11172
  {
@@ -11223,11 +11210,6 @@
11223
11210
  }
11224
11211
  }
11225
11212
  },
11226
- {
11227
- "kind": "method",
11228
- "name": "renderRequiredLabel",
11229
- "privacy": "protected"
11230
- },
11231
11213
  {
11232
11214
  "kind": "method",
11233
11215
  "name": "renderHelpTextIcon",
@@ -11298,12 +11280,13 @@
11298
11280
  "fieldName": "label"
11299
11281
  },
11300
11282
  {
11301
- "name": "required-label",
11283
+ "name": "required",
11302
11284
  "type": {
11303
- "text": "string | undefined"
11285
+ "text": "boolean"
11304
11286
  },
11305
- "description": "The required label of the input field.\nWhen an appropriate string value is set,\nthe input field is marked as required and the label is appended with this text.",
11306
- "fieldName": "requiredLabel"
11287
+ "default": "false",
11288
+ "description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
11289
+ "fieldName": "required"
11307
11290
  },
11308
11291
  {
11309
11292
  "name": "id",
@@ -12296,12 +12279,13 @@
12296
12279
  },
12297
12280
  {
12298
12281
  "kind": "field",
12299
- "name": "requiredLabel",
12282
+ "name": "required",
12300
12283
  "type": {
12301
- "text": "string | undefined"
12284
+ "text": "boolean"
12302
12285
  },
12303
- "description": "The required label of the input field.\nWhen an appropriate string value is set,\nthe input field is marked as required and the label is appended with this text.",
12304
- "attribute": "required-label",
12286
+ "default": "false",
12287
+ "description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
12288
+ "attribute": "required",
12305
12289
  "reflects": true,
12306
12290
  "inheritedFrom": {
12307
12291
  "name": "FormfieldWrapper",
@@ -12365,15 +12349,6 @@
12365
12349
  "module": "components/formfieldwrapper/formfieldwrapper.component.js"
12366
12350
  }
12367
12351
  },
12368
- {
12369
- "kind": "method",
12370
- "name": "renderRequiredLabel",
12371
- "privacy": "protected",
12372
- "inheritedFrom": {
12373
- "name": "FormfieldWrapper",
12374
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
12375
- }
12376
- },
12377
12352
  {
12378
12353
  "kind": "method",
12379
12354
  "name": "renderHelpTextIcon",
@@ -12668,12 +12643,13 @@
12668
12643
  }
12669
12644
  },
12670
12645
  {
12671
- "name": "required-label",
12646
+ "name": "required",
12672
12647
  "type": {
12673
- "text": "string | undefined"
12648
+ "text": "boolean"
12674
12649
  },
12675
- "description": "The required label of the input field.\nWhen an appropriate string value is set,\nthe input field is marked as required and the label is appended with this text.",
12676
- "fieldName": "requiredLabel",
12650
+ "default": "false",
12651
+ "description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
12652
+ "fieldName": "required",
12677
12653
  "inheritedFrom": {
12678
12654
  "name": "FormfieldWrapper",
12679
12655
  "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
@@ -14028,14 +14004,17 @@
14028
14004
  "name": "event",
14029
14005
  "type": {
14030
14006
  "text": "KeyboardEvent"
14031
- }
14007
+ },
14008
+ "description": "The keyboard event triggered when a key is pressed down."
14032
14009
  }
14033
- ]
14010
+ ],
14011
+ "description": "Fires the click event when the enter or space key is pressed."
14034
14012
  },
14035
14013
  {
14036
14014
  "kind": "method",
14037
14015
  "name": "triggerClickEvent",
14038
- "privacy": "private"
14016
+ "privacy": "private",
14017
+ "description": "Triggers a click event on the list item."
14039
14018
  },
14040
14019
  {
14041
14020
  "kind": "method",
@@ -14045,7 +14024,8 @@
14045
14024
  "type": {
14046
14025
  "text": "void"
14047
14026
  }
14048
- }
14027
+ },
14028
+ "description": "Handles the click event on the list item.\nIf the tooltip is open, it has to be closed first."
14049
14029
  },
14050
14030
  {
14051
14031
  "kind": "method",
@@ -14127,12 +14107,44 @@
14127
14107
  {
14128
14108
  "kind": "method",
14129
14109
  "name": "renderTrailingControls",
14130
- "privacy": "protected"
14110
+ "privacy": "protected",
14111
+ "description": "Renders the trailing controls slot.",
14112
+ "return": {
14113
+ "type": {
14114
+ "text": ""
14115
+ }
14116
+ }
14131
14117
  },
14132
14118
  {
14133
14119
  "kind": "method",
14134
14120
  "name": "renderLeadingControls",
14135
- "privacy": "protected"
14121
+ "privacy": "protected",
14122
+ "description": "Renders the leading controls slot.",
14123
+ "return": {
14124
+ "type": {
14125
+ "text": ""
14126
+ }
14127
+ }
14128
+ },
14129
+ {
14130
+ "kind": "method",
14131
+ "name": "stopEventPropagation",
14132
+ "privacy": "protected",
14133
+ "return": {
14134
+ "type": {
14135
+ "text": "void"
14136
+ }
14137
+ },
14138
+ "parameters": [
14139
+ {
14140
+ "name": "event",
14141
+ "type": {
14142
+ "text": "Event"
14143
+ },
14144
+ "description": "The mouse event triggered when a click occurs."
14145
+ }
14146
+ ],
14147
+ "description": "Stops the click event from propagating to parent elements. In case of keyboard events,\nit stops the propagation for Enter and Space keys.\nThis is useful when the list item contains controls that\nshould not trigger the click event on the list item itself."
14136
14148
  },
14137
14149
  {
14138
14150
  "kind": "field",
@@ -15311,6 +15323,11 @@
15311
15323
  "name": "renderTrailingControls",
15312
15324
  "privacy": "protected",
15313
15325
  "description": "Renders the trailing controls slot and optionally the trailing arrow icon,\nbased on `arrowPosition` and `arrowDirection`.",
15326
+ "return": {
15327
+ "type": {
15328
+ "text": ""
15329
+ }
15330
+ },
15314
15331
  "inheritedFrom": {
15315
15332
  "name": "ListItem",
15316
15333
  "module": "components/listitem/listitem.component.js"
@@ -15321,6 +15338,11 @@
15321
15338
  "name": "renderLeadingControls",
15322
15339
  "privacy": "protected",
15323
15340
  "description": "Renders the leading controls slot and optionally the leading arrow icon,\nbased on `arrowPosition` and `arrowDirection`.",
15341
+ "return": {
15342
+ "type": {
15343
+ "text": ""
15344
+ }
15345
+ },
15324
15346
  "inheritedFrom": {
15325
15347
  "name": "ListItem",
15326
15348
  "module": "components/listitem/listitem.component.js"
@@ -15484,9 +15506,11 @@
15484
15506
  "name": "event",
15485
15507
  "type": {
15486
15508
  "text": "KeyboardEvent"
15487
- }
15509
+ },
15510
+ "description": "The keyboard event triggered when a key is pressed down."
15488
15511
  }
15489
15512
  ],
15513
+ "description": "Fires the click event when the enter or space key is pressed.",
15490
15514
  "inheritedFrom": {
15491
15515
  "name": "ListItem",
15492
15516
  "module": "components/listitem/listitem.component.js"
@@ -15496,6 +15520,7 @@
15496
15520
  "kind": "method",
15497
15521
  "name": "triggerClickEvent",
15498
15522
  "privacy": "private",
15523
+ "description": "Triggers a click event on the list item.",
15499
15524
  "inheritedFrom": {
15500
15525
  "name": "ListItem",
15501
15526
  "module": "components/listitem/listitem.component.js"
@@ -15510,6 +15535,7 @@
15510
15535
  "text": "void"
15511
15536
  }
15512
15537
  },
15538
+ "description": "Handles the click event on the list item.\nIf the tooltip is open, it has to be closed first.",
15513
15539
  "inheritedFrom": {
15514
15540
  "name": "ListItem",
15515
15541
  "module": "components/listitem/listitem.component.js"
@@ -15607,6 +15633,30 @@
15607
15633
  "name": "ListItem",
15608
15634
  "module": "components/listitem/listitem.component.js"
15609
15635
  }
15636
+ },
15637
+ {
15638
+ "kind": "method",
15639
+ "name": "stopEventPropagation",
15640
+ "privacy": "protected",
15641
+ "return": {
15642
+ "type": {
15643
+ "text": "void"
15644
+ }
15645
+ },
15646
+ "parameters": [
15647
+ {
15648
+ "name": "event",
15649
+ "type": {
15650
+ "text": "Event"
15651
+ },
15652
+ "description": "The mouse event triggered when a click occurs."
15653
+ }
15654
+ ],
15655
+ "description": "Stops the click event from propagating to parent elements. In case of keyboard events,\nit stops the propagation for Enter and Space keys.\nThis is useful when the list item contains controls that\nshould not trigger the click event on the list item itself.",
15656
+ "inheritedFrom": {
15657
+ "name": "ListItem",
15658
+ "module": "components/listitem/listitem.component.js"
15659
+ }
15610
15660
  }
15611
15661
  ],
15612
15662
  "events": [
@@ -16097,6 +16147,11 @@
16097
16147
  "name": "renderTrailingControls",
16098
16148
  "privacy": "protected",
16099
16149
  "description": "Renders the trailing controls slot and optionally the trailing arrow icon,\nbased on `arrowPosition` and `arrowDirection`.",
16150
+ "return": {
16151
+ "type": {
16152
+ "text": ""
16153
+ }
16154
+ },
16100
16155
  "inheritedFrom": {
16101
16156
  "name": "ListItem",
16102
16157
  "module": "components/listitem/listitem.component.js"
@@ -16107,6 +16162,11 @@
16107
16162
  "name": "renderLeadingControls",
16108
16163
  "privacy": "protected",
16109
16164
  "description": "Renders the leading controls slot and optionally the leading arrow icon,\nbased on `arrowPosition` and `arrowDirection`.",
16165
+ "return": {
16166
+ "type": {
16167
+ "text": ""
16168
+ }
16169
+ },
16110
16170
  "inheritedFrom": {
16111
16171
  "name": "ListItem",
16112
16172
  "module": "components/listitem/listitem.component.js"
@@ -16270,9 +16330,11 @@
16270
16330
  "name": "event",
16271
16331
  "type": {
16272
16332
  "text": "KeyboardEvent"
16273
- }
16333
+ },
16334
+ "description": "The keyboard event triggered when a key is pressed down."
16274
16335
  }
16275
16336
  ],
16337
+ "description": "Fires the click event when the enter or space key is pressed.",
16276
16338
  "inheritedFrom": {
16277
16339
  "name": "ListItem",
16278
16340
  "module": "components/listitem/listitem.component.js"
@@ -16282,6 +16344,7 @@
16282
16344
  "kind": "method",
16283
16345
  "name": "triggerClickEvent",
16284
16346
  "privacy": "private",
16347
+ "description": "Triggers a click event on the list item.",
16285
16348
  "inheritedFrom": {
16286
16349
  "name": "ListItem",
16287
16350
  "module": "components/listitem/listitem.component.js"
@@ -16296,6 +16359,7 @@
16296
16359
  "text": "void"
16297
16360
  }
16298
16361
  },
16362
+ "description": "Handles the click event on the list item.\nIf the tooltip is open, it has to be closed first.",
16299
16363
  "inheritedFrom": {
16300
16364
  "name": "ListItem",
16301
16365
  "module": "components/listitem/listitem.component.js"
@@ -16393,6 +16457,30 @@
16393
16457
  "name": "ListItem",
16394
16458
  "module": "components/listitem/listitem.component.js"
16395
16459
  }
16460
+ },
16461
+ {
16462
+ "kind": "method",
16463
+ "name": "stopEventPropagation",
16464
+ "privacy": "protected",
16465
+ "return": {
16466
+ "type": {
16467
+ "text": "void"
16468
+ }
16469
+ },
16470
+ "parameters": [
16471
+ {
16472
+ "name": "event",
16473
+ "type": {
16474
+ "text": "Event"
16475
+ },
16476
+ "description": "The mouse event triggered when a click occurs."
16477
+ }
16478
+ ],
16479
+ "description": "Stops the click event from propagating to parent elements. In case of keyboard events,\nit stops the propagation for Enter and Space keys.\nThis is useful when the list item contains controls that\nshould not trigger the click event on the list item itself.",
16480
+ "inheritedFrom": {
16481
+ "name": "ListItem",
16482
+ "module": "components/listitem/listitem.component.js"
16483
+ }
16396
16484
  }
16397
16485
  ],
16398
16486
  "events": [
@@ -16737,6 +16825,11 @@
16737
16825
  "name": "renderTrailingControls",
16738
16826
  "privacy": "protected",
16739
16827
  "description": "Renders the trailing controls slot and optionally the trailing arrow icon,\nbased on `arrowPosition` and `arrowDirection`.",
16828
+ "return": {
16829
+ "type": {
16830
+ "text": ""
16831
+ }
16832
+ },
16740
16833
  "inheritedFrom": {
16741
16834
  "name": "ListItem",
16742
16835
  "module": "components/listitem/listitem.component.js"
@@ -16747,6 +16840,11 @@
16747
16840
  "name": "renderLeadingControls",
16748
16841
  "privacy": "protected",
16749
16842
  "description": "Renders the leading controls slot and optionally the leading arrow icon,\nbased on `arrowPosition` and `arrowDirection`.",
16843
+ "return": {
16844
+ "type": {
16845
+ "text": ""
16846
+ }
16847
+ },
16750
16848
  "inheritedFrom": {
16751
16849
  "name": "ListItem",
16752
16850
  "module": "components/listitem/listitem.component.js"
@@ -16910,9 +17008,11 @@
16910
17008
  "name": "event",
16911
17009
  "type": {
16912
17010
  "text": "KeyboardEvent"
16913
- }
17011
+ },
17012
+ "description": "The keyboard event triggered when a key is pressed down."
16914
17013
  }
16915
17014
  ],
17015
+ "description": "Fires the click event when the enter or space key is pressed.",
16916
17016
  "inheritedFrom": {
16917
17017
  "name": "ListItem",
16918
17018
  "module": "components/listitem/listitem.component.js"
@@ -16922,6 +17022,7 @@
16922
17022
  "kind": "method",
16923
17023
  "name": "triggerClickEvent",
16924
17024
  "privacy": "private",
17025
+ "description": "Triggers a click event on the list item.",
16925
17026
  "inheritedFrom": {
16926
17027
  "name": "ListItem",
16927
17028
  "module": "components/listitem/listitem.component.js"
@@ -16936,6 +17037,7 @@
16936
17037
  "text": "void"
16937
17038
  }
16938
17039
  },
17040
+ "description": "Handles the click event on the list item.\nIf the tooltip is open, it has to be closed first.",
16939
17041
  "inheritedFrom": {
16940
17042
  "name": "ListItem",
16941
17043
  "module": "components/listitem/listitem.component.js"
@@ -17033,6 +17135,30 @@
17033
17135
  "name": "ListItem",
17034
17136
  "module": "components/listitem/listitem.component.js"
17035
17137
  }
17138
+ },
17139
+ {
17140
+ "kind": "method",
17141
+ "name": "stopEventPropagation",
17142
+ "privacy": "protected",
17143
+ "return": {
17144
+ "type": {
17145
+ "text": "void"
17146
+ }
17147
+ },
17148
+ "parameters": [
17149
+ {
17150
+ "name": "event",
17151
+ "type": {
17152
+ "text": "Event"
17153
+ },
17154
+ "description": "The mouse event triggered when a click occurs."
17155
+ }
17156
+ ],
17157
+ "description": "Stops the click event from propagating to parent elements. In case of keyboard events,\nit stops the propagation for Enter and Space keys.\nThis is useful when the list item contains controls that\nshould not trigger the click event on the list item itself.",
17158
+ "inheritedFrom": {
17159
+ "name": "ListItem",
17160
+ "module": "components/listitem/listitem.component.js"
17161
+ }
17036
17162
  }
17037
17163
  ],
17038
17164
  "events": [
@@ -20191,9 +20317,11 @@
20191
20317
  "name": "event",
20192
20318
  "type": {
20193
20319
  "text": "KeyboardEvent"
20194
- }
20320
+ },
20321
+ "description": "The keyboard event triggered when a key is pressed down."
20195
20322
  }
20196
20323
  ],
20324
+ "description": "Fires the click event when the enter or space key is pressed.",
20197
20325
  "inheritedFrom": {
20198
20326
  "name": "ListItem",
20199
20327
  "module": "components/listitem/listitem.component.js"
@@ -20203,6 +20331,7 @@
20203
20331
  "kind": "method",
20204
20332
  "name": "triggerClickEvent",
20205
20333
  "privacy": "private",
20334
+ "description": "Triggers a click event on the list item.",
20206
20335
  "inheritedFrom": {
20207
20336
  "name": "ListItem",
20208
20337
  "module": "components/listitem/listitem.component.js"
@@ -20217,6 +20346,7 @@
20217
20346
  "text": "void"
20218
20347
  }
20219
20348
  },
20349
+ "description": "Handles the click event on the list item.\nIf the tooltip is open, it has to be closed first.",
20220
20350
  "inheritedFrom": {
20221
20351
  "name": "ListItem",
20222
20352
  "module": "components/listitem/listitem.component.js"
@@ -20319,6 +20449,12 @@
20319
20449
  "kind": "method",
20320
20450
  "name": "renderTrailingControls",
20321
20451
  "privacy": "protected",
20452
+ "description": "Renders the trailing controls slot.",
20453
+ "return": {
20454
+ "type": {
20455
+ "text": ""
20456
+ }
20457
+ },
20322
20458
  "inheritedFrom": {
20323
20459
  "name": "ListItem",
20324
20460
  "module": "components/listitem/listitem.component.js"
@@ -20328,6 +20464,36 @@
20328
20464
  "kind": "method",
20329
20465
  "name": "renderLeadingControls",
20330
20466
  "privacy": "protected",
20467
+ "description": "Renders the leading controls slot.",
20468
+ "return": {
20469
+ "type": {
20470
+ "text": ""
20471
+ }
20472
+ },
20473
+ "inheritedFrom": {
20474
+ "name": "ListItem",
20475
+ "module": "components/listitem/listitem.component.js"
20476
+ }
20477
+ },
20478
+ {
20479
+ "kind": "method",
20480
+ "name": "stopEventPropagation",
20481
+ "privacy": "protected",
20482
+ "return": {
20483
+ "type": {
20484
+ "text": "void"
20485
+ }
20486
+ },
20487
+ "parameters": [
20488
+ {
20489
+ "name": "event",
20490
+ "type": {
20491
+ "text": "Event"
20492
+ },
20493
+ "description": "The mouse event triggered when a click occurs."
20494
+ }
20495
+ ],
20496
+ "description": "Stops the click event from propagating to parent elements. In case of keyboard events,\nit stops the propagation for Enter and Space keys.\nThis is useful when the list item contains controls that\nshould not trigger the click event on the list item itself.",
20331
20497
  "inheritedFrom": {
20332
20498
  "name": "ListItem",
20333
20499
  "module": "components/listitem/listitem.component.js"
@@ -22243,12 +22409,13 @@
22243
22409
  },
22244
22410
  {
22245
22411
  "kind": "field",
22246
- "name": "requiredLabel",
22412
+ "name": "required",
22247
22413
  "type": {
22248
- "text": "string | undefined"
22414
+ "text": "boolean"
22249
22415
  },
22250
- "description": "The required label of the input field.\nWhen an appropriate string value is set,\nthe input field is marked as required and the label is appended with this text.",
22251
- "attribute": "required-label",
22416
+ "default": "false",
22417
+ "description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
22418
+ "attribute": "required",
22252
22419
  "reflects": true,
22253
22420
  "inheritedFrom": {
22254
22421
  "name": "FormfieldWrapper",
@@ -22312,15 +22479,6 @@
22312
22479
  "module": "components/formfieldwrapper/formfieldwrapper.component.js"
22313
22480
  }
22314
22481
  },
22315
- {
22316
- "kind": "method",
22317
- "name": "renderRequiredLabel",
22318
- "privacy": "protected",
22319
- "inheritedFrom": {
22320
- "name": "FormfieldWrapper",
22321
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
22322
- }
22323
- },
22324
22482
  {
22325
22483
  "kind": "method",
22326
22484
  "name": "renderHelpTextIcon",
@@ -22449,12 +22607,13 @@
22449
22607
  }
22450
22608
  },
22451
22609
  {
22452
- "name": "required-label",
22610
+ "name": "required",
22453
22611
  "type": {
22454
- "text": "string | undefined"
22612
+ "text": "boolean"
22455
22613
  },
22456
- "description": "The required label of the input field.\nWhen an appropriate string value is set,\nthe input field is marked as required and the label is appended with this text.",
22457
- "fieldName": "requiredLabel",
22614
+ "default": "false",
22615
+ "description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
22616
+ "fieldName": "required",
22458
22617
  "inheritedFrom": {
22459
22618
  "name": "FormfieldWrapper",
22460
22619
  "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
@@ -22785,12 +22944,13 @@
22785
22944
  },
22786
22945
  {
22787
22946
  "kind": "field",
22788
- "name": "requiredLabel",
22947
+ "name": "required",
22789
22948
  "type": {
22790
- "text": "string | undefined"
22949
+ "text": "boolean"
22791
22950
  },
22792
- "description": "The required label of the input field.\nWhen an appropriate string value is set,\nthe input field is marked as required and the label is appended with this text.",
22793
- "attribute": "required-label",
22951
+ "default": "false",
22952
+ "description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
22953
+ "attribute": "required",
22794
22954
  "reflects": true,
22795
22955
  "inheritedFrom": {
22796
22956
  "name": "FormfieldWrapper",
@@ -22854,15 +23014,6 @@
22854
23014
  "module": "components/formfieldwrapper/formfieldwrapper.component.js"
22855
23015
  }
22856
23016
  },
22857
- {
22858
- "kind": "method",
22859
- "name": "renderRequiredLabel",
22860
- "privacy": "protected",
22861
- "inheritedFrom": {
22862
- "name": "FormfieldWrapper",
22863
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
22864
- }
22865
- },
22866
23017
  {
22867
23018
  "kind": "method",
22868
23019
  "name": "renderHelpTextIcon",
@@ -23010,12 +23161,13 @@
23010
23161
  }
23011
23162
  },
23012
23163
  {
23013
- "name": "required-label",
23164
+ "name": "required",
23014
23165
  "type": {
23015
- "text": "string | undefined"
23166
+ "text": "boolean"
23016
23167
  },
23017
- "description": "The required label of the input field.\nWhen an appropriate string value is set,\nthe input field is marked as required and the label is appended with this text.",
23018
- "fieldName": "requiredLabel",
23168
+ "default": "false",
23169
+ "description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
23170
+ "fieldName": "required",
23019
23171
  "inheritedFrom": {
23020
23172
  "name": "FormfieldWrapper",
23021
23173
  "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
@@ -23445,12 +23597,13 @@
23445
23597
  },
23446
23598
  {
23447
23599
  "kind": "field",
23448
- "name": "requiredLabel",
23600
+ "name": "required",
23449
23601
  "type": {
23450
- "text": "string | undefined"
23602
+ "text": "boolean"
23451
23603
  },
23452
- "description": "The required label of the input field.\nWhen an appropriate string value is set,\nthe input field is marked as required and the label is appended with this text.",
23453
- "attribute": "required-label",
23604
+ "default": "false",
23605
+ "description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
23606
+ "attribute": "required",
23454
23607
  "reflects": true,
23455
23608
  "inheritedFrom": {
23456
23609
  "name": "FormfieldWrapper",
@@ -23514,15 +23667,6 @@
23514
23667
  "module": "components/formfieldwrapper/formfieldwrapper.component.js"
23515
23668
  }
23516
23669
  },
23517
- {
23518
- "kind": "method",
23519
- "name": "renderRequiredLabel",
23520
- "privacy": "protected",
23521
- "inheritedFrom": {
23522
- "name": "FormfieldWrapper",
23523
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
23524
- }
23525
- },
23526
23670
  {
23527
23671
  "kind": "method",
23528
23672
  "name": "renderHelpTextIcon",
@@ -23706,12 +23850,13 @@
23706
23850
  }
23707
23851
  },
23708
23852
  {
23709
- "name": "required-label",
23853
+ "name": "required",
23710
23854
  "type": {
23711
- "text": "string | undefined"
23855
+ "text": "boolean"
23712
23856
  },
23713
- "description": "The required label of the input field.\nWhen an appropriate string value is set,\nthe input field is marked as required and the label is appended with this text.",
23714
- "fieldName": "requiredLabel",
23857
+ "default": "false",
23858
+ "description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
23859
+ "fieldName": "required",
23715
23860
  "inheritedFrom": {
23716
23861
  "name": "FormfieldWrapper",
23717
23862
  "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
@@ -23866,12 +24011,13 @@
23866
24011
  },
23867
24012
  {
23868
24013
  "kind": "field",
23869
- "name": "requiredLabel",
24014
+ "name": "required",
23870
24015
  "type": {
23871
- "text": "string | undefined"
24016
+ "text": "boolean"
23872
24017
  },
23873
- "description": "The required label of the input field.\nWhen an appropriate string value is set,\nthe input field is marked as required and the label is appended with this text.",
23874
- "attribute": "required-label",
24018
+ "default": "false",
24019
+ "description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
24020
+ "attribute": "required",
23875
24021
  "reflects": true,
23876
24022
  "inheritedFrom": {
23877
24023
  "name": "FormfieldWrapper",
@@ -23935,15 +24081,6 @@
23935
24081
  "module": "components/formfieldwrapper/formfieldwrapper.component.js"
23936
24082
  }
23937
24083
  },
23938
- {
23939
- "kind": "method",
23940
- "name": "renderRequiredLabel",
23941
- "privacy": "protected",
23942
- "inheritedFrom": {
23943
- "name": "FormfieldWrapper",
23944
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
23945
- }
23946
- },
23947
24084
  {
23948
24085
  "kind": "method",
23949
24086
  "name": "renderHelpTextIcon",
@@ -24054,12 +24191,13 @@
24054
24191
  }
24055
24192
  },
24056
24193
  {
24057
- "name": "required-label",
24194
+ "name": "required",
24058
24195
  "type": {
24059
- "text": "string | undefined"
24196
+ "text": "boolean"
24060
24197
  },
24061
- "description": "The required label of the input field.\nWhen an appropriate string value is set,\nthe input field is marked as required and the label is appended with this text.",
24062
- "fieldName": "requiredLabel",
24198
+ "default": "false",
24199
+ "description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
24200
+ "fieldName": "required",
24063
24201
  "inheritedFrom": {
24064
24202
  "name": "FormfieldWrapper",
24065
24203
  "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
@@ -24873,12 +25011,13 @@
24873
25011
  },
24874
25012
  {
24875
25013
  "kind": "field",
24876
- "name": "requiredLabel",
25014
+ "name": "required",
24877
25015
  "type": {
24878
- "text": "string | undefined"
25016
+ "text": "boolean"
24879
25017
  },
24880
- "description": "The required label of the input field.\nWhen an appropriate string value is set,\nthe input field is marked as required and the label is appended with this text.",
24881
- "attribute": "required-label",
25018
+ "default": "false",
25019
+ "description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
25020
+ "attribute": "required",
24882
25021
  "reflects": true,
24883
25022
  "inheritedFrom": {
24884
25023
  "name": "FormfieldWrapper",
@@ -24942,15 +25081,6 @@
24942
25081
  "module": "components/formfieldwrapper/formfieldwrapper.component.js"
24943
25082
  }
24944
25083
  },
24945
- {
24946
- "kind": "method",
24947
- "name": "renderRequiredLabel",
24948
- "privacy": "protected",
24949
- "inheritedFrom": {
24950
- "name": "FormfieldWrapper",
24951
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
24952
- }
24953
- },
24954
25084
  {
24955
25085
  "kind": "method",
24956
25086
  "name": "renderHelpTextIcon",
@@ -25285,12 +25415,13 @@
25285
25415
  }
25286
25416
  },
25287
25417
  {
25288
- "name": "required-label",
25418
+ "name": "required",
25289
25419
  "type": {
25290
- "text": "string | undefined"
25420
+ "text": "boolean"
25291
25421
  },
25292
- "description": "The required label of the input field.\nWhen an appropriate string value is set,\nthe input field is marked as required and the label is appended with this text.",
25293
- "fieldName": "requiredLabel",
25422
+ "default": "false",
25423
+ "description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
25424
+ "fieldName": "required",
25294
25425
  "inheritedFrom": {
25295
25426
  "name": "FormfieldWrapper",
25296
25427
  "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
@@ -25663,12 +25794,6 @@
25663
25794
  ],
25664
25795
  "description": "Sets the selected value based on the provided option element.\nIt retrieves the 'label' attribute of the option, if present,\notherwise it falls back to the option's text content."
25665
25796
  },
25666
- {
25667
- "kind": "method",
25668
- "name": "manageRequired",
25669
- "privacy": "private",
25670
- "description": "Manages the required state of the select.\nIf the value is not set and the requiredLabel property is set,\nthen the select is invalid."
25671
- },
25672
25797
  {
25673
25798
  "kind": "method",
25674
25799
  "name": "dispatchChange",
@@ -26046,12 +26171,13 @@
26046
26171
  },
26047
26172
  {
26048
26173
  "kind": "field",
26049
- "name": "requiredLabel",
26174
+ "name": "required",
26050
26175
  "type": {
26051
- "text": "string | undefined"
26176
+ "text": "boolean"
26052
26177
  },
26053
- "description": "The required label of the input field.\nWhen an appropriate string value is set,\nthe input field is marked as required and the label is appended with this text.",
26054
- "attribute": "required-label",
26178
+ "default": "false",
26179
+ "description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
26180
+ "attribute": "required",
26055
26181
  "reflects": true,
26056
26182
  "inheritedFrom": {
26057
26183
  "name": "FormfieldWrapper",
@@ -26115,15 +26241,6 @@
26115
26241
  "module": "components/formfieldwrapper/formfieldwrapper.component.js"
26116
26242
  }
26117
26243
  },
26118
- {
26119
- "kind": "method",
26120
- "name": "renderRequiredLabel",
26121
- "privacy": "protected",
26122
- "inheritedFrom": {
26123
- "name": "FormfieldWrapper",
26124
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
26125
- }
26126
- },
26127
26244
  {
26128
26245
  "kind": "method",
26129
26246
  "name": "renderHelpTextIcon",
@@ -26314,12 +26431,13 @@
26314
26431
  }
26315
26432
  },
26316
26433
  {
26317
- "name": "required-label",
26434
+ "name": "required",
26318
26435
  "type": {
26319
- "text": "string | undefined"
26436
+ "text": "boolean"
26320
26437
  },
26321
- "description": "The required label of the input field.\nWhen an appropriate string value is set,\nthe input field is marked as required and the label is appended with this text.",
26322
- "fieldName": "requiredLabel",
26438
+ "default": "false",
26439
+ "description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
26440
+ "fieldName": "required",
26323
26441
  "inheritedFrom": {
26324
26442
  "name": "FormfieldWrapper",
26325
26443
  "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
@@ -27957,7 +28075,7 @@
27957
28075
  "declarations": [
27958
28076
  {
27959
28077
  "kind": "class",
27960
- "description": "mdc-textarea component, which is used to get the multi-line text input from the user.\nIt contains:\n- label: It is the title of the textarea field.\n- required-label: A string depicting that the textarea field is required.\n- Textarea: It is the multi-line text input field.\n- helper-text: It is the text that provides additional information about the textarea field.\n- max-character-limit: It is the text that shows the character count of the textarea field.\n- Error, Warning, Success, Priority Help Text type: It is the text that provides additional information\n about the textarea field based on the validation state.\n- limitexceeded: It is the event that is dispatched when the character limit exceeds or restored.\n This event exposes 3 properties:\n - currentCharacterCount - the current number of characters in the textarea field,\n - maxCharacterLimit - the maximum number of characters allowed in the textarea field,\n - value - the current value of the textarea field,\n\n**Note**: Consumers must set the help-text-type with 'error' and\nhelp-text attribute with the error message using limitexceeded event.\nThe same help-text value will be used for the validation message to be displayed.",
28078
+ "description": "mdc-textarea component, which is used to get the multi-line text input from the user.\nIt contains:\n- label: It is the title of the textarea field.\n- required: A boolean attribute depicting that the textarea field is required.\n- Textarea: It is the multi-line text input field.\n- helper-text: It is the text that provides additional information about the textarea field.\n- max-character-limit: It is the text that shows the character count of the textarea field.\n- Error, Warning, Success, Priority Help Text type: It is the text that provides additional information\n about the textarea field based on the validation state.\n- limitexceeded: It is the event that is dispatched when the character limit exceeds or restored.\n This event exposes 3 properties:\n - currentCharacterCount - the current number of characters in the textarea field,\n - maxCharacterLimit - the maximum number of characters allowed in the textarea field,\n - value - the current value of the textarea field,\n\n**Note**: Consumers must set the help-text-type with 'error' and\nhelp-text attribute with the error message using limitexceeded event.\nThe same help-text value will be used for the validation message to be displayed.",
27961
28079
  "name": "Textarea",
27962
28080
  "cssProperties": [
27963
28081
  {
@@ -28364,12 +28482,13 @@
28364
28482
  },
28365
28483
  {
28366
28484
  "kind": "field",
28367
- "name": "requiredLabel",
28485
+ "name": "required",
28368
28486
  "type": {
28369
- "text": "string | undefined"
28487
+ "text": "boolean"
28370
28488
  },
28371
- "description": "The required label of the input field.\nWhen an appropriate string value is set,\nthe input field is marked as required and the label is appended with this text.",
28372
- "attribute": "required-label",
28489
+ "default": "false",
28490
+ "description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
28491
+ "attribute": "required",
28373
28492
  "reflects": true,
28374
28493
  "inheritedFrom": {
28375
28494
  "name": "FormfieldWrapper",
@@ -28433,15 +28552,6 @@
28433
28552
  "module": "components/formfieldwrapper/formfieldwrapper.component.js"
28434
28553
  }
28435
28554
  },
28436
- {
28437
- "kind": "method",
28438
- "name": "renderRequiredLabel",
28439
- "privacy": "protected",
28440
- "inheritedFrom": {
28441
- "name": "FormfieldWrapper",
28442
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
28443
- }
28444
- },
28445
28555
  {
28446
28556
  "kind": "method",
28447
28557
  "name": "renderHelpTextIcon",
@@ -28713,12 +28823,13 @@
28713
28823
  }
28714
28824
  },
28715
28825
  {
28716
- "name": "required-label",
28826
+ "name": "required",
28717
28827
  "type": {
28718
- "text": "string | undefined"
28828
+ "text": "boolean"
28719
28829
  },
28720
- "description": "The required label of the input field.\nWhen an appropriate string value is set,\nthe input field is marked as required and the label is appended with this text.",
28721
- "fieldName": "requiredLabel",
28830
+ "default": "false",
28831
+ "description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
28832
+ "fieldName": "required",
28722
28833
  "inheritedFrom": {
28723
28834
  "name": "FormfieldWrapper",
28724
28835
  "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
@@ -28777,7 +28888,7 @@
28777
28888
  "module": "/src/components/formfieldwrapper"
28778
28889
  },
28779
28890
  "tagName": "mdc-textarea",
28780
- "jsDoc": "/**\n * mdc-textarea component, which is used to get the multi-line text input from the user.\n * It contains:\n * - label: It is the title of the textarea field.\n * - required-label: A string depicting that the textarea field is required.\n * - Textarea: It is the multi-line text input field.\n * - helper-text: It is the text that provides additional information about the textarea field.\n * - max-character-limit: It is the text that shows the character count of the textarea field.\n * - Error, Warning, Success, Priority Help Text type: It is the text that provides additional information\n * about the textarea field based on the validation state.\n * - limitexceeded: It is the event that is dispatched when the character limit exceeds or restored.\n * This event exposes 3 properties:\n * - currentCharacterCount - the current number of characters in the textarea field,\n * - maxCharacterLimit - the maximum number of characters allowed in the textarea field,\n * - value - the current value of the textarea field,\n *\n * **Note**: Consumers must set the help-text-type with 'error' and\n * help-text attribute with the error message using limitexceeded event.\n * The same help-text value will be used for the validation message to be displayed.\n *\n * @tagname mdc-textarea\n *\n * @event input - (React: onInput) This event is dispatched when the value of the textarea field changes (every press).\n * @event change - (React: onChange) This event is dispatched when the value of the textarea field changes (on blur).\n * @event focus - (React: onFocus) This event is dispatched when the textarea receives focus.\n * @event blur - (React: onBlur) This event is dispatched when the textarea loses focus.\n * @event limitexceeded - (React: onLimitExceeded) This event is dispatched once when the character limit\n * exceeds or restored.\n *\n *\n * @dependency mdc-icon\n * @dependency mdc-text\n * @dependency mdc-button\n *\n * @cssproperty --mdc-textarea-disabled-border-color - Border color for the textarea container when disabled\n * @cssproperty --mdc-textarea-disabled-text-color - Text color for the textarea field when disabled\n * @cssproperty --mdc-textarea-disabled-background-color - Background color for the textarea field when disabled\n * @cssproperty --mdc-textarea-text-color - Text color for the textarea field\n * @cssproperty --mdc-textarea-background-color - Background color for the textarea field\n * @cssproperty --mdc-textarea-border-color - Border color for the textarea field\n * @cssproperty --mdc-textarea-text-secondary-normal - Text color for the character counter\n * @cssproperty --mdc-textarea-error-border-color - Border color for the error related help text\n * @cssproperty --mdc-textarea-warning-border-color - Border color for the warning related help text\n * @cssproperty --mdc-textarea-success-border-color - Border color for the success related help text\n * @cssproperty --mdc-textarea-primary-border-color - Border color for the priority related help text\n * @cssproperty --mdc-textarea-hover-background-color - Background color for the textarea container when hover\n * @cssproperty --mdc-textarea-focused-background-color - Background color for the textarea container when focused\n * @cssproperty --mdc-textarea-focused-border-color - Border color for the textarea container when focused\n */",
28891
+ "jsDoc": "/**\n * mdc-textarea component, which is used to get the multi-line text input from the user.\n * It contains:\n * - label: It is the title of the textarea field.\n * - required: A boolean attribute depicting that the textarea field is required.\n * - Textarea: It is the multi-line text input field.\n * - helper-text: It is the text that provides additional information about the textarea field.\n * - max-character-limit: It is the text that shows the character count of the textarea field.\n * - Error, Warning, Success, Priority Help Text type: It is the text that provides additional information\n * about the textarea field based on the validation state.\n * - limitexceeded: It is the event that is dispatched when the character limit exceeds or restored.\n * This event exposes 3 properties:\n * - currentCharacterCount - the current number of characters in the textarea field,\n * - maxCharacterLimit - the maximum number of characters allowed in the textarea field,\n * - value - the current value of the textarea field,\n *\n * **Note**: Consumers must set the help-text-type with 'error' and\n * help-text attribute with the error message using limitexceeded event.\n * The same help-text value will be used for the validation message to be displayed.\n *\n * @tagname mdc-textarea\n *\n * @event input - (React: onInput) This event is dispatched when the value of the textarea field changes (every press).\n * @event change - (React: onChange) This event is dispatched when the value of the textarea field changes (on blur).\n * @event focus - (React: onFocus) This event is dispatched when the textarea receives focus.\n * @event blur - (React: onBlur) This event is dispatched when the textarea loses focus.\n * @event limitexceeded - (React: onLimitExceeded) This event is dispatched once when the character limit\n * exceeds or restored.\n *\n *\n * @dependency mdc-icon\n * @dependency mdc-text\n * @dependency mdc-button\n *\n * @cssproperty --mdc-textarea-disabled-border-color - Border color for the textarea container when disabled\n * @cssproperty --mdc-textarea-disabled-text-color - Text color for the textarea field when disabled\n * @cssproperty --mdc-textarea-disabled-background-color - Background color for the textarea field when disabled\n * @cssproperty --mdc-textarea-text-color - Text color for the textarea field\n * @cssproperty --mdc-textarea-background-color - Background color for the textarea field\n * @cssproperty --mdc-textarea-border-color - Border color for the textarea field\n * @cssproperty --mdc-textarea-text-secondary-normal - Text color for the character counter\n * @cssproperty --mdc-textarea-error-border-color - Border color for the error related help text\n * @cssproperty --mdc-textarea-warning-border-color - Border color for the warning related help text\n * @cssproperty --mdc-textarea-success-border-color - Border color for the success related help text\n * @cssproperty --mdc-textarea-primary-border-color - Border color for the priority related help text\n * @cssproperty --mdc-textarea-hover-background-color - Background color for the textarea container when hover\n * @cssproperty --mdc-textarea-focused-background-color - Background color for the textarea container when focused\n * @cssproperty --mdc-textarea-focused-border-color - Border color for the textarea container when focused\n */",
28781
28892
  "customElement": true,
28782
28893
  "slots": [
28783
28894
  {
@@ -29020,7 +29131,7 @@
29020
29131
  "kind": "method",
29021
29132
  "name": "manageRequired",
29022
29133
  "privacy": "private",
29023
- "description": "Manages the required state of the checkbox.\nIf the checkbox is not checked and the requiredLabel property is set, then the checkbox is invalid."
29134
+ "description": "Manages the required state of the checkbox.\nIf the checkbox is not checked and the required property is set, then the checkbox is invalid.\nIf the validationMessage is set, it will be used as the custom validity message.\nIf the validationMessage is not set, it will clear the custom validity message."
29024
29135
  },
29025
29136
  {
29026
29137
  "kind": "method",
@@ -29234,12 +29345,13 @@
29234
29345
  },
29235
29346
  {
29236
29347
  "kind": "field",
29237
- "name": "requiredLabel",
29348
+ "name": "required",
29238
29349
  "type": {
29239
- "text": "string | undefined"
29350
+ "text": "boolean"
29240
29351
  },
29241
- "description": "The required label of the input field.\nWhen an appropriate string value is set,\nthe input field is marked as required and the label is appended with this text.",
29242
- "attribute": "required-label",
29352
+ "default": "false",
29353
+ "description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
29354
+ "attribute": "required",
29243
29355
  "reflects": true,
29244
29356
  "inheritedFrom": {
29245
29357
  "name": "FormfieldWrapper",
@@ -29303,15 +29415,6 @@
29303
29415
  "module": "components/formfieldwrapper/formfieldwrapper.component.js"
29304
29416
  }
29305
29417
  },
29306
- {
29307
- "kind": "method",
29308
- "name": "renderRequiredLabel",
29309
- "privacy": "protected",
29310
- "inheritedFrom": {
29311
- "name": "FormfieldWrapper",
29312
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
29313
- }
29314
- },
29315
29418
  {
29316
29419
  "kind": "method",
29317
29420
  "name": "renderHelpTextIcon",
@@ -29495,12 +29598,13 @@
29495
29598
  }
29496
29599
  },
29497
29600
  {
29498
- "name": "required-label",
29601
+ "name": "required",
29499
29602
  "type": {
29500
- "text": "string | undefined"
29603
+ "text": "boolean"
29501
29604
  },
29502
- "description": "The required label of the input field.\nWhen an appropriate string value is set,\nthe input field is marked as required and the label is appended with this text.",
29503
- "fieldName": "requiredLabel",
29605
+ "default": "false",
29606
+ "description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
29607
+ "fieldName": "required",
29504
29608
  "inheritedFrom": {
29505
29609
  "name": "FormfieldWrapper",
29506
29610
  "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"