@momentum-design/components 0.32.0 → 0.33.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/browser/index.js +313 -140
- package/dist/browser/index.js.map +4 -4
- package/dist/components/input/input.component.js +1 -1
- package/dist/components/popover/popover.component.d.ts +5 -0
- package/dist/components/popover/popover.component.js +15 -2
- package/dist/components/popover/popover.constants.d.ts +1 -0
- package/dist/components/popover/popover.constants.js +1 -0
- package/dist/components/textarea/index.d.ts +10 -0
- package/dist/components/textarea/index.js +7 -0
- package/dist/components/textarea/textarea.component.d.ts +203 -0
- package/dist/components/textarea/textarea.component.js +432 -0
- package/dist/components/textarea/textarea.constants.d.ts +21 -0
- package/dist/components/textarea/textarea.constants.js +25 -0
- package/dist/components/textarea/textarea.styles.d.ts +2 -0
- package/dist/components/textarea/textarea.styles.js +122 -0
- package/dist/components/textarea/textarea.types.d.ts +5 -0
- package/dist/components/textarea/textarea.types.js +1 -0
- package/dist/custom-elements.json +1792 -836
- package/dist/index.d.ts +2 -1
- package/dist/index.js +2 -1
- package/dist/react/index.d.ts +3 -2
- package/dist/react/index.js +3 -2
- package/dist/react/textarea/index.d.ts +61 -0
- package/dist/react/textarea/index.js +70 -0
- package/dist/utils/mixins/FormInternalsMixin.d.ts +2 -2
- package/dist/utils/mixins/FormInternalsMixin.js +1 -1
- package/package.json +1 -1
@@ -4,79 +4,163 @@
|
|
4
4
|
"modules": [
|
5
5
|
{
|
6
6
|
"kind": "javascript-module",
|
7
|
-
"path": "components/
|
7
|
+
"path": "components/avatarbutton/avatarbutton.component.js",
|
8
8
|
"declarations": [
|
9
9
|
{
|
10
10
|
"kind": "class",
|
11
|
-
"description": "The `mdc-
|
12
|
-
"name": "
|
13
|
-
"
|
14
|
-
{
|
15
|
-
"description": "The foreground color of the primary badge.",
|
16
|
-
"name": "--mdc-badge-primary-foreground-color"
|
17
|
-
},
|
11
|
+
"description": "The `mdc-avatarbutton` component is an interactable version of the `mdc-avatar` component.\n\nThis component is made by extending `buttonsimple` class.\nThe button component acts as a wrapper for the avatar component.",
|
12
|
+
"name": "AvatarButton",
|
13
|
+
"members": [
|
18
14
|
{
|
19
|
-
"
|
20
|
-
"name": "
|
15
|
+
"kind": "field",
|
16
|
+
"name": "ariaLabel",
|
17
|
+
"type": {
|
18
|
+
"text": "string | null"
|
19
|
+
},
|
20
|
+
"default": "null",
|
21
|
+
"description": "Aria-label attribute to be set for accessibility",
|
22
|
+
"attribute": "aria-label"
|
21
23
|
},
|
22
24
|
{
|
23
|
-
"
|
24
|
-
"name": "
|
25
|
+
"kind": "method",
|
26
|
+
"name": "setSize",
|
27
|
+
"privacy": "private",
|
28
|
+
"parameters": [
|
29
|
+
{
|
30
|
+
"name": "size",
|
31
|
+
"type": {
|
32
|
+
"text": "AvatarSize"
|
33
|
+
}
|
34
|
+
}
|
35
|
+
]
|
25
36
|
},
|
26
37
|
{
|
27
|
-
"
|
28
|
-
"name": "
|
38
|
+
"kind": "field",
|
39
|
+
"name": "active",
|
40
|
+
"type": {
|
41
|
+
"text": "boolean"
|
42
|
+
},
|
43
|
+
"default": "undefined as unknown",
|
44
|
+
"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.",
|
45
|
+
"attribute": "active",
|
46
|
+
"reflects": true,
|
47
|
+
"inheritedFrom": {
|
48
|
+
"name": "Buttonsimple",
|
49
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
50
|
+
}
|
29
51
|
},
|
30
52
|
{
|
31
|
-
"
|
32
|
-
"name": "
|
53
|
+
"kind": "field",
|
54
|
+
"name": "disabled",
|
55
|
+
"type": {
|
56
|
+
"text": "boolean"
|
57
|
+
},
|
58
|
+
"default": "undefined as unknown",
|
59
|
+
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
60
|
+
"attribute": "disabled",
|
61
|
+
"reflects": true,
|
62
|
+
"inheritedFrom": {
|
63
|
+
"name": "DisabledMixin",
|
64
|
+
"module": "utils/mixins/DisabledMixin.js"
|
65
|
+
}
|
33
66
|
},
|
34
67
|
{
|
35
|
-
"
|
36
|
-
"name": "
|
68
|
+
"kind": "field",
|
69
|
+
"name": "softDisabled",
|
70
|
+
"type": {
|
71
|
+
"text": "boolean"
|
72
|
+
},
|
73
|
+
"default": "undefined as unknown",
|
74
|
+
"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.",
|
75
|
+
"attribute": "soft-disabled",
|
76
|
+
"inheritedFrom": {
|
77
|
+
"name": "Buttonsimple",
|
78
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
79
|
+
}
|
37
80
|
},
|
38
81
|
{
|
39
|
-
"
|
40
|
-
"name": "
|
82
|
+
"kind": "field",
|
83
|
+
"name": "role",
|
84
|
+
"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.",
|
85
|
+
"default": "'button'",
|
86
|
+
"attribute": "role",
|
87
|
+
"reflects": true,
|
88
|
+
"type": {
|
89
|
+
"text": "string"
|
90
|
+
},
|
91
|
+
"inheritedFrom": {
|
92
|
+
"name": "Buttonsimple",
|
93
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
94
|
+
}
|
41
95
|
},
|
42
96
|
{
|
43
|
-
"
|
44
|
-
"name": "
|
97
|
+
"kind": "field",
|
98
|
+
"name": "type",
|
99
|
+
"type": {
|
100
|
+
"text": "ButtonType"
|
101
|
+
},
|
102
|
+
"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.",
|
103
|
+
"default": "button",
|
104
|
+
"attribute": "type",
|
105
|
+
"reflects": true,
|
106
|
+
"inheritedFrom": {
|
107
|
+
"name": "Buttonsimple",
|
108
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
109
|
+
}
|
45
110
|
},
|
46
111
|
{
|
47
|
-
"
|
48
|
-
"name": "
|
112
|
+
"kind": "field",
|
113
|
+
"name": "src",
|
114
|
+
"type": {
|
115
|
+
"text": "string | undefined"
|
116
|
+
},
|
117
|
+
"description": "The src is the url which will be used to display the avatar.\nWhen the src is loading, we will display the initials as a placeholder.",
|
118
|
+
"attribute": "src",
|
119
|
+
"inheritedFrom": {
|
120
|
+
"name": "AvatarComponentMixin",
|
121
|
+
"module": "utils/mixins/AvatarComponentMixin.js"
|
122
|
+
}
|
49
123
|
},
|
50
124
|
{
|
51
|
-
"
|
52
|
-
"name": "
|
125
|
+
"kind": "field",
|
126
|
+
"name": "initials",
|
127
|
+
"type": {
|
128
|
+
"text": "string | undefined"
|
129
|
+
},
|
130
|
+
"description": "The initials to be displayed for the avatar.",
|
131
|
+
"attribute": "initials",
|
132
|
+
"inheritedFrom": {
|
133
|
+
"name": "AvatarComponentMixin",
|
134
|
+
"module": "utils/mixins/AvatarComponentMixin.js"
|
135
|
+
}
|
53
136
|
},
|
54
|
-
{
|
55
|
-
"description": "The background color of the badge overlay.",
|
56
|
-
"name": "--mdc-badge-overlay-background-color"
|
57
|
-
}
|
58
|
-
],
|
59
|
-
"members": [
|
60
137
|
{
|
61
138
|
"kind": "field",
|
62
|
-
"name": "
|
139
|
+
"name": "presence",
|
63
140
|
"type": {
|
64
|
-
"text": "
|
141
|
+
"text": "PresenceType | undefined"
|
65
142
|
},
|
66
|
-
"description": "
|
67
|
-
"attribute": "
|
68
|
-
"
|
143
|
+
"description": "The presence is the status which can be used to display the\nactivity state of a user or a space within an avatar component.\n\nAcceptable values include:\n- `active`\n- `away`\n- `away-calling`\n- `busy`\n- `dnd`\n- `meeting`\n- `on-call`\n- `on-device`\n- `on-mobile`\n- `pause`\n- `pto`\n- `presenting`\n- `quiet`\n- `scheduled`",
|
144
|
+
"attribute": "presence",
|
145
|
+
"inheritedFrom": {
|
146
|
+
"name": "AvatarComponentMixin",
|
147
|
+
"module": "utils/mixins/AvatarComponentMixin.js"
|
148
|
+
}
|
69
149
|
},
|
70
150
|
{
|
71
151
|
"kind": "field",
|
72
|
-
"name": "
|
152
|
+
"name": "size",
|
73
153
|
"type": {
|
74
|
-
"text": "
|
154
|
+
"text": "ButtonSize"
|
75
155
|
},
|
76
|
-
"description": "
|
77
|
-
"default": "
|
78
|
-
"attribute": "
|
79
|
-
"reflects": true
|
156
|
+
"description": "Acceptable values include (size in px unit):\n- 24\n- 32\n- 48\n- 64\n- 72\n- 88\n- 124",
|
157
|
+
"default": "32",
|
158
|
+
"attribute": "size",
|
159
|
+
"reflects": true,
|
160
|
+
"inheritedFrom": {
|
161
|
+
"name": "Buttonsimple",
|
162
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
163
|
+
}
|
80
164
|
},
|
81
165
|
{
|
82
166
|
"kind": "field",
|
@@ -84,205 +168,325 @@
|
|
84
168
|
"type": {
|
85
169
|
"text": "number | undefined"
|
86
170
|
},
|
87
|
-
"description": "
|
88
|
-
"attribute": "counter"
|
171
|
+
"description": "The counter is the number which can be displayed on the avatar.\nThe maximum number is 99 and if the given number is greater than 99,\nthen the avatar will be displayed as `99+`.\nIf the given number is a negative number,\nthen the avatar will be displayed as `0`.",
|
172
|
+
"attribute": "counter",
|
173
|
+
"inheritedFrom": {
|
174
|
+
"name": "AvatarComponentMixin",
|
175
|
+
"module": "utils/mixins/AvatarComponentMixin.js"
|
176
|
+
}
|
89
177
|
},
|
90
178
|
{
|
91
179
|
"kind": "field",
|
92
|
-
"name": "
|
180
|
+
"name": "isTyping",
|
93
181
|
"type": {
|
94
|
-
"text": "
|
182
|
+
"text": "boolean"
|
95
183
|
},
|
96
|
-
"
|
97
|
-
"
|
98
|
-
"attribute": "
|
99
|
-
"
|
184
|
+
"default": "false",
|
185
|
+
"description": "Represents the typing indicator when the user is typing.",
|
186
|
+
"attribute": "is-typing",
|
187
|
+
"inheritedFrom": {
|
188
|
+
"name": "AvatarComponentMixin",
|
189
|
+
"module": "utils/mixins/AvatarComponentMixin.js"
|
190
|
+
}
|
100
191
|
},
|
101
192
|
{
|
102
193
|
"kind": "field",
|
103
|
-
"name": "
|
194
|
+
"name": "iconName",
|
104
195
|
"type": {
|
105
|
-
"text": "
|
196
|
+
"text": "IconNames | undefined"
|
106
197
|
},
|
107
|
-
"
|
108
|
-
"
|
109
|
-
"
|
198
|
+
"description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
|
199
|
+
"attribute": "icon-name",
|
200
|
+
"inheritedFrom": {
|
201
|
+
"name": "IconNameMixin",
|
202
|
+
"module": "utils/mixins/IconNameMixin.js"
|
203
|
+
}
|
110
204
|
},
|
111
205
|
{
|
112
206
|
"kind": "field",
|
113
|
-
"name": "
|
207
|
+
"name": "tabIndex",
|
114
208
|
"type": {
|
115
|
-
"text": "
|
209
|
+
"text": "number"
|
116
210
|
},
|
117
|
-
"default": "
|
118
|
-
"description": "
|
119
|
-
"attribute": "
|
211
|
+
"default": "0",
|
212
|
+
"description": "This property specifies the tab order of the element.",
|
213
|
+
"attribute": "tabIndex",
|
214
|
+
"reflects": true,
|
215
|
+
"inheritedFrom": {
|
216
|
+
"name": "TabIndexMixin",
|
217
|
+
"module": "utils/mixins/TabIndexMixin.js"
|
218
|
+
}
|
120
219
|
},
|
121
220
|
{
|
122
221
|
"kind": "method",
|
123
|
-
"name": "
|
124
|
-
"privacy": "
|
125
|
-
"
|
126
|
-
"
|
127
|
-
|
128
|
-
|
129
|
-
|
222
|
+
"name": "executeAction",
|
223
|
+
"privacy": "protected",
|
224
|
+
"inheritedFrom": {
|
225
|
+
"name": "Buttonsimple",
|
226
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
227
|
+
}
|
228
|
+
},
|
229
|
+
{
|
230
|
+
"kind": "method",
|
231
|
+
"name": "setActive",
|
232
|
+
"privacy": "protected",
|
130
233
|
"parameters": [
|
131
234
|
{
|
132
|
-
"name": "
|
235
|
+
"name": "element",
|
133
236
|
"type": {
|
134
|
-
"text": "
|
237
|
+
"text": "HTMLElement"
|
135
238
|
},
|
136
|
-
"description": "
|
239
|
+
"description": "The button element"
|
137
240
|
},
|
138
241
|
{
|
139
|
-
"name": "
|
140
|
-
"optional": true,
|
242
|
+
"name": "active",
|
141
243
|
"type": {
|
142
|
-
"text": "
|
244
|
+
"text": "boolean"
|
143
245
|
},
|
144
|
-
"description": "
|
246
|
+
"description": "The active state of the element"
|
145
247
|
}
|
146
248
|
],
|
147
|
-
"description": "
|
148
|
-
|
149
|
-
|
150
|
-
|
151
|
-
|
249
|
+
"description": "Sets the aria-pressed attribute based on the active state of the button.",
|
250
|
+
"inheritedFrom": {
|
251
|
+
"name": "Buttonsimple",
|
252
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
253
|
+
}
|
254
|
+
},
|
255
|
+
{
|
256
|
+
"kind": "method",
|
257
|
+
"name": "setSoftDisabled",
|
152
258
|
"privacy": "private",
|
153
|
-
"return": {
|
154
|
-
"type": {
|
155
|
-
"text": ""
|
156
|
-
}
|
157
|
-
},
|
158
259
|
"parameters": [
|
159
260
|
{
|
160
|
-
"name": "
|
261
|
+
"name": "element",
|
161
262
|
"type": {
|
162
|
-
"text": "
|
263
|
+
"text": "HTMLElement"
|
163
264
|
},
|
164
|
-
"description": "
|
265
|
+
"description": "The button element."
|
165
266
|
},
|
166
267
|
{
|
167
|
-
"name": "
|
268
|
+
"name": "softDisabled",
|
168
269
|
"type": {
|
169
|
-
"text": "
|
270
|
+
"text": "boolean"
|
170
271
|
},
|
171
|
-
"description": "
|
272
|
+
"description": "The soft-disabled state."
|
172
273
|
}
|
173
274
|
],
|
174
|
-
"description": "
|
275
|
+
"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.",
|
276
|
+
"inheritedFrom": {
|
277
|
+
"name": "Buttonsimple",
|
278
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
279
|
+
}
|
175
280
|
},
|
176
281
|
{
|
177
282
|
"kind": "method",
|
178
|
-
"name": "
|
283
|
+
"name": "setDisabled",
|
179
284
|
"privacy": "private",
|
180
|
-
"
|
181
|
-
|
182
|
-
"
|
285
|
+
"parameters": [
|
286
|
+
{
|
287
|
+
"name": "element",
|
288
|
+
"type": {
|
289
|
+
"text": "HTMLElement"
|
290
|
+
},
|
291
|
+
"description": "The button element."
|
292
|
+
},
|
293
|
+
{
|
294
|
+
"name": "disabled",
|
295
|
+
"type": {
|
296
|
+
"text": "boolean"
|
297
|
+
},
|
298
|
+
"description": "The disabled state."
|
183
299
|
}
|
184
|
-
|
185
|
-
"description": "
|
300
|
+
],
|
301
|
+
"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.",
|
302
|
+
"inheritedFrom": {
|
303
|
+
"name": "Buttonsimple",
|
304
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
305
|
+
}
|
186
306
|
},
|
187
307
|
{
|
188
308
|
"kind": "method",
|
189
|
-
"name": "
|
309
|
+
"name": "triggerClickEvent",
|
190
310
|
"privacy": "private",
|
191
|
-
"
|
192
|
-
"
|
193
|
-
|
194
|
-
|
195
|
-
},
|
196
|
-
"description": "Method to generate the badge text and counter template."
|
311
|
+
"inheritedFrom": {
|
312
|
+
"name": "Buttonsimple",
|
313
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
314
|
+
}
|
197
315
|
},
|
198
316
|
{
|
199
317
|
"kind": "method",
|
200
|
-
"name": "
|
318
|
+
"name": "handleBlur",
|
201
319
|
"privacy": "private",
|
202
|
-
"
|
203
|
-
|
204
|
-
|
320
|
+
"description": "In case the button is pressed and the focus is lost while pressing,\nthe pressed class is removed.",
|
321
|
+
"inheritedFrom": {
|
322
|
+
"name": "Buttonsimple",
|
323
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
324
|
+
}
|
325
|
+
},
|
326
|
+
{
|
327
|
+
"kind": "method",
|
328
|
+
"name": "handleKeyDown",
|
329
|
+
"privacy": "private",
|
330
|
+
"parameters": [
|
331
|
+
{
|
332
|
+
"name": "event",
|
333
|
+
"type": {
|
334
|
+
"text": "KeyboardEvent"
|
335
|
+
},
|
336
|
+
"description": "The keyboard event."
|
205
337
|
}
|
206
|
-
|
207
|
-
"description": "
|
338
|
+
],
|
339
|
+
"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.",
|
340
|
+
"inheritedFrom": {
|
341
|
+
"name": "Buttonsimple",
|
342
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
343
|
+
}
|
208
344
|
},
|
209
345
|
{
|
210
346
|
"kind": "method",
|
211
|
-
"name": "
|
347
|
+
"name": "handleKeyUp",
|
212
348
|
"privacy": "private",
|
213
|
-
"
|
214
|
-
|
215
|
-
"
|
349
|
+
"parameters": [
|
350
|
+
{
|
351
|
+
"name": "event",
|
352
|
+
"type": {
|
353
|
+
"text": "KeyboardEvent"
|
354
|
+
},
|
355
|
+
"description": "The keyboard event."
|
216
356
|
}
|
217
|
-
|
218
|
-
"description": "
|
357
|
+
],
|
358
|
+
"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.",
|
359
|
+
"inheritedFrom": {
|
360
|
+
"name": "Buttonsimple",
|
361
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
362
|
+
}
|
363
|
+
}
|
364
|
+
],
|
365
|
+
"events": [
|
366
|
+
{
|
367
|
+
"description": "(React: onClick) This event is dispatched when the avatarbutton is clicked.",
|
368
|
+
"name": "click",
|
369
|
+
"reactName": "onClick",
|
370
|
+
"eventName": "ClickEvent",
|
371
|
+
"inheritedFrom": {
|
372
|
+
"name": "Buttonsimple",
|
373
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
374
|
+
}
|
219
375
|
},
|
220
376
|
{
|
221
|
-
"
|
222
|
-
"name": "
|
223
|
-
"
|
224
|
-
|
225
|
-
},
|
226
|
-
"description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
|
227
|
-
"attribute": "icon-name",
|
377
|
+
"description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the avatarbutton.",
|
378
|
+
"name": "keydown",
|
379
|
+
"reactName": "onKeyDown",
|
380
|
+
"eventName": "KeydownEvent",
|
228
381
|
"inheritedFrom": {
|
229
|
-
"name": "
|
230
|
-
"module": "
|
382
|
+
"name": "Buttonsimple",
|
383
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
384
|
+
}
|
385
|
+
},
|
386
|
+
{
|
387
|
+
"description": "(React: onKeyUp) This event is dispatched when a key is released on the avatarbutton.",
|
388
|
+
"name": "keyup",
|
389
|
+
"reactName": "onKeyUp",
|
390
|
+
"eventName": "KeyupEvent",
|
391
|
+
"inheritedFrom": {
|
392
|
+
"name": "Buttonsimple",
|
393
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
394
|
+
}
|
395
|
+
},
|
396
|
+
{
|
397
|
+
"description": "(React: onFocus) This event is dispatched when the avatarbutton receives focus.",
|
398
|
+
"name": "focus",
|
399
|
+
"reactName": "onFocus",
|
400
|
+
"eventName": "FocusEvent",
|
401
|
+
"inheritedFrom": {
|
402
|
+
"name": "Buttonsimple",
|
403
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
231
404
|
}
|
232
405
|
}
|
233
406
|
],
|
234
407
|
"attributes": [
|
235
408
|
{
|
236
|
-
"name": "
|
409
|
+
"name": "aria-label",
|
237
410
|
"type": {
|
238
|
-
"text": "
|
411
|
+
"text": "string | null"
|
239
412
|
},
|
240
|
-
"
|
241
|
-
"
|
413
|
+
"default": "null",
|
414
|
+
"description": "Aria-label attribute to be set for accessibility",
|
415
|
+
"fieldName": "ariaLabel"
|
242
416
|
},
|
243
417
|
{
|
244
|
-
"name": "
|
418
|
+
"name": "src",
|
245
419
|
"type": {
|
246
|
-
"text": "
|
420
|
+
"text": "string | undefined"
|
247
421
|
},
|
248
|
-
"description": "
|
249
|
-
"
|
250
|
-
"
|
422
|
+
"description": "The src is the url which will be used to display the avatar.\nWhen the src is loading, we will display the initials as a placeholder.",
|
423
|
+
"fieldName": "src",
|
424
|
+
"inheritedFrom": {
|
425
|
+
"name": "AvatarComponentMixin",
|
426
|
+
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
427
|
+
}
|
251
428
|
},
|
252
429
|
{
|
253
|
-
"name": "
|
430
|
+
"name": "initials",
|
254
431
|
"type": {
|
255
|
-
"text": "
|
432
|
+
"text": "string | undefined"
|
256
433
|
},
|
257
|
-
"description": "
|
258
|
-
"fieldName": "
|
434
|
+
"description": "The initials to be displayed for the avatar.",
|
435
|
+
"fieldName": "initials",
|
436
|
+
"inheritedFrom": {
|
437
|
+
"name": "AvatarComponentMixin",
|
438
|
+
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
439
|
+
}
|
259
440
|
},
|
260
441
|
{
|
261
|
-
"name": "
|
442
|
+
"name": "presence",
|
262
443
|
"type": {
|
263
|
-
"text": "
|
444
|
+
"text": "PresenceType | undefined"
|
264
445
|
},
|
265
|
-
"description": "The
|
266
|
-
"
|
267
|
-
"
|
446
|
+
"description": "The presence is the status which can be used to display the\nactivity state of a user or a space within an avatar component.\n\nAcceptable values include:\n- `active`\n- `away`\n- `away-calling`\n- `busy`\n- `dnd`\n- `meeting`\n- `on-call`\n- `on-device`\n- `on-mobile`\n- `pause`\n- `pto`\n- `presenting`\n- `quiet`\n- `scheduled`",
|
447
|
+
"fieldName": "presence",
|
448
|
+
"inheritedFrom": {
|
449
|
+
"name": "AvatarComponentMixin",
|
450
|
+
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
451
|
+
}
|
268
452
|
},
|
269
453
|
{
|
270
|
-
"name": "
|
454
|
+
"name": "size",
|
271
455
|
"type": {
|
272
|
-
"text": "
|
456
|
+
"text": "ButtonSize"
|
273
457
|
},
|
274
|
-
"
|
275
|
-
"
|
276
|
-
"fieldName": "
|
458
|
+
"description": "Acceptable values include (size in px unit):\n- 24\n- 32\n- 48\n- 64\n- 72\n- 88\n- 124",
|
459
|
+
"default": "32",
|
460
|
+
"fieldName": "size",
|
461
|
+
"inheritedFrom": {
|
462
|
+
"name": "Buttonsimple",
|
463
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
464
|
+
}
|
277
465
|
},
|
278
466
|
{
|
279
|
-
"name": "
|
467
|
+
"name": "counter",
|
280
468
|
"type": {
|
281
|
-
"text": "
|
469
|
+
"text": "number | undefined"
|
282
470
|
},
|
283
|
-
"
|
284
|
-
"
|
285
|
-
"
|
471
|
+
"description": "The counter is the number which can be displayed on the avatar.\nThe maximum number is 99 and if the given number is greater than 99,\nthen the avatar will be displayed as `99+`.\nIf the given number is a negative number,\nthen the avatar will be displayed as `0`.",
|
472
|
+
"fieldName": "counter",
|
473
|
+
"inheritedFrom": {
|
474
|
+
"name": "AvatarComponentMixin",
|
475
|
+
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
476
|
+
}
|
477
|
+
},
|
478
|
+
{
|
479
|
+
"name": "is-typing",
|
480
|
+
"type": {
|
481
|
+
"text": "boolean"
|
482
|
+
},
|
483
|
+
"default": "false",
|
484
|
+
"description": "Represents the typing indicator when the user is typing.",
|
485
|
+
"fieldName": "isTyping",
|
486
|
+
"inheritedFrom": {
|
487
|
+
"name": "AvatarComponentMixin",
|
488
|
+
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
489
|
+
}
|
286
490
|
},
|
287
491
|
{
|
288
492
|
"name": "icon-name",
|
@@ -295,193 +499,188 @@
|
|
295
499
|
"name": "IconNameMixin",
|
296
500
|
"module": "src/utils/mixins/IconNameMixin.ts"
|
297
501
|
}
|
298
|
-
}
|
299
|
-
],
|
300
|
-
"mixins": [
|
301
|
-
{
|
302
|
-
"name": "IconNameMixin",
|
303
|
-
"module": "/src/utils/mixins/IconNameMixin"
|
304
|
-
}
|
305
|
-
],
|
306
|
-
"superclass": {
|
307
|
-
"name": "Component",
|
308
|
-
"module": "/src/models"
|
309
|
-
},
|
310
|
-
"tagName": "mdc-badge",
|
311
|
-
"jsDoc": "/**\n * The `mdc-badge` component is a versatile UI element used to\n * display dot, icons, counters, success, warning and error type badge.\n *\n * Supported badge types:\n * - `dot`: Displays a dot notification badge with a blue color.\n * - `icon`: Displays a badge with a specified icon using the `icon-name` attribute.\n * - `counter`: Displays a badge with a counter value. If the counter exceeds the `max-counter`,\n * it shows `maxCounter+`. The maximum value of the counter is 999 and anything above that will be set to `999+`.\n * - `success`: Displays a success badge with a check circle icon and green color.\n * - `warning`: Displays a warning badge with a warning icon and yellow color.\n * - `error`: Displays a error badge with a error legacy icon and red color.\n *\n * For `icon`, `success`, `warning` and `error` types, the `mdc-icon` component is used to render the icon.\n *\n * For the `counter` type, the `mdc-text` component is used to render the counter value.\n *\n * @dependency mdc-icon\n * @dependency mdc-text\n *\n * @tagname mdc-badge\n *\n * @cssproperty --mdc-badge-primary-foreground-color - The foreground color of the primary badge.\n * @cssproperty --mdc-badge-primary-background-color - The background color of the primary badge.\n * @cssproperty --mdc-badge-secondary-foreground-color - The foreground color of the secondary badge.\n * @cssproperty --mdc-badge-secondary-background-color - The background color of the secondary badge.\n * @cssproperty --mdc-badge-success-foreground-color - The foreground color of the success badge.\n * @cssproperty --mdc-badge-success-background-color - The background color of the success badge.\n * @cssproperty --mdc-badge-warning-foreground-color - The foreground color of the warning badge.\n * @cssproperty --mdc-badge-warning-background-color - The background color of the warning badge.\n * @cssproperty --mdc-badge-error-foreground-color - The foreground color of the error badge.\n * @cssproperty --mdc-badge-error-background-color - The background color of the error badge.\n * @cssproperty --mdc-badge-overlay-background-color - The background color of the badge overlay.\n */",
|
312
|
-
"customElement": true
|
313
|
-
}
|
314
|
-
],
|
315
|
-
"exports": [
|
316
|
-
{
|
317
|
-
"kind": "js",
|
318
|
-
"name": "default",
|
319
|
-
"declaration": {
|
320
|
-
"name": "Badge",
|
321
|
-
"module": "components/badge/badge.component.js"
|
322
|
-
}
|
323
|
-
}
|
324
|
-
]
|
325
|
-
},
|
326
|
-
{
|
327
|
-
"kind": "javascript-module",
|
328
|
-
"path": "components/avatarbutton/avatarbutton.component.js",
|
329
|
-
"declarations": [
|
330
|
-
{
|
331
|
-
"kind": "class",
|
332
|
-
"description": "The `mdc-avatarbutton` component is an interactable version of the `mdc-avatar` component.\n\nThis component is made by extending `buttonsimple` class.\nThe button component acts as a wrapper for the avatar component.",
|
333
|
-
"name": "AvatarButton",
|
334
|
-
"members": [
|
502
|
+
},
|
335
503
|
{
|
336
|
-
"
|
337
|
-
"name": "ariaLabel",
|
504
|
+
"name": "tabIndex",
|
338
505
|
"type": {
|
339
|
-
"text": "
|
506
|
+
"text": "number"
|
340
507
|
},
|
341
|
-
"default": "
|
342
|
-
"description": "
|
343
|
-
"
|
344
|
-
|
345
|
-
|
346
|
-
|
347
|
-
|
348
|
-
"privacy": "private",
|
349
|
-
"parameters": [
|
350
|
-
{
|
351
|
-
"name": "size",
|
352
|
-
"type": {
|
353
|
-
"text": "AvatarSize"
|
354
|
-
}
|
355
|
-
}
|
356
|
-
]
|
508
|
+
"default": "0",
|
509
|
+
"description": "This property specifies the tab order of the element.",
|
510
|
+
"fieldName": "tabIndex",
|
511
|
+
"inheritedFrom": {
|
512
|
+
"name": "TabIndexMixin",
|
513
|
+
"module": "src/utils/mixins/TabIndexMixin.ts"
|
514
|
+
}
|
357
515
|
},
|
358
516
|
{
|
359
|
-
"
|
360
|
-
"name": "active",
|
517
|
+
"name": "disabled",
|
361
518
|
"type": {
|
362
519
|
"text": "boolean"
|
363
520
|
},
|
364
|
-
"default": "
|
365
|
-
"description": "
|
366
|
-
"
|
367
|
-
"reflects": true,
|
521
|
+
"default": "false",
|
522
|
+
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
523
|
+
"fieldName": "disabled",
|
368
524
|
"inheritedFrom": {
|
369
|
-
"name": "
|
370
|
-
"module": "
|
525
|
+
"name": "DisabledMixin",
|
526
|
+
"module": "src/utils/mixins/DisabledMixin.ts"
|
371
527
|
}
|
372
528
|
},
|
373
529
|
{
|
374
|
-
"
|
375
|
-
"name": "disabled",
|
530
|
+
"name": "active",
|
376
531
|
"type": {
|
377
532
|
"text": "boolean"
|
378
533
|
},
|
379
|
-
"default": "
|
380
|
-
"description": "
|
381
|
-
"
|
382
|
-
"reflects": true,
|
534
|
+
"default": "false",
|
535
|
+
"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.",
|
536
|
+
"fieldName": "active",
|
383
537
|
"inheritedFrom": {
|
384
|
-
"name": "
|
385
|
-
"module": "
|
538
|
+
"name": "Buttonsimple",
|
539
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
386
540
|
}
|
387
541
|
},
|
388
542
|
{
|
389
|
-
"
|
390
|
-
"name": "softDisabled",
|
543
|
+
"name": "soft-disabled",
|
391
544
|
"type": {
|
392
545
|
"text": "boolean"
|
393
546
|
},
|
394
|
-
"default": "
|
547
|
+
"default": "false",
|
395
548
|
"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.",
|
396
|
-
"
|
549
|
+
"fieldName": "softDisabled",
|
397
550
|
"inheritedFrom": {
|
398
551
|
"name": "Buttonsimple",
|
399
|
-
"module": "components/buttonsimple/buttonsimple.component.
|
552
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
400
553
|
}
|
401
554
|
},
|
402
555
|
{
|
403
|
-
"kind": "field",
|
404
556
|
"name": "role",
|
405
557
|
"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.",
|
406
|
-
"default": "
|
407
|
-
"
|
408
|
-
"reflects": true,
|
409
|
-
"type": {
|
410
|
-
"text": "string"
|
411
|
-
},
|
558
|
+
"default": "button",
|
559
|
+
"fieldName": "role",
|
412
560
|
"inheritedFrom": {
|
413
561
|
"name": "Buttonsimple",
|
414
|
-
"module": "components/buttonsimple/buttonsimple.component.
|
562
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
415
563
|
}
|
416
564
|
},
|
417
565
|
{
|
418
|
-
"kind": "field",
|
419
566
|
"name": "type",
|
420
567
|
"type": {
|
421
568
|
"text": "ButtonType"
|
422
569
|
},
|
423
570
|
"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.",
|
424
571
|
"default": "button",
|
425
|
-
"
|
426
|
-
"reflects": true,
|
572
|
+
"fieldName": "type",
|
427
573
|
"inheritedFrom": {
|
428
574
|
"name": "Buttonsimple",
|
429
|
-
"module": "components/buttonsimple/buttonsimple.component.
|
575
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
430
576
|
}
|
577
|
+
}
|
578
|
+
],
|
579
|
+
"mixins": [
|
580
|
+
{
|
581
|
+
"name": "AvatarComponentMixin",
|
582
|
+
"module": "/src/utils/mixins/AvatarComponentMixin"
|
431
583
|
},
|
432
584
|
{
|
433
|
-
"
|
434
|
-
"
|
435
|
-
|
436
|
-
|
437
|
-
|
438
|
-
|
439
|
-
|
440
|
-
|
441
|
-
|
442
|
-
|
443
|
-
|
585
|
+
"name": "IconNameMixin",
|
586
|
+
"module": "/src/utils/mixins/IconNameMixin"
|
587
|
+
}
|
588
|
+
],
|
589
|
+
"superclass": {
|
590
|
+
"name": "Buttonsimple",
|
591
|
+
"module": "/src/components/buttonsimple/buttonsimple.component"
|
592
|
+
},
|
593
|
+
"tagName": "mdc-avatarbutton",
|
594
|
+
"jsDoc": "/**\n * The `mdc-avatarbutton` component is an interactable version of the `mdc-avatar` component.\n *\n * This component is made by extending `buttonsimple` class.\n * The button component acts as a wrapper for the avatar component.\n *\n * @dependency mdc-avatar\n *\n * @event click - (React: onClick) This event is dispatched when the avatarbutton is clicked.\n * @event keydown - (React: onKeyDown) This event is dispatched when a key is pressed down on the avatarbutton.\n * @event keyup - (React: onKeyUp) This event is dispatched when a key is released on the avatarbutton.\n * @event focus - (React: onFocus) This event is dispatched when the avatarbutton receives focus.\n *\n * @tagname mdc-avatarbutton\n */",
|
595
|
+
"customElement": true
|
596
|
+
}
|
597
|
+
],
|
598
|
+
"exports": [
|
599
|
+
{
|
600
|
+
"kind": "js",
|
601
|
+
"name": "default",
|
602
|
+
"declaration": {
|
603
|
+
"name": "AvatarButton",
|
604
|
+
"module": "components/avatarbutton/avatarbutton.component.js"
|
605
|
+
}
|
606
|
+
}
|
607
|
+
]
|
608
|
+
},
|
609
|
+
{
|
610
|
+
"kind": "javascript-module",
|
611
|
+
"path": "components/badge/badge.component.js",
|
612
|
+
"declarations": [
|
613
|
+
{
|
614
|
+
"kind": "class",
|
615
|
+
"description": "The `mdc-badge` component is a versatile UI element used to\ndisplay dot, icons, counters, success, warning and error type badge.\n\nSupported badge types:\n- `dot`: Displays a dot notification badge with a blue color.\n- `icon`: Displays a badge with a specified icon using the `icon-name` attribute.\n- `counter`: Displays a badge with a counter value. If the counter exceeds the `max-counter`,\nit shows `maxCounter+`. The maximum value of the counter is 999 and anything above that will be set to `999+`.\n- `success`: Displays a success badge with a check circle icon and green color.\n- `warning`: Displays a warning badge with a warning icon and yellow color.\n- `error`: Displays a error badge with a error legacy icon and red color.\n\nFor `icon`, `success`, `warning` and `error` types, the `mdc-icon` component is used to render the icon.\n\nFor the `counter` type, the `mdc-text` component is used to render the counter value.",
|
616
|
+
"name": "Badge",
|
617
|
+
"cssProperties": [
|
618
|
+
{
|
619
|
+
"description": "The foreground color of the primary badge.",
|
620
|
+
"name": "--mdc-badge-primary-foreground-color"
|
444
621
|
},
|
445
622
|
{
|
446
|
-
"
|
447
|
-
"name": "
|
448
|
-
|
449
|
-
|
450
|
-
|
451
|
-
"
|
452
|
-
|
453
|
-
|
454
|
-
|
455
|
-
|
456
|
-
|
623
|
+
"description": "The background color of the primary badge.",
|
624
|
+
"name": "--mdc-badge-primary-background-color"
|
625
|
+
},
|
626
|
+
{
|
627
|
+
"description": "The foreground color of the secondary badge.",
|
628
|
+
"name": "--mdc-badge-secondary-foreground-color"
|
629
|
+
},
|
630
|
+
{
|
631
|
+
"description": "The background color of the secondary badge.",
|
632
|
+
"name": "--mdc-badge-secondary-background-color"
|
633
|
+
},
|
634
|
+
{
|
635
|
+
"description": "The foreground color of the success badge.",
|
636
|
+
"name": "--mdc-badge-success-foreground-color"
|
637
|
+
},
|
638
|
+
{
|
639
|
+
"description": "The background color of the success badge.",
|
640
|
+
"name": "--mdc-badge-success-background-color"
|
641
|
+
},
|
642
|
+
{
|
643
|
+
"description": "The foreground color of the warning badge.",
|
644
|
+
"name": "--mdc-badge-warning-foreground-color"
|
645
|
+
},
|
646
|
+
{
|
647
|
+
"description": "The background color of the warning badge.",
|
648
|
+
"name": "--mdc-badge-warning-background-color"
|
649
|
+
},
|
650
|
+
{
|
651
|
+
"description": "The foreground color of the error badge.",
|
652
|
+
"name": "--mdc-badge-error-foreground-color"
|
653
|
+
},
|
654
|
+
{
|
655
|
+
"description": "The background color of the error badge.",
|
656
|
+
"name": "--mdc-badge-error-background-color"
|
457
657
|
},
|
658
|
+
{
|
659
|
+
"description": "The background color of the badge overlay.",
|
660
|
+
"name": "--mdc-badge-overlay-background-color"
|
661
|
+
}
|
662
|
+
],
|
663
|
+
"members": [
|
458
664
|
{
|
459
665
|
"kind": "field",
|
460
|
-
"name": "
|
666
|
+
"name": "type",
|
461
667
|
"type": {
|
462
|
-
"text": "
|
668
|
+
"text": "BadgeType | undefined"
|
463
669
|
},
|
464
|
-
"description": "
|
465
|
-
"attribute": "
|
466
|
-
"
|
467
|
-
"name": "AvatarComponentMixin",
|
468
|
-
"module": "utils/mixins/AvatarComponentMixin.js"
|
469
|
-
}
|
670
|
+
"description": "Type of the badge\nCan be `dot` (notification) , `icon`, `counter`, `success`, `warning` or `error`.",
|
671
|
+
"attribute": "type",
|
672
|
+
"reflects": true
|
470
673
|
},
|
471
674
|
{
|
472
675
|
"kind": "field",
|
473
|
-
"name": "
|
676
|
+
"name": "variant",
|
474
677
|
"type": {
|
475
|
-
"text": "
|
678
|
+
"text": "IconVariant"
|
476
679
|
},
|
477
|
-
"description": "
|
478
|
-
"default": "
|
479
|
-
"attribute": "
|
480
|
-
"reflects": true
|
481
|
-
"inheritedFrom": {
|
482
|
-
"name": "Buttonsimple",
|
483
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
484
|
-
}
|
680
|
+
"description": "Type of the variant can be `primary` or `secondary`.\nIt defines the background and foreground color of the icon.",
|
681
|
+
"default": "primary",
|
682
|
+
"attribute": "variant",
|
683
|
+
"reflects": true
|
485
684
|
},
|
486
685
|
{
|
487
686
|
"kind": "field",
|
@@ -489,325 +688,205 @@
|
|
489
688
|
"type": {
|
490
689
|
"text": "number | undefined"
|
491
690
|
},
|
492
|
-
"description": "
|
493
|
-
"attribute": "counter"
|
494
|
-
"inheritedFrom": {
|
495
|
-
"name": "AvatarComponentMixin",
|
496
|
-
"module": "utils/mixins/AvatarComponentMixin.js"
|
497
|
-
}
|
691
|
+
"description": "Counter is the number which can be provided in the badge.",
|
692
|
+
"attribute": "counter"
|
498
693
|
},
|
499
694
|
{
|
500
695
|
"kind": "field",
|
501
|
-
"name": "
|
696
|
+
"name": "maxCounter",
|
502
697
|
"type": {
|
503
|
-
"text": "
|
698
|
+
"text": "number"
|
504
699
|
},
|
505
|
-
"
|
506
|
-
"
|
507
|
-
"attribute": "
|
508
|
-
"
|
509
|
-
"name": "AvatarComponentMixin",
|
510
|
-
"module": "utils/mixins/AvatarComponentMixin.js"
|
511
|
-
}
|
700
|
+
"description": "The maximum number can be set up to 999, anything above that will be rendered as _999+_.\nThe max counter can be `9`, `99` or `999`.",
|
701
|
+
"default": "99",
|
702
|
+
"attribute": "max-counter",
|
703
|
+
"reflects": true
|
512
704
|
},
|
513
705
|
{
|
514
706
|
"kind": "field",
|
515
|
-
"name": "
|
707
|
+
"name": "overlay",
|
516
708
|
"type": {
|
517
|
-
"text": "
|
709
|
+
"text": "boolean"
|
518
710
|
},
|
519
|
-
"
|
520
|
-
"
|
521
|
-
"
|
522
|
-
"name": "IconNameMixin",
|
523
|
-
"module": "utils/mixins/IconNameMixin.js"
|
524
|
-
}
|
711
|
+
"default": "false",
|
712
|
+
"description": "Overlay is to add a thin outline to the badge.\nThis will help distinguish between the badge and the button,\nwhere the badge will be layered on top of a button.",
|
713
|
+
"attribute": "overlay"
|
525
714
|
},
|
526
715
|
{
|
527
716
|
"kind": "field",
|
528
|
-
"name": "
|
717
|
+
"name": "ariaLabel",
|
529
718
|
"type": {
|
530
|
-
"text": "
|
719
|
+
"text": "string | null"
|
531
720
|
},
|
532
|
-
"default": "
|
533
|
-
"description": "
|
534
|
-
"attribute": "
|
535
|
-
"reflects": true,
|
536
|
-
"inheritedFrom": {
|
537
|
-
"name": "TabIndexMixin",
|
538
|
-
"module": "utils/mixins/TabIndexMixin.js"
|
539
|
-
}
|
540
|
-
},
|
541
|
-
{
|
542
|
-
"kind": "method",
|
543
|
-
"name": "executeAction",
|
544
|
-
"privacy": "protected",
|
545
|
-
"inheritedFrom": {
|
546
|
-
"name": "Buttonsimple",
|
547
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
548
|
-
}
|
549
|
-
},
|
550
|
-
{
|
551
|
-
"kind": "method",
|
552
|
-
"name": "setActive",
|
553
|
-
"privacy": "protected",
|
554
|
-
"parameters": [
|
555
|
-
{
|
556
|
-
"name": "element",
|
557
|
-
"type": {
|
558
|
-
"text": "HTMLElement"
|
559
|
-
},
|
560
|
-
"description": "The button element"
|
561
|
-
},
|
562
|
-
{
|
563
|
-
"name": "active",
|
564
|
-
"type": {
|
565
|
-
"text": "boolean"
|
566
|
-
},
|
567
|
-
"description": "The active state of the element"
|
568
|
-
}
|
569
|
-
],
|
570
|
-
"description": "Sets the aria-pressed attribute based on the active state of the button.",
|
571
|
-
"inheritedFrom": {
|
572
|
-
"name": "Buttonsimple",
|
573
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
574
|
-
}
|
721
|
+
"default": "null",
|
722
|
+
"description": "Aria-label attribute to be set for accessibility",
|
723
|
+
"attribute": "aria-label"
|
575
724
|
},
|
576
725
|
{
|
577
726
|
"kind": "method",
|
578
|
-
"name": "
|
727
|
+
"name": "getCounterText",
|
579
728
|
"privacy": "private",
|
729
|
+
"return": {
|
730
|
+
"type": {
|
731
|
+
"text": ""
|
732
|
+
}
|
733
|
+
},
|
580
734
|
"parameters": [
|
581
735
|
{
|
582
|
-
"name": "
|
736
|
+
"name": "maxCounter",
|
583
737
|
"type": {
|
584
|
-
"text": "
|
738
|
+
"text": "number"
|
585
739
|
},
|
586
|
-
"description": "
|
740
|
+
"description": "the maximum limit which can be displayed on the badge"
|
587
741
|
},
|
588
742
|
{
|
589
|
-
"name": "
|
743
|
+
"name": "counter",
|
744
|
+
"optional": true,
|
590
745
|
"type": {
|
591
|
-
"text": "
|
746
|
+
"text": "number"
|
592
747
|
},
|
593
|
-
"description": "
|
748
|
+
"description": "the number to be displayed on the badge"
|
594
749
|
}
|
595
750
|
],
|
596
|
-
"description": "
|
597
|
-
"inheritedFrom": {
|
598
|
-
"name": "Buttonsimple",
|
599
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
600
|
-
}
|
751
|
+
"description": "If `type` is set to `counter` and if `counter` is greater than `maxCounter`,\nthen it will return a string the maxCounter value as string.\nOtherwise, it will return a string representation of `counter`.\nIf `counter` is not a number, it will return an empty string."
|
601
752
|
},
|
602
753
|
{
|
603
754
|
"kind": "method",
|
604
|
-
"name": "
|
755
|
+
"name": "getBadgeIcon",
|
605
756
|
"privacy": "private",
|
757
|
+
"return": {
|
758
|
+
"type": {
|
759
|
+
"text": ""
|
760
|
+
}
|
761
|
+
},
|
606
762
|
"parameters": [
|
607
763
|
{
|
608
|
-
"name": "
|
764
|
+
"name": "iconName",
|
609
765
|
"type": {
|
610
|
-
"text": "
|
766
|
+
"text": "string"
|
611
767
|
},
|
612
|
-
"description": "
|
768
|
+
"description": "the name of the icon from the icon set"
|
613
769
|
},
|
614
770
|
{
|
615
|
-
"name": "
|
771
|
+
"name": "backgroundClassPostfix",
|
616
772
|
"type": {
|
617
|
-
"text": "
|
773
|
+
"text": "string"
|
618
774
|
},
|
619
|
-
"description": "
|
775
|
+
"description": "postfix for the class to style the badge icon."
|
620
776
|
}
|
621
777
|
],
|
622
|
-
"description": "
|
623
|
-
"inheritedFrom": {
|
624
|
-
"name": "Buttonsimple",
|
625
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
626
|
-
}
|
778
|
+
"description": "Method to generate the badge icon."
|
627
779
|
},
|
628
780
|
{
|
629
781
|
"kind": "method",
|
630
|
-
"name": "
|
782
|
+
"name": "getBadgeDot",
|
631
783
|
"privacy": "private",
|
632
|
-
"
|
633
|
-
"
|
634
|
-
|
635
|
-
|
784
|
+
"return": {
|
785
|
+
"type": {
|
786
|
+
"text": ""
|
787
|
+
}
|
788
|
+
},
|
789
|
+
"description": "Method to generate the badge dot template."
|
636
790
|
},
|
637
791
|
{
|
638
792
|
"kind": "method",
|
639
|
-
"name": "
|
793
|
+
"name": "getBadgeCounterText",
|
640
794
|
"privacy": "private",
|
641
|
-
"
|
642
|
-
|
643
|
-
|
644
|
-
|
645
|
-
}
|
795
|
+
"return": {
|
796
|
+
"type": {
|
797
|
+
"text": ""
|
798
|
+
}
|
799
|
+
},
|
800
|
+
"description": "Method to generate the badge text and counter template."
|
646
801
|
},
|
647
802
|
{
|
648
803
|
"kind": "method",
|
649
|
-
"name": "
|
804
|
+
"name": "setRoleByAriaLabel",
|
650
805
|
"privacy": "private",
|
651
|
-
"
|
652
|
-
{
|
653
|
-
"
|
654
|
-
"type": {
|
655
|
-
"text": "KeyboardEvent"
|
656
|
-
},
|
657
|
-
"description": "The keyboard event."
|
806
|
+
"return": {
|
807
|
+
"type": {
|
808
|
+
"text": "void"
|
658
809
|
}
|
659
|
-
|
660
|
-
"description": "
|
661
|
-
"inheritedFrom": {
|
662
|
-
"name": "Buttonsimple",
|
663
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
664
|
-
}
|
810
|
+
},
|
811
|
+
"description": "Method to set the role based on the aria-label provided.\nIf the aria-label is provided, the role of the element will be 'img'.\nOtherwise, the role will be null."
|
665
812
|
},
|
666
813
|
{
|
667
814
|
"kind": "method",
|
668
|
-
"name": "
|
815
|
+
"name": "getBadgeContentBasedOnType",
|
669
816
|
"privacy": "private",
|
670
|
-
"
|
671
|
-
{
|
672
|
-
"
|
673
|
-
"type": {
|
674
|
-
"text": "KeyboardEvent"
|
675
|
-
},
|
676
|
-
"description": "The keyboard event."
|
817
|
+
"return": {
|
818
|
+
"type": {
|
819
|
+
"text": ""
|
677
820
|
}
|
678
|
-
|
679
|
-
"description": "
|
680
|
-
"inheritedFrom": {
|
681
|
-
"name": "Buttonsimple",
|
682
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
683
|
-
}
|
684
|
-
}
|
685
|
-
],
|
686
|
-
"events": [
|
687
|
-
{
|
688
|
-
"description": "(React: onClick) This event is dispatched when the avatarbutton is clicked.",
|
689
|
-
"name": "click",
|
690
|
-
"reactName": "onClick",
|
691
|
-
"eventName": "ClickEvent",
|
692
|
-
"inheritedFrom": {
|
693
|
-
"name": "Buttonsimple",
|
694
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
695
|
-
}
|
696
|
-
},
|
697
|
-
{
|
698
|
-
"description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the avatarbutton.",
|
699
|
-
"name": "keydown",
|
700
|
-
"reactName": "onKeyDown",
|
701
|
-
"eventName": "KeydownEvent",
|
702
|
-
"inheritedFrom": {
|
703
|
-
"name": "Buttonsimple",
|
704
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
705
|
-
}
|
706
|
-
},
|
707
|
-
{
|
708
|
-
"description": "(React: onKeyUp) This event is dispatched when a key is released on the avatarbutton.",
|
709
|
-
"name": "keyup",
|
710
|
-
"reactName": "onKeyUp",
|
711
|
-
"eventName": "KeyupEvent",
|
712
|
-
"inheritedFrom": {
|
713
|
-
"name": "Buttonsimple",
|
714
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
715
|
-
}
|
821
|
+
},
|
822
|
+
"description": "Generates the badge content based on the badge type.\nUtilizes various helper methods to create the appropriate badge template based on the\ncurrent badge type. Supports 'dot', 'icon', 'counter', 'success', 'warning', and 'error'\ntypes, returning the corresponding template result for each type."
|
716
823
|
},
|
717
824
|
{
|
718
|
-
"
|
719
|
-
"name": "
|
720
|
-
"
|
721
|
-
|
825
|
+
"kind": "field",
|
826
|
+
"name": "iconName",
|
827
|
+
"type": {
|
828
|
+
"text": "IconNames | undefined"
|
829
|
+
},
|
830
|
+
"description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
|
831
|
+
"attribute": "icon-name",
|
722
832
|
"inheritedFrom": {
|
723
|
-
"name": "
|
724
|
-
"module": "
|
833
|
+
"name": "IconNameMixin",
|
834
|
+
"module": "utils/mixins/IconNameMixin.js"
|
725
835
|
}
|
726
836
|
}
|
727
837
|
],
|
728
838
|
"attributes": [
|
729
839
|
{
|
730
|
-
"name": "
|
840
|
+
"name": "type",
|
731
841
|
"type": {
|
732
|
-
"text": "
|
842
|
+
"text": "BadgeType | undefined"
|
733
843
|
},
|
734
|
-
"
|
735
|
-
"
|
736
|
-
"fieldName": "ariaLabel"
|
844
|
+
"description": "Type of the badge\nCan be `dot` (notification) , `icon`, `counter`, `success`, `warning` or `error`.",
|
845
|
+
"fieldName": "type"
|
737
846
|
},
|
738
847
|
{
|
739
|
-
"name": "
|
740
|
-
"type": {
|
741
|
-
"text": "string | undefined"
|
742
|
-
},
|
743
|
-
"description": "The src is the url which will be used to display the avatar.\nWhen the src is loading, we will display the initials as a placeholder.",
|
744
|
-
"fieldName": "src",
|
745
|
-
"inheritedFrom": {
|
746
|
-
"name": "AvatarComponentMixin",
|
747
|
-
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
748
|
-
}
|
749
|
-
},
|
750
|
-
{
|
751
|
-
"name": "initials",
|
848
|
+
"name": "variant",
|
752
849
|
"type": {
|
753
|
-
"text": "
|
850
|
+
"text": "IconVariant"
|
754
851
|
},
|
755
|
-
"description": "
|
756
|
-
"
|
757
|
-
"
|
758
|
-
"name": "AvatarComponentMixin",
|
759
|
-
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
760
|
-
}
|
852
|
+
"description": "Type of the variant can be `primary` or `secondary`.\nIt defines the background and foreground color of the icon.",
|
853
|
+
"default": "primary",
|
854
|
+
"fieldName": "variant"
|
761
855
|
},
|
762
856
|
{
|
763
|
-
"name": "
|
857
|
+
"name": "counter",
|
764
858
|
"type": {
|
765
|
-
"text": "
|
859
|
+
"text": "number | undefined"
|
766
860
|
},
|
767
|
-
"description": "
|
768
|
-
"fieldName": "
|
769
|
-
"inheritedFrom": {
|
770
|
-
"name": "AvatarComponentMixin",
|
771
|
-
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
772
|
-
}
|
861
|
+
"description": "Counter is the number which can be provided in the badge.",
|
862
|
+
"fieldName": "counter"
|
773
863
|
},
|
774
864
|
{
|
775
|
-
"name": "
|
865
|
+
"name": "max-counter",
|
776
866
|
"type": {
|
777
|
-
"text": "
|
867
|
+
"text": "number"
|
778
868
|
},
|
779
|
-
"description": "
|
780
|
-
"default": "
|
781
|
-
"fieldName": "
|
782
|
-
"inheritedFrom": {
|
783
|
-
"name": "Buttonsimple",
|
784
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
785
|
-
}
|
869
|
+
"description": "The maximum number can be set up to 999, anything above that will be rendered as _999+_.\nThe max counter can be `9`, `99` or `999`.",
|
870
|
+
"default": "99",
|
871
|
+
"fieldName": "maxCounter"
|
786
872
|
},
|
787
873
|
{
|
788
|
-
"name": "
|
874
|
+
"name": "overlay",
|
789
875
|
"type": {
|
790
|
-
"text": "
|
876
|
+
"text": "boolean"
|
791
877
|
},
|
792
|
-
"
|
793
|
-
"
|
794
|
-
"
|
795
|
-
"name": "AvatarComponentMixin",
|
796
|
-
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
797
|
-
}
|
878
|
+
"default": "false",
|
879
|
+
"description": "Overlay is to add a thin outline to the badge.\nThis will help distinguish between the badge and the button,\nwhere the badge will be layered on top of a button.",
|
880
|
+
"fieldName": "overlay"
|
798
881
|
},
|
799
882
|
{
|
800
|
-
"name": "
|
883
|
+
"name": "aria-label",
|
801
884
|
"type": {
|
802
|
-
"text": "
|
885
|
+
"text": "string | null"
|
803
886
|
},
|
804
|
-
"default": "
|
805
|
-
"description": "
|
806
|
-
"fieldName": "
|
807
|
-
"inheritedFrom": {
|
808
|
-
"name": "AvatarComponentMixin",
|
809
|
-
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
810
|
-
}
|
887
|
+
"default": "null",
|
888
|
+
"description": "Aria-label attribute to be set for accessibility",
|
889
|
+
"fieldName": "ariaLabel"
|
811
890
|
},
|
812
891
|
{
|
813
892
|
"name": "icon-name",
|
@@ -820,170 +899,20 @@
|
|
820
899
|
"name": "IconNameMixin",
|
821
900
|
"module": "src/utils/mixins/IconNameMixin.ts"
|
822
901
|
}
|
823
|
-
},
|
824
|
-
{
|
825
|
-
"name": "tabIndex",
|
826
|
-
"type": {
|
827
|
-
"text": "number"
|
828
|
-
},
|
829
|
-
"default": "0",
|
830
|
-
"description": "This property specifies the tab order of the element.",
|
831
|
-
"fieldName": "tabIndex",
|
832
|
-
"inheritedFrom": {
|
833
|
-
"name": "TabIndexMixin",
|
834
|
-
"module": "src/utils/mixins/TabIndexMixin.ts"
|
835
|
-
}
|
836
|
-
},
|
837
|
-
{
|
838
|
-
"name": "disabled",
|
839
|
-
"type": {
|
840
|
-
"text": "boolean"
|
841
|
-
},
|
842
|
-
"default": "false",
|
843
|
-
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
844
|
-
"fieldName": "disabled",
|
845
|
-
"inheritedFrom": {
|
846
|
-
"name": "DisabledMixin",
|
847
|
-
"module": "src/utils/mixins/DisabledMixin.ts"
|
848
|
-
}
|
849
|
-
},
|
850
|
-
{
|
851
|
-
"name": "active",
|
852
|
-
"type": {
|
853
|
-
"text": "boolean"
|
854
|
-
},
|
855
|
-
"default": "false",
|
856
|
-
"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.",
|
857
|
-
"fieldName": "active",
|
858
|
-
"inheritedFrom": {
|
859
|
-
"name": "Buttonsimple",
|
860
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
861
|
-
}
|
862
|
-
},
|
863
|
-
{
|
864
|
-
"name": "soft-disabled",
|
865
|
-
"type": {
|
866
|
-
"text": "boolean"
|
867
|
-
},
|
868
|
-
"default": "false",
|
869
|
-
"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.",
|
870
|
-
"fieldName": "softDisabled",
|
871
|
-
"inheritedFrom": {
|
872
|
-
"name": "Buttonsimple",
|
873
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
874
|
-
}
|
875
|
-
},
|
876
|
-
{
|
877
|
-
"name": "role",
|
878
|
-
"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.",
|
879
|
-
"default": "button",
|
880
|
-
"fieldName": "role",
|
881
|
-
"inheritedFrom": {
|
882
|
-
"name": "Buttonsimple",
|
883
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
884
|
-
}
|
885
|
-
},
|
886
|
-
{
|
887
|
-
"name": "type",
|
888
|
-
"type": {
|
889
|
-
"text": "ButtonType"
|
890
|
-
},
|
891
|
-
"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.",
|
892
|
-
"default": "button",
|
893
|
-
"fieldName": "type",
|
894
|
-
"inheritedFrom": {
|
895
|
-
"name": "Buttonsimple",
|
896
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
897
|
-
}
|
898
902
|
}
|
899
903
|
],
|
900
904
|
"mixins": [
|
901
|
-
{
|
902
|
-
"name": "AvatarComponentMixin",
|
903
|
-
"module": "/src/utils/mixins/AvatarComponentMixin"
|
904
|
-
},
|
905
905
|
{
|
906
906
|
"name": "IconNameMixin",
|
907
907
|
"module": "/src/utils/mixins/IconNameMixin"
|
908
908
|
}
|
909
909
|
],
|
910
|
-
"superclass": {
|
911
|
-
"name": "Buttonsimple",
|
912
|
-
"module": "/src/components/buttonsimple/buttonsimple.component"
|
913
|
-
},
|
914
|
-
"tagName": "mdc-avatarbutton",
|
915
|
-
"jsDoc": "/**\n * The `mdc-avatarbutton` component is an interactable version of the `mdc-avatar` component.\n *\n * This component is made by extending `buttonsimple` class.\n * The button component acts as a wrapper for the avatar component.\n *\n * @dependency mdc-avatar\n *\n * @event click - (React: onClick) This event is dispatched when the avatarbutton is clicked.\n * @event keydown - (React: onKeyDown) This event is dispatched when a key is pressed down on the avatarbutton.\n * @event keyup - (React: onKeyUp) This event is dispatched when a key is released on the avatarbutton.\n * @event focus - (React: onFocus) This event is dispatched when the avatarbutton receives focus.\n *\n * @tagname mdc-avatarbutton\n */",
|
916
|
-
"customElement": true
|
917
|
-
}
|
918
|
-
],
|
919
|
-
"exports": [
|
920
|
-
{
|
921
|
-
"kind": "js",
|
922
|
-
"name": "default",
|
923
|
-
"declaration": {
|
924
|
-
"name": "AvatarButton",
|
925
|
-
"module": "components/avatarbutton/avatarbutton.component.js"
|
926
|
-
}
|
927
|
-
}
|
928
|
-
]
|
929
|
-
},
|
930
|
-
{
|
931
|
-
"kind": "javascript-module",
|
932
|
-
"path": "components/bullet/bullet.component.js",
|
933
|
-
"declarations": [
|
934
|
-
{
|
935
|
-
"kind": "class",
|
936
|
-
"description": "Bullet component, which is a visual marker\nand be used to organize and present items in a list format.",
|
937
|
-
"name": "Bullet",
|
938
|
-
"cssProperties": [
|
939
|
-
{
|
940
|
-
"description": "background color of the bullet",
|
941
|
-
"name": "--mdc-bullet-background-color"
|
942
|
-
},
|
943
|
-
{
|
944
|
-
"description": "small size value of the bullet",
|
945
|
-
"name": "--mdc-bullet-size-small"
|
946
|
-
},
|
947
|
-
{
|
948
|
-
"description": "medium size value of the bullet",
|
949
|
-
"name": "--mdc-bullet-size-medium"
|
950
|
-
},
|
951
|
-
{
|
952
|
-
"description": "large size value of the bullet",
|
953
|
-
"name": "--mdc-bullet-size-large"
|
954
|
-
}
|
955
|
-
],
|
956
|
-
"members": [
|
957
|
-
{
|
958
|
-
"kind": "field",
|
959
|
-
"name": "size",
|
960
|
-
"type": {
|
961
|
-
"text": "Size"
|
962
|
-
},
|
963
|
-
"privacy": "public",
|
964
|
-
"description": "Size of the bullet\n\nPossible values: 'small', 'medium', 'large'",
|
965
|
-
"default": "small",
|
966
|
-
"attribute": "size",
|
967
|
-
"reflects": true
|
968
|
-
}
|
969
|
-
],
|
970
|
-
"attributes": [
|
971
|
-
{
|
972
|
-
"name": "size",
|
973
|
-
"type": {
|
974
|
-
"text": "Size"
|
975
|
-
},
|
976
|
-
"description": "Size of the bullet\n\nPossible values: 'small', 'medium', 'large'",
|
977
|
-
"default": "small",
|
978
|
-
"fieldName": "size"
|
979
|
-
}
|
980
|
-
],
|
981
910
|
"superclass": {
|
982
911
|
"name": "Component",
|
983
912
|
"module": "/src/models"
|
984
913
|
},
|
985
|
-
"tagName": "mdc-
|
986
|
-
"jsDoc": "/**\n *
|
914
|
+
"tagName": "mdc-badge",
|
915
|
+
"jsDoc": "/**\n * The `mdc-badge` component is a versatile UI element used to\n * display dot, icons, counters, success, warning and error type badge.\n *\n * Supported badge types:\n * - `dot`: Displays a dot notification badge with a blue color.\n * - `icon`: Displays a badge with a specified icon using the `icon-name` attribute.\n * - `counter`: Displays a badge with a counter value. If the counter exceeds the `max-counter`,\n * it shows `maxCounter+`. The maximum value of the counter is 999 and anything above that will be set to `999+`.\n * - `success`: Displays a success badge with a check circle icon and green color.\n * - `warning`: Displays a warning badge with a warning icon and yellow color.\n * - `error`: Displays a error badge with a error legacy icon and red color.\n *\n * For `icon`, `success`, `warning` and `error` types, the `mdc-icon` component is used to render the icon.\n *\n * For the `counter` type, the `mdc-text` component is used to render the counter value.\n *\n * @dependency mdc-icon\n * @dependency mdc-text\n *\n * @tagname mdc-badge\n *\n * @cssproperty --mdc-badge-primary-foreground-color - The foreground color of the primary badge.\n * @cssproperty --mdc-badge-primary-background-color - The background color of the primary badge.\n * @cssproperty --mdc-badge-secondary-foreground-color - The foreground color of the secondary badge.\n * @cssproperty --mdc-badge-secondary-background-color - The background color of the secondary badge.\n * @cssproperty --mdc-badge-success-foreground-color - The foreground color of the success badge.\n * @cssproperty --mdc-badge-success-background-color - The background color of the success badge.\n * @cssproperty --mdc-badge-warning-foreground-color - The foreground color of the warning badge.\n * @cssproperty --mdc-badge-warning-background-color - The background color of the warning badge.\n * @cssproperty --mdc-badge-error-foreground-color - The foreground color of the error badge.\n * @cssproperty --mdc-badge-error-background-color - The background color of the error badge.\n * @cssproperty --mdc-badge-overlay-background-color - The background color of the badge overlay.\n */",
|
987
916
|
"customElement": true
|
988
917
|
}
|
989
918
|
],
|
@@ -992,8 +921,8 @@
|
|
992
921
|
"kind": "js",
|
993
922
|
"name": "default",
|
994
923
|
"declaration": {
|
995
|
-
"name": "
|
996
|
-
"module": "components/
|
924
|
+
"name": "Badge",
|
925
|
+
"module": "components/badge/badge.component.js"
|
997
926
|
}
|
998
927
|
}
|
999
928
|
]
|
@@ -1244,25 +1173,96 @@
|
|
1244
1173
|
},
|
1245
1174
|
{
|
1246
1175
|
"kind": "javascript-module",
|
1247
|
-
"path": "components/
|
1176
|
+
"path": "components/bullet/bullet.component.js",
|
1248
1177
|
"declarations": [
|
1249
1178
|
{
|
1250
1179
|
"kind": "class",
|
1251
|
-
"description": "
|
1252
|
-
"name": "
|
1253
|
-
"
|
1180
|
+
"description": "Bullet component, which is a visual marker\nand be used to organize and present items in a list format.",
|
1181
|
+
"name": "Bullet",
|
1182
|
+
"cssProperties": [
|
1254
1183
|
{
|
1255
|
-
"description": "
|
1256
|
-
"name": ""
|
1257
|
-
}
|
1258
|
-
],
|
1259
|
-
"members": [
|
1184
|
+
"description": "background color of the bullet",
|
1185
|
+
"name": "--mdc-bullet-background-color"
|
1186
|
+
},
|
1260
1187
|
{
|
1261
|
-
"
|
1262
|
-
"name": "
|
1263
|
-
|
1264
|
-
|
1265
|
-
|
1188
|
+
"description": "small size value of the bullet",
|
1189
|
+
"name": "--mdc-bullet-size-small"
|
1190
|
+
},
|
1191
|
+
{
|
1192
|
+
"description": "medium size value of the bullet",
|
1193
|
+
"name": "--mdc-bullet-size-medium"
|
1194
|
+
},
|
1195
|
+
{
|
1196
|
+
"description": "large size value of the bullet",
|
1197
|
+
"name": "--mdc-bullet-size-large"
|
1198
|
+
}
|
1199
|
+
],
|
1200
|
+
"members": [
|
1201
|
+
{
|
1202
|
+
"kind": "field",
|
1203
|
+
"name": "size",
|
1204
|
+
"type": {
|
1205
|
+
"text": "Size"
|
1206
|
+
},
|
1207
|
+
"privacy": "public",
|
1208
|
+
"description": "Size of the bullet\n\nPossible values: 'small', 'medium', 'large'",
|
1209
|
+
"default": "small",
|
1210
|
+
"attribute": "size",
|
1211
|
+
"reflects": true
|
1212
|
+
}
|
1213
|
+
],
|
1214
|
+
"attributes": [
|
1215
|
+
{
|
1216
|
+
"name": "size",
|
1217
|
+
"type": {
|
1218
|
+
"text": "Size"
|
1219
|
+
},
|
1220
|
+
"description": "Size of the bullet\n\nPossible values: 'small', 'medium', 'large'",
|
1221
|
+
"default": "small",
|
1222
|
+
"fieldName": "size"
|
1223
|
+
}
|
1224
|
+
],
|
1225
|
+
"superclass": {
|
1226
|
+
"name": "Component",
|
1227
|
+
"module": "/src/models"
|
1228
|
+
},
|
1229
|
+
"tagName": "mdc-bullet",
|
1230
|
+
"jsDoc": "/**\n * Bullet component, which is a visual marker\n * and be used to organize and present items in a list format.\n *\n * @tagname mdc-bullet\n *\n * @cssproperty --mdc-bullet-background-color - background color of the bullet\n * @cssproperty --mdc-bullet-size-small - small size value of the bullet\n * @cssproperty --mdc-bullet-size-medium - medium size value of the bullet\n * @cssproperty --mdc-bullet-size-large - large size value of the bullet\n*/",
|
1231
|
+
"customElement": true
|
1232
|
+
}
|
1233
|
+
],
|
1234
|
+
"exports": [
|
1235
|
+
{
|
1236
|
+
"kind": "js",
|
1237
|
+
"name": "default",
|
1238
|
+
"declaration": {
|
1239
|
+
"name": "Bullet",
|
1240
|
+
"module": "components/bullet/bullet.component.js"
|
1241
|
+
}
|
1242
|
+
}
|
1243
|
+
]
|
1244
|
+
},
|
1245
|
+
{
|
1246
|
+
"kind": "javascript-module",
|
1247
|
+
"path": "components/button/button.component.js",
|
1248
|
+
"declarations": [
|
1249
|
+
{
|
1250
|
+
"kind": "class",
|
1251
|
+
"description": "`mdc-button` is a component that can be configured in various ways to suit different use cases.\n\nButton Variants:\n- **Primary**: Solid background color.\n- **Secondary**: Transparent background with a solid border.\n- **Tertiary**: No background or border, appears as plain text but retains all button functionalities.\n\nButton Colors:\n- **Positive**: Green color.\n- **Negative**: Red color.\n- **Accent**: Blue color.\n- **Promotional**: Purple color.\n- **Default**: White color.\n\nButton Sizes (in REM units):\n- **Pill button**: 40, 32, 28, 24.\n- **Icon button**: 64, 52, 40, 32, 28, 24.\n- **Tertiary icon button**: 20.\n\nButton Types:\n- **Pill button**: A button that contains text value. Commonly used for call to action, tags, or filters.\n- **Pill button with icons**: A button containing an icon either on the left or right side of the button.\n- **Icon button**: A button represented by just an icon without any text.\nThe type of button is inferred based on the presence of slot and/or prefix and postfix icons.",
|
1252
|
+
"name": "Button",
|
1253
|
+
"slots": [
|
1254
|
+
{
|
1255
|
+
"description": "Text label of the button.",
|
1256
|
+
"name": ""
|
1257
|
+
}
|
1258
|
+
],
|
1259
|
+
"members": [
|
1260
|
+
{
|
1261
|
+
"kind": "field",
|
1262
|
+
"name": "prefixIcon",
|
1263
|
+
"type": {
|
1264
|
+
"text": "string | undefined"
|
1265
|
+
},
|
1266
1266
|
"description": "The name of the icon to display as a prefix.\nThe icon is displayed on the left side of the button.",
|
1267
1267
|
"attribute": "prefix-icon",
|
1268
1268
|
"reflects": true
|
@@ -6166,6 +6166,17 @@
|
|
6166
6166
|
"attribute": "aria-describedby",
|
6167
6167
|
"reflects": true
|
6168
6168
|
},
|
6169
|
+
{
|
6170
|
+
"kind": "field",
|
6171
|
+
"name": "disableAriaExpanded",
|
6172
|
+
"type": {
|
6173
|
+
"text": "boolean"
|
6174
|
+
},
|
6175
|
+
"description": "Disable aria-expanded attribute on trigger element.",
|
6176
|
+
"default": "false",
|
6177
|
+
"attribute": "disable-aria-expanded",
|
6178
|
+
"reflects": true
|
6179
|
+
},
|
6169
6180
|
{
|
6170
6181
|
"kind": "field",
|
6171
6182
|
"name": "arrowElement",
|
@@ -6993,6 +7004,15 @@
|
|
6993
7004
|
"description": "aria-describedby of the popover.",
|
6994
7005
|
"fieldName": "ariaDescribedby"
|
6995
7006
|
},
|
7007
|
+
{
|
7008
|
+
"name": "disable-aria-expanded",
|
7009
|
+
"type": {
|
7010
|
+
"text": "boolean"
|
7011
|
+
},
|
7012
|
+
"description": "Disable aria-expanded attribute on trigger element.",
|
7013
|
+
"default": "false",
|
7014
|
+
"fieldName": "disableAriaExpanded"
|
7015
|
+
},
|
6996
7016
|
{
|
6997
7017
|
"name": "enabledFocusTrap",
|
6998
7018
|
"type": {
|
@@ -9002,232 +9022,1168 @@
|
|
9002
9022
|
}
|
9003
9023
|
},
|
9004
9024
|
{
|
9005
|
-
"description": "(React: onFocus) This event is dispatched when the tab receives focus.",
|
9006
|
-
"name": "focus",
|
9007
|
-
"reactName": "onFocus",
|
9008
|
-
"eventName": "FocusEvent",
|
9009
|
-
"inheritedFrom": {
|
9010
|
-
"name": "Buttonsimple",
|
9011
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
9012
|
-
}
|
9013
|
-
}
|
9014
|
-
],
|
9015
|
-
"attributes": [
|
9025
|
+
"description": "(React: onFocus) This event is dispatched when the tab receives focus.",
|
9026
|
+
"name": "focus",
|
9027
|
+
"reactName": "onFocus",
|
9028
|
+
"eventName": "FocusEvent",
|
9029
|
+
"inheritedFrom": {
|
9030
|
+
"name": "Buttonsimple",
|
9031
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
9032
|
+
}
|
9033
|
+
}
|
9034
|
+
],
|
9035
|
+
"attributes": [
|
9036
|
+
{
|
9037
|
+
"name": "text",
|
9038
|
+
"type": {
|
9039
|
+
"text": "string | undefined"
|
9040
|
+
},
|
9041
|
+
"description": "Text to be displayed in the tab.\nIf no `text` is provided, no text will be rendered,\n`aria-label` should be set on the tab.",
|
9042
|
+
"fieldName": "text"
|
9043
|
+
},
|
9044
|
+
{
|
9045
|
+
"name": "variant",
|
9046
|
+
"type": {
|
9047
|
+
"text": "Variant"
|
9048
|
+
},
|
9049
|
+
"description": "Tab can have three variants:\n- `glass`\n- `line`\n- `pill`\n\nIt defines the background and foreground color of the tab.",
|
9050
|
+
"default": "pill",
|
9051
|
+
"fieldName": "variant"
|
9052
|
+
},
|
9053
|
+
{
|
9054
|
+
"name": "icon-name",
|
9055
|
+
"type": {
|
9056
|
+
"text": "IconNames | undefined"
|
9057
|
+
},
|
9058
|
+
"description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
|
9059
|
+
"fieldName": "iconName",
|
9060
|
+
"inheritedFrom": {
|
9061
|
+
"name": "IconNameMixin",
|
9062
|
+
"module": "src/utils/mixins/IconNameMixin.ts"
|
9063
|
+
}
|
9064
|
+
},
|
9065
|
+
{
|
9066
|
+
"name": "tabIndex",
|
9067
|
+
"type": {
|
9068
|
+
"text": "number"
|
9069
|
+
},
|
9070
|
+
"default": "0",
|
9071
|
+
"description": "This property specifies the tab order of the element.",
|
9072
|
+
"fieldName": "tabIndex",
|
9073
|
+
"inheritedFrom": {
|
9074
|
+
"name": "Buttonsimple",
|
9075
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
9076
|
+
}
|
9077
|
+
},
|
9078
|
+
{
|
9079
|
+
"name": "disabled",
|
9080
|
+
"type": {
|
9081
|
+
"text": "boolean"
|
9082
|
+
},
|
9083
|
+
"default": "false",
|
9084
|
+
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
9085
|
+
"fieldName": "disabled",
|
9086
|
+
"inheritedFrom": {
|
9087
|
+
"name": "Buttonsimple",
|
9088
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
9089
|
+
}
|
9090
|
+
},
|
9091
|
+
{
|
9092
|
+
"name": "active",
|
9093
|
+
"type": {
|
9094
|
+
"text": "boolean"
|
9095
|
+
},
|
9096
|
+
"default": "false",
|
9097
|
+
"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.",
|
9098
|
+
"fieldName": "active",
|
9099
|
+
"inheritedFrom": {
|
9100
|
+
"name": "Buttonsimple",
|
9101
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
9102
|
+
}
|
9103
|
+
},
|
9104
|
+
{
|
9105
|
+
"name": "soft-disabled",
|
9106
|
+
"type": {
|
9107
|
+
"text": "boolean"
|
9108
|
+
},
|
9109
|
+
"default": "false",
|
9110
|
+
"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.",
|
9111
|
+
"fieldName": "softDisabled",
|
9112
|
+
"inheritedFrom": {
|
9113
|
+
"name": "Buttonsimple",
|
9114
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
9115
|
+
}
|
9116
|
+
},
|
9117
|
+
{
|
9118
|
+
"name": "size",
|
9119
|
+
"type": {
|
9120
|
+
"text": "ButtonSize"
|
9121
|
+
},
|
9122
|
+
"description": "Simplebutton size is a super set of all the sizes supported by children components.",
|
9123
|
+
"default": "32",
|
9124
|
+
"fieldName": "size",
|
9125
|
+
"inheritedFrom": {
|
9126
|
+
"name": "Buttonsimple",
|
9127
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
9128
|
+
}
|
9129
|
+
},
|
9130
|
+
{
|
9131
|
+
"name": "role",
|
9132
|
+
"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.",
|
9133
|
+
"default": "button",
|
9134
|
+
"fieldName": "role",
|
9135
|
+
"inheritedFrom": {
|
9136
|
+
"name": "Buttonsimple",
|
9137
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
9138
|
+
}
|
9139
|
+
},
|
9140
|
+
{
|
9141
|
+
"name": "type",
|
9142
|
+
"type": {
|
9143
|
+
"text": "ButtonType"
|
9144
|
+
},
|
9145
|
+
"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.",
|
9146
|
+
"default": "button",
|
9147
|
+
"fieldName": "type",
|
9148
|
+
"inheritedFrom": {
|
9149
|
+
"name": "Buttonsimple",
|
9150
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
9151
|
+
}
|
9152
|
+
}
|
9153
|
+
],
|
9154
|
+
"mixins": [
|
9155
|
+
{
|
9156
|
+
"name": "IconNameMixin",
|
9157
|
+
"module": "/src/utils/mixins/IconNameMixin"
|
9158
|
+
}
|
9159
|
+
],
|
9160
|
+
"superclass": {
|
9161
|
+
"name": "Buttonsimple",
|
9162
|
+
"module": "/src/components/buttonsimple/buttonsimple.component"
|
9163
|
+
},
|
9164
|
+
"tagName": "mdc-tab",
|
9165
|
+
"jsDoc": "/**\n * `mdc-tab` is Tab component to be used within the Tabgroup.\n *\n * Passing in the attribute `text` to the tab component is changing the text displayed in the tab.\n *\n * The `slot=\"badge\"` can be used to add a badge to the tab.\n *\n * The `slot=\"chip\"` can be used to add a chip to the tab.\n *\n * For `icon`, the `mdc-icon` component is used to render the icon.\n *\n * Note: Icons can be used in conjunction with badges or chips.\n * Badges and chips should not be used at the same time.\n *\n * @dependency mdc-icon\n * @dependency mdc-text\n *\n * @event click - (React: onClick) This event is dispatched when the tab is clicked.\n * @event keydown - (React: onKeyDown) This event is dispatched when a key is pressed down on the tab.\n * @event keyup - (React: onKeyUp) This event is dispatched when a key is released on the tab.\n * @event focus - (React: onFocus) This event is dispatched when the tab receives focus.\n *\n * @tagname mdc-tab\n *\n * @cssproperty --mdc-tab-content-gap - Gap between the badge(if provided), icon and text.\n * @cssproperty --mdc-tab-height - Height of the tab.\n * @cssproperty --mdc-tab-glass-active-background-color-disabled - Background color for active glass tab\n * in disabled state.\n * @cssproperty --mdc-tab-glass-active-background-color-hover - Background color for active glass tab in hover state.\n * @cssproperty --mdc-tab-glass-active-background-color-normal - Background color for active glass tab in rest state.\n * @cssproperty --mdc-tab-glass-active-background-color-pressed - Background color for active glass tab\n * in pressed state.\n * @cssproperty --mdc-tab-glass-active-color - Text and icon color for active glass tab.\n * @cssproperty --mdc-tab-glass-active-color-disabled - Text and icon color for active glass tab in disabled state.\n * @cssproperty --mdc-tab-glass-border-radius - Border radius for glass tab.\n * @cssproperty --mdc-tab-glass-inactive-background-color-disabled - Background color for inactive glass tab\n * in disabled state.\n * @cssproperty --mdc-tab-glass-inactive-background-color-hover - Background color for inactive glass tab\n * in hover state.\n * @cssproperty --mdc-tab-glass-inactive-background-color-normal - Background color for inactive glass tab\n * in rest state.\n * @cssproperty --mdc-tab-glass-inactive-background-color-pressed - Background color for inactive glass tab\n * in pressed state.\n * @cssproperty --mdc-tab-glass-inactive-color - Text and icon color for inactive glass tab.\n * @cssproperty --mdc-tab-glass-inactive-color-disabled - Text and icon color for inactive glass tab in disabled state.\n * @cssproperty --mdc-tab-line-active-background-color-pressed - Background color for active line tab in pressed state.\n * @cssproperty --mdc-tab-line-active-background-color-disabled - Background color for active line tab\n * in disabled state.\n * @cssproperty --mdc-tab-line-active-background-color-hover - Background color for active line tab in hover state.\n * @cssproperty --mdc-tab-line-active-background-color-normal - Background color for active line tab in rest state.\n * @cssproperty --mdc-tab-line-active-color - Text and icon color for active line tab.\n * @cssproperty --mdc-tab-line-active-color-disabled - Text and icon color for active line tab in disabled state.\n * @cssproperty --mdc-tab-line-active-indicator-color - color for indicator in active line tab.\n * @cssproperty --mdc-tab-line-active-indicator-color-disabled - Color for indicator in active line tab\n * in disabled state.\n * @cssproperty --mdc-tab-line-active-indicator-height - Height for indicator in active line tab.\n * @cssproperty --mdc-tab-line-active-indicator-width - Width for indicator in active line tab.\n * @cssproperty --mdc-tab-line-border-bottom-left-radius - Bottom left border radius for line tab.\n * @cssproperty --mdc-tab-line-border-bottom-right-radius - Bottom right border radius for line tab.\n * @cssproperty --mdc-tab-line-border-top-left-radius - Top left border radius for line tab.\n * @cssproperty --mdc-tab-line-border-top-right-radius - Top right border radius for line tab.\n * @cssproperty --mdc-tab-line-inactive-background-color-pressed - Background color for inactive line tab\n * in pressed state.\n * @cssproperty --mdc-tab-line-inactive-background-color-disabled - Background color for inactive line tab\n * in disabled state\n * @cssproperty --mdc-tab-line-inactive-background-color-hover - Background color for inactive line tab in hover state.\n * @cssproperty --mdc-tab-line-inactive-background-color-normal - Background color for inactive line tab\n * in rest state.\n * @cssproperty --mdc-tab-line-inactive-color - Text and icon color for inactive line tab.\n * @cssproperty --mdc-tab-line-inactive-color-disabled - Text and icon color for inactive line tab in disabled state.\n * @cssproperty --mdc-tab-padding-left - Padding left for the tab.\n * @cssproperty --mdc-tab-padding-right - Padding right for the tab.\n * @cssproperty --mdc-tab-pill-active-background-color-pressed - Background color for active pill tab in pressed state.\n * @cssproperty --mdc-tab-pill-active-background-color-disabled - Background color for active pill tab\n * in disabled state.\n * @cssproperty --mdc-tab-pill-active-background-color-hover - Background color for active pill tab in hover state.\n * @cssproperty --mdc-tab-pill-active-background-color-normal - Background color for active pill tab in rest state.\n * @cssproperty --mdc-tab-pill-active-color - Text and icon color for active pill tab.\n * @cssproperty --mdc-tab-pill-active-color-disabled - Text and icon color for active pill tab in disabled state.\n * @cssproperty --mdc-tab-pill-border-radius - Border radius for pill tab.\n * @cssproperty --mdc-tab-pill-inactive-background-color-pressed - Background color for inactive pill tab\n * in pressed state.\n * @cssproperty --mdc-tab-pill-inactive-background-color-disabled - Background color for inactive pill tab\n * in disabled state.\n * @cssproperty --mdc-tab-pill-inactive-background-color-hover - Background color for inactive pill tab in hover state.\n * @cssproperty --mdc-tab-pill-inactive-background-color-normal - Background color for inactive pill tab in rest state.\n * @cssproperty --mdc-tab-pill-inactive-color - Text and icon color for inactive pill tab.\n * @cssproperty --mdc-tab-pill-inactive-color-disabled - Text and icon color for inactive pill tab in disabled state.\n */",
|
9166
|
+
"customElement": true
|
9167
|
+
}
|
9168
|
+
],
|
9169
|
+
"exports": [
|
9170
|
+
{
|
9171
|
+
"kind": "js",
|
9172
|
+
"name": "default",
|
9173
|
+
"declaration": {
|
9174
|
+
"name": "Tab",
|
9175
|
+
"module": "components/tab/tab.component.js"
|
9176
|
+
}
|
9177
|
+
}
|
9178
|
+
]
|
9179
|
+
},
|
9180
|
+
{
|
9181
|
+
"kind": "javascript-module",
|
9182
|
+
"path": "components/text/text.component.js",
|
9183
|
+
"declarations": [
|
9184
|
+
{
|
9185
|
+
"kind": "class",
|
9186
|
+
"description": "Text component for creating styled text elements.\nIt has to be mounted within the ThemeProvider to access color and font tokens.\n\nThe `type` attribute allows changing the text style.\nThe `tagname` attribute allows changing the tag name of the text element.\nThe default tag name is `p`.\n\nThe `tagname` attribute should be a valid HTML tag name.\nIf the `tagname` attribute is not a valid HTML tag name, the default tag name will be used.\n\nThe styling is applied based on the `type` attribute.",
|
9187
|
+
"name": "Text",
|
9188
|
+
"cssParts": [
|
9189
|
+
{
|
9190
|
+
"description": "The text element",
|
9191
|
+
"name": "text"
|
9192
|
+
}
|
9193
|
+
],
|
9194
|
+
"slots": [
|
9195
|
+
{
|
9196
|
+
"description": "Default slot for text content",
|
9197
|
+
"name": ""
|
9198
|
+
}
|
9199
|
+
],
|
9200
|
+
"members": [
|
9201
|
+
{
|
9202
|
+
"kind": "field",
|
9203
|
+
"name": "type",
|
9204
|
+
"type": {
|
9205
|
+
"text": "TextType"
|
9206
|
+
},
|
9207
|
+
"privacy": "public",
|
9208
|
+
"description": "Specifies the text style to be applied.\n\nAcceptable values include:\n\n- 'body-small-regular'\n- 'body-small-medium'\n- 'body-small-bold'\n- 'body-midsize-regular'\n- 'body-midsize-medium'\n- 'body-midsize-bold'\n- 'body-large-regular'\n- 'body-large-medium'\n- 'body-large-bold'\n- 'body-small-regular-underline'\n- 'body-small-medium-underline'\n- 'body-midsize-regular-underline'\n- 'body-midsize-medium-underline'\n- 'body-large-regular-underline'\n- 'body-large-medium-underline'\n- 'heading-small-regular'\n- 'heading-small-medium'\n- 'heading-small-bold'\n- 'heading-midsize-regular'\n- 'heading-midsize-medium'\n- 'heading-midsize-bold'\n- 'heading-large-regular'\n- 'heading-large-medium'\n- 'heading-large-bold'\n- 'heading-xlarge-regular'\n- 'heading-xlarge-medium'\n- 'heading-xlarge-bold'\n- 'headline-small-light'\n- 'headline-small-regular'",
|
9209
|
+
"default": "body-large-regular",
|
9210
|
+
"attribute": "type",
|
9211
|
+
"reflects": true
|
9212
|
+
},
|
9213
|
+
{
|
9214
|
+
"kind": "field",
|
9215
|
+
"name": "tagname",
|
9216
|
+
"type": {
|
9217
|
+
"text": "TagName | undefined"
|
9218
|
+
},
|
9219
|
+
"privacy": "public",
|
9220
|
+
"description": "Specifies the HTML tag name for the text element. The default tag name is `p`.\nThis attribute is optional. When set, it changes the tag name of the text element.\n\nAcceptable values include:\n\n- 'h1'\n- 'h2'\n- 'h3'\n- 'h4'\n- 'h5'\n- 'h6'\n- 'p'\n- 'small'\n- 'span'\n- 'div'\n\nFor instance, setting this attribute to `h2` will render the text element as an `h2` element.\nNote that the styling is determined by the `type` attribute.",
|
9221
|
+
"attribute": "tagname",
|
9222
|
+
"reflects": true
|
9223
|
+
}
|
9224
|
+
],
|
9225
|
+
"attributes": [
|
9226
|
+
{
|
9227
|
+
"name": "type",
|
9228
|
+
"type": {
|
9229
|
+
"text": "TextType"
|
9230
|
+
},
|
9231
|
+
"description": "Specifies the text style to be applied.\n\nAcceptable values include:\n\n- 'body-small-regular'\n- 'body-small-medium'\n- 'body-small-bold'\n- 'body-midsize-regular'\n- 'body-midsize-medium'\n- 'body-midsize-bold'\n- 'body-large-regular'\n- 'body-large-medium'\n- 'body-large-bold'\n- 'body-small-regular-underline'\n- 'body-small-medium-underline'\n- 'body-midsize-regular-underline'\n- 'body-midsize-medium-underline'\n- 'body-large-regular-underline'\n- 'body-large-medium-underline'\n- 'heading-small-regular'\n- 'heading-small-medium'\n- 'heading-small-bold'\n- 'heading-midsize-regular'\n- 'heading-midsize-medium'\n- 'heading-midsize-bold'\n- 'heading-large-regular'\n- 'heading-large-medium'\n- 'heading-large-bold'\n- 'heading-xlarge-regular'\n- 'heading-xlarge-medium'\n- 'heading-xlarge-bold'\n- 'headline-small-light'\n- 'headline-small-regular'",
|
9232
|
+
"default": "body-large-regular",
|
9233
|
+
"fieldName": "type"
|
9234
|
+
},
|
9235
|
+
{
|
9236
|
+
"name": "tagname",
|
9237
|
+
"type": {
|
9238
|
+
"text": "TagName | undefined"
|
9239
|
+
},
|
9240
|
+
"description": "Specifies the HTML tag name for the text element. The default tag name is `p`.\nThis attribute is optional. When set, it changes the tag name of the text element.\n\nAcceptable values include:\n\n- 'h1'\n- 'h2'\n- 'h3'\n- 'h4'\n- 'h5'\n- 'h6'\n- 'p'\n- 'small'\n- 'span'\n- 'div'\n\nFor instance, setting this attribute to `h2` will render the text element as an `h2` element.\nNote that the styling is determined by the `type` attribute.",
|
9241
|
+
"fieldName": "tagname"
|
9242
|
+
}
|
9243
|
+
],
|
9244
|
+
"superclass": {
|
9245
|
+
"name": "Component",
|
9246
|
+
"module": "/src/models"
|
9247
|
+
},
|
9248
|
+
"tagName": "mdc-text",
|
9249
|
+
"jsDoc": "/**\n * Text component for creating styled text elements.\n * It has to be mounted within the ThemeProvider to access color and font tokens.\n *\n * The `type` attribute allows changing the text style.\n * The `tagname` attribute allows changing the tag name of the text element.\n * The default tag name is `p`.\n *\n * The `tagname` attribute should be a valid HTML tag name.\n * If the `tagname` attribute is not a valid HTML tag name, the default tag name will be used.\n *\n * The styling is applied based on the `type` attribute.\n *\n * @tagname mdc-text\n * @slot - Default slot for text content\n *\n * @csspart text - The text element\n */",
|
9250
|
+
"customElement": true
|
9251
|
+
}
|
9252
|
+
],
|
9253
|
+
"exports": [
|
9254
|
+
{
|
9255
|
+
"kind": "js",
|
9256
|
+
"name": "default",
|
9257
|
+
"declaration": {
|
9258
|
+
"name": "Text",
|
9259
|
+
"module": "components/text/text.component.js"
|
9260
|
+
}
|
9261
|
+
}
|
9262
|
+
]
|
9263
|
+
},
|
9264
|
+
{
|
9265
|
+
"kind": "javascript-module",
|
9266
|
+
"path": "components/textarea/textarea.component.js",
|
9267
|
+
"declarations": [
|
9268
|
+
{
|
9269
|
+
"kind": "class",
|
9270
|
+
"description": "mdc-textarea component, which is used to get the multi-line text input from the user.\nIt contains:\n- label: It is the title of the textarea field.\n- required-label: A string depicting that the textarea field is required.\n- Textarea: It is the multi-line text input field.\n- helper-text: It is the text that provides additional information about the textarea field.\n- max-character-limit: It is the text that shows the character count of the textarea field.\n- clear-button: A boolean value when marked to true represents a button that can\n clear the text value within the textarea field.\n- Error, Warning, Success, Priority Help Text type: It is the text that provides additional information\n about the textarea field based on the validation state.\n- limitexceeded: It is the event that is dispatched when the character limit exceeds or restored.\n This event exposes 3 properties:\n - currentCharacterCount - the current number of characters in the textarea field,\n - maxCharacterLimit - the maximum number of characters allowed in the textarea field,\n - value - the current value of the textarea field,\n\n**Note**: Consumers must set the help-text-type with 'error' and\nhelp-text attribute with the error message using limitexceeded event.\nThe same help-text value will be used for the validation message to be displayed.",
|
9271
|
+
"name": "Textarea",
|
9272
|
+
"cssProperties": [
|
9273
|
+
{
|
9274
|
+
"description": "Border color for the textarea container when disabled",
|
9275
|
+
"name": "--mdc-textarea-disabled-border-color"
|
9276
|
+
},
|
9277
|
+
{
|
9278
|
+
"description": "Text color for the textarea field when disabled",
|
9279
|
+
"name": "--mdc-textarea-disabled-text-color"
|
9280
|
+
},
|
9281
|
+
{
|
9282
|
+
"description": "Background color for the textarea field when disabled",
|
9283
|
+
"name": "--mdc-textarea-disabled-background-color"
|
9284
|
+
},
|
9285
|
+
{
|
9286
|
+
"description": "Text color for the textarea field",
|
9287
|
+
"name": "--mdc-textarea-text-color"
|
9288
|
+
},
|
9289
|
+
{
|
9290
|
+
"description": "Background color for the textarea field",
|
9291
|
+
"name": "--mdc-textarea-background-color"
|
9292
|
+
},
|
9293
|
+
{
|
9294
|
+
"description": "Border color for the textarea field",
|
9295
|
+
"name": "--mdc-textarea-border-color"
|
9296
|
+
},
|
9297
|
+
{
|
9298
|
+
"description": "Text color for the character counter",
|
9299
|
+
"name": "--mdc-textarea-text-secondary-normal"
|
9300
|
+
},
|
9301
|
+
{
|
9302
|
+
"description": "Border color for the error related help text",
|
9303
|
+
"name": "--mdc-textarea-error-border-color"
|
9304
|
+
},
|
9305
|
+
{
|
9306
|
+
"description": "Border color for the warning related help text",
|
9307
|
+
"name": "--mdc-textarea-warning-border-color"
|
9308
|
+
},
|
9309
|
+
{
|
9310
|
+
"description": "Border color for the success related help text",
|
9311
|
+
"name": "--mdc-textarea-success-border-color"
|
9312
|
+
},
|
9313
|
+
{
|
9314
|
+
"description": "Border color for the priority related help text",
|
9315
|
+
"name": "--mdc-textarea-primary-border-color"
|
9316
|
+
},
|
9317
|
+
{
|
9318
|
+
"description": "Background color for the textarea container when hover",
|
9319
|
+
"name": "--mdc-textarea-hover-background-color"
|
9320
|
+
},
|
9321
|
+
{
|
9322
|
+
"description": "Background color for the textarea container when focused",
|
9323
|
+
"name": "--mdc-textarea-focused-background-color"
|
9324
|
+
},
|
9325
|
+
{
|
9326
|
+
"description": "Border color for the textarea container when focused",
|
9327
|
+
"name": "--mdc-textarea-focused-border-color"
|
9328
|
+
}
|
9329
|
+
],
|
9330
|
+
"members": [
|
9331
|
+
{
|
9332
|
+
"kind": "field",
|
9333
|
+
"name": "placeholder",
|
9334
|
+
"type": {
|
9335
|
+
"text": "string | undefined"
|
9336
|
+
},
|
9337
|
+
"description": "The placeholder text that is displayed when the textarea field is empty.",
|
9338
|
+
"attribute": "placeholder"
|
9339
|
+
},
|
9340
|
+
{
|
9341
|
+
"kind": "field",
|
9342
|
+
"name": "readonly",
|
9343
|
+
"type": {
|
9344
|
+
"text": "boolean"
|
9345
|
+
},
|
9346
|
+
"default": "false",
|
9347
|
+
"description": "readonly attribute of the textarea field. If true, the textarea field is read-only.",
|
9348
|
+
"attribute": "readonly"
|
9349
|
+
},
|
9350
|
+
{
|
9351
|
+
"kind": "field",
|
9352
|
+
"name": "rows",
|
9353
|
+
"description": "The rows attribute specifies the visible number of lines in a text area.",
|
9354
|
+
"default": "5",
|
9355
|
+
"attribute": "rows"
|
9356
|
+
},
|
9357
|
+
{
|
9358
|
+
"kind": "field",
|
9359
|
+
"name": "cols",
|
9360
|
+
"description": "The cols attribute specifies the visible number of lines in a text area.",
|
9361
|
+
"default": "40",
|
9362
|
+
"attribute": "cols"
|
9363
|
+
},
|
9364
|
+
{
|
9365
|
+
"kind": "field",
|
9366
|
+
"name": "wrap",
|
9367
|
+
"type": {
|
9368
|
+
"text": "WrapType"
|
9369
|
+
},
|
9370
|
+
"description": "The wrap attribute specifies how the text in a text area is to be wrapped when submitted in a form.",
|
9371
|
+
"default": "'soft'",
|
9372
|
+
"attribute": "wrap"
|
9373
|
+
},
|
9374
|
+
{
|
9375
|
+
"kind": "field",
|
9376
|
+
"name": "autocapitalize",
|
9377
|
+
"type": {
|
9378
|
+
"text": "AutoCapitalizeType"
|
9379
|
+
},
|
9380
|
+
"description": "The autocapitalize attribute of the textarea field.",
|
9381
|
+
"default": "'off'",
|
9382
|
+
"attribute": "autocapitalize"
|
9383
|
+
},
|
9384
|
+
{
|
9385
|
+
"kind": "field",
|
9386
|
+
"name": "autocomplete",
|
9387
|
+
"type": {
|
9388
|
+
"text": "AutoCompleteType"
|
9389
|
+
},
|
9390
|
+
"description": "The autocomplete attribute of the textarea field.",
|
9391
|
+
"default": "'off'",
|
9392
|
+
"attribute": "autocomplete"
|
9393
|
+
},
|
9394
|
+
{
|
9395
|
+
"kind": "field",
|
9396
|
+
"name": "autofocus",
|
9397
|
+
"type": {
|
9398
|
+
"text": "boolean"
|
9399
|
+
},
|
9400
|
+
"default": "false",
|
9401
|
+
"description": "If true, the textarea field is focused when the component is rendered.",
|
9402
|
+
"attribute": "autofocus"
|
9403
|
+
},
|
9404
|
+
{
|
9405
|
+
"kind": "field",
|
9406
|
+
"name": "dirname",
|
9407
|
+
"type": {
|
9408
|
+
"text": "string | undefined"
|
9409
|
+
},
|
9410
|
+
"description": "Specifies the name of the directionality of text for submission purposes (e.g., \"rtl\" for right-to-left).",
|
9411
|
+
"attribute": "dirname"
|
9412
|
+
},
|
9413
|
+
{
|
9414
|
+
"kind": "field",
|
9415
|
+
"name": "maxlength",
|
9416
|
+
"type": {
|
9417
|
+
"text": "number | undefined"
|
9418
|
+
},
|
9419
|
+
"description": "The maximum number of characters that the textarea field can accept.",
|
9420
|
+
"attribute": "maxlength"
|
9421
|
+
},
|
9422
|
+
{
|
9423
|
+
"kind": "field",
|
9424
|
+
"name": "minlength",
|
9425
|
+
"type": {
|
9426
|
+
"text": "number | undefined"
|
9427
|
+
},
|
9428
|
+
"description": "The minimum number of characters that the textarea field can accept.",
|
9429
|
+
"attribute": "minlength"
|
9430
|
+
},
|
9431
|
+
{
|
9432
|
+
"kind": "field",
|
9433
|
+
"name": "clearButton",
|
9434
|
+
"type": {
|
9435
|
+
"text": "boolean"
|
9436
|
+
},
|
9437
|
+
"default": "false",
|
9438
|
+
"description": "The clear button when set to true, shows a clear button that clears the textarea field.",
|
9439
|
+
"attribute": "clear-button"
|
9440
|
+
},
|
9441
|
+
{
|
9442
|
+
"kind": "field",
|
9443
|
+
"name": "clearAriaLabel",
|
9444
|
+
"type": {
|
9445
|
+
"text": "string"
|
9446
|
+
},
|
9447
|
+
"default": "''",
|
9448
|
+
"description": "Aria label for the clear button. If clear button is set to true, this label is used for the clear button.",
|
9449
|
+
"attribute": "clear-aria-label"
|
9450
|
+
},
|
9451
|
+
{
|
9452
|
+
"kind": "field",
|
9453
|
+
"name": "maxCharacterLimit",
|
9454
|
+
"type": {
|
9455
|
+
"text": "number | undefined"
|
9456
|
+
},
|
9457
|
+
"description": "maximum character limit for the textarea field for character counter.",
|
9458
|
+
"attribute": "max-character-limit"
|
9459
|
+
},
|
9460
|
+
{
|
9461
|
+
"kind": "field",
|
9462
|
+
"name": "characterLimitExceedingFired",
|
9463
|
+
"type": {
|
9464
|
+
"text": "boolean"
|
9465
|
+
},
|
9466
|
+
"privacy": "private",
|
9467
|
+
"default": "false"
|
9468
|
+
},
|
9469
|
+
{
|
9470
|
+
"kind": "field",
|
9471
|
+
"name": "textarea",
|
9472
|
+
"type": {
|
9473
|
+
"text": "HTMLTextAreaElement"
|
9474
|
+
},
|
9475
|
+
"privacy": "protected",
|
9476
|
+
"readonly": true
|
9477
|
+
},
|
9478
|
+
{
|
9479
|
+
"kind": "method",
|
9480
|
+
"name": "setTextareaValidity",
|
9481
|
+
"privacy": "private"
|
9482
|
+
},
|
9483
|
+
{
|
9484
|
+
"kind": "method",
|
9485
|
+
"name": "handleValueChange",
|
9486
|
+
"description": "Handles the value change of the textarea field.\nSets the form value and updates the validity of the textarea field.",
|
9487
|
+
"return": {
|
9488
|
+
"type": {
|
9489
|
+
"text": ""
|
9490
|
+
}
|
9491
|
+
}
|
9492
|
+
},
|
9493
|
+
{
|
9494
|
+
"kind": "method",
|
9495
|
+
"name": "dispatchCharacterOverflowStateChangeEvent",
|
9496
|
+
"privacy": "private",
|
9497
|
+
"description": "Dispatches the character overflow state change event.",
|
9498
|
+
"return": {
|
9499
|
+
"type": {
|
9500
|
+
"text": ""
|
9501
|
+
}
|
9502
|
+
}
|
9503
|
+
},
|
9504
|
+
{
|
9505
|
+
"kind": "method",
|
9506
|
+
"name": "handleCharacterOverflowStateChange",
|
9507
|
+
"privacy": "private",
|
9508
|
+
"description": "Handles the character overflow state change.\nDispatches the character overflow state change event if the character limit is exceeded or restored.",
|
9509
|
+
"return": {
|
9510
|
+
"type": {
|
9511
|
+
"text": ""
|
9512
|
+
}
|
9513
|
+
}
|
9514
|
+
},
|
9515
|
+
{
|
9516
|
+
"kind": "method",
|
9517
|
+
"name": "updateValue",
|
9518
|
+
"privacy": "private",
|
9519
|
+
"description": "Updates the value of the textarea field.\nSets the form value.",
|
9520
|
+
"return": {
|
9521
|
+
"type": {
|
9522
|
+
"text": ""
|
9523
|
+
}
|
9524
|
+
}
|
9525
|
+
},
|
9526
|
+
{
|
9527
|
+
"kind": "method",
|
9528
|
+
"name": "onChange",
|
9529
|
+
"privacy": "private",
|
9530
|
+
"parameters": [
|
9531
|
+
{
|
9532
|
+
"name": "event",
|
9533
|
+
"type": {
|
9534
|
+
"text": "Event"
|
9535
|
+
},
|
9536
|
+
"description": "Event which contains information about the value change."
|
9537
|
+
}
|
9538
|
+
],
|
9539
|
+
"description": "Handles the change event of the textarea field.\nUpdates the value and sets the validity of the textarea field.\n\nThe 'change' event does not bubble up through the shadow DOM as it was not composed.\nTherefore, we need to re-dispatch the same event to ensure it is propagated correctly.\nRead more: https://developer.mozilla.org/en-US/docs/Web/API/Event/composed"
|
9540
|
+
},
|
9541
|
+
{
|
9542
|
+
"kind": "method",
|
9543
|
+
"name": "handleKeyDown",
|
9544
|
+
"privacy": "private",
|
9545
|
+
"parameters": [
|
9546
|
+
{
|
9547
|
+
"name": "event",
|
9548
|
+
"type": {
|
9549
|
+
"text": "KeyboardEvent"
|
9550
|
+
},
|
9551
|
+
"description": "Keyboard event"
|
9552
|
+
}
|
9553
|
+
],
|
9554
|
+
"description": "Handles the keydown event of the textarea field.\nClears the textarea field when the 'Enter' key is pressed.",
|
9555
|
+
"return": {
|
9556
|
+
"type": {
|
9557
|
+
"text": ""
|
9558
|
+
}
|
9559
|
+
}
|
9560
|
+
},
|
9561
|
+
{
|
9562
|
+
"kind": "method",
|
9563
|
+
"name": "clearInputText",
|
9564
|
+
"privacy": "private",
|
9565
|
+
"description": "Clears the textarea field.",
|
9566
|
+
"return": {
|
9567
|
+
"type": {
|
9568
|
+
"text": ""
|
9569
|
+
}
|
9570
|
+
}
|
9571
|
+
},
|
9572
|
+
{
|
9573
|
+
"kind": "method",
|
9574
|
+
"name": "renderClearButton",
|
9575
|
+
"privacy": "protected",
|
9576
|
+
"description": "Renders the clear button to clear the textarea field if the clearButton is set to true.",
|
9577
|
+
"return": {
|
9578
|
+
"type": {
|
9579
|
+
"text": ""
|
9580
|
+
}
|
9581
|
+
}
|
9582
|
+
},
|
9583
|
+
{
|
9584
|
+
"kind": "method",
|
9585
|
+
"name": "renderCharacterCounter",
|
9586
|
+
"privacy": "protected"
|
9587
|
+
},
|
9588
|
+
{
|
9589
|
+
"kind": "method",
|
9590
|
+
"name": "renderTextareaFooter",
|
9591
|
+
"privacy": "protected"
|
9592
|
+
},
|
9593
|
+
{
|
9594
|
+
"kind": "field",
|
9595
|
+
"name": "value",
|
9596
|
+
"type": {
|
9597
|
+
"text": "string"
|
9598
|
+
},
|
9599
|
+
"default": "''",
|
9600
|
+
"description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
|
9601
|
+
"attribute": "value",
|
9602
|
+
"reflects": true,
|
9603
|
+
"inheritedFrom": {
|
9604
|
+
"name": "FormInternalsMixin",
|
9605
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
9606
|
+
}
|
9607
|
+
},
|
9608
|
+
{
|
9609
|
+
"kind": "field",
|
9610
|
+
"name": "name",
|
9611
|
+
"type": {
|
9612
|
+
"text": "string"
|
9613
|
+
},
|
9614
|
+
"default": "''",
|
9615
|
+
"description": "Indicates the name of the component group.\nThey are used to group elements in a form together.",
|
9616
|
+
"attribute": "name",
|
9617
|
+
"reflects": true,
|
9618
|
+
"inheritedFrom": {
|
9619
|
+
"name": "FormInternalsMixin",
|
9620
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
9621
|
+
}
|
9622
|
+
},
|
9623
|
+
{
|
9624
|
+
"kind": "field",
|
9625
|
+
"name": "validationMessage",
|
9626
|
+
"type": {
|
9627
|
+
"text": "string | undefined"
|
9628
|
+
},
|
9629
|
+
"description": "Custom validation message that will override the default message and displayed when the input is invalid.",
|
9630
|
+
"attribute": "validation-message",
|
9631
|
+
"reflects": true,
|
9632
|
+
"inheritedFrom": {
|
9633
|
+
"name": "FormInternalsMixin",
|
9634
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
9635
|
+
}
|
9636
|
+
},
|
9637
|
+
{
|
9638
|
+
"kind": "field",
|
9639
|
+
"name": "validity",
|
9640
|
+
"type": {
|
9641
|
+
"text": "ValidityState"
|
9642
|
+
},
|
9643
|
+
"readonly": true,
|
9644
|
+
"inheritedFrom": {
|
9645
|
+
"name": "FormInternalsMixin",
|
9646
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
9647
|
+
}
|
9648
|
+
},
|
9649
|
+
{
|
9650
|
+
"kind": "field",
|
9651
|
+
"name": "willValidate",
|
9652
|
+
"readonly": true,
|
9653
|
+
"inheritedFrom": {
|
9654
|
+
"name": "FormInternalsMixin",
|
9655
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
9656
|
+
}
|
9657
|
+
},
|
9658
|
+
{
|
9659
|
+
"kind": "method",
|
9660
|
+
"name": "setValidity",
|
9661
|
+
"description": "Sets the validity of the input field based on the input field's validity.",
|
9662
|
+
"return": {
|
9663
|
+
"type": {
|
9664
|
+
"text": ""
|
9665
|
+
}
|
9666
|
+
},
|
9667
|
+
"inheritedFrom": {
|
9668
|
+
"name": "FormInternalsMixin",
|
9669
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
9670
|
+
}
|
9671
|
+
},
|
9672
|
+
{
|
9673
|
+
"kind": "method",
|
9674
|
+
"name": "checkValidity",
|
9675
|
+
"return": {
|
9676
|
+
"type": {
|
9677
|
+
"text": "boolean"
|
9678
|
+
}
|
9679
|
+
},
|
9680
|
+
"inheritedFrom": {
|
9681
|
+
"name": "FormInternalsMixin",
|
9682
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
9683
|
+
}
|
9684
|
+
},
|
9685
|
+
{
|
9686
|
+
"kind": "method",
|
9687
|
+
"name": "reportValidity",
|
9688
|
+
"inheritedFrom": {
|
9689
|
+
"name": "FormInternalsMixin",
|
9690
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
9691
|
+
}
|
9692
|
+
},
|
9693
|
+
{
|
9694
|
+
"kind": "field",
|
9695
|
+
"name": "id",
|
9696
|
+
"type": {
|
9697
|
+
"text": "string"
|
9698
|
+
},
|
9699
|
+
"default": "`mdc-input-${uuidv4()}`",
|
9700
|
+
"description": "The unique id of the input field. It is used to link the input field with the label.",
|
9701
|
+
"attribute": "id",
|
9702
|
+
"inheritedFrom": {
|
9703
|
+
"name": "FormfieldWrapper",
|
9704
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
9705
|
+
}
|
9706
|
+
},
|
9707
|
+
{
|
9708
|
+
"kind": "field",
|
9709
|
+
"name": "dataAriaLabel",
|
9710
|
+
"type": {
|
9711
|
+
"text": "string | null"
|
9712
|
+
},
|
9713
|
+
"default": "null",
|
9714
|
+
"description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
|
9715
|
+
"attribute": "data-aria-label",
|
9716
|
+
"reflects": true,
|
9717
|
+
"inheritedFrom": {
|
9718
|
+
"name": "DataAriaLabelMixin",
|
9719
|
+
"module": "utils/mixins/DataAriaLabelMixin.js"
|
9720
|
+
}
|
9721
|
+
},
|
9722
|
+
{
|
9723
|
+
"kind": "field",
|
9724
|
+
"name": "disabled",
|
9725
|
+
"type": {
|
9726
|
+
"text": "boolean"
|
9727
|
+
},
|
9728
|
+
"default": "false",
|
9729
|
+
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
9730
|
+
"attribute": "disabled",
|
9731
|
+
"reflects": true,
|
9732
|
+
"inheritedFrom": {
|
9733
|
+
"name": "FormfieldWrapper",
|
9734
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
9735
|
+
}
|
9736
|
+
},
|
9737
|
+
{
|
9738
|
+
"kind": "field",
|
9739
|
+
"name": "label",
|
9740
|
+
"type": {
|
9741
|
+
"text": "string | undefined"
|
9742
|
+
},
|
9743
|
+
"description": "The label of the input field. It is linked to the input field using the `for` attribute.",
|
9744
|
+
"attribute": "label",
|
9745
|
+
"reflects": true,
|
9746
|
+
"inheritedFrom": {
|
9747
|
+
"name": "FormfieldWrapper",
|
9748
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
9749
|
+
}
|
9750
|
+
},
|
9751
|
+
{
|
9752
|
+
"kind": "field",
|
9753
|
+
"name": "requiredLabel",
|
9754
|
+
"type": {
|
9755
|
+
"text": "string | undefined"
|
9756
|
+
},
|
9757
|
+
"description": "The required label of the input field.\nWhen an appropriate string value is set,\nthe input field is marked as required and the label is appended with this text.",
|
9758
|
+
"attribute": "required-label",
|
9759
|
+
"reflects": true,
|
9760
|
+
"inheritedFrom": {
|
9761
|
+
"name": "FormfieldWrapper",
|
9762
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
9763
|
+
}
|
9764
|
+
},
|
9765
|
+
{
|
9766
|
+
"kind": "field",
|
9767
|
+
"name": "helpTextType",
|
9768
|
+
"type": {
|
9769
|
+
"text": "ValidationType"
|
9770
|
+
},
|
9771
|
+
"description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
|
9772
|
+
"attribute": "help-text-type",
|
9773
|
+
"reflects": true,
|
9774
|
+
"inheritedFrom": {
|
9775
|
+
"name": "FormfieldWrapper",
|
9776
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
9777
|
+
}
|
9778
|
+
},
|
9779
|
+
{
|
9780
|
+
"kind": "field",
|
9781
|
+
"name": "helpText",
|
9782
|
+
"type": {
|
9783
|
+
"text": "string | undefined"
|
9784
|
+
},
|
9785
|
+
"description": "The help text that is displayed below the input field.",
|
9786
|
+
"attribute": "help-text",
|
9787
|
+
"reflects": true,
|
9788
|
+
"inheritedFrom": {
|
9789
|
+
"name": "FormfieldWrapper",
|
9790
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
9791
|
+
}
|
9792
|
+
},
|
9793
|
+
{
|
9794
|
+
"kind": "method",
|
9795
|
+
"name": "renderLabelElement",
|
9796
|
+
"privacy": "protected",
|
9797
|
+
"description": "creates the label element when the label property is set.\nid is used to link the label with the input field.",
|
9798
|
+
"return": {
|
9799
|
+
"type": {
|
9800
|
+
"text": ""
|
9801
|
+
}
|
9802
|
+
},
|
9803
|
+
"inheritedFrom": {
|
9804
|
+
"name": "FormfieldWrapper",
|
9805
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
9806
|
+
}
|
9807
|
+
},
|
9808
|
+
{
|
9809
|
+
"kind": "method",
|
9810
|
+
"name": "renderRequiredLabel",
|
9811
|
+
"privacy": "protected",
|
9812
|
+
"inheritedFrom": {
|
9813
|
+
"name": "FormfieldWrapper",
|
9814
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
9815
|
+
}
|
9816
|
+
},
|
9817
|
+
{
|
9818
|
+
"kind": "method",
|
9819
|
+
"name": "renderHelpTextIcon",
|
9820
|
+
"privacy": "protected",
|
9821
|
+
"description": "creates the helpertext icon based on the helpTextType for validation.\nIf the helpTextType is not set, it defaults to 'default' and it doesn't display any icon.",
|
9822
|
+
"return": {
|
9823
|
+
"type": {
|
9824
|
+
"text": ""
|
9825
|
+
}
|
9826
|
+
},
|
9827
|
+
"inheritedFrom": {
|
9828
|
+
"name": "FormfieldWrapper",
|
9829
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
9830
|
+
}
|
9831
|
+
},
|
9832
|
+
{
|
9833
|
+
"kind": "method",
|
9834
|
+
"name": "renderHelpText",
|
9835
|
+
"privacy": "protected",
|
9836
|
+
"description": "creates the helper text component when the helpertext value is set.\nIt is also used to display the validation message based on the helpTextType.",
|
9837
|
+
"return": {
|
9838
|
+
"type": {
|
9839
|
+
"text": ""
|
9840
|
+
}
|
9841
|
+
},
|
9842
|
+
"inheritedFrom": {
|
9843
|
+
"name": "FormfieldWrapper",
|
9844
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
9845
|
+
}
|
9846
|
+
},
|
9847
|
+
{
|
9848
|
+
"kind": "method",
|
9849
|
+
"name": "renderLabel",
|
9850
|
+
"privacy": "protected",
|
9851
|
+
"description": "renders the mdc-label-text container that contains the label and labelInfoToggleTip.",
|
9852
|
+
"return": {
|
9853
|
+
"type": {
|
9854
|
+
"text": ""
|
9855
|
+
}
|
9856
|
+
},
|
9857
|
+
"inheritedFrom": {
|
9858
|
+
"name": "FormfieldWrapper",
|
9859
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
9860
|
+
}
|
9861
|
+
},
|
9862
|
+
{
|
9863
|
+
"kind": "method",
|
9864
|
+
"name": "renderHelperText",
|
9865
|
+
"privacy": "protected",
|
9866
|
+
"description": "renders the mdc-help-text container that contains the helpertext icon and helpertext.",
|
9867
|
+
"return": {
|
9868
|
+
"type": {
|
9869
|
+
"text": ""
|
9870
|
+
}
|
9871
|
+
},
|
9872
|
+
"inheritedFrom": {
|
9873
|
+
"name": "FormfieldWrapper",
|
9874
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
9875
|
+
}
|
9876
|
+
}
|
9877
|
+
],
|
9878
|
+
"events": [
|
9879
|
+
{
|
9880
|
+
"name": "limitexceeded",
|
9881
|
+
"type": {
|
9882
|
+
"text": "CustomEvent"
|
9883
|
+
},
|
9884
|
+
"description": "(React: onLimitExceeded) This event is dispatched once when the character limit exceeds or restored.",
|
9885
|
+
"reactName": "onLimitExceeded",
|
9886
|
+
"eventName": "LimitexceededEvent"
|
9887
|
+
},
|
9888
|
+
{
|
9889
|
+
"type": {
|
9890
|
+
"text": "EventConstructor"
|
9891
|
+
}
|
9892
|
+
},
|
9893
|
+
{
|
9894
|
+
"description": "(React: onInput) This event is dispatched when the value of the textarea field changes (every press).",
|
9895
|
+
"name": "input",
|
9896
|
+
"reactName": "onInput",
|
9897
|
+
"eventName": "InputEvent"
|
9898
|
+
},
|
9899
|
+
{
|
9900
|
+
"description": "(React: onChange) This event is dispatched when the value of the textarea field changes (on blur).",
|
9901
|
+
"name": "change",
|
9902
|
+
"reactName": "onChange",
|
9903
|
+
"eventName": "ChangeEvent"
|
9904
|
+
},
|
9905
|
+
{
|
9906
|
+
"description": "(React: onFocus) This event is dispatched when the textarea receives focus.",
|
9907
|
+
"name": "focus",
|
9908
|
+
"reactName": "onFocus",
|
9909
|
+
"eventName": "FocusEvent"
|
9910
|
+
},
|
9911
|
+
{
|
9912
|
+
"description": "(React: onBlur) This event is dispatched when the textarea loses focus.",
|
9913
|
+
"name": "blur",
|
9914
|
+
"reactName": "onBlur",
|
9915
|
+
"eventName": "BlurEvent"
|
9916
|
+
}
|
9917
|
+
],
|
9918
|
+
"attributes": [
|
9919
|
+
{
|
9920
|
+
"name": "placeholder",
|
9921
|
+
"type": {
|
9922
|
+
"text": "string | undefined"
|
9923
|
+
},
|
9924
|
+
"description": "The placeholder text that is displayed when the textarea field is empty.",
|
9925
|
+
"fieldName": "placeholder"
|
9926
|
+
},
|
9927
|
+
{
|
9928
|
+
"name": "readonly",
|
9929
|
+
"type": {
|
9930
|
+
"text": "boolean"
|
9931
|
+
},
|
9932
|
+
"default": "false",
|
9933
|
+
"description": "readonly attribute of the textarea field. If true, the textarea field is read-only.",
|
9934
|
+
"fieldName": "readonly"
|
9935
|
+
},
|
9936
|
+
{
|
9937
|
+
"name": "rows",
|
9938
|
+
"description": "The rows attribute specifies the visible number of lines in a text area.",
|
9939
|
+
"default": "5",
|
9940
|
+
"fieldName": "rows"
|
9941
|
+
},
|
9942
|
+
{
|
9943
|
+
"name": "cols",
|
9944
|
+
"description": "The cols attribute specifies the visible number of lines in a text area.",
|
9945
|
+
"default": "40",
|
9946
|
+
"fieldName": "cols"
|
9947
|
+
},
|
9948
|
+
{
|
9949
|
+
"name": "wrap",
|
9950
|
+
"type": {
|
9951
|
+
"text": "WrapType"
|
9952
|
+
},
|
9953
|
+
"description": "The wrap attribute specifies how the text in a text area is to be wrapped when submitted in a form.",
|
9954
|
+
"default": "'soft'",
|
9955
|
+
"fieldName": "wrap"
|
9956
|
+
},
|
9957
|
+
{
|
9958
|
+
"name": "autocapitalize",
|
9959
|
+
"type": {
|
9960
|
+
"text": "AutoCapitalizeType"
|
9961
|
+
},
|
9962
|
+
"description": "The autocapitalize attribute of the textarea field.",
|
9963
|
+
"default": "'off'",
|
9964
|
+
"fieldName": "autocapitalize"
|
9965
|
+
},
|
9966
|
+
{
|
9967
|
+
"name": "autocomplete",
|
9968
|
+
"type": {
|
9969
|
+
"text": "AutoCompleteType"
|
9970
|
+
},
|
9971
|
+
"description": "The autocomplete attribute of the textarea field.",
|
9972
|
+
"default": "'off'",
|
9973
|
+
"fieldName": "autocomplete"
|
9974
|
+
},
|
9975
|
+
{
|
9976
|
+
"name": "autofocus",
|
9977
|
+
"type": {
|
9978
|
+
"text": "boolean"
|
9979
|
+
},
|
9980
|
+
"default": "false",
|
9981
|
+
"description": "If true, the textarea field is focused when the component is rendered.",
|
9982
|
+
"fieldName": "autofocus"
|
9983
|
+
},
|
9984
|
+
{
|
9985
|
+
"name": "dirname",
|
9986
|
+
"type": {
|
9987
|
+
"text": "string | undefined"
|
9988
|
+
},
|
9989
|
+
"description": "Specifies the name of the directionality of text for submission purposes (e.g., \"rtl\" for right-to-left).",
|
9990
|
+
"fieldName": "dirname"
|
9991
|
+
},
|
9992
|
+
{
|
9993
|
+
"name": "maxlength",
|
9994
|
+
"type": {
|
9995
|
+
"text": "number | undefined"
|
9996
|
+
},
|
9997
|
+
"description": "The maximum number of characters that the textarea field can accept.",
|
9998
|
+
"fieldName": "maxlength"
|
9999
|
+
},
|
10000
|
+
{
|
10001
|
+
"name": "minlength",
|
10002
|
+
"type": {
|
10003
|
+
"text": "number | undefined"
|
10004
|
+
},
|
10005
|
+
"description": "The minimum number of characters that the textarea field can accept.",
|
10006
|
+
"fieldName": "minlength"
|
10007
|
+
},
|
10008
|
+
{
|
10009
|
+
"name": "clear-button",
|
10010
|
+
"type": {
|
10011
|
+
"text": "boolean"
|
10012
|
+
},
|
10013
|
+
"default": "false",
|
10014
|
+
"description": "The clear button when set to true, shows a clear button that clears the textarea field.",
|
10015
|
+
"fieldName": "clearButton"
|
10016
|
+
},
|
9016
10017
|
{
|
9017
|
-
"name": "
|
10018
|
+
"name": "clear-aria-label",
|
9018
10019
|
"type": {
|
9019
|
-
"text": "string
|
10020
|
+
"text": "string"
|
9020
10021
|
},
|
9021
|
-
"
|
9022
|
-
"
|
10022
|
+
"default": "''",
|
10023
|
+
"description": "Aria label for the clear button. If clear button is set to true, this label is used for the clear button.",
|
10024
|
+
"fieldName": "clearAriaLabel"
|
9023
10025
|
},
|
9024
10026
|
{
|
9025
|
-
"name": "
|
10027
|
+
"name": "max-character-limit",
|
9026
10028
|
"type": {
|
9027
|
-
"text": "
|
10029
|
+
"text": "number | undefined"
|
9028
10030
|
},
|
9029
|
-
"description": "
|
9030
|
-
"
|
9031
|
-
"fieldName": "variant"
|
10031
|
+
"description": "maximum character limit for the textarea field for character counter.",
|
10032
|
+
"fieldName": "maxCharacterLimit"
|
9032
10033
|
},
|
9033
10034
|
{
|
9034
|
-
"name": "
|
10035
|
+
"name": "name",
|
9035
10036
|
"type": {
|
9036
|
-
"text": "
|
10037
|
+
"text": "string"
|
9037
10038
|
},
|
9038
|
-
"
|
9039
|
-
"
|
10039
|
+
"default": "''",
|
10040
|
+
"description": "Indicates the name of the component group.\nThey are used to group elements in a form together.",
|
10041
|
+
"fieldName": "name",
|
9040
10042
|
"inheritedFrom": {
|
9041
|
-
"name": "
|
9042
|
-
"module": "src/utils/mixins/
|
10043
|
+
"name": "FormInternalsMixin",
|
10044
|
+
"module": "src/utils/mixins/FormInternalsMixin.ts"
|
9043
10045
|
}
|
9044
10046
|
},
|
9045
10047
|
{
|
9046
|
-
"name": "
|
10048
|
+
"name": "value",
|
9047
10049
|
"type": {
|
9048
|
-
"text": "
|
10050
|
+
"text": "string"
|
9049
10051
|
},
|
9050
|
-
"default": "
|
9051
|
-
"description": "
|
9052
|
-
"fieldName": "
|
10052
|
+
"default": "''",
|
10053
|
+
"description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
|
10054
|
+
"fieldName": "value",
|
9053
10055
|
"inheritedFrom": {
|
9054
|
-
"name": "
|
9055
|
-
"module": "src/
|
10056
|
+
"name": "FormInternalsMixin",
|
10057
|
+
"module": "src/utils/mixins/FormInternalsMixin.ts"
|
9056
10058
|
}
|
9057
10059
|
},
|
9058
10060
|
{
|
9059
|
-
"name": "
|
10061
|
+
"name": "validation-message",
|
9060
10062
|
"type": {
|
9061
|
-
"text": "
|
10063
|
+
"text": "string | undefined"
|
9062
10064
|
},
|
9063
|
-
"
|
9064
|
-
"
|
9065
|
-
"fieldName": "disabled",
|
10065
|
+
"description": "Custom validation message that will override the default message and displayed when the input is invalid.",
|
10066
|
+
"fieldName": "validationMessage",
|
9066
10067
|
"inheritedFrom": {
|
9067
|
-
"name": "
|
9068
|
-
"module": "src/
|
10068
|
+
"name": "FormInternalsMixin",
|
10069
|
+
"module": "src/utils/mixins/FormInternalsMixin.ts"
|
9069
10070
|
}
|
9070
10071
|
},
|
9071
10072
|
{
|
9072
|
-
"name": "
|
10073
|
+
"name": "data-aria-label",
|
9073
10074
|
"type": {
|
9074
|
-
"text": "
|
10075
|
+
"text": "string | null"
|
9075
10076
|
},
|
9076
|
-
"default": "
|
9077
|
-
"description": "
|
9078
|
-
"fieldName": "
|
10077
|
+
"default": "null",
|
10078
|
+
"description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
|
10079
|
+
"fieldName": "dataAriaLabel",
|
9079
10080
|
"inheritedFrom": {
|
9080
|
-
"name": "
|
9081
|
-
"module": "src/
|
10081
|
+
"name": "DataAriaLabelMixin",
|
10082
|
+
"module": "src/utils/mixins/DataAriaLabelMixin.ts"
|
9082
10083
|
}
|
9083
10084
|
},
|
9084
10085
|
{
|
9085
|
-
"name": "
|
10086
|
+
"name": "disabled",
|
9086
10087
|
"type": {
|
9087
10088
|
"text": "boolean"
|
9088
10089
|
},
|
9089
10090
|
"default": "false",
|
9090
|
-
"description": "Indicates whether the
|
9091
|
-
"fieldName": "
|
10091
|
+
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
10092
|
+
"fieldName": "disabled",
|
9092
10093
|
"inheritedFrom": {
|
9093
|
-
"name": "
|
9094
|
-
"module": "src/components/
|
10094
|
+
"name": "FormfieldWrapper",
|
10095
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
9095
10096
|
}
|
9096
10097
|
},
|
9097
10098
|
{
|
9098
|
-
"name": "
|
10099
|
+
"name": "label",
|
9099
10100
|
"type": {
|
9100
|
-
"text": "
|
10101
|
+
"text": "string | undefined"
|
9101
10102
|
},
|
9102
|
-
"description": "
|
9103
|
-
"
|
9104
|
-
"fieldName": "size",
|
10103
|
+
"description": "The label of the input field. It is linked to the input field using the `for` attribute.",
|
10104
|
+
"fieldName": "label",
|
9105
10105
|
"inheritedFrom": {
|
9106
|
-
"name": "
|
9107
|
-
"module": "src/components/
|
10106
|
+
"name": "FormfieldWrapper",
|
10107
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
9108
10108
|
}
|
9109
10109
|
},
|
9110
10110
|
{
|
9111
|
-
"name": "
|
9112
|
-
"
|
9113
|
-
|
9114
|
-
|
10111
|
+
"name": "required-label",
|
10112
|
+
"type": {
|
10113
|
+
"text": "string | undefined"
|
10114
|
+
},
|
10115
|
+
"description": "The required label of the input field.\nWhen an appropriate string value is set,\nthe input field is marked as required and the label is appended with this text.",
|
10116
|
+
"fieldName": "requiredLabel",
|
9115
10117
|
"inheritedFrom": {
|
9116
|
-
"name": "
|
9117
|
-
"module": "src/components/
|
10118
|
+
"name": "FormfieldWrapper",
|
10119
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
9118
10120
|
}
|
9119
10121
|
},
|
9120
10122
|
{
|
9121
|
-
"name": "
|
10123
|
+
"name": "id",
|
9122
10124
|
"type": {
|
9123
|
-
"text": "
|
10125
|
+
"text": "string"
|
9124
10126
|
},
|
9125
|
-
"
|
9126
|
-
"
|
9127
|
-
"fieldName": "
|
10127
|
+
"default": "''",
|
10128
|
+
"description": "The unique id of the input field. It is used to link the input field with the label.",
|
10129
|
+
"fieldName": "id",
|
9128
10130
|
"inheritedFrom": {
|
9129
|
-
"name": "
|
9130
|
-
"module": "src/components/
|
10131
|
+
"name": "FormfieldWrapper",
|
10132
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
9131
10133
|
}
|
9132
|
-
}
|
9133
|
-
],
|
9134
|
-
"mixins": [
|
9135
|
-
{
|
9136
|
-
"name": "IconNameMixin",
|
9137
|
-
"module": "/src/utils/mixins/IconNameMixin"
|
9138
|
-
}
|
9139
|
-
],
|
9140
|
-
"superclass": {
|
9141
|
-
"name": "Buttonsimple",
|
9142
|
-
"module": "/src/components/buttonsimple/buttonsimple.component"
|
9143
|
-
},
|
9144
|
-
"tagName": "mdc-tab",
|
9145
|
-
"jsDoc": "/**\n * `mdc-tab` is Tab component to be used within the Tabgroup.\n *\n * Passing in the attribute `text` to the tab component is changing the text displayed in the tab.\n *\n * The `slot=\"badge\"` can be used to add a badge to the tab.\n *\n * The `slot=\"chip\"` can be used to add a chip to the tab.\n *\n * For `icon`, the `mdc-icon` component is used to render the icon.\n *\n * Note: Icons can be used in conjunction with badges or chips.\n * Badges and chips should not be used at the same time.\n *\n * @dependency mdc-icon\n * @dependency mdc-text\n *\n * @event click - (React: onClick) This event is dispatched when the tab is clicked.\n * @event keydown - (React: onKeyDown) This event is dispatched when a key is pressed down on the tab.\n * @event keyup - (React: onKeyUp) This event is dispatched when a key is released on the tab.\n * @event focus - (React: onFocus) This event is dispatched when the tab receives focus.\n *\n * @tagname mdc-tab\n *\n * @cssproperty --mdc-tab-content-gap - Gap between the badge(if provided), icon and text.\n * @cssproperty --mdc-tab-height - Height of the tab.\n * @cssproperty --mdc-tab-glass-active-background-color-disabled - Background color for active glass tab\n * in disabled state.\n * @cssproperty --mdc-tab-glass-active-background-color-hover - Background color for active glass tab in hover state.\n * @cssproperty --mdc-tab-glass-active-background-color-normal - Background color for active glass tab in rest state.\n * @cssproperty --mdc-tab-glass-active-background-color-pressed - Background color for active glass tab\n * in pressed state.\n * @cssproperty --mdc-tab-glass-active-color - Text and icon color for active glass tab.\n * @cssproperty --mdc-tab-glass-active-color-disabled - Text and icon color for active glass tab in disabled state.\n * @cssproperty --mdc-tab-glass-border-radius - Border radius for glass tab.\n * @cssproperty --mdc-tab-glass-inactive-background-color-disabled - Background color for inactive glass tab\n * in disabled state.\n * @cssproperty --mdc-tab-glass-inactive-background-color-hover - Background color for inactive glass tab\n * in hover state.\n * @cssproperty --mdc-tab-glass-inactive-background-color-normal - Background color for inactive glass tab\n * in rest state.\n * @cssproperty --mdc-tab-glass-inactive-background-color-pressed - Background color for inactive glass tab\n * in pressed state.\n * @cssproperty --mdc-tab-glass-inactive-color - Text and icon color for inactive glass tab.\n * @cssproperty --mdc-tab-glass-inactive-color-disabled - Text and icon color for inactive glass tab in disabled state.\n * @cssproperty --mdc-tab-line-active-background-color-pressed - Background color for active line tab in pressed state.\n * @cssproperty --mdc-tab-line-active-background-color-disabled - Background color for active line tab\n * in disabled state.\n * @cssproperty --mdc-tab-line-active-background-color-hover - Background color for active line tab in hover state.\n * @cssproperty --mdc-tab-line-active-background-color-normal - Background color for active line tab in rest state.\n * @cssproperty --mdc-tab-line-active-color - Text and icon color for active line tab.\n * @cssproperty --mdc-tab-line-active-color-disabled - Text and icon color for active line tab in disabled state.\n * @cssproperty --mdc-tab-line-active-indicator-color - color for indicator in active line tab.\n * @cssproperty --mdc-tab-line-active-indicator-color-disabled - Color for indicator in active line tab\n * in disabled state.\n * @cssproperty --mdc-tab-line-active-indicator-height - Height for indicator in active line tab.\n * @cssproperty --mdc-tab-line-active-indicator-width - Width for indicator in active line tab.\n * @cssproperty --mdc-tab-line-border-bottom-left-radius - Bottom left border radius for line tab.\n * @cssproperty --mdc-tab-line-border-bottom-right-radius - Bottom right border radius for line tab.\n * @cssproperty --mdc-tab-line-border-top-left-radius - Top left border radius for line tab.\n * @cssproperty --mdc-tab-line-border-top-right-radius - Top right border radius for line tab.\n * @cssproperty --mdc-tab-line-inactive-background-color-pressed - Background color for inactive line tab\n * in pressed state.\n * @cssproperty --mdc-tab-line-inactive-background-color-disabled - Background color for inactive line tab\n * in disabled state\n * @cssproperty --mdc-tab-line-inactive-background-color-hover - Background color for inactive line tab in hover state.\n * @cssproperty --mdc-tab-line-inactive-background-color-normal - Background color for inactive line tab\n * in rest state.\n * @cssproperty --mdc-tab-line-inactive-color - Text and icon color for inactive line tab.\n * @cssproperty --mdc-tab-line-inactive-color-disabled - Text and icon color for inactive line tab in disabled state.\n * @cssproperty --mdc-tab-padding-left - Padding left for the tab.\n * @cssproperty --mdc-tab-padding-right - Padding right for the tab.\n * @cssproperty --mdc-tab-pill-active-background-color-pressed - Background color for active pill tab in pressed state.\n * @cssproperty --mdc-tab-pill-active-background-color-disabled - Background color for active pill tab\n * in disabled state.\n * @cssproperty --mdc-tab-pill-active-background-color-hover - Background color for active pill tab in hover state.\n * @cssproperty --mdc-tab-pill-active-background-color-normal - Background color for active pill tab in rest state.\n * @cssproperty --mdc-tab-pill-active-color - Text and icon color for active pill tab.\n * @cssproperty --mdc-tab-pill-active-color-disabled - Text and icon color for active pill tab in disabled state.\n * @cssproperty --mdc-tab-pill-border-radius - Border radius for pill tab.\n * @cssproperty --mdc-tab-pill-inactive-background-color-pressed - Background color for inactive pill tab\n * in pressed state.\n * @cssproperty --mdc-tab-pill-inactive-background-color-disabled - Background color for inactive pill tab\n * in disabled state.\n * @cssproperty --mdc-tab-pill-inactive-background-color-hover - Background color for inactive pill tab in hover state.\n * @cssproperty --mdc-tab-pill-inactive-background-color-normal - Background color for inactive pill tab in rest state.\n * @cssproperty --mdc-tab-pill-inactive-color - Text and icon color for inactive pill tab.\n * @cssproperty --mdc-tab-pill-inactive-color-disabled - Text and icon color for inactive pill tab in disabled state.\n */",
|
9146
|
-
"customElement": true
|
9147
|
-
}
|
9148
|
-
],
|
9149
|
-
"exports": [
|
9150
|
-
{
|
9151
|
-
"kind": "js",
|
9152
|
-
"name": "default",
|
9153
|
-
"declaration": {
|
9154
|
-
"name": "Tab",
|
9155
|
-
"module": "components/tab/tab.component.js"
|
9156
|
-
}
|
9157
|
-
}
|
9158
|
-
]
|
9159
|
-
},
|
9160
|
-
{
|
9161
|
-
"kind": "javascript-module",
|
9162
|
-
"path": "components/text/text.component.js",
|
9163
|
-
"declarations": [
|
9164
|
-
{
|
9165
|
-
"kind": "class",
|
9166
|
-
"description": "Text component for creating styled text elements.\nIt has to be mounted within the ThemeProvider to access color and font tokens.\n\nThe `type` attribute allows changing the text style.\nThe `tagname` attribute allows changing the tag name of the text element.\nThe default tag name is `p`.\n\nThe `tagname` attribute should be a valid HTML tag name.\nIf the `tagname` attribute is not a valid HTML tag name, the default tag name will be used.\n\nThe styling is applied based on the `type` attribute.",
|
9167
|
-
"name": "Text",
|
9168
|
-
"cssParts": [
|
9169
|
-
{
|
9170
|
-
"description": "The text element",
|
9171
|
-
"name": "text"
|
9172
|
-
}
|
9173
|
-
],
|
9174
|
-
"slots": [
|
9175
|
-
{
|
9176
|
-
"description": "Default slot for text content",
|
9177
|
-
"name": ""
|
9178
|
-
}
|
9179
|
-
],
|
9180
|
-
"members": [
|
10134
|
+
},
|
9181
10135
|
{
|
9182
|
-
"
|
9183
|
-
"name": "type",
|
10136
|
+
"name": "help-text-type",
|
9184
10137
|
"type": {
|
9185
|
-
"text": "
|
10138
|
+
"text": "ValidationType"
|
9186
10139
|
},
|
9187
|
-
"
|
9188
|
-
"
|
9189
|
-
"
|
9190
|
-
|
9191
|
-
|
10140
|
+
"description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
|
10141
|
+
"fieldName": "helpTextType",
|
10142
|
+
"inheritedFrom": {
|
10143
|
+
"name": "FormfieldWrapper",
|
10144
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
10145
|
+
}
|
9192
10146
|
},
|
9193
10147
|
{
|
9194
|
-
"
|
9195
|
-
"name": "tagname",
|
10148
|
+
"name": "help-text",
|
9196
10149
|
"type": {
|
9197
|
-
"text": "
|
10150
|
+
"text": "string | undefined"
|
9198
10151
|
},
|
9199
|
-
"
|
9200
|
-
"
|
9201
|
-
"
|
9202
|
-
|
10152
|
+
"description": "The help text that is displayed below the input field.",
|
10153
|
+
"fieldName": "helpText",
|
10154
|
+
"inheritedFrom": {
|
10155
|
+
"name": "FormfieldWrapper",
|
10156
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
10157
|
+
}
|
9203
10158
|
}
|
9204
10159
|
],
|
9205
|
-
"
|
10160
|
+
"mixins": [
|
9206
10161
|
{
|
9207
|
-
"name": "
|
9208
|
-
"
|
9209
|
-
"text": "TextType"
|
9210
|
-
},
|
9211
|
-
"description": "Specifies the text style to be applied.\n\nAcceptable values include:\n\n- 'body-small-regular'\n- 'body-small-medium'\n- 'body-small-bold'\n- 'body-midsize-regular'\n- 'body-midsize-medium'\n- 'body-midsize-bold'\n- 'body-large-regular'\n- 'body-large-medium'\n- 'body-large-bold'\n- 'body-small-regular-underline'\n- 'body-small-medium-underline'\n- 'body-midsize-regular-underline'\n- 'body-midsize-medium-underline'\n- 'body-large-regular-underline'\n- 'body-large-medium-underline'\n- 'heading-small-regular'\n- 'heading-small-medium'\n- 'heading-small-bold'\n- 'heading-midsize-regular'\n- 'heading-midsize-medium'\n- 'heading-midsize-bold'\n- 'heading-large-regular'\n- 'heading-large-medium'\n- 'heading-large-bold'\n- 'heading-xlarge-regular'\n- 'heading-xlarge-medium'\n- 'heading-xlarge-bold'\n- 'headline-small-light'\n- 'headline-small-regular'",
|
9212
|
-
"default": "body-large-regular",
|
9213
|
-
"fieldName": "type"
|
10162
|
+
"name": "FormInternalsMixin",
|
10163
|
+
"module": "/src/utils/mixins/FormInternalsMixin"
|
9214
10164
|
},
|
9215
10165
|
{
|
9216
|
-
"name": "
|
9217
|
-
"
|
9218
|
-
"text": "TagName | undefined"
|
9219
|
-
},
|
9220
|
-
"description": "Specifies the HTML tag name for the text element. The default tag name is `p`.\nThis attribute is optional. When set, it changes the tag name of the text element.\n\nAcceptable values include:\n\n- 'h1'\n- 'h2'\n- 'h3'\n- 'h4'\n- 'h5'\n- 'h6'\n- 'p'\n- 'small'\n- 'span'\n- 'div'\n\nFor instance, setting this attribute to `h2` will render the text element as an `h2` element.\nNote that the styling is determined by the `type` attribute.",
|
9221
|
-
"fieldName": "tagname"
|
10166
|
+
"name": "DataAriaLabelMixin",
|
10167
|
+
"module": "/src/utils/mixins/DataAriaLabelMixin"
|
9222
10168
|
}
|
9223
10169
|
],
|
9224
10170
|
"superclass": {
|
9225
|
-
"name": "
|
9226
|
-
"module": "/src/
|
10171
|
+
"name": "FormfieldWrapper",
|
10172
|
+
"module": "/src/components/formfieldwrapper"
|
9227
10173
|
},
|
9228
|
-
"tagName": "mdc-
|
9229
|
-
"jsDoc": "/**\n *
|
9230
|
-
"customElement": true
|
10174
|
+
"tagName": "mdc-textarea",
|
10175
|
+
"jsDoc": "/**\n * mdc-textarea component, which is used to get the multi-line text input from the user.\n * It contains:\n * - label: It is the title of the textarea field.\n * - required-label: A string depicting that the textarea field is required.\n * - Textarea: It is the multi-line text input field.\n * - helper-text: It is the text that provides additional information about the textarea field.\n * - max-character-limit: It is the text that shows the character count of the textarea field.\n * - clear-button: A boolean value when marked to true represents a button that can\n * clear the text value within the textarea field.\n * - Error, Warning, Success, Priority Help Text type: It is the text that provides additional information\n * about the textarea field based on the validation state.\n * - limitexceeded: It is the event that is dispatched when the character limit exceeds or restored.\n * This event exposes 3 properties:\n * - currentCharacterCount - the current number of characters in the textarea field,\n * - maxCharacterLimit - the maximum number of characters allowed in the textarea field,\n * - value - the current value of the textarea field,\n *\n * **Note**: Consumers must set the help-text-type with 'error' and\n * help-text attribute with the error message using limitexceeded event.\n * The same help-text value will be used for the validation message to be displayed.\n *\n * @tagname mdc-textarea\n *\n * @event input - (React: onInput) This event is dispatched when the value of the textarea field changes (every press).\n * @event change - (React: onChange) This event is dispatched when the value of the textarea field changes (on blur).\n * @event focus - (React: onFocus) This event is dispatched when the textarea receives focus.\n * @event blur - (React: onBlur) This event is dispatched when the textarea loses focus.\n * @event limitexceeded - (React: onLimitExceeded) This event is dispatched once when the character limit\n * exceeds or restored.\n *\n *\n * @dependency mdc-icon\n * @dependency mdc-text\n * @dependency mdc-button\n *\n * @cssproperty --mdc-textarea-disabled-border-color - Border color for the textarea container when disabled\n * @cssproperty --mdc-textarea-disabled-text-color - Text color for the textarea field when disabled\n * @cssproperty --mdc-textarea-disabled-background-color - Background color for the textarea field when disabled\n * @cssproperty --mdc-textarea-text-color - Text color for the textarea field\n * @cssproperty --mdc-textarea-background-color - Background color for the textarea field\n * @cssproperty --mdc-textarea-border-color - Border color for the textarea field\n * @cssproperty --mdc-textarea-text-secondary-normal - Text color for the character counter\n * @cssproperty --mdc-textarea-error-border-color - Border color for the error related help text\n * @cssproperty --mdc-textarea-warning-border-color - Border color for the warning related help text\n * @cssproperty --mdc-textarea-success-border-color - Border color for the success related help text\n * @cssproperty --mdc-textarea-primary-border-color - Border color for the priority related help text\n * @cssproperty --mdc-textarea-hover-background-color - Background color for the textarea container when hover\n * @cssproperty --mdc-textarea-focused-background-color - Background color for the textarea container when focused\n * @cssproperty --mdc-textarea-focused-border-color - Border color for the textarea container when focused\n */",
|
10176
|
+
"customElement": true,
|
10177
|
+
"slots": [
|
10178
|
+
{
|
10179
|
+
"description": "slot to add the label info icon",
|
10180
|
+
"name": "label-info",
|
10181
|
+
"inheritedFrom": {
|
10182
|
+
"name": "FormfieldWrapper",
|
10183
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
10184
|
+
}
|
10185
|
+
}
|
10186
|
+
]
|
9231
10187
|
}
|
9232
10188
|
],
|
9233
10189
|
"exports": [
|
@@ -9235,8 +10191,8 @@
|
|
9235
10191
|
"kind": "js",
|
9236
10192
|
"name": "default",
|
9237
10193
|
"declaration": {
|
9238
|
-
"name": "
|
9239
|
-
"module": "components/
|
10194
|
+
"name": "Textarea",
|
10195
|
+
"module": "components/textarea/textarea.component.js"
|
9240
10196
|
}
|
9241
10197
|
}
|
9242
10198
|
]
|