@momentum-design/components 0.51.1 → 0.51.3
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 +218 -178
- package/dist/browser/index.js.map +4 -4
- package/dist/components/tab/tab.component.d.ts +21 -0
- package/dist/components/tab/tab.component.js +28 -1
- package/dist/components/tab/tab.styles.js +1 -0
- package/dist/components/tablist/index.d.ts +9 -0
- package/dist/components/tablist/index.js +6 -0
- package/dist/components/tablist/tablist.component.d.ts +230 -0
- package/dist/components/tablist/tablist.component.js +517 -0
- package/dist/components/tablist/tablist.constants.d.ts +12 -0
- package/dist/components/tablist/tablist.constants.js +13 -0
- package/dist/components/tablist/tablist.styles.d.ts +2 -0
- package/dist/components/tablist/tablist.styles.js +35 -0
- package/dist/components/tablist/tablist.types.d.ts +7 -0
- package/dist/components/tablist/tablist.types.js +1 -0
- package/dist/components/tablist/tablist.utils.d.ts +7 -0
- package/dist/components/tablist/tablist.utils.js +12 -0
- package/dist/components/tooltip/tooltip.component.js +0 -1
- package/dist/custom-elements.json +597 -449
- package/dist/index.d.ts +2 -1
- package/dist/index.js +2 -1
- package/dist/react/index.d.ts +2 -1
- package/dist/react/index.js +2 -1
- package/dist/react/tab/index.d.ts +9 -0
- package/dist/react/tab/index.js +9 -0
- package/dist/react/tablist/index.d.ts +51 -0
- package/dist/react/tablist/index.js +59 -0
- package/dist/utils/styles/index.d.ts +2 -1
- package/dist/utils/styles/index.js +3 -3
- package/package.json +1 -1
@@ -4,464 +4,159 @@
|
|
4
4
|
"modules": [
|
5
5
|
{
|
6
6
|
"kind": "javascript-module",
|
7
|
-
"path": "components/
|
8
|
-
"declarations": [
|
9
|
-
{
|
10
|
-
"kind": "class",
|
11
|
-
"description": "The `mdc-appheader` component provides a structured and accessible app header layout.\nIt consists of three primary sections: leading, center, and trailing.\n\n- The **leading section** typically holds a **brand logo**, **brand name** or **menu icon**.\n- The **center section** can contain a **search bar**, **icons** or action controls.\n- The **trailing section** generally includes a **profile avatar**, **additional icons** or **action controls**.",
|
12
|
-
"name": "Appheader",
|
13
|
-
"cssParts": [
|
14
|
-
{
|
15
|
-
"description": "The main container for styling the header.",
|
16
|
-
"name": "container"
|
17
|
-
},
|
18
|
-
{
|
19
|
-
"description": "The leading section of the header.",
|
20
|
-
"name": "leading-section"
|
21
|
-
},
|
22
|
-
{
|
23
|
-
"description": "The center section of the header.",
|
24
|
-
"name": "center-section"
|
25
|
-
},
|
26
|
-
{
|
27
|
-
"description": "The trailing section of the header.",
|
28
|
-
"name": "trailing-section"
|
29
|
-
}
|
30
|
-
],
|
31
|
-
"slots": [
|
32
|
-
{
|
33
|
-
"description": "Slot for the leading section (e.g., brand logo, brand name).",
|
34
|
-
"name": "leading"
|
35
|
-
},
|
36
|
-
{
|
37
|
-
"description": "Slot for the center section (e.g., search bar, icons).",
|
38
|
-
"name": "center"
|
39
|
-
},
|
40
|
-
{
|
41
|
-
"description": "Slot for the trailing section (e.g., profile avatar, icons).",
|
42
|
-
"name": "trailing"
|
43
|
-
}
|
44
|
-
],
|
45
|
-
"members": [],
|
46
|
-
"superclass": {
|
47
|
-
"name": "Component",
|
48
|
-
"module": "/src/models"
|
49
|
-
},
|
50
|
-
"tagName": "mdc-appheader",
|
51
|
-
"jsDoc": "/**\n * The `mdc-appheader` component provides a structured and accessible app header layout.\n * It consists of three primary sections: leading, center, and trailing.\n *\n * - The **leading section** typically holds a **brand logo**, **brand name** or **menu icon**.\n * - The **center section** can contain a **search bar**, **icons** or action controls.\n * - The **trailing section** generally includes a **profile avatar**, **additional icons** or **action controls**.\n *\n * @tagname mdc-appheader\n *\n * @slot leading - Slot for the leading section (e.g., brand logo, brand name).\n * @slot center - Slot for the center section (e.g., search bar, icons).\n * @slot trailing - Slot for the trailing section (e.g., profile avatar, icons).\n *\n * @csspart container - The main container for styling the header.\n * @csspart leading-section - The leading section of the header.\n * @csspart center-section - The center section of the header.\n * @csspart trailing-section - The trailing section of the header.\n */",
|
52
|
-
"customElement": true
|
53
|
-
}
|
54
|
-
],
|
55
|
-
"exports": [
|
56
|
-
{
|
57
|
-
"kind": "js",
|
58
|
-
"name": "default",
|
59
|
-
"declaration": {
|
60
|
-
"name": "Appheader",
|
61
|
-
"module": "components/appheader/appheader.component.js"
|
62
|
-
}
|
63
|
-
}
|
64
|
-
]
|
65
|
-
},
|
66
|
-
{
|
67
|
-
"kind": "javascript-module",
|
68
|
-
"path": "components/avatar/avatar.component.js",
|
7
|
+
"path": "components/alertchip/alertchip.component.js",
|
69
8
|
"declarations": [
|
70
9
|
{
|
71
10
|
"kind": "class",
|
72
|
-
"description": "
|
73
|
-
"name": "
|
11
|
+
"description": "mdc-alertchip component is an interactive chip that consumers can use to represent an alert.\n\n- It supports a leading icon along with label.\n- It supports 5 variants of alerts - neutral, warning, error, success, and informational\n\nThis component is built by extending Buttonsimple.",
|
12
|
+
"name": "AlertChip",
|
74
13
|
"cssProperties": [
|
75
14
|
{
|
76
|
-
"description": "
|
77
|
-
"name": "--mdc-
|
78
|
-
},
|
79
|
-
{
|
80
|
-
"description": "Allows customization of the default foreground color.",
|
81
|
-
"name": "--mdc-avatar-default-foreground-color"
|
15
|
+
"description": "The color of the label text",
|
16
|
+
"name": "--mdc-chip-color"
|
82
17
|
},
|
83
18
|
{
|
84
|
-
"description": "
|
85
|
-
"name": "--mdc-
|
19
|
+
"description": "The color of the icon",
|
20
|
+
"name": "--mdc-chip-icon-color"
|
86
21
|
},
|
87
22
|
{
|
88
|
-
"description": "
|
89
|
-
"name": "--mdc-
|
23
|
+
"description": "The border color of the alertchip",
|
24
|
+
"name": "--mdc-chip-border-color"
|
90
25
|
},
|
91
26
|
{
|
92
|
-
"description": "
|
93
|
-
"name": "--mdc-
|
27
|
+
"description": "The background color of the alertchip",
|
28
|
+
"name": "--mdc-chip-background-color"
|
94
29
|
}
|
95
30
|
],
|
96
31
|
"members": [
|
97
32
|
{
|
98
33
|
"kind": "field",
|
99
|
-
"name": "
|
34
|
+
"name": "variant",
|
100
35
|
"type": {
|
101
|
-
"text": "
|
36
|
+
"text": "VariantType"
|
102
37
|
},
|
103
|
-
"description": "The
|
104
|
-
"
|
105
|
-
"
|
106
|
-
"name": "AvatarComponentMixin",
|
107
|
-
"module": "utils/mixins/AvatarComponentMixin.js"
|
108
|
-
}
|
38
|
+
"description": "The variant of the alertchip. It supports 5 variants\n- neutral\n- warning\n- error\n- success\n- informational",
|
39
|
+
"default": "neutral",
|
40
|
+
"attribute": "variant"
|
109
41
|
},
|
110
42
|
{
|
111
43
|
"kind": "field",
|
112
|
-
"name": "
|
44
|
+
"name": "label",
|
113
45
|
"type": {
|
114
|
-
"text": "string
|
46
|
+
"text": "string"
|
115
47
|
},
|
116
|
-
"
|
117
|
-
"
|
118
|
-
"
|
119
|
-
"name": "AvatarComponentMixin",
|
120
|
-
"module": "utils/mixins/AvatarComponentMixin.js"
|
121
|
-
}
|
48
|
+
"default": "''",
|
49
|
+
"description": "The visible label text of the alertchip.\n\nWe recommend limiting the <b>maximum length of the label text to 20 characters</b>,\nincluding empty spaces to split words.",
|
50
|
+
"attribute": "label"
|
122
51
|
},
|
123
52
|
{
|
124
53
|
"kind": "field",
|
125
|
-
"name": "
|
54
|
+
"name": "tabIndex",
|
126
55
|
"type": {
|
127
|
-
"text": "
|
56
|
+
"text": "number"
|
128
57
|
},
|
129
|
-
"
|
130
|
-
"
|
58
|
+
"default": "0",
|
59
|
+
"description": "This property specifies the tab order of the element.",
|
60
|
+
"attribute": "tabIndex",
|
61
|
+
"reflects": true,
|
131
62
|
"inheritedFrom": {
|
132
|
-
"name": "
|
133
|
-
"module": "utils/mixins/
|
63
|
+
"name": "TabIndexMixin",
|
64
|
+
"module": "utils/mixins/TabIndexMixin.js"
|
134
65
|
}
|
135
66
|
},
|
136
67
|
{
|
137
68
|
"kind": "field",
|
138
|
-
"name": "
|
69
|
+
"name": "disabled",
|
139
70
|
"type": {
|
140
|
-
"text": "
|
71
|
+
"text": "boolean | undefined"
|
141
72
|
},
|
142
|
-
"description": "
|
143
|
-
"default": "
|
144
|
-
"attribute": "
|
73
|
+
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
74
|
+
"default": "undefined",
|
75
|
+
"attribute": "disabled",
|
145
76
|
"reflects": true,
|
146
77
|
"inheritedFrom": {
|
147
|
-
"name": "
|
148
|
-
"module": "utils/mixins/
|
78
|
+
"name": "DisabledMixin",
|
79
|
+
"module": "utils/mixins/DisabledMixin.js"
|
149
80
|
}
|
150
81
|
},
|
151
82
|
{
|
152
83
|
"kind": "field",
|
153
|
-
"name": "
|
84
|
+
"name": "active",
|
154
85
|
"type": {
|
155
|
-
"text": "
|
86
|
+
"text": "boolean"
|
156
87
|
},
|
157
|
-
"
|
158
|
-
"
|
88
|
+
"default": "false",
|
89
|
+
"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.",
|
90
|
+
"attribute": "active",
|
91
|
+
"reflects": true,
|
159
92
|
"inheritedFrom": {
|
160
|
-
"name": "
|
161
|
-
"module": "
|
93
|
+
"name": "Buttonsimple",
|
94
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
162
95
|
}
|
163
96
|
},
|
164
97
|
{
|
165
98
|
"kind": "field",
|
166
|
-
"name": "
|
99
|
+
"name": "softDisabled",
|
167
100
|
"type": {
|
168
101
|
"text": "boolean"
|
169
102
|
},
|
170
103
|
"default": "false",
|
171
|
-
"description": "
|
172
|
-
"attribute": "
|
104
|
+
"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.",
|
105
|
+
"attribute": "soft-disabled",
|
173
106
|
"inheritedFrom": {
|
174
|
-
"name": "
|
175
|
-
"module": "
|
107
|
+
"name": "Buttonsimple",
|
108
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
176
109
|
}
|
177
110
|
},
|
178
111
|
{
|
179
112
|
"kind": "field",
|
180
|
-
"name": "
|
181
|
-
"type": {
|
182
|
-
"text": "IconNames | undefined"
|
183
|
-
},
|
184
|
-
"description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
|
185
|
-
"attribute": "icon-name",
|
186
|
-
"inheritedFrom": {
|
187
|
-
"name": "IconNameMixin",
|
188
|
-
"module": "utils/mixins/IconNameMixin.js"
|
189
|
-
}
|
190
|
-
}
|
191
|
-
],
|
192
|
-
"mixins": [
|
193
|
-
{
|
194
|
-
"name": "AvatarComponentMixin",
|
195
|
-
"module": "/src/utils/mixins/AvatarComponentMixin"
|
196
|
-
},
|
197
|
-
{
|
198
|
-
"name": "IconNameMixin",
|
199
|
-
"module": "/src/utils/mixins/IconNameMixin"
|
200
|
-
}
|
201
|
-
],
|
202
|
-
"superclass": {
|
203
|
-
"name": "Component",
|
204
|
-
"module": "/src/models"
|
205
|
-
},
|
206
|
-
"tagName": "mdc-avatar",
|
207
|
-
"jsDoc": "/**\n * The `mdc-avatar` component is used to represent a person or a space.\n * An avatar can be an icon, initials, counter and photo.\n *\n * To set the photo of an avatar,\n * you need to set \"src\" attribute.\n *\n * While the avatar image is loading, as a placeholder,\n * we will show the initials text.\n * If the initials are not specified then,\n * we will show `user-regular` icon as a placeholder.\n *\n * By default, if there are no attributes specified,\n * then the default avatar will be an icon with `user-regular` name.\n *\n * The avatar component is non clickable and non interactive/focusable component.\n * If the avatar is typing, then the loading indicator will be displayed.\n * If the counter type avatar is set to a negative number, then we will display 0.\n * The presence indicator will be hidden when the counter property is set.\n *\n * @dependency mdc-icon\n * @dependency mdc-presence\n * @dependency mdc-text\n *\n * @tagname mdc-avatar\n *\n * @cssproperty --mdc-avatar-default-background-color - Allows customization of the default background color.\n * @cssproperty --mdc-avatar-default-foreground-color - Allows customization of the default foreground color.\n * @cssproperty --mdc-avatar-loading-indicator-background-color -\n * Allows customization of the loading indicator background color.\n * @cssproperty --mdc-avatar-loading-indicator-foreground-color -\n * Allows customization of the loading indicator foreground color.\n * @cssproperty --mdc-avatar-loading-overlay-background-color -\n * Allows customization of the loading overlay background color.\n */",
|
208
|
-
"customElement": true,
|
209
|
-
"attributes": [
|
210
|
-
{
|
211
|
-
"name": "src",
|
113
|
+
"name": "size",
|
212
114
|
"type": {
|
213
|
-
"text": "
|
115
|
+
"text": "ButtonSize"
|
214
116
|
},
|
215
|
-
"description": "
|
216
|
-
"
|
117
|
+
"description": "Simplebutton size is a super set of all the sizes supported by children components.",
|
118
|
+
"default": "32",
|
119
|
+
"attribute": "size",
|
120
|
+
"reflects": true,
|
217
121
|
"inheritedFrom": {
|
218
|
-
"name": "
|
219
|
-
"module": "
|
122
|
+
"name": "Buttonsimple",
|
123
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
220
124
|
}
|
221
125
|
},
|
222
126
|
{
|
223
|
-
"
|
224
|
-
"
|
225
|
-
|
226
|
-
|
227
|
-
"
|
228
|
-
"
|
127
|
+
"kind": "field",
|
128
|
+
"name": "role",
|
129
|
+
"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.",
|
130
|
+
"default": "button",
|
131
|
+
"attribute": "role",
|
132
|
+
"reflects": true,
|
229
133
|
"inheritedFrom": {
|
230
|
-
"name": "
|
231
|
-
"module": "
|
134
|
+
"name": "Buttonsimple",
|
135
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
232
136
|
}
|
233
137
|
},
|
234
138
|
{
|
235
|
-
"
|
139
|
+
"kind": "field",
|
140
|
+
"name": "type",
|
236
141
|
"type": {
|
237
|
-
"text": "
|
142
|
+
"text": "ButtonType"
|
238
143
|
},
|
239
|
-
"description": "
|
240
|
-
"
|
144
|
+
"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.",
|
145
|
+
"default": "button",
|
146
|
+
"attribute": "type",
|
147
|
+
"reflects": true,
|
241
148
|
"inheritedFrom": {
|
242
|
-
"name": "
|
243
|
-
"module": "
|
149
|
+
"name": "Buttonsimple",
|
150
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
244
151
|
}
|
245
152
|
},
|
246
153
|
{
|
247
|
-
"
|
248
|
-
"
|
249
|
-
|
250
|
-
},
|
251
|
-
"description": "Acceptable values include (size in px unit):\n- 24\n- 32\n- 48\n- 64\n- 72\n- 88\n- 124",
|
252
|
-
"default": "32",
|
253
|
-
"fieldName": "size",
|
154
|
+
"kind": "method",
|
155
|
+
"name": "executeAction",
|
156
|
+
"privacy": "protected",
|
254
157
|
"inheritedFrom": {
|
255
|
-
"name": "
|
256
|
-
"module": "
|
257
|
-
}
|
258
|
-
},
|
259
|
-
{
|
260
|
-
"name": "counter",
|
261
|
-
"type": {
|
262
|
-
"text": "number | undefined"
|
263
|
-
},
|
264
|
-
"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`.",
|
265
|
-
"fieldName": "counter",
|
266
|
-
"inheritedFrom": {
|
267
|
-
"name": "AvatarComponentMixin",
|
268
|
-
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
269
|
-
}
|
270
|
-
},
|
271
|
-
{
|
272
|
-
"name": "is-typing",
|
273
|
-
"type": {
|
274
|
-
"text": "boolean"
|
275
|
-
},
|
276
|
-
"default": "false",
|
277
|
-
"description": "Represents the typing indicator when the user is typing.",
|
278
|
-
"fieldName": "isTyping",
|
279
|
-
"inheritedFrom": {
|
280
|
-
"name": "AvatarComponentMixin",
|
281
|
-
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
282
|
-
}
|
283
|
-
},
|
284
|
-
{
|
285
|
-
"name": "icon-name",
|
286
|
-
"type": {
|
287
|
-
"text": "IconNames | undefined"
|
288
|
-
},
|
289
|
-
"description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
|
290
|
-
"fieldName": "iconName",
|
291
|
-
"inheritedFrom": {
|
292
|
-
"name": "IconNameMixin",
|
293
|
-
"module": "src/utils/mixins/IconNameMixin.ts"
|
294
|
-
}
|
295
|
-
}
|
296
|
-
]
|
297
|
-
}
|
298
|
-
],
|
299
|
-
"exports": [
|
300
|
-
{
|
301
|
-
"kind": "js",
|
302
|
-
"name": "default",
|
303
|
-
"declaration": {
|
304
|
-
"name": "Avatar",
|
305
|
-
"module": "components/avatar/avatar.component.js"
|
306
|
-
}
|
307
|
-
}
|
308
|
-
]
|
309
|
-
},
|
310
|
-
{
|
311
|
-
"kind": "javascript-module",
|
312
|
-
"path": "components/alertchip/alertchip.component.js",
|
313
|
-
"declarations": [
|
314
|
-
{
|
315
|
-
"kind": "class",
|
316
|
-
"description": "mdc-alertchip component is an interactive chip that consumers can use to represent an alert.\n\n- It supports a leading icon along with label.\n- It supports 5 variants of alerts - neutral, warning, error, success, and informational\n\nThis component is built by extending Buttonsimple.",
|
317
|
-
"name": "AlertChip",
|
318
|
-
"cssProperties": [
|
319
|
-
{
|
320
|
-
"description": "The color of the label text",
|
321
|
-
"name": "--mdc-chip-color"
|
322
|
-
},
|
323
|
-
{
|
324
|
-
"description": "The color of the icon",
|
325
|
-
"name": "--mdc-chip-icon-color"
|
326
|
-
},
|
327
|
-
{
|
328
|
-
"description": "The border color of the alertchip",
|
329
|
-
"name": "--mdc-chip-border-color"
|
330
|
-
},
|
331
|
-
{
|
332
|
-
"description": "The background color of the alertchip",
|
333
|
-
"name": "--mdc-chip-background-color"
|
334
|
-
}
|
335
|
-
],
|
336
|
-
"members": [
|
337
|
-
{
|
338
|
-
"kind": "field",
|
339
|
-
"name": "variant",
|
340
|
-
"type": {
|
341
|
-
"text": "VariantType"
|
342
|
-
},
|
343
|
-
"description": "The variant of the alertchip. It supports 5 variants\n- neutral\n- warning\n- error\n- success\n- informational",
|
344
|
-
"default": "neutral",
|
345
|
-
"attribute": "variant"
|
346
|
-
},
|
347
|
-
{
|
348
|
-
"kind": "field",
|
349
|
-
"name": "label",
|
350
|
-
"type": {
|
351
|
-
"text": "string"
|
352
|
-
},
|
353
|
-
"default": "''",
|
354
|
-
"description": "The visible label text of the alertchip.\n\nWe recommend limiting the <b>maximum length of the label text to 20 characters</b>,\nincluding empty spaces to split words.",
|
355
|
-
"attribute": "label"
|
356
|
-
},
|
357
|
-
{
|
358
|
-
"kind": "field",
|
359
|
-
"name": "tabIndex",
|
360
|
-
"type": {
|
361
|
-
"text": "number"
|
362
|
-
},
|
363
|
-
"default": "0",
|
364
|
-
"description": "This property specifies the tab order of the element.",
|
365
|
-
"attribute": "tabIndex",
|
366
|
-
"reflects": true,
|
367
|
-
"inheritedFrom": {
|
368
|
-
"name": "TabIndexMixin",
|
369
|
-
"module": "utils/mixins/TabIndexMixin.js"
|
370
|
-
}
|
371
|
-
},
|
372
|
-
{
|
373
|
-
"kind": "field",
|
374
|
-
"name": "disabled",
|
375
|
-
"type": {
|
376
|
-
"text": "boolean | undefined"
|
377
|
-
},
|
378
|
-
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
379
|
-
"default": "undefined",
|
380
|
-
"attribute": "disabled",
|
381
|
-
"reflects": true,
|
382
|
-
"inheritedFrom": {
|
383
|
-
"name": "DisabledMixin",
|
384
|
-
"module": "utils/mixins/DisabledMixin.js"
|
385
|
-
}
|
386
|
-
},
|
387
|
-
{
|
388
|
-
"kind": "field",
|
389
|
-
"name": "active",
|
390
|
-
"type": {
|
391
|
-
"text": "boolean"
|
392
|
-
},
|
393
|
-
"default": "false",
|
394
|
-
"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.",
|
395
|
-
"attribute": "active",
|
396
|
-
"reflects": true,
|
397
|
-
"inheritedFrom": {
|
398
|
-
"name": "Buttonsimple",
|
399
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
400
|
-
}
|
401
|
-
},
|
402
|
-
{
|
403
|
-
"kind": "field",
|
404
|
-
"name": "softDisabled",
|
405
|
-
"type": {
|
406
|
-
"text": "boolean"
|
407
|
-
},
|
408
|
-
"default": "false",
|
409
|
-
"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.",
|
410
|
-
"attribute": "soft-disabled",
|
411
|
-
"inheritedFrom": {
|
412
|
-
"name": "Buttonsimple",
|
413
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
414
|
-
}
|
415
|
-
},
|
416
|
-
{
|
417
|
-
"kind": "field",
|
418
|
-
"name": "size",
|
419
|
-
"type": {
|
420
|
-
"text": "ButtonSize"
|
421
|
-
},
|
422
|
-
"description": "Simplebutton size is a super set of all the sizes supported by children components.",
|
423
|
-
"default": "32",
|
424
|
-
"attribute": "size",
|
425
|
-
"reflects": true,
|
426
|
-
"inheritedFrom": {
|
427
|
-
"name": "Buttonsimple",
|
428
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
429
|
-
}
|
430
|
-
},
|
431
|
-
{
|
432
|
-
"kind": "field",
|
433
|
-
"name": "role",
|
434
|
-
"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.",
|
435
|
-
"default": "button",
|
436
|
-
"attribute": "role",
|
437
|
-
"reflects": true,
|
438
|
-
"inheritedFrom": {
|
439
|
-
"name": "Buttonsimple",
|
440
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
441
|
-
}
|
442
|
-
},
|
443
|
-
{
|
444
|
-
"kind": "field",
|
445
|
-
"name": "type",
|
446
|
-
"type": {
|
447
|
-
"text": "ButtonType"
|
448
|
-
},
|
449
|
-
"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.",
|
450
|
-
"default": "button",
|
451
|
-
"attribute": "type",
|
452
|
-
"reflects": true,
|
453
|
-
"inheritedFrom": {
|
454
|
-
"name": "Buttonsimple",
|
455
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
456
|
-
}
|
457
|
-
},
|
458
|
-
{
|
459
|
-
"kind": "method",
|
460
|
-
"name": "executeAction",
|
461
|
-
"privacy": "protected",
|
462
|
-
"inheritedFrom": {
|
463
|
-
"name": "Buttonsimple",
|
464
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
158
|
+
"name": "Buttonsimple",
|
159
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
465
160
|
}
|
466
161
|
},
|
467
162
|
{
|
@@ -651,105 +346,410 @@
|
|
651
346
|
"text": "boolean"
|
652
347
|
},
|
653
348
|
"default": "false",
|
654
|
-
"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.",
|
655
|
-
"fieldName": "active",
|
349
|
+
"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.",
|
350
|
+
"fieldName": "active",
|
351
|
+
"inheritedFrom": {
|
352
|
+
"name": "Buttonsimple",
|
353
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
354
|
+
}
|
355
|
+
},
|
356
|
+
{
|
357
|
+
"name": "soft-disabled",
|
358
|
+
"type": {
|
359
|
+
"text": "boolean"
|
360
|
+
},
|
361
|
+
"default": "false",
|
362
|
+
"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.",
|
363
|
+
"fieldName": "softDisabled",
|
364
|
+
"inheritedFrom": {
|
365
|
+
"name": "Buttonsimple",
|
366
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
367
|
+
}
|
368
|
+
},
|
369
|
+
{
|
370
|
+
"name": "size",
|
371
|
+
"type": {
|
372
|
+
"text": "ButtonSize"
|
373
|
+
},
|
374
|
+
"description": "Simplebutton size is a super set of all the sizes supported by children components.",
|
375
|
+
"default": "32",
|
376
|
+
"fieldName": "size",
|
377
|
+
"inheritedFrom": {
|
378
|
+
"name": "Buttonsimple",
|
379
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
380
|
+
}
|
381
|
+
},
|
382
|
+
{
|
383
|
+
"name": "role",
|
384
|
+
"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.",
|
385
|
+
"default": "button",
|
386
|
+
"fieldName": "role",
|
387
|
+
"inheritedFrom": {
|
388
|
+
"name": "Buttonsimple",
|
389
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
390
|
+
}
|
391
|
+
},
|
392
|
+
{
|
393
|
+
"name": "type",
|
394
|
+
"type": {
|
395
|
+
"text": "ButtonType"
|
396
|
+
},
|
397
|
+
"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.",
|
398
|
+
"default": "button",
|
399
|
+
"fieldName": "type",
|
400
|
+
"inheritedFrom": {
|
401
|
+
"name": "Buttonsimple",
|
402
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
403
|
+
}
|
404
|
+
}
|
405
|
+
],
|
406
|
+
"superclass": {
|
407
|
+
"name": "Buttonsimple",
|
408
|
+
"module": "/src/components/buttonsimple/buttonsimple.component"
|
409
|
+
},
|
410
|
+
"tagName": "mdc-alertchip",
|
411
|
+
"jsDoc": "/**\n * mdc-alertchip component is an interactive chip that consumers can use to represent an alert.\n *\n * - It supports a leading icon along with label.\n * - It supports 5 variants of alerts - neutral, warning, error, success, and informational\n *\n * This component is built by extending Buttonsimple.\n *\n * @tagname mdc-alertchip\n *\n * @dependency mdc-icon\n * @dependency mdc-text\n *\n * @cssproperty --mdc-chip-color - The color of the label text\n * @cssproperty --mdc-chip-icon-color - The color of the icon\n * @cssproperty --mdc-chip-border-color - The border color of the alertchip\n * @cssproperty --mdc-chip-background-color - The background color of the alertchip\n *\n */",
|
412
|
+
"customElement": true,
|
413
|
+
"events": [
|
414
|
+
{
|
415
|
+
"description": "(React: onClick) This event is dispatched when the button is clicked.",
|
416
|
+
"name": "click",
|
417
|
+
"reactName": "onClick",
|
418
|
+
"inheritedFrom": {
|
419
|
+
"name": "Buttonsimple",
|
420
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
421
|
+
}
|
422
|
+
},
|
423
|
+
{
|
424
|
+
"description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the button.",
|
425
|
+
"name": "keydown",
|
426
|
+
"reactName": "onKeyDown",
|
427
|
+
"inheritedFrom": {
|
428
|
+
"name": "Buttonsimple",
|
429
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
430
|
+
}
|
431
|
+
},
|
432
|
+
{
|
433
|
+
"description": "(React: onKeyUp) This event is dispatched when a key is released on the button.",
|
434
|
+
"name": "keyup",
|
435
|
+
"reactName": "onKeyUp",
|
436
|
+
"inheritedFrom": {
|
437
|
+
"name": "Buttonsimple",
|
438
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
439
|
+
}
|
440
|
+
},
|
441
|
+
{
|
442
|
+
"description": "(React: onFocus) This event is dispatched when the button receives focus.",
|
443
|
+
"name": "focus",
|
444
|
+
"reactName": "onFocus",
|
445
|
+
"inheritedFrom": {
|
446
|
+
"name": "Buttonsimple",
|
447
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
448
|
+
}
|
449
|
+
}
|
450
|
+
]
|
451
|
+
}
|
452
|
+
],
|
453
|
+
"exports": [
|
454
|
+
{
|
455
|
+
"kind": "js",
|
456
|
+
"name": "default",
|
457
|
+
"declaration": {
|
458
|
+
"name": "AlertChip",
|
459
|
+
"module": "components/alertchip/alertchip.component.js"
|
460
|
+
}
|
461
|
+
}
|
462
|
+
]
|
463
|
+
},
|
464
|
+
{
|
465
|
+
"kind": "javascript-module",
|
466
|
+
"path": "components/appheader/appheader.component.js",
|
467
|
+
"declarations": [
|
468
|
+
{
|
469
|
+
"kind": "class",
|
470
|
+
"description": "The `mdc-appheader` component provides a structured and accessible app header layout.\nIt consists of three primary sections: leading, center, and trailing.\n\n- The **leading section** typically holds a **brand logo**, **brand name** or **menu icon**.\n- The **center section** can contain a **search bar**, **icons** or action controls.\n- The **trailing section** generally includes a **profile avatar**, **additional icons** or **action controls**.",
|
471
|
+
"name": "Appheader",
|
472
|
+
"cssParts": [
|
473
|
+
{
|
474
|
+
"description": "The main container for styling the header.",
|
475
|
+
"name": "container"
|
476
|
+
},
|
477
|
+
{
|
478
|
+
"description": "The leading section of the header.",
|
479
|
+
"name": "leading-section"
|
480
|
+
},
|
481
|
+
{
|
482
|
+
"description": "The center section of the header.",
|
483
|
+
"name": "center-section"
|
484
|
+
},
|
485
|
+
{
|
486
|
+
"description": "The trailing section of the header.",
|
487
|
+
"name": "trailing-section"
|
488
|
+
}
|
489
|
+
],
|
490
|
+
"slots": [
|
491
|
+
{
|
492
|
+
"description": "Slot for the leading section (e.g., brand logo, brand name).",
|
493
|
+
"name": "leading"
|
494
|
+
},
|
495
|
+
{
|
496
|
+
"description": "Slot for the center section (e.g., search bar, icons).",
|
497
|
+
"name": "center"
|
498
|
+
},
|
499
|
+
{
|
500
|
+
"description": "Slot for the trailing section (e.g., profile avatar, icons).",
|
501
|
+
"name": "trailing"
|
502
|
+
}
|
503
|
+
],
|
504
|
+
"members": [],
|
505
|
+
"superclass": {
|
506
|
+
"name": "Component",
|
507
|
+
"module": "/src/models"
|
508
|
+
},
|
509
|
+
"tagName": "mdc-appheader",
|
510
|
+
"jsDoc": "/**\n * The `mdc-appheader` component provides a structured and accessible app header layout.\n * It consists of three primary sections: leading, center, and trailing.\n *\n * - The **leading section** typically holds a **brand logo**, **brand name** or **menu icon**.\n * - The **center section** can contain a **search bar**, **icons** or action controls.\n * - The **trailing section** generally includes a **profile avatar**, **additional icons** or **action controls**.\n *\n * @tagname mdc-appheader\n *\n * @slot leading - Slot for the leading section (e.g., brand logo, brand name).\n * @slot center - Slot for the center section (e.g., search bar, icons).\n * @slot trailing - Slot for the trailing section (e.g., profile avatar, icons).\n *\n * @csspart container - The main container for styling the header.\n * @csspart leading-section - The leading section of the header.\n * @csspart center-section - The center section of the header.\n * @csspart trailing-section - The trailing section of the header.\n */",
|
511
|
+
"customElement": true
|
512
|
+
}
|
513
|
+
],
|
514
|
+
"exports": [
|
515
|
+
{
|
516
|
+
"kind": "js",
|
517
|
+
"name": "default",
|
518
|
+
"declaration": {
|
519
|
+
"name": "Appheader",
|
520
|
+
"module": "components/appheader/appheader.component.js"
|
521
|
+
}
|
522
|
+
}
|
523
|
+
]
|
524
|
+
},
|
525
|
+
{
|
526
|
+
"kind": "javascript-module",
|
527
|
+
"path": "components/avatar/avatar.component.js",
|
528
|
+
"declarations": [
|
529
|
+
{
|
530
|
+
"kind": "class",
|
531
|
+
"description": "The `mdc-avatar` component is used to represent a person or a space.\nAn avatar can be an icon, initials, counter and photo.\n\nTo set the photo of an avatar,\nyou need to set \"src\" attribute.\n\nWhile the avatar image is loading, as a placeholder,\nwe will show the initials text.\nIf the initials are not specified then,\nwe will show `user-regular` icon as a placeholder.\n\nBy default, if there are no attributes specified,\nthen the default avatar will be an icon with `user-regular` name.\n\nThe avatar component is non clickable and non interactive/focusable component.\nIf the avatar is typing, then the loading indicator will be displayed.\nIf the counter type avatar is set to a negative number, then we will display 0.\nThe presence indicator will be hidden when the counter property is set.",
|
532
|
+
"name": "Avatar",
|
533
|
+
"cssProperties": [
|
534
|
+
{
|
535
|
+
"description": "Allows customization of the default background color.",
|
536
|
+
"name": "--mdc-avatar-default-background-color"
|
537
|
+
},
|
538
|
+
{
|
539
|
+
"description": "Allows customization of the default foreground color.",
|
540
|
+
"name": "--mdc-avatar-default-foreground-color"
|
541
|
+
},
|
542
|
+
{
|
543
|
+
"description": "Allows customization of the loading indicator background color.",
|
544
|
+
"name": "--mdc-avatar-loading-indicator-background-color"
|
545
|
+
},
|
546
|
+
{
|
547
|
+
"description": "Allows customization of the loading indicator foreground color.",
|
548
|
+
"name": "--mdc-avatar-loading-indicator-foreground-color"
|
549
|
+
},
|
550
|
+
{
|
551
|
+
"description": "Allows customization of the loading overlay background color.",
|
552
|
+
"name": "--mdc-avatar-loading-overlay-background-color"
|
553
|
+
}
|
554
|
+
],
|
555
|
+
"members": [
|
556
|
+
{
|
557
|
+
"kind": "field",
|
558
|
+
"name": "src",
|
559
|
+
"type": {
|
560
|
+
"text": "string | undefined"
|
561
|
+
},
|
562
|
+
"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.",
|
563
|
+
"attribute": "src",
|
564
|
+
"inheritedFrom": {
|
565
|
+
"name": "AvatarComponentMixin",
|
566
|
+
"module": "utils/mixins/AvatarComponentMixin.js"
|
567
|
+
}
|
568
|
+
},
|
569
|
+
{
|
570
|
+
"kind": "field",
|
571
|
+
"name": "initials",
|
572
|
+
"type": {
|
573
|
+
"text": "string | undefined"
|
574
|
+
},
|
575
|
+
"description": "The initials to be displayed for the avatar.",
|
576
|
+
"attribute": "initials",
|
577
|
+
"inheritedFrom": {
|
578
|
+
"name": "AvatarComponentMixin",
|
579
|
+
"module": "utils/mixins/AvatarComponentMixin.js"
|
580
|
+
}
|
581
|
+
},
|
582
|
+
{
|
583
|
+
"kind": "field",
|
584
|
+
"name": "presence",
|
585
|
+
"type": {
|
586
|
+
"text": "PresenceType | undefined"
|
587
|
+
},
|
588
|
+
"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`",
|
589
|
+
"attribute": "presence",
|
590
|
+
"inheritedFrom": {
|
591
|
+
"name": "AvatarComponentMixin",
|
592
|
+
"module": "utils/mixins/AvatarComponentMixin.js"
|
593
|
+
}
|
594
|
+
},
|
595
|
+
{
|
596
|
+
"kind": "field",
|
597
|
+
"name": "size",
|
598
|
+
"type": {
|
599
|
+
"text": "AvatarSize"
|
600
|
+
},
|
601
|
+
"description": "Acceptable values include (size in px unit):\n- 24\n- 32\n- 48\n- 64\n- 72\n- 88\n- 124",
|
602
|
+
"default": "32",
|
603
|
+
"attribute": "size",
|
604
|
+
"reflects": true,
|
605
|
+
"inheritedFrom": {
|
606
|
+
"name": "AvatarComponentMixin",
|
607
|
+
"module": "utils/mixins/AvatarComponentMixin.js"
|
608
|
+
}
|
609
|
+
},
|
610
|
+
{
|
611
|
+
"kind": "field",
|
612
|
+
"name": "counter",
|
613
|
+
"type": {
|
614
|
+
"text": "number | undefined"
|
615
|
+
},
|
616
|
+
"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`.",
|
617
|
+
"attribute": "counter",
|
618
|
+
"inheritedFrom": {
|
619
|
+
"name": "AvatarComponentMixin",
|
620
|
+
"module": "utils/mixins/AvatarComponentMixin.js"
|
621
|
+
}
|
622
|
+
},
|
623
|
+
{
|
624
|
+
"kind": "field",
|
625
|
+
"name": "isTyping",
|
626
|
+
"type": {
|
627
|
+
"text": "boolean"
|
628
|
+
},
|
629
|
+
"default": "false",
|
630
|
+
"description": "Represents the typing indicator when the user is typing.",
|
631
|
+
"attribute": "is-typing",
|
656
632
|
"inheritedFrom": {
|
657
|
-
"name": "
|
658
|
-
"module": "
|
633
|
+
"name": "AvatarComponentMixin",
|
634
|
+
"module": "utils/mixins/AvatarComponentMixin.js"
|
659
635
|
}
|
660
636
|
},
|
661
637
|
{
|
662
|
-
"
|
638
|
+
"kind": "field",
|
639
|
+
"name": "iconName",
|
663
640
|
"type": {
|
664
|
-
"text": "
|
641
|
+
"text": "IconNames | undefined"
|
665
642
|
},
|
666
|
-
"
|
667
|
-
"
|
668
|
-
"fieldName": "softDisabled",
|
643
|
+
"description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
|
644
|
+
"attribute": "icon-name",
|
669
645
|
"inheritedFrom": {
|
670
|
-
"name": "
|
671
|
-
"module": "
|
646
|
+
"name": "IconNameMixin",
|
647
|
+
"module": "utils/mixins/IconNameMixin.js"
|
672
648
|
}
|
649
|
+
}
|
650
|
+
],
|
651
|
+
"mixins": [
|
652
|
+
{
|
653
|
+
"name": "AvatarComponentMixin",
|
654
|
+
"module": "/src/utils/mixins/AvatarComponentMixin"
|
673
655
|
},
|
674
656
|
{
|
675
|
-
"name": "
|
657
|
+
"name": "IconNameMixin",
|
658
|
+
"module": "/src/utils/mixins/IconNameMixin"
|
659
|
+
}
|
660
|
+
],
|
661
|
+
"superclass": {
|
662
|
+
"name": "Component",
|
663
|
+
"module": "/src/models"
|
664
|
+
},
|
665
|
+
"tagName": "mdc-avatar",
|
666
|
+
"jsDoc": "/**\n * The `mdc-avatar` component is used to represent a person or a space.\n * An avatar can be an icon, initials, counter and photo.\n *\n * To set the photo of an avatar,\n * you need to set \"src\" attribute.\n *\n * While the avatar image is loading, as a placeholder,\n * we will show the initials text.\n * If the initials are not specified then,\n * we will show `user-regular` icon as a placeholder.\n *\n * By default, if there are no attributes specified,\n * then the default avatar will be an icon with `user-regular` name.\n *\n * The avatar component is non clickable and non interactive/focusable component.\n * If the avatar is typing, then the loading indicator will be displayed.\n * If the counter type avatar is set to a negative number, then we will display 0.\n * The presence indicator will be hidden when the counter property is set.\n *\n * @dependency mdc-icon\n * @dependency mdc-presence\n * @dependency mdc-text\n *\n * @tagname mdc-avatar\n *\n * @cssproperty --mdc-avatar-default-background-color - Allows customization of the default background color.\n * @cssproperty --mdc-avatar-default-foreground-color - Allows customization of the default foreground color.\n * @cssproperty --mdc-avatar-loading-indicator-background-color -\n * Allows customization of the loading indicator background color.\n * @cssproperty --mdc-avatar-loading-indicator-foreground-color -\n * Allows customization of the loading indicator foreground color.\n * @cssproperty --mdc-avatar-loading-overlay-background-color -\n * Allows customization of the loading overlay background color.\n */",
|
667
|
+
"customElement": true,
|
668
|
+
"attributes": [
|
669
|
+
{
|
670
|
+
"name": "src",
|
676
671
|
"type": {
|
677
|
-
"text": "
|
672
|
+
"text": "string | undefined"
|
678
673
|
},
|
679
|
-
"description": "
|
680
|
-
"
|
681
|
-
"fieldName": "size",
|
674
|
+
"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.",
|
675
|
+
"fieldName": "src",
|
682
676
|
"inheritedFrom": {
|
683
|
-
"name": "
|
684
|
-
"module": "src/
|
677
|
+
"name": "AvatarComponentMixin",
|
678
|
+
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
685
679
|
}
|
686
680
|
},
|
687
681
|
{
|
688
|
-
"name": "
|
689
|
-
"
|
690
|
-
|
691
|
-
|
682
|
+
"name": "initials",
|
683
|
+
"type": {
|
684
|
+
"text": "string | undefined"
|
685
|
+
},
|
686
|
+
"description": "The initials to be displayed for the avatar.",
|
687
|
+
"fieldName": "initials",
|
692
688
|
"inheritedFrom": {
|
693
|
-
"name": "
|
694
|
-
"module": "src/
|
689
|
+
"name": "AvatarComponentMixin",
|
690
|
+
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
695
691
|
}
|
696
692
|
},
|
697
693
|
{
|
698
|
-
"name": "
|
694
|
+
"name": "presence",
|
699
695
|
"type": {
|
700
|
-
"text": "
|
696
|
+
"text": "PresenceType | undefined"
|
701
697
|
},
|
702
|
-
"description": "
|
703
|
-
"
|
704
|
-
"fieldName": "type",
|
698
|
+
"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`",
|
699
|
+
"fieldName": "presence",
|
705
700
|
"inheritedFrom": {
|
706
|
-
"name": "
|
707
|
-
"module": "src/
|
701
|
+
"name": "AvatarComponentMixin",
|
702
|
+
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
708
703
|
}
|
709
|
-
}
|
710
|
-
],
|
711
|
-
"superclass": {
|
712
|
-
"name": "Buttonsimple",
|
713
|
-
"module": "/src/components/buttonsimple/buttonsimple.component"
|
714
|
-
},
|
715
|
-
"tagName": "mdc-alertchip",
|
716
|
-
"jsDoc": "/**\n * mdc-alertchip component is an interactive chip that consumers can use to represent an alert.\n *\n * - It supports a leading icon along with label.\n * - It supports 5 variants of alerts - neutral, warning, error, success, and informational\n *\n * This component is built by extending Buttonsimple.\n *\n * @tagname mdc-alertchip\n *\n * @dependency mdc-icon\n * @dependency mdc-text\n *\n * @cssproperty --mdc-chip-color - The color of the label text\n * @cssproperty --mdc-chip-icon-color - The color of the icon\n * @cssproperty --mdc-chip-border-color - The border color of the alertchip\n * @cssproperty --mdc-chip-background-color - The background color of the alertchip\n *\n */",
|
717
|
-
"customElement": true,
|
718
|
-
"events": [
|
704
|
+
},
|
719
705
|
{
|
720
|
-
"
|
721
|
-
"
|
722
|
-
|
706
|
+
"name": "size",
|
707
|
+
"type": {
|
708
|
+
"text": "AvatarSize"
|
709
|
+
},
|
710
|
+
"description": "Acceptable values include (size in px unit):\n- 24\n- 32\n- 48\n- 64\n- 72\n- 88\n- 124",
|
711
|
+
"default": "32",
|
712
|
+
"fieldName": "size",
|
723
713
|
"inheritedFrom": {
|
724
|
-
"name": "
|
725
|
-
"module": "src/
|
714
|
+
"name": "AvatarComponentMixin",
|
715
|
+
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
726
716
|
}
|
727
717
|
},
|
728
718
|
{
|
729
|
-
"
|
730
|
-
"
|
731
|
-
|
719
|
+
"name": "counter",
|
720
|
+
"type": {
|
721
|
+
"text": "number | undefined"
|
722
|
+
},
|
723
|
+
"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`.",
|
724
|
+
"fieldName": "counter",
|
732
725
|
"inheritedFrom": {
|
733
|
-
"name": "
|
734
|
-
"module": "src/
|
726
|
+
"name": "AvatarComponentMixin",
|
727
|
+
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
735
728
|
}
|
736
729
|
},
|
737
730
|
{
|
738
|
-
"
|
739
|
-
"
|
740
|
-
|
731
|
+
"name": "is-typing",
|
732
|
+
"type": {
|
733
|
+
"text": "boolean"
|
734
|
+
},
|
735
|
+
"default": "false",
|
736
|
+
"description": "Represents the typing indicator when the user is typing.",
|
737
|
+
"fieldName": "isTyping",
|
741
738
|
"inheritedFrom": {
|
742
|
-
"name": "
|
743
|
-
"module": "src/
|
739
|
+
"name": "AvatarComponentMixin",
|
740
|
+
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
744
741
|
}
|
745
742
|
},
|
746
743
|
{
|
747
|
-
"
|
748
|
-
"
|
749
|
-
|
744
|
+
"name": "icon-name",
|
745
|
+
"type": {
|
746
|
+
"text": "IconNames | undefined"
|
747
|
+
},
|
748
|
+
"description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
|
749
|
+
"fieldName": "iconName",
|
750
750
|
"inheritedFrom": {
|
751
|
-
"name": "
|
752
|
-
"module": "src/
|
751
|
+
"name": "IconNameMixin",
|
752
|
+
"module": "src/utils/mixins/IconNameMixin.ts"
|
753
753
|
}
|
754
754
|
}
|
755
755
|
]
|
@@ -760,8 +760,8 @@
|
|
760
760
|
"kind": "js",
|
761
761
|
"name": "default",
|
762
762
|
"declaration": {
|
763
|
-
"name": "
|
764
|
-
"module": "components/
|
763
|
+
"name": "Avatar",
|
764
|
+
"module": "components/avatar/avatar.component.js"
|
765
765
|
}
|
766
766
|
}
|
767
767
|
]
|
@@ -15596,7 +15596,7 @@
|
|
15596
15596
|
"declarations": [
|
15597
15597
|
{
|
15598
15598
|
"kind": "class",
|
15599
|
-
"description": "`mdc-tab` is Tab component to be used within the Tabgroup.\n\nPassing in the attribute `text` to the tab component is changing the text displayed in the tab.\n\nThe `slot=\"badge\"` can be used to add a badge to the tab.\n\nThe `slot=\"chip\"` can be used to add a chip to the tab.\n\nFor `icon`, the `mdc-icon` component is used to render the icon.\n\nNote: Icons can be used in conjunction with badges or chips.\nBadges and chips should not be used at the same time.",
|
15599
|
+
"description": "`mdc-tab` is Tab component to be used within the Tabgroup.\n\nPassing in the attribute `text` to the tab component is changing the text displayed in the tab.\n\nPass attribute `tabid` when using inside of `tablist` component.\n\nThe `slot=\"badge\"` can be used to add a badge to the tab.\n\nThe `slot=\"chip\"` can be used to add a chip to the tab.\n\nFor `icon`, the `mdc-icon` component is used to render the icon.\n\nNote: Icons can be used in conjunction with badges or chips.\nBadges and chips should not be used at the same time.",
|
15600
15600
|
"name": "Tab",
|
15601
15601
|
"cssProperties": [
|
15602
15602
|
{
|
@@ -15822,6 +15822,17 @@
|
|
15822
15822
|
"attribute": "variant",
|
15823
15823
|
"reflects": true
|
15824
15824
|
},
|
15825
|
+
{
|
15826
|
+
"kind": "field",
|
15827
|
+
"name": "tabId",
|
15828
|
+
"type": {
|
15829
|
+
"text": "string | undefined"
|
15830
|
+
},
|
15831
|
+
"description": "Id of the tab (used as a identificator when used in the tablist)\nNote: has to be unique!",
|
15832
|
+
"default": "undefined",
|
15833
|
+
"attribute": "tab-id",
|
15834
|
+
"reflects": true
|
15835
|
+
},
|
15825
15836
|
{
|
15826
15837
|
"kind": "method",
|
15827
15838
|
"name": "modifyIconName",
|
@@ -15862,6 +15873,18 @@
|
|
15862
15873
|
],
|
15863
15874
|
"description": "Sets the variant attribute for the tab component.\nIf the provided variant is not included in the TAB_VARIANTS,\nit defaults to the value specified in DEFAULTS.VARIANT."
|
15864
15875
|
},
|
15876
|
+
{
|
15877
|
+
"kind": "field",
|
15878
|
+
"name": "handleTabActiveChange",
|
15879
|
+
"privacy": "private",
|
15880
|
+
"description": "Dispatch the activechange event.",
|
15881
|
+
"parameters": [
|
15882
|
+
{
|
15883
|
+
"description": "The active state of the tab.",
|
15884
|
+
"name": "active"
|
15885
|
+
}
|
15886
|
+
]
|
15887
|
+
},
|
15865
15888
|
{
|
15866
15889
|
"kind": "method",
|
15867
15890
|
"name": "setActive",
|
@@ -16157,6 +16180,11 @@
|
|
16157
16180
|
"name": "Buttonsimple",
|
16158
16181
|
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
16159
16182
|
}
|
16183
|
+
},
|
16184
|
+
{
|
16185
|
+
"description": "(React: onActiveChange) This event is dispatched when the active state of the tab changes <br /> Event Data: `detail: { tabId: this.tabId, active }` <br /> Note: the activechange event is used by the tab list component to react to the change in state of the tab, so this event won't be needed if the tab list is used.",
|
16186
|
+
"name": "activechange",
|
16187
|
+
"reactName": "onActiveChange"
|
16160
16188
|
}
|
16161
16189
|
],
|
16162
16190
|
"attributes": [
|
@@ -16177,6 +16205,15 @@
|
|
16177
16205
|
"default": "pill",
|
16178
16206
|
"fieldName": "variant"
|
16179
16207
|
},
|
16208
|
+
{
|
16209
|
+
"name": "tab-id",
|
16210
|
+
"type": {
|
16211
|
+
"text": "string | undefined"
|
16212
|
+
},
|
16213
|
+
"description": "Id of the tab (used as a identificator when used in the tablist)\nNote: has to be unique!",
|
16214
|
+
"default": "undefined",
|
16215
|
+
"fieldName": "tabId"
|
16216
|
+
},
|
16180
16217
|
{
|
16181
16218
|
"name": "icon-name",
|
16182
16219
|
"type": {
|
@@ -16289,7 +16326,7 @@
|
|
16289
16326
|
"module": "/src/components/buttonsimple/buttonsimple.component"
|
16290
16327
|
},
|
16291
16328
|
"tagName": "mdc-tab",
|
16292
|
-
"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 */",
|
16329
|
+
"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 * Pass attribute `tabid` when using inside of `tablist` component.\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 * @event activechange - (React: onActiveChange) This event is dispatched when the active state of the tab changes\n * <br />\n * Event Data: `detail: { tabId: this.tabId, active }`\n * <br />\n * Note: the activechange event is used by the tab list component to react to the change in state of the tab,\n * so this event won't be needed if the tab list is used.\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 */",
|
16293
16330
|
"customElement": true
|
16294
16331
|
}
|
16295
16332
|
],
|
@@ -16304,6 +16341,117 @@
|
|
16304
16341
|
}
|
16305
16342
|
]
|
16306
16343
|
},
|
16344
|
+
{
|
16345
|
+
"kind": "javascript-module",
|
16346
|
+
"path": "components/tablist/tablist.component.js",
|
16347
|
+
"declarations": [
|
16348
|
+
{
|
16349
|
+
"kind": "class",
|
16350
|
+
"description": "Tab list organizes tabs into a container.\n\nChildren of the tab list are `mdc-tab` elements, sent to the default slot.\n\nThe tabs can be navigated using the left/right arrow keys, and selected by clicking,\n or pressing the Enter and Space keys.\n\n**Implicit accessibility rules**\n\n- The element that serves as the container for the set of tabs has role `tablist`.\n- Each element that serves as a tab has role `tab` and is contained within the element with role `tablist`.\n- The active tab element has the state `aria-selected` set to `true`\n and all other tab elements have it set to `false`.\n\n\n**Accessibility notes for consuming (have to be explicitly set when you consume the component)**\n\n- Each element that contains the `content panel` for a `tab` has role `tabpanel`.\n- If the tab list has a visible label,\n the element with role `tablist` has `aria-labelledby` needs to be a value that refers to the labelling element.\n Otherwise, the `tablist` element needs to have a label provided by `aria-label`.\n- Each element with role `tab` has the property `aria-controls`\n that should refer to its associated `tabpanel` element.\n- Each element with role `tabpanel` has the property `aria-labelledby` referring to its associated `tab` element.\n- If a `tab` element has a popup menu, it needs to have the property `aria-haspopup` set to either `menu` or `true`.",
|
16351
|
+
"name": "TabList",
|
16352
|
+
"cssProperties": [
|
16353
|
+
{
|
16354
|
+
"description": "Gap between tabs",
|
16355
|
+
"name": "--mdc-tablist-gap"
|
16356
|
+
},
|
16357
|
+
{
|
16358
|
+
"description": "Width of the tablist",
|
16359
|
+
"name": "--mdc-tablist-width"
|
16360
|
+
},
|
16361
|
+
{
|
16362
|
+
"description": "Margin value for the arrow button",
|
16363
|
+
"name": "--mdc-tablist-arrow-button-margin"
|
16364
|
+
}
|
16365
|
+
],
|
16366
|
+
"slots": [
|
16367
|
+
{
|
16368
|
+
"description": "slot for mdc-tab elements.",
|
16369
|
+
"name": "Default"
|
16370
|
+
}
|
16371
|
+
],
|
16372
|
+
"members": [
|
16373
|
+
{
|
16374
|
+
"kind": "field",
|
16375
|
+
"name": "activeTabId",
|
16376
|
+
"type": {
|
16377
|
+
"text": "string | undefined"
|
16378
|
+
},
|
16379
|
+
"description": "ID of the active tab, defaults to the first tab if not provided",
|
16380
|
+
"attribute": "active-tab-id",
|
16381
|
+
"reflects": true
|
16382
|
+
},
|
16383
|
+
{
|
16384
|
+
"kind": "field",
|
16385
|
+
"name": "dataAriaLabelledby",
|
16386
|
+
"type": {
|
16387
|
+
"text": "string | undefined"
|
16388
|
+
},
|
16389
|
+
"description": "Selector for the element that provides a label for the tablist.",
|
16390
|
+
"attribute": "data-aria-labelledby"
|
16391
|
+
},
|
16392
|
+
{
|
16393
|
+
"kind": "field",
|
16394
|
+
"name": "dataAriaLabel",
|
16395
|
+
"type": {
|
16396
|
+
"text": "string | undefined"
|
16397
|
+
},
|
16398
|
+
"description": "Label for the tablist in case aria-labelledby is not provided.\nThis is used when the tablist does not have a visible label.\nDefaults to 'Tab List'.\n<br/>\nNote: If both `data-aria-labelledby` and `data-aria-label` are provided,\nthe `data-aria-labelledby` will be used.",
|
16399
|
+
"attribute": "data-aria-label"
|
16400
|
+
}
|
16401
|
+
],
|
16402
|
+
"events": [
|
16403
|
+
{
|
16404
|
+
"description": "(React: onChange) This event is dispatched when the tab is selected. Event that fires when user changes the active tab. The function sent as the argument will receive the fired event and the new tab id can be fetched from event.detail.tabId. `(event: CustomEvent) => handleTabChange(event.detail.tabId);`",
|
16405
|
+
"name": "change",
|
16406
|
+
"reactName": "onChange"
|
16407
|
+
}
|
16408
|
+
],
|
16409
|
+
"attributes": [
|
16410
|
+
{
|
16411
|
+
"name": "active-tab-id",
|
16412
|
+
"type": {
|
16413
|
+
"text": "string | undefined"
|
16414
|
+
},
|
16415
|
+
"description": "ID of the active tab, defaults to the first tab if not provided",
|
16416
|
+
"fieldName": "activeTabId"
|
16417
|
+
},
|
16418
|
+
{
|
16419
|
+
"name": "data-aria-labelledby",
|
16420
|
+
"type": {
|
16421
|
+
"text": "string | undefined"
|
16422
|
+
},
|
16423
|
+
"description": "Selector for the element that provides a label for the tablist.",
|
16424
|
+
"fieldName": "dataAriaLabelledby"
|
16425
|
+
},
|
16426
|
+
{
|
16427
|
+
"name": "data-aria-label",
|
16428
|
+
"type": {
|
16429
|
+
"text": "string | undefined"
|
16430
|
+
},
|
16431
|
+
"description": "Label for the tablist in case aria-labelledby is not provided.\nThis is used when the tablist does not have a visible label.\nDefaults to 'Tab List'.\n<br/>\nNote: If both `data-aria-labelledby` and `data-aria-label` are provided,\nthe `data-aria-labelledby` will be used.",
|
16432
|
+
"fieldName": "dataAriaLabel"
|
16433
|
+
}
|
16434
|
+
],
|
16435
|
+
"superclass": {
|
16436
|
+
"name": "Component",
|
16437
|
+
"module": "/src/models"
|
16438
|
+
},
|
16439
|
+
"tagName": "mdc-tablist",
|
16440
|
+
"jsDoc": "/**\n * Tab list organizes tabs into a container.\n *\n * Children of the tab list are `mdc-tab` elements, sent to the default slot.\n *\n * The tabs can be navigated using the left/right arrow keys, and selected by clicking,\n * or pressing the Enter and Space keys.\n *\n * **Implicit accessibility rules**\n *\n * - The element that serves as the container for the set of tabs has role `tablist`.\n * - Each element that serves as a tab has role `tab` and is contained within the element with role `tablist`.\n * - The active tab element has the state `aria-selected` set to `true`\n * and all other tab elements have it set to `false`.\n *\n *\n * **Accessibility notes for consuming (have to be explicitly set when you consume the component)**\n *\n * - Each element that contains the `content panel` for a `tab` has role `tabpanel`.\n * - If the tab list has a visible label,\n * the element with role `tablist` has `aria-labelledby` needs to be a value that refers to the labelling element.\n * Otherwise, the `tablist` element needs to have a label provided by `aria-label`.\n * - Each element with role `tab` has the property `aria-controls`\n * that should refer to its associated `tabpanel` element.\n * - Each element with role `tabpanel` has the property `aria-labelledby` referring to its associated `tab` element.\n * - If a `tab` element has a popup menu, it needs to have the property `aria-haspopup` set to either `menu` or `true`.\n *\n * @tagname mdc-tablist\n *\n * @dependency mdc-tab\n * @dependency mdc-button\n *\n * @event change - (React: onChange) This event is dispatched when the tab is selected.\n * Event that fires when user changes the active tab.\n * The function sent as the argument will receive the fired event\n * and the new tab id can be fetched from event.detail.tabId.\n *\n * `(event: CustomEvent) => handleTabChange(event.detail.tabId);`\n *\n * @slot Default slot for mdc-tab elements.\n *\n * @cssproperty --mdc-tablist-gap - Gap between tabs\n * @cssproperty --mdc-tablist-width - Width of the tablist\n * @cssproperty --mdc-tablist-arrow-button-margin - Margin value for the arrow button\n */",
|
16441
|
+
"customElement": true
|
16442
|
+
}
|
16443
|
+
],
|
16444
|
+
"exports": [
|
16445
|
+
{
|
16446
|
+
"kind": "js",
|
16447
|
+
"name": "default",
|
16448
|
+
"declaration": {
|
16449
|
+
"name": "TabList",
|
16450
|
+
"module": "components/tablist/tablist.component.js"
|
16451
|
+
}
|
16452
|
+
}
|
16453
|
+
]
|
16454
|
+
},
|
16307
16455
|
{
|
16308
16456
|
"kind": "javascript-module",
|
16309
16457
|
"path": "components/text/text.component.js",
|