@momentum-design/components 0.83.0 → 0.83.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.
@@ -1039,110 +1039,27 @@
1039
1039
  },
1040
1040
  {
1041
1041
  "kind": "javascript-module",
1042
- "path": "components/badge/badge.component.js",
1042
+ "path": "components/avatarbutton/avatarbutton.component.js",
1043
1043
  "declarations": [
1044
1044
  {
1045
1045
  "kind": "class",
1046
- "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.",
1047
- "name": "Badge",
1046
+ "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.",
1047
+ "name": "AvatarButton",
1048
1048
  "cssProperties": [
1049
1049
  {
1050
- "description": "The foreground color of the primary badge.",
1051
- "name": "--mdc-badge-primary-foreground-color"
1052
- },
1053
- {
1054
- "description": "The background color of the primary badge.",
1055
- "name": "--mdc-badge-primary-background-color"
1056
- },
1057
- {
1058
- "description": "The foreground color of the secondary badge.",
1059
- "name": "--mdc-badge-secondary-foreground-color"
1060
- },
1061
- {
1062
- "description": "The background color of the secondary badge.",
1063
- "name": "--mdc-badge-secondary-background-color"
1064
- },
1065
- {
1066
- "description": "The foreground color of the success badge.",
1067
- "name": "--mdc-badge-success-foreground-color"
1068
- },
1069
- {
1070
- "description": "The background color of the success badge.",
1071
- "name": "--mdc-badge-success-background-color"
1072
- },
1073
- {
1074
- "description": "The foreground color of the warning badge.",
1075
- "name": "--mdc-badge-warning-foreground-color"
1076
- },
1077
- {
1078
- "description": "The background color of the warning badge.",
1079
- "name": "--mdc-badge-warning-background-color"
1080
- },
1081
- {
1082
- "description": "The foreground color of the error badge.",
1083
- "name": "--mdc-badge-error-foreground-color"
1050
+ "description": "Background color of the overlay in rest state",
1051
+ "name": "--mdc-avatarbutton-overlay-background-color-rest"
1084
1052
  },
1085
1053
  {
1086
- "description": "The background color of the error badge.",
1087
- "name": "--mdc-badge-error-background-color"
1054
+ "description": "Background color of the overlay in hover state",
1055
+ "name": "--mdc-avatarbutton-overlay-background-color-hover"
1088
1056
  },
1089
1057
  {
1090
- "description": "The background color of the badge overlay.",
1091
- "name": "--mdc-badge-overlay-background-color"
1058
+ "description": "Background color of the overlay in active state",
1059
+ "name": "--mdc-avatarbutton-overlay-background-color-active"
1092
1060
  }
1093
1061
  ],
1094
1062
  "members": [
1095
- {
1096
- "kind": "field",
1097
- "name": "type",
1098
- "type": {
1099
- "text": "BadgeType | undefined"
1100
- },
1101
- "description": "Type of the badge\nCan be `dot` (notification) , `icon`, `counter`, `success`, `warning` or `error`.",
1102
- "attribute": "type",
1103
- "reflects": true
1104
- },
1105
- {
1106
- "kind": "field",
1107
- "name": "variant",
1108
- "type": {
1109
- "text": "IconVariant"
1110
- },
1111
- "description": "Type of the variant can be `primary` or `secondary`.\nIt defines the background and foreground color of the icon.",
1112
- "default": "primary",
1113
- "attribute": "variant",
1114
- "reflects": true
1115
- },
1116
- {
1117
- "kind": "field",
1118
- "name": "counter",
1119
- "type": {
1120
- "text": "number | undefined"
1121
- },
1122
- "description": "Counter is the number which can be provided in the badge.",
1123
- "attribute": "counter"
1124
- },
1125
- {
1126
- "kind": "field",
1127
- "name": "maxCounter",
1128
- "type": {
1129
- "text": "number"
1130
- },
1131
- "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`.",
1132
- "default": "99",
1133
- "attribute": "max-counter",
1134
- "reflects": true
1135
- },
1136
- {
1137
- "kind": "field",
1138
- "name": "overlay",
1139
- "type": {
1140
- "text": "boolean"
1141
- },
1142
- "default": "false",
1143
- "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.",
1144
- "attribute": "overlay"
1145
- },
1146
1063
  {
1147
1064
  "kind": "field",
1148
1065
  "name": "ariaLabel",
@@ -1155,102 +1072,97 @@
1155
1072
  },
1156
1073
  {
1157
1074
  "kind": "method",
1158
- "name": "getCounterText",
1075
+ "name": "setSize",
1159
1076
  "privacy": "private",
1160
- "return": {
1161
- "type": {
1162
- "text": ""
1163
- }
1164
- },
1165
1077
  "parameters": [
1166
1078
  {
1167
- "name": "maxCounter",
1168
- "type": {
1169
- "text": "number"
1170
- },
1171
- "description": "the maximum limit which can be displayed on the badge"
1172
- },
1173
- {
1174
- "name": "counter",
1175
- "optional": true,
1079
+ "name": "size",
1176
1080
  "type": {
1177
- "text": "number"
1178
- },
1179
- "description": "the number to be displayed on the badge"
1081
+ "text": "AvatarSize"
1082
+ }
1180
1083
  }
1181
- ],
1182
- "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."
1084
+ ]
1183
1085
  },
1184
1086
  {
1185
- "kind": "method",
1186
- "name": "getBadgeIcon",
1187
- "privacy": "private",
1188
- "return": {
1189
- "type": {
1190
- "text": ""
1191
- }
1087
+ "kind": "field",
1088
+ "name": "src",
1089
+ "type": {
1090
+ "text": "string | undefined"
1192
1091
  },
1193
- "parameters": [
1194
- {
1195
- "name": "iconName",
1196
- "type": {
1197
- "text": "string"
1198
- },
1199
- "description": "the name of the icon from the icon set"
1200
- },
1201
- {
1202
- "name": "backgroundClassPostfix",
1203
- "type": {
1204
- "text": "string"
1205
- },
1206
- "description": "postfix for the class to style the badge icon."
1207
- }
1208
- ],
1209
- "description": "Method to generate the badge icon."
1092
+ "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.",
1093
+ "attribute": "src",
1094
+ "inheritedFrom": {
1095
+ "name": "AvatarComponentMixin",
1096
+ "module": "utils/mixins/AvatarComponentMixin.js"
1097
+ }
1210
1098
  },
1211
1099
  {
1212
- "kind": "method",
1213
- "name": "getBadgeDot",
1214
- "privacy": "private",
1215
- "return": {
1216
- "type": {
1217
- "text": ""
1218
- }
1100
+ "kind": "field",
1101
+ "name": "initials",
1102
+ "type": {
1103
+ "text": "string | undefined"
1219
1104
  },
1220
- "description": "Method to generate the badge dot template."
1105
+ "description": "The initials to be displayed for the avatar.",
1106
+ "attribute": "initials",
1107
+ "inheritedFrom": {
1108
+ "name": "AvatarComponentMixin",
1109
+ "module": "utils/mixins/AvatarComponentMixin.js"
1110
+ }
1221
1111
  },
1222
1112
  {
1223
- "kind": "method",
1224
- "name": "getBadgeCounterText",
1225
- "privacy": "private",
1226
- "return": {
1227
- "type": {
1228
- "text": ""
1229
- }
1113
+ "kind": "field",
1114
+ "name": "presence",
1115
+ "type": {
1116
+ "text": "PresenceType | undefined"
1230
1117
  },
1231
- "description": "Method to generate the badge text and counter template."
1118
+ "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`",
1119
+ "attribute": "presence",
1120
+ "inheritedFrom": {
1121
+ "name": "AvatarComponentMixin",
1122
+ "module": "utils/mixins/AvatarComponentMixin.js"
1123
+ }
1232
1124
  },
1233
1125
  {
1234
- "kind": "method",
1235
- "name": "setRoleByAriaLabel",
1236
- "privacy": "private",
1237
- "return": {
1238
- "type": {
1239
- "text": "void"
1240
- }
1126
+ "kind": "field",
1127
+ "name": "size",
1128
+ "type": {
1129
+ "text": "ButtonSize"
1241
1130
  },
1242
- "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."
1131
+ "description": "Acceptable values include (size in px unit):\n- 24\n- 32\n- 48\n- 64\n- 72\n- 88\n- 124",
1132
+ "default": "32",
1133
+ "attribute": "size",
1134
+ "reflects": true,
1135
+ "inheritedFrom": {
1136
+ "name": "Buttonsimple",
1137
+ "module": "components/buttonsimple/buttonsimple.component.js"
1138
+ }
1243
1139
  },
1244
1140
  {
1245
- "kind": "method",
1246
- "name": "getBadgeContentBasedOnType",
1247
- "privacy": "private",
1248
- "return": {
1249
- "type": {
1250
- "text": ""
1251
- }
1141
+ "kind": "field",
1142
+ "name": "counter",
1143
+ "type": {
1144
+ "text": "number | undefined"
1252
1145
  },
1253
- "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."
1146
+ "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`.",
1147
+ "attribute": "counter",
1148
+ "inheritedFrom": {
1149
+ "name": "AvatarComponentMixin",
1150
+ "module": "utils/mixins/AvatarComponentMixin.js"
1151
+ }
1152
+ },
1153
+ {
1154
+ "kind": "field",
1155
+ "name": "isTyping",
1156
+ "type": {
1157
+ "text": "boolean"
1158
+ },
1159
+ "default": "false",
1160
+ "description": "Represents the typing indicator when the user is typing.",
1161
+ "attribute": "is-typing",
1162
+ "inheritedFrom": {
1163
+ "name": "AvatarComponentMixin",
1164
+ "module": "utils/mixins/AvatarComponentMixin.js"
1165
+ }
1254
1166
  },
1255
1167
  {
1256
1168
  "kind": "field",
@@ -1264,860 +1176,844 @@
1264
1176
  "name": "IconNameMixin",
1265
1177
  "module": "utils/mixins/IconNameMixin.js"
1266
1178
  }
1267
- }
1268
- ],
1269
- "attributes": [
1179
+ },
1270
1180
  {
1271
- "name": "type",
1181
+ "kind": "field",
1182
+ "name": "autofocus",
1272
1183
  "type": {
1273
- "text": "BadgeType | undefined"
1184
+ "text": "boolean"
1274
1185
  },
1275
- "description": "Type of the badge\nCan be `dot` (notification) , `icon`, `counter`, `success`, `warning` or `error`.",
1276
- "fieldName": "type"
1186
+ "default": "false",
1187
+ "description": "This property indicates whether the element should receive focus automatically when it is rendered.",
1188
+ "attribute": "autofocus",
1189
+ "reflects": true,
1190
+ "inheritedFrom": {
1191
+ "name": "AutoFocusMixin",
1192
+ "module": "utils/mixins/AutoFocusMixin.js"
1193
+ }
1277
1194
  },
1278
1195
  {
1279
- "name": "variant",
1196
+ "kind": "field",
1197
+ "name": "tabIndex",
1280
1198
  "type": {
1281
- "text": "IconVariant"
1199
+ "text": "number"
1282
1200
  },
1283
- "description": "Type of the variant can be `primary` or `secondary`.\nIt defines the background and foreground color of the icon.",
1284
- "default": "primary",
1285
- "fieldName": "variant"
1201
+ "default": "0",
1202
+ "description": "This property specifies the tab order of the element.",
1203
+ "attribute": "tabIndex",
1204
+ "reflects": true,
1205
+ "inheritedFrom": {
1206
+ "name": "TabIndexMixin",
1207
+ "module": "utils/mixins/TabIndexMixin.js"
1208
+ }
1286
1209
  },
1287
1210
  {
1288
- "name": "counter",
1211
+ "kind": "field",
1212
+ "name": "disabled",
1289
1213
  "type": {
1290
- "text": "number | undefined"
1214
+ "text": "boolean | undefined"
1291
1215
  },
1292
- "description": "Counter is the number which can be provided in the badge.",
1293
- "fieldName": "counter"
1216
+ "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
1217
+ "default": "undefined",
1218
+ "attribute": "disabled",
1219
+ "reflects": true,
1220
+ "inheritedFrom": {
1221
+ "name": "DisabledMixin",
1222
+ "module": "utils/mixins/DisabledMixin.js"
1223
+ }
1294
1224
  },
1295
1225
  {
1296
- "name": "max-counter",
1226
+ "kind": "field",
1227
+ "name": "active",
1297
1228
  "type": {
1298
- "text": "number"
1229
+ "text": "boolean | undefined"
1299
1230
  },
1300
- "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`.",
1301
- "default": "99",
1302
- "fieldName": "maxCounter"
1231
+ "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.",
1232
+ "default": "undefined",
1233
+ "attribute": "active",
1234
+ "reflects": true,
1235
+ "inheritedFrom": {
1236
+ "name": "Buttonsimple",
1237
+ "module": "components/buttonsimple/buttonsimple.component.js"
1238
+ }
1303
1239
  },
1304
1240
  {
1305
- "name": "overlay",
1241
+ "kind": "field",
1242
+ "name": "softDisabled",
1306
1243
  "type": {
1307
- "text": "boolean"
1244
+ "text": "boolean | undefined"
1308
1245
  },
1309
- "default": "false",
1310
- "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.",
1311
- "fieldName": "overlay"
1246
+ "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.",
1247
+ "default": "undefined",
1248
+ "attribute": "soft-disabled",
1249
+ "reflects": true,
1250
+ "inheritedFrom": {
1251
+ "name": "Buttonsimple",
1252
+ "module": "components/buttonsimple/buttonsimple.component.js"
1253
+ }
1312
1254
  },
1313
1255
  {
1314
- "name": "aria-label",
1315
- "type": {
1316
- "text": "string | null"
1317
- },
1318
- "default": "null",
1319
- "description": "Aria-label attribute to be set for accessibility",
1320
- "fieldName": "ariaLabel"
1256
+ "kind": "field",
1257
+ "name": "role",
1258
+ "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.",
1259
+ "default": "button",
1260
+ "attribute": "role",
1261
+ "reflects": true,
1262
+ "inheritedFrom": {
1263
+ "name": "Buttonsimple",
1264
+ "module": "components/buttonsimple/buttonsimple.component.js"
1265
+ }
1321
1266
  },
1322
1267
  {
1323
- "name": "icon-name",
1268
+ "kind": "field",
1269
+ "name": "ariaStateKey",
1324
1270
  "type": {
1325
- "text": "IconNames | undefined"
1271
+ "text": "string | undefined"
1326
1272
  },
1327
- "description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
1328
- "fieldName": "iconName",
1273
+ "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`",
1274
+ "default": "'aria-pressed' (when)",
1275
+ "attribute": "ariaStateKey",
1276
+ "reflects": true,
1329
1277
  "inheritedFrom": {
1330
- "name": "IconNameMixin",
1331
- "module": "src/utils/mixins/IconNameMixin.ts"
1278
+ "name": "Buttonsimple",
1279
+ "module": "components/buttonsimple/buttonsimple.component.js"
1332
1280
  }
1333
- }
1334
- ],
1335
- "mixins": [
1336
- {
1337
- "name": "IconNameMixin",
1338
- "module": "/src/utils/mixins/IconNameMixin"
1339
- }
1340
- ],
1341
- "superclass": {
1342
- "name": "Component",
1343
- "module": "/src/models"
1344
- },
1345
- "tagName": "mdc-badge",
1346
- "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 */",
1347
- "customElement": true
1348
- }
1349
- ],
1350
- "exports": [
1351
- {
1352
- "kind": "js",
1353
- "name": "default",
1354
- "declaration": {
1355
- "name": "Badge",
1356
- "module": "components/badge/badge.component.js"
1357
- }
1358
- }
1359
- ]
1360
- },
1361
- {
1362
- "kind": "javascript-module",
1363
- "path": "components/brandvisual/brandvisual.component.js",
1364
- "declarations": [
1365
- {
1366
- "kind": "class",
1367
- "description": "The `mdc-brandvisual` component is responsible for rendering logos dynamically & ensures they are\ndisplayed correctly within applications.\n\nFeatures:\n- Dynamically loads brandvisuals based on the `name` attribute.\n- Emits a `load` event when the brandvisual is successfully fetched.\n- Emits an `error` event when the brandvisual import fails.\n- Supports accessibility best practices.\n- Used for brand representation within the design system.",
1368
- "name": "Brandvisual",
1369
- "members": [
1281
+ },
1370
1282
  {
1371
1283
  "kind": "field",
1372
- "name": "brandVisualData",
1284
+ "name": "type",
1373
1285
  "type": {
1374
- "text": "HTMLElement | undefined"
1286
+ "text": "ButtonType"
1375
1287
  },
1376
- "privacy": "private"
1288
+ "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.",
1289
+ "default": "button",
1290
+ "attribute": "type",
1291
+ "reflects": true,
1292
+ "inheritedFrom": {
1293
+ "name": "Buttonsimple",
1294
+ "module": "components/buttonsimple/buttonsimple.component.js"
1295
+ }
1377
1296
  },
1378
1297
  {
1379
- "kind": "field",
1380
- "name": "name",
1381
- "type": {
1382
- "text": "BrandVisualNames | undefined"
1383
- },
1384
- "description": "Name of the brandVisual (= filename)",
1385
- "attribute": "name",
1386
- "reflects": true
1298
+ "kind": "method",
1299
+ "name": "executeAction",
1300
+ "privacy": "protected",
1301
+ "inheritedFrom": {
1302
+ "name": "Buttonsimple",
1303
+ "module": "components/buttonsimple/buttonsimple.component.js"
1304
+ }
1387
1305
  },
1388
1306
  {
1389
1307
  "kind": "method",
1390
- "name": "getBrandVisualData",
1391
- "privacy": "private"
1308
+ "name": "setActive",
1309
+ "privacy": "protected",
1310
+ "parameters": [
1311
+ {
1312
+ "name": "element",
1313
+ "type": {
1314
+ "text": "HTMLElement"
1315
+ },
1316
+ "description": "The button element"
1317
+ },
1318
+ {
1319
+ "name": "active",
1320
+ "optional": true,
1321
+ "type": {
1322
+ "text": "boolean"
1323
+ },
1324
+ "description": "The active state of the element"
1325
+ }
1326
+ ],
1327
+ "description": "Sets the ariaStateKey attributes based on the active state of the button.",
1328
+ "inheritedFrom": {
1329
+ "name": "Buttonsimple",
1330
+ "module": "components/buttonsimple/buttonsimple.component.js"
1331
+ }
1392
1332
  },
1393
1333
  {
1394
1334
  "kind": "method",
1395
- "name": "handleBrandVisualLoadedSuccess",
1335
+ "name": "setSoftDisabled",
1396
1336
  "privacy": "private",
1397
1337
  "parameters": [
1398
1338
  {
1399
- "name": "brandVisualHtml",
1339
+ "name": "element",
1400
1340
  "type": {
1401
1341
  "text": "HTMLElement"
1402
1342
  },
1403
- "description": "The brandvisual html element which has been fetched from the brandvisual provider."
1343
+ "description": "The button element."
1344
+ },
1345
+ {
1346
+ "name": "softDisabled",
1347
+ "optional": true,
1348
+ "type": {
1349
+ "text": "boolean"
1350
+ },
1351
+ "description": "The soft-disabled state."
1404
1352
  }
1405
1353
  ],
1406
- "description": "Sets the brandVisualData state to the fetched brandvisual.\nDispatches a 'load' event on the component once the brandvisual has been successfully loaded."
1354
+ "description": "Sets the soft-disabled attribute for the button.\nWhen soft-disabled, the button looks to be disabled but remains focusable and clickable.\nAlso sets/removes aria-disabled attribute.",
1355
+ "inheritedFrom": {
1356
+ "name": "Buttonsimple",
1357
+ "module": "components/buttonsimple/buttonsimple.component.js"
1358
+ }
1407
1359
  },
1408
1360
  {
1409
1361
  "kind": "method",
1410
- "name": "handleBrandVisualLoadedFailure",
1362
+ "name": "setDisabled",
1411
1363
  "privacy": "private",
1412
1364
  "parameters": [
1413
1365
  {
1414
- "name": "error",
1366
+ "name": "element",
1415
1367
  "type": {
1416
- "text": "unknown"
1417
- }
1368
+ "text": "HTMLElement"
1369
+ },
1370
+ "description": "The button element."
1371
+ },
1372
+ {
1373
+ "name": "disabled",
1374
+ "type": {
1375
+ "text": "boolean"
1376
+ },
1377
+ "description": "The disabled state."
1418
1378
  }
1419
1379
  ],
1420
- "description": "Dispatches an 'error' event on the component when the brandvisual import has failed.\nThis event bubbles and is cancelable.\nThe error detail is set to the error object."
1421
- }
1422
- ],
1423
- "events": [
1380
+ "description": "Sets the disabled attribute for the button.\nWhen disabled, the button is not focusable or clickable, and tabindex is set to -1.\nThe previous tabindex is stored and restored when enabled.\nAlso sets/removes aria-disabled attribute.",
1381
+ "inheritedFrom": {
1382
+ "name": "Buttonsimple",
1383
+ "module": "components/buttonsimple/buttonsimple.component.js"
1384
+ }
1385
+ },
1424
1386
  {
1425
- "description": "(React: onLoad) This event is dispatched when the brandvisual has been successfully loaded.",
1426
- "name": "load",
1427
- "reactName": "onLoad"
1387
+ "kind": "method",
1388
+ "name": "triggerClickEvent",
1389
+ "privacy": "private",
1390
+ "inheritedFrom": {
1391
+ "name": "Buttonsimple",
1392
+ "module": "components/buttonsimple/buttonsimple.component.js"
1393
+ }
1428
1394
  },
1429
1395
  {
1430
- "description": "(React: onError) This event is dispatched when the brandvisual fetching has failed.",
1431
- "name": "error",
1432
- "reactName": "onError"
1433
- }
1434
- ],
1435
- "attributes": [
1396
+ "kind": "method",
1397
+ "name": "handleBlur",
1398
+ "privacy": "private",
1399
+ "description": "In case the button is pressed and the focus is lost while pressing,\nthe pressed class is removed.",
1400
+ "inheritedFrom": {
1401
+ "name": "Buttonsimple",
1402
+ "module": "components/buttonsimple/buttonsimple.component.js"
1403
+ }
1404
+ },
1436
1405
  {
1437
- "name": "name",
1438
- "type": {
1439
- "text": "BrandVisualNames | undefined"
1440
- },
1441
- "description": "Name of the brandVisual (= filename)",
1442
- "fieldName": "name"
1406
+ "kind": "method",
1407
+ "name": "handleKeyDown",
1408
+ "privacy": "private",
1409
+ "parameters": [
1410
+ {
1411
+ "name": "event",
1412
+ "type": {
1413
+ "text": "KeyboardEvent"
1414
+ },
1415
+ "description": "The keyboard event."
1416
+ }
1417
+ ],
1418
+ "description": "Handles the keydown event on the button.\nIf the key is 'Enter' or 'Space', the button is pressed.\nIf the key is 'Enter', the button is pressed. The native HTML button works in the same way.\nIf the key is 'Space', the button's default is prevent to avoid scrolling etc in the host application.",
1419
+ "inheritedFrom": {
1420
+ "name": "Buttonsimple",
1421
+ "module": "components/buttonsimple/buttonsimple.component.js"
1422
+ }
1423
+ },
1424
+ {
1425
+ "kind": "method",
1426
+ "name": "handleKeyUp",
1427
+ "privacy": "private",
1428
+ "parameters": [
1429
+ {
1430
+ "name": "event",
1431
+ "type": {
1432
+ "text": "KeyboardEvent"
1433
+ },
1434
+ "description": "The keyboard event."
1435
+ }
1436
+ ],
1437
+ "description": "Handles the keyup event on the button.\nIf the key is 'Enter' or 'Space', the button is clicked.\nIf the key is 'Space', the button is pressed. The native HTML button works in the same way.",
1438
+ "inheritedFrom": {
1439
+ "name": "Buttonsimple",
1440
+ "module": "components/buttonsimple/buttonsimple.component.js"
1441
+ }
1443
1442
  }
1444
1443
  ],
