@momentum-design/components 0.95.6 → 0.95.8
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/browser/index.js +526 -320
- package/dist/browser/index.js.map +4 -4
- package/dist/components/buttonsimple/buttonsimple.component.js +5 -4
- package/dist/components/cardcheckbox/cardcheckbox.component.js +3 -2
- package/dist/components/cardradio/cardradio.component.js +3 -2
- package/dist/components/checkbox/checkbox.component.js +2 -1
- package/dist/components/input/input.component.js +2 -1
- package/dist/components/option/option.styles.js +2 -0
- package/dist/components/radio/radio.component.js +3 -2
- package/dist/components/searchfield/searchfield.component.js +3 -2
- package/dist/components/stepperconnector/index.d.ts +7 -0
- package/dist/components/stepperconnector/index.js +4 -0
- package/dist/components/stepperconnector/stepperconnector.component.d.ts +31 -0
- package/dist/components/stepperconnector/stepperconnector.component.js +60 -0
- package/dist/components/stepperconnector/stepperconnector.constants.d.ts +14 -0
- package/dist/components/stepperconnector/stepperconnector.constants.js +15 -0
- package/dist/components/stepperconnector/stepperconnector.styles.d.ts +2 -0
- package/dist/components/stepperconnector/stepperconnector.styles.js +38 -0
- package/dist/components/stepperconnector/stepperconnector.types.d.ts +5 -0
- package/dist/components/stepperconnector/stepperconnector.types.js +1 -0
- package/dist/components/stepperitem/index.d.ts +9 -0
- package/dist/components/stepperitem/index.js +6 -0
- package/dist/components/stepperitem/stepperitem.component.d.ts +107 -0
- package/dist/components/stepperitem/stepperitem.component.js +199 -0
- package/dist/components/stepperitem/stepperitem.constants.d.ts +22 -0
- package/dist/components/stepperitem/stepperitem.constants.js +23 -0
- package/dist/components/stepperitem/stepperitem.styles.d.ts +2 -0
- package/dist/components/stepperitem/stepperitem.styles.js +157 -0
- package/dist/components/stepperitem/stepperitem.types.d.ts +11 -0
- package/dist/components/stepperitem/stepperitem.types.js +1 -0
- package/dist/components/toggle/toggle.component.js +2 -1
- package/dist/custom-elements.json +1112 -727
- package/dist/index.d.ts +3 -1
- package/dist/index.js +3 -1
- package/dist/react/index.d.ts +4 -2
- package/dist/react/index.js +4 -2
- package/dist/react/stepperconnector/index.d.ts +15 -0
- package/dist/react/stepperconnector/index.js +24 -0
- package/dist/react/stepperitem/index.d.ts +40 -0
- package/dist/react/stepperitem/index.js +48 -0
- package/dist/utils/keys.d.ts +12 -12
- package/package.json +1 -1
@@ -4,792 +4,792 @@
|
|
4
4
|
"modules": [
|
5
5
|
{
|
6
6
|
"kind": "javascript-module",
|
7
|
-
"path": "components/
|
7
|
+
"path": "components/animation/animation.component.js",
|
8
8
|
"declarations": [
|
9
9
|
{
|
10
10
|
"kind": "class",
|
11
|
-
"description": "mdc-
|
12
|
-
"name": "
|
13
|
-
"cssProperties": [
|
14
|
-
{
|
15
|
-
"description": "The color of the label text",
|
16
|
-
"name": "--mdc-chip-color"
|
17
|
-
},
|
18
|
-
{
|
19
|
-
"description": "The color of the icon",
|
20
|
-
"name": "--mdc-chip-icon-color"
|
21
|
-
},
|
22
|
-
{
|
23
|
-
"description": "The border color of the alertchip",
|
24
|
-
"name": "--mdc-chip-border-color"
|
25
|
-
},
|
26
|
-
{
|
27
|
-
"description": "The background color of the alertchip",
|
28
|
-
"name": "--mdc-chip-background-color"
|
29
|
-
}
|
30
|
-
],
|
31
|
-
"cssParts": [
|
32
|
-
{
|
33
|
-
"description": "The alert icon",
|
34
|
-
"name": "icon"
|
35
|
-
},
|
36
|
-
{
|
37
|
-
"description": "The text label of the alertchip",
|
38
|
-
"name": "label"
|
39
|
-
}
|
40
|
-
],
|
11
|
+
"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.",
|
12
|
+
"name": "Animation",
|
41
13
|
"members": [
|
42
14
|
{
|
43
15
|
"kind": "field",
|
44
|
-
"name": "
|
45
|
-
"type": {
|
46
|
-
"text": "VariantType"
|
47
|
-
},
|
48
|
-
"description": "The variant of the alertchip. It supports 5 variants\n- neutral\n- warning\n- error\n- success\n- informational",
|
49
|
-
"default": "neutral",
|
50
|
-
"attribute": "variant"
|
51
|
-
},
|
52
|
-
{
|
53
|
-
"kind": "field",
|
54
|
-
"name": "label",
|
55
|
-
"type": {
|
56
|
-
"text": "string"
|
57
|
-
},
|
58
|
-
"default": "''",
|
59
|
-
"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.",
|
60
|
-
"attribute": "label"
|
61
|
-
},
|
62
|
-
{
|
63
|
-
"kind": "field",
|
64
|
-
"name": "autofocus",
|
16
|
+
"name": "name",
|
65
17
|
"type": {
|
66
|
-
"text": "
|
18
|
+
"text": "AnimationNames | undefined"
|
67
19
|
},
|
68
|
-
"
|
69
|
-
"
|
70
|
-
"
|
71
|
-
"reflects": true,
|
72
|
-
"inheritedFrom": {
|
73
|
-
"name": "AutoFocusMixin",
|
74
|
-
"module": "utils/mixins/AutoFocusMixin.js"
|
75
|
-
}
|
20
|
+
"description": "Name of the animation (= filename)",
|
21
|
+
"attribute": "name",
|
22
|
+
"reflects": true
|
76
23
|
},
|
77
24
|
{
|
78
25
|
"kind": "field",
|
79
|
-
"name": "
|
26
|
+
"name": "loop",
|
80
27
|
"type": {
|
81
|
-
"text": "
|
28
|
+
"text": "LoopType | undefined"
|
82
29
|
},
|
83
|
-
"
|
84
|
-
"
|
85
|
-
"
|
86
|
-
"reflects": true,
|
87
|
-
"inheritedFrom": {
|
88
|
-
"name": "TabIndexMixin",
|
89
|
-
"module": "utils/mixins/TabIndexMixin.js"
|
90
|
-
}
|
30
|
+
"description": "How many times to loop the animation\n- \"true\" - infinite\n- \"false\" - no loop\n- number - number of times to loop",
|
31
|
+
"attribute": "loop",
|
32
|
+
"reflects": true
|
91
33
|
},
|
92
34
|
{
|
93
35
|
"kind": "field",
|
94
|
-
"name": "
|
36
|
+
"name": "autoplay",
|
95
37
|
"type": {
|
96
38
|
"text": "boolean | undefined"
|
97
39
|
},
|
98
|
-
"description": "
|
99
|
-
"
|
100
|
-
"
|
101
|
-
"reflects": true,
|
102
|
-
"inheritedFrom": {
|
103
|
-
"name": "DisabledMixin",
|
104
|
-
"module": "utils/mixins/DisabledMixin.js"
|
105
|
-
}
|
40
|
+
"description": "Weather start the animation automatically",
|
41
|
+
"attribute": "autoplay",
|
42
|
+
"reflects": true
|
106
43
|
},
|
107
44
|
{
|
108
45
|
"kind": "field",
|
109
|
-
"name": "
|
46
|
+
"name": "ariaLabel",
|
110
47
|
"type": {
|
111
|
-
"text": "
|
48
|
+
"text": "string | null"
|
112
49
|
},
|
113
|
-
"
|
114
|
-
"
|
115
|
-
"attribute": "
|
116
|
-
"reflects": true,
|
117
|
-
"inheritedFrom": {
|
118
|
-
"name": "Buttonsimple",
|
119
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
120
|
-
}
|
50
|
+
"default": "null",
|
51
|
+
"description": "Aria-label attribute to be set for accessibility",
|
52
|
+
"attribute": "aria-label"
|
121
53
|
},
|
122
54
|
{
|
123
55
|
"kind": "field",
|
124
|
-
"name": "
|
56
|
+
"name": "ariaLabelledBy",
|
125
57
|
"type": {
|
126
|
-
"text": "
|
58
|
+
"text": "string | null"
|
127
59
|
},
|
128
|
-
"
|
129
|
-
"
|
130
|
-
"attribute": "
|
131
|
-
"reflects": true,
|
132
|
-
"inheritedFrom": {
|
133
|
-
"name": "Buttonsimple",
|
134
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
135
|
-
}
|
60
|
+
"default": "null",
|
61
|
+
"description": "Aria-labelledby attribute to be set for accessibility",
|
62
|
+
"attribute": "aria-labelledby"
|
136
63
|
},
|
137
64
|
{
|
138
65
|
"kind": "field",
|
139
|
-
"name": "
|
66
|
+
"name": "lottieInstance",
|
140
67
|
"type": {
|
141
|
-
"text": "
|
68
|
+
"text": "AnimationItem | undefined"
|
142
69
|
},
|
143
|
-
"
|
144
|
-
"
|
145
|
-
"attribute": "size",
|
146
|
-
"reflects": true,
|
147
|
-
"inheritedFrom": {
|
148
|
-
"name": "Buttonsimple",
|
149
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
150
|
-
}
|
151
|
-
},
|
152
|
-
{
|
153
|
-
"kind": "field",
|
154
|
-
"name": "role",
|
155
|
-
"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.",
|
156
|
-
"default": "button",
|
157
|
-
"attribute": "role",
|
158
|
-
"reflects": true,
|
159
|
-
"inheritedFrom": {
|
160
|
-
"name": "Buttonsimple",
|
161
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
162
|
-
}
|
70
|
+
"privacy": "private",
|
71
|
+
"description": "Lottie animation instance"
|
163
72
|
},
|
164
73
|
{
|
165
74
|
"kind": "field",
|
166
|
-
"name": "
|
75
|
+
"name": "containerRef",
|
167
76
|
"type": {
|
168
|
-
"text": "
|
77
|
+
"text": "Ref<HTMLDivElement>"
|
169
78
|
},
|
170
|
-
"
|
171
|
-
"
|
172
|
-
"attribute": "ariaStateKey",
|
173
|
-
"reflects": true,
|
174
|
-
"inheritedFrom": {
|
175
|
-
"name": "Buttonsimple",
|
176
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
177
|
-
}
|
79
|
+
"privacy": "private",
|
80
|
+
"description": "Container for the animation"
|
178
81
|
},
|
179
82
|
{
|
180
83
|
"kind": "field",
|
181
|
-
"name": "
|
182
|
-
"
|
183
|
-
|
184
|
-
},
|
185
|
-
"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.",
|
186
|
-
"default": "button",
|
187
|
-
"attribute": "type",
|
188
|
-
"reflects": true,
|
189
|
-
"inheritedFrom": {
|
190
|
-
"name": "Buttonsimple",
|
191
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
192
|
-
}
|
84
|
+
"name": "animation",
|
85
|
+
"description": "Exposed API of the animation library (lottie)",
|
86
|
+
"readonly": true
|
193
87
|
},
|
194
88
|
{
|
195
89
|
"kind": "method",
|
196
|
-
"name": "
|
197
|
-
"privacy": "
|
198
|
-
"inheritedFrom": {
|
199
|
-
"name": "Buttonsimple",
|
200
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
201
|
-
}
|
90
|
+
"name": "getLoopValue",
|
91
|
+
"privacy": "private"
|
202
92
|
},
|
203
93
|
{
|
204
94
|
"kind": "method",
|
205
|
-
"name": "
|
206
|
-
"privacy": "
|
95
|
+
"name": "onLoadSuccessHandler",
|
96
|
+
"privacy": "private",
|
207
97
|
"parameters": [
|
208
98
|
{
|
209
|
-
"name": "
|
210
|
-
"type": {
|
211
|
-
"text": "HTMLElement"
|
212
|
-
},
|
213
|
-
"description": "The button element"
|
214
|
-
},
|
215
|
-
{
|
216
|
-
"name": "active",
|
217
|
-
"optional": true,
|
99
|
+
"name": "animationData",
|
218
100
|
"type": {
|
219
|
-
"text": "
|
220
|
-
}
|
221
|
-
"description": "The active state of the element"
|
101
|
+
"text": "any"
|
102
|
+
}
|
222
103
|
}
|
223
104
|
],
|
224
|
-
"description": "
|
225
|
-
"inheritedFrom": {
|
226
|
-
"name": "Buttonsimple",
|
227
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
228
|
-
}
|
105
|
+
"description": "Create new lotty instance for the loaded data"
|
229
106
|
},
|
230
107
|
{
|
231
108
|
"kind": "method",
|
232
|
-
"name": "
|
109
|
+
"name": "onLoadFailHandler",
|
233
110
|
"privacy": "private",
|
234
111
|
"parameters": [
|
235
112
|
{
|
236
|
-
"name": "
|
237
|
-
"type": {
|
238
|
-
"text": "HTMLElement"
|
239
|
-
},
|
240
|
-
"description": "The button element."
|
241
|
-
},
|
242
|
-
{
|
243
|
-
"name": "softDisabled",
|
244
|
-
"optional": true,
|
113
|
+
"name": "error",
|
245
114
|
"type": {
|
246
|
-
"text": "
|
247
|
-
}
|
248
|
-
"description": "The soft-disabled state."
|
115
|
+
"text": "Error"
|
116
|
+
}
|
249
117
|
}
|
250
118
|
],
|
251
|
-
"description": "
|
252
|
-
"inheritedFrom": {
|
253
|
-
"name": "Buttonsimple",
|
254
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
255
|
-
}
|
119
|
+
"description": "Error handler for animation loading"
|
256
120
|
},
|
257
121
|
{
|
258
122
|
"kind": "method",
|
259
|
-
"name": "
|
123
|
+
"name": "getAnimationData",
|
260
124
|
"privacy": "private",
|
261
|
-
"
|
262
|
-
{
|
263
|
-
"name": "element",
|
264
|
-
"type": {
|
265
|
-
"text": "HTMLElement"
|
266
|
-
},
|
267
|
-
"description": "The button element."
|
268
|
-
},
|
269
|
-
{
|
270
|
-
"name": "disabled",
|
271
|
-
"type": {
|
272
|
-
"text": "boolean"
|
273
|
-
},
|
274
|
-
"description": "The disabled state."
|
275
|
-
}
|
276
|
-
],
|
277
|
-
"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.",
|
278
|
-
"inheritedFrom": {
|
279
|
-
"name": "Buttonsimple",
|
280
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
281
|
-
}
|
125
|
+
"description": "Import animation data dynamically"
|
282
126
|
},
|
283
127
|
{
|
284
|
-
"kind": "
|
285
|
-
"name": "
|
286
|
-
"
|
287
|
-
|
288
|
-
|
289
|
-
|
290
|
-
}
|
291
|
-
},
|
128
|
+
"kind": "field",
|
129
|
+
"name": "onCompleteHandler",
|
130
|
+
"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."
|
131
|
+
}
|
132
|
+
],
|
133
|
+
"events": [
|
292
134
|
{
|
293
|
-
"
|
294
|
-
"
|
295
|
-
|
296
|
-
|
297
|
-
"
|
298
|
-
|
299
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
300
|
-
}
|
135
|
+
"name": "load",
|
136
|
+
"type": {
|
137
|
+
"text": "CustomEvent"
|
138
|
+
},
|
139
|
+
"description": "(React: onLoad) This event is dispatched when the animation is loaded",
|
140
|
+
"reactName": "onLoad"
|
301
141
|
},
|
302
142
|
{
|
303
|
-
"
|
304
|
-
"name": "
|
305
|
-
"
|
306
|
-
"parameters": [
|
307
|
-
{
|
308
|
-
"name": "event",
|
309
|
-
"type": {
|
310
|
-
"text": "KeyboardEvent"
|
311
|
-
},
|
312
|
-
"description": "The keyboard event."
|
313
|
-
}
|
314
|
-
],
|
315
|
-
"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.",
|
316
|
-
"inheritedFrom": {
|
317
|
-
"name": "Buttonsimple",
|
318
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
319
|
-
}
|
143
|
+
"description": "(React: onComplete) This event is dispatched when all animation loops completed",
|
144
|
+
"name": "complete",
|
145
|
+
"reactName": "onComplete"
|
320
146
|
},
|
321
147
|
{
|
322
|
-
"
|
323
|
-
"name": "
|
324
|
-
"
|
325
|
-
"parameters": [
|
326
|
-
{
|
327
|
-
"name": "event",
|
328
|
-
"type": {
|
329
|
-
"text": "KeyboardEvent"
|
330
|
-
},
|
331
|
-
"description": "The keyboard event."
|
332
|
-
}
|
333
|
-
],
|
334
|
-
"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.",
|
335
|
-
"inheritedFrom": {
|
336
|
-
"name": "Buttonsimple",
|
337
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
338
|
-
}
|
148
|
+
"description": "(React: onError) This event is dispatched when animation loading failed",
|
149
|
+
"name": "error",
|
150
|
+
"reactName": "onError"
|
339
151
|
}
|
340
152
|
],
|
341
153
|
"attributes": [
|
342
154
|
{
|
155
|
+
"name": "name",
|
156
|
+
"type": {
|
157
|
+
"text": "AnimationNames | undefined"
|
158
|
+
},
|
159
|
+
"description": "Name of the animation (= filename)",
|
160
|
+
"fieldName": "name"
|
161
|
+
},
|
162
|
+
{
|
163
|
+
"name": "loop",
|
164
|
+
"type": {
|
165
|
+
"text": "LoopType | undefined"
|
166
|
+
},
|
167
|
+
"description": "How many times to loop the animation\n- \"true\" - infinite\n- \"false\" - no loop\n- number - number of times to loop",
|
168
|
+
"fieldName": "loop"
|
169
|
+
},
|
170
|
+
{
|
171
|
+
"name": "autoplay",
|
172
|
+
"type": {
|
173
|
+
"text": "boolean | undefined"
|
174
|
+
},
|
175
|
+
"description": "Weather start the animation automatically",
|
176
|
+
"fieldName": "autoplay"
|
177
|
+
},
|
178
|
+
{
|
179
|
+
"name": "aria-label",
|
180
|
+
"type": {
|
181
|
+
"text": "string | null"
|
182
|
+
},
|
183
|
+
"default": "null",
|
184
|
+
"description": "Aria-label attribute to be set for accessibility",
|
185
|
+
"fieldName": "ariaLabel"
|
186
|
+
},
|
187
|
+
{
|
188
|
+
"name": "aria-labelledby",
|
189
|
+
"type": {
|
190
|
+
"text": "string | null"
|
191
|
+
},
|
192
|
+
"default": "null",
|
193
|
+
"description": "Aria-labelledby attribute to be set for accessibility",
|
194
|
+
"fieldName": "ariaLabelledBy"
|
195
|
+
}
|
196
|
+
],
|
197
|
+
"superclass": {
|
198
|
+
"name": "Component",
|
199
|
+
"module": "/src/models"
|
200
|
+
},
|
201
|
+
"tagName": "mdc-animation",
|
202
|
+
"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 */",
|
203
|
+
"customElement": true
|
204
|
+
}
|
205
|
+
],
|
206
|
+
"exports": [
|
207
|
+
{
|
208
|
+
"kind": "js",
|
209
|
+
"name": "default",
|
210
|
+
"declaration": {
|
211
|
+
"name": "Animation",
|
212
|
+
"module": "components/animation/animation.component.js"
|
213
|
+
}
|
214
|
+
}
|
215
|
+
]
|
216
|
+
},
|
217
|
+
{
|
218
|
+
"kind": "javascript-module",
|
219
|
+
"path": "components/appheader/appheader.component.js",
|
220
|
+
"declarations": [
|
221
|
+
{
|
222
|
+
"kind": "class",
|
223
|
+
"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**.",
|
224
|
+
"name": "Appheader",
|
225
|
+
"cssParts": [
|
226
|
+
{
|
227
|
+
"description": "The main container for styling the header.",
|
228
|
+
"name": "container"
|
229
|
+
},
|
230
|
+
{
|
231
|
+
"description": "The leading section of the header.",
|
232
|
+
"name": "leading-section"
|
233
|
+
},
|
234
|
+
{
|
235
|
+
"description": "The center section of the header.",
|
236
|
+
"name": "center-section"
|
237
|
+
},
|
238
|
+
{
|
239
|
+
"description": "The trailing section of the header.",
|
240
|
+
"name": "trailing-section"
|
241
|
+
}
|
242
|
+
],
|
243
|
+
"slots": [
|
244
|
+
{
|
245
|
+
"description": "Slot for the leading section (e.g., brand logo, brand name).",
|
246
|
+
"name": "leading"
|
247
|
+
},
|
248
|
+
{
|
249
|
+
"description": "Slot for the center section (e.g., search bar, icons).",
|
250
|
+
"name": "center"
|
251
|
+
},
|
252
|
+
{
|
253
|
+
"description": "Slot for the trailing section (e.g., profile avatar, icons).",
|
254
|
+
"name": "trailing"
|
255
|
+
}
|
256
|
+
],
|
257
|
+
"members": [],
|
258
|
+
"superclass": {
|
259
|
+
"name": "Component",
|
260
|
+
"module": "/src/models"
|
261
|
+
},
|
262
|
+
"tagName": "mdc-appheader",
|
263
|
+
"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 */",
|
264
|
+
"customElement": true
|
265
|
+
}
|
266
|
+
],
|
267
|
+
"exports": [
|
268
|
+
{
|
269
|
+
"kind": "js",
|
270
|
+
"name": "default",
|
271
|
+
"declaration": {
|
272
|
+
"name": "Appheader",
|
273
|
+
"module": "components/appheader/appheader.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"
|
290
|
+
},
|
291
|
+
{
|
292
|
+
"description": "The color of the icon",
|
293
|
+
"name": "--mdc-chip-icon-color"
|
294
|
+
},
|
295
|
+
{
|
296
|
+
"description": "The border color of the alertchip",
|
297
|
+
"name": "--mdc-chip-border-color"
|
298
|
+
},
|
299
|
+
{
|
300
|
+
"description": "The background color of the alertchip",
|
301
|
+
"name": "--mdc-chip-background-color"
|
302
|
+
}
|
303
|
+
],
|
304
|
+
"cssParts": [
|
305
|
+
{
|
306
|
+
"description": "The alert icon",
|
307
|
+
"name": "icon"
|
308
|
+
},
|
309
|
+
{
|
310
|
+
"description": "The text label of the alertchip",
|
311
|
+
"name": "label"
|
312
|
+
}
|
313
|
+
],
|
314
|
+
"members": [
|
315
|
+
{
|
316
|
+
"kind": "field",
|
343
317
|
"name": "variant",
|
344
318
|
"type": {
|
345
319
|
"text": "VariantType"
|
346
320
|
},
|
347
321
|
"description": "The variant of the alertchip. It supports 5 variants\n- neutral\n- warning\n- error\n- success\n- informational",
|
348
322
|
"default": "neutral",
|
349
|
-
"
|
323
|
+
"attribute": "variant"
|
350
324
|
},
|
351
325
|
{
|
326
|
+
"kind": "field",
|
352
327
|
"name": "label",
|
353
328
|
"type": {
|
354
329
|
"text": "string"
|
355
330
|
},
|
356
331
|
"default": "''",
|
357
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.",
|
358
|
-
"
|
333
|
+
"attribute": "label"
|
359
334
|
},
|
360
335
|
{
|
336
|
+
"kind": "field",
|
361
337
|
"name": "autofocus",
|
362
338
|
"type": {
|
363
339
|
"text": "boolean"
|
364
340
|
},
|
365
341
|
"default": "false",
|
366
342
|
"description": "This property indicates whether the element should receive focus automatically when it is rendered.",
|
367
|
-
"
|
343
|
+
"attribute": "autofocus",
|
344
|
+
"reflects": true,
|
368
345
|
"inheritedFrom": {
|
369
346
|
"name": "AutoFocusMixin",
|
370
|
-
"module": "
|
347
|
+
"module": "utils/mixins/AutoFocusMixin.js"
|
371
348
|
}
|
372
349
|
},
|
373
350
|
{
|
351
|
+
"kind": "field",
|
374
352
|
"name": "tabIndex",
|
375
353
|
"type": {
|
376
354
|
"text": "number"
|
377
355
|
},
|
378
356
|
"default": "0",
|
379
357
|
"description": "This property specifies the tab order of the element.",
|
380
|
-
"
|
358
|
+
"attribute": "tabIndex",
|
359
|
+
"reflects": true,
|
381
360
|
"inheritedFrom": {
|
382
361
|
"name": "TabIndexMixin",
|
383
|
-
"module": "
|
362
|
+
"module": "utils/mixins/TabIndexMixin.js"
|
384
363
|
}
|
385
364
|
},
|
386
365
|
{
|
366
|
+
"kind": "field",
|
387
367
|
"name": "disabled",
|
388
368
|
"type": {
|
389
369
|
"text": "boolean | undefined"
|
390
370
|
},
|
391
371
|
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
392
372
|
"default": "undefined",
|
393
|
-
"
|
373
|
+
"attribute": "disabled",
|
374
|
+
"reflects": true,
|
394
375
|
"inheritedFrom": {
|
395
376
|
"name": "DisabledMixin",
|
396
|
-
"module": "
|
377
|
+
"module": "utils/mixins/DisabledMixin.js"
|
397
378
|
}
|
398
379
|
},
|
399
380
|
{
|
381
|
+
"kind": "field",
|
400
382
|
"name": "active",
|
401
383
|
"type": {
|
402
384
|
"text": "boolean | undefined"
|
403
385
|
},
|
404
386
|
"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.",
|
405
387
|
"default": "undefined",
|
406
|
-
"
|
388
|
+
"attribute": "active",
|
389
|
+
"reflects": true,
|
407
390
|
"inheritedFrom": {
|
408
391
|
"name": "Buttonsimple",
|
409
|
-
"module": "
|
392
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
410
393
|
}
|
411
394
|
},
|
412
395
|
{
|
413
|
-
"
|
396
|
+
"kind": "field",
|
397
|
+
"name": "softDisabled",
|
414
398
|
"type": {
|
415
399
|
"text": "boolean | undefined"
|
416
400
|
},
|
417
401
|
"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.",
|
418
402
|
"default": "undefined",
|
419
|
-
"
|
403
|
+
"attribute": "soft-disabled",
|
404
|
+
"reflects": true,
|
420
405
|
"inheritedFrom": {
|
421
406
|
"name": "Buttonsimple",
|
422
|
-
"module": "
|
407
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
423
408
|
}
|
424
409
|
},
|
425
410
|
{
|
411
|
+
"kind": "field",
|
426
412
|
"name": "size",
|
427
413
|
"type": {
|
428
414
|
"text": "ButtonSize"
|
429
415
|
},
|
430
416
|
"description": "Simplebutton size is a super set of all the sizes supported by children components.",
|
431
417
|
"default": "32",
|
432
|
-
"
|
418
|
+
"attribute": "size",
|
419
|
+
"reflects": true,
|
433
420
|
"inheritedFrom": {
|
434
421
|
"name": "Buttonsimple",
|
435
|
-
"module": "
|
422
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
436
423
|
}
|
437
424
|
},
|
438
425
|
{
|
426
|
+
"kind": "field",
|
439
427
|
"name": "role",
|
440
428
|
"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.",
|
441
429
|
"default": "button",
|
442
|
-
"
|
430
|
+
"attribute": "role",
|
431
|
+
"reflects": true,
|
443
432
|
"inheritedFrom": {
|
444
433
|
"name": "Buttonsimple",
|
445
|
-
"module": "
|
434
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
446
435
|
}
|
447
436
|
},
|
448
437
|
{
|
438
|
+
"kind": "field",
|
449
439
|
"name": "ariaStateKey",
|
450
440
|
"type": {
|
451
441
|
"text": "string | undefined"
|
452
442
|
},
|
453
443
|
"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`",
|
454
444
|
"default": "'aria-pressed' (when)",
|
455
|
-
"
|
445
|
+
"attribute": "ariaStateKey",
|
446
|
+
"reflects": true,
|
456
447
|
"inheritedFrom": {
|
457
448
|
"name": "Buttonsimple",
|
458
|
-
"module": "
|
449
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
459
450
|
}
|
460
451
|
},
|
461
452
|
{
|
453
|
+
"kind": "field",
|
462
454
|
"name": "type",
|
463
455
|
"type": {
|
464
456
|
"text": "ButtonType"
|
465
457
|
},
|
466
458
|
"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.",
|
467
459
|
"default": "button",
|
468
|
-
"
|
469
|
-
"
|
470
|
-
"name": "Buttonsimple",
|
471
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
472
|
-
}
|
473
|
-
}
|
474
|
-
],
|
475
|
-
"superclass": {
|
476
|
-
"name": "Buttonsimple",
|
477
|
-
"module": "/src/components/buttonsimple/buttonsimple.component"
|
478
|
-
},
|
479
|
-
"tagName": "mdc-alertchip",
|
480
|
-
"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 * @csspart icon - The alert icon\n * @csspart label - The text label of the alertchip\n */",
|
481
|
-
"customElement": true,
|
482
|
-
"events": [
|
483
|
-
{
|
484
|
-
"description": "(React: onClick) This event is dispatched when the button is clicked.",
|
485
|
-
"name": "click",
|
486
|
-
"reactName": "onClick",
|
460
|
+
"attribute": "type",
|
461
|
+
"reflects": true,
|
487
462
|
"inheritedFrom": {
|
488
463
|
"name": "Buttonsimple",
|
489
|
-
"module": "
|
464
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
490
465
|
}
|
491
466
|
},
|
492
467
|
{
|
493
|
-
"
|
494
|
-
"name": "
|
495
|
-
"
|
468
|
+
"kind": "method",
|
469
|
+
"name": "executeAction",
|
470
|
+
"privacy": "protected",
|
496
471
|
"inheritedFrom": {
|
497
472
|
"name": "Buttonsimple",
|
498
|
-
"module": "
|
473
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
499
474
|
}
|
500
475
|
},
|
501
476
|
{
|
502
|
-
"
|
503
|
-
"name": "
|
504
|
-
"
|
477
|
+
"kind": "method",
|
478
|
+
"name": "setActive",
|
479
|
+
"privacy": "protected",
|
480
|
+
"parameters": [
|
481
|
+
{
|
482
|
+
"name": "element",
|
483
|
+
"type": {
|
484
|
+
"text": "HTMLElement"
|
485
|
+
},
|
486
|
+
"description": "The button element"
|
487
|
+
},
|
488
|
+
{
|
489
|
+
"name": "active",
|
490
|
+
"optional": true,
|
491
|
+
"type": {
|
492
|
+
"text": "boolean"
|
493
|
+
},
|
494
|
+
"description": "The active state of the element"
|
495
|
+
}
|
496
|
+
],
|
497
|
+
"description": "Sets the ariaStateKey attributes based on the active state of the button.",
|
505
498
|
"inheritedFrom": {
|
506
499
|
"name": "Buttonsimple",
|
507
|
-
"module": "
|
500
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
508
501
|
}
|
509
502
|
},
|
510
503
|
{
|
511
|
-
"
|
512
|
-
"name": "
|
513
|
-
"
|
504
|
+
"kind": "method",
|
505
|
+
"name": "setSoftDisabled",
|
506
|
+
"privacy": "private",
|
507
|
+
"parameters": [
|
508
|
+
{
|
509
|
+
"name": "element",
|
510
|
+
"type": {
|
511
|
+
"text": "HTMLElement"
|
512
|
+
},
|
513
|
+
"description": "The button element."
|
514
|
+
},
|
515
|
+
{
|
516
|
+
"name": "softDisabled",
|
517
|
+
"optional": true,
|
518
|
+
"type": {
|
519
|
+
"text": "boolean"
|
520
|
+
},
|
521
|
+
"description": "The soft-disabled state."
|
522
|
+
}
|
523
|
+
],
|
524
|
+
"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.",
|
514
525
|
"inheritedFrom": {
|
515
526
|
"name": "Buttonsimple",
|
516
|
-
"module": "
|
517
|
-
}
|
518
|
-
}
|
519
|
-
|
520
|
-
|
521
|
-
|
522
|
-
"exports": [
|
523
|
-
{
|
524
|
-
"kind": "js",
|
525
|
-
"name": "default",
|
526
|
-
"declaration": {
|
527
|
-
"name": "AlertChip",
|
528
|
-
"module": "components/alertchip/alertchip.component.js"
|
529
|
-
}
|
530
|
-
}
|
531
|
-
]
|
532
|
-
},
|
533
|
-
{
|
534
|
-
"kind": "javascript-module",
|
535
|
-
"path": "components/animation/animation.component.js",
|
536
|
-
"declarations": [
|
537
|
-
{
|
538
|
-
"kind": "class",
|
539
|
-
"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.",
|
540
|
-
"name": "Animation",
|
541
|
-
"members": [
|
542
|
-
{
|
543
|
-
"kind": "field",
|
544
|
-
"name": "name",
|
545
|
-
"type": {
|
546
|
-
"text": "AnimationNames | undefined"
|
547
|
-
},
|
548
|
-
"description": "Name of the animation (= filename)",
|
549
|
-
"attribute": "name",
|
550
|
-
"reflects": true
|
551
|
-
},
|
552
|
-
{
|
553
|
-
"kind": "field",
|
554
|
-
"name": "loop",
|
555
|
-
"type": {
|
556
|
-
"text": "LoopType | undefined"
|
557
|
-
},
|
558
|
-
"description": "How many times to loop the animation\n- \"true\" - infinite\n- \"false\" - no loop\n- number - number of times to loop",
|
559
|
-
"attribute": "loop",
|
560
|
-
"reflects": true
|
561
|
-
},
|
562
|
-
{
|
563
|
-
"kind": "field",
|
564
|
-
"name": "autoplay",
|
565
|
-
"type": {
|
566
|
-
"text": "boolean | undefined"
|
567
|
-
},
|
568
|
-
"description": "Weather start the animation automatically",
|
569
|
-
"attribute": "autoplay",
|
570
|
-
"reflects": true
|
571
|
-
},
|
572
|
-
{
|
573
|
-
"kind": "field",
|
574
|
-
"name": "ariaLabel",
|
575
|
-
"type": {
|
576
|
-
"text": "string | null"
|
577
|
-
},
|
578
|
-
"default": "null",
|
579
|
-
"description": "Aria-label attribute to be set for accessibility",
|
580
|
-
"attribute": "aria-label"
|
581
|
-
},
|
582
|
-
{
|
583
|
-
"kind": "field",
|
584
|
-
"name": "ariaLabelledBy",
|
585
|
-
"type": {
|
586
|
-
"text": "string | null"
|
587
|
-
},
|
588
|
-
"default": "null",
|
589
|
-
"description": "Aria-labelledby attribute to be set for accessibility",
|
590
|
-
"attribute": "aria-labelledby"
|
591
|
-
},
|
592
|
-
{
|
593
|
-
"kind": "field",
|
594
|
-
"name": "lottieInstance",
|
595
|
-
"type": {
|
596
|
-
"text": "AnimationItem | undefined"
|
597
|
-
},
|
598
|
-
"privacy": "private",
|
599
|
-
"description": "Lottie animation instance"
|
600
|
-
},
|
601
|
-
{
|
602
|
-
"kind": "field",
|
603
|
-
"name": "containerRef",
|
604
|
-
"type": {
|
605
|
-
"text": "Ref<HTMLDivElement>"
|
606
|
-
},
|
527
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
528
|
+
}
|
529
|
+
},
|
530
|
+
{
|
531
|
+
"kind": "method",
|
532
|
+
"name": "setDisabled",
|
607
533
|
"privacy": "private",
|
608
|
-
"
|
534
|
+
"parameters": [
|
535
|
+
{
|
536
|
+
"name": "element",
|
537
|
+
"type": {
|
538
|
+
"text": "HTMLElement"
|
539
|
+
},
|
540
|
+
"description": "The button element."
|
541
|
+
},
|
542
|
+
{
|
543
|
+
"name": "disabled",
|
544
|
+
"type": {
|
545
|
+
"text": "boolean"
|
546
|
+
},
|
547
|
+
"description": "The disabled state."
|
548
|
+
}
|
549
|
+
],
|
550
|
+
"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.",
|
551
|
+
"inheritedFrom": {
|
552
|
+
"name": "Buttonsimple",
|
553
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
554
|
+
}
|
609
555
|
},
|
610
556
|
{
|
611
|
-
"kind": "
|
612
|
-
"name": "
|
613
|
-
"
|
614
|
-
"
|
557
|
+
"kind": "method",
|
558
|
+
"name": "triggerClickEvent",
|
559
|
+
"privacy": "private",
|
560
|
+
"inheritedFrom": {
|
561
|
+
"name": "Buttonsimple",
|
562
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
563
|
+
}
|
615
564
|
},
|
616
565
|
{
|
617
566
|
"kind": "method",
|
618
|
-
"name": "
|
619
|
-
"privacy": "private"
|
567
|
+
"name": "handleBlur",
|
568
|
+
"privacy": "private",
|
569
|
+
"description": "In case the button is pressed and the focus is lost while pressing,\nthe pressed class is removed.",
|
570
|
+
"inheritedFrom": {
|
571
|
+
"name": "Buttonsimple",
|
572
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
573
|
+
}
|
620
574
|
},
|
621
575
|
{
|
622
576
|
"kind": "method",
|
623
|
-
"name": "
|
577
|
+
"name": "handleKeyDown",
|
624
578
|
"privacy": "private",
|
625
579
|
"parameters": [
|
626
580
|
{
|
627
|
-
"name": "
|
581
|
+
"name": "event",
|
628
582
|
"type": {
|
629
|
-
"text": "
|
630
|
-
}
|
583
|
+
"text": "KeyboardEvent"
|
584
|
+
},
|
585
|
+
"description": "The keyboard event."
|
631
586
|
}
|
632
587
|
],
|
633
|
-
"description": "
|
588
|
+
"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.",
|
589
|
+
"inheritedFrom": {
|
590
|
+
"name": "Buttonsimple",
|
591
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
592
|
+
}
|
634
593
|
},
|
635
594
|
{
|
636
595
|
"kind": "method",
|
637
|
-
"name": "
|
596
|
+
"name": "handleKeyUp",
|
638
597
|
"privacy": "private",
|
639
598
|
"parameters": [
|
640
599
|
{
|
641
|
-
"name": "
|
600
|
+
"name": "event",
|
642
601
|
"type": {
|
643
|
-
"text": "
|
644
|
-
}
|
602
|
+
"text": "KeyboardEvent"
|
603
|
+
},
|
604
|
+
"description": "The keyboard event."
|
645
605
|
}
|
646
606
|
],
|
647
|
-
"description": "
|
648
|
-
|
649
|
-
|
650
|
-
|
651
|
-
|
652
|
-
"privacy": "private",
|
653
|
-
"description": "Import animation data dynamically"
|
654
|
-
},
|
655
|
-
{
|
656
|
-
"kind": "field",
|
657
|
-
"name": "onCompleteHandler",
|
658
|
-
"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."
|
607
|
+
"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.",
|
608
|
+
"inheritedFrom": {
|
609
|
+
"name": "Buttonsimple",
|
610
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
611
|
+
}
|
659
612
|
}
|
660
613
|
],
|
661
|
-
"
|
614
|
+
"attributes": [
|
662
615
|
{
|
663
|
-
"name": "
|
616
|
+
"name": "variant",
|
664
617
|
"type": {
|
665
|
-
"text": "
|
618
|
+
"text": "VariantType"
|
666
619
|
},
|
667
|
-
"description": "
|
668
|
-
"
|
620
|
+
"description": "The variant of the alertchip. It supports 5 variants\n- neutral\n- warning\n- error\n- success\n- informational",
|
621
|
+
"default": "neutral",
|
622
|
+
"fieldName": "variant"
|
669
623
|
},
|
670
624
|
{
|
671
|
-
"
|
672
|
-
"
|
673
|
-
|
625
|
+
"name": "label",
|
626
|
+
"type": {
|
627
|
+
"text": "string"
|
628
|
+
},
|
629
|
+
"default": "''",
|
630
|
+
"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.",
|
631
|
+
"fieldName": "label"
|
674
632
|
},
|
675
633
|
{
|
676
|
-
"
|
677
|
-
"name": "error",
|
678
|
-
"reactName": "onError"
|
679
|
-
}
|
680
|
-
],
|
681
|
-
"attributes": [
|
682
|
-
{
|
683
|
-
"name": "name",
|
634
|
+
"name": "autofocus",
|
684
635
|
"type": {
|
685
|
-
"text": "
|
636
|
+
"text": "boolean"
|
686
637
|
},
|
687
|
-
"
|
688
|
-
"
|
638
|
+
"default": "false",
|
639
|
+
"description": "This property indicates whether the element should receive focus automatically when it is rendered.",
|
640
|
+
"fieldName": "autofocus",
|
641
|
+
"inheritedFrom": {
|
642
|
+
"name": "AutoFocusMixin",
|
643
|
+
"module": "src/utils/mixins/AutoFocusMixin.ts"
|
644
|
+
}
|
689
645
|
},
|
690
646
|
{
|
691
|
-
"name": "
|
647
|
+
"name": "tabIndex",
|
692
648
|
"type": {
|
693
|
-
"text": "
|
649
|
+
"text": "number"
|
694
650
|
},
|
695
|
-
"
|
696
|
-
"
|
651
|
+
"default": "0",
|
652
|
+
"description": "This property specifies the tab order of the element.",
|
653
|
+
"fieldName": "tabIndex",
|
654
|
+
"inheritedFrom": {
|
655
|
+
"name": "TabIndexMixin",
|
656
|
+
"module": "src/utils/mixins/TabIndexMixin.ts"
|
657
|
+
}
|
697
658
|
},
|
698
659
|
{
|
699
|
-
"name": "
|
660
|
+
"name": "disabled",
|
700
661
|
"type": {
|
701
662
|
"text": "boolean | undefined"
|
702
663
|
},
|
703
|
-
"description": "
|
704
|
-
"
|
664
|
+
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
665
|
+
"default": "undefined",
|
666
|
+
"fieldName": "disabled",
|
667
|
+
"inheritedFrom": {
|
668
|
+
"name": "DisabledMixin",
|
669
|
+
"module": "src/utils/mixins/DisabledMixin.ts"
|
670
|
+
}
|
705
671
|
},
|
706
672
|
{
|
707
|
-
"name": "
|
673
|
+
"name": "active",
|
708
674
|
"type": {
|
709
|
-
"text": "
|
675
|
+
"text": "boolean | undefined"
|
710
676
|
},
|
711
|
-
"
|
712
|
-
"
|
713
|
-
"fieldName": "
|
677
|
+
"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.",
|
678
|
+
"default": "undefined",
|
679
|
+
"fieldName": "active",
|
680
|
+
"inheritedFrom": {
|
681
|
+
"name": "Buttonsimple",
|
682
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
683
|
+
}
|
714
684
|
},
|
715
685
|
{
|
716
|
-
"name": "
|
686
|
+
"name": "soft-disabled",
|
717
687
|
"type": {
|
718
|
-
"text": "
|
688
|
+
"text": "boolean | undefined"
|
719
689
|
},
|
720
|
-
"
|
721
|
-
"
|
722
|
-
"fieldName": "
|
723
|
-
|
724
|
-
|
725
|
-
|
726
|
-
|
727
|
-
|
728
|
-
},
|
729
|
-
"tagName": "mdc-animation",
|
730
|
-
"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 */",
|
731
|
-
"customElement": true
|
732
|
-
}
|
733
|
-
],
|
734
|
-
"exports": [
|
735
|
-
{
|
736
|
-
"kind": "js",
|
737
|
-
"name": "default",
|
738
|
-
"declaration": {
|
739
|
-
"name": "Animation",
|
740
|
-
"module": "components/animation/animation.component.js"
|
741
|
-
}
|
742
|
-
}
|
743
|
-
]
|
744
|
-
},
|
745
|
-
{
|
746
|
-
"kind": "javascript-module",
|
747
|
-
"path": "components/appheader/appheader.component.js",
|
748
|
-
"declarations": [
|
749
|
-
{
|
750
|
-
"kind": "class",
|
751
|
-
"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**.",
|
752
|
-
"name": "Appheader",
|
753
|
-
"cssParts": [
|
690
|
+
"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.",
|
691
|
+
"default": "undefined",
|
692
|
+
"fieldName": "softDisabled",
|
693
|
+
"inheritedFrom": {
|
694
|
+
"name": "Buttonsimple",
|
695
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
696
|
+
}
|
697
|
+
},
|
754
698
|
{
|
755
|
-
"
|
756
|
-
"
|
699
|
+
"name": "size",
|
700
|
+
"type": {
|
701
|
+
"text": "ButtonSize"
|
702
|
+
},
|
703
|
+
"description": "Simplebutton size is a super set of all the sizes supported by children components.",
|
704
|
+
"default": "32",
|
705
|
+
"fieldName": "size",
|
706
|
+
"inheritedFrom": {
|
707
|
+
"name": "Buttonsimple",
|
708
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
709
|
+
}
|
757
710
|
},
|
758
711
|
{
|
759
|
-
"
|
760
|
-
"
|
712
|
+
"name": "role",
|
713
|
+
"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.",
|
714
|
+
"default": "button",
|
715
|
+
"fieldName": "role",
|
716
|
+
"inheritedFrom": {
|
717
|
+
"name": "Buttonsimple",
|
718
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
719
|
+
}
|
761
720
|
},
|
762
721
|
{
|
763
|
-
"
|
764
|
-
"
|
722
|
+
"name": "ariaStateKey",
|
723
|
+
"type": {
|
724
|
+
"text": "string | undefined"
|
725
|
+
},
|
726
|
+
"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`",
|
727
|
+
"default": "'aria-pressed' (when)",
|
728
|
+
"fieldName": "ariaStateKey",
|
729
|
+
"inheritedFrom": {
|
730
|
+
"name": "Buttonsimple",
|
731
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
732
|
+
}
|
765
733
|
},
|
766
734
|
{
|
767
|
-
"
|
768
|
-
"
|
735
|
+
"name": "type",
|
736
|
+
"type": {
|
737
|
+
"text": "ButtonType"
|
738
|
+
},
|
739
|
+
"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.",
|
740
|
+
"default": "button",
|
741
|
+
"fieldName": "type",
|
742
|
+
"inheritedFrom": {
|
743
|
+
"name": "Buttonsimple",
|
744
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
745
|
+
}
|
769
746
|
}
|
770
747
|
],
|
771
|
-
"
|
748
|
+
"superclass": {
|
749
|
+
"name": "Buttonsimple",
|
750
|
+
"module": "/src/components/buttonsimple/buttonsimple.component"
|
751
|
+
},
|
752
|
+
"tagName": "mdc-alertchip",
|
753
|
+
"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 * @csspart icon - The alert icon\n * @csspart label - The text label of the alertchip\n */",
|
754
|
+
"customElement": true,
|
755
|
+
"events": [
|
772
756
|
{
|
773
|
-
"description": "
|
774
|
-
"name": "
|
757
|
+
"description": "(React: onClick) This event is dispatched when the button is clicked.",
|
758
|
+
"name": "click",
|
759
|
+
"reactName": "onClick",
|
760
|
+
"inheritedFrom": {
|
761
|
+
"name": "Buttonsimple",
|
762
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
763
|
+
}
|
775
764
|
},
|
776
765
|
{
|
777
|
-
"description": "
|
778
|
-
"name": "
|
766
|
+
"description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the button.",
|
767
|
+
"name": "keydown",
|
768
|
+
"reactName": "onKeyDown",
|
769
|
+
"inheritedFrom": {
|
770
|
+
"name": "Buttonsimple",
|
771
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
772
|
+
}
|
779
773
|
},
|
780
774
|
{
|
781
|
-
"description": "
|
782
|
-
"name": "
|
775
|
+
"description": "(React: onKeyUp) This event is dispatched when a key is released on the button.",
|
776
|
+
"name": "keyup",
|
777
|
+
"reactName": "onKeyUp",
|
778
|
+
"inheritedFrom": {
|
779
|
+
"name": "Buttonsimple",
|
780
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
781
|
+
}
|
782
|
+
},
|
783
|
+
{
|
784
|
+
"description": "(React: onFocus) This event is dispatched when the button receives focus.",
|
785
|
+
"name": "focus",
|
786
|
+
"reactName": "onFocus",
|
787
|
+
"inheritedFrom": {
|
788
|
+
"name": "Buttonsimple",
|
789
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
790
|
+
}
|
783
791
|
}
|
784
|
-
]
|
785
|
-
"members": [],
|
786
|
-
"superclass": {
|
787
|
-
"name": "Component",
|
788
|
-
"module": "/src/models"
|
789
|
-
},
|
790
|
-
"tagName": "mdc-appheader",
|
791
|
-
"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 */",
|
792
|
-
"customElement": true
|
792
|
+
]
|
793
793
|
}
|
794
794
|
],
|
795
795
|
"exports": [
|
@@ -797,8 +797,8 @@
|
|
797
797
|
"kind": "js",
|
798
798
|
"name": "default",
|
799
799
|
"declaration": {
|
800
|
-
"name": "
|
801
|
-
"module": "components/
|
800
|
+
"name": "AlertChip",
|
801
|
+
"module": "components/alertchip/alertchip.component.js"
|
802
802
|
}
|
803
803
|
}
|
804
804
|
]
|
@@ -2086,110 +2086,6 @@
|
|
2086
2086
|
}
|
2087
2087
|
]
|
2088
2088
|
},
|
2089
|
-
{
|
2090
|
-
"kind": "javascript-module",
|
2091
|
-
"path": "components/brandvisual/brandvisual.component.js",
|
2092
|
-
"declarations": [
|
2093
|
-
{
|
2094
|
-
"kind": "class",
|
2095
|
-
"description": "The `mdc-brandvisual` component is responsible for rendering logos dynamically & ensures they are\ndisplayed correctly within applications.\n\nFeatures:\n- Dynamically loads brandvisuals based on the `name` attribute.\n- Emits a `load` event when the brandvisual is successfully fetched.\n- Emits an `error` event when the brandvisual import fails.\n- Supports accessibility best practices.\n- Used for brand representation within the design system.",
|
2096
|
-
"name": "Brandvisual",
|
2097
|
-
"members": [
|
2098
|
-
{
|
2099
|
-
"kind": "field",
|
2100
|
-
"name": "brandVisualData",
|
2101
|
-
"type": {
|
2102
|
-
"text": "HTMLElement | undefined"
|
2103
|
-
},
|
2104
|
-
"privacy": "private"
|
2105
|
-
},
|
2106
|
-
{
|
2107
|
-
"kind": "field",
|
2108
|
-
"name": "name",
|
2109
|
-
"type": {
|
2110
|
-
"text": "BrandVisualNames | undefined"
|
2111
|
-
},
|
2112
|
-
"description": "Name of the brandVisual (= filename)",
|
2113
|
-
"attribute": "name",
|
2114
|
-
"reflects": true
|
2115
|
-
},
|
2116
|
-
{
|
2117
|
-
"kind": "method",
|
2118
|
-
"name": "getBrandVisualData",
|
2119
|
-
"privacy": "private"
|
2120
|
-
},
|
2121
|
-
{
|
2122
|
-
"kind": "method",
|
2123
|
-
"name": "handleBrandVisualLoadedSuccess",
|
2124
|
-
"privacy": "private",
|
2125
|
-
"parameters": [
|
2126
|
-
{
|
2127
|
-
"name": "brandVisualHtml",
|
2128
|
-
"type": {
|
2129
|
-
"text": "HTMLElement"
|
2130
|
-
},
|
2131
|
-
"description": "The brandvisual html element which has been fetched from the brandvisual provider."
|
2132
|
-
}
|
2133
|
-
],
|
2134
|
-
"description": "Sets the brandVisualData state to the fetched brandvisual.\nDispatches a 'load' event on the component once the brandvisual has been successfully loaded."
|
2135
|
-
},
|
2136
|
-
{
|
2137
|
-
"kind": "method",
|
2138
|
-
"name": "handleBrandVisualLoadedFailure",
|
2139
|
-
"privacy": "private",
|
2140
|
-
"parameters": [
|
2141
|
-
{
|
2142
|
-
"name": "error",
|
2143
|
-
"type": {
|
2144
|
-
"text": "unknown"
|
2145
|
-
}
|
2146
|
-
}
|
2147
|
-
],
|
2148
|
-
"description": "Dispatches an 'error' event on the component when the brandvisual import has failed.\nThis event bubbles and is cancelable.\nThe error detail is set to the error object."
|
2149
|
-
}
|
2150
|
-
],
|
2151
|
-
"events": [
|
2152
|
-
{
|
2153
|
-
"description": "(React: onLoad) This event is dispatched when the brandvisual has been successfully loaded.",
|
2154
|
-
"name": "load",
|
2155
|
-
"reactName": "onLoad"
|
2156
|
-
},
|
2157
|
-
{
|
2158
|
-
"description": "(React: onError) This event is dispatched when the brandvisual fetching has failed.",
|
2159
|
-
"name": "error",
|
2160
|
-
"reactName": "onError"
|
2161
|
-
}
|
2162
|
-
],
|
2163
|
-
"attributes": [
|
2164
|
-
{
|
2165
|
-
"name": "name",
|
2166
|
-
"type": {
|
2167
|
-
"text": "BrandVisualNames | undefined"
|
2168
|
-
},
|
2169
|
-
"description": "Name of the brandVisual (= filename)",
|
2170
|
-
"fieldName": "name"
|
2171
|
-
}
|
2172
|
-
],
|
2173
|
-
"superclass": {
|
2174
|
-
"name": "Component",
|
2175
|
-
"module": "/src/models"
|
2176
|
-
},
|
2177
|
-
"tagName": "mdc-brandvisual",
|
2178
|
-
"jsDoc": "/**\n * The `mdc-brandvisual` component is responsible for rendering logos dynamically & ensures they are\n * displayed correctly within applications.\n *\n * Features:\n * - Dynamically loads brandvisuals based on the `name` attribute.\n * - Emits a `load` event when the brandvisual is successfully fetched.\n * - Emits an `error` event when the brandvisual import fails.\n * - Supports accessibility best practices.\n * - Used for brand representation within the design system.\n *\n * @tagname mdc-brandvisual\n *\n * @event load - (React: onLoad) This event is dispatched when the brandvisual has been successfully loaded.\n * @event error - (React: onError) This event is dispatched when the brandvisual fetching has failed.\n *\n */",
|
2179
|
-
"customElement": true
|
2180
|
-
}
|
2181
|
-
],
|
2182
|
-
"exports": [
|
2183
|
-
{
|
2184
|
-
"kind": "js",
|
2185
|
-
"name": "default",
|
2186
|
-
"declaration": {
|
2187
|
-
"name": "Brandvisual",
|
2188
|
-
"module": "components/brandvisual/brandvisual.component.js"
|
2189
|
-
}
|
2190
|
-
}
|
2191
|
-
]
|
2192
|
-
},
|
2193
2089
|
{
|
2194
2090
|
"kind": "javascript-module",
|
2195
2091
|
"path": "components/bullet/bullet.component.js",
|
@@ -2942,7 +2838,111 @@
|
|
2942
2838
|
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
2943
2839
|
}
|
2944
2840
|
}
|
2945
|
-
]
|
2841
|
+
]
|
2842
|
+
}
|
2843
|
+
],
|
2844
|
+
"exports": [
|
2845
|
+
{
|
2846
|
+
"kind": "js",
|
2847
|
+
"name": "default",
|
2848
|
+
"declaration": {
|
2849
|
+
"name": "Button",
|
2850
|
+
"module": "components/button/button.component.js"
|
2851
|
+
}
|
2852
|
+
}
|
2853
|
+
]
|
2854
|
+
},
|
2855
|
+
{
|
2856
|
+
"kind": "javascript-module",
|
2857
|
+
"path": "components/brandvisual/brandvisual.component.js",
|
2858
|
+
"declarations": [
|
2859
|
+
{
|
2860
|
+
"kind": "class",
|
2861
|
+
"description": "The `mdc-brandvisual` component is responsible for rendering logos dynamically & ensures they are\ndisplayed correctly within applications.\n\nFeatures:\n- Dynamically loads brandvisuals based on the `name` attribute.\n- Emits a `load` event when the brandvisual is successfully fetched.\n- Emits an `error` event when the brandvisual import fails.\n- Supports accessibility best practices.\n- Used for brand representation within the design system.",
|
2862
|
+
"name": "Brandvisual",
|
2863
|
+
"members": [
|
2864
|
+
{
|
2865
|
+
"kind": "field",
|
2866
|
+
"name": "brandVisualData",
|
2867
|
+
"type": {
|
2868
|
+
"text": "HTMLElement | undefined"
|
2869
|
+
},
|
2870
|
+
"privacy": "private"
|
2871
|
+
},
|
2872
|
+
{
|
2873
|
+
"kind": "field",
|
2874
|
+
"name": "name",
|
2875
|
+
"type": {
|
2876
|
+
"text": "BrandVisualNames | undefined"
|
2877
|
+
},
|
2878
|
+
"description": "Name of the brandVisual (= filename)",
|
2879
|
+
"attribute": "name",
|
2880
|
+
"reflects": true
|
2881
|
+
},
|
2882
|
+
{
|
2883
|
+
"kind": "method",
|
2884
|
+
"name": "getBrandVisualData",
|
2885
|
+
"privacy": "private"
|
2886
|
+
},
|
2887
|
+
{
|
2888
|
+
"kind": "method",
|
2889
|
+
"name": "handleBrandVisualLoadedSuccess",
|
2890
|
+
"privacy": "private",
|
2891
|
+
"parameters": [
|
2892
|
+
{
|
2893
|
+
"name": "brandVisualHtml",
|
2894
|
+
"type": {
|
2895
|
+
"text": "HTMLElement"
|
2896
|
+
},
|
2897
|
+
"description": "The brandvisual html element which has been fetched from the brandvisual provider."
|
2898
|
+
}
|
2899
|
+
],
|
2900
|
+
"description": "Sets the brandVisualData state to the fetched brandvisual.\nDispatches a 'load' event on the component once the brandvisual has been successfully loaded."
|
2901
|
+
},
|
2902
|
+
{
|
2903
|
+
"kind": "method",
|
2904
|
+
"name": "handleBrandVisualLoadedFailure",
|
2905
|
+
"privacy": "private",
|
2906
|
+
"parameters": [
|
2907
|
+
{
|
2908
|
+
"name": "error",
|
2909
|
+
"type": {
|
2910
|
+
"text": "unknown"
|
2911
|
+
}
|
2912
|
+
}
|
2913
|
+
],
|
2914
|
+
"description": "Dispatches an 'error' event on the component when the brandvisual import has failed.\nThis event bubbles and is cancelable.\nThe error detail is set to the error object."
|
2915
|
+
}
|
2916
|
+
],
|
2917
|
+
"events": [
|
2918
|
+
{
|
2919
|
+
"description": "(React: onLoad) This event is dispatched when the brandvisual has been successfully loaded.",
|
2920
|
+
"name": "load",
|
2921
|
+
"reactName": "onLoad"
|
2922
|
+
},
|
2923
|
+
{
|
2924
|
+
"description": "(React: onError) This event is dispatched when the brandvisual fetching has failed.",
|
2925
|
+
"name": "error",
|
2926
|
+
"reactName": "onError"
|
2927
|
+
}
|
2928
|
+
],
|
2929
|
+
"attributes": [
|
2930
|
+
{
|
2931
|
+
"name": "name",
|
2932
|
+
"type": {
|
2933
|
+
"text": "BrandVisualNames | undefined"
|
2934
|
+
},
|
2935
|
+
"description": "Name of the brandVisual (= filename)",
|
2936
|
+
"fieldName": "name"
|
2937
|
+
}
|
2938
|
+
],
|
2939
|
+
"superclass": {
|
2940
|
+
"name": "Component",
|
2941
|
+
"module": "/src/models"
|
2942
|
+
},
|
2943
|
+
"tagName": "mdc-brandvisual",
|
2944
|
+
"jsDoc": "/**\n * The `mdc-brandvisual` component is responsible for rendering logos dynamically & ensures they are\n * displayed correctly within applications.\n *\n * Features:\n * - Dynamically loads brandvisuals based on the `name` attribute.\n * - Emits a `load` event when the brandvisual is successfully fetched.\n * - Emits an `error` event when the brandvisual import fails.\n * - Supports accessibility best practices.\n * - Used for brand representation within the design system.\n *\n * @tagname mdc-brandvisual\n *\n * @event load - (React: onLoad) This event is dispatched when the brandvisual has been successfully loaded.\n * @event error - (React: onError) This event is dispatched when the brandvisual fetching has failed.\n *\n */",
|
2945
|
+
"customElement": true
|
2946
2946
|
}
|
2947
2947
|
],
|
2948
2948
|
"exports": [
|
@@ -2950,8 +2950,8 @@
|
|
2950
2950
|
"kind": "js",
|
2951
2951
|
"name": "default",
|
2952
2952
|
"declaration": {
|
2953
|
-
"name": "
|
2954
|
-
"module": "components/
|
2953
|
+
"name": "Brandvisual",
|
2954
|
+
"module": "components/brandvisual/brandvisual.component.js"
|
2955
2955
|
}
|
2956
2956
|
}
|
2957
2957
|
]
|
@@ -31134,31 +31134,293 @@
|
|
31134
31134
|
"fieldName": "readonly"
|
31135
31135
|
},
|
31136
31136
|
{
|
31137
|
-
"name": "disabled",
|
31137
|
+
"name": "disabled",
|
31138
|
+
"type": {
|
31139
|
+
"text": "boolean | undefined"
|
31140
|
+
},
|
31141
|
+
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
31142
|
+
"default": "undefined",
|
31143
|
+
"fieldName": "disabled",
|
31144
|
+
"inheritedFrom": {
|
31145
|
+
"name": "DisabledMixin",
|
31146
|
+
"module": "src/utils/mixins/DisabledMixin.ts"
|
31147
|
+
}
|
31148
|
+
}
|
31149
|
+
],
|
31150
|
+
"mixins": [
|
31151
|
+
{
|
31152
|
+
"name": "DisabledMixin",
|
31153
|
+
"module": "/src/utils/mixins/DisabledMixin"
|
31154
|
+
}
|
31155
|
+
],
|
31156
|
+
"superclass": {
|
31157
|
+
"name": "Component",
|
31158
|
+
"module": "/src/models"
|
31159
|
+
},
|
31160
|
+
"tagName": "mdc-staticradio",
|
31161
|
+
"jsDoc": "/**\n * This is a decorative component that is styled to look as a radio.\n * It has 2 properties - checked and disabled.\n *\n * We are using the same styling that has been created for the `mdc-radio` component.\n *\n * @tagname mdc-staticradio\n *\n * @cssproperty --mdc-staticradio-inner-circle-size - size of the inner circle\n * @cssproperty --mdc-staticradio-text-disabled-color - color of the label when disabled\n * @cssproperty --mdc-staticradio-normal-border-color - color of the radio button border when normal\n * @cssproperty --mdc-staticradio-disabled-border-color - color of the radio button border when disabled\n * @cssproperty --mdc-staticradio-inner-circle-normal-background - background color of the inner circle when normal\n * @cssproperty --mdc-staticradio-inner-circle-disabled-background - background color of the inner circle when disabled\n * @cssproperty --mdc-staticradio-control-inactive-color - color of the radio button when inactive\n * @cssproperty --mdc-staticradio-control-inactive-disabled-background - background color of the radio button when\n * inactive and disabled\n * @cssproperty --mdc-staticradio-control-active-color - color of the radio button when active\n * @cssproperty --mdc-staticradio-control-active-disabled-background - background color of the radio button\n * when active and disabled\n */",
|
31162
|
+
"customElement": true
|
31163
|
+
}
|
31164
|
+
],
|
31165
|
+
"exports": [
|
31166
|
+
{
|
31167
|
+
"kind": "js",
|
31168
|
+
"name": "default",
|
31169
|
+
"declaration": {
|
31170
|
+
"name": "StaticRadio",
|
31171
|
+
"module": "components/staticradio/staticradio.component.js"
|
31172
|
+
}
|
31173
|
+
}
|
31174
|
+
]
|
31175
|
+
},
|
31176
|
+
{
|
31177
|
+
"kind": "javascript-module",
|
31178
|
+
"path": "components/statictoggle/statictoggle.component.js",
|
31179
|
+
"declarations": [
|
31180
|
+
{
|
31181
|
+
"kind": "class",
|
31182
|
+
"description": "This is a decorative component that is styled to look as a toggle. <br/>\nIt has 3 properties - checked, size and disabled. <br/>\nWe are using the same styling that has been created for the `mdc-toggle` component.",
|
31183
|
+
"name": "StaticToggle",
|
31184
|
+
"cssProperties": [
|
31185
|
+
{
|
31186
|
+
"description": "Width of the toggle",
|
31187
|
+
"name": "--mdc-statictoggle-width"
|
31188
|
+
},
|
31189
|
+
{
|
31190
|
+
"description": "Height of the toggle",
|
31191
|
+
"name": "--mdc-statictoggle-height"
|
31192
|
+
},
|
31193
|
+
{
|
31194
|
+
"description": "Width of the toggle when it's size is compact",
|
31195
|
+
"name": "--mdc-statictoggle-width-compact"
|
31196
|
+
},
|
31197
|
+
{
|
31198
|
+
"description": "Height of the toggle when it's size is compact",
|
31199
|
+
"name": "--mdc-statictoggle-height-compact"
|
31200
|
+
},
|
31201
|
+
{
|
31202
|
+
"description": "Border radius of the toggle",
|
31203
|
+
"name": "--mdc-statictoggle-border-radius"
|
31204
|
+
},
|
31205
|
+
{
|
31206
|
+
"description": "Border radius of the toggle when it's size is compact",
|
31207
|
+
"name": "--mdc-statictoggle-border-radius-compact"
|
31208
|
+
},
|
31209
|
+
{
|
31210
|
+
"description": "Border of the toggle",
|
31211
|
+
"name": "--mdc-statictoggle-border"
|
31212
|
+
},
|
31213
|
+
{
|
31214
|
+
"description": "Background color of the inactive toggle in rest state",
|
31215
|
+
"name": "--mdc-statictoggle-inactive-rest-color"
|
31216
|
+
},
|
31217
|
+
{
|
31218
|
+
"description": "Background color of the inactive toggle in disabled state",
|
31219
|
+
"name": "--mdc-statictoggle-inactive-disabled-color"
|
31220
|
+
},
|
31221
|
+
{
|
31222
|
+
"description": "Background color of the active toggle in rest state",
|
31223
|
+
"name": "--mdc-statictoggle-active-rest-color"
|
31224
|
+
},
|
31225
|
+
{
|
31226
|
+
"description": "Background color of the active toggle in disabled state",
|
31227
|
+
"name": "--mdc-statictoggle-active-disabled-color"
|
31228
|
+
},
|
31229
|
+
{
|
31230
|
+
"description": "Color of the icon in normal state",
|
31231
|
+
"name": "--mdc-statictoggle-icon-color-normal"
|
31232
|
+
},
|
31233
|
+
{
|
31234
|
+
"description": "Color of the icon in disabled state",
|
31235
|
+
"name": "--mdc-statictoggle-icon-color-disabled"
|
31236
|
+
},
|
31237
|
+
{
|
31238
|
+
"description": "Background color of the icon in normal state",
|
31239
|
+
"name": "--mdc-statictoggle-icon-background-color-normal"
|
31240
|
+
},
|
31241
|
+
{
|
31242
|
+
"description": "Background color of the icon in disabled state",
|
31243
|
+
"name": "--mdc-statictoggle-icon-background-color-disabled"
|
31244
|
+
}
|
31245
|
+
],
|
31246
|
+
"slots": [
|
31247
|
+
{
|
31248
|
+
"description": "This is a default/unnamed slot",
|
31249
|
+
"name": "default"
|
31250
|
+
}
|
31251
|
+
],
|
31252
|
+
"members": [
|
31253
|
+
{
|
31254
|
+
"kind": "field",
|
31255
|
+
"name": "checked",
|
31256
|
+
"type": {
|
31257
|
+
"text": "boolean"
|
31258
|
+
},
|
31259
|
+
"default": "false",
|
31260
|
+
"description": "Determines whether the toggle is active or inactive.",
|
31261
|
+
"attribute": "checked",
|
31262
|
+
"reflects": true
|
31263
|
+
},
|
31264
|
+
{
|
31265
|
+
"kind": "field",
|
31266
|
+
"name": "size",
|
31267
|
+
"type": {
|
31268
|
+
"text": "ToggleSize"
|
31269
|
+
},
|
31270
|
+
"description": "Determines toggle size in rem (height is specified here).\n- **Default**: 1.5\n- **Compact**: 1",
|
31271
|
+
"default": "default",
|
31272
|
+
"attribute": "size",
|
31273
|
+
"reflects": true
|
31274
|
+
},
|
31275
|
+
{
|
31276
|
+
"kind": "field",
|
31277
|
+
"name": "disabled",
|
31278
|
+
"type": {
|
31279
|
+
"text": "boolean | undefined"
|
31280
|
+
},
|
31281
|
+
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
31282
|
+
"default": "undefined",
|
31283
|
+
"attribute": "disabled",
|
31284
|
+
"reflects": true,
|
31285
|
+
"inheritedFrom": {
|
31286
|
+
"name": "DisabledMixin",
|
31287
|
+
"module": "utils/mixins/DisabledMixin.js"
|
31288
|
+
}
|
31289
|
+
}
|
31290
|
+
],
|
31291
|
+
"attributes": [
|
31292
|
+
{
|
31293
|
+
"name": "checked",
|
31294
|
+
"type": {
|
31295
|
+
"text": "boolean"
|
31296
|
+
},
|
31297
|
+
"default": "false",
|
31298
|
+
"description": "Determines whether the toggle is active or inactive.",
|
31299
|
+
"fieldName": "checked"
|
31300
|
+
},
|
31301
|
+
{
|
31302
|
+
"name": "size",
|
31303
|
+
"type": {
|
31304
|
+
"text": "ToggleSize"
|
31305
|
+
},
|
31306
|
+
"description": "Determines toggle size in rem (height is specified here).\n- **Default**: 1.5\n- **Compact**: 1",
|
31307
|
+
"default": "default",
|
31308
|
+
"fieldName": "size"
|
31309
|
+
},
|
31310
|
+
{
|
31311
|
+
"name": "disabled",
|
31312
|
+
"type": {
|
31313
|
+
"text": "boolean | undefined"
|
31314
|
+
},
|
31315
|
+
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
31316
|
+
"default": "undefined",
|
31317
|
+
"fieldName": "disabled",
|
31318
|
+
"inheritedFrom": {
|
31319
|
+
"name": "DisabledMixin",
|
31320
|
+
"module": "src/utils/mixins/DisabledMixin.ts"
|
31321
|
+
}
|
31322
|
+
}
|
31323
|
+
],
|
31324
|
+
"mixins": [
|
31325
|
+
{
|
31326
|
+
"name": "DisabledMixin",
|
31327
|
+
"module": "/src/utils/mixins/DisabledMixin"
|
31328
|
+
}
|
31329
|
+
],
|
31330
|
+
"superclass": {
|
31331
|
+
"name": "Component",
|
31332
|
+
"module": "/src/models"
|
31333
|
+
},
|
31334
|
+
"tagName": "mdc-statictoggle",
|
31335
|
+
"jsDoc": "/**\n * This is a decorative component that is styled to look as a toggle. <br/>\n * It has 3 properties - checked, size and disabled. <br/>\n * We are using the same styling that has been created for the `mdc-toggle` component.\n *\n * @dependency mdc-icon\n *\n * @tagname mdc-statictoggle\n *\n * @slot default - This is a default/unnamed slot\n *\n * @cssproperty --mdc-statictoggle-width - Width of the toggle\n * @cssproperty --mdc-statictoggle-height - Height of the toggle\n * @cssproperty --mdc-statictoggle-width-compact - Width of the toggle when it's size is compact\n * @cssproperty --mdc-statictoggle-height-compact - Height of the toggle when it's size is compact\n * @cssproperty --mdc-statictoggle-border-radius - Border radius of the toggle\n * @cssproperty --mdc-statictoggle-border-radius-compact - Border radius of the toggle when it's size is compact\n * @cssproperty --mdc-statictoggle-border - Border of the toggle\n * @cssproperty --mdc-statictoggle-inactive-rest-color - Background color of the inactive toggle in rest state\n * @cssproperty --mdc-statictoggle-inactive-disabled-color - Background color of the inactive toggle in disabled state\n * @cssproperty --mdc-statictoggle-active-rest-color - Background color of the active toggle in rest state\n * @cssproperty --mdc-statictoggle-active-disabled-color - Background color of the active toggle in disabled state\n * @cssproperty --mdc-statictoggle-icon-color-normal - Color of the icon in normal state\n * @cssproperty --mdc-statictoggle-icon-color-disabled - Color of the icon in disabled state\n * @cssproperty --mdc-statictoggle-icon-background-color-normal - Background color of the icon in normal state\n * @cssproperty --mdc-statictoggle-icon-background-color-disabled - Background color of the icon in disabled state\n */",
|
31336
|
+
"customElement": true
|
31337
|
+
}
|
31338
|
+
],
|
31339
|
+
"exports": [
|
31340
|
+
{
|
31341
|
+
"kind": "js",
|
31342
|
+
"name": "default",
|
31343
|
+
"declaration": {
|
31344
|
+
"name": "StaticToggle",
|
31345
|
+
"module": "components/statictoggle/statictoggle.component.js"
|
31346
|
+
}
|
31347
|
+
}
|
31348
|
+
]
|
31349
|
+
},
|
31350
|
+
{
|
31351
|
+
"kind": "javascript-module",
|
31352
|
+
"path": "components/stepperconnector/stepperconnector.component.js",
|
31353
|
+
"declarations": [
|
31354
|
+
{
|
31355
|
+
"kind": "class",
|
31356
|
+
"description": "StepperConnector component visually represents the connection between two stepper items.\nIndicates whether the connection is complete or incomplete, and supports vertical or horizontal orientation.\nThey are used between 2 `mdc-stepperitem` components to visually connect them and wrapped in a `mdc-stepper` component.",
|
31357
|
+
"name": "StepperConnector",
|
31358
|
+
"cssProperties": [
|
31359
|
+
{
|
31360
|
+
"description": "Background color for the complete connector",
|
31361
|
+
"name": "--mdc-stepperconnector-complete-background"
|
31362
|
+
},
|
31363
|
+
{
|
31364
|
+
"description": "Background color for the incomplete connector",
|
31365
|
+
"name": "--mdc-stepperconnector-incomplete-background"
|
31366
|
+
}
|
31367
|
+
],
|
31368
|
+
"cssParts": [
|
31369
|
+
{
|
31370
|
+
"description": "The main connector line between steps",
|
31371
|
+
"name": "connector"
|
31372
|
+
}
|
31373
|
+
],
|
31374
|
+
"members": [
|
31375
|
+
{
|
31376
|
+
"kind": "field",
|
31377
|
+
"name": "status",
|
31378
|
+
"type": {
|
31379
|
+
"text": "StatusType"
|
31380
|
+
},
|
31381
|
+
"description": "The status of the connector (complete or incomplete)",
|
31382
|
+
"default": "\"incomplete\"",
|
31383
|
+
"attribute": "status",
|
31384
|
+
"reflects": true
|
31385
|
+
},
|
31386
|
+
{
|
31387
|
+
"kind": "field",
|
31388
|
+
"name": "orientation",
|
31138
31389
|
"type": {
|
31139
|
-
"text": "
|
31390
|
+
"text": "OrientationType"
|
31140
31391
|
},
|
31141
|
-
"description": "
|
31142
|
-
"default": "
|
31143
|
-
"
|
31144
|
-
"
|
31145
|
-
"name": "DisabledMixin",
|
31146
|
-
"module": "src/utils/mixins/DisabledMixin.ts"
|
31147
|
-
}
|
31392
|
+
"description": "The orientation of the connector (vertical or horizontal)",
|
31393
|
+
"default": "\"horizontal\"",
|
31394
|
+
"attribute": "orientation",
|
31395
|
+
"reflects": true
|
31148
31396
|
}
|
31149
31397
|
],
|
31150
|
-
"
|
31398
|
+
"attributes": [
|
31151
31399
|
{
|
31152
|
-
"name": "
|
31153
|
-
"
|
31400
|
+
"name": "status",
|
31401
|
+
"type": {
|
31402
|
+
"text": "StatusType"
|
31403
|
+
},
|
31404
|
+
"description": "The status of the connector (complete or incomplete)",
|
31405
|
+
"default": "\"incomplete\"",
|
31406
|
+
"fieldName": "status"
|
31407
|
+
},
|
31408
|
+
{
|
31409
|
+
"name": "orientation",
|
31410
|
+
"type": {
|
31411
|
+
"text": "OrientationType"
|
31412
|
+
},
|
31413
|
+
"description": "The orientation of the connector (vertical or horizontal)",
|
31414
|
+
"default": "\"horizontal\"",
|
31415
|
+
"fieldName": "orientation"
|
31154
31416
|
}
|
31155
31417
|
],
|
31156
31418
|
"superclass": {
|
31157
31419
|
"name": "Component",
|
31158
31420
|
"module": "/src/models"
|
31159
31421
|
},
|
31160
|
-
"tagName": "mdc-
|
31161
|
-
"jsDoc": "/**\n *
|
31422
|
+
"tagName": "mdc-stepperconnector",
|
31423
|
+
"jsDoc": "/**\n * StepperConnector component visually represents the connection between two stepper items.\n * Indicates whether the connection is complete or incomplete, and supports vertical or horizontal orientation.\n * They are used between 2 `mdc-stepperitem` components to visually connect them and wrapped in a `mdc-stepper` component.\n *\n * @tagname mdc-stepperconnector\n *\n * @csspart connector - The main connector line between steps\n *\n * @cssproperty --mdc-stepperconnector-complete-background - Background color for the complete connector\n * @cssproperty --mdc-stepperconnector-incomplete-background - Background color for the incomplete connector\n */",
|
31162
31424
|
"customElement": true
|
31163
31425
|
}
|
31164
31426
|
],
|
@@ -31167,172 +31429,295 @@
|
|
31167
31429
|
"kind": "js",
|
31168
31430
|
"name": "default",
|
31169
31431
|
"declaration": {
|
31170
|
-
"name": "
|
31171
|
-
"module": "components/
|
31432
|
+
"name": "StepperConnector",
|
31433
|
+
"module": "components/stepperconnector/stepperconnector.component.js"
|
31172
31434
|
}
|
31173
31435
|
}
|
31174
31436
|
]
|
31175
31437
|
},
|
31176
31438
|
{
|
31177
31439
|
"kind": "javascript-module",
|
31178
|
-
"path": "components/
|
31440
|
+
"path": "components/stepperitem/stepperitem.component.js",
|
31179
31441
|
"declarations": [
|
31180
31442
|
{
|
31181
31443
|
"kind": "class",
|
31182
|
-
"description": "
|
31183
|
-
"name": "
|
31444
|
+
"description": "stepperitem component is used to represent a single step in a stepper component. It is used within a `mdc-stepper` component to indicate the current step in a process.\nIt can have different statuses such as `completed`, `current`, `incomplete`, `error-current`, and `error-incomplete`.\nThe component supports various visual styles and can be customized with labels, help text, and step numbers.\n\nThis is an uncontrolled component, meaning it does not manage its own state. Instead, it relies on the consumer's to manage the state of each step.\nMake sure to set `aria-current=\"step\"` on the current stepper item. It is applicable only when status is `current` or `error-current`. This ensures accessibility for the stepper component. Only one stepper item should have this attribute at a time.",
|
31445
|
+
"name": "StepperItem",
|
31184
31446
|
"cssProperties": [
|
31185
31447
|
{
|
31186
|
-
"description": "
|
31187
|
-
"name": "--mdc-
|
31448
|
+
"description": "The background color of the status container.",
|
31449
|
+
"name": "--mdc-stepperitem-status-container-background"
|
31188
31450
|
},
|
31189
31451
|
{
|
31190
|
-
"description": "
|
31191
|
-
"name": "--mdc-
|
31452
|
+
"description": "The border color of the status container.",
|
31453
|
+
"name": "--mdc-stepperitem-status-container-border-color"
|
31192
31454
|
},
|
31193
31455
|
{
|
31194
|
-
"description": "
|
31195
|
-
"name": "--mdc-
|
31456
|
+
"description": "The color of the label text.",
|
31457
|
+
"name": "--mdc-stepperitem-label-color"
|
31196
31458
|
},
|
31197
31459
|
{
|
31198
|
-
"description": "
|
31199
|
-
"name": "--mdc-
|
31460
|
+
"description": "The color of the optional label text.",
|
31461
|
+
"name": "--mdc-stepperitem-help-text-color"
|
31200
31462
|
},
|
31201
31463
|
{
|
31202
|
-
"description": "
|
31203
|
-
"name": "--mdc-
|
31204
|
-
}
|
31464
|
+
"description": "The background color of the label container.",
|
31465
|
+
"name": "--mdc-stepperitem-label-container-background"
|
31466
|
+
}
|
31467
|
+
],
|
31468
|
+
"cssParts": [
|
31205
31469
|
{
|
31206
|
-
"description": "
|
31207
|
-
"name": "
|
31470
|
+
"description": "The container for the status icon or step number.",
|
31471
|
+
"name": "status-container"
|
31208
31472
|
},
|
31209
31473
|
{
|
31210
|
-
"description": "
|
31211
|
-
"name": "
|
31474
|
+
"description": "The container for the label and help text.",
|
31475
|
+
"name": "label-container"
|
31212
31476
|
},
|
31213
31477
|
{
|
31214
|
-
"description": "
|
31215
|
-
"name": "
|
31478
|
+
"description": "The container for the help text and error icon when applicable.",
|
31479
|
+
"name": "help-text-container"
|
31216
31480
|
},
|
31217
31481
|
{
|
31218
|
-
"description": "
|
31219
|
-
"name": "
|
31482
|
+
"description": "The icon representing the status of the stepper item.",
|
31483
|
+
"name": "status-icon"
|
31220
31484
|
},
|
31221
31485
|
{
|
31222
|
-
"description": "
|
31223
|
-
"name": "
|
31486
|
+
"description": "The text representing the step number.",
|
31487
|
+
"name": "step-number"
|
31224
31488
|
},
|
31225
31489
|
{
|
31226
|
-
"description": "
|
31227
|
-
"name": "
|
31490
|
+
"description": "The text representing the label of the stepper item.",
|
31491
|
+
"name": "label"
|
31228
31492
|
},
|
31229
31493
|
{
|
31230
|
-
"description": "
|
31231
|
-
"name": "
|
31494
|
+
"description": "The text providing additional information about the stepper item.",
|
31495
|
+
"name": "help-text"
|
31232
31496
|
},
|
31233
31497
|
{
|
31234
|
-
"description": "
|
31235
|
-
"name": "
|
31236
|
-
}
|
31498
|
+
"description": "The icon representing an error in the stepper item.",
|
31499
|
+
"name": "help-icon"
|
31500
|
+
}
|
31501
|
+
],
|
31502
|
+
"members": [
|
31237
31503
|
{
|
31238
|
-
"
|
31239
|
-
"name": "
|
31504
|
+
"kind": "field",
|
31505
|
+
"name": "variant",
|
31506
|
+
"type": {
|
31507
|
+
"text": "VariantType"
|
31508
|
+
},
|
31509
|
+
"description": "The variant of the stepper item, which can be `inline` or `stacked`.",
|
31510
|
+
"default": "'inline'",
|
31511
|
+
"attribute": "variant",
|
31512
|
+
"reflects": true
|
31240
31513
|
},
|
31241
31514
|
{
|
31242
|
-
"
|
31243
|
-
"name": "
|
31244
|
-
|
31245
|
-
|
31246
|
-
|
31515
|
+
"kind": "field",
|
31516
|
+
"name": "status",
|
31517
|
+
"type": {
|
31518
|
+
"text": "StatusType"
|
31519
|
+
},
|
31520
|
+
"description": "The status of the stepper item, which can be `completed`, `current`, `not-started`, `error-current`, or `error-incomplete`.",
|
31521
|
+
"default": "'not-started'",
|
31522
|
+
"attribute": "status",
|
31523
|
+
"reflects": true
|
31524
|
+
},
|
31247
31525
|
{
|
31248
|
-
"
|
31249
|
-
"name": "
|
31250
|
-
|
31251
|
-
|
31252
|
-
|
31526
|
+
"kind": "field",
|
31527
|
+
"name": "label",
|
31528
|
+
"type": {
|
31529
|
+
"text": "string"
|
31530
|
+
},
|
31531
|
+
"default": "''",
|
31532
|
+
"description": "The label for the stepper item, which is displayed as the main text of the step.\nThis label is typically used to describe the step or action that the step represents.",
|
31533
|
+
"attribute": "label",
|
31534
|
+
"reflects": true
|
31535
|
+
},
|
31253
31536
|
{
|
31254
31537
|
"kind": "field",
|
31255
|
-
"name": "
|
31538
|
+
"name": "helpText",
|
31256
31539
|
"type": {
|
31257
|
-
"text": "
|
31540
|
+
"text": "string | undefined"
|
31258
31541
|
},
|
31259
|
-
"
|
31260
|
-
"
|
31261
|
-
"attribute": "
|
31542
|
+
"description": "Additional informational text that appears below the label\nThis text is optional and can be used to provide more context or instructions for the step.",
|
31543
|
+
"default": "''",
|
31544
|
+
"attribute": "help-text",
|
31262
31545
|
"reflects": true
|
31263
31546
|
},
|
31264
31547
|
{
|
31265
31548
|
"kind": "field",
|
31266
|
-
"name": "
|
31549
|
+
"name": "stepNumber",
|
31267
31550
|
"type": {
|
31268
|
-
"text": "
|
31551
|
+
"text": "number | undefined"
|
31269
31552
|
},
|
31270
|
-
"description": "
|
31271
|
-
"default": "
|
31272
|
-
"attribute": "
|
31553
|
+
"description": "The step number for the stepper item, which is displayed as a numeric indicator of the step's position in the sequence.\nThis is useful for indicating the order of steps in a process.",
|
31554
|
+
"default": "''",
|
31555
|
+
"attribute": "step-number",
|
31273
31556
|
"reflects": true
|
31274
31557
|
},
|
31558
|
+
{
|
31559
|
+
"kind": "method",
|
31560
|
+
"name": "handleKeyDown",
|
31561
|
+
"privacy": "private",
|
31562
|
+
"parameters": [
|
31563
|
+
{
|
31564
|
+
"name": "event",
|
31565
|
+
"type": {
|
31566
|
+
"text": "KeyboardEvent"
|
31567
|
+
},
|
31568
|
+
"description": "The keyboard event."
|
31569
|
+
}
|
31570
|
+
],
|
31571
|
+
"description": "Handles the keydown event on the stepperitem.\nIf the key is 'Enter' or 'Space', the stepperitem is pressed.\nIf the key is 'Enter', the stepperitem is pressed. The native HTML button works in the same way.\nIf the key is 'Space', the stepperitem's default is prevent to avoid scrolling etc in the host application."
|
31572
|
+
},
|
31573
|
+
{
|
31574
|
+
"kind": "method",
|
31575
|
+
"name": "triggerClickEvent",
|
31576
|
+
"privacy": "private",
|
31577
|
+
"description": "Triggers a click event on the stepper item."
|
31578
|
+
},
|
31579
|
+
{
|
31580
|
+
"kind": "method",
|
31581
|
+
"name": "handleKeyUp",
|
31582
|
+
"privacy": "private",
|
31583
|
+
"parameters": [
|
31584
|
+
{
|
31585
|
+
"name": "event",
|
31586
|
+
"type": {
|
31587
|
+
"text": "KeyboardEvent"
|
31588
|
+
},
|
31589
|
+
"description": "The keyboard event."
|
31590
|
+
}
|
31591
|
+
],
|
31592
|
+
"description": "Handles the keyup event on the stepperitem.\nIf the key is 'Enter' or 'Space', the stepperitem is clicked.\nIf the key is 'Space', the stepperitem is pressed. The native HTML button works in the same way."
|
31593
|
+
},
|
31594
|
+
{
|
31595
|
+
"kind": "method",
|
31596
|
+
"name": "renderStatusIcon",
|
31597
|
+
"privacy": "private",
|
31598
|
+
"description": "Renders the status icon based on the current status of the stepper item.\n- If the status is `completed`, it renders a check icon.\n- If the status is `current` or `error-current`, it renders a pencil icon.\n- If the status is `not-started` or `error-incomplete`, it renders the step number.\n- If the status is anything else, it renders nothing.",
|
31599
|
+
"return": {
|
31600
|
+
"type": {
|
31601
|
+
"text": ""
|
31602
|
+
}
|
31603
|
+
}
|
31604
|
+
},
|
31605
|
+
{
|
31606
|
+
"kind": "method",
|
31607
|
+
"name": "renderHelpText",
|
31608
|
+
"privacy": "private",
|
31609
|
+
"description": "Renders the help text for the stepper item.\nIf the `helpText` property is not set, it returns nothing.",
|
31610
|
+
"return": {
|
31611
|
+
"type": {
|
31612
|
+
"text": ""
|
31613
|
+
}
|
31614
|
+
}
|
31615
|
+
},
|
31275
31616
|
{
|
31276
31617
|
"kind": "field",
|
31277
|
-
"name": "
|
31618
|
+
"name": "tabIndex",
|
31278
31619
|
"type": {
|
31279
|
-
"text": "
|
31620
|
+
"text": "number"
|
31280
31621
|
},
|
31281
|
-
"
|
31282
|
-
"
|
31283
|
-
"attribute": "
|
31622
|
+
"default": "0",
|
31623
|
+
"description": "This property specifies the tab order of the element.",
|
31624
|
+
"attribute": "tabIndex",
|
31284
31625
|
"reflects": true,
|
31285
31626
|
"inheritedFrom": {
|
31286
|
-
"name": "
|
31287
|
-
"module": "utils/mixins/
|
31627
|
+
"name": "TabIndexMixin",
|
31628
|
+
"module": "utils/mixins/TabIndexMixin.js"
|
31288
31629
|
}
|
31289
31630
|
}
|
31290
31631
|
],
|
31632
|
+
"events": [
|
31633
|
+
{
|
31634
|
+
"description": "(React: onClick) This event is dispatched when the stepperitem is clicked.",
|
31635
|
+
"name": "click",
|
31636
|
+
"reactName": "onClick"
|
31637
|
+
},
|
31638
|
+
{
|
31639
|
+
"description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the stepperitem.",
|
31640
|
+
"name": "keydown",
|
31641
|
+
"reactName": "onKeyDown"
|
31642
|
+
},
|
31643
|
+
{
|
31644
|
+
"description": "(React: onKeyUp) This event is dispatched when a key is released on the stepperitem.",
|
31645
|
+
"name": "keyup",
|
31646
|
+
"reactName": "onKeyUp"
|
31647
|
+
}
|
31648
|
+
],
|
31291
31649
|
"attributes": [
|
31292
31650
|
{
|
31293
|
-
"name": "
|
31651
|
+
"name": "variant",
|
31294
31652
|
"type": {
|
31295
|
-
"text": "
|
31653
|
+
"text": "VariantType"
|
31296
31654
|
},
|
31297
|
-
"
|
31298
|
-
"
|
31299
|
-
"fieldName": "
|
31655
|
+
"description": "The variant of the stepper item, which can be `inline` or `stacked`.",
|
31656
|
+
"default": "'inline'",
|
31657
|
+
"fieldName": "variant"
|
31300
31658
|
},
|
31301
31659
|
{
|
31302
|
-
"name": "
|
31660
|
+
"name": "status",
|
31303
31661
|
"type": {
|
31304
|
-
"text": "
|
31662
|
+
"text": "StatusType"
|
31305
31663
|
},
|
31306
|
-
"description": "
|
31307
|
-
"default": "
|
31308
|
-
"fieldName": "
|
31664
|
+
"description": "The status of the stepper item, which can be `completed`, `current`, `not-started`, `error-current`, or `error-incomplete`.",
|
31665
|
+
"default": "'not-started'",
|
31666
|
+
"fieldName": "status"
|
31309
31667
|
},
|
31310
31668
|
{
|
31311
|
-
"name": "
|
31669
|
+
"name": "label",
|
31312
31670
|
"type": {
|
31313
|
-
"text": "
|
31671
|
+
"text": "string"
|
31314
31672
|
},
|
31315
|
-
"
|
31316
|
-
"
|
31317
|
-
"fieldName": "
|
31673
|
+
"default": "''",
|
31674
|
+
"description": "The label for the stepper item, which is displayed as the main text of the step.\nThis label is typically used to describe the step or action that the step represents.",
|
31675
|
+
"fieldName": "label"
|
31676
|
+
},
|
31677
|
+
{
|
31678
|
+
"name": "help-text",
|
31679
|
+
"type": {
|
31680
|
+
"text": "string | undefined"
|
31681
|
+
},
|
31682
|
+
"description": "Additional informational text that appears below the label\nThis text is optional and can be used to provide more context or instructions for the step.",
|
31683
|
+
"default": "''",
|
31684
|
+
"fieldName": "helpText"
|
31685
|
+
},
|
31686
|
+
{
|
31687
|
+
"name": "step-number",
|
31688
|
+
"type": {
|
31689
|
+
"text": "number | undefined"
|
31690
|
+
},
|
31691
|
+
"description": "The step number for the stepper item, which is displayed as a numeric indicator of the step's position in the sequence.\nThis is useful for indicating the order of steps in a process.",
|
31692
|
+
"default": "''",
|
31693
|
+
"fieldName": "stepNumber"
|
31694
|
+
},
|
31695
|
+
{
|
31696
|
+
"name": "tabIndex",
|
31697
|
+
"type": {
|
31698
|
+
"text": "number"
|
31699
|
+
},
|
31700
|
+
"default": "0",
|
31701
|
+
"description": "This property specifies the tab order of the element.",
|
31702
|
+
"fieldName": "tabIndex",
|
31318
31703
|
"inheritedFrom": {
|
31319
|
-
"name": "
|
31320
|
-
"module": "src/utils/mixins/
|
31704
|
+
"name": "TabIndexMixin",
|
31705
|
+
"module": "src/utils/mixins/TabIndexMixin.ts"
|
31321
31706
|
}
|
31322
31707
|
}
|
31323
31708
|
],
|
31324
31709
|
"mixins": [
|
31325
31710
|
{
|
31326
|
-
"name": "
|
31327
|
-
"module": "/src/utils/mixins/
|
31711
|
+
"name": "TabIndexMixin",
|
31712
|
+
"module": "/src/utils/mixins/TabIndexMixin"
|
31328
31713
|
}
|
31329
31714
|
],
|
31330
31715
|
"superclass": {
|
31331
31716
|
"name": "Component",
|
31332
31717
|
"module": "/src/models"
|
31333
31718
|
},
|
31334
|
-
"tagName": "mdc-
|
31335
|
-
"jsDoc": "/**\n *
|
31719
|
+
"tagName": "mdc-stepperitem",
|
31720
|
+
"jsDoc": "/**\n * stepperitem component is used to represent a single step in a stepper component. It is used within a `mdc-stepper` component to indicate the current step in a process.\n * It can have different statuses such as `completed`, `current`, `incomplete`, `error-current`, and `error-incomplete`.\n * The component supports various visual styles and can be customized with labels, help text, and step numbers.\n *\n * This is an uncontrolled component, meaning it does not manage its own state. Instead, it relies on the consumer's to manage the state of each step.\n * Make sure to set `aria-current=\"step\"` on the current stepper item. It is applicable only when status is `current` or `error-current`. This ensures accessibility for the stepper component. Only one stepper item should have this attribute at a time.\n *\n * @dependency mdc-icon\n * @dependency mdc-text\n *\n * @tagname mdc-stepperitem\n *\n * @event click - (React: onClick) This event is dispatched when the stepperitem is clicked.\n * @event keydown - (React: onKeyDown) This event is dispatched when a key is pressed down on the stepperitem.\n * @event keyup - (React: onKeyUp) This event is dispatched when a key is released on the stepperitem.\n *\n * @csspart status-container - The container for the status icon or step number.\n * @csspart label-container - The container for the label and help text.\n * @csspart help-text-container - The container for the help text and error icon when applicable.\n * @csspart status-icon - The icon representing the status of the stepper item.\n * @csspart step-number - The text representing the step number.\n * @csspart label - The text representing the label of the stepper item.\n * @csspart help-text - The text providing additional information about the stepper item.\n * @csspart help-icon - The icon representing an error in the stepper item.\n *\n * @cssproperty --mdc-stepperitem-status-container-background - The background color of the status container.\n * @cssproperty --mdc-stepperitem-status-container-border-color - The border color of the status container.\n * @cssproperty --mdc-stepperitem-label-color - The color of the label text.\n * @cssproperty --mdc-stepperitem-help-text-color - The color of the optional label text.\n * @cssproperty --mdc-stepperitem-label-container-background - The background color of the label container.\n */",
|
31336
31721
|
"customElement": true
|
31337
31722
|
}
|
31338
31723
|
],
|
@@ -31341,8 +31726,8 @@
|
|
31341
31726
|
"kind": "js",
|
31342
31727
|
"name": "default",
|
31343
31728
|
"declaration": {
|
31344
|
-
"name": "
|
31345
|
-
"module": "components/
|
31729
|
+
"name": "StepperItem",
|
31730
|
+
"module": "components/stepperitem/stepperitem.component.js"
|
31346
31731
|
}
|
31347
31732
|
}
|
31348
31733
|
]
|