@momentum-design/components 0.90.0 → 0.91.1
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 +364 -308
- package/dist/browser/index.js.map +4 -4
- package/dist/components/badge/badge.styles.js +5 -0
- package/dist/components/listheader/index.d.ts +9 -0
- package/dist/components/listheader/index.js +6 -0
- package/dist/components/listheader/listheader.component.d.ts +45 -0
- package/dist/components/listheader/listheader.component.js +85 -0
- package/dist/components/listheader/listheader.constants.d.ts +2 -0
- package/dist/components/listheader/listheader.constants.js +3 -0
- package/dist/components/listheader/listheader.styles.d.ts +2 -0
- package/dist/components/listheader/listheader.styles.js +30 -0
- package/dist/components/menusection/index.d.ts +1 -0
- package/dist/components/menusection/index.js +1 -0
- package/dist/components/menusection/menusection.component.d.ts +11 -3
- package/dist/components/menusection/menusection.component.js +16 -8
- package/dist/components/menusection/menusection.styles.js +4 -2
- package/dist/custom-elements.json +1104 -964
- package/dist/index.d.ts +2 -1
- package/dist/index.js +2 -1
- package/dist/react/index.d.ts +5 -4
- package/dist/react/index.js +5 -4
- package/dist/react/listheader/index.d.ts +15 -0
- package/dist/react/listheader/index.js +24 -0
- package/package.json +1 -1
@@ -1071,110 +1071,53 @@
|
|
1071
1071
|
},
|
1072
1072
|
{
|
1073
1073
|
"kind": "javascript-module",
|
1074
|
-
"path": "components/
|
1074
|
+
"path": "components/avatarbutton/avatarbutton.component.js",
|
1075
1075
|
"declarations": [
|
1076
1076
|
{
|
1077
1077
|
"kind": "class",
|
1078
|
-
"description": "The `mdc-
|
1079
|
-
"name": "
|
1078
|
+
"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.\n\nTo override styles of the avatar inside, use the specified css parts.",
|
1079
|
+
"name": "AvatarButton",
|
1080
1080
|
"cssProperties": [
|
1081
1081
|
{
|
1082
|
-
"description": "
|
1083
|
-
"name": "--mdc-
|
1084
|
-
},
|
1085
|
-
{
|
1086
|
-
"description": "The background color of the primary badge.",
|
1087
|
-
"name": "--mdc-badge-primary-background-color"
|
1088
|
-
},
|
1089
|
-
{
|
1090
|
-
"description": "The foreground color of the secondary badge.",
|
1091
|
-
"name": "--mdc-badge-secondary-foreground-color"
|
1082
|
+
"description": "Background color of the overlay in rest state",
|
1083
|
+
"name": "--mdc-avatarbutton-overlay-background-color-rest"
|
1092
1084
|
},
|
1093
1085
|
{
|
1094
|
-
"description": "
|
1095
|
-
"name": "--mdc-
|
1086
|
+
"description": "Background color of the overlay in hover state",
|
1087
|
+
"name": "--mdc-avatarbutton-overlay-background-color-hover"
|
1096
1088
|
},
|
1097
1089
|
{
|
1098
|
-
"description": "
|
1099
|
-
"name": "--mdc-
|
1100
|
-
}
|
1090
|
+
"description": "Background color of the overlay in active state",
|
1091
|
+
"name": "--mdc-avatarbutton-overlay-background-color-active"
|
1092
|
+
}
|
1093
|
+
],
|
1094
|
+
"cssParts": [
|
1101
1095
|
{
|
1102
|
-
"description": "The
|
1103
|
-
"name": "
|
1096
|
+
"description": "The overlay part of the avatar button.",
|
1097
|
+
"name": "overlay"
|
1104
1098
|
},
|
1105
1099
|
{
|
1106
|
-
"description": "The
|
1107
|
-
"name": "
|
1100
|
+
"description": "The main content of the avatar.",
|
1101
|
+
"name": "content"
|
1108
1102
|
},
|
1109
1103
|
{
|
1110
|
-
"description": "The
|
1111
|
-
"name": "
|
1104
|
+
"description": "The photo part of the avatar.",
|
1105
|
+
"name": "photo"
|
1112
1106
|
},
|
1113
1107
|
{
|
1114
|
-
"description": "The
|
1115
|
-
"name": "
|
1108
|
+
"description": "The presence indicator part of the avatar.",
|
1109
|
+
"name": "presence"
|
1116
1110
|
},
|
1117
1111
|
{
|
1118
|
-
"description": "The
|
1119
|
-
"name": "
|
1112
|
+
"description": "The wrapper for the loading indicator of the avatar.",
|
1113
|
+
"name": "loading-wrapper"
|
1120
1114
|
},
|
1121
1115
|
{
|
1122
|
-
"description": "The
|
1123
|
-
"name": "
|
1116
|
+
"description": "The loading indicator part of the avatar.",
|
1117
|
+
"name": "loader"
|
1124
1118
|
}
|
1125
1119
|
],
|
1126
1120
|
"members": [
|
1127
|
-
{
|
1128
|
-
"kind": "field",
|
1129
|
-
"name": "type",
|
1130
|
-
"type": {
|
1131
|
-
"text": "BadgeType | undefined"
|
1132
|
-
},
|
1133
|
-
"description": "Type of the badge\nCan be `dot` (notification) , `icon`, `counter`, `success`, `warning` or `error`.",
|
1134
|
-
"attribute": "type",
|
1135
|
-
"reflects": true
|
1136
|
-
},
|
1137
|
-
{
|
1138
|
-
"kind": "field",
|
1139
|
-
"name": "variant",
|
1140
|
-
"type": {
|
1141
|
-
"text": "IconVariant"
|
1142
|
-
},
|
1143
|
-
"description": "Type of the variant can be `primary` or `secondary`.\nIt defines the background and foreground color of the icon.",
|
1144
|
-
"default": "primary",
|
1145
|
-
"attribute": "variant",
|
1146
|
-
"reflects": true
|
1147
|
-
},
|
1148
|
-
{
|
1149
|
-
"kind": "field",
|
1150
|
-
"name": "counter",
|
1151
|
-
"type": {
|
1152
|
-
"text": "number | undefined"
|
1153
|
-
},
|
1154
|
-
"description": "Counter is the number which can be provided in the badge.",
|
1155
|
-
"attribute": "counter"
|
1156
|
-
},
|
1157
|
-
{
|
1158
|
-
"kind": "field",
|
1159
|
-
"name": "maxCounter",
|
1160
|
-
"type": {
|
1161
|
-
"text": "number"
|
1162
|
-
},
|
1163
|
-
"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`.",
|
1164
|
-
"default": "99",
|
1165
|
-
"attribute": "max-counter",
|
1166
|
-
"reflects": true
|
1167
|
-
},
|
1168
|
-
{
|
1169
|
-
"kind": "field",
|
1170
|
-
"name": "overlay",
|
1171
|
-
"type": {
|
1172
|
-
"text": "boolean"
|
1173
|
-
},
|
1174
|
-
"default": "false",
|
1175
|
-
"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.",
|
1176
|
-
"attribute": "overlay"
|
1177
|
-
},
|
1178
1121
|
{
|
1179
1122
|
"kind": "field",
|
1180
1123
|
"name": "ariaLabel",
|
@@ -1187,102 +1130,97 @@
|
|
1187
1130
|
},
|
1188
1131
|
{
|
1189
1132
|
"kind": "method",
|
1190
|
-
"name": "
|
1133
|
+
"name": "setSize",
|
1191
1134
|
"privacy": "private",
|
1192
|
-
"return": {
|
1193
|
-
"type": {
|
1194
|
-
"text": ""
|
1195
|
-
}
|
1196
|
-
},
|
1197
1135
|
"parameters": [
|
1198
1136
|
{
|
1199
|
-
"name": "
|
1200
|
-
"type": {
|
1201
|
-
"text": "number"
|
1202
|
-
},
|
1203
|
-
"description": "the maximum limit which can be displayed on the badge"
|
1204
|
-
},
|
1205
|
-
{
|
1206
|
-
"name": "counter",
|
1207
|
-
"optional": true,
|
1137
|
+
"name": "size",
|
1208
1138
|
"type": {
|
1209
|
-
"text": "
|
1210
|
-
}
|
1211
|
-
"description": "the number to be displayed on the badge"
|
1139
|
+
"text": "AvatarSize"
|
1140
|
+
}
|
1212
1141
|
}
|
1213
|
-
]
|
1214
|
-
"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."
|
1142
|
+
]
|
1215
1143
|
},
|
1216
1144
|
{
|
1217
|
-
"kind": "
|
1218
|
-
"name": "
|
1219
|
-
"
|
1220
|
-
|
1221
|
-
"type": {
|
1222
|
-
"text": ""
|
1223
|
-
}
|
1145
|
+
"kind": "field",
|
1146
|
+
"name": "src",
|
1147
|
+
"type": {
|
1148
|
+
"text": "string | undefined"
|
1224
1149
|
},
|
1225
|
-
"
|
1226
|
-
|
1227
|
-
|
1228
|
-
|
1229
|
-
|
1230
|
-
|
1231
|
-
"description": "the name of the icon from the icon set"
|
1232
|
-
},
|
1233
|
-
{
|
1234
|
-
"name": "backgroundClassPostfix",
|
1235
|
-
"type": {
|
1236
|
-
"text": "string"
|
1237
|
-
},
|
1238
|
-
"description": "postfix for the class to style the badge icon."
|
1239
|
-
}
|
1240
|
-
],
|
1241
|
-
"description": "Method to generate the badge icon."
|
1150
|
+
"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.",
|
1151
|
+
"attribute": "src",
|
1152
|
+
"inheritedFrom": {
|
1153
|
+
"name": "AvatarComponentMixin",
|
1154
|
+
"module": "utils/mixins/AvatarComponentMixin.js"
|
1155
|
+
}
|
1242
1156
|
},
|
1243
1157
|
{
|
1244
|
-
"kind": "
|
1245
|
-
"name": "
|
1246
|
-
"
|
1247
|
-
|
1248
|
-
"type": {
|
1249
|
-
"text": ""
|
1250
|
-
}
|
1158
|
+
"kind": "field",
|
1159
|
+
"name": "initials",
|
1160
|
+
"type": {
|
1161
|
+
"text": "string | undefined"
|
1251
1162
|
},
|
1252
|
-
"description": "
|
1163
|
+
"description": "The initials to be displayed for the avatar.",
|
1164
|
+
"attribute": "initials",
|
1165
|
+
"inheritedFrom": {
|
1166
|
+
"name": "AvatarComponentMixin",
|
1167
|
+
"module": "utils/mixins/AvatarComponentMixin.js"
|
1168
|
+
}
|
1253
1169
|
},
|
1254
1170
|
{
|
1255
|
-
"kind": "
|
1256
|
-
"name": "
|
1257
|
-
"
|
1258
|
-
|
1259
|
-
"type": {
|
1260
|
-
"text": ""
|
1261
|
-
}
|
1171
|
+
"kind": "field",
|
1172
|
+
"name": "presence",
|
1173
|
+
"type": {
|
1174
|
+
"text": "PresenceType | undefined"
|
1262
1175
|
},
|
1263
|
-
"description": "
|
1176
|
+
"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`",
|
1177
|
+
"attribute": "presence",
|
1178
|
+
"inheritedFrom": {
|
1179
|
+
"name": "AvatarComponentMixin",
|
1180
|
+
"module": "utils/mixins/AvatarComponentMixin.js"
|
1181
|
+
}
|
1264
1182
|
},
|
1265
1183
|
{
|
1266
|
-
"kind": "
|
1267
|
-
"name": "
|
1268
|
-
"
|
1269
|
-
|
1270
|
-
"type": {
|
1271
|
-
"text": "void"
|
1272
|
-
}
|
1184
|
+
"kind": "field",
|
1185
|
+
"name": "size",
|
1186
|
+
"type": {
|
1187
|
+
"text": "ButtonSize"
|
1273
1188
|
},
|
1274
|
-
"description": "
|
1189
|
+
"description": "Acceptable values include (size in px unit):\n- 24\n- 32\n- 48\n- 64\n- 72\n- 88\n- 124",
|
1190
|
+
"default": "32",
|
1191
|
+
"attribute": "size",
|
1192
|
+
"reflects": true,
|
1193
|
+
"inheritedFrom": {
|
1194
|
+
"name": "Buttonsimple",
|
1195
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
1196
|
+
}
|
1275
1197
|
},
|
1276
1198
|
{
|
1277
|
-
"kind": "
|
1278
|
-
"name": "
|
1279
|
-
"
|
1280
|
-
|
1281
|
-
"type": {
|
1282
|
-
"text": ""
|
1283
|
-
}
|
1199
|
+
"kind": "field",
|
1200
|
+
"name": "counter",
|
1201
|
+
"type": {
|
1202
|
+
"text": "number | undefined"
|
1284
1203
|
},
|
1285
|
-
"description": "
|
1204
|
+
"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`.",
|
1205
|
+
"attribute": "counter",
|
1206
|
+
"inheritedFrom": {
|
1207
|
+
"name": "AvatarComponentMixin",
|
1208
|
+
"module": "utils/mixins/AvatarComponentMixin.js"
|
1209
|
+
}
|
1210
|
+
},
|
1211
|
+
{
|
1212
|
+
"kind": "field",
|
1213
|
+
"name": "isTyping",
|
1214
|
+
"type": {
|
1215
|
+
"text": "boolean"
|
1216
|
+
},
|
1217
|
+
"default": "false",
|
1218
|
+
"description": "Represents the typing indicator when the user is typing.",
|
1219
|
+
"attribute": "is-typing",
|
1220
|
+
"inheritedFrom": {
|
1221
|
+
"name": "AvatarComponentMixin",
|
1222
|
+
"module": "utils/mixins/AvatarComponentMixin.js"
|
1223
|
+
}
|
1286
1224
|
},
|
1287
1225
|
{
|
1288
1226
|
"kind": "field",
|
@@ -1296,220 +1234,103 @@
|
|
1296
1234
|
"name": "IconNameMixin",
|
1297
1235
|
"module": "utils/mixins/IconNameMixin.js"
|
1298
1236
|
}
|
1299
|
-
}
|
1300
|
-
],
|
1301
|
-
"attributes": [
|
1237
|
+
},
|
1302
1238
|
{
|
1303
|
-
"
|
1304
|
-
"
|
1305
|
-
"text": "BadgeType | undefined"
|
1306
|
-
},
|
1307
|
-
"description": "Type of the badge\nCan be `dot` (notification) , `icon`, `counter`, `success`, `warning` or `error`.",
|
1308
|
-
"fieldName": "type"
|
1309
|
-
},
|
1310
|
-
{
|
1311
|
-
"name": "variant",
|
1312
|
-
"type": {
|
1313
|
-
"text": "IconVariant"
|
1314
|
-
},
|
1315
|
-
"description": "Type of the variant can be `primary` or `secondary`.\nIt defines the background and foreground color of the icon.",
|
1316
|
-
"default": "primary",
|
1317
|
-
"fieldName": "variant"
|
1318
|
-
},
|
1319
|
-
{
|
1320
|
-
"name": "counter",
|
1321
|
-
"type": {
|
1322
|
-
"text": "number | undefined"
|
1323
|
-
},
|
1324
|
-
"description": "Counter is the number which can be provided in the badge.",
|
1325
|
-
"fieldName": "counter"
|
1326
|
-
},
|
1327
|
-
{
|
1328
|
-
"name": "max-counter",
|
1329
|
-
"type": {
|
1330
|
-
"text": "number"
|
1331
|
-
},
|
1332
|
-
"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`.",
|
1333
|
-
"default": "99",
|
1334
|
-
"fieldName": "maxCounter"
|
1335
|
-
},
|
1336
|
-
{
|
1337
|
-
"name": "overlay",
|
1239
|
+
"kind": "field",
|
1240
|
+
"name": "autofocus",
|
1338
1241
|
"type": {
|
1339
1242
|
"text": "boolean"
|
1340
1243
|
},
|
1341
1244
|
"default": "false",
|
1342
|
-
"description": "
|
1343
|
-
"
|
1344
|
-
|
1345
|
-
|
1346
|
-
|
1347
|
-
|
1348
|
-
|
1349
|
-
},
|
1350
|
-
"default": "null",
|
1351
|
-
"description": "Aria-label attribute to be set for accessibility",
|
1352
|
-
"fieldName": "ariaLabel"
|
1245
|
+
"description": "This property indicates whether the element should receive focus automatically when it is rendered.",
|
1246
|
+
"attribute": "autofocus",
|
1247
|
+
"reflects": true,
|
1248
|
+
"inheritedFrom": {
|
1249
|
+
"name": "AutoFocusMixin",
|
1250
|
+
"module": "utils/mixins/AutoFocusMixin.js"
|
1251
|
+
}
|
1353
1252
|
},
|
1354
1253
|
{
|
1355
|
-
"
|
1254
|
+
"kind": "field",
|
1255
|
+
"name": "tabIndex",
|
1356
1256
|
"type": {
|
1357
|
-
"text": "
|
1257
|
+
"text": "number"
|
1358
1258
|
},
|
1359
|
-
"
|
1360
|
-
"
|
1259
|
+
"default": "0",
|
1260
|
+
"description": "This property specifies the tab order of the element.",
|
1261
|
+
"attribute": "tabIndex",
|
1262
|
+
"reflects": true,
|
1361
1263
|
"inheritedFrom": {
|
1362
|
-
"name": "
|
1363
|
-
"module": "
|
1264
|
+
"name": "TabIndexMixin",
|
1265
|
+
"module": "utils/mixins/TabIndexMixin.js"
|
1364
1266
|
}
|
1365
|
-
}
|
1366
|
-
],
|
1367
|
-
"mixins": [
|
1368
|
-
{
|
1369
|
-
"name": "IconNameMixin",
|
1370
|
-
"module": "/src/utils/mixins/IconNameMixin"
|
1371
|
-
}
|
1372
|
-
],
|
1373
|
-
"superclass": {
|
1374
|
-
"name": "Component",
|
1375
|
-
"module": "/src/models"
|
1376
|
-
},
|
1377
|
-
"tagName": "mdc-badge",
|
1378
|
-
"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 */",
|
1379
|
-
"customElement": true
|
1380
|
-
}
|
1381
|
-
],
|
1382
|
-
"exports": [
|
1383
|
-
{
|
1384
|
-
"kind": "js",
|
1385
|
-
"name": "default",
|
1386
|
-
"declaration": {
|
1387
|
-
"name": "Badge",
|
1388
|
-
"module": "components/badge/badge.component.js"
|
1389
|
-
}
|
1390
|
-
}
|
1391
|
-
]
|
1392
|
-
},
|
1393
|
-
{
|
1394
|
-
"kind": "javascript-module",
|
1395
|
-
"path": "components/avatarbutton/avatarbutton.component.js",
|
1396
|
-
"declarations": [
|
1397
|
-
{
|
1398
|
-
"kind": "class",
|
1399
|
-
"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.\n\nTo override styles of the avatar inside, use the specified css parts.",
|
1400
|
-
"name": "AvatarButton",
|
1401
|
-
"cssProperties": [
|
1402
|
-
{
|
1403
|
-
"description": "Background color of the overlay in rest state",
|
1404
|
-
"name": "--mdc-avatarbutton-overlay-background-color-rest"
|
1405
|
-
},
|
1406
|
-
{
|
1407
|
-
"description": "Background color of the overlay in hover state",
|
1408
|
-
"name": "--mdc-avatarbutton-overlay-background-color-hover"
|
1409
|
-
},
|
1410
|
-
{
|
1411
|
-
"description": "Background color of the overlay in active state",
|
1412
|
-
"name": "--mdc-avatarbutton-overlay-background-color-active"
|
1413
|
-
}
|
1414
|
-
],
|
1415
|
-
"cssParts": [
|
1416
|
-
{
|
1417
|
-
"description": "The overlay part of the avatar button.",
|
1418
|
-
"name": "overlay"
|
1419
|
-
},
|
1420
|
-
{
|
1421
|
-
"description": "The main content of the avatar.",
|
1422
|
-
"name": "content"
|
1423
1267
|
},
|
1424
|
-
{
|
1425
|
-
"description": "The photo part of the avatar.",
|
1426
|
-
"name": "photo"
|
1427
|
-
},
|
1428
|
-
{
|
1429
|
-
"description": "The presence indicator part of the avatar.",
|
1430
|
-
"name": "presence"
|
1431
|
-
},
|
1432
|
-
{
|
1433
|
-
"description": "The wrapper for the loading indicator of the avatar.",
|
1434
|
-
"name": "loading-wrapper"
|
1435
|
-
},
|
1436
|
-
{
|
1437
|
-
"description": "The loading indicator part of the avatar.",
|
1438
|
-
"name": "loader"
|
1439
|
-
}
|
1440
|
-
],
|
1441
|
-
"members": [
|
1442
1268
|
{
|
1443
1269
|
"kind": "field",
|
1444
|
-
"name": "
|
1270
|
+
"name": "disabled",
|
1445
1271
|
"type": {
|
1446
|
-
"text": "
|
1272
|
+
"text": "boolean | undefined"
|
1447
1273
|
},
|
1448
|
-
"
|
1449
|
-
"
|
1450
|
-
"attribute": "
|
1451
|
-
|
1452
|
-
|
1453
|
-
|
1454
|
-
|
1455
|
-
|
1456
|
-
"parameters": [
|
1457
|
-
{
|
1458
|
-
"name": "size",
|
1459
|
-
"type": {
|
1460
|
-
"text": "AvatarSize"
|
1461
|
-
}
|
1462
|
-
}
|
1463
|
-
]
|
1274
|
+
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
1275
|
+
"default": "undefined",
|
1276
|
+
"attribute": "disabled",
|
1277
|
+
"reflects": true,
|
1278
|
+
"inheritedFrom": {
|
1279
|
+
"name": "DisabledMixin",
|
1280
|
+
"module": "utils/mixins/DisabledMixin.js"
|
1281
|
+
}
|
1464
1282
|
},
|
1465
1283
|
{
|
1466
1284
|
"kind": "field",
|
1467
|
-
"name": "
|
1285
|
+
"name": "active",
|
1468
1286
|
"type": {
|
1469
|
-
"text": "
|
1287
|
+
"text": "boolean | undefined"
|
1470
1288
|
},
|
1471
|
-
"description": "The
|
1472
|
-
"
|
1289
|
+
"description": "The button's active state indicates whether it is currently toggled on (active) or off (inactive).\nWhen the active state is true, the button is considered to be in an active state, meaning it is toggled on.\nConversely, when the active state is false, the button is in an inactive state, indicating it is toggled off.\n\nThis attribute is used to set the provided `ariaStateKey` to true or false.",
|
1290
|
+
"default": "undefined",
|
1291
|
+
"attribute": "active",
|
1292
|
+
"reflects": true,
|
1473
1293
|
"inheritedFrom": {
|
1474
|
-
"name": "
|
1475
|
-
"module": "
|
1294
|
+
"name": "Buttonsimple",
|
1295
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
1476
1296
|
}
|
1477
1297
|
},
|
1478
1298
|
{
|
1479
1299
|
"kind": "field",
|
1480
|
-
"name": "
|
1300
|
+
"name": "softDisabled",
|
1481
1301
|
"type": {
|
1482
|
-
"text": "
|
1302
|
+
"text": "boolean | undefined"
|
1483
1303
|
},
|
1484
|
-
"description": "
|
1485
|
-
"
|
1304
|
+
"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.",
|
1305
|
+
"default": "undefined",
|
1306
|
+
"attribute": "soft-disabled",
|
1307
|
+
"reflects": true,
|
1486
1308
|
"inheritedFrom": {
|
1487
|
-
"name": "
|
1488
|
-
"module": "
|
1309
|
+
"name": "Buttonsimple",
|
1310
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
1489
1311
|
}
|
1490
1312
|
},
|
1491
1313
|
{
|
1492
1314
|
"kind": "field",
|
1493
|
-
"name": "
|
1494
|
-
"
|
1495
|
-
|
1496
|
-
|
1497
|
-
"
|
1498
|
-
"attribute": "presence",
|
1315
|
+
"name": "role",
|
1316
|
+
"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.",
|
1317
|
+
"default": "button",
|
1318
|
+
"attribute": "role",
|
1319
|
+
"reflects": true,
|
1499
1320
|
"inheritedFrom": {
|
1500
|
-
"name": "
|
1501
|
-
"module": "
|
1321
|
+
"name": "Buttonsimple",
|
1322
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
1502
1323
|
}
|
1503
1324
|
},
|
1504
1325
|
{
|
1505
1326
|
"kind": "field",
|
1506
|
-
"name": "
|
1327
|
+
"name": "ariaStateKey",
|
1507
1328
|
"type": {
|
1508
|
-
"text": "
|
1329
|
+
"text": "string | undefined"
|
1509
1330
|
},
|
1510
|
-
"description": "
|
1511
|
-
"default": "
|
1512
|
-
"attribute": "
|
1331
|
+
"description": "This property defines the ARIA state key, which will be toggled when the\nButton is set to `active`.\nThe default value is 'aria-pressed', which is commonly used for toggle buttons.\n\nConsumers can override this property to use a different ARIA state key if needed.\nIn case multiple aria attributes should be toggled, they can be passed in as\na comma separated string.\nFor example: `aria-pressed,aria-expanded`",
|
1332
|
+
"default": "'aria-pressed' (when)",
|
1333
|
+
"attribute": "ariaStateKey",
|
1513
1334
|
"reflects": true,
|
1514
1335
|
"inheritedFrom": {
|
1515
1336
|
"name": "Buttonsimple",
|
@@ -1518,168 +1339,26 @@
|
|
1518
1339
|
},
|
1519
1340
|
{
|
1520
1341
|
"kind": "field",
|
1521
|
-
"name": "
|
1342
|
+
"name": "type",
|
1522
1343
|
"type": {
|
1523
|
-
"text": "
|
1344
|
+
"text": "ButtonType"
|
1524
1345
|
},
|
1525
|
-
"description": "
|
1526
|
-
"
|
1346
|
+
"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.",
|
1347
|
+
"default": "button",
|
1348
|
+
"attribute": "type",
|
1349
|
+
"reflects": true,
|
1527
1350
|
"inheritedFrom": {
|
1528
|
-
"name": "
|
1529
|
-
"module": "
|
1351
|
+
"name": "Buttonsimple",
|
1352
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
1530
1353
|
}
|
1531
1354
|
},
|
1532
1355
|
{
|
1533
|
-
"kind": "
|
1534
|
-
"name": "
|
1535
|
-
"
|
1536
|
-
"text": "boolean"
|
1537
|
-
},
|
1538
|
-
"default": "false",
|
1539
|
-
"description": "Represents the typing indicator when the user is typing.",
|
1540
|
-
"attribute": "is-typing",
|
1356
|
+
"kind": "method",
|
1357
|
+
"name": "executeAction",
|
1358
|
+
"privacy": "protected",
|
1541
1359
|
"inheritedFrom": {
|
1542
|
-
"name": "
|
1543
|
-
"module": "
|
1544
|
-
}
|
1545
|
-
},
|
1546
|
-
{
|
1547
|
-
"kind": "field",
|
1548
|
-
"name": "iconName",
|
1549
|
-
"type": {
|
1550
|
-
"text": "IconNames | undefined"
|
1551
|
-
},
|
1552
|
-
"description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
|
1553
|
-
"attribute": "icon-name",
|
1554
|
-
"inheritedFrom": {
|
1555
|
-
"name": "IconNameMixin",
|
1556
|
-
"module": "utils/mixins/IconNameMixin.js"
|
1557
|
-
}
|
1558
|
-
},
|
1559
|
-
{
|
1560
|
-
"kind": "field",
|
1561
|
-
"name": "autofocus",
|
1562
|
-
"type": {
|
1563
|
-
"text": "boolean"
|
1564
|
-
},
|
1565
|
-
"default": "false",
|
1566
|
-
"description": "This property indicates whether the element should receive focus automatically when it is rendered.",
|
1567
|
-
"attribute": "autofocus",
|
1568
|
-
"reflects": true,
|
1569
|
-
"inheritedFrom": {
|
1570
|
-
"name": "AutoFocusMixin",
|
1571
|
-
"module": "utils/mixins/AutoFocusMixin.js"
|
1572
|
-
}
|
1573
|
-
},
|
1574
|
-
{
|
1575
|
-
"kind": "field",
|
1576
|
-
"name": "tabIndex",
|
1577
|
-
"type": {
|
1578
|
-
"text": "number"
|
1579
|
-
},
|
1580
|
-
"default": "0",
|
1581
|
-
"description": "This property specifies the tab order of the element.",
|
1582
|
-
"attribute": "tabIndex",
|
1583
|
-
"reflects": true,
|
1584
|
-
"inheritedFrom": {
|
1585
|
-
"name": "TabIndexMixin",
|
1586
|
-
"module": "utils/mixins/TabIndexMixin.js"
|
1587
|
-
}
|
1588
|
-
},
|
1589
|
-
{
|
1590
|
-
"kind": "field",
|
1591
|
-
"name": "disabled",
|
1592
|
-
"type": {
|
1593
|
-
"text": "boolean | undefined"
|
1594
|
-
},
|
1595
|
-
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
1596
|
-
"default": "undefined",
|
1597
|
-
"attribute": "disabled",
|
1598
|
-
"reflects": true,
|
1599
|
-
"inheritedFrom": {
|
1600
|
-
"name": "DisabledMixin",
|
1601
|
-
"module": "utils/mixins/DisabledMixin.js"
|
1602
|
-
}
|
1603
|
-
},
|
1604
|
-
{
|
1605
|
-
"kind": "field",
|
1606
|
-
"name": "active",
|
1607
|
-
"type": {
|
1608
|
-
"text": "boolean | undefined"
|
1609
|
-
},
|
1610
|
-
"description": "The button's active state indicates whether it is currently toggled on (active) or off (inactive).\nWhen the active state is true, the button is considered to be in an active state, meaning it is toggled on.\nConversely, when the active state is false, the button is in an inactive state, indicating it is toggled off.\n\nThis attribute is used to set the provided `ariaStateKey` to true or false.",
|
1611
|
-
"default": "undefined",
|
1612
|
-
"attribute": "active",
|
1613
|
-
"reflects": true,
|
1614
|
-
"inheritedFrom": {
|
1615
|
-
"name": "Buttonsimple",
|
1616
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
1617
|
-
}
|
1618
|
-
},
|
1619
|
-
{
|
1620
|
-
"kind": "field",
|
1621
|
-
"name": "softDisabled",
|
1622
|
-
"type": {
|
1623
|
-
"text": "boolean | undefined"
|
1624
|
-
},
|
1625
|
-
"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.",
|
1626
|
-
"default": "undefined",
|
1627
|
-
"attribute": "soft-disabled",
|
1628
|
-
"reflects": true,
|
1629
|
-
"inheritedFrom": {
|
1630
|
-
"name": "Buttonsimple",
|
1631
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
1632
|
-
}
|
1633
|
-
},
|
1634
|
-
{
|
1635
|
-
"kind": "field",
|
1636
|
-
"name": "role",
|
1637
|
-
"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.",
|
1638
|
-
"default": "button",
|
1639
|
-
"attribute": "role",
|
1640
|
-
"reflects": true,
|
1641
|
-
"inheritedFrom": {
|
1642
|
-
"name": "Buttonsimple",
|
1643
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
1644
|
-
}
|
1645
|
-
},
|
1646
|
-
{
|
1647
|
-
"kind": "field",
|
1648
|
-
"name": "ariaStateKey",
|
1649
|
-
"type": {
|
1650
|
-
"text": "string | undefined"
|
1651
|
-
},
|
1652
|
-
"description": "This property defines the ARIA state key, which will be toggled when the\nButton is set to `active`.\nThe default value is 'aria-pressed', which is commonly used for toggle buttons.\n\nConsumers can override this property to use a different ARIA state key if needed.\nIn case multiple aria attributes should be toggled, they can be passed in as\na comma separated string.\nFor example: `aria-pressed,aria-expanded`",
|
1653
|
-
"default": "'aria-pressed' (when)",
|
1654
|
-
"attribute": "ariaStateKey",
|
1655
|
-
"reflects": true,
|
1656
|
-
"inheritedFrom": {
|
1657
|
-
"name": "Buttonsimple",
|
1658
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
1659
|
-
}
|
1660
|
-
},
|
1661
|
-
{
|
1662
|
-
"kind": "field",
|
1663
|
-
"name": "type",
|
1664
|
-
"type": {
|
1665
|
-
"text": "ButtonType"
|
1666
|
-
},
|
1667
|
-
"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.",
|
1668
|
-
"default": "button",
|
1669
|
-
"attribute": "type",
|
1670
|
-
"reflects": true,
|
1671
|
-
"inheritedFrom": {
|
1672
|
-
"name": "Buttonsimple",
|
1673
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
1674
|
-
}
|
1675
|
-
},
|
1676
|
-
{
|
1677
|
-
"kind": "method",
|
1678
|
-
"name": "executeAction",
|
1679
|
-
"privacy": "protected",
|
1680
|
-
"inheritedFrom": {
|
1681
|
-
"name": "Buttonsimple",
|
1682
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
1360
|
+
"name": "Buttonsimple",
|
1361
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
1683
1362
|
}
|
1684
1363
|
},
|
1685
1364
|
{
|
@@ -1905,173 +1584,494 @@
|
|
1905
1584
|
}
|
1906
1585
|
},
|
1907
1586
|
{
|
1908
|
-
"name": "size",
|
1909
|
-
"type": {
|
1910
|
-
"text": "ButtonSize"
|
1587
|
+
"name": "size",
|
1588
|
+
"type": {
|
1589
|
+
"text": "ButtonSize"
|
1590
|
+
},
|
1591
|
+
"description": "Acceptable values include (size in px unit):\n- 24\n- 32\n- 48\n- 64\n- 72\n- 88\n- 124",
|
1592
|
+
"default": "32",
|
1593
|
+
"fieldName": "size",
|
1594
|
+
"inheritedFrom": {
|
1595
|
+
"name": "Buttonsimple",
|
1596
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
1597
|
+
}
|
1598
|
+
},
|
1599
|
+
{
|
1600
|
+
"name": "counter",
|
1601
|
+
"type": {
|
1602
|
+
"text": "number | undefined"
|
1603
|
+
},
|
1604
|
+
"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`.",
|
1605
|
+
"fieldName": "counter",
|
1606
|
+
"inheritedFrom": {
|
1607
|
+
"name": "AvatarComponentMixin",
|
1608
|
+
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
1609
|
+
}
|
1610
|
+
},
|
1611
|
+
{
|
1612
|
+
"name": "is-typing",
|
1613
|
+
"type": {
|
1614
|
+
"text": "boolean"
|
1615
|
+
},
|
1616
|
+
"default": "false",
|
1617
|
+
"description": "Represents the typing indicator when the user is typing.",
|
1618
|
+
"fieldName": "isTyping",
|
1619
|
+
"inheritedFrom": {
|
1620
|
+
"name": "AvatarComponentMixin",
|
1621
|
+
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
1622
|
+
}
|
1623
|
+
},
|
1624
|
+
{
|
1625
|
+
"name": "icon-name",
|
1626
|
+
"type": {
|
1627
|
+
"text": "IconNames | undefined"
|
1628
|
+
},
|
1629
|
+
"description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
|
1630
|
+
"fieldName": "iconName",
|
1631
|
+
"inheritedFrom": {
|
1632
|
+
"name": "IconNameMixin",
|
1633
|
+
"module": "src/utils/mixins/IconNameMixin.ts"
|
1634
|
+
}
|
1635
|
+
},
|
1636
|
+
{
|
1637
|
+
"name": "autofocus",
|
1638
|
+
"type": {
|
1639
|
+
"text": "boolean"
|
1640
|
+
},
|
1641
|
+
"default": "false",
|
1642
|
+
"description": "This property indicates whether the element should receive focus automatically when it is rendered.",
|
1643
|
+
"fieldName": "autofocus",
|
1644
|
+
"inheritedFrom": {
|
1645
|
+
"name": "AutoFocusMixin",
|
1646
|
+
"module": "src/utils/mixins/AutoFocusMixin.ts"
|
1647
|
+
}
|
1648
|
+
},
|
1649
|
+
{
|
1650
|
+
"name": "tabIndex",
|
1651
|
+
"type": {
|
1652
|
+
"text": "number"
|
1653
|
+
},
|
1654
|
+
"default": "0",
|
1655
|
+
"description": "This property specifies the tab order of the element.",
|
1656
|
+
"fieldName": "tabIndex",
|
1657
|
+
"inheritedFrom": {
|
1658
|
+
"name": "TabIndexMixin",
|
1659
|
+
"module": "src/utils/mixins/TabIndexMixin.ts"
|
1660
|
+
}
|
1661
|
+
},
|
1662
|
+
{
|
1663
|
+
"name": "disabled",
|
1664
|
+
"type": {
|
1665
|
+
"text": "boolean | undefined"
|
1666
|
+
},
|
1667
|
+
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
1668
|
+
"default": "undefined",
|
1669
|
+
"fieldName": "disabled",
|
1670
|
+
"inheritedFrom": {
|
1671
|
+
"name": "DisabledMixin",
|
1672
|
+
"module": "src/utils/mixins/DisabledMixin.ts"
|
1673
|
+
}
|
1674
|
+
},
|
1675
|
+
{
|
1676
|
+
"name": "active",
|
1677
|
+
"type": {
|
1678
|
+
"text": "boolean | undefined"
|
1679
|
+
},
|
1680
|
+
"description": "The button's active state indicates whether it is currently toggled on (active) or off (inactive).\nWhen the active state is true, the button is considered to be in an active state, meaning it is toggled on.\nConversely, when the active state is false, the button is in an inactive state, indicating it is toggled off.\n\nThis attribute is used to set the provided `ariaStateKey` to true or false.",
|
1681
|
+
"default": "undefined",
|
1682
|
+
"fieldName": "active",
|
1683
|
+
"inheritedFrom": {
|
1684
|
+
"name": "Buttonsimple",
|
1685
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
1686
|
+
}
|
1687
|
+
},
|
1688
|
+
{
|
1689
|
+
"name": "soft-disabled",
|
1690
|
+
"type": {
|
1691
|
+
"text": "boolean | undefined"
|
1692
|
+
},
|
1693
|
+
"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.",
|
1694
|
+
"default": "undefined",
|
1695
|
+
"fieldName": "softDisabled",
|
1696
|
+
"inheritedFrom": {
|
1697
|
+
"name": "Buttonsimple",
|
1698
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
1699
|
+
}
|
1700
|
+
},
|
1701
|
+
{
|
1702
|
+
"name": "role",
|
1703
|
+
"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.",
|
1704
|
+
"default": "button",
|
1705
|
+
"fieldName": "role",
|
1706
|
+
"inheritedFrom": {
|
1707
|
+
"name": "Buttonsimple",
|
1708
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
1709
|
+
}
|
1710
|
+
},
|
1711
|
+
{
|
1712
|
+
"name": "ariaStateKey",
|
1713
|
+
"type": {
|
1714
|
+
"text": "string | undefined"
|
1715
|
+
},
|
1716
|
+
"description": "This property defines the ARIA state key, which will be toggled when the\nButton is set to `active`.\nThe default value is 'aria-pressed', which is commonly used for toggle buttons.\n\nConsumers can override this property to use a different ARIA state key if needed.\nIn case multiple aria attributes should be toggled, they can be passed in as\na comma separated string.\nFor example: `aria-pressed,aria-expanded`",
|
1717
|
+
"default": "'aria-pressed' (when)",
|
1718
|
+
"fieldName": "ariaStateKey",
|
1719
|
+
"inheritedFrom": {
|
1720
|
+
"name": "Buttonsimple",
|
1721
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
1722
|
+
}
|
1723
|
+
},
|
1724
|
+
{
|
1725
|
+
"name": "type",
|
1726
|
+
"type": {
|
1727
|
+
"text": "ButtonType"
|
1728
|
+
},
|
1729
|
+
"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.",
|
1730
|
+
"default": "button",
|
1731
|
+
"fieldName": "type",
|
1732
|
+
"inheritedFrom": {
|
1733
|
+
"name": "Buttonsimple",
|
1734
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
1735
|
+
}
|
1736
|
+
}
|
1737
|
+
],
|
1738
|
+
"mixins": [
|
1739
|
+
{
|
1740
|
+
"name": "AvatarComponentMixin",
|
1741
|
+
"module": "/src/utils/mixins/AvatarComponentMixin"
|
1742
|
+
},
|
1743
|
+
{
|
1744
|
+
"name": "IconNameMixin",
|
1745
|
+
"module": "/src/utils/mixins/IconNameMixin"
|
1746
|
+
}
|
1747
|
+
],
|
1748
|
+
"superclass": {
|
1749
|
+
"name": "Buttonsimple",
|
1750
|
+
"module": "/src/components/buttonsimple/buttonsimple.component"
|
1751
|
+
},
|
1752
|
+
"tagName": "mdc-avatarbutton",
|
1753
|
+
"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 * To override styles of the avatar inside, use the specified css parts.\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 *\n * @cssproperty --mdc-avatarbutton-overlay-background-color-rest - Background color of the overlay in rest state\n * @cssproperty --mdc-avatarbutton-overlay-background-color-hover - Background color of the overlay in hover state\n * @cssproperty --mdc-avatarbutton-overlay-background-color-active - Background color of the overlay in active state\n *\n * @csspart overlay - The overlay part of the avatar button.\n * @csspart content - The main content of the avatar.\n * @csspart photo - The photo part of the avatar.\n * @csspart presence - The presence indicator part of the avatar.\n * @csspart loading-wrapper - The wrapper for the loading indicator of the avatar.\n * @csspart loader - The loading indicator part of the avatar.\n */",
|
1754
|
+
"customElement": true
|
1755
|
+
}
|
1756
|
+
],
|
1757
|
+
"exports": [
|
1758
|
+
{
|
1759
|
+
"kind": "js",
|
1760
|
+
"name": "default",
|
1761
|
+
"declaration": {
|
1762
|
+
"name": "AvatarButton",
|
1763
|
+
"module": "components/avatarbutton/avatarbutton.component.js"
|
1764
|
+
}
|
1765
|
+
}
|
1766
|
+
]
|
1767
|
+
},
|
1768
|
+
{
|
1769
|
+
"kind": "javascript-module",
|
1770
|
+
"path": "components/badge/badge.component.js",
|
1771
|
+
"declarations": [
|
1772
|
+
{
|
1773
|
+
"kind": "class",
|
1774
|
+
"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.",
|
1775
|
+
"name": "Badge",
|
1776
|
+
"cssProperties": [
|
1777
|
+
{
|
1778
|
+
"description": "The foreground color of the primary badge.",
|
1779
|
+
"name": "--mdc-badge-primary-foreground-color"
|
1780
|
+
},
|
1781
|
+
{
|
1782
|
+
"description": "The background color of the primary badge.",
|
1783
|
+
"name": "--mdc-badge-primary-background-color"
|
1784
|
+
},
|
1785
|
+
{
|
1786
|
+
"description": "The foreground color of the secondary badge.",
|
1787
|
+
"name": "--mdc-badge-secondary-foreground-color"
|
1788
|
+
},
|
1789
|
+
{
|
1790
|
+
"description": "The background color of the secondary badge.",
|
1791
|
+
"name": "--mdc-badge-secondary-background-color"
|
1792
|
+
},
|
1793
|
+
{
|
1794
|
+
"description": "The foreground color of the success badge.",
|
1795
|
+
"name": "--mdc-badge-success-foreground-color"
|
1796
|
+
},
|
1797
|
+
{
|
1798
|
+
"description": "The background color of the success badge.",
|
1799
|
+
"name": "--mdc-badge-success-background-color"
|
1800
|
+
},
|
1801
|
+
{
|
1802
|
+
"description": "The foreground color of the warning badge.",
|
1803
|
+
"name": "--mdc-badge-warning-foreground-color"
|
1804
|
+
},
|
1805
|
+
{
|
1806
|
+
"description": "The background color of the warning badge.",
|
1807
|
+
"name": "--mdc-badge-warning-background-color"
|
1808
|
+
},
|
1809
|
+
{
|
1810
|
+
"description": "The foreground color of the error badge.",
|
1811
|
+
"name": "--mdc-badge-error-foreground-color"
|
1812
|
+
},
|
1813
|
+
{
|
1814
|
+
"description": "The background color of the error badge.",
|
1815
|
+
"name": "--mdc-badge-error-background-color"
|
1816
|
+
},
|
1817
|
+
{
|
1818
|
+
"description": "The background color of the badge overlay.",
|
1819
|
+
"name": "--mdc-badge-overlay-background-color"
|
1820
|
+
}
|
1821
|
+
],
|
1822
|
+
"members": [
|
1823
|
+
{
|
1824
|
+
"kind": "field",
|
1825
|
+
"name": "type",
|
1826
|
+
"type": {
|
1827
|
+
"text": "BadgeType | undefined"
|
1828
|
+
},
|
1829
|
+
"description": "Type of the badge\nCan be `dot` (notification) , `icon`, `counter`, `success`, `warning` or `error`.",
|
1830
|
+
"attribute": "type",
|
1831
|
+
"reflects": true
|
1832
|
+
},
|
1833
|
+
{
|
1834
|
+
"kind": "field",
|
1835
|
+
"name": "variant",
|
1836
|
+
"type": {
|
1837
|
+
"text": "IconVariant"
|
1838
|
+
},
|
1839
|
+
"description": "Type of the variant can be `primary` or `secondary`.\nIt defines the background and foreground color of the icon.",
|
1840
|
+
"default": "primary",
|
1841
|
+
"attribute": "variant",
|
1842
|
+
"reflects": true
|
1843
|
+
},
|
1844
|
+
{
|
1845
|
+
"kind": "field",
|
1846
|
+
"name": "counter",
|
1847
|
+
"type": {
|
1848
|
+
"text": "number | undefined"
|
1849
|
+
},
|
1850
|
+
"description": "Counter is the number which can be provided in the badge.",
|
1851
|
+
"attribute": "counter"
|
1852
|
+
},
|
1853
|
+
{
|
1854
|
+
"kind": "field",
|
1855
|
+
"name": "maxCounter",
|
1856
|
+
"type": {
|
1857
|
+
"text": "number"
|
1858
|
+
},
|
1859
|
+
"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`.",
|
1860
|
+
"default": "99",
|
1861
|
+
"attribute": "max-counter",
|
1862
|
+
"reflects": true
|
1863
|
+
},
|
1864
|
+
{
|
1865
|
+
"kind": "field",
|
1866
|
+
"name": "overlay",
|
1867
|
+
"type": {
|
1868
|
+
"text": "boolean"
|
1869
|
+
},
|
1870
|
+
"default": "false",
|
1871
|
+
"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.",
|
1872
|
+
"attribute": "overlay"
|
1873
|
+
},
|
1874
|
+
{
|
1875
|
+
"kind": "field",
|
1876
|
+
"name": "ariaLabel",
|
1877
|
+
"type": {
|
1878
|
+
"text": "string | null"
|
1879
|
+
},
|
1880
|
+
"default": "null",
|
1881
|
+
"description": "Aria-label attribute to be set for accessibility",
|
1882
|
+
"attribute": "aria-label"
|
1883
|
+
},
|
1884
|
+
{
|
1885
|
+
"kind": "method",
|
1886
|
+
"name": "getCounterText",
|
1887
|
+
"privacy": "private",
|
1888
|
+
"return": {
|
1889
|
+
"type": {
|
1890
|
+
"text": ""
|
1891
|
+
}
|
1892
|
+
},
|
1893
|
+
"parameters": [
|
1894
|
+
{
|
1895
|
+
"name": "maxCounter",
|
1896
|
+
"type": {
|
1897
|
+
"text": "number"
|
1898
|
+
},
|
1899
|
+
"description": "the maximum limit which can be displayed on the badge"
|
1900
|
+
},
|
1901
|
+
{
|
1902
|
+
"name": "counter",
|
1903
|
+
"optional": true,
|
1904
|
+
"type": {
|
1905
|
+
"text": "number"
|
1906
|
+
},
|
1907
|
+
"description": "the number to be displayed on the badge"
|
1908
|
+
}
|
1909
|
+
],
|
1910
|
+
"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."
|
1911
|
+
},
|
1912
|
+
{
|
1913
|
+
"kind": "method",
|
1914
|
+
"name": "getBadgeIcon",
|
1915
|
+
"privacy": "private",
|
1916
|
+
"return": {
|
1917
|
+
"type": {
|
1918
|
+
"text": ""
|
1919
|
+
}
|
1920
|
+
},
|
1921
|
+
"parameters": [
|
1922
|
+
{
|
1923
|
+
"name": "iconName",
|
1924
|
+
"type": {
|
1925
|
+
"text": "string"
|
1926
|
+
},
|
1927
|
+
"description": "the name of the icon from the icon set"
|
1928
|
+
},
|
1929
|
+
{
|
1930
|
+
"name": "backgroundClassPostfix",
|
1931
|
+
"type": {
|
1932
|
+
"text": "string"
|
1933
|
+
},
|
1934
|
+
"description": "postfix for the class to style the badge icon."
|
1935
|
+
}
|
1936
|
+
],
|
1937
|
+
"description": "Method to generate the badge icon."
|
1938
|
+
},
|
1939
|
+
{
|
1940
|
+
"kind": "method",
|
1941
|
+
"name": "getBadgeDot",
|
1942
|
+
"privacy": "private",
|
1943
|
+
"return": {
|
1944
|
+
"type": {
|
1945
|
+
"text": ""
|
1946
|
+
}
|
1947
|
+
},
|
1948
|
+
"description": "Method to generate the badge dot template."
|
1949
|
+
},
|
1950
|
+
{
|
1951
|
+
"kind": "method",
|
1952
|
+
"name": "getBadgeCounterText",
|
1953
|
+
"privacy": "private",
|
1954
|
+
"return": {
|
1955
|
+
"type": {
|
1956
|
+
"text": ""
|
1957
|
+
}
|
1911
1958
|
},
|
1912
|
-
"description": "
|
1913
|
-
"default": "32",
|
1914
|
-
"fieldName": "size",
|
1915
|
-
"inheritedFrom": {
|
1916
|
-
"name": "Buttonsimple",
|
1917
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
1918
|
-
}
|
1959
|
+
"description": "Method to generate the badge text and counter template."
|
1919
1960
|
},
|
1920
1961
|
{
|
1921
|
-
"
|
1922
|
-
"
|
1923
|
-
|
1962
|
+
"kind": "method",
|
1963
|
+
"name": "setRoleByAriaLabel",
|
1964
|
+
"privacy": "private",
|
1965
|
+
"return": {
|
1966
|
+
"type": {
|
1967
|
+
"text": "void"
|
1968
|
+
}
|
1924
1969
|
},
|
1925
|
-
"description": "
|
1926
|
-
"fieldName": "counter",
|
1927
|
-
"inheritedFrom": {
|
1928
|
-
"name": "AvatarComponentMixin",
|
1929
|
-
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
1930
|
-
}
|
1970
|
+
"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."
|
1931
1971
|
},
|
1932
1972
|
{
|
1933
|
-
"
|
1934
|
-
"
|
1935
|
-
|
1973
|
+
"kind": "method",
|
1974
|
+
"name": "getBadgeContentBasedOnType",
|
1975
|
+
"privacy": "private",
|
1976
|
+
"return": {
|
1977
|
+
"type": {
|
1978
|
+
"text": ""
|
1979
|
+
}
|
1936
1980
|
},
|
1937
|
-
"
|
1938
|
-
"description": "Represents the typing indicator when the user is typing.",
|
1939
|
-
"fieldName": "isTyping",
|
1940
|
-
"inheritedFrom": {
|
1941
|
-
"name": "AvatarComponentMixin",
|
1942
|
-
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
1943
|
-
}
|
1981
|
+
"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."
|
1944
1982
|
},
|
1945
1983
|
{
|
1946
|
-
"
|
1984
|
+
"kind": "field",
|
1985
|
+
"name": "iconName",
|
1947
1986
|
"type": {
|
1948
1987
|
"text": "IconNames | undefined"
|
1949
1988
|
},
|
1950
1989
|
"description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
|
1951
|
-
"
|
1990
|
+
"attribute": "icon-name",
|
1952
1991
|
"inheritedFrom": {
|
1953
1992
|
"name": "IconNameMixin",
|
1954
|
-
"module": "
|
1993
|
+
"module": "utils/mixins/IconNameMixin.js"
|
1955
1994
|
}
|
1956
|
-
}
|
1995
|
+
}
|
1996
|
+
],
|
1997
|
+
"attributes": [
|
1957
1998
|
{
|
1958
|
-
"name": "
|
1999
|
+
"name": "type",
|
1959
2000
|
"type": {
|
1960
|
-
"text": "
|
2001
|
+
"text": "BadgeType | undefined"
|
1961
2002
|
},
|
1962
|
-
"
|
1963
|
-
"
|
1964
|
-
"fieldName": "autofocus",
|
1965
|
-
"inheritedFrom": {
|
1966
|
-
"name": "AutoFocusMixin",
|
1967
|
-
"module": "src/utils/mixins/AutoFocusMixin.ts"
|
1968
|
-
}
|
2003
|
+
"description": "Type of the badge\nCan be `dot` (notification) , `icon`, `counter`, `success`, `warning` or `error`.",
|
2004
|
+
"fieldName": "type"
|
1969
2005
|
},
|
1970
2006
|
{
|
1971
|
-
"name": "
|
2007
|
+
"name": "variant",
|
1972
2008
|
"type": {
|
1973
|
-
"text": "
|
2009
|
+
"text": "IconVariant"
|
1974
2010
|
},
|
1975
|
-
"
|
1976
|
-
"
|
1977
|
-
"fieldName": "
|
1978
|
-
"inheritedFrom": {
|
1979
|
-
"name": "TabIndexMixin",
|
1980
|
-
"module": "src/utils/mixins/TabIndexMixin.ts"
|
1981
|
-
}
|
2011
|
+
"description": "Type of the variant can be `primary` or `secondary`.\nIt defines the background and foreground color of the icon.",
|
2012
|
+
"default": "primary",
|
2013
|
+
"fieldName": "variant"
|
1982
2014
|
},
|
1983
2015
|
{
|
1984
|
-
"name": "
|
2016
|
+
"name": "counter",
|
1985
2017
|
"type": {
|
1986
|
-
"text": "
|
2018
|
+
"text": "number | undefined"
|
1987
2019
|
},
|
1988
|
-
"description": "
|
1989
|
-
"
|
1990
|
-
"fieldName": "disabled",
|
1991
|
-
"inheritedFrom": {
|
1992
|
-
"name": "DisabledMixin",
|
1993
|
-
"module": "src/utils/mixins/DisabledMixin.ts"
|
1994
|
-
}
|
2020
|
+
"description": "Counter is the number which can be provided in the badge.",
|
2021
|
+
"fieldName": "counter"
|
1995
2022
|
},
|
1996
2023
|
{
|
1997
|
-
"name": "
|
2024
|
+
"name": "max-counter",
|
1998
2025
|
"type": {
|
1999
|
-
"text": "
|
2026
|
+
"text": "number"
|
2000
2027
|
},
|
2001
|
-
"description": "The
|
2002
|
-
"default": "
|
2003
|
-
"fieldName": "
|
2004
|
-
"inheritedFrom": {
|
2005
|
-
"name": "Buttonsimple",
|
2006
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
2007
|
-
}
|
2028
|
+
"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`.",
|
2029
|
+
"default": "99",
|
2030
|
+
"fieldName": "maxCounter"
|
2008
2031
|
},
|
2009
2032
|
{
|
2010
|
-
"name": "
|
2033
|
+
"name": "overlay",
|
2011
2034
|
"type": {
|
2012
|
-
"text": "boolean
|
2035
|
+
"text": "boolean"
|
2013
2036
|
},
|
2014
|
-
"
|
2015
|
-
"
|
2016
|
-
"fieldName": "
|
2017
|
-
"inheritedFrom": {
|
2018
|
-
"name": "Buttonsimple",
|
2019
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
2020
|
-
}
|
2021
|
-
},
|
2022
|
-
{
|
2023
|
-
"name": "role",
|
2024
|
-
"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.",
|
2025
|
-
"default": "button",
|
2026
|
-
"fieldName": "role",
|
2027
|
-
"inheritedFrom": {
|
2028
|
-
"name": "Buttonsimple",
|
2029
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
2030
|
-
}
|
2037
|
+
"default": "false",
|
2038
|
+
"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.",
|
2039
|
+
"fieldName": "overlay"
|
2031
2040
|
},
|
2032
2041
|
{
|
2033
|
-
"name": "
|
2042
|
+
"name": "aria-label",
|
2034
2043
|
"type": {
|
2035
|
-
"text": "string |
|
2044
|
+
"text": "string | null"
|
2036
2045
|
},
|
2037
|
-
"
|
2038
|
-
"
|
2039
|
-
"fieldName": "
|
2040
|
-
"inheritedFrom": {
|
2041
|
-
"name": "Buttonsimple",
|
2042
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
2043
|
-
}
|
2046
|
+
"default": "null",
|
2047
|
+
"description": "Aria-label attribute to be set for accessibility",
|
2048
|
+
"fieldName": "ariaLabel"
|
2044
2049
|
},
|
2045
2050
|
{
|
2046
|
-
"name": "
|
2051
|
+
"name": "icon-name",
|
2047
2052
|
"type": {
|
2048
|
-
"text": "
|
2053
|
+
"text": "IconNames | undefined"
|
2049
2054
|
},
|
2050
|
-
"description": "
|
2051
|
-
"
|
2052
|
-
"fieldName": "type",
|
2055
|
+
"description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
|
2056
|
+
"fieldName": "iconName",
|
2053
2057
|
"inheritedFrom": {
|
2054
|
-
"name": "
|
2055
|
-
"module": "src/
|
2058
|
+
"name": "IconNameMixin",
|
2059
|
+
"module": "src/utils/mixins/IconNameMixin.ts"
|
2056
2060
|
}
|
2057
2061
|
}
|
2058
2062
|
],
|
2059
2063
|
"mixins": [
|
2060
|
-
{
|
2061
|
-
"name": "AvatarComponentMixin",
|
2062
|
-
"module": "/src/utils/mixins/AvatarComponentMixin"
|
2063
|
-
},
|
2064
2064
|
{
|
2065
2065
|
"name": "IconNameMixin",
|
2066
2066
|
"module": "/src/utils/mixins/IconNameMixin"
|
2067
2067
|
}
|
2068
2068
|
],
|
2069
2069
|
"superclass": {
|
2070
|
-
"name": "
|
2071
|
-
"module": "/src/
|
2070
|
+
"name": "Component",
|
2071
|
+
"module": "/src/models"
|
2072
2072
|
},
|
2073
|
-
"tagName": "mdc-
|
2074
|
-
"jsDoc": "/**\n * The `mdc-
|
2073
|
+
"tagName": "mdc-badge",
|
2074
|
+
"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 */",
|
2075
2075
|
"customElement": true
|
2076
2076
|
}
|
2077
2077
|
],
|
@@ -2080,8 +2080,8 @@
|
|
2080
2080
|
"kind": "js",
|
2081
2081
|
"name": "default",
|
2082
2082
|
"declaration": {
|
2083
|
-
"name": "
|
2084
|
-
"module": "components/
|
2083
|
+
"name": "Badge",
|
2084
|
+
"module": "components/badge/badge.component.js"
|
2085
2085
|
}
|
2086
2086
|
}
|
2087
2087
|
]
|
@@ -2174,8 +2174,79 @@
|
|
2174
2174
|
"name": "Component",
|
2175
2175
|
"module": "/src/models"
|
2176
2176
|
},
|
2177
|
-
"tagName": "mdc-brandvisual",
|
2178
|
-
"jsDoc": "/**\n * The `mdc-brandvisual` component is responsible for rendering logos dynamically & ensures they are\n * displayed correctly within applications.\n *\n * Features:\n * - Dynamically loads brandvisuals based on the `name` attribute.\n * - Emits a `load` event when the brandvisual is successfully fetched.\n * - Emits an `error` event when the brandvisual import fails.\n * - Supports accessibility best practices.\n * - Used for brand representation within the design system.\n *\n * @tagname mdc-brandvisual\n *\n * @event load - (React: onLoad) This event is dispatched when the brandvisual has been successfully loaded.\n * @event error - (React: onError) This event is dispatched when the brandvisual fetching has failed.\n *\n */",
|
2177
|
+
"tagName": "mdc-brandvisual",
|
2178
|
+
"jsDoc": "/**\n * The `mdc-brandvisual` component is responsible for rendering logos dynamically & ensures they are\n * displayed correctly within applications.\n *\n * Features:\n * - Dynamically loads brandvisuals based on the `name` attribute.\n * - Emits a `load` event when the brandvisual is successfully fetched.\n * - Emits an `error` event when the brandvisual import fails.\n * - Supports accessibility best practices.\n * - Used for brand representation within the design system.\n *\n * @tagname mdc-brandvisual\n *\n * @event load - (React: onLoad) This event is dispatched when the brandvisual has been successfully loaded.\n * @event error - (React: onError) This event is dispatched when the brandvisual fetching has failed.\n *\n */",
|
2179
|
+
"customElement": true
|
2180
|
+
}
|
2181
|
+
],
|
2182
|
+
"exports": [
|
2183
|
+
{
|
2184
|
+
"kind": "js",
|
2185
|
+
"name": "default",
|
2186
|
+
"declaration": {
|
2187
|
+
"name": "Brandvisual",
|
2188
|
+
"module": "components/brandvisual/brandvisual.component.js"
|
2189
|
+
}
|
2190
|
+
}
|
2191
|
+
]
|
2192
|
+
},
|
2193
|
+
{
|
2194
|
+
"kind": "javascript-module",
|
2195
|
+
"path": "components/bullet/bullet.component.js",
|
2196
|
+
"declarations": [
|
2197
|
+
{
|
2198
|
+
"kind": "class",
|
2199
|
+
"description": "Bullet component, which is a visual marker\nand be used to organize and present items in a list format.",
|
2200
|
+
"name": "Bullet",
|
2201
|
+
"cssProperties": [
|
2202
|
+
{
|
2203
|
+
"description": "background color of the bullet",
|
2204
|
+
"name": "--mdc-bullet-background-color"
|
2205
|
+
},
|
2206
|
+
{
|
2207
|
+
"description": "small size value of the bullet",
|
2208
|
+
"name": "--mdc-bullet-size-small"
|
2209
|
+
},
|
2210
|
+
{
|
2211
|
+
"description": "medium size value of the bullet",
|
2212
|
+
"name": "--mdc-bullet-size-medium"
|
2213
|
+
},
|
2214
|
+
{
|
2215
|
+
"description": "large size value of the bullet",
|
2216
|
+
"name": "--mdc-bullet-size-large"
|
2217
|
+
}
|
2218
|
+
],
|
2219
|
+
"members": [
|
2220
|
+
{
|
2221
|
+
"kind": "field",
|
2222
|
+
"name": "size",
|
2223
|
+
"type": {
|
2224
|
+
"text": "Size"
|
2225
|
+
},
|
2226
|
+
"privacy": "public",
|
2227
|
+
"description": "Size of the bullet\n\nPossible values: 'small', 'medium', 'large'",
|
2228
|
+
"default": "small",
|
2229
|
+
"attribute": "size",
|
2230
|
+
"reflects": true
|
2231
|
+
}
|
2232
|
+
],
|
2233
|
+
"attributes": [
|
2234
|
+
{
|
2235
|
+
"name": "size",
|
2236
|
+
"type": {
|
2237
|
+
"text": "Size"
|
2238
|
+
},
|
2239
|
+
"description": "Size of the bullet\n\nPossible values: 'small', 'medium', 'large'",
|
2240
|
+
"default": "small",
|
2241
|
+
"fieldName": "size"
|
2242
|
+
}
|
2243
|
+
],
|
2244
|
+
"superclass": {
|
2245
|
+
"name": "Component",
|
2246
|
+
"module": "/src/models"
|
2247
|
+
},
|
2248
|
+
"tagName": "mdc-bullet",
|
2249
|
+
"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 */",
|
2179
2250
|
"customElement": true
|
2180
2251
|
}
|
2181
2252
|
],
|
@@ -2184,8 +2255,8 @@
|
|
2184
2255
|
"kind": "js",
|
2185
2256
|
"name": "default",
|
2186
2257
|
"declaration": {
|
2187
|
-
"name": "
|
2188
|
-
"module": "components/
|
2258
|
+
"name": "Bullet",
|
2259
|
+
"module": "components/bullet/bullet.component.js"
|
2189
2260
|
}
|
2190
2261
|
}
|
2191
2262
|
]
|
@@ -2887,61 +2958,122 @@
|
|
2887
2958
|
},
|
2888
2959
|
{
|
2889
2960
|
"kind": "javascript-module",
|
2890
|
-
"path": "components/
|
2961
|
+
"path": "components/buttongroup/buttongroup.component.js",
|
2891
2962
|
"declarations": [
|
2892
2963
|
{
|
2893
2964
|
"kind": "class",
|
2894
|
-
"description": "
|
2895
|
-
"name": "
|
2965
|
+
"description": "buttongroup component, is a styled wrapper for multiple buttons.\nIt can support icon buttons, combination of icon and pill buttons, and text buttons.\nThey are available in horizontal and vertical orientation.",
|
2966
|
+
"name": "ButtonGroup",
|
2896
2967
|
"cssProperties": [
|
2897
2968
|
{
|
2898
|
-
"description": "
|
2899
|
-
"name": "--mdc-
|
2969
|
+
"description": "The border radius of the buttongroup",
|
2970
|
+
"name": "--mdc-buttongroup-border-radius"
|
2900
2971
|
},
|
2901
2972
|
{
|
2902
|
-
"description": "
|
2903
|
-
"name": "--mdc-
|
2973
|
+
"description": "The border color of the buttongroup",
|
2974
|
+
"name": "--mdc-buttongroup-border-color"
|
2904
2975
|
},
|
2905
2976
|
{
|
2906
|
-
"description": "
|
2907
|
-
"name": "--mdc-
|
2908
|
-
}
|
2977
|
+
"description": "The color of the divider between buttons within the buttongroup",
|
2978
|
+
"name": "--mdc-buttongroup-divider-color"
|
2979
|
+
}
|
2980
|
+
],
|
2981
|
+
"slots": [
|
2909
2982
|
{
|
2910
|
-
"description": "
|
2911
|
-
"name": "
|
2983
|
+
"description": "This is a default/unnamed slot, which contains the buttons",
|
2984
|
+
"name": "default"
|
2912
2985
|
}
|
2913
2986
|
],
|
2914
2987
|
"members": [
|
2988
|
+
{
|
2989
|
+
"kind": "field",
|
2990
|
+
"name": "orientation",
|
2991
|
+
"type": {
|
2992
|
+
"text": "ButtonGroupOrientation"
|
2993
|
+
},
|
2994
|
+
"description": "Orientation of the buttongroup.",
|
2995
|
+
"default": "'horizontal'",
|
2996
|
+
"attribute": "orientation",
|
2997
|
+
"reflects": true
|
2998
|
+
},
|
2999
|
+
{
|
3000
|
+
"kind": "field",
|
3001
|
+
"name": "variant",
|
3002
|
+
"type": {
|
3003
|
+
"text": "ButtonGroupVariant"
|
3004
|
+
},
|
3005
|
+
"description": "Variant of the buttons within the buttongroup.",
|
3006
|
+
"default": "'primary'",
|
3007
|
+
"attribute": "variant",
|
3008
|
+
"reflects": true
|
3009
|
+
},
|
2915
3010
|
{
|
2916
3011
|
"kind": "field",
|
2917
3012
|
"name": "size",
|
2918
3013
|
"type": {
|
2919
|
-
"text": "
|
3014
|
+
"text": "ButtonGroupSize"
|
2920
3015
|
},
|
2921
|
-
"
|
2922
|
-
"
|
2923
|
-
"default": "small",
|
3016
|
+
"description": "Size of the buttons within the buttongroup.",
|
3017
|
+
"default": "'28'",
|
2924
3018
|
"attribute": "size",
|
2925
3019
|
"reflects": true
|
3020
|
+
},
|
3021
|
+
{
|
3022
|
+
"kind": "field",
|
3023
|
+
"name": "compact",
|
3024
|
+
"type": {
|
3025
|
+
"text": "boolean"
|
3026
|
+
},
|
3027
|
+
"default": "false",
|
3028
|
+
"description": "When this is true, the buttons within the buttongroup will be compact.\ni.e. Irrespective of the size of the buttons, they will have a height of 24px.",
|
3029
|
+
"attribute": "compact",
|
3030
|
+
"reflects": true
|
2926
3031
|
}
|
2927
3032
|
],
|
2928
3033
|
"attributes": [
|
3034
|
+
{
|
3035
|
+
"name": "orientation",
|
3036
|
+
"type": {
|
3037
|
+
"text": "ButtonGroupOrientation"
|
3038
|
+
},
|
3039
|
+
"description": "Orientation of the buttongroup.",
|
3040
|
+
"default": "'horizontal'",
|
3041
|
+
"fieldName": "orientation"
|
3042
|
+
},
|
3043
|
+
{
|
3044
|
+
"name": "variant",
|
3045
|
+
"type": {
|
3046
|
+
"text": "ButtonGroupVariant"
|
3047
|
+
},
|
3048
|
+
"description": "Variant of the buttons within the buttongroup.",
|
3049
|
+
"default": "'primary'",
|
3050
|
+
"fieldName": "variant"
|
3051
|
+
},
|
2929
3052
|
{
|
2930
3053
|
"name": "size",
|
2931
3054
|
"type": {
|
2932
|
-
"text": "
|
3055
|
+
"text": "ButtonGroupSize"
|
2933
3056
|
},
|
2934
|
-
"description": "Size of the
|
2935
|
-
"default": "
|
3057
|
+
"description": "Size of the buttons within the buttongroup.",
|
3058
|
+
"default": "'28'",
|
2936
3059
|
"fieldName": "size"
|
3060
|
+
},
|
3061
|
+
{
|
3062
|
+
"name": "compact",
|
3063
|
+
"type": {
|
3064
|
+
"text": "boolean"
|
3065
|
+
},
|
3066
|
+
"default": "false",
|
3067
|
+
"description": "When this is true, the buttons within the buttongroup will be compact.\ni.e. Irrespective of the size of the buttons, they will have a height of 24px.",
|
3068
|
+
"fieldName": "compact"
|
2937
3069
|
}
|
2938
3070
|
],
|
2939
3071
|
"superclass": {
|
2940
3072
|
"name": "Component",
|
2941
3073
|
"module": "/src/models"
|
2942
3074
|
},
|
2943
|
-
"tagName": "mdc-
|
2944
|
-
"jsDoc": "/**\n *
|
3075
|
+
"tagName": "mdc-buttongroup",
|
3076
|
+
"jsDoc": "/**\n * buttongroup component, is a styled wrapper for multiple buttons.\n * It can support icon buttons, combination of icon and pill buttons, and text buttons.\n * They are available in horizontal and vertical orientation.\n *\n * @tagname mdc-buttongroup\n *\n * @slot default - This is a default/unnamed slot, which contains the buttons\n *\n * @cssproperty --mdc-buttongroup-border-radius - The border radius of the buttongroup\n * @cssproperty --mdc-buttongroup-border-color - The border color of the buttongroup\n * @cssproperty --mdc-buttongroup-divider-color - The color of the divider between buttons within the buttongroup\n */",
|
2945
3077
|
"customElement": true
|
2946
3078
|
}
|
2947
3079
|
],
|
@@ -2950,8 +3082,8 @@
|
|
2950
3082
|
"kind": "js",
|
2951
3083
|
"name": "default",
|
2952
3084
|
"declaration": {
|
2953
|
-
"name": "
|
2954
|
-
"module": "components/
|
3085
|
+
"name": "ButtonGroup",
|
3086
|
+
"module": "components/buttongroup/buttongroup.component.js"
|
2955
3087
|
}
|
2956
3088
|
}
|
2957
3089
|
]
|
@@ -3549,146 +3681,14 @@
|
|
3549
3681
|
}
|
3550
3682
|
},
|
3551
3683
|
{
|
3552
|
-
"description": "Color of the inverted link’s child content in the normal state.",
|
3553
|
-
"name": "--mdc-link-inverted-color-normal",
|
3554
|
-
"inheritedFrom": {
|
3555
|
-
"name": "Linksimple",
|
3556
|
-
"module": "src/components/linksimple/linksimple.component.ts"
|
3557
|
-
}
|
3558
|
-
}
|
3559
|
-
]
|
3560
|
-
}
|
3561
|
-
],
|
3562
|
-
"exports": [
|
3563
|
-
{
|
3564
|
-
"kind": "js",
|
3565
|
-
"name": "default",
|
3566
|
-
"declaration": {
|
3567
|
-
"name": "ButtonLink",
|
3568
|
-
"module": "components/buttonlink/buttonlink.component.js"
|
3569
|
-
}
|
3570
|
-
}
|
3571
|
-
]
|
3572
|
-
},
|
3573
|
-
{
|
3574
|
-
"kind": "javascript-module",
|
3575
|
-
"path": "components/buttongroup/buttongroup.component.js",
|
3576
|
-
"declarations": [
|
3577
|
-
{
|
3578
|
-
"kind": "class",
|
3579
|
-
"description": "buttongroup component, is a styled wrapper for multiple buttons.\nIt can support icon buttons, combination of icon and pill buttons, and text buttons.\nThey are available in horizontal and vertical orientation.",
|
3580
|
-
"name": "ButtonGroup",
|
3581
|
-
"cssProperties": [
|
3582
|
-
{
|
3583
|
-
"description": "The border radius of the buttongroup",
|
3584
|
-
"name": "--mdc-buttongroup-border-radius"
|
3585
|
-
},
|
3586
|
-
{
|
3587
|
-
"description": "The border color of the buttongroup",
|
3588
|
-
"name": "--mdc-buttongroup-border-color"
|
3589
|
-
},
|
3590
|
-
{
|
3591
|
-
"description": "The color of the divider between buttons within the buttongroup",
|
3592
|
-
"name": "--mdc-buttongroup-divider-color"
|
3593
|
-
}
|
3594
|
-
],
|
3595
|
-
"slots": [
|
3596
|
-
{
|
3597
|
-
"description": "This is a default/unnamed slot, which contains the buttons",
|
3598
|
-
"name": "default"
|
3599
|
-
}
|
3600
|
-
],
|
3601
|
-
"members": [
|
3602
|
-
{
|
3603
|
-
"kind": "field",
|
3604
|
-
"name": "orientation",
|
3605
|
-
"type": {
|
3606
|
-
"text": "ButtonGroupOrientation"
|
3607
|
-
},
|
3608
|
-
"description": "Orientation of the buttongroup.",
|
3609
|
-
"default": "'horizontal'",
|
3610
|
-
"attribute": "orientation",
|
3611
|
-
"reflects": true
|
3612
|
-
},
|
3613
|
-
{
|
3614
|
-
"kind": "field",
|
3615
|
-
"name": "variant",
|
3616
|
-
"type": {
|
3617
|
-
"text": "ButtonGroupVariant"
|
3618
|
-
},
|
3619
|
-
"description": "Variant of the buttons within the buttongroup.",
|
3620
|
-
"default": "'primary'",
|
3621
|
-
"attribute": "variant",
|
3622
|
-
"reflects": true
|
3623
|
-
},
|
3624
|
-
{
|
3625
|
-
"kind": "field",
|
3626
|
-
"name": "size",
|
3627
|
-
"type": {
|
3628
|
-
"text": "ButtonGroupSize"
|
3629
|
-
},
|
3630
|
-
"description": "Size of the buttons within the buttongroup.",
|
3631
|
-
"default": "'28'",
|
3632
|
-
"attribute": "size",
|
3633
|
-
"reflects": true
|
3634
|
-
},
|
3635
|
-
{
|
3636
|
-
"kind": "field",
|
3637
|
-
"name": "compact",
|
3638
|
-
"type": {
|
3639
|
-
"text": "boolean"
|
3640
|
-
},
|
3641
|
-
"default": "false",
|
3642
|
-
"description": "When this is true, the buttons within the buttongroup will be compact.\ni.e. Irrespective of the size of the buttons, they will have a height of 24px.",
|
3643
|
-
"attribute": "compact",
|
3644
|
-
"reflects": true
|
3645
|
-
}
|
3646
|
-
],
|
3647
|
-
"attributes": [
|
3648
|
-
{
|
3649
|
-
"name": "orientation",
|
3650
|
-
"type": {
|
3651
|
-
"text": "ButtonGroupOrientation"
|
3652
|
-
},
|
3653
|
-
"description": "Orientation of the buttongroup.",
|
3654
|
-
"default": "'horizontal'",
|
3655
|
-
"fieldName": "orientation"
|
3656
|
-
},
|
3657
|
-
{
|
3658
|
-
"name": "variant",
|
3659
|
-
"type": {
|
3660
|
-
"text": "ButtonGroupVariant"
|
3661
|
-
},
|
3662
|
-
"description": "Variant of the buttons within the buttongroup.",
|
3663
|
-
"default": "'primary'",
|
3664
|
-
"fieldName": "variant"
|
3665
|
-
},
|
3666
|
-
{
|
3667
|
-
"name": "size",
|
3668
|
-
"type": {
|
3669
|
-
"text": "ButtonGroupSize"
|
3670
|
-
},
|
3671
|
-
"description": "Size of the buttons within the buttongroup.",
|
3672
|
-
"default": "'28'",
|
3673
|
-
"fieldName": "size"
|
3674
|
-
},
|
3675
|
-
{
|
3676
|
-
"name": "compact",
|
3677
|
-
"type": {
|
3678
|
-
"text": "boolean"
|
3679
|
-
},
|
3680
|
-
"default": "false",
|
3681
|
-
"description": "When this is true, the buttons within the buttongroup will be compact.\ni.e. Irrespective of the size of the buttons, they will have a height of 24px.",
|
3682
|
-
"fieldName": "compact"
|
3683
|
-
}
|
3684
|
-
],
|
3685
|
-
"superclass": {
|
3686
|
-
"name": "Component",
|
3687
|
-
"module": "/src/models"
|
3688
|
-
},
|
3689
|
-
"tagName": "mdc-buttongroup",
|
3690
|
-
"jsDoc": "/**\n * buttongroup component, is a styled wrapper for multiple buttons.\n * It can support icon buttons, combination of icon and pill buttons, and text buttons.\n * They are available in horizontal and vertical orientation.\n *\n * @tagname mdc-buttongroup\n *\n * @slot default - This is a default/unnamed slot, which contains the buttons\n *\n * @cssproperty --mdc-buttongroup-border-radius - The border radius of the buttongroup\n * @cssproperty --mdc-buttongroup-border-color - The border color of the buttongroup\n * @cssproperty --mdc-buttongroup-divider-color - The color of the divider between buttons within the buttongroup\n */",
|
3691
|
-
"customElement": true
|
3684
|
+
"description": "Color of the inverted link’s child content in the normal state.",
|
3685
|
+
"name": "--mdc-link-inverted-color-normal",
|
3686
|
+
"inheritedFrom": {
|
3687
|
+
"name": "Linksimple",
|
3688
|
+
"module": "src/components/linksimple/linksimple.component.ts"
|
3689
|
+
}
|
3690
|
+
}
|
3691
|
+
]
|
3692
3692
|
}
|
3693
3693
|
],
|
3694
3694
|
"exports": [
|
@@ -3696,8 +3696,8 @@
|
|
3696
3696
|
"kind": "js",
|
3697
3697
|
"name": "default",
|
3698
3698
|
"declaration": {
|
3699
|
-
"name": "
|
3700
|
-
"module": "components/
|
3699
|
+
"name": "ButtonLink",
|
3700
|
+
"module": "components/buttonlink/buttonlink.component.js"
|
3701
3701
|
}
|
3702
3702
|
}
|
3703
3703
|
]
|
@@ -14642,6 +14642,129 @@
|
|
14642
14642
|
}
|
14643
14643
|
]
|
14644
14644
|
},
|
14645
|
+
{
|
14646
|
+
"kind": "javascript-module",
|
14647
|
+
"path": "components/listheader/listheader.component.js",
|
14648
|
+
"declarations": [
|
14649
|
+
{
|
14650
|
+
"kind": "class",
|
14651
|
+
"description": "Listheader component is used to display a header in a list.\nIt can include icons before and after the header text, and allows for additional content via slots.",
|
14652
|
+
"name": "Listheader",
|
14653
|
+
"cssProperties": [
|
14654
|
+
{
|
14655
|
+
"description": "height of the header",
|
14656
|
+
"name": "--mdc-listheader-height"
|
14657
|
+
},
|
14658
|
+
{
|
14659
|
+
"description": "padding around the header content",
|
14660
|
+
"name": "--mdc-listheader-padding"
|
14661
|
+
},
|
14662
|
+
{
|
14663
|
+
"description": "gap between content",
|
14664
|
+
"name": "--mdc-listheader-gap"
|
14665
|
+
}
|
14666
|
+
],
|
14667
|
+
"slots": [
|
14668
|
+
{
|
14669
|
+
"description": "to pass in actionable content like buttons or links",
|
14670
|
+
"name": "default"
|
14671
|
+
}
|
14672
|
+
],
|
14673
|
+
"members": [
|
14674
|
+
{
|
14675
|
+
"kind": "field",
|
14676
|
+
"name": "prefixIcon",
|
14677
|
+
"type": {
|
14678
|
+
"text": "IconNames | undefined"
|
14679
|
+
},
|
14680
|
+
"description": "Name of the icon rendered before the text\n\nIf not provided, no icon will be rendered and text will be aligned to the start.",
|
14681
|
+
"attribute": "prefix-icon"
|
14682
|
+
},
|
14683
|
+
{
|
14684
|
+
"kind": "field",
|
14685
|
+
"name": "postfixIcon",
|
14686
|
+
"type": {
|
14687
|
+
"text": "IconNames | undefined"
|
14688
|
+
},
|
14689
|
+
"description": "Name of the icon rendered after the slot & text\n\nIf not provided, no icon will be rendered and content will be aligned to the end.",
|
14690
|
+
"attribute": "postfix-icon"
|
14691
|
+
},
|
14692
|
+
{
|
14693
|
+
"kind": "field",
|
14694
|
+
"name": "headerText",
|
14695
|
+
"type": {
|
14696
|
+
"text": "string | undefined"
|
14697
|
+
},
|
14698
|
+
"description": "Text to be rendered in the header",
|
14699
|
+
"attribute": "header-text"
|
14700
|
+
},
|
14701
|
+
{
|
14702
|
+
"kind": "field",
|
14703
|
+
"name": "disabled",
|
14704
|
+
"type": {
|
14705
|
+
"text": "boolean"
|
14706
|
+
},
|
14707
|
+
"default": "false",
|
14708
|
+
"description": "Disables the header, making it visually styled as disabled.\n\nNOTE: slot content will still be interactive unless individually disabled.\nMake sure to handle the disabled state of any actionable elements inside the slot.",
|
14709
|
+
"attribute": "disabled",
|
14710
|
+
"reflects": true
|
14711
|
+
}
|
14712
|
+
],
|
14713
|
+
"attributes": [
|
14714
|
+
{
|
14715
|
+
"name": "prefix-icon",
|
14716
|
+
"type": {
|
14717
|
+
"text": "IconNames | undefined"
|
14718
|
+
},
|
14719
|
+
"description": "Name of the icon rendered before the text\n\nIf not provided, no icon will be rendered and text will be aligned to the start.",
|
14720
|
+
"fieldName": "prefixIcon"
|
14721
|
+
},
|
14722
|
+
{
|
14723
|
+
"name": "postfix-icon",
|
14724
|
+
"type": {
|
14725
|
+
"text": "IconNames | undefined"
|
14726
|
+
},
|
14727
|
+
"description": "Name of the icon rendered after the slot & text\n\nIf not provided, no icon will be rendered and content will be aligned to the end.",
|
14728
|
+
"fieldName": "postfixIcon"
|
14729
|
+
},
|
14730
|
+
{
|
14731
|
+
"name": "header-text",
|
14732
|
+
"type": {
|
14733
|
+
"text": "string | undefined"
|
14734
|
+
},
|
14735
|
+
"description": "Text to be rendered in the header",
|
14736
|
+
"fieldName": "headerText"
|
14737
|
+
},
|
14738
|
+
{
|
14739
|
+
"name": "disabled",
|
14740
|
+
"type": {
|
14741
|
+
"text": "boolean"
|
14742
|
+
},
|
14743
|
+
"default": "false",
|
14744
|
+
"description": "Disables the header, making it visually styled as disabled.\n\nNOTE: slot content will still be interactive unless individually disabled.\nMake sure to handle the disabled state of any actionable elements inside the slot.",
|
14745
|
+
"fieldName": "disabled"
|
14746
|
+
}
|
14747
|
+
],
|
14748
|
+
"superclass": {
|
14749
|
+
"name": "Component",
|
14750
|
+
"module": "/src/models"
|
14751
|
+
},
|
14752
|
+
"tagName": "mdc-listheader",
|
14753
|
+
"jsDoc": "/**\n * Listheader component is used to display a header in a list.\n * It can include icons before and after the header text, and allows for additional content via slots.\n *\n * @tagname mdc-listheader\n *\n * @slot default - to pass in actionable content like buttons or links\n *\n * @cssproperty --mdc-listheader-height - height of the header\n * @cssproperty --mdc-listheader-padding - padding around the header content\n * @cssproperty --mdc-listheader-gap - gap between content\n */",
|
14754
|
+
"customElement": true
|
14755
|
+
}
|
14756
|
+
],
|
14757
|
+
"exports": [
|
14758
|
+
{
|
14759
|
+
"kind": "js",
|
14760
|
+
"name": "default",
|
14761
|
+
"declaration": {
|
14762
|
+
"name": "Listheader",
|
14763
|
+
"module": "components/listheader/listheader.component.js"
|
14764
|
+
}
|
14765
|
+
}
|
14766
|
+
]
|
14767
|
+
},
|
14645
14768
|
{
|
14646
14769
|
"kind": "javascript-module",
|
14647
14770
|
"path": "components/listitem/listitem.component.js",
|
@@ -15541,15 +15664,15 @@
|
|
15541
15664
|
},
|
15542
15665
|
{
|
15543
15666
|
"kind": "javascript-module",
|
15544
|
-
"path": "components/
|
15667
|
+
"path": "components/menuitemcheckbox/menuitemcheckbox.component.js",
|
15545
15668
|
"declarations": [
|
15546
15669
|
{
|
15547
15670
|
"kind": "class",
|
15548
|
-
"description": "
|
15549
|
-
"name": "
|
15671
|
+
"description": "A menuitemcheckbox component is a checkable menuitem.\nThere should be no focusable descendants inside this menuitemcheckbox component.\n\nThe `checked` attribute indicates whether the menuitemcheckbox is checked or not.\n\nMenu item checkbox has `name` and `value` attribute that can be used to identify the menu item when it is selected.\n\nThe `indicator` attribute is used to differentiate between <b>checkbox</b>, <b>checkmark</b>, <b>toggle</b> and <b>none</b>.\nBy default, the `indicator` is set to <b>checkbox</b>.<br/>\n\nThe checkbox will always be positioned on the leading side of the menuitem label and\nthe toggle and checkmark will always be positioned on the trailing side.\n\nThe checkbox will have the possible states of `true` or `false`.\nIf the indicator is set to <b>checkmark</b> and if the `checked` attribute is set to `true`,\nthen the checkmark will be displayed. if not, then no indicator will be displayed.\n\nThe forth options for the `indicator` is <b>none</b>, which will not display any indicator at all.\nIt is intended to be used for customised menu items where the indicator is implemented differently.\nFor example, you can use a custom icon or a different visual element to indicate the state of the menu item.\nMake sure the new indicator is accessible.\n\nIf you want only one item in a group to be checked, consider using menuitemradio component.",
|
15672
|
+
"name": "MenuItemCheckbox",
|
15550
15673
|
"slots": [
|
15551
15674
|
{
|
15552
|
-
"description": "slot for menu item controls to appear of leading end.",
|
15675
|
+
"description": "slot for menu item checkbox controls to appear of leading end.",
|
15553
15676
|
"name": "leading-controls",
|
15554
15677
|
"inheritedFrom": {
|
15555
15678
|
"name": "ListItem",
|
@@ -15557,7 +15680,7 @@
|
|
15557
15680
|
}
|
15558
15681
|
},
|
15559
15682
|
{
|
15560
|
-
"description": "slot for menu item primary label.",
|
15683
|
+
"description": "slot for menu item checkbox primary label.",
|
15561
15684
|
"name": "leading-text-primary-label",
|
15562
15685
|
"inheritedFrom": {
|
15563
15686
|
"name": "ListItem",
|
@@ -15565,7 +15688,7 @@
|
|
15565
15688
|
}
|
15566
15689
|
},
|
15567
15690
|
{
|
15568
|
-
"description": "slot for menu item secondary label.",
|
15691
|
+
"description": "slot for menu item checkbox secondary label.",
|
15569
15692
|
"name": "leading-text-secondary-label",
|
15570
15693
|
"inheritedFrom": {
|
15571
15694
|
"name": "ListItem",
|
@@ -15573,7 +15696,7 @@
|
|
15573
15696
|
}
|
15574
15697
|
},
|
15575
15698
|
{
|
15576
|
-
"description": "slot for menu item tertiary label.",
|
15699
|
+
"description": "slot for menu item checkbox tertiary label.",
|
15577
15700
|
"name": "leading-text-tertiary-label",
|
15578
15701
|
"inheritedFrom": {
|
15579
15702
|
"name": "ListItem",
|
@@ -15581,7 +15704,7 @@
|
|
15581
15704
|
}
|
15582
15705
|
},
|
15583
15706
|
{
|
15584
|
-
"description": "slot for menu item side header text.",
|
15707
|
+
"description": "slot for menu item checkbox side header text.",
|
15585
15708
|
"name": "trailing-text-side-header",
|
15586
15709
|
"inheritedFrom": {
|
15587
15710
|
"name": "ListItem",
|
@@ -15589,7 +15712,7 @@
|
|
15589
15712
|
}
|
15590
15713
|
},
|
15591
15714
|
{
|
15592
|
-
"description": "slot for menu item subline text.",
|
15715
|
+
"description": "slot for menu item checkbox subline text.",
|
15593
15716
|
"name": "trailing-text-subline",
|
15594
15717
|
"inheritedFrom": {
|
15595
15718
|
"name": "ListItem",
|
@@ -15597,7 +15720,7 @@
|
|
15597
15720
|
}
|
15598
15721
|
},
|
15599
15722
|
{
|
15600
|
-
"description": "slot for menu item controls to appear of trailing end.",
|
15723
|
+
"description": "slot for menu item checkbox controls to appear of trailing end.",
|
15601
15724
|
"name": "trailing-controls",
|
15602
15725
|
"inheritedFrom": {
|
15603
15726
|
"name": "ListItem",
|
@@ -15606,6 +15729,67 @@
|
|
15606
15729
|
}
|
15607
15730
|
],
|
15608
15731
|
"members": [
|
15732
|
+
{
|
15733
|
+
"kind": "field",
|
15734
|
+
"name": "checked",
|
15735
|
+
"type": {
|
15736
|
+
"text": "boolean"
|
15737
|
+
},
|
15738
|
+
"default": "false",
|
15739
|
+
"description": "The checked attribute is used to indicate that the menuitemcheckbox is checked or not.",
|
15740
|
+
"attribute": "checked",
|
15741
|
+
"reflects": true
|
15742
|
+
},
|
15743
|
+
{
|
15744
|
+
"kind": "field",
|
15745
|
+
"name": "indicator",
|
15746
|
+
"type": {
|
15747
|
+
"text": "Indicator"
|
15748
|
+
},
|
15749
|
+
"description": "The indicator attribute is used to differentiate between <b>checkbox</b> and <b>toggle</b>.",
|
15750
|
+
"default": "'checkbox'",
|
15751
|
+
"attribute": "indicator",
|
15752
|
+
"reflects": true
|
15753
|
+
},
|
15754
|
+
{
|
15755
|
+
"kind": "field",
|
15756
|
+
"name": "handleMouseClick",
|
15757
|
+
"privacy": "private",
|
15758
|
+
"description": "Handles click events to toggle checked state\nIf the menuitemcheckbox is disabled, it does nothing.\nIf the menuitemcheckbox is not disabled, it toggles the `checked` state between `true` and `false`."
|
15759
|
+
},
|
15760
|
+
{
|
15761
|
+
"kind": "method",
|
15762
|
+
"name": "staticCheckbox",
|
15763
|
+
"privacy": "private",
|
15764
|
+
"return": {
|
15765
|
+
"type": {
|
15766
|
+
"text": ""
|
15767
|
+
}
|
15768
|
+
},
|
15769
|
+
"description": "Returns a static checkbox element if the indicator is set to checkbox.\nIf the indicator is not set to checkbox, it returns nothing."
|
15770
|
+
},
|
15771
|
+
{
|
15772
|
+
"kind": "method",
|
15773
|
+
"name": "staticToggle",
|
15774
|
+
"privacy": "private",
|
15775
|
+
"return": {
|
15776
|
+
"type": {
|
15777
|
+
"text": ""
|
15778
|
+
}
|
15779
|
+
},
|
15780
|
+
"description": "Returns a static toggle element if the indicator is set to toggle.\nIf the indicator is not set to toggle, it returns nothing.\n\nThe toggle will always be positioned on the trailing side of the menuitem label."
|
15781
|
+
},
|
15782
|
+
{
|
15783
|
+
"kind": "method",
|
15784
|
+
"name": "getCheckmarkIcon",
|
15785
|
+
"privacy": "private",
|
15786
|
+
"return": {
|
15787
|
+
"type": {
|
15788
|
+
"text": ""
|
15789
|
+
}
|
15790
|
+
},
|
15791
|
+
"description": "Returns a checkmark icon if the indicator is set to checkmark and the checked state is true.\nIf the indicator is not set to checkmark or the checked state is false, it returns nothing.\n\nThe checkmark icon will always be positioned on the trailing side of the menuitem label."
|
15792
|
+
},
|
15609
15793
|
{
|
15610
15794
|
"kind": "field",
|
15611
15795
|
"name": "arrowPosition",
|
@@ -15614,7 +15798,11 @@
|
|
15614
15798
|
},
|
15615
15799
|
"description": "Defines where the arrow icon will appear.\n- `'leading'`: Icon appears on the leading edge (start).\n- `'trailing'`: Icon appears on the trailing edge (end).\n\nIf not set, no arrow is displayed.",
|
15616
15800
|
"attribute": "arrow-position",
|
15617
|
-
"reflects": true
|
15801
|
+
"reflects": true,
|
15802
|
+
"inheritedFrom": {
|
15803
|
+
"name": "MenuItem",
|
15804
|
+
"module": "components/menuitem/menuitem.component.js"
|
15805
|
+
}
|
15618
15806
|
},
|
15619
15807
|
{
|
15620
15808
|
"kind": "field",
|
@@ -15624,7 +15812,11 @@
|
|
15624
15812
|
},
|
15625
15813
|
"description": "Defines the direction the arrow icon points.\n- `'positive'`: Arrow points toward the trailing side.\n- `'negative'`: Arrow points toward the leading side.",
|
15626
15814
|
"attribute": "arrow-direction",
|
15627
|
-
"reflects": true
|
15815
|
+
"reflects": true,
|
15816
|
+
"inheritedFrom": {
|
15817
|
+
"name": "MenuItem",
|
15818
|
+
"module": "components/menuitem/menuitem.component.js"
|
15819
|
+
}
|
15628
15820
|
},
|
15629
15821
|
{
|
15630
15822
|
"kind": "field",
|
@@ -15635,7 +15827,11 @@
|
|
15635
15827
|
"default": "undefined",
|
15636
15828
|
"description": "The name attribute is used to identify the menu item when it is selected.",
|
15637
15829
|
"attribute": "name",
|
15638
|
-
"reflects": true
|
15830
|
+
"reflects": true,
|
15831
|
+
"inheritedFrom": {
|
15832
|
+
"name": "MenuItem",
|
15833
|
+
"module": "components/menuitem/menuitem.component.js"
|
15834
|
+
}
|
15639
15835
|
},
|
15640
15836
|
{
|
15641
15837
|
"kind": "field",
|
@@ -15646,7 +15842,11 @@
|
|
15646
15842
|
"default": "undefined",
|
15647
15843
|
"description": "The value attribute is used to represent a value when the menu item is selected.\nIt is typically used with checkbox and radio menu items, but can be handy for any menu item.",
|
15648
15844
|
"attribute": "value",
|
15649
|
-
"reflects": true
|
15845
|
+
"reflects": true,
|
15846
|
+
"inheritedFrom": {
|
15847
|
+
"name": "MenuItem",
|
15848
|
+
"module": "components/menuitem/menuitem.component.js"
|
15849
|
+
}
|
15650
15850
|
},
|
15651
15851
|
{
|
15652
15852
|
"kind": "method",
|
@@ -15690,7 +15890,11 @@
|
|
15690
15890
|
"description": "The keyboard event that triggered the action."
|
15691
15891
|
}
|
15692
15892
|
],
|
15693
|
-
"description": "Handles the keyup event for the menu item.\nIf the Space key is released, it triggers a click event on the menu item.\nThis allows keyboard users to activate the menu item using the Space key.\nIt also prevents the default action of the Space key to avoid scrolling the page."
|
15893
|
+
"description": "Handles the keyup event for the menu item.\nIf the Space key is released, it triggers a click event on the menu item.\nThis allows keyboard users to activate the menu item using the Space key.\nIt also prevents the default action of the Space key to avoid scrolling the page.",
|
15894
|
+
"inheritedFrom": {
|
15895
|
+
"name": "MenuItem",
|
15896
|
+
"module": "components/menuitem/menuitem.component.js"
|
15897
|
+
}
|
15694
15898
|
},
|
15695
15899
|
{
|
15696
15900
|
"kind": "method",
|
@@ -16027,7 +16231,12 @@
|
|
16027
16231
|
],
|
16028
16232
|
"events": [
|
16029
16233
|
{
|
16030
|
-
"description": "(React:
|
16234
|
+
"description": "(React: onChange) This event is dispatched when the menuitemcheckbox changes.",
|
16235
|
+
"name": "change",
|
16236
|
+
"reactName": "onChange"
|
16237
|
+
},
|
16238
|
+
{
|
16239
|
+
"description": "(React: onClick) This event is dispatched when the menuitemcheckbox is clicked.",
|
16031
16240
|
"name": "click",
|
16032
16241
|
"reactName": "onClick",
|
16033
16242
|
"inheritedFrom": {
|
@@ -16035,6 +16244,15 @@
|
|
16035
16244
|
"module": "src/components/listitem/listitem.component.ts"
|
16036
16245
|
}
|
16037
16246
|
},
|
16247
|
+
{
|
16248
|
+
"description": "(React: onFocus) This event is dispatched when the menuitemcheckbox receives focus.",
|
16249
|
+
"name": "focus",
|
16250
|
+
"reactName": "onFocus",
|
16251
|
+
"inheritedFrom": {
|
16252
|
+
"name": "ListItem",
|
16253
|
+
"module": "src/components/listitem/listitem.component.ts"
|
16254
|
+
}
|
16255
|
+
},
|
16038
16256
|
{
|
16039
16257
|
"description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the menuitem.",
|
16040
16258
|
"name": "keydown",
|
@@ -16052,25 +16270,38 @@
|
|
16052
16270
|
"name": "ListItem",
|
16053
16271
|
"module": "src/components/listitem/listitem.component.ts"
|
16054
16272
|
}
|
16273
|
+
}
|
16274
|
+
],
|
16275
|
+
"attributes": [
|
16276
|
+
{
|
16277
|
+
"name": "checked",
|
16278
|
+
"type": {
|
16279
|
+
"text": "boolean"
|
16280
|
+
},
|
16281
|
+
"default": "false",
|
16282
|
+
"description": "The checked attribute is used to indicate that the menuitemcheckbox is checked or not.",
|
16283
|
+
"fieldName": "checked"
|
16284
|
+
},
|
16285
|
+
{
|
16286
|
+
"name": "indicator",
|
16287
|
+
"type": {
|
16288
|
+
"text": "Indicator"
|
16289
|
+
},
|
16290
|
+
"description": "The indicator attribute is used to differentiate between <b>checkbox</b> and <b>toggle</b>.",
|
16291
|
+
"default": "'checkbox'",
|
16292
|
+
"fieldName": "indicator"
|
16055
16293
|
},
|
16056
|
-
{
|
16057
|
-
"description": "(React: onFocus) This event is dispatched when the menuitem receives focus.",
|
16058
|
-
"name": "focus",
|
16059
|
-
"reactName": "onFocus",
|
16060
|
-
"inheritedFrom": {
|
16061
|
-
"name": "ListItem",
|
16062
|
-
"module": "src/components/listitem/listitem.component.ts"
|
16063
|
-
}
|
16064
|
-
}
|
16065
|
-
],
|
16066
|
-
"attributes": [
|
16067
16294
|
{
|
16068
16295
|
"name": "arrow-position",
|
16069
16296
|
"type": {
|
16070
16297
|
"text": "ArrowPositions | undefined"
|
16071
16298
|
},
|
16072
16299
|
"description": "Defines where the arrow icon will appear.\n- `'leading'`: Icon appears on the leading edge (start).\n- `'trailing'`: Icon appears on the trailing edge (end).\n\nIf not set, no arrow is displayed.",
|
16073
|
-
"fieldName": "arrowPosition"
|
16300
|
+
"fieldName": "arrowPosition",
|
16301
|
+
"inheritedFrom": {
|
16302
|
+
"name": "MenuItem",
|
16303
|
+
"module": "src/components/menuitem/menuitem.component.ts"
|
16304
|
+
}
|
16074
16305
|
},
|
16075
16306
|
{
|
16076
16307
|
"name": "arrow-direction",
|
@@ -16078,7 +16309,11 @@
|
|
16078
16309
|
"text": "ArrowDirections | undefined"
|
16079
16310
|
},
|
16080
16311
|
"description": "Defines the direction the arrow icon points.\n- `'positive'`: Arrow points toward the trailing side.\n- `'negative'`: Arrow points toward the leading side.",
|
16081
|
-
"fieldName": "arrowDirection"
|
16312
|
+
"fieldName": "arrowDirection",
|
16313
|
+
"inheritedFrom": {
|
16314
|
+
"name": "MenuItem",
|
16315
|
+
"module": "src/components/menuitem/menuitem.component.ts"
|
16316
|
+
}
|
16082
16317
|
},
|
16083
16318
|
{
|
16084
16319
|
"name": "name",
|
@@ -16087,7 +16322,11 @@
|
|
16087
16322
|
},
|
16088
16323
|
"default": "undefined",
|
16089
16324
|
"description": "The name attribute is used to identify the menu item when it is selected.",
|
16090
|
-
"fieldName": "name"
|
16325
|
+
"fieldName": "name",
|
16326
|
+
"inheritedFrom": {
|
16327
|
+
"name": "MenuItem",
|
16328
|
+
"module": "src/components/menuitem/menuitem.component.ts"
|
16329
|
+
}
|
16091
16330
|
},
|
16092
16331
|
{
|
16093
16332
|
"name": "value",
|
@@ -16096,7 +16335,11 @@
|
|
16096
16335
|
},
|
16097
16336
|
"default": "undefined",
|
16098
16337
|
"description": "The value attribute is used to represent a value when the menu item is selected.\nIt is typically used with checkbox and radio menu items, but can be handy for any menu item.",
|
16099
|
-
"fieldName": "value"
|
16338
|
+
"fieldName": "value",
|
16339
|
+
"inheritedFrom": {
|
16340
|
+
"name": "MenuItem",
|
16341
|
+
"module": "src/components/menuitem/menuitem.component.ts"
|
16342
|
+
}
|
16100
16343
|
},
|
16101
16344
|
{
|
16102
16345
|
"name": "disabled",
|
@@ -16237,11 +16480,11 @@
|
|
16237
16480
|
}
|
16238
16481
|
],
|
16239
16482
|
"superclass": {
|
16240
|
-
"name": "
|
16241
|
-
"module": "/src/components/
|
16483
|
+
"name": "MenuItem",
|
16484
|
+
"module": "/src/components/menuitem/menuitem.component"
|
16242
16485
|
},
|
16243
|
-
"tagName": "mdc-
|
16244
|
-
"jsDoc": "/**\n *
|
16486
|
+
"tagName": "mdc-menuitemcheckbox",
|
16487
|
+
"jsDoc": "/**\n * A menuitemcheckbox component is a checkable menuitem.\n * There should be no focusable descendants inside this menuitemcheckbox component.\n *\n * The `checked` attribute indicates whether the menuitemcheckbox is checked or not.\n *\n * Menu item checkbox has `name` and `value` attribute that can be used to identify the menu item when it is selected.\n *\n * The `indicator` attribute is used to differentiate between <b>checkbox</b>, <b>checkmark</b>, <b>toggle</b> and <b>none</b>.\n * By default, the `indicator` is set to <b>checkbox</b>.<br/>\n *\n * The checkbox will always be positioned on the leading side of the menuitem label and\n * the toggle and checkmark will always be positioned on the trailing side.\n *\n * The checkbox will have the possible states of `true` or `false`.\n * If the indicator is set to <b>checkmark</b> and if the `checked` attribute is set to `true`,\n * then the checkmark will be displayed. if not, then no indicator will be displayed.\n *\n * The forth options for the `indicator` is <b>none</b>, which will not display any indicator at all.\n * It is intended to be used for customised menu items where the indicator is implemented differently.\n * For example, you can use a custom icon or a different visual element to indicate the state of the menu item.\n * Make sure the new indicator is accessible.\n *\n * If you want only one item in a group to be checked, consider using menuitemradio component.\n *\n * @dependency mdc-staticcheckbox\n * @dependency mdc-statictoggle\n * @dependency mdc-icon\n *\n * @tagname mdc-menuitemcheckbox\n *\n * @slot leading-controls - slot for menu item checkbox controls to appear of leading end.\n * @slot leading-text-primary-label - slot for menu item checkbox primary label.\n * @slot leading-text-secondary-label - slot for menu item checkbox secondary label.\n * @slot leading-text-tertiary-label - slot for menu item checkbox tertiary label.\n * @slot trailing-text-side-header - slot for menu item checkbox side header text.\n * @slot trailing-text-subline - slot for menu item checkbox subline text.\n * @slot trailing-controls - slot for menu item checkbox controls to appear of trailing end.\n *\n * @event change - (React: onChange) This event is dispatched when the menuitemcheckbox changes.\n * @event click - (React: onClick) This event is dispatched when the menuitemcheckbox is clicked.\n * @event focus - (React: onFocus) This event is dispatched when the menuitemcheckbox receives focus.\n */",
|
16245
16488
|
"customElement": true,
|
16246
16489
|
"cssProperties": [
|
16247
16490
|
{
|
@@ -16316,23 +16559,23 @@
|
|
16316
16559
|
"kind": "js",
|
16317
16560
|
"name": "default",
|
16318
16561
|
"declaration": {
|
16319
|
-
"name": "
|
16320
|
-
"module": "components/
|
16562
|
+
"name": "MenuItemCheckbox",
|
16563
|
+
"module": "components/menuitemcheckbox/menuitemcheckbox.component.js"
|
16321
16564
|
}
|
16322
16565
|
}
|
16323
16566
|
]
|
16324
16567
|
},
|
16325
16568
|
{
|
16326
16569
|
"kind": "javascript-module",
|
16327
|
-
"path": "components/
|
16570
|
+
"path": "components/menuitem/menuitem.component.js",
|
16328
16571
|
"declarations": [
|
16329
16572
|
{
|
16330
16573
|
"kind": "class",
|
16331
|
-
"description": "
|
16332
|
-
"name": "
|
16574
|
+
"description": "menuitem component is inherited by listitem component with the role set `menuitem`.<br/>\nA menu item can contain an icon on the leading or trailing side.\n\nThe leading and trailing slots can be used to display controls and text.<br/>\nBased on the leading/trailing slot, the position of the controls and text can be adjusted.\n\nPlease use element with role=menu as a parent element even when there is only menuitem for a11y purpose.\nFor example mdc-menupopover or mdc-menubar.\n\nMenu item has `name` and `value` attribute that can be used to identify the menu item when it is selected.",
|
16575
|
+
"name": "MenuItem",
|
16333
16576
|
"slots": [
|
16334
16577
|
{
|
16335
|
-
"description": "slot for menu item
|
16578
|
+
"description": "slot for menu item controls to appear of leading end.",
|
16336
16579
|
"name": "leading-controls",
|
16337
16580
|
"inheritedFrom": {
|
16338
16581
|
"name": "ListItem",
|
@@ -16340,7 +16583,7 @@
|
|
16340
16583
|
}
|
16341
16584
|
},
|
16342
16585
|
{
|
16343
|
-
"description": "slot for menu item
|
16586
|
+
"description": "slot for menu item primary label.",
|
16344
16587
|
"name": "leading-text-primary-label",
|
16345
16588
|
"inheritedFrom": {
|
16346
16589
|
"name": "ListItem",
|
@@ -16348,7 +16591,7 @@
|
|
16348
16591
|
}
|
16349
16592
|
},
|
16350
16593
|
{
|
16351
|
-
"description": "slot for menu item
|
16594
|
+
"description": "slot for menu item secondary label.",
|
16352
16595
|
"name": "leading-text-secondary-label",
|
16353
16596
|
"inheritedFrom": {
|
16354
16597
|
"name": "ListItem",
|
@@ -16356,7 +16599,7 @@
|
|
16356
16599
|
}
|
16357
16600
|
},
|
16358
16601
|
{
|
16359
|
-
"description": "slot for menu item
|
16602
|
+
"description": "slot for menu item tertiary label.",
|
16360
16603
|
"name": "leading-text-tertiary-label",
|
16361
16604
|
"inheritedFrom": {
|
16362
16605
|
"name": "ListItem",
|
@@ -16364,7 +16607,7 @@
|
|
16364
16607
|
}
|
16365
16608
|
},
|
16366
16609
|
{
|
16367
|
-
"description": "slot for menu item
|
16610
|
+
"description": "slot for menu item side header text.",
|
16368
16611
|
"name": "trailing-text-side-header",
|
16369
16612
|
"inheritedFrom": {
|
16370
16613
|
"name": "ListItem",
|
@@ -16372,7 +16615,7 @@
|
|
16372
16615
|
}
|
16373
16616
|
},
|
16374
16617
|
{
|
16375
|
-
"description": "slot for menu item
|
16618
|
+
"description": "slot for menu item subline text.",
|
16376
16619
|
"name": "trailing-text-subline",
|
16377
16620
|
"inheritedFrom": {
|
16378
16621
|
"name": "ListItem",
|
@@ -16380,7 +16623,7 @@
|
|
16380
16623
|
}
|
16381
16624
|
},
|
16382
16625
|
{
|
16383
|
-
"description": "slot for menu item
|
16626
|
+
"description": "slot for menu item controls to appear of trailing end.",
|
16384
16627
|
"name": "trailing-controls",
|
16385
16628
|
"inheritedFrom": {
|
16386
16629
|
"name": "ListItem",
|
@@ -16389,67 +16632,6 @@
|
|
16389
16632
|
}
|
16390
16633
|
],
|
16391
16634
|
"members": [
|
16392
|
-
{
|
16393
|
-
"kind": "field",
|
16394
|
-
"name": "checked",
|
16395
|
-
"type": {
|
16396
|
-
"text": "boolean"
|
16397
|
-
},
|
16398
|
-
"default": "false",
|
16399
|
-
"description": "The checked attribute is used to indicate that the menuitemcheckbox is checked or not.",
|
16400
|
-
"attribute": "checked",
|
16401
|
-
"reflects": true
|
16402
|
-
},
|
16403
|
-
{
|
16404
|
-
"kind": "field",
|
16405
|
-
"name": "indicator",
|
16406
|
-
"type": {
|
16407
|
-
"text": "Indicator"
|
16408
|
-
},
|
16409
|
-
"description": "The indicator attribute is used to differentiate between <b>checkbox</b> and <b>toggle</b>.",
|
16410
|
-
"default": "'checkbox'",
|
16411
|
-
"attribute": "indicator",
|
16412
|
-
"reflects": true
|
16413
|
-
},
|
16414
|
-
{
|
16415
|
-
"kind": "field",
|
16416
|
-
"name": "handleMouseClick",
|
16417
|
-
"privacy": "private",
|
16418
|
-
"description": "Handles click events to toggle checked state\nIf the menuitemcheckbox is disabled, it does nothing.\nIf the menuitemcheckbox is not disabled, it toggles the `checked` state between `true` and `false`."
|
16419
|
-
},
|
16420
|
-
{
|
16421
|
-
"kind": "method",
|
16422
|
-
"name": "staticCheckbox",
|
16423
|
-
"privacy": "private",
|
16424
|
-
"return": {
|
16425
|
-
"type": {
|
16426
|
-
"text": ""
|
16427
|
-
}
|
16428
|
-
},
|
16429
|
-
"description": "Returns a static checkbox element if the indicator is set to checkbox.\nIf the indicator is not set to checkbox, it returns nothing."
|
16430
|
-
},
|
16431
|
-
{
|
16432
|
-
"kind": "method",
|
16433
|
-
"name": "staticToggle",
|
16434
|
-
"privacy": "private",
|
16435
|
-
"return": {
|
16436
|
-
"type": {
|
16437
|
-
"text": ""
|
16438
|
-
}
|
16439
|
-
},
|
16440
|
-
"description": "Returns a static toggle element if the indicator is set to toggle.\nIf the indicator is not set to toggle, it returns nothing.\n\nThe toggle will always be positioned on the trailing side of the menuitem label."
|
16441
|
-
},
|
16442
|
-
{
|
16443
|
-
"kind": "method",
|
16444
|
-
"name": "getCheckmarkIcon",
|
16445
|
-
"privacy": "private",
|
16446
|
-
"return": {
|
16447
|
-
"type": {
|
16448
|
-
"text": ""
|
16449
|
-
}
|
16450
|
-
},
|
16451
|
-
"description": "Returns a checkmark icon if the indicator is set to checkmark and the checked state is true.\nIf the indicator is not set to checkmark or the checked state is false, it returns nothing.\n\nThe checkmark icon will always be positioned on the trailing side of the menuitem label."
|
16452
|
-
},
|
16453
16635
|
{
|
16454
16636
|
"kind": "field",
|
16455
16637
|
"name": "arrowPosition",
|
@@ -16458,11 +16640,7 @@
|
|
16458
16640
|
},
|
16459
16641
|
"description": "Defines where the arrow icon will appear.\n- `'leading'`: Icon appears on the leading edge (start).\n- `'trailing'`: Icon appears on the trailing edge (end).\n\nIf not set, no arrow is displayed.",
|
16460
16642
|
"attribute": "arrow-position",
|
16461
|
-
"reflects": true
|
16462
|
-
"inheritedFrom": {
|
16463
|
-
"name": "MenuItem",
|
16464
|
-
"module": "components/menuitem/menuitem.component.js"
|
16465
|
-
}
|
16643
|
+
"reflects": true
|
16466
16644
|
},
|
16467
16645
|
{
|
16468
16646
|
"kind": "field",
|
@@ -16472,11 +16650,7 @@
|
|
16472
16650
|
},
|
16473
16651
|
"description": "Defines the direction the arrow icon points.\n- `'positive'`: Arrow points toward the trailing side.\n- `'negative'`: Arrow points toward the leading side.",
|
16474
16652
|
"attribute": "arrow-direction",
|
16475
|
-
"reflects": true
|
16476
|
-
"inheritedFrom": {
|
16477
|
-
"name": "MenuItem",
|
16478
|
-
"module": "components/menuitem/menuitem.component.js"
|
16479
|
-
}
|
16653
|
+
"reflects": true
|
16480
16654
|
},
|
16481
16655
|
{
|
16482
16656
|
"kind": "field",
|
@@ -16487,11 +16661,7 @@
|
|
16487
16661
|
"default": "undefined",
|
16488
16662
|
"description": "The name attribute is used to identify the menu item when it is selected.",
|
16489
16663
|
"attribute": "name",
|
16490
|
-
"reflects": true
|
16491
|
-
"inheritedFrom": {
|
16492
|
-
"name": "MenuItem",
|
16493
|
-
"module": "components/menuitem/menuitem.component.js"
|
16494
|
-
}
|
16664
|
+
"reflects": true
|
16495
16665
|
},
|
16496
16666
|
{
|
16497
16667
|
"kind": "field",
|
@@ -16502,11 +16672,7 @@
|
|
16502
16672
|
"default": "undefined",
|
16503
16673
|
"description": "The value attribute is used to represent a value when the menu item is selected.\nIt is typically used with checkbox and radio menu items, but can be handy for any menu item.",
|
16504
16674
|
"attribute": "value",
|
16505
|
-
"reflects": true
|
16506
|
-
"inheritedFrom": {
|
16507
|
-
"name": "MenuItem",
|
16508
|
-
"module": "components/menuitem/menuitem.component.js"
|
16509
|
-
}
|
16675
|
+
"reflects": true
|
16510
16676
|
},
|
16511
16677
|
{
|
16512
16678
|
"kind": "method",
|
@@ -16550,11 +16716,7 @@
|
|
16550
16716
|
"description": "The keyboard event that triggered the action."
|
16551
16717
|
}
|
16552
16718
|
],
|
16553
|
-
"description": "Handles the keyup event for the menu item.\nIf the Space key is released, it triggers a click event on the menu item.\nThis allows keyboard users to activate the menu item using the Space key.\nIt also prevents the default action of the Space key to avoid scrolling the page."
|
16554
|
-
"inheritedFrom": {
|
16555
|
-
"name": "MenuItem",
|
16556
|
-
"module": "components/menuitem/menuitem.component.js"
|
16557
|
-
}
|
16719
|
+
"description": "Handles the keyup event for the menu item.\nIf the Space key is released, it triggers a click event on the menu item.\nThis allows keyboard users to activate the menu item using the Space key.\nIt also prevents the default action of the Space key to avoid scrolling the page."
|
16558
16720
|
},
|
16559
16721
|
{
|
16560
16722
|
"kind": "method",
|
@@ -16891,12 +17053,7 @@
|
|
16891
17053
|
],
|
16892
17054
|
"events": [
|
16893
17055
|
{
|
16894
|
-
"description": "(React:
|
16895
|
-
"name": "change",
|
16896
|
-
"reactName": "onChange"
|
16897
|
-
},
|
16898
|
-
{
|
16899
|
-
"description": "(React: onClick) This event is dispatched when the menuitemcheckbox is clicked.",
|
17056
|
+
"description": "(React: onClick) This event is dispatched when the menuitem is clicked.",
|
16900
17057
|
"name": "click",
|
16901
17058
|
"reactName": "onClick",
|
16902
17059
|
"inheritedFrom": {
|
@@ -16904,15 +17061,6 @@
|
|
16904
17061
|
"module": "src/components/listitem/listitem.component.ts"
|
16905
17062
|
}
|
16906
17063
|
},
|
16907
|
-
{
|
16908
|
-
"description": "(React: onFocus) This event is dispatched when the menuitemcheckbox receives focus.",
|
16909
|
-
"name": "focus",
|
16910
|
-
"reactName": "onFocus",
|
16911
|
-
"inheritedFrom": {
|
16912
|
-
"name": "ListItem",
|
16913
|
-
"module": "src/components/listitem/listitem.component.ts"
|
16914
|
-
}
|
16915
|
-
},
|
16916
17064
|
{
|
16917
17065
|
"description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the menuitem.",
|
16918
17066
|
"name": "keydown",
|
@@ -16930,38 +17078,25 @@
|
|
16930
17078
|
"name": "ListItem",
|
16931
17079
|
"module": "src/components/listitem/listitem.component.ts"
|
16932
17080
|
}
|
17081
|
+
},
|
17082
|
+
{
|
17083
|
+
"description": "(React: onFocus) This event is dispatched when the menuitem receives focus.",
|
17084
|
+
"name": "focus",
|
17085
|
+
"reactName": "onFocus",
|
17086
|
+
"inheritedFrom": {
|
17087
|
+
"name": "ListItem",
|
17088
|
+
"module": "src/components/listitem/listitem.component.ts"
|
17089
|
+
}
|
16933
17090
|
}
|
16934
17091
|
],
|
16935
17092
|
"attributes": [
|
16936
|
-
{
|
16937
|
-
"name": "checked",
|
16938
|
-
"type": {
|
16939
|
-
"text": "boolean"
|
16940
|
-
},
|
16941
|
-
"default": "false",
|
16942
|
-
"description": "The checked attribute is used to indicate that the menuitemcheckbox is checked or not.",
|
16943
|
-
"fieldName": "checked"
|
16944
|
-
},
|
16945
|
-
{
|
16946
|
-
"name": "indicator",
|
16947
|
-
"type": {
|
16948
|
-
"text": "Indicator"
|
16949
|
-
},
|
16950
|
-
"description": "The indicator attribute is used to differentiate between <b>checkbox</b> and <b>toggle</b>.",
|
16951
|
-
"default": "'checkbox'",
|
16952
|
-
"fieldName": "indicator"
|
16953
|
-
},
|
16954
17093
|
{
|
16955
17094
|
"name": "arrow-position",
|
16956
17095
|
"type": {
|
16957
17096
|
"text": "ArrowPositions | undefined"
|
16958
17097
|
},
|
16959
17098
|
"description": "Defines where the arrow icon will appear.\n- `'leading'`: Icon appears on the leading edge (start).\n- `'trailing'`: Icon appears on the trailing edge (end).\n\nIf not set, no arrow is displayed.",
|
16960
|
-
"fieldName": "arrowPosition"
|
16961
|
-
"inheritedFrom": {
|
16962
|
-
"name": "MenuItem",
|
16963
|
-
"module": "src/components/menuitem/menuitem.component.ts"
|
16964
|
-
}
|
17099
|
+
"fieldName": "arrowPosition"
|
16965
17100
|
},
|
16966
17101
|
{
|
16967
17102
|
"name": "arrow-direction",
|
@@ -16969,11 +17104,7 @@
|
|
16969
17104
|
"text": "ArrowDirections | undefined"
|
16970
17105
|
},
|
16971
17106
|
"description": "Defines the direction the arrow icon points.\n- `'positive'`: Arrow points toward the trailing side.\n- `'negative'`: Arrow points toward the leading side.",
|
16972
|
-
"fieldName": "arrowDirection"
|
16973
|
-
"inheritedFrom": {
|
16974
|
-
"name": "MenuItem",
|
16975
|
-
"module": "src/components/menuitem/menuitem.component.ts"
|
16976
|
-
}
|
17107
|
+
"fieldName": "arrowDirection"
|
16977
17108
|
},
|
16978
17109
|
{
|
16979
17110
|
"name": "name",
|
@@ -16982,11 +17113,7 @@
|
|
16982
17113
|
},
|
16983
17114
|
"default": "undefined",
|
16984
17115
|
"description": "The name attribute is used to identify the menu item when it is selected.",
|
16985
|
-
"fieldName": "name"
|
16986
|
-
"inheritedFrom": {
|
16987
|
-
"name": "MenuItem",
|
16988
|
-
"module": "src/components/menuitem/menuitem.component.ts"
|
16989
|
-
}
|
17116
|
+
"fieldName": "name"
|
16990
17117
|
},
|
16991
17118
|
{
|
16992
17119
|
"name": "value",
|
@@ -16995,11 +17122,7 @@
|
|
16995
17122
|
},
|
16996
17123
|
"default": "undefined",
|
16997
17124
|
"description": "The value attribute is used to represent a value when the menu item is selected.\nIt is typically used with checkbox and radio menu items, but can be handy for any menu item.",
|
16998
|
-
"fieldName": "value"
|
16999
|
-
"inheritedFrom": {
|
17000
|
-
"name": "MenuItem",
|
17001
|
-
"module": "src/components/menuitem/menuitem.component.ts"
|
17002
|
-
}
|
17125
|
+
"fieldName": "value"
|
17003
17126
|
},
|
17004
17127
|
{
|
17005
17128
|
"name": "disabled",
|
@@ -17140,11 +17263,11 @@
|
|
17140
17263
|
}
|
17141
17264
|
],
|
17142
17265
|
"superclass": {
|
17143
|
-
"name": "
|
17144
|
-
"module": "/src/components/
|
17266
|
+
"name": "ListItem",
|
17267
|
+
"module": "/src/components/listitem/listitem.component"
|
17145
17268
|
},
|
17146
|
-
"tagName": "mdc-
|
17147
|
-
"jsDoc": "/**\n *
|
17269
|
+
"tagName": "mdc-menuitem",
|
17270
|
+
"jsDoc": "/**\n * menuitem component is inherited by listitem component with the role set `menuitem`.<br/>\n * A menu item can contain an icon on the leading or trailing side.\n *\n * The leading and trailing slots can be used to display controls and text.<br/>\n * Based on the leading/trailing slot, the position of the controls and text can be adjusted.\n *\n * Please use element with role=menu as a parent element even when there is only menuitem for a11y purpose.\n * For example mdc-menupopover or mdc-menubar.\n *\n * Menu item has `name` and `value` attribute that can be used to identify the menu item when it is selected.\n *\n * @dependency mdc-text\n * @dependency mdc-icon\n * @dependency mdc-tooltip\n *\n * @tagname mdc-menuitem\n *\n * @slot leading-controls - slot for menu item controls to appear of leading end.\n * @slot leading-text-primary-label - slot for menu item primary label.\n * @slot leading-text-secondary-label - slot for menu item secondary label.\n * @slot leading-text-tertiary-label - slot for menu item tertiary label.\n * @slot trailing-text-side-header - slot for menu item side header text.\n * @slot trailing-text-subline - slot for menu item subline text.\n * @slot trailing-controls - slot for menu item controls to appear of trailing end.\n *\n * @event click - (React: onClick) This event is dispatched when the menuitem is clicked.\n * @event keydown - (React: onKeyDown) This event is dispatched when a key is pressed down on the menuitem.\n * @event keyup - (React: onKeyUp) This event is dispatched when a key is released on the menuitem.\n * @event focus - (React: onFocus) This event is dispatched when the menuitem receives focus.\n */",
|
17148
17271
|
"customElement": true,
|
17149
17272
|
"cssProperties": [
|
17150
17273
|
{
|
@@ -17219,8 +17342,8 @@
|
|
17219
17342
|
"kind": "js",
|
17220
17343
|
"name": "default",
|
17221
17344
|
"declaration": {
|
17222
|
-
"name": "
|
17223
|
-
"module": "components/
|
17345
|
+
"name": "MenuItem",
|
17346
|
+
"module": "components/menuitem/menuitem.component.js"
|
17224
17347
|
}
|
17225
17348
|
}
|
17226
17349
|
]
|
@@ -20079,7 +20202,7 @@
|
|
20079
20202
|
"text": "string | null"
|
20080
20203
|
},
|
20081
20204
|
"default": "null",
|
20082
|
-
"description": "The
|
20205
|
+
"description": "The aria-label for the section.\nThis is used for accessibility purposes to describe the section.\nIf not provided, it defaults to the `headerText`.",
|
20083
20206
|
"attribute": "aria-label",
|
20084
20207
|
"reflects": true
|
20085
20208
|
},
|
@@ -20094,9 +20217,18 @@
|
|
20094
20217
|
"attribute": "header-text",
|
20095
20218
|
"reflects": true
|
20096
20219
|
},
|
20220
|
+
{
|
20221
|
+
"kind": "field",
|
20222
|
+
"name": "prefixIcon",
|
20223
|
+
"type": {
|
20224
|
+
"text": "IconNames | undefined"
|
20225
|
+
},
|
20226
|
+
"description": "Name of the icon rendered before the text\n\nIf not provided, no icon will be rendered and text will be aligned to the start.",
|
20227
|
+
"attribute": "prefix-icon"
|
20228
|
+
},
|
20097
20229
|
{
|
20098
20230
|
"kind": "method",
|
20099
|
-
"name": "
|
20231
|
+
"name": "renderHeader",
|
20100
20232
|
"privacy": "private"
|
20101
20233
|
}
|
20102
20234
|
],
|
@@ -20114,7 +20246,7 @@
|
|
20114
20246
|
"text": "string | null"
|
20115
20247
|
},
|
20116
20248
|
"default": "null",
|
20117
|
-
"description": "The
|
20249
|
+
"description": "The aria-label for the section.\nThis is used for accessibility purposes to describe the section.\nIf not provided, it defaults to the `headerText`.",
|
20118
20250
|
"fieldName": "ariaLabel"
|
20119
20251
|
},
|
20120
20252
|
{
|
@@ -20125,6 +20257,14 @@
|
|
20125
20257
|
"default": "null",
|
20126
20258
|
"description": "The primary headerText of the list item.\nThis appears on the leading side of the list item.",
|
20127
20259
|
"fieldName": "headerText"
|
20260
|
+
},
|
20261
|
+
{
|
20262
|
+
"name": "prefix-icon",
|
20263
|
+
"type": {
|
20264
|
+
"text": "IconNames | undefined"
|
20265
|
+
},
|
20266
|
+
"description": "Name of the icon rendered before the text\n\nIf not provided, no icon will be rendered and text will be aligned to the start.",
|
20267
|
+
"fieldName": "prefixIcon"
|
20128
20268
|
}
|
20129
20269
|
],
|
20130
20270
|
"superclass": {
|