1445
- "superclass": {
1446
- "name": "Component",
1447
- "module": "/src/models"
1448
- },
1449
- "tagName": "mdc-brandvisual",
1450
- "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 */",
1451
- "customElement": true
1452
- }
1453
- ],
1454
- "exports": [
1455
- {
1456
- "kind": "js",
1457
- "name": "default",
1458
- "declaration": {
1459
- "name": "Brandvisual",
1460
- "module": "components/brandvisual/brandvisual.component.js"
1461
- }
1462
- }
1463
- ]
1464
- },
1465
- {
1466
- "kind": "javascript-module",
1467
- "path": "components/avatarbutton/avatarbutton.component.js",
1468
- "declarations": [
1469
- {
1470
- "kind": "class",
1471
- "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.",
1472
- "name": "AvatarButton",
1473
- "cssProperties": [
1444
+ "events": [
1474
1445
  {
1475
- "description": "Background color of the overlay in rest state",
1476
- "name": "--mdc-avatarbutton-overlay-background-color-rest"
1446
+ "description": "(React: onClick) This event is dispatched when the avatarbutton is clicked.",
1447
+ "name": "click",
1448
+ "reactName": "onClick",
1449
+ "inheritedFrom": {
1450
+ "name": "Buttonsimple",
1451
+ "module": "src/components/buttonsimple/buttonsimple.component.ts"
1452
+ }
1477
1453
  },
1478
1454
  {
1479
- "description": "Background color of the overlay in hover state",
1480
- "name": "--mdc-avatarbutton-overlay-background-color-hover"
1455
+ "description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the avatarbutton.",
1456
+ "name": "keydown",
1457
+ "reactName": "onKeyDown",
1458
+ "inheritedFrom": {
1459
+ "name": "Buttonsimple",
1460
+ "module": "src/components/buttonsimple/buttonsimple.component.ts"
1461
+ }
1481
1462
  },
1482
1463
  {
1483
- "description": "Background color of the overlay in active state",
1484
- "name": "--mdc-avatarbutton-overlay-background-color-active"
1464
+ "description": "(React: onKeyUp) This event is dispatched when a key is released on the avatarbutton.",
1465
+ "name": "keyup",
1466
+ "reactName": "onKeyUp",
1467
+ "inheritedFrom": {
1468
+ "name": "Buttonsimple",
1469
+ "module": "src/components/buttonsimple/buttonsimple.component.ts"
1470
+ }
1471
+ },
1472
+ {
1473
+ "description": "(React: onFocus) This event is dispatched when the avatarbutton receives focus.",
1474
+ "name": "focus",
1475
+ "reactName": "onFocus",
1476
+ "inheritedFrom": {
1477
+ "name": "Buttonsimple",
1478
+ "module": "src/components/buttonsimple/buttonsimple.component.ts"
1479
+ }
1485
1480
  }
1486
1481
  ],
1487
- "members": [
1482
+ "attributes": [
1488
1483
  {
1489
- "kind": "field",
1490
- "name": "ariaLabel",
1484
+ "name": "aria-label",
1491
1485
  "type": {
1492
1486
  "text": "string | null"
1493
1487
  },
1494
1488
  "default": "null",
1495
1489
  "description": "Aria-label attribute to be set for accessibility",
1496
- "attribute": "aria-label"
1497
- },
1498
- {
1499
- "kind": "method",
1500
- "name": "setSize",
1501
- "privacy": "private",
1502
- "parameters": [
1503
- {
1504
- "name": "size",
1505
- "type": {
1506
- "text": "AvatarSize"
1507
- }
1508
- }
1509
- ]
1490
+ "fieldName": "ariaLabel"
1510
1491
  },
1511
1492
  {
1512
- "kind": "field",
1513
1493
  "name": "src",
1514
1494
  "type": {
1515
1495
  "text": "string | undefined"
1516
1496
  },
1517
1497
  "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.",
1518
- "attribute": "src",
1498
+ "fieldName": "src",
1519
1499
  "inheritedFrom": {
1520
1500
  "name": "AvatarComponentMixin",
1521
- "module": "utils/mixins/AvatarComponentMixin.js"
1501
+ "module": "src/utils/mixins/AvatarComponentMixin.ts"
1522
1502
  }
1523
1503
  },
1524
1504
  {
1525
- "kind": "field",
1526
1505
  "name": "initials",
1527
1506
  "type": {
1528
1507
  "text": "string | undefined"
1529
1508
  },
1530
1509
  "description": "The initials to be displayed for the avatar.",
1531
- "attribute": "initials",
1510
+ "fieldName": "initials",
1532
1511
  "inheritedFrom": {
1533
1512
  "name": "AvatarComponentMixin",
1534
- "module": "utils/mixins/AvatarComponentMixin.js"
1513
+ "module": "src/utils/mixins/AvatarComponentMixin.ts"
1535
1514
  }
1536
1515
  },
1537
1516
  {
1538
- "kind": "field",
1539
1517
  "name": "presence",
1540
1518
  "type": {
1541
1519
  "text": "PresenceType | undefined"
1542
1520
  },
1543
1521
  "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`",
1544
- "attribute": "presence",
1522
+ "fieldName": "presence",
1545
1523
  "inheritedFrom": {
1546
1524
  "name": "AvatarComponentMixin",
1547
- "module": "utils/mixins/AvatarComponentMixin.js"
1525
+ "module": "src/utils/mixins/AvatarComponentMixin.ts"
1548
1526
  }
1549
1527
  },
1550
1528
  {
1551
- "kind": "field",
1552
1529
  "name": "size",
1553
1530
  "type": {
1554
1531
  "text": "ButtonSize"
1555
1532
  },
1556
1533
  "description": "Acceptable values include (size in px unit):\n- 24\n- 32\n- 48\n- 64\n- 72\n- 88\n- 124",
1557
1534
  "default": "32",
1558
- "attribute": "size",
1559
- "reflects": true,
1535
+ "fieldName": "size",
1560
1536
  "inheritedFrom": {
1561
1537
  "name": "Buttonsimple",
1562
- "module": "components/buttonsimple/buttonsimple.component.js"
1538
+ "module": "src/components/buttonsimple/buttonsimple.component.ts"
1563
1539
  }
1564
1540
  },
1565
1541
  {
1566
- "kind": "field",
1567
1542
  "name": "counter",
1568
1543
  "type": {
1569
1544
  "text": "number | undefined"
1570
1545
  },
1571
1546
  "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`.",
1572
- "attribute": "counter",
1547
+ "fieldName": "counter",
1573
1548
  "inheritedFrom": {
1574
1549
  "name": "AvatarComponentMixin",
1575
- "module": "utils/mixins/AvatarComponentMixin.js"
1550
+ "module": "src/utils/mixins/AvatarComponentMixin.ts"
1576
1551
  }
1577
1552
  },
1578
1553
  {
1579
- "kind": "field",
1580
- "name": "isTyping",
1554
+ "name": "is-typing",
1581
1555
  "type": {
1582
1556
  "text": "boolean"
1583
1557
  },
1584
1558
  "default": "false",
1585
1559
  "description": "Represents the typing indicator when the user is typing.",
1586
- "attribute": "is-typing",
1560
+ "fieldName": "isTyping",
1587
1561
  "inheritedFrom": {
1588
1562
  "name": "AvatarComponentMixin",
1589
- "module": "utils/mixins/AvatarComponentMixin.js"
1563
+ "module": "src/utils/mixins/AvatarComponentMixin.ts"
1590
1564
  }
1591
1565
  },
1592
1566
  {
1593
- "kind": "field",
1594
- "name": "iconName",
1567
+ "name": "icon-name",
1595
1568
  "type": {
1596
1569
  "text": "IconNames | undefined"
1597
1570
  },
1598
1571
  "description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
1599
- "attribute": "icon-name",
1572
+ "fieldName": "iconName",
1600
1573
  "inheritedFrom": {
1601
1574
  "name": "IconNameMixin",
1602
- "module": "utils/mixins/IconNameMixin.js"
1575
+ "module": "src/utils/mixins/IconNameMixin.ts"
1603
1576
  }
1604
1577
  },
1605
1578
  {
1606
- "kind": "field",
1607
1579
  "name": "autofocus",
1608
1580
  "type": {
1609
1581
  "text": "boolean"
1610
1582
  },
1611
1583
  "default": "false",
1612
1584
  "description": "This property indicates whether the element should receive focus automatically when it is rendered.",
1613
- "attribute": "autofocus",
1614
- "reflects": true,
1585
+ "fieldName": "autofocus",
1615
1586
  "inheritedFrom": {
1616
1587
  "name": "AutoFocusMixin",
1617
- "module": "utils/mixins/AutoFocusMixin.js"
1588
+ "module": "src/utils/mixins/AutoFocusMixin.ts"
1618
1589
  }
1619
1590
  },
1620
1591
  {
1621
- "kind": "field",
1622
1592
  "name": "tabIndex",
1623
1593
  "type": {
1624
1594
  "text": "number"
1625
1595
  },
1626
1596
  "default": "0",
1627
1597
  "description": "This property specifies the tab order of the element.",
1628
- "attribute": "tabIndex",
1629
- "reflects": true,
1598
+ "fieldName": "tabIndex",
1630
1599
  "inheritedFrom": {
1631
1600
  "name": "TabIndexMixin",
1632
- "module": "utils/mixins/TabIndexMixin.js"
1601
+ "module": "src/utils/mixins/TabIndexMixin.ts"
1633
1602
  }
1634
1603
  },
1635
1604
  {
1636
- "kind": "field",
1637
1605
  "name": "disabled",
1638
1606
  "type": {
1639
1607
  "text": "boolean | undefined"
1640
1608
  },
1641
1609
  "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
1642
1610
  "default": "undefined",
1643
- "attribute": "disabled",
1644
- "reflects": true,
1611
+ "fieldName": "disabled",
1645
1612
  "inheritedFrom": {
1646
1613
  "name": "DisabledMixin",
1647
- "module": "utils/mixins/DisabledMixin.js"
1614
+ "module": "src/utils/mixins/DisabledMixin.ts"
1648
1615
  }
1649
1616
  },
1650
1617
  {
1651
- "kind": "field",
1652
1618
  "name": "active",
1653
1619
  "type": {
1654
1620
  "text": "boolean | undefined"
1655
1621
  },
1656
1622
  "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.",
1657
1623
  "default": "undefined",
1658
- "attribute": "active",
1659
- "reflects": true,
1624
+ "fieldName": "active",
1660
1625
  "inheritedFrom": {
1661
1626
  "name": "Buttonsimple",
1662
- "module": "components/buttonsimple/buttonsimple.component.js"
1627
+ "module": "src/components/buttonsimple/buttonsimple.component.ts"
1663
1628
  }
1664
1629
  },
1665
1630
  {
1666
- "kind": "field",
1667
- "name": "softDisabled",
1631
+ "name": "soft-disabled",
1668
1632
  "type": {
1669
1633
  "text": "boolean | undefined"
1670
1634
  },
1671
1635
  "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.",
1672
1636
  "default": "undefined",
1673
- "attribute": "soft-disabled",
1674
- "reflects": true,
1637
+ "fieldName": "softDisabled",
1675
1638
  "inheritedFrom": {
1676
1639
  "name": "Buttonsimple",
1677
- "module": "components/buttonsimple/buttonsimple.component.js"
1640
+ "module": "src/components/buttonsimple/buttonsimple.component.ts"
1678
1641
  }
1679
1642
  },
1680
1643
  {
1681
- "kind": "field",
1682
1644
  "name": "role",
1683
1645
  "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.",
1684
1646
  "default": "button",
1685
- "attribute": "role",
1686
- "reflects": true,
1647
+ "fieldName": "role",
1687
1648
  "inheritedFrom": {
1688
1649
  "name": "Buttonsimple",
1689
- "module": "components/buttonsimple/buttonsimple.component.js"
1650
+ "module": "src/components/buttonsimple/buttonsimple.component.ts"
1690
1651
  }
1691
1652
  },
1692
1653
  {
1693
- "kind": "field",
1694
1654
  "name": "ariaStateKey",
1695
1655
  "type": {
1696
1656
  "text": "string | undefined"
1697
1657
  },
1698
1658
  "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`",
1699
1659
  "default": "'aria-pressed' (when)",
1700
- "attribute": "ariaStateKey",
1701
- "reflects": true,
1660
+ "fieldName": "ariaStateKey",
1702
1661
  "inheritedFrom": {
1703
1662
  "name": "Buttonsimple",
1704
- "module": "components/buttonsimple/buttonsimple.component.js"
1663
+ "module": "src/components/buttonsimple/buttonsimple.component.ts"
1705
1664
  }
1706
1665
  },
1707
1666
  {
1708
- "kind": "field",
1709
1667
  "name": "type",
1710
1668
  "type": {
1711
1669
  "text": "ButtonType"
1712
1670
  },
1713
1671
  "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.",
1714
1672
  "default": "button",
1715
- "attribute": "type",
1716
- "reflects": true,
1673
+ "fieldName": "type",
1717
1674
  "inheritedFrom": {
1718
1675
  "name": "Buttonsimple",
1719
- "module": "components/buttonsimple/buttonsimple.component.js"
1676
+ "module": "src/components/buttonsimple/buttonsimple.component.ts"
1720
1677
  }
1721
- },
1678
+ }
1679
+ ],
1680
+ "mixins": [
1722
1681
  {
1723
- "kind": "method",
1724
- "name": "executeAction",
1725
- "privacy": "protected",
1726
- "inheritedFrom": {
1727
- "name": "Buttonsimple",
1728
- "module": "components/buttonsimple/buttonsimple.component.js"
1729
- }
1682
+ "name": "AvatarComponentMixin",
1683
+ "module": "/src/utils/mixins/AvatarComponentMixin"
1730
1684
  },
1731
1685
  {
1732
- "kind": "method",
1733
- "name": "setActive",
1734
- "privacy": "protected",
1735
- "parameters": [
1736
- {
1737
- "name": "element",
1738
- "type": {
1739
- "text": "HTMLElement"
1740
- },
1741
- "description": "The button element"
1742
- },
1743
- {
1744
- "name": "active",
1745
- "optional": true,
1746
- "type": {
1747
- "text": "boolean"
1748
- },
1749
- "description": "The active state of the element"
1750
- }
1751
- ],
1752
- "description": "Sets the ariaStateKey attributes based on the active state of the button.",
1753
- "inheritedFrom": {
1754
- "name": "Buttonsimple",
1755
- "module": "components/buttonsimple/buttonsimple.component.js"
1756
- }
1686
+ "name": "IconNameMixin",
1687
+ "module": "/src/utils/mixins/IconNameMixin"
1688
+ }
1689
+ ],
1690
+ "superclass": {
1691
+ "name": "Buttonsimple",
1692
+ "module": "/src/components/buttonsimple/buttonsimple.component"
1693
+ },
1694
+ "tagName": "mdc-avatarbutton",
1695
+ "jsDoc": "/**\n * The `mdc-avatarbutton` component is an interactable version of the `mdc-avatar` component.\n *\n * This component is made by extending `buttonsimple` class.\n * The button component acts as a wrapper for the avatar component.\n *\n * @dependency mdc-avatar\n *\n * @event click - (React: onClick) This event is dispatched when the avatarbutton is clicked.\n * @event keydown - (React: onKeyDown) This event is dispatched when a key is pressed down on the avatarbutton.\n * @event keyup - (React: onKeyUp) This event is dispatched when a key is released on the avatarbutton.\n * @event focus - (React: onFocus) This event is dispatched when the avatarbutton receives focus.\n *\n * @tagname mdc-avatarbutton\n *\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 */",
1696
+ "customElement": true
1697
+ }
1698
+ ],
1699
+ "exports": [
1700
+ {
1701
+ "kind": "js",
1702
+ "name": "default",
1703
+ "declaration": {
1704
+ "name": "AvatarButton",
1705
+ "module": "components/avatarbutton/avatarbutton.component.js"
1706
+ }
1707
+ }
1708
+ ]
1709
+ },
1710
+ {
1711
+ "kind": "javascript-module",
1712
+ "path": "components/badge/badge.component.js",
1713
+ "declarations": [
1714
+ {
1715
+ "kind": "class",
1716
+ "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.",
1717
+ "name": "Badge",
1718
+ "cssProperties": [
1719
+ {
1720
+ "description": "The foreground color of the primary badge.",
1721
+ "name": "--mdc-badge-primary-foreground-color"
1757
1722
  },
1758
1723
  {
1759
- "kind": "method",
1760
- "name": "setSoftDisabled",
1761
- "privacy": "private",
1762
- "parameters": [
1763
- {
1764
- "name": "element",
1765
- "type": {
1766
- "text": "HTMLElement"
1767
- },
1768
- "description": "The button element."
1769
- },
1770
- {
1771
- "name": "softDisabled",
1772
- "optional": true,
1773
- "type": {
1774
- "text": "boolean"
1775
- },
1776
- "description": "The soft-disabled state."
1777
- }
1778
- ],
1779
- "description": "Sets the soft-disabled attribute for the button.\nWhen soft-disabled, the button looks to be disabled but remains focusable and clickable.\nAlso sets/removes aria-disabled attribute.",
1780
- "inheritedFrom": {
1781
- "name": "Buttonsimple",
1782
- "module": "components/buttonsimple/buttonsimple.component.js"
1783
- }
1724
+ "description": "The background color of the primary badge.",
1725
+ "name": "--mdc-badge-primary-background-color"
1784
1726
  },
1785
1727
  {
1786
- "kind": "method",
1787
- "name": "setDisabled",
1788
- "privacy": "private",
1789
- "parameters": [
1790
- {
1791
- "name": "element",
1792
- "type": {
1793
- "text": "HTMLElement"
1794
- },
1795
- "description": "The button element."
1796
- },
1797
- {
1798
- "name": "disabled",
1799
- "type": {
1800
- "text": "boolean"
1801
- },
1802
- "description": "The disabled state."
1803
- }
1804
- ],
1805
- "description": "Sets the disabled attribute for the button.\nWhen disabled, the button is not focusable or clickable, and tabindex is set to -1.\nThe previous tabindex is stored and restored when enabled.\nAlso sets/removes aria-disabled attribute.",
1806
- "inheritedFrom": {
1807
- "name": "Buttonsimple",
1808
- "module": "components/buttonsimple/buttonsimple.component.js"
1809
- }
1728
+ "description": "The foreground color of the secondary badge.",
1729
+ "name": "--mdc-badge-secondary-foreground-color"
1810
1730
  },
1811
1731
  {
1812
- "kind": "method",
1813
- "name": "triggerClickEvent",
1814
- "privacy": "private",
1815
- "inheritedFrom": {
1816
- "name": "Buttonsimple",
1817
- "module": "components/buttonsimple/buttonsimple.component.js"
1818
- }
1732
+ "description": "The background color of the secondary badge.",
1733
+ "name": "--mdc-badge-secondary-background-color"
1819
1734
  },
1820
1735
  {
1821
- "kind": "method",
1822
- "name": "handleBlur",
1823
- "privacy": "private",
1824
- "description": "In case the button is pressed and the focus is lost while pressing,\nthe pressed class is removed.",
1825
- "inheritedFrom": {
1826
- "name": "Buttonsimple",
1827
- "module": "components/buttonsimple/buttonsimple.component.js"
1828
- }
1736
+ "description": "The foreground color of the success badge.",
1737
+ "name": "--mdc-badge-success-foreground-color"
1829
1738
  },
1830
1739
  {
1831
- "kind": "method",
1832
- "name": "handleKeyDown",
1833
- "privacy": "private",
1834
- "parameters": [
1835
- {
1836
- "name": "event",
1837
- "type": {
1838
- "text": "KeyboardEvent"
1839
- },
1840
- "description": "The keyboard event."
1841
- }
1842
- ],
1843
- "description": "Handles the keydown event on the button.\nIf the key is 'Enter' or 'Space', the button is pressed.\nIf the key is 'Enter', the button is pressed. The native HTML button works in the same way.\nIf the key is 'Space', the button's default is prevent to avoid scrolling etc in the host application.",
1844
- "inheritedFrom": {
1845
- "name": "Buttonsimple",
1846
- "module": "components/buttonsimple/buttonsimple.component.js"
1847
- }
1740
+ "description": "The background color of the success badge.",
1741
+ "name": "--mdc-badge-success-background-color"
1848
1742
  },
1849
1743
  {
1850
- "kind": "method",
1851
- "name": "handleKeyUp",
1852
- "privacy": "private",
1853
- "parameters": [
1854
- {
1855
- "name": "event",
1856
- "type": {
1857
- "text": "KeyboardEvent"
1858
- },
1859
- "description": "The keyboard event."
1860
- }
1861
- ],
1862
- "description": "Handles the keyup event on the button.\nIf the key is 'Enter' or 'Space', the button is clicked.\nIf the key is 'Space', the button is pressed. The native HTML button works in the same way.",
1863
- "inheritedFrom": {
1864
- "name": "Buttonsimple",
1865
- "module": "components/buttonsimple/buttonsimple.component.js"
1866
- }
1867
- }
1868
- ],
1869
- "events": [
1744
+ "description": "The foreground color of the warning badge.",
1745
+ "name": "--mdc-badge-warning-foreground-color"
1746
+ },
1870
1747
  {
1871
- "description": "(React: onClick) This event is dispatched when the avatarbutton is clicked.",
1872
- "name": "click",
1873
- "reactName": "onClick",
1874
- "inheritedFrom": {
1875
- "name": "Buttonsimple",
1876
- "module": "src/components/buttonsimple/buttonsimple.component.ts"
1877
- }
1748
+ "description": "The background color of the warning badge.",
1749
+ "name": "--mdc-badge-warning-background-color"
1878
1750
  },
1879
1751
  {
1880
- "description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the avatarbutton.",
1881
- "name": "keydown",
1882
- "reactName": "onKeyDown",
1883
- "inheritedFrom": {
1884
- "name": "Buttonsimple",
1885
- "module": "src/components/buttonsimple/buttonsimple.component.ts"
1886
- }
1752
+ "description": "The foreground color of the error badge.",
1753
+ "name": "--mdc-badge-error-foreground-color"
1887
1754
  },
1888
1755
  {
1889
- "description": "(React: onKeyUp) This event is dispatched when a key is released on the avatarbutton.",
1890
- "name": "keyup",
1891
- "reactName": "onKeyUp",
1892
- "inheritedFrom": {
1893
- "name": "Buttonsimple",
1894
- "module": "src/components/buttonsimple/buttonsimple.component.ts"
1895
- }
1756
+ "description": "The background color of the error badge.",
1757
+ "name": "--mdc-badge-error-background-color"
1896
1758
  },
1897
1759
  {
1898
- "description": "(React: onFocus) This event is dispatched when the avatarbutton receives focus.",
1899
- "name": "focus",
1900
- "reactName": "onFocus",
1901
- "inheritedFrom": {
1902
- "name": "Buttonsimple",
1903
- "module": "src/components/buttonsimple/buttonsimple.component.ts"
1904
- }
1760
+ "description": "The background color of the badge overlay.",
1761
+ "name": "--mdc-badge-overlay-background-color"
1905
1762
  }
1906
1763
  ],
1907
- "attributes": [
1764
+ "members": [
1908
1765
  {
1909
- "name": "aria-label",
1766
+ "kind": "field",
1767
+ "name": "type",
1910
1768
  "type": {
1911
- "text": "string | null"
1769
+ "text": "BadgeType | undefined"
1912
1770
  },
1913
- "default": "null",
1914
- "description": "Aria-label attribute to be set for accessibility",
1915
- "fieldName": "ariaLabel"
1771
+ "description": "Type of the badge\nCan be `dot` (notification) , `icon`, `counter`, `success`, `warning` or `error`.",
1772
+ "attribute": "type",
1773
+ "reflects": true
1916
1774
  },
1917
1775
  {
1918
- "name": "src",
1776
+ "kind": "field",
1777
+ "name": "variant",
1919
1778
  "type": {
1920
- "text": "string | undefined"
1779
+ "text": "IconVariant"
1921
1780
  },
1922
- "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.",
1923
- "fieldName": "src",
1924
- "inheritedFrom": {
1925
- "name": "AvatarComponentMixin",
1926
- "module": "src/utils/mixins/AvatarComponentMixin.ts"
1927
- }
1781
+ "description": "Type of the variant can be `primary` or `secondary`.\nIt defines the background and foreground color of the icon.",
1782
+ "default": "primary",
1783
+ "attribute": "variant",
1784
+ "reflects": true
1928
1785
  },
1929
1786
  {
1930
- "name": "initials",
1787
+ "kind": "field",
1788
+ "name": "counter",
1931
1789
  "type": {
1932
- "text": "string | undefined"
1790
+ "text": "number | undefined"
1933
1791
  },
1934
- "description": "The initials to be displayed for the avatar.",
1935
- "fieldName": "initials",
1936
- "inheritedFrom": {
1937
- "name": "AvatarComponentMixin",
1938
- "module": "src/utils/mixins/AvatarComponentMixin.ts"
1939
- }
1792
+ "description": "Counter is the number which can be provided in the badge.",
1793
+ "attribute": "counter"
1940
1794
  },
1941
1795
  {
1942
- "name": "presence",
1796
+ "kind": "field",
1797
+ "name": "maxCounter",
1943
1798
  "type": {
1944
- "text": "PresenceType | undefined"
1799
+ "text": "number"
1945
1800
  },
1946
- "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`",
1947
- "fieldName": "presence",
1948
- "inheritedFrom": {
1949
- "name": "AvatarComponentMixin",
1950
- "module": "src/utils/mixins/AvatarComponentMixin.ts"
1951
- }
1801
+ "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`.",
1802
+ "default": "99",
1803
+ "attribute": "max-counter",
1804
+ "reflects": true
1952
1805
  },
1953
1806
  {
1954
- "name": "size",
1807
+ "kind": "field",
1808
+ "name": "overlay",
1955
1809
  "type": {
1956
- "text": "ButtonSize"
1810
+ "text": "boolean"
1957
1811
  },
1958
- "description": "Acceptable values include (size in px unit):\n- 24\n- 32\n- 48\n- 64\n- 72\n- 88\n- 124",
1959
- "default": "32",
1960
- "fieldName": "size",
1961
- "inheritedFrom": {
1962
- "name": "Buttonsimple",
1963
- "module": "src/components/buttonsimple/buttonsimple.component.ts"
1964
- }
1812
+ "default": "false",
1813
+ "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.",
1814
+ "attribute": "overlay"
1965
1815
  },
1966
1816
  {
1967
- "name": "counter",
1817
+ "kind": "field",
1818
+ "name": "ariaLabel",
1968
1819
  "type": {
1969
- "text": "number | undefined"
1820
+ "text": "string | null"
1821
+ },
1822
+ "default": "null",
1823
+ "description": "Aria-label attribute to be set for accessibility",
1824
+ "attribute": "aria-label"
1825
+ },
1826
+ {
1827
+ "kind": "method",
1828
+ "name": "getCounterText",
1829
+ "privacy": "private",
1830
+ "return": {
1831
+ "type": {
1832
+ "text": ""
1833
+ }
1834
+ },
1835
+ "parameters": [
1836
+ {
1837
+ "name": "maxCounter",
1838
+ "type": {
1839
+ "text": "number"
1840
+ },
1841
+ "description": "the maximum limit which can be displayed on the badge"
1842
+ },
1843
+ {
1844
+ "name": "counter",
1845
+ "optional": true,
1846
+ "type": {
1847
+ "text": "number"
1848
+ },
1849
+ "description": "the number to be displayed on the badge"
1850
+ }
1851
+ ],
1852
+ "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."
1853
+ },
1854
+ {
1855
+ "kind": "method",
1856
+ "name": "getBadgeIcon",
1857
+ "privacy": "private",
1858
+ "return": {
1859
+ "type": {
1860
+ "text": ""
1861
+ }
1862
+ },
1863
+ "parameters": [
1864
+ {
1865
+ "name": "iconName",
1866
+ "type": {
1867
+ "text": "string"
1868
+ },
1869
+ "description": "the name of the icon from the icon set"
1870
+ },
1871
+ {
1872
+ "name": "backgroundClassPostfix",
1873
+ "type": {
1874
+ "text": "string"
1875
+ },
1876
+ "description": "postfix for the class to style the badge icon."
1877
+ }
1878
+ ],
1879
+ "description": "Method to generate the badge icon."
1880
+ },
1881
+ {
1882
+ "kind": "method",
1883
+ "name": "getBadgeDot",
1884
+ "privacy": "private",
1885
+ "return": {
1886
+ "type": {
1887
+ "text": ""
1888
+ }
1889
+ },
1890
+ "description": "Method to generate the badge dot template."
1891
+ },
1892
+ {
1893
+ "kind": "method",
1894
+ "name": "getBadgeCounterText",
1895
+ "privacy": "private",
1896
+ "return": {
1897
+ "type": {
1898
+ "text": ""
1899
+ }
1900
+ },
1901
+ "description": "Method to generate the badge text and counter template."
1902
+ },
1903
+ {
1904
+ "kind": "method",
1905
+ "name": "setRoleByAriaLabel",
1906
+ "privacy": "private",
1907
+ "return": {
1908
+ "type": {
1909
+ "text": "void"
1910
+ }
1970
1911
  },
1971
- "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`.",
1972
- "fieldName": "counter",
1973
- "inheritedFrom": {
1974
- "name": "AvatarComponentMixin",
1975
- "module": "src/utils/mixins/AvatarComponentMixin.ts"
1976
- }
1912
+ "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."
1977
1913
  },
1978
1914
  {
1979
- "name": "is-typing",
1980
- "type": {
1981
- "text": "boolean"
1915
+ "kind": "method",
1916
+ "name": "getBadgeContentBasedOnType",
1917
+ "privacy": "private",
1918
+ "return": {
1919
+ "type": {
1920
+ "text": ""
1921
+ }
1982
1922
  },
1983
- "default": "false",
1984
- "description": "Represents the typing indicator when the user is typing.",
1985
- "fieldName": "isTyping",
1986
- "inheritedFrom": {
1987
- "name": "AvatarComponentMixin",
1988
- "module": "src/utils/mixins/AvatarComponentMixin.ts"
1989
- }
1923
+ "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."
1990
1924
  },
1991
1925
  {
1992
- "name": "icon-name",
1926
+ "kind": "field",
1927
+ "name": "iconName",
1993
1928
  "type": {
1994
1929
  "text": "IconNames | undefined"
1995
1930
  },
1996
1931
  "description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
1997
- "fieldName": "iconName",
1932
+ "attribute": "icon-name",
1998
1933
  "inheritedFrom": {
1999
1934
  "name": "IconNameMixin",
2000
- "module": "src/utils/mixins/IconNameMixin.ts"
1935
+ "module": "utils/mixins/IconNameMixin.js"
2001
1936
  }
2002
- },
1937
+ }
1938
+ ],
1939
+ "attributes": [
2003
1940
  {
2004
- "name": "autofocus",
1941
+ "name": "type",
2005
1942
  "type": {
2006
- "text": "boolean"
1943
+ "text": "BadgeType | undefined"
2007
1944
  },
2008
- "default": "false",
2009
- "description": "This property indicates whether the element should receive focus automatically when it is rendered.",
2010
- "fieldName": "autofocus",
2011
- "inheritedFrom": {
2012
- "name": "AutoFocusMixin",
2013
- "module": "src/utils/mixins/AutoFocusMixin.ts"
2014
- }
1945
+ "description": "Type of the badge\nCan be `dot` (notification) , `icon`, `counter`, `success`, `warning` or `error`.",
1946
+ "fieldName": "type"
2015
1947
  },
2016
1948
  {
2017
- "name": "tabIndex",
1949
+ "name": "variant",
2018
1950
  "type": {
2019
- "text": "number"
1951
+ "text": "IconVariant"
2020
1952
  },
2021
- "default": "0",
2022
- "description": "This property specifies the tab order of the element.",
2023
- "fieldName": "tabIndex",
2024
- "inheritedFrom": {
2025
- "name": "TabIndexMixin",
2026
- "module": "src/utils/mixins/TabIndexMixin.ts"
2027
- }
1953
+ "description": "Type of the variant can be `primary` or `secondary`.\nIt defines the background and foreground color of the icon.",
1954
+ "default": "primary",
1955
+ "fieldName": "variant"
2028
1956
  },
2029
1957
  {
2030
- "name": "disabled",
1958
+ "name": "counter",
2031
1959
  "type": {
2032
- "text": "boolean | undefined"
1960
+ "text": "number | undefined"
2033
1961
  },
2034
- "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
2035
- "default": "undefined",
2036
- "fieldName": "disabled",
2037
- "inheritedFrom": {
2038
- "name": "DisabledMixin",
2039
- "module": "src/utils/mixins/DisabledMixin.ts"
2040
- }
1962
+ "description": "Counter is the number which can be provided in the badge.",
1963
+ "fieldName": "counter"
2041
1964
  },
2042
1965
  {
2043
- "name": "active",
1966
+ "name": "max-counter",
2044
1967
  "type": {
2045
- "text": "boolean | undefined"
1968
+ "text": "number"
2046
1969
  },
2047
- "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.",
2048
- "default": "undefined",
2049
- "fieldName": "active",
2050
- "inheritedFrom": {
2051
- "name": "Buttonsimple",
2052
- "module": "src/components/buttonsimple/buttonsimple.component.ts"
2053
- }
1970
+ "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`.",
1971
+ "default": "99",
1972
+ "fieldName": "maxCounter"
2054
1973
  },
2055
1974
  {
2056
- "name": "soft-disabled",
1975
+ "name": "overlay",
2057
1976
  "type": {
2058
- "text": "boolean | undefined"
1977
+ "text": "boolean"
2059
1978
  },
2060
- "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.",
2061
- "default": "undefined",
2062
- "fieldName": "softDisabled",
2063
- "inheritedFrom": {
2064
- "name": "Buttonsimple",
2065
- "module": "src/components/buttonsimple/buttonsimple.component.ts"
2066
- }
2067
- },
2068
- {
2069
- "name": "role",
2070
- "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.",
2071
- "default": "button",
2072
- "fieldName": "role",
2073
- "inheritedFrom": {
2074
- "name": "Buttonsimple",
2075
- "module": "src/components/buttonsimple/buttonsimple.component.ts"
2076
- }
1979
+ "default": "false",
1980
+ "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.",
1981
+ "fieldName": "overlay"
2077
1982
  },
2078
1983
  {
2079
- "name": "ariaStateKey",
1984
+ "name": "aria-label",
2080
1985
  "type": {
2081
- "text": "string | undefined"
1986
+ "text": "string | null"
2082
1987
  },
2083
- "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`",
2084
- "default": "'aria-pressed' (when)",
2085
- "fieldName": "ariaStateKey",
2086
- "inheritedFrom": {
2087
- "name": "Buttonsimple",
2088
- "module": "src/components/buttonsimple/buttonsimple.component.ts"
2089
- }
1988
+ "default": "null",
1989
+ "description": "Aria-label attribute to be set for accessibility",
1990
+ "fieldName": "ariaLabel"
2090
1991
  },
2091
1992
  {
2092
- "name": "type",
1993
+ "name": "icon-name",
2093
1994
  "type": {
2094
- "text": "ButtonType"
1995
+ "text": "IconNames | undefined"
2095
1996
  },
2096
- "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.",
2097
- "default": "button",
2098
- "fieldName": "type",
1997
+ "description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
1998
+ "fieldName": "iconName",
2099
1999
  "inheritedFrom": {
2100
- "name": "Buttonsimple",
2101
- "module": "src/components/buttonsimple/buttonsimple.component.ts"
2000
+ "name": "IconNameMixin",
2001
+ "module": "src/utils/mixins/IconNameMixin.ts"
2102
2002
  }
2103
2003
  }
2104
2004
  ],
2105
2005
  "mixins": [
2106
- {
2107
- "name": "AvatarComponentMixin",
2108
- "module": "/src/utils/mixins/AvatarComponentMixin"
2109
- },
2110
2006
  {
2111
2007
  "name": "IconNameMixin",
2112
2008
  "module": "/src/utils/mixins/IconNameMixin"
2113
2009
  }
2114
2010
  ],
2115
2011
  "superclass": {
2116
- "name": "Buttonsimple",
2117
- "module": "/src/components/buttonsimple/buttonsimple.component"
2012
+ "name": "Component",
2013
+ "module": "/src/models"
2118
2014
  },
2119
- "tagName": "mdc-avatarbutton",
2120
- "jsDoc": "/**\n * The `mdc-avatarbutton` component is an interactable version of the `mdc-avatar` component.\n *\n * This component is made by extending `buttonsimple` class.\n * The button component acts as a wrapper for the avatar component.\n *\n * @dependency mdc-avatar\n *\n * @event click - (React: onClick) This event is dispatched when the avatarbutton is clicked.\n * @event keydown - (React: onKeyDown) This event is dispatched when a key is pressed down on the avatarbutton.\n * @event keyup - (React: onKeyUp) This event is dispatched when a key is released on the avatarbutton.\n * @event focus - (React: onFocus) This event is dispatched when the avatarbutton receives focus.\n *\n * @tagname mdc-avatarbutton\n *\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 */",
2015
+ "tagName": "mdc-badge",
2016
+ "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 */",
2121
2017
  "customElement": true
2122
2018
  }
2123
2019
  ],
@@ -2126,69 +2022,102 @@
2126
2022
  "kind": "js",
2127
2023
  "name": "default",
2128
2024
  "declaration": {
2129
- "name": "AvatarButton",
2130
- "module": "components/avatarbutton/avatarbutton.component.js"
2025
+ "name": "Badge",
2026
+ "module": "components/badge/badge.component.js"
2131
2027
  }
2132
2028
  }
2133
2029
  ]
2134
2030
  },
2135
2031
  {
2136
2032
  "kind": "javascript-module",
2137
- "path": "components/bullet/bullet.component.js",
2033
+ "path": "components/brandvisual/brandvisual.component.js",
2138
2034
  "declarations": [
2139
2035
  {
2140
2036
  "kind": "class",
2141
- "description": "Bullet component, which is a visual marker\nand be used to organize and present items in a list format.",
2142
- "name": "Bullet",
2143
- "cssProperties": [
2037
+ "description": "The `mdc-brandvisual` component is responsible for rendering logos dynamically & ensures they are\ndisplayed correctly within applications.\n\nFeatures:\n- Dynamically loads brandvisuals based on the `name` attribute.\n- Emits a `load` event when the brandvisual is successfully fetched.\n- Emits an `error` event when the brandvisual import fails.\n- Supports accessibility best practices.\n- Used for brand representation within the design system.",
2038
+ "name": "Brandvisual",
2039
+ "members": [
2144
2040
  {
2145
- "description": "background color of the bullet",
2146
- "name": "--mdc-bullet-background-color"
2041
+ "kind": "field",
2042
+ "name": "brandVisualData",
2043
+ "type": {
2044
+ "text": "HTMLElement | undefined"
2045
+ },
2046
+ "privacy": "private"
2147
2047
  },
2148
2048
  {
2149
- "description": "small size value of the bullet",
2150
- "name": "--mdc-bullet-size-small"
2049
+ "kind": "field",
2050
+ "name": "name",
2051
+ "type": {
2052
+ "text": "BrandVisualNames | undefined"
2053
+ },
2054
+ "description": "Name of the brandVisual (= filename)",
2055
+ "attribute": "name",
2056
+ "reflects": true
2151
2057
  },
2152
2058
  {
2153
- "description": "medium size value of the bullet",
2154
- "name": "--mdc-bullet-size-medium"
2059
+ "kind": "method",
2060
+ "name": "getBrandVisualData",
2061
+ "privacy": "private"
2155
2062
  },
2156
2063
  {
2157
- "description": "large size value of the bullet",
2158
- "name": "--mdc-bullet-size-large"
2064
+ "kind": "method",
2065
+ "name": "handleBrandVisualLoadedSuccess",
2066
+ "privacy": "private",
2067
+ "parameters": [
2068
+ {
2069
+ "name": "brandVisualHtml",
2070
+ "type": {
2071
+ "text": "HTMLElement"
2072
+ },
2073
+ "description": "The brandvisual html element which has been fetched from the brandvisual provider."
2074
+ }
2075
+ ],
2076
+ "description": "Sets the brandVisualData state to the fetched brandvisual.\nDispatches a 'load' event on the component once the brandvisual has been successfully loaded."
2077
+ },
2078
+ {
2079
+ "kind": "method",
2080
+ "name": "handleBrandVisualLoadedFailure",
2081
+ "privacy": "private",
2082
+ "parameters": [
2083
+ {
2084
+ "name": "error",
2085
+ "type": {
2086
+ "text": "unknown"
2087
+ }
2088
+ }
2089
+ ],
2090
+ "description": "Dispatches an 'error' event on the component when the brandvisual import has failed.\nThis event bubbles and is cancelable.\nThe error detail is set to the error object."
2159
2091
  }
2160
2092
  ],
2161
- "members": [
2093
+ "events": [
2162
2094
  {
2163
- "kind": "field",
2164
- "name": "size",
2165
- "type": {
2166
- "text": "Size"
2167
- },
2168
- "privacy": "public",
2169
- "description": "Size of the bullet\n\nPossible values: 'small', 'medium', 'large'",
2170
- "default": "small",
2171
- "attribute": "size",
2172
- "reflects": true
2095
+ "description": "(React: onLoad) This event is dispatched when the brandvisual has been successfully loaded.",
2096
+ "name": "load",
2097
+ "reactName": "onLoad"
2098
+ },
2099
+ {
2100
+ "description": "(React: onError) This event is dispatched when the brandvisual fetching has failed.",
2101
+ "name": "error",
2102
+ "reactName": "onError"
2173
2103
  }
2174
2104
  ],
2175
2105
  "attributes": [
2176
2106
  {
2177
- "name": "size",
2107
+ "name": "name",
2178
2108
  "type": {
2179
- "text": "Size"
2109
+ "text": "BrandVisualNames | undefined"
2180
2110
  },
2181
- "description": "Size of the bullet\n\nPossible values: 'small', 'medium', 'large'",
2182
- "default": "small",
2183
- "fieldName": "size"
2111
+ "description": "Name of the brandVisual (= filename)",
2112
+ "fieldName": "name"
2184
2113
  }
2185
2114
  ],
2186
2115
  "superclass": {
2187
2116
  "name": "Component",
2188
2117
  "module": "/src/models"
2189
2118
  },
2190
- "tagName": "mdc-bullet",
2191
- "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*/",
2119
+ "tagName": "mdc-brandvisual",
2120
+ "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 */",
2192
2121
  "customElement": true
2193
2122
  }
2194
2123
  ],
@@ -2196,9 +2125,9 @@
2196
2125
  {
2197
2126
  "kind": "js",
2198
2127
  "name": "default",
2199
- "declaration": {
2200
- "name": "Bullet",
2201
- "module": "components/bullet/bullet.component.js"
2128
+ "declaration": {
2129
+ "name": "Brandvisual",
2130
+ "module": "components/brandvisual/brandvisual.component.js"
2202
2131
  }
2203
2132
  }
2204
2133
  ]
@@ -2782,109 +2711,312 @@
2782
2711
  }
2783
2712
  },
2784
2713
  {
2785
- "name": "active",
2714
+ "name": "active",
2715
+ "type": {
2716
+ "text": "boolean | undefined"
2717
+ },
2718
+ "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.",
2719
+ "default": "undefined",
2720
+ "fieldName": "active",
2721
+ "inheritedFrom": {
2722
+ "name": "Buttonsimple",
2723
+ "module": "src/components/buttonsimple/buttonsimple.component.ts"
2724
+ }
2725
+ },
2726
+ {
2727
+ "name": "soft-disabled",
2728
+ "type": {
2729
+ "text": "boolean | undefined"
2730
+ },
2731
+ "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.",
2732
+ "default": "undefined",
2733
+ "fieldName": "softDisabled",
2734
+ "inheritedFrom": {
2735
+ "name": "Buttonsimple",
2736
+ "module": "src/components/buttonsimple/buttonsimple.component.ts"
2737
+ }
2738
+ },
2739
+ {
2740
+ "name": "ariaStateKey",
2741
+ "type": {
2742
+ "text": "string | undefined"
2743
+ },
2744
+ "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`",
2745
+ "default": "'aria-pressed' (when)",
2746
+ "fieldName": "ariaStateKey",
2747
+ "inheritedFrom": {
2748
+ "name": "Buttonsimple",
2749
+ "module": "src/components/buttonsimple/buttonsimple.component.ts"
2750
+ }
2751
+ },
2752
+ {
2753
+ "name": "type",
2754
+ "type": {
2755
+ "text": "ButtonType"
2756
+ },
2757
+ "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.",
2758
+ "default": "button",
2759
+ "fieldName": "type",
2760
+ "inheritedFrom": {
2761
+ "name": "Buttonsimple",
2762
+ "module": "src/components/buttonsimple/buttonsimple.component.ts"
2763
+ }
2764
+ }
2765
+ ],
2766
+ "mixins": [
2767
+ {
2768
+ "name": "ButtonComponentMixin",
2769
+ "module": "/src/utils/mixins/ButtonComponentMixin"
2770
+ }
2771
+ ],
2772
+ "superclass": {
2773
+ "name": "Buttonsimple",
2774
+ "module": "/src/components/buttonsimple/buttonsimple.component"
2775
+ },
2776
+ "tagName": "mdc-button",
2777
+ "jsDoc": "/**\n * `mdc-button` is a component that can be configured in various ways to suit different use cases.\n *\n * Button Variants:\n * - **Primary**: Solid background color.\n * - **Secondary**: Transparent background with a solid border.\n * - **Tertiary**: No background or border, appears as plain text but retains all button functionalities.\n *\n * Button Colors:\n * - **Positive**: Green color.\n * - **Negative**: Red color.\n * - **Accent**: Blue color.\n * - **Promotional**: Purple color.\n * - **Default**: White color.\n *\n * Button Sizes (in REM units):\n * - **Pill button**: 40, 32, 28, 24.\n * - **Icon button**: 64, 52, 40, 32, 28, 24.\n * - **Tertiary icon button**: 20.\n *\n * Button Types:\n * - **Pill button**: A button that contains text value. Commonly used for call to action, tags, or filters.\n * - **Pill button with icons**: A button containing an icon either on the left or right side of the button.\n * - **Icon button**: A button represented by just an icon without any text.\n * The type of button is inferred based on the presence of slot and/or prefix and postfix icons.\n *\n * @dependency mdc-icon\n *\n * @tagname mdc-button\n *\n * @slot - Text label of the button.\n */",
2778
+ "customElement": true,
2779
+ "events": [
2780
+ {
2781
+ "description": "(React: onClick) This event is dispatched when the button is clicked.",
2782
+ "name": "click",
2783
+ "reactName": "onClick",
2784
+ "inheritedFrom": {
2785
+ "name": "Buttonsimple",
2786
+ "module": "src/components/buttonsimple/buttonsimple.component.ts"
2787
+ }
2788
+ },
2789
+ {
2790
+ "description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the button.",
2791
+ "name": "keydown",
2792
+ "reactName": "onKeyDown",
2793
+ "inheritedFrom": {
2794
+ "name": "Buttonsimple",
2795
+ "module": "src/components/buttonsimple/buttonsimple.component.ts"
2796
+ }
2797
+ },
2798
+ {
2799
+ "description": "(React: onKeyUp) This event is dispatched when a key is released on the button.",
2800
+ "name": "keyup",
2801
+ "reactName": "onKeyUp",
2802
+ "inheritedFrom": {
2803
+ "name": "Buttonsimple",
2804
+ "module": "src/components/buttonsimple/buttonsimple.component.ts"
2805
+ }
2806
+ },
2807
+ {
2808
+ "description": "(React: onFocus) This event is dispatched when the button receives focus.",
2809
+ "name": "focus",
2810
+ "reactName": "onFocus",
2811
+ "inheritedFrom": {
2812
+ "name": "Buttonsimple",
2813
+ "module": "src/components/buttonsimple/buttonsimple.component.ts"
2814
+ }
2815
+ }
2816
+ ]
2817
+ }
2818
+ ],
2819
+ "exports": [
2820
+ {
2821
+ "kind": "js",
2822
+ "name": "default",
2823
+ "declaration": {
2824
+ "name": "Button",
2825
+ "module": "components/button/button.component.js"
2826
+ }
2827
+ }
2828
+ ]
2829
+ },
2830
+ {
2831
+ "kind": "javascript-module",
2832
+ "path": "components/bullet/bullet.component.js",
2833
+ "declarations": [
2834
+ {
2835
+ "kind": "class",
2836
+ "description": "Bullet component, which is a visual marker\nand be used to organize and present items in a list format.",
2837
+ "name": "Bullet",
2838
+ "cssProperties": [
2839
+ {
2840
+ "description": "background color of the bullet",
2841
+ "name": "--mdc-bullet-background-color"
2842
+ },
2843
+ {
2844
+ "description": "small size value of the bullet",
2845
+ "name": "--mdc-bullet-size-small"
2846
+ },
2847
+ {
2848
+ "description": "medium size value of the bullet",
2849
+ "name": "--mdc-bullet-size-medium"
2850
+ },
2851
+ {
2852
+ "description": "large size value of the bullet",
2853
+ "name": "--mdc-bullet-size-large"
2854
+ }
2855
+ ],
2856
+ "members": [
2857
+ {
2858
+ "kind": "field",
2859
+ "name": "size",
2860
+ "type": {
2861
+ "text": "Size"
2862
+ },
2863
+ "privacy": "public",
2864
+ "description": "Size of the bullet\n\nPossible values: 'small', 'medium', 'large'",
2865
+ "default": "small",
2866
+ "attribute": "size",
2867
+ "reflects": true
2868
+ }
2869
+ ],
2870
+ "attributes": [
2871
+ {
2872
+ "name": "size",
2873
+ "type": {
2874
+ "text": "Size"
2875
+ },
2876
+ "description": "Size of the bullet\n\nPossible values: 'small', 'medium', 'large'",
2877
+ "default": "small",
2878
+ "fieldName": "size"
2879
+ }
2880
+ ],
2881
+ "superclass": {
2882
+ "name": "Component",
2883
+ "module": "/src/models"
2884
+ },
2885
+ "tagName": "mdc-bullet",
2886
+ "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*/",
2887
+ "customElement": true
2888
+ }
2889
+ ],
2890
+ "exports": [
2891
+ {
2892
+ "kind": "js",
2893
+ "name": "default",
2894
+ "declaration": {
2895
+ "name": "Bullet",
2896
+ "module": "components/bullet/bullet.component.js"
2897
+ }
2898
+ }
2899
+ ]
2900
+ },
2901
+ {
2902
+ "kind": "javascript-module",
2903
+ "path": "components/buttongroup/buttongroup.component.js",
2904
+ "declarations": [
2905
+ {
2906
+ "kind": "class",
2907
+ "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.",
2908
+ "name": "ButtonGroup",
2909
+ "cssProperties": [
2910
+ {
2911
+ "description": "The border radius of the buttongroup",
2912
+ "name": "--mdc-buttongroup-border-radius"
2913
+ },
2914
+ {
2915
+ "description": "The border color of the buttongroup",
2916
+ "name": "--mdc-buttongroup-border-color"
2917
+ },
2918
+ {
2919
+ "description": "The color of the divider between buttons within the buttongroup",
2920
+ "name": "--mdc-buttongroup-divider-color"
2921
+ }
2922
+ ],
2923
+ "slots": [
2924
+ {
2925
+ "description": "This is a default/unnamed slot, which contains the buttons",
2926
+ "name": "default"
2927
+ }
2928
+ ],
2929
+ "members": [
2930
+ {
2931
+ "kind": "field",
2932
+ "name": "orientation",
2933
+ "type": {
2934
+ "text": "ButtonGroupOrientation"
2935
+ },
2936
+ "description": "Orientation of the buttongroup.",
2937
+ "default": "'horizontal'",
2938
+ "attribute": "orientation",
2939
+ "reflects": true
2940
+ },
2941
+ {
2942
+ "kind": "field",
2943
+ "name": "variant",
2944
+ "type": {
2945
+ "text": "ButtonGroupVariant"
2946
+ },
2947
+ "description": "Variant of the buttons within the buttongroup.",
2948
+ "default": "'primary'",
2949
+ "attribute": "variant",
2950
+ "reflects": true
2951
+ },
2952
+ {
2953
+ "kind": "field",
2954
+ "name": "size",
2955
+ "type": {
2956
+ "text": "ButtonGroupSize"
2957
+ },
2958
+ "description": "Size of the buttons within the buttongroup.",
2959
+ "default": "'28'",
2960
+ "attribute": "size",
2961
+ "reflects": true
2962
+ },
2963
+ {
2964
+ "kind": "field",
2965
+ "name": "compact",
2966
+ "type": {
2967
+ "text": "boolean"
2968
+ },
2969
+ "default": "false",
2970
+ "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.",
2971
+ "attribute": "compact",
2972
+ "reflects": true
2973
+ }
2974
+ ],
2975
+ "attributes": [
2976
+ {
2977
+ "name": "orientation",
2786
2978
  "type": {
2787
- "text": "boolean | undefined"
2979
+ "text": "ButtonGroupOrientation"
2788
2980
  },
2789
- "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.",
2790
- "default": "undefined",
2791
- "fieldName": "active",
2792
- "inheritedFrom": {
2793
- "name": "Buttonsimple",
2794
- "module": "src/components/buttonsimple/buttonsimple.component.ts"
2795
- }
2981
+ "description": "Orientation of the buttongroup.",
2982
+ "default": "'horizontal'",
2983
+ "fieldName": "orientation"
2796
2984
  },
2797
2985
  {
2798
- "name": "soft-disabled",
2986
+ "name": "variant",
2799
2987
  "type": {
2800
- "text": "boolean | undefined"
2988
+ "text": "ButtonGroupVariant"
2801
2989
  },
2802
- "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.",
2803
- "default": "undefined",
2804
- "fieldName": "softDisabled",
2805
- "inheritedFrom": {
2806
- "name": "Buttonsimple",
2807
- "module": "src/components/buttonsimple/buttonsimple.component.ts"
2808
- }
2990
+ "description": "Variant of the buttons within the buttongroup.",
2991
+ "default": "'primary'",
2992
+ "fieldName": "variant"
2809
2993
  },
2810
2994
  {
2811
- "name": "ariaStateKey",
2995
+ "name": "size",
2812
2996
  "type": {
2813
- "text": "string | undefined"
2997
+ "text": "ButtonGroupSize"
2814
2998
  },
2815
- "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`",
2816
- "default": "'aria-pressed' (when)",
2817
- "fieldName": "ariaStateKey",
2818
- "inheritedFrom": {
2819
- "name": "Buttonsimple",
2820
- "module": "src/components/buttonsimple/buttonsimple.component.ts"
2821
- }
2999
+ "description": "Size of the buttons within the buttongroup.",
3000
+ "default": "'28'",
3001
+ "fieldName": "size"
2822
3002
  },
2823
3003
  {
2824
- "name": "type",
3004
+ "name": "compact",
2825
3005
  "type": {
2826
- "text": "ButtonType"
3006
+ "text": "boolean"
2827
3007
  },
2828
- "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.",
2829
- "default": "button",
2830
- "fieldName": "type",
2831
- "inheritedFrom": {
2832
- "name": "Buttonsimple",
2833
- "module": "src/components/buttonsimple/buttonsimple.component.ts"
2834
- }
2835
- }
2836
- ],
2837
- "mixins": [
2838
- {
2839
- "name": "ButtonComponentMixin",
2840
- "module": "/src/utils/mixins/ButtonComponentMixin"
3008
+ "default": "false",
3009
+ "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.",
3010
+ "fieldName": "compact"
2841
3011
  }
2842
3012
  ],
2843
3013
  "superclass": {
2844
- "name": "Buttonsimple",
2845
- "module": "/src/components/buttonsimple/buttonsimple.component"
3014
+ "name": "Component",
3015
+ "module": "/src/models"
2846
3016
  },
2847
- "tagName": "mdc-button",
2848
- "jsDoc": "/**\n * `mdc-button` is a component that can be configured in various ways to suit different use cases.\n *\n * Button Variants:\n * - **Primary**: Solid background color.\n * - **Secondary**: Transparent background with a solid border.\n * - **Tertiary**: No background or border, appears as plain text but retains all button functionalities.\n *\n * Button Colors:\n * - **Positive**: Green color.\n * - **Negative**: Red color.\n * - **Accent**: Blue color.\n * - **Promotional**: Purple color.\n * - **Default**: White color.\n *\n * Button Sizes (in REM units):\n * - **Pill button**: 40, 32, 28, 24.\n * - **Icon button**: 64, 52, 40, 32, 28, 24.\n * - **Tertiary icon button**: 20.\n *\n * Button Types:\n * - **Pill button**: A button that contains text value. Commonly used for call to action, tags, or filters.\n * - **Pill button with icons**: A button containing an icon either on the left or right side of the button.\n * - **Icon button**: A button represented by just an icon without any text.\n * The type of button is inferred based on the presence of slot and/or prefix and postfix icons.\n *\n * @dependency mdc-icon\n *\n * @tagname mdc-button\n *\n * @slot - Text label of the button.\n */",
2849
- "customElement": true,
2850
- "events": [
2851
- {
2852
- "description": "(React: onClick) This event is dispatched when the button is clicked.",
2853
- "name": "click",
2854
- "reactName": "onClick",
2855
- "inheritedFrom": {
2856
- "name": "Buttonsimple",
2857
- "module": "src/components/buttonsimple/buttonsimple.component.ts"
2858
- }
2859
- },
2860
- {
2861
- "description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the button.",
2862
- "name": "keydown",
2863
- "reactName": "onKeyDown",
2864
- "inheritedFrom": {
2865
- "name": "Buttonsimple",
2866
- "module": "src/components/buttonsimple/buttonsimple.component.ts"
2867
- }
2868
- },
2869
- {
2870
- "description": "(React: onKeyUp) This event is dispatched when a key is released on the button.",
2871
- "name": "keyup",
2872
- "reactName": "onKeyUp",
2873
- "inheritedFrom": {
2874
- "name": "Buttonsimple",
2875
- "module": "src/components/buttonsimple/buttonsimple.component.ts"
2876
- }
2877
- },
2878
- {
2879
- "description": "(React: onFocus) This event is dispatched when the button receives focus.",
2880
- "name": "focus",
2881
- "reactName": "onFocus",
2882
- "inheritedFrom": {
2883
- "name": "Buttonsimple",
2884
- "module": "src/components/buttonsimple/buttonsimple.component.ts"
2885
- }
2886
- }
2887
- ]
3017
+ "tagName": "mdc-buttongroup",
3018
+ "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 */",
3019
+ "customElement": true
2888
3020
  }
2889
3021
  ],
2890
3022
  "exports": [
@@ -2892,8 +3024,8 @@
2892
3024
  "kind": "js",
2893
3025
  "name": "default",
2894
3026
  "declaration": {
2895
- "name": "Button",
2896
- "module": "components/button/button.component.js"
3027
+ "name": "ButtonGroup",
3028
+ "module": "components/buttongroup/buttongroup.component.js"
2897
3029
  }
2898
3030
  }
2899
3031
  ]
@@ -4297,138 +4429,6 @@
4297
4429
  }
4298
4430
  ]
4299
4431
  },
4300
- {
4301
- "kind": "javascript-module",
4302
- "path": "components/buttongroup/buttongroup.component.js",
4303
- "declarations": [
4304
- {
4305
- "kind": "class",
4306
- "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.",
4307
- "name": "ButtonGroup",
4308
- "cssProperties": [
4309
- {
4310
- "description": "The border radius of the buttongroup",
4311
- "name": "--mdc-buttongroup-border-radius"
4312
- },
4313
- {
4314
- "description": "The border color of the buttongroup",
4315
- "name": "--mdc-buttongroup-border-color"
4316
- },
4317
- {
4318
- "description": "The color of the divider between buttons within the buttongroup",
4319
- "name": "--mdc-buttongroup-divider-color"
4320
- }
4321
- ],
4322
- "slots": [
4323
- {
4324
- "description": "This is a default/unnamed slot, which contains the buttons",
4325
- "name": "default"
4326
- }
4327
- ],
4328
- "members": [
4329
- {
4330
- "kind": "field",
4331
- "name": "orientation",
4332
- "type": {
4333
- "text": "ButtonGroupOrientation"
4334
- },
4335
- "description": "Orientation of the buttongroup.",
4336
- "default": "'horizontal'",
4337
- "attribute": "orientation",
4338
- "reflects": true
4339
- },
4340
- {
4341
- "kind": "field",
4342
- "name": "variant",
4343
- "type": {
4344
- "text": "ButtonGroupVariant"
4345
- },
4346
- "description": "Variant of the buttons within the buttongroup.",
4347
- "default": "'primary'",
4348
- "attribute": "variant",
4349
- "reflects": true
4350
- },
4351
- {
4352
- "kind": "field",
4353
- "name": "size",
4354
- "type": {
4355
- "text": "ButtonGroupSize"
4356
- },
4357
- "description": "Size of the buttons within the buttongroup.",
4358
- "default": "'28'",
4359
- "attribute": "size",
4360
- "reflects": true
4361
- },
4362
- {
4363
- "kind": "field",
4364
- "name": "compact",
4365
- "type": {
4366
- "text": "boolean"
4367
- },
4368
- "default": "false",
4369
- "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.",
4370
- "attribute": "compact",
4371
- "reflects": true
4372
- }
4373
- ],
4374
- "attributes": [
4375
- {
4376
- "name": "orientation",
4377
- "type": {
4378
- "text": "ButtonGroupOrientation"
4379
- },
4380
- "description": "Orientation of the buttongroup.",
4381
- "default": "'horizontal'",
4382
- "fieldName": "orientation"
4383
- },
4384
- {
4385
- "name": "variant",
4386
- "type": {
4387
- "text": "ButtonGroupVariant"
4388
- },
4389
- "description": "Variant of the buttons within the buttongroup.",
4390
- "default": "'primary'",
4391
- "fieldName": "variant"
4392
- },
4393
- {
4394
- "name": "size",
4395
- "type": {
4396
- "text": "ButtonGroupSize"
4397
- },
4398
- "description": "Size of the buttons within the buttongroup.",
4399
- "default": "'28'",
4400
- "fieldName": "size"
4401
- },
4402
- {
4403
- "name": "compact",
4404
- "type": {
4405
- "text": "boolean"
4406
- },
4407
- "default": "false",
4408
- "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.",
4409
- "fieldName": "compact"
4410
- }
4411
- ],
4412
- "superclass": {
4413
- "name": "Component",
4414
- "module": "/src/models"
4415
- },
4416
- "tagName": "mdc-buttongroup",
4417
- "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 */",
4418
- "customElement": true
4419
- }
4420
- ],
4421
- "exports": [
4422
- {
4423
- "kind": "js",
4424
- "name": "default",
4425
- "declaration": {
4426
- "name": "ButtonGroup",
4427
- "module": "components/buttongroup/buttongroup.component.js"
4428
- }
4429
- }
4430
- ]
4431
- },
4432
4432
  {
4433
4433
  "kind": "javascript-module",
4434
4434
  "path": "components/cardbutton/cardbutton.component.js",