@momentum-design/components 0.83.0 → 0.83.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/browser/index.js +6 -6
- package/dist/browser/index.js.map +3 -3
- package/dist/components/popover/popover.component.d.ts +13 -0
- package/dist/components/popover/popover.component.js +29 -6
- package/dist/components/popover/popover.constants.d.ts +1 -0
- package/dist/components/popover/popover.constants.js +1 -0
- package/dist/custom-elements.json +1703 -1571
- package/dist/react/index.d.ts +5 -5
- package/dist/react/index.js +5 -5
- package/dist/utils/mixins/FocusTrapMixin.js +11 -8
- package/package.json +1 -1
|
@@ -1037,431 +1037,6 @@
|
|
|
1037
1037
|
}
|
|
1038
1038
|
]
|
|
1039
1039
|
},
|
|
1040
|
-
{
|
|
1041
|
-
"kind": "javascript-module",
|
|
1042
|
-
"path": "components/badge/badge.component.js",
|
|
1043
|
-
"declarations": [
|
|
1044
|
-
{
|
|
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",
|
|
1048
|
-
"cssProperties": [
|
|
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"
|
|
1084
|
-
},
|
|
1085
|
-
{
|
|
1086
|
-
"description": "The background color of the error badge.",
|
|
1087
|
-
"name": "--mdc-badge-error-background-color"
|
|
1088
|
-
},
|
|
1089
|
-
{
|
|
1090
|
-
"description": "The background color of the badge overlay.",
|
|
1091
|
-
"name": "--mdc-badge-overlay-background-color"
|
|
1092
|
-
}
|
|
1093
|
-
],
|
|
1094
|
-
"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
|
-
{
|
|
1147
|
-
"kind": "field",
|
|
1148
|
-
"name": "ariaLabel",
|
|
1149
|
-
"type": {
|
|
1150
|
-
"text": "string | null"
|
|
1151
|
-
},
|
|
1152
|
-
"default": "null",
|
|
1153
|
-
"description": "Aria-label attribute to be set for accessibility",
|
|
1154
|
-
"attribute": "aria-label"
|
|
1155
|
-
},
|
|
1156
|
-
{
|
|
1157
|
-
"kind": "method",
|
|
1158
|
-
"name": "getCounterText",
|
|
1159
|
-
"privacy": "private",
|
|
1160
|
-
"return": {
|
|
1161
|
-
"type": {
|
|
1162
|
-
"text": ""
|
|
1163
|
-
}
|
|
1164
|
-
},
|
|
1165
|
-
"parameters": [
|
|
1166
|
-
{
|
|
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,
|
|
1176
|
-
"type": {
|
|
1177
|
-
"text": "number"
|
|
1178
|
-
},
|
|
1179
|
-
"description": "the number to be displayed on the badge"
|
|
1180
|
-
}
|
|
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."
|
|
1183
|
-
},
|
|
1184
|
-
{
|
|
1185
|
-
"kind": "method",
|
|
1186
|
-
"name": "getBadgeIcon",
|
|
1187
|
-
"privacy": "private",
|
|
1188
|
-
"return": {
|
|
1189
|
-
"type": {
|
|
1190
|
-
"text": ""
|
|
1191
|
-
}
|
|
1192
|
-
},
|
|
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."
|
|
1210
|
-
},
|
|
1211
|
-
{
|
|
1212
|
-
"kind": "method",
|
|
1213
|
-
"name": "getBadgeDot",
|
|
1214
|
-
"privacy": "private",
|
|
1215
|
-
"return": {
|
|
1216
|
-
"type": {
|
|
1217
|
-
"text": ""
|
|
1218
|
-
}
|
|
1219
|
-
},
|
|
1220
|
-
"description": "Method to generate the badge dot template."
|
|
1221
|
-
},
|
|
1222
|
-
{
|
|
1223
|
-
"kind": "method",
|
|
1224
|
-
"name": "getBadgeCounterText",
|
|
1225
|
-
"privacy": "private",
|
|
1226
|
-
"return": {
|
|
1227
|
-
"type": {
|
|
1228
|
-
"text": ""
|
|
1229
|
-
}
|
|
1230
|
-
},
|
|
1231
|
-
"description": "Method to generate the badge text and counter template."
|
|
1232
|
-
},
|
|
1233
|
-
{
|
|
1234
|
-
"kind": "method",
|
|
1235
|
-
"name": "setRoleByAriaLabel",
|
|
1236
|
-
"privacy": "private",
|
|
1237
|
-
"return": {
|
|
1238
|
-
"type": {
|
|
1239
|
-
"text": "void"
|
|
1240
|
-
}
|
|
1241
|
-
},
|
|
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."
|
|
1243
|
-
},
|
|
1244
|
-
{
|
|
1245
|
-
"kind": "method",
|
|
1246
|
-
"name": "getBadgeContentBasedOnType",
|
|
1247
|
-
"privacy": "private",
|
|
1248
|
-
"return": {
|
|
1249
|
-
"type": {
|
|
1250
|
-
"text": ""
|
|
1251
|
-
}
|
|
1252
|
-
},
|
|
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."
|
|
1254
|
-
},
|
|
1255
|
-
{
|
|
1256
|
-
"kind": "field",
|
|
1257
|
-
"name": "iconName",
|
|
1258
|
-
"type": {
|
|
1259
|
-
"text": "IconNames | undefined"
|
|
1260
|
-
},
|
|
1261
|
-
"description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
|
|
1262
|
-
"attribute": "icon-name",
|
|
1263
|
-
"inheritedFrom": {
|
|
1264
|
-
"name": "IconNameMixin",
|
|
1265
|
-
"module": "utils/mixins/IconNameMixin.js"
|
|
1266
|
-
}
|
|
1267
|
-
}
|
|
1268
|
-
],
|
|
1269
|
-
"attributes": [
|
|
1270
|
-
{
|
|
1271
|
-
"name": "type",
|
|
1272
|
-
"type": {
|
|
1273
|
-
"text": "BadgeType | undefined"
|
|
1274
|
-
},
|
|
1275
|
-
"description": "Type of the badge\nCan be `dot` (notification) , `icon`, `counter`, `success`, `warning` or `error`.",
|
|
1276
|
-
"fieldName": "type"
|
|
1277
|
-
},
|
|
1278
|
-
{
|
|
1279
|
-
"name": "variant",
|
|
1280
|
-
"type": {
|
|
1281
|
-
"text": "IconVariant"
|
|
1282
|
-
},
|
|
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"
|
|
1286
|
-
},
|
|
1287
|
-
{
|
|
1288
|
-
"name": "counter",
|
|
1289
|
-
"type": {
|
|
1290
|
-
"text": "number | undefined"
|
|
1291
|
-
},
|
|
1292
|
-
"description": "Counter is the number which can be provided in the badge.",
|
|
1293
|
-
"fieldName": "counter"
|
|
1294
|
-
},
|
|
1295
|
-
{
|
|
1296
|
-
"name": "max-counter",
|
|
1297
|
-
"type": {
|
|
1298
|
-
"text": "number"
|
|
1299
|
-
},
|
|
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"
|
|
1303
|
-
},
|
|
1304
|
-
{
|
|
1305
|
-
"name": "overlay",
|
|
1306
|
-
"type": {
|
|
1307
|
-
"text": "boolean"
|
|
1308
|
-
},
|
|
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"
|
|
1312
|
-
},
|
|
1313
|
-
{
|
|
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"
|
|
1321
|
-
},
|
|
1322
|
-
{
|
|
1323
|
-
"name": "icon-name",
|
|
1324
|
-
"type": {
|
|
1325
|
-
"text": "IconNames | undefined"
|
|
1326
|
-
},
|
|
1327
|
-
"description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
|
|
1328
|
-
"fieldName": "iconName",
|
|
1329
|
-
"inheritedFrom": {
|
|
1330
|
-
"name": "IconNameMixin",
|
|
1331
|
-
"module": "src/utils/mixins/IconNameMixin.ts"
|
|
1332
|
-
}
|
|
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": [
|
|
1370
|
-
{
|
|
1371
|
-
"kind": "field",
|
|
1372
|
-
"name": "brandVisualData",
|
|
1373
|
-
"type": {
|
|
1374
|
-
"text": "HTMLElement | undefined"
|
|
1375
|
-
},
|
|
1376
|
-
"privacy": "private"
|
|
1377
|
-
},
|
|
1378
|
-
{
|
|
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
|
|
1387
|
-
},
|
|
1388
|
-
{
|
|
1389
|
-
"kind": "method",
|
|
1390
|
-
"name": "getBrandVisualData",
|
|
1391
|
-
"privacy": "private"
|
|
1392
|
-
},
|
|
1393
|
-
{
|
|
1394
|
-
"kind": "method",
|
|
1395
|
-
"name": "handleBrandVisualLoadedSuccess",
|
|
1396
|
-
"privacy": "private",
|
|
1397
|
-
"parameters": [
|
|
1398
|
-
{
|
|
1399
|
-
"name": "brandVisualHtml",
|
|
1400
|
-
"type": {
|
|
1401
|
-
"text": "HTMLElement"
|
|
1402
|
-
},
|
|
1403
|
-
"description": "The brandvisual html element which has been fetched from the brandvisual provider."
|
|
1404
|
-
}
|
|
1405
|
-
],
|
|
1406
|
-
"description": "Sets the brandVisualData state to the fetched brandvisual.\nDispatches a 'load' event on the component once the brandvisual has been successfully loaded."
|
|
1407
|
-
},
|
|
1408
|
-
{
|
|
1409
|
-
"kind": "method",
|
|
1410
|
-
"name": "handleBrandVisualLoadedFailure",
|
|
1411
|
-
"privacy": "private",
|
|
1412
|
-
"parameters": [
|
|
1413
|
-
{
|
|
1414
|
-
"name": "error",
|
|
1415
|
-
"type": {
|
|
1416
|
-
"text": "unknown"
|
|
1417
|
-
}
|
|
1418
|
-
}
|
|
1419
|
-
],
|
|
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": [
|
|
1424
|
-
{
|
|
1425
|
-
"description": "(React: onLoad) This event is dispatched when the brandvisual has been successfully loaded.",
|
|
1426
|
-
"name": "load",
|
|
1427
|
-
"reactName": "onLoad"
|
|
1428
|
-
},
|
|
1429
|
-
{
|
|
1430
|
-
"description": "(React: onError) This event is dispatched when the brandvisual fetching has failed.",
|
|
1431
|
-
"name": "error",
|
|
1432
|
-
"reactName": "onError"
|
|
1433
|
-
}
|
|
1434
|
-
],
|
|
1435
|
-
"attributes": [
|
|
1436
|
-
{
|
|
1437
|
-
"name": "name",
|
|
1438
|
-
"type": {
|
|
1439
|
-
"text": "BrandVisualNames | undefined"
|
|
1440
|
-
},
|
|
1441
|
-
"description": "Name of the brandVisual (= filename)",
|
|
1442
|
-
"fieldName": "name"
|
|
1443
|
-
}
|
|
1444
|
-
],
|
|
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
1040
|
{
|
|
1466
1041
|
"kind": "javascript-module",
|
|
1467
1042
|
"path": "components/avatarbutton/avatarbutton.component.js",
|
|
@@ -2134,68 +1709,389 @@
|
|
|
2134
1709
|
},
|
|
2135
1710
|
{
|
|
2136
1711
|
"kind": "javascript-module",
|
|
2137
|
-
"path": "components/
|
|
1712
|
+
"path": "components/badge/badge.component.js",
|
|
2138
1713
|
"declarations": [
|
|
2139
1714
|
{
|
|
2140
1715
|
"kind": "class",
|
|
2141
|
-
"description": "
|
|
2142
|
-
"name": "
|
|
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",
|
|
2143
1718
|
"cssProperties": [
|
|
2144
1719
|
{
|
|
2145
|
-
"description": "
|
|
2146
|
-
"name": "--mdc-
|
|
1720
|
+
"description": "The foreground color of the primary badge.",
|
|
1721
|
+
"name": "--mdc-badge-primary-foreground-color"
|
|
2147
1722
|
},
|
|
2148
1723
|
{
|
|
2149
|
-
"description": "
|
|
2150
|
-
"name": "--mdc-
|
|
1724
|
+
"description": "The background color of the primary badge.",
|
|
1725
|
+
"name": "--mdc-badge-primary-background-color"
|
|
2151
1726
|
},
|
|
2152
1727
|
{
|
|
2153
|
-
"description": "
|
|
2154
|
-
"name": "--mdc-
|
|
1728
|
+
"description": "The foreground color of the secondary badge.",
|
|
1729
|
+
"name": "--mdc-badge-secondary-foreground-color"
|
|
2155
1730
|
},
|
|
2156
1731
|
{
|
|
2157
|
-
"description": "
|
|
2158
|
-
"name": "--mdc-
|
|
1732
|
+
"description": "The background color of the secondary badge.",
|
|
1733
|
+
"name": "--mdc-badge-secondary-background-color"
|
|
1734
|
+
},
|
|
1735
|
+
{
|
|
1736
|
+
"description": "The foreground color of the success badge.",
|
|
1737
|
+
"name": "--mdc-badge-success-foreground-color"
|
|
1738
|
+
},
|
|
1739
|
+
{
|
|
1740
|
+
"description": "The background color of the success badge.",
|
|
1741
|
+
"name": "--mdc-badge-success-background-color"
|
|
1742
|
+
},
|
|
1743
|
+
{
|
|
1744
|
+
"description": "The foreground color of the warning badge.",
|
|
1745
|
+
"name": "--mdc-badge-warning-foreground-color"
|
|
1746
|
+
},
|
|
1747
|
+
{
|
|
1748
|
+
"description": "The background color of the warning badge.",
|
|
1749
|
+
"name": "--mdc-badge-warning-background-color"
|
|
1750
|
+
},
|
|
1751
|
+
{
|
|
1752
|
+
"description": "The foreground color of the error badge.",
|
|
1753
|
+
"name": "--mdc-badge-error-foreground-color"
|
|
1754
|
+
},
|
|
1755
|
+
{
|
|
1756
|
+
"description": "The background color of the error badge.",
|
|
1757
|
+
"name": "--mdc-badge-error-background-color"
|
|
1758
|
+
},
|
|
1759
|
+
{
|
|
1760
|
+
"description": "The background color of the badge overlay.",
|
|
1761
|
+
"name": "--mdc-badge-overlay-background-color"
|
|
2159
1762
|
}
|
|
2160
1763
|
],
|
|
2161
1764
|
"members": [
|
|
2162
1765
|
{
|
|
2163
1766
|
"kind": "field",
|
|
2164
|
-
"name": "
|
|
1767
|
+
"name": "type",
|
|
2165
1768
|
"type": {
|
|
2166
|
-
"text": "
|
|
1769
|
+
"text": "BadgeType | undefined"
|
|
2167
1770
|
},
|
|
2168
|
-
"
|
|
2169
|
-
"
|
|
2170
|
-
"default": "small",
|
|
2171
|
-
"attribute": "size",
|
|
1771
|
+
"description": "Type of the badge\nCan be `dot` (notification) , `icon`, `counter`, `success`, `warning` or `error`.",
|
|
1772
|
+
"attribute": "type",
|
|
2172
1773
|
"reflects": true
|
|
2173
|
-
}
|
|
2174
|
-
],
|
|
2175
|
-
"attributes": [
|
|
1774
|
+
},
|
|
2176
1775
|
{
|
|
2177
|
-
"
|
|
1776
|
+
"kind": "field",
|
|
1777
|
+
"name": "variant",
|
|
2178
1778
|
"type": {
|
|
2179
|
-
"text": "
|
|
1779
|
+
"text": "IconVariant"
|
|
2180
1780
|
},
|
|
2181
|
-
"description": "
|
|
2182
|
-
"default": "
|
|
2183
|
-
"
|
|
2184
|
-
|
|
2185
|
-
|
|
2186
|
-
|
|
2187
|
-
|
|
2188
|
-
|
|
2189
|
-
|
|
2190
|
-
|
|
2191
|
-
|
|
2192
|
-
|
|
2193
|
-
|
|
2194
|
-
|
|
2195
|
-
|
|
2196
|
-
|
|
2197
|
-
|
|
2198
|
-
|
|
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
|
|
1785
|
+
},
|
|
1786
|
+
{
|
|
1787
|
+
"kind": "field",
|
|
1788
|
+
"name": "counter",
|
|
1789
|
+
"type": {
|
|
1790
|
+
"text": "number | undefined"
|
|
1791
|
+
},
|
|
1792
|
+
"description": "Counter is the number which can be provided in the badge.",
|
|
1793
|
+
"attribute": "counter"
|
|
1794
|
+
},
|
|
1795
|
+
{
|
|
1796
|
+
"kind": "field",
|
|
1797
|
+
"name": "maxCounter",
|
|
1798
|
+
"type": {
|
|
1799
|
+
"text": "number"
|
|
1800
|
+
},
|
|
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
|
|
1805
|
+
},
|
|
1806
|
+
{
|
|
1807
|
+
"kind": "field",
|
|
1808
|
+
"name": "overlay",
|
|
1809
|
+
"type": {
|
|
1810
|
+
"text": "boolean"
|
|
1811
|
+
},
|
|
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"
|
|
1815
|
+
},
|
|
1816
|
+
{
|
|
1817
|
+
"kind": "field",
|
|
1818
|
+
"name": "ariaLabel",
|
|
1819
|
+
"type": {
|
|
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
|
+
}
|
|
1911
|
+
},
|
|
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."
|
|
1913
|
+
},
|
|
1914
|
+
{
|
|
1915
|
+
"kind": "method",
|
|
1916
|
+
"name": "getBadgeContentBasedOnType",
|
|
1917
|
+
"privacy": "private",
|
|
1918
|
+
"return": {
|
|
1919
|
+
"type": {
|
|
1920
|
+
"text": ""
|
|
1921
|
+
}
|
|
1922
|
+
},
|
|
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."
|
|
1924
|
+
},
|
|
1925
|
+
{
|
|
1926
|
+
"kind": "field",
|
|
1927
|
+
"name": "iconName",
|
|
1928
|
+
"type": {
|
|
1929
|
+
"text": "IconNames | undefined"
|
|
1930
|
+
},
|
|
1931
|
+
"description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
|
|
1932
|
+
"attribute": "icon-name",
|
|
1933
|
+
"inheritedFrom": {
|
|
1934
|
+
"name": "IconNameMixin",
|
|
1935
|
+
"module": "utils/mixins/IconNameMixin.js"
|
|
1936
|
+
}
|
|
1937
|
+
}
|
|
1938
|
+
],
|
|
1939
|
+
"attributes": [
|
|
1940
|
+
{
|
|
1941
|
+
"name": "type",
|
|
1942
|
+
"type": {
|
|
1943
|
+
"text": "BadgeType | undefined"
|
|
1944
|
+
},
|
|
1945
|
+
"description": "Type of the badge\nCan be `dot` (notification) , `icon`, `counter`, `success`, `warning` or `error`.",
|
|
1946
|
+
"fieldName": "type"
|
|
1947
|
+
},
|
|
1948
|
+
{
|
|
1949
|
+
"name": "variant",
|
|
1950
|
+
"type": {
|
|
1951
|
+
"text": "IconVariant"
|
|
1952
|
+
},
|
|
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"
|
|
1956
|
+
},
|
|
1957
|
+
{
|
|
1958
|
+
"name": "counter",
|
|
1959
|
+
"type": {
|
|
1960
|
+
"text": "number | undefined"
|
|
1961
|
+
},
|
|
1962
|
+
"description": "Counter is the number which can be provided in the badge.",
|
|
1963
|
+
"fieldName": "counter"
|
|
1964
|
+
},
|
|
1965
|
+
{
|
|
1966
|
+
"name": "max-counter",
|
|
1967
|
+
"type": {
|
|
1968
|
+
"text": "number"
|
|
1969
|
+
},
|
|
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"
|
|
1973
|
+
},
|
|
1974
|
+
{
|
|
1975
|
+
"name": "overlay",
|
|
1976
|
+
"type": {
|
|
1977
|
+
"text": "boolean"
|
|
1978
|
+
},
|
|
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"
|
|
1982
|
+
},
|
|
1983
|
+
{
|
|
1984
|
+
"name": "aria-label",
|
|
1985
|
+
"type": {
|
|
1986
|
+
"text": "string | null"
|
|
1987
|
+
},
|
|
1988
|
+
"default": "null",
|
|
1989
|
+
"description": "Aria-label attribute to be set for accessibility",
|
|
1990
|
+
"fieldName": "ariaLabel"
|
|
1991
|
+
},
|
|
1992
|
+
{
|
|
1993
|
+
"name": "icon-name",
|
|
1994
|
+
"type": {
|
|
1995
|
+
"text": "IconNames | undefined"
|
|
1996
|
+
},
|
|
1997
|
+
"description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
|
|
1998
|
+
"fieldName": "iconName",
|
|
1999
|
+
"inheritedFrom": {
|
|
2000
|
+
"name": "IconNameMixin",
|
|
2001
|
+
"module": "src/utils/mixins/IconNameMixin.ts"
|
|
2002
|
+
}
|
|
2003
|
+
}
|
|
2004
|
+
],
|
|
2005
|
+
"mixins": [
|
|
2006
|
+
{
|
|
2007
|
+
"name": "IconNameMixin",
|
|
2008
|
+
"module": "/src/utils/mixins/IconNameMixin"
|
|
2009
|
+
}
|
|
2010
|
+
],
|
|
2011
|
+
"superclass": {
|
|
2012
|
+
"name": "Component",
|
|
2013
|
+
"module": "/src/models"
|
|
2014
|
+
},
|
|
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 */",
|
|
2017
|
+
"customElement": true
|
|
2018
|
+
}
|
|
2019
|
+
],
|
|
2020
|
+
"exports": [
|
|
2021
|
+
{
|
|
2022
|
+
"kind": "js",
|
|
2023
|
+
"name": "default",
|
|
2024
|
+
"declaration": {
|
|
2025
|
+
"name": "Badge",
|
|
2026
|
+
"module": "components/badge/badge.component.js"
|
|
2027
|
+
}
|
|
2028
|
+
}
|
|
2029
|
+
]
|
|
2030
|
+
},
|
|
2031
|
+
{
|
|
2032
|
+
"kind": "javascript-module",
|
|
2033
|
+
"path": "components/bullet/bullet.component.js",
|
|
2034
|
+
"declarations": [
|
|
2035
|
+
{
|
|
2036
|
+
"kind": "class",
|
|
2037
|
+
"description": "Bullet component, which is a visual marker\nand be used to organize and present items in a list format.",
|
|
2038
|
+
"name": "Bullet",
|
|
2039
|
+
"cssProperties": [
|
|
2040
|
+
{
|
|
2041
|
+
"description": "background color of the bullet",
|
|
2042
|
+
"name": "--mdc-bullet-background-color"
|
|
2043
|
+
},
|
|
2044
|
+
{
|
|
2045
|
+
"description": "small size value of the bullet",
|
|
2046
|
+
"name": "--mdc-bullet-size-small"
|
|
2047
|
+
},
|
|
2048
|
+
{
|
|
2049
|
+
"description": "medium size value of the bullet",
|
|
2050
|
+
"name": "--mdc-bullet-size-medium"
|
|
2051
|
+
},
|
|
2052
|
+
{
|
|
2053
|
+
"description": "large size value of the bullet",
|
|
2054
|
+
"name": "--mdc-bullet-size-large"
|
|
2055
|
+
}
|
|
2056
|
+
],
|
|
2057
|
+
"members": [
|
|
2058
|
+
{
|
|
2059
|
+
"kind": "field",
|
|
2060
|
+
"name": "size",
|
|
2061
|
+
"type": {
|
|
2062
|
+
"text": "Size"
|
|
2063
|
+
},
|
|
2064
|
+
"privacy": "public",
|
|
2065
|
+
"description": "Size of the bullet\n\nPossible values: 'small', 'medium', 'large'",
|
|
2066
|
+
"default": "small",
|
|
2067
|
+
"attribute": "size",
|
|
2068
|
+
"reflects": true
|
|
2069
|
+
}
|
|
2070
|
+
],
|
|
2071
|
+
"attributes": [
|
|
2072
|
+
{
|
|
2073
|
+
"name": "size",
|
|
2074
|
+
"type": {
|
|
2075
|
+
"text": "Size"
|
|
2076
|
+
},
|
|
2077
|
+
"description": "Size of the bullet\n\nPossible values: 'small', 'medium', 'large'",
|
|
2078
|
+
"default": "small",
|
|
2079
|
+
"fieldName": "size"
|
|
2080
|
+
}
|
|
2081
|
+
],
|
|
2082
|
+
"superclass": {
|
|
2083
|
+
"name": "Component",
|
|
2084
|
+
"module": "/src/models"
|
|
2085
|
+
},
|
|
2086
|
+
"tagName": "mdc-bullet",
|
|
2087
|
+
"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*/",
|
|
2088
|
+
"customElement": true
|
|
2089
|
+
}
|
|
2090
|
+
],
|
|
2091
|
+
"exports": [
|
|
2092
|
+
{
|
|
2093
|
+
"kind": "js",
|
|
2094
|
+
"name": "default",
|
|
2199
2095
|
"declaration": {
|
|
2200
2096
|
"name": "Bullet",
|
|
2201
2097
|
"module": "components/bullet/bullet.component.js"
|
|
@@ -2898,6 +2794,110 @@
|
|
|
2898
2794
|
}
|
|
2899
2795
|
]
|
|
2900
2796
|
},
|
|
2797
|
+
{
|
|
2798
|
+
"kind": "javascript-module",
|
|
2799
|
+
"path": "components/brandvisual/brandvisual.component.js",
|
|
2800
|
+
"declarations": [
|
|
2801
|
+
{
|
|
2802
|
+
"kind": "class",
|
|
2803
|
+
"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.",
|
|
2804
|
+
"name": "Brandvisual",
|
|
2805
|
+
"members": [
|
|
2806
|
+
{
|
|
2807
|
+
"kind": "field",
|
|
2808
|
+
"name": "brandVisualData",
|
|
2809
|
+
"type": {
|
|
2810
|
+
"text": "HTMLElement | undefined"
|
|
2811
|
+
},
|
|
2812
|
+
"privacy": "private"
|
|
2813
|
+
},
|
|
2814
|
+
{
|
|
2815
|
+
"kind": "field",
|
|
2816
|
+
"name": "name",
|
|
2817
|
+
"type": {
|
|
2818
|
+
"text": "BrandVisualNames | undefined"
|
|
2819
|
+
},
|
|
2820
|
+
"description": "Name of the brandVisual (= filename)",
|
|
2821
|
+
"attribute": "name",
|
|
2822
|
+
"reflects": true
|
|
2823
|
+
},
|
|
2824
|
+
{
|
|
2825
|
+
"kind": "method",
|
|
2826
|
+
"name": "getBrandVisualData",
|
|
2827
|
+
"privacy": "private"
|
|
2828
|
+
},
|
|
2829
|
+
{
|
|
2830
|
+
"kind": "method",
|
|
2831
|
+
"name": "handleBrandVisualLoadedSuccess",
|
|
2832
|
+
"privacy": "private",
|
|
2833
|
+
"parameters": [
|
|
2834
|
+
{
|
|
2835
|
+
"name": "brandVisualHtml",
|
|
2836
|
+
"type": {
|
|
2837
|
+
"text": "HTMLElement"
|
|
2838
|
+
},
|
|
2839
|
+
"description": "The brandvisual html element which has been fetched from the brandvisual provider."
|
|
2840
|
+
}
|
|
2841
|
+
],
|
|
2842
|
+
"description": "Sets the brandVisualData state to the fetched brandvisual.\nDispatches a 'load' event on the component once the brandvisual has been successfully loaded."
|
|
2843
|
+
},
|
|
2844
|
+
{
|
|
2845
|
+
"kind": "method",
|
|
2846
|
+
"name": "handleBrandVisualLoadedFailure",
|
|
2847
|
+
"privacy": "private",
|
|
2848
|
+
"parameters": [
|
|
2849
|
+
{
|
|
2850
|
+
"name": "error",
|
|
2851
|
+
"type": {
|
|
2852
|
+
"text": "unknown"
|
|
2853
|
+
}
|
|
2854
|
+
}
|
|
2855
|
+
],
|
|
2856
|
+
"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."
|
|
2857
|
+
}
|
|
2858
|
+
],
|
|
2859
|
+
"events": [
|
|
2860
|
+
{
|
|
2861
|
+
"description": "(React: onLoad) This event is dispatched when the brandvisual has been successfully loaded.",
|
|
2862
|
+
"name": "load",
|
|
2863
|
+
"reactName": "onLoad"
|
|
2864
|
+
},
|
|
2865
|
+
{
|
|
2866
|
+
"description": "(React: onError) This event is dispatched when the brandvisual fetching has failed.",
|
|
2867
|
+
"name": "error",
|
|
2868
|
+
"reactName": "onError"
|
|
2869
|
+
}
|
|
2870
|
+
],
|
|
2871
|
+
"attributes": [
|
|
2872
|
+
{
|
|
2873
|
+
"name": "name",
|
|
2874
|
+
"type": {
|
|
2875
|
+
"text": "BrandVisualNames | undefined"
|
|
2876
|
+
},
|
|
2877
|
+
"description": "Name of the brandVisual (= filename)",
|
|
2878
|
+
"fieldName": "name"
|
|
2879
|
+
}
|
|
2880
|
+
],
|
|
2881
|
+
"superclass": {
|
|
2882
|
+
"name": "Component",
|
|
2883
|
+
"module": "/src/models"
|
|
2884
|
+
},
|
|
2885
|
+
"tagName": "mdc-brandvisual",
|
|
2886
|
+
"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 */",
|
|
2887
|
+
"customElement": true
|
|
2888
|
+
}
|
|
2889
|
+
],
|
|
2890
|
+
"exports": [
|
|
2891
|
+
{
|
|
2892
|
+
"kind": "js",
|
|
2893
|
+
"name": "default",
|
|
2894
|
+
"declaration": {
|
|
2895
|
+
"name": "Brandvisual",
|
|
2896
|
+
"module": "components/brandvisual/brandvisual.component.js"
|
|
2897
|
+
}
|
|
2898
|
+
}
|
|
2899
|
+
]
|
|
2900
|
+
},
|
|
2901
2901
|
{
|
|
2902
2902
|
"kind": "javascript-module",
|
|
2903
2903
|
"path": "components/buttonlink/buttonlink.component.js",
|
|
@@ -3512,6 +3512,138 @@
|
|
|
3512
3512
|
}
|
|
3513
3513
|
]
|
|
3514
3514
|
},
|
|
3515
|
+
{
|
|
3516
|
+
"kind": "javascript-module",
|
|
3517
|
+
"path": "components/buttongroup/buttongroup.component.js",
|
|
3518
|
+
"declarations": [
|
|
3519
|
+
{
|
|
3520
|
+
"kind": "class",
|
|
3521
|
+
"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.",
|
|
3522
|
+
"name": "ButtonGroup",
|
|
3523
|
+
"cssProperties": [
|
|
3524
|
+
{
|
|
3525
|
+
"description": "The border radius of the buttongroup",
|
|
3526
|
+
"name": "--mdc-buttongroup-border-radius"
|
|
3527
|
+
},
|
|
3528
|
+
{
|
|
3529
|
+
"description": "The border color of the buttongroup",
|
|
3530
|
+
"name": "--mdc-buttongroup-border-color"
|
|
3531
|
+
},
|
|
3532
|
+
{
|
|
3533
|
+
"description": "The color of the divider between buttons within the buttongroup",
|
|
3534
|
+
"name": "--mdc-buttongroup-divider-color"
|
|
3535
|
+
}
|
|
3536
|
+
],
|
|
3537
|
+
"slots": [
|
|
3538
|
+
{
|
|
3539
|
+
"description": "This is a default/unnamed slot, which contains the buttons",
|
|
3540
|
+
"name": "default"
|
|
3541
|
+
}
|
|
3542
|
+
],
|
|
3543
|
+
"members": [
|
|
3544
|
+
{
|
|
3545
|
+
"kind": "field",
|
|
3546
|
+
"name": "orientation",
|
|
3547
|
+
"type": {
|
|
3548
|
+
"text": "ButtonGroupOrientation"
|
|
3549
|
+
},
|
|
3550
|
+
"description": "Orientation of the buttongroup.",
|
|
3551
|
+
"default": "'horizontal'",
|
|
3552
|
+
"attribute": "orientation",
|
|
3553
|
+
"reflects": true
|
|
3554
|
+
},
|
|
3555
|
+
{
|
|
3556
|
+
"kind": "field",
|
|
3557
|
+
"name": "variant",
|
|
3558
|
+
"type": {
|
|
3559
|
+
"text": "ButtonGroupVariant"
|
|
3560
|
+
},
|
|
3561
|
+
"description": "Variant of the buttons within the buttongroup.",
|
|
3562
|
+
"default": "'primary'",
|
|
3563
|
+
"attribute": "variant",
|
|
3564
|
+
"reflects": true
|
|
3565
|
+
},
|
|
3566
|
+
{
|
|
3567
|
+
"kind": "field",
|
|
3568
|
+
"name": "size",
|
|
3569
|
+
"type": {
|
|
3570
|
+
"text": "ButtonGroupSize"
|
|
3571
|
+
},
|
|
3572
|
+
"description": "Size of the buttons within the buttongroup.",
|
|
3573
|
+
"default": "'28'",
|
|
3574
|
+
"attribute": "size",
|
|
3575
|
+
"reflects": true
|
|
3576
|
+
},
|
|
3577
|
+
{
|
|
3578
|
+
"kind": "field",
|
|
3579
|
+
"name": "compact",
|
|
3580
|
+
"type": {
|
|
3581
|
+
"text": "boolean"
|
|
3582
|
+
},
|
|
3583
|
+
"default": "false",
|
|
3584
|
+
"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.",
|
|
3585
|
+
"attribute": "compact",
|
|
3586
|
+
"reflects": true
|
|
3587
|
+
}
|
|
3588
|
+
],
|
|
3589
|
+
"attributes": [
|
|
3590
|
+
{
|
|
3591
|
+
"name": "orientation",
|
|
3592
|
+
"type": {
|
|
3593
|
+
"text": "ButtonGroupOrientation"
|
|
3594
|
+
},
|
|
3595
|
+
"description": "Orientation of the buttongroup.",
|
|
3596
|
+
"default": "'horizontal'",
|
|
3597
|
+
"fieldName": "orientation"
|
|
3598
|
+
},
|
|
3599
|
+
{
|
|
3600
|
+
"name": "variant",
|
|
3601
|
+
"type": {
|
|
3602
|
+
"text": "ButtonGroupVariant"
|
|
3603
|
+
},
|
|
3604
|
+
"description": "Variant of the buttons within the buttongroup.",
|
|
3605
|
+
"default": "'primary'",
|
|
3606
|
+
"fieldName": "variant"
|
|
3607
|
+
},
|
|
3608
|
+
{
|
|
3609
|
+
"name": "size",
|
|
3610
|
+
"type": {
|
|
3611
|
+
"text": "ButtonGroupSize"
|
|
3612
|
+
},
|
|
3613
|
+
"description": "Size of the buttons within the buttongroup.",
|
|
3614
|
+
"default": "'28'",
|
|
3615
|
+
"fieldName": "size"
|
|
3616
|
+
},
|
|
3617
|
+
{
|
|
3618
|
+
"name": "compact",
|
|
3619
|
+
"type": {
|
|
3620
|
+
"text": "boolean"
|
|
3621
|
+
},
|
|
3622
|
+
"default": "false",
|
|
3623
|
+
"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.",
|
|
3624
|
+
"fieldName": "compact"
|
|
3625
|
+
}
|
|
3626
|
+
],
|
|
3627
|
+
"superclass": {
|
|
3628
|
+
"name": "Component",
|
|
3629
|
+
"module": "/src/models"
|
|
3630
|
+
},
|
|
3631
|
+
"tagName": "mdc-buttongroup",
|
|
3632
|
+
"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 */",
|
|
3633
|
+
"customElement": true
|
|
3634
|
+
}
|
|
3635
|
+
],
|
|
3636
|
+
"exports": [
|
|
3637
|
+
{
|
|
3638
|
+
"kind": "js",
|
|
3639
|
+
"name": "default",
|
|
3640
|
+
"declaration": {
|
|
3641
|
+
"name": "ButtonGroup",
|
|
3642
|
+
"module": "components/buttongroup/buttongroup.component.js"
|
|
3643
|
+
}
|
|
3644
|
+
}
|
|
3645
|
+
]
|
|
3646
|
+
},
|
|
3515
3647
|
{
|
|
3516
3648
|
"kind": "javascript-module",
|
|
3517
3649
|
"path": "components/buttonsimple/buttonsimple.component.js",
|
|
@@ -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",
|
|
@@ -5814,68 +5814,32 @@
|
|
|
5814
5814
|
},
|
|
5815
5815
|
{
|
|
5816
5816
|
"kind": "javascript-module",
|
|
5817
|
-
"path": "components/
|
|
5817
|
+
"path": "components/checkbox/checkbox.component.js",
|
|
5818
5818
|
"declarations": [
|
|
5819
5819
|
{
|
|
5820
5820
|
"kind": "class",
|
|
5821
|
-
"description": "
|
|
5822
|
-
"name": "
|
|
5823
|
-
"
|
|
5824
|
-
{
|
|
5825
|
-
"description": "This slot is for passing the content before the body",
|
|
5826
|
-
"name": "before-body",
|
|
5827
|
-
"inheritedFrom": {
|
|
5828
|
-
"name": "Card",
|
|
5829
|
-
"module": "src/components/card/card.component.ts"
|
|
5830
|
-
}
|
|
5831
|
-
},
|
|
5832
|
-
{
|
|
5833
|
-
"description": "This slot is for passing the text content for the card",
|
|
5834
|
-
"name": "body",
|
|
5835
|
-
"inheritedFrom": {
|
|
5836
|
-
"name": "Card",
|
|
5837
|
-
"module": "src/components/card/card.component.ts"
|
|
5838
|
-
}
|
|
5839
|
-
},
|
|
5821
|
+
"description": "Checkboxes allow users to select multiple options from a list or turn an item/feature on or off.\nThese are often used in forms, settings, and selections in lists.\n\nA checkbox component contains an optional label and an optional helper text.\n\nTo create a group of checkboxes, use the FormFieldGroup component.",
|
|
5822
|
+
"name": "Checkbox",
|
|
5823
|
+
"cssProperties": [
|
|
5840
5824
|
{
|
|
5841
|
-
"description": "
|
|
5842
|
-
"name": "
|
|
5843
|
-
"inheritedFrom": {
|
|
5844
|
-
"name": "Card",
|
|
5845
|
-
"module": "src/components/card/card.component.ts"
|
|
5846
|
-
}
|
|
5825
|
+
"description": "Allows customization of the background color on hover.",
|
|
5826
|
+
"name": "--mdc-checkbox-background-color-hover"
|
|
5847
5827
|
},
|
|
5848
5828
|
{
|
|
5849
|
-
"description": "
|
|
5850
|
-
"name": "
|
|
5851
|
-
"inheritedFrom": {
|
|
5852
|
-
"name": "Card",
|
|
5853
|
-
"module": "src/components/card/card.component.ts"
|
|
5854
|
-
}
|
|
5829
|
+
"description": "Background color for a selected checkbox when hovered.",
|
|
5830
|
+
"name": "--mdc-checkbox-checked-background-color-hover"
|
|
5855
5831
|
},
|
|
5856
5832
|
{
|
|
5857
|
-
"description": "
|
|
5858
|
-
"name": "
|
|
5859
|
-
"inheritedFrom": {
|
|
5860
|
-
"name": "Card",
|
|
5861
|
-
"module": "src/components/card/card.component.ts"
|
|
5862
|
-
}
|
|
5833
|
+
"description": "Background color for a selected checkbox when pressed.",
|
|
5834
|
+
"name": "--mdc-checkbox-checked-pressed-icon-color"
|
|
5863
5835
|
},
|
|
5864
5836
|
{
|
|
5865
|
-
"description": "
|
|
5866
|
-
"name": "
|
|
5867
|
-
"inheritedFrom": {
|
|
5868
|
-
"name": "Card",
|
|
5869
|
-
"module": "src/components/card/card.component.ts"
|
|
5870
|
-
}
|
|
5837
|
+
"description": "Background color for a selected checkbox when pressed.",
|
|
5838
|
+
"name": "--mdc-checkbox-pressed-icon-color"
|
|
5871
5839
|
},
|
|
5872
5840
|
{
|
|
5873
|
-
"description": "
|
|
5874
|
-
"name": "
|
|
5875
|
-
"inheritedFrom": {
|
|
5876
|
-
"name": "Card",
|
|
5877
|
-
"module": "src/components/card/card.component.ts"
|
|
5878
|
-
}
|
|
5841
|
+
"description": "Background color for a selected checkbox when disabled.",
|
|
5842
|
+
"name": "--mdc-checkbox-disabled-checked-icon-color"
|
|
5879
5843
|
}
|
|
5880
5844
|
],
|
|
5881
5845
|
"members": [
|
|
@@ -5886,45 +5850,59 @@
|
|
|
5886
5850
|
"text": "boolean"
|
|
5887
5851
|
},
|
|
5888
5852
|
"default": "false",
|
|
5889
|
-
"description": "
|
|
5853
|
+
"description": "Determines whether the checkbox is selected or unselected.",
|
|
5890
5854
|
"attribute": "checked",
|
|
5891
5855
|
"reflects": true
|
|
5892
5856
|
},
|
|
5893
5857
|
{
|
|
5894
5858
|
"kind": "field",
|
|
5895
|
-
"name": "
|
|
5859
|
+
"name": "indeterminate",
|
|
5896
5860
|
"type": {
|
|
5897
|
-
"text": "
|
|
5861
|
+
"text": "boolean"
|
|
5898
5862
|
},
|
|
5899
|
-
"default": "
|
|
5900
|
-
"description": "
|
|
5901
|
-
"attribute": "
|
|
5863
|
+
"default": "false",
|
|
5864
|
+
"description": "This property is used to determine the parent checkbox in a nested checkbox group.\nIf any one of the children is unselected, then the parent checkbox will be indeterminate.\nIf all children are either selected or unselected, then the parent checkbox will not be indeterminate.",
|
|
5865
|
+
"attribute": "indeterminate",
|
|
5866
|
+
"reflects": true
|
|
5867
|
+
},
|
|
5868
|
+
{
|
|
5869
|
+
"kind": "field",
|
|
5870
|
+
"name": "autofocus",
|
|
5871
|
+
"type": {
|
|
5872
|
+
"text": "boolean"
|
|
5873
|
+
},
|
|
5874
|
+
"default": "false",
|
|
5875
|
+
"description": "Automatically focus on the element when the page loads.\n[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/autofocus)",
|
|
5876
|
+
"attribute": "autofocus",
|
|
5877
|
+
"reflects": true
|
|
5902
5878
|
},
|
|
5903
5879
|
{
|
|
5904
5880
|
"kind": "method",
|
|
5905
|
-
"name": "
|
|
5881
|
+
"name": "setFormValue",
|
|
5906
5882
|
"privacy": "private",
|
|
5907
|
-
"
|
|
5908
|
-
"type": {
|
|
5909
|
-
"text": "CardRadio[]"
|
|
5910
|
-
}
|
|
5911
|
-
},
|
|
5912
|
-
"description": "Returns all cards within the same group (name)."
|
|
5883
|
+
"description": "Updates the form value to reflect the current state of the checkbox.\nIf checked, the value is set to either the user-provided value or 'on' if no value is provided.\nIf unchecked, the value is set to null."
|
|
5913
5884
|
},
|
|
5914
5885
|
{
|
|
5915
5886
|
"kind": "method",
|
|
5916
|
-
"name": "
|
|
5887
|
+
"name": "manageRequired",
|
|
5888
|
+
"privacy": "private",
|
|
5889
|
+
"description": "Manages the required state of the checkbox.\nIf the checkbox is not checked and the required property is set, then the checkbox is invalid."
|
|
5890
|
+
},
|
|
5891
|
+
{
|
|
5892
|
+
"kind": "method",
|
|
5893
|
+
"name": "toggleState",
|
|
5917
5894
|
"privacy": "private",
|
|
5918
5895
|
"return": {
|
|
5919
5896
|
"type": {
|
|
5920
5897
|
"text": "void"
|
|
5921
5898
|
}
|
|
5922
5899
|
},
|
|
5923
|
-
"description": "
|
|
5900
|
+
"description": "Toggles the state of the checkbox element.\nIf the element is not disabled, then\nthe checked property is toggled and the indeterminate property is set to false."
|
|
5924
5901
|
},
|
|
5925
5902
|
{
|
|
5926
5903
|
"kind": "method",
|
|
5927
|
-
"name": "
|
|
5904
|
+
"name": "handleKeyDown",
|
|
5905
|
+
"privacy": "private",
|
|
5928
5906
|
"return": {
|
|
5929
5907
|
"type": {
|
|
5930
5908
|
"text": "void"
|
|
@@ -5932,17 +5910,19 @@
|
|
|
5932
5910
|
},
|
|
5933
5911
|
"parameters": [
|
|
5934
5912
|
{
|
|
5935
|
-
"name": "
|
|
5913
|
+
"name": "event",
|
|
5936
5914
|
"type": {
|
|
5937
|
-
"text": "
|
|
5938
|
-
}
|
|
5915
|
+
"text": "KeyboardEvent"
|
|
5916
|
+
},
|
|
5917
|
+
"description": "The keyboard event."
|
|
5939
5918
|
}
|
|
5940
|
-
]
|
|
5919
|
+
],
|
|
5920
|
+
"description": "Handles the keydown event on the checkbox.\nWhen the user presses Enter, the form is submitted."
|
|
5941
5921
|
},
|
|
5942
5922
|
{
|
|
5943
5923
|
"kind": "method",
|
|
5944
|
-
"name": "
|
|
5945
|
-
"privacy": "
|
|
5924
|
+
"name": "handleChange",
|
|
5925
|
+
"privacy": "public",
|
|
5946
5926
|
"return": {
|
|
5947
5927
|
"type": {
|
|
5948
5928
|
"text": "void"
|
|
@@ -5950,312 +5930,352 @@
|
|
|
5950
5930
|
},
|
|
5951
5931
|
"parameters": [
|
|
5952
5932
|
{
|
|
5953
|
-
"name": "
|
|
5954
|
-
"type": {
|
|
5955
|
-
"text": "CardRadio[]"
|
|
5956
|
-
}
|
|
5957
|
-
},
|
|
5958
|
-
{
|
|
5959
|
-
"name": "index",
|
|
5933
|
+
"name": "event",
|
|
5960
5934
|
"type": {
|
|
5961
|
-
"text": "
|
|
5935
|
+
"text": "Event"
|
|
5962
5936
|
}
|
|
5963
5937
|
}
|
|
5964
|
-
]
|
|
5938
|
+
],
|
|
5939
|
+
"description": "Toggles the state of the checkbox element.\nand dispatch the new change event."
|
|
5965
5940
|
},
|
|
5966
5941
|
{
|
|
5967
|
-
"kind": "
|
|
5968
|
-
"name": "
|
|
5969
|
-
"privacy": "private"
|
|
5970
|
-
|
|
5971
|
-
|
|
5972
|
-
|
|
5973
|
-
|
|
5974
|
-
|
|
5975
|
-
|
|
5976
|
-
|
|
5977
|
-
|
|
5978
|
-
|
|
5979
|
-
"
|
|
5942
|
+
"kind": "field",
|
|
5943
|
+
"name": "renderLabelAndHelperText",
|
|
5944
|
+
"privacy": "private"
|
|
5945
|
+
},
|
|
5946
|
+
{
|
|
5947
|
+
"kind": "field",
|
|
5948
|
+
"name": "name",
|
|
5949
|
+
"type": {
|
|
5950
|
+
"text": "string"
|
|
5951
|
+
},
|
|
5952
|
+
"default": "''",
|
|
5953
|
+
"description": "Indicates the name of the component group.\nThey are used to group elements in a form together.",
|
|
5954
|
+
"attribute": "name",
|
|
5955
|
+
"reflects": true,
|
|
5956
|
+
"inheritedFrom": {
|
|
5957
|
+
"name": "FormInternalsMixin",
|
|
5958
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
|
5959
|
+
}
|
|
5960
|
+
},
|
|
5961
|
+
{
|
|
5962
|
+
"kind": "field",
|
|
5963
|
+
"name": "value",
|
|
5964
|
+
"type": {
|
|
5965
|
+
"text": "string"
|
|
5966
|
+
},
|
|
5967
|
+
"default": "''",
|
|
5968
|
+
"description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
|
|
5969
|
+
"attribute": "value",
|
|
5970
|
+
"reflects": true,
|
|
5971
|
+
"inheritedFrom": {
|
|
5972
|
+
"name": "FormInternalsMixin",
|
|
5973
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
|
5974
|
+
}
|
|
5975
|
+
},
|
|
5976
|
+
{
|
|
5977
|
+
"kind": "field",
|
|
5978
|
+
"name": "validationMessage",
|
|
5979
|
+
"type": {
|
|
5980
|
+
"text": "string | undefined"
|
|
5981
|
+
},
|
|
5982
|
+
"description": "Custom validation message that will override the default message and displayed when the input is invalid.",
|
|
5983
|
+
"attribute": "validation-message",
|
|
5984
|
+
"reflects": true,
|
|
5985
|
+
"inheritedFrom": {
|
|
5986
|
+
"name": "FormInternalsMixin",
|
|
5987
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
|
5988
|
+
}
|
|
5989
|
+
},
|
|
5990
|
+
{
|
|
5991
|
+
"kind": "field",
|
|
5992
|
+
"name": "validity",
|
|
5993
|
+
"type": {
|
|
5994
|
+
"text": "ValidityState"
|
|
5995
|
+
},
|
|
5996
|
+
"readonly": true,
|
|
5997
|
+
"inheritedFrom": {
|
|
5998
|
+
"name": "FormInternalsMixin",
|
|
5999
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
|
6000
|
+
}
|
|
6001
|
+
},
|
|
6002
|
+
{
|
|
6003
|
+
"kind": "field",
|
|
6004
|
+
"name": "willValidate",
|
|
6005
|
+
"readonly": true,
|
|
6006
|
+
"inheritedFrom": {
|
|
6007
|
+
"name": "FormInternalsMixin",
|
|
6008
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
|
6009
|
+
}
|
|
5980
6010
|
},
|
|
5981
6011
|
{
|
|
5982
6012
|
"kind": "method",
|
|
5983
|
-
"name": "
|
|
5984
|
-
"
|
|
5985
|
-
"
|
|
5986
|
-
{
|
|
5987
|
-
"
|
|
5988
|
-
"type": {
|
|
5989
|
-
"text": "KeyboardEvent"
|
|
5990
|
-
},
|
|
5991
|
-
"description": "The keyboard event"
|
|
6013
|
+
"name": "setValidity",
|
|
6014
|
+
"description": "Sets the validity of the input field based on the input field's validity.",
|
|
6015
|
+
"return": {
|
|
6016
|
+
"type": {
|
|
6017
|
+
"text": ""
|
|
5992
6018
|
}
|
|
5993
|
-
|
|
5994
|
-
"
|
|
6019
|
+
},
|
|
6020
|
+
"inheritedFrom": {
|
|
6021
|
+
"name": "FormInternalsMixin",
|
|
6022
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
|
6023
|
+
}
|
|
5995
6024
|
},
|
|
5996
6025
|
{
|
|
5997
6026
|
"kind": "method",
|
|
5998
|
-
"name": "
|
|
5999
|
-
"privacy": "protected",
|
|
6000
|
-
"description": "Renders the header of the card",
|
|
6027
|
+
"name": "checkValidity",
|
|
6001
6028
|
"return": {
|
|
6002
6029
|
"type": {
|
|
6003
|
-
"text": ""
|
|
6030
|
+
"text": "boolean"
|
|
6004
6031
|
}
|
|
6005
6032
|
},
|
|
6006
6033
|
"inheritedFrom": {
|
|
6007
|
-
"name": "
|
|
6008
|
-
"module": "
|
|
6034
|
+
"name": "FormInternalsMixin",
|
|
6035
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
|
6036
|
+
}
|
|
6037
|
+
},
|
|
6038
|
+
{
|
|
6039
|
+
"kind": "method",
|
|
6040
|
+
"name": "reportValidity",
|
|
6041
|
+
"inheritedFrom": {
|
|
6042
|
+
"name": "FormInternalsMixin",
|
|
6043
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
|
6009
6044
|
}
|
|
6010
6045
|
},
|
|
6011
6046
|
{
|
|
6012
6047
|
"kind": "field",
|
|
6013
|
-
"name": "
|
|
6048
|
+
"name": "dataAriaLabel",
|
|
6014
6049
|
"type": {
|
|
6015
|
-
"text": "
|
|
6050
|
+
"text": "string | null"
|
|
6016
6051
|
},
|
|
6017
|
-
"
|
|
6018
|
-
"
|
|
6019
|
-
"attribute": "
|
|
6052
|
+
"default": "null",
|
|
6053
|
+
"description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
|
|
6054
|
+
"attribute": "data-aria-label",
|
|
6020
6055
|
"reflects": true,
|
|
6021
6056
|
"inheritedFrom": {
|
|
6022
|
-
"name": "
|
|
6023
|
-
"module": "utils/mixins/
|
|
6057
|
+
"name": "DataAriaLabelMixin",
|
|
6058
|
+
"module": "utils/mixins/DataAriaLabelMixin.js"
|
|
6024
6059
|
}
|
|
6025
6060
|
},
|
|
6026
6061
|
{
|
|
6027
6062
|
"kind": "field",
|
|
6028
|
-
"name": "
|
|
6063
|
+
"name": "disabled",
|
|
6029
6064
|
"type": {
|
|
6030
|
-
"text": "
|
|
6065
|
+
"text": "boolean | undefined"
|
|
6031
6066
|
},
|
|
6032
|
-
"
|
|
6033
|
-
"
|
|
6034
|
-
"attribute": "
|
|
6067
|
+
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
|
6068
|
+
"default": "undefined",
|
|
6069
|
+
"attribute": "disabled",
|
|
6035
6070
|
"reflects": true,
|
|
6036
6071
|
"inheritedFrom": {
|
|
6037
|
-
"name": "
|
|
6038
|
-
"module": "utils/mixins/
|
|
6072
|
+
"name": "DisabledMixin",
|
|
6073
|
+
"module": "utils/mixins/DisabledMixin.js"
|
|
6039
6074
|
}
|
|
6040
6075
|
},
|
|
6041
6076
|
{
|
|
6042
6077
|
"kind": "field",
|
|
6043
|
-
"name": "
|
|
6078
|
+
"name": "label",
|
|
6044
6079
|
"type": {
|
|
6045
|
-
"text": "string"
|
|
6080
|
+
"text": "string | undefined"
|
|
6046
6081
|
},
|
|
6047
|
-
"
|
|
6048
|
-
"
|
|
6049
|
-
"attribute": "card-title",
|
|
6082
|
+
"description": "The label of the input field. It is linked to the input field using the `for` attribute.",
|
|
6083
|
+
"attribute": "label",
|
|
6050
6084
|
"reflects": true,
|
|
6051
6085
|
"inheritedFrom": {
|
|
6052
|
-
"name": "
|
|
6053
|
-
"module": "components/
|
|
6086
|
+
"name": "FormfieldWrapper",
|
|
6087
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
|
6054
6088
|
}
|
|
6055
6089
|
},
|
|
6056
6090
|
{
|
|
6057
6091
|
"kind": "field",
|
|
6058
|
-
"name": "
|
|
6092
|
+
"name": "required",
|
|
6059
6093
|
"type": {
|
|
6060
|
-
"text": "
|
|
6094
|
+
"text": "boolean"
|
|
6061
6095
|
},
|
|
6062
|
-
"default": "
|
|
6063
|
-
"description": "The
|
|
6064
|
-
"attribute": "
|
|
6096
|
+
"default": "false",
|
|
6097
|
+
"description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
|
|
6098
|
+
"attribute": "required",
|
|
6065
6099
|
"reflects": true,
|
|
6066
6100
|
"inheritedFrom": {
|
|
6067
|
-
"name": "
|
|
6068
|
-
"module": "components/
|
|
6101
|
+
"name": "FormfieldWrapper",
|
|
6102
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
|
6069
6103
|
}
|
|
6070
6104
|
},
|
|
6071
6105
|
{
|
|
6072
6106
|
"kind": "field",
|
|
6073
|
-
"name": "
|
|
6107
|
+
"name": "id",
|
|
6074
6108
|
"type": {
|
|
6075
6109
|
"text": "string"
|
|
6076
6110
|
},
|
|
6077
6111
|
"default": "''",
|
|
6078
|
-
"description": "The
|
|
6079
|
-
"attribute": "
|
|
6080
|
-
"reflects": true,
|
|
6112
|
+
"description": "The unique id of the input field. It is used to link the input field with the label.",
|
|
6113
|
+
"attribute": "id",
|
|
6081
6114
|
"inheritedFrom": {
|
|
6082
|
-
"name": "
|
|
6083
|
-
"module": "components/
|
|
6115
|
+
"name": "FormfieldWrapper",
|
|
6116
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
|
6084
6117
|
}
|
|
6085
6118
|
},
|
|
6086
6119
|
{
|
|
6087
6120
|
"kind": "field",
|
|
6088
|
-
"name": "
|
|
6121
|
+
"name": "helpTextType",
|
|
6089
6122
|
"type": {
|
|
6090
|
-
"text": "
|
|
6123
|
+
"text": "ValidationType"
|
|
6091
6124
|
},
|
|
6092
|
-
"
|
|
6093
|
-
"
|
|
6094
|
-
"attribute": "image-alt",
|
|
6125
|
+
"description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
|
|
6126
|
+
"attribute": "help-text-type",
|
|
6095
6127
|
"reflects": true,
|
|
6096
6128
|
"inheritedFrom": {
|
|
6097
|
-
"name": "
|
|
6098
|
-
"module": "components/
|
|
6129
|
+
"name": "FormfieldWrapper",
|
|
6130
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
|
6099
6131
|
}
|
|
6100
6132
|
},
|
|
6101
6133
|
{
|
|
6102
6134
|
"kind": "field",
|
|
6103
|
-
"name": "
|
|
6135
|
+
"name": "helpText",
|
|
6104
6136
|
"type": {
|
|
6105
|
-
"text": "
|
|
6137
|
+
"text": "string | undefined"
|
|
6106
6138
|
},
|
|
6107
|
-
"description": "The
|
|
6108
|
-
"
|
|
6109
|
-
"attribute": "variant",
|
|
6139
|
+
"description": "The help text that is displayed below the input field.",
|
|
6140
|
+
"attribute": "help-text",
|
|
6110
6141
|
"reflects": true,
|
|
6111
6142
|
"inheritedFrom": {
|
|
6112
|
-
"name": "
|
|
6113
|
-
"module": "components/
|
|
6143
|
+
"name": "FormfieldWrapper",
|
|
6144
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
|
6114
6145
|
}
|
|
6115
6146
|
},
|
|
6116
6147
|
{
|
|
6117
6148
|
"kind": "field",
|
|
6118
|
-
"name": "
|
|
6149
|
+
"name": "toggletipText",
|
|
6119
6150
|
"type": {
|
|
6120
|
-
"text": "
|
|
6151
|
+
"text": "string | undefined"
|
|
6121
6152
|
},
|
|
6122
|
-
"description": "The
|
|
6123
|
-
"
|
|
6124
|
-
"attribute": "orientation",
|
|
6153
|
+
"description": "The toggletip text that is displayed when the label is hovered.\nIt is used to provide additional information about the label.",
|
|
6154
|
+
"attribute": "toggletip-text",
|
|
6125
6155
|
"reflects": true,
|
|
6126
6156
|
"inheritedFrom": {
|
|
6127
|
-
"name": "
|
|
6128
|
-
"module": "components/
|
|
6157
|
+
"name": "FormfieldWrapper",
|
|
6158
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
|
6129
6159
|
}
|
|
6130
6160
|
},
|
|
6131
6161
|
{
|
|
6132
6162
|
"kind": "field",
|
|
6133
|
-
"name": "
|
|
6163
|
+
"name": "toggletipPlacement",
|
|
6134
6164
|
"type": {
|
|
6135
|
-
"text": "
|
|
6165
|
+
"text": "PopoverPlacement"
|
|
6136
6166
|
},
|
|
6137
|
-
"description": "The
|
|
6138
|
-
"default": "'
|
|
6139
|
-
"attribute": "
|
|
6167
|
+
"description": "The placement of the toggletip that is displayed when the info icon is hovered.",
|
|
6168
|
+
"default": "'top'",
|
|
6169
|
+
"attribute": "toggletip-placement",
|
|
6140
6170
|
"reflects": true,
|
|
6141
6171
|
"inheritedFrom": {
|
|
6142
|
-
"name": "
|
|
6143
|
-
"module": "components/
|
|
6172
|
+
"name": "FormfieldWrapper",
|
|
6173
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
|
6144
6174
|
}
|
|
6145
6175
|
},
|
|
6146
6176
|
{
|
|
6147
6177
|
"kind": "field",
|
|
6148
|
-
"name": "
|
|
6178
|
+
"name": "infoIconAriaLabel",
|
|
6149
6179
|
"type": {
|
|
6150
|
-
"text": "
|
|
6180
|
+
"text": "string | undefined"
|
|
6151
6181
|
},
|
|
6152
|
-
"description": "
|
|
6153
|
-
"
|
|
6154
|
-
"attribute": "subtitle-tag-name",
|
|
6182
|
+
"description": "Aria label for the info icon that is displayed next to the label when `toggletipText` is set.\nThis is used for accessibility purposes to provide a description of the icon.",
|
|
6183
|
+
"attribute": "info-icon-aria-label",
|
|
6155
6184
|
"reflects": true,
|
|
6156
6185
|
"inheritedFrom": {
|
|
6157
|
-
"name": "
|
|
6158
|
-
"module": "components/
|
|
6186
|
+
"name": "FormfieldWrapper",
|
|
6187
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
|
6159
6188
|
}
|
|
6160
6189
|
},
|
|
6161
6190
|
{
|
|
6162
|
-
"kind": "
|
|
6163
|
-
"name": "
|
|
6164
|
-
"
|
|
6165
|
-
|
|
6191
|
+
"kind": "method",
|
|
6192
|
+
"name": "renderLabelElement",
|
|
6193
|
+
"privacy": "protected",
|
|
6194
|
+
"description": "creates the label element when the label property is set.\nid is used to link the label with the input field.",
|
|
6195
|
+
"return": {
|
|
6196
|
+
"type": {
|
|
6197
|
+
"text": ""
|
|
6198
|
+
}
|
|
6166
6199
|
},
|
|
6167
|
-
"description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
|
|
6168
|
-
"attribute": "icon-name",
|
|
6169
|
-
"reflects": true,
|
|
6170
6200
|
"inheritedFrom": {
|
|
6171
|
-
"name": "
|
|
6172
|
-
"module": "components/
|
|
6201
|
+
"name": "FormfieldWrapper",
|
|
6202
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
|
6173
6203
|
}
|
|
6174
6204
|
},
|
|
6175
6205
|
{
|
|
6176
6206
|
"kind": "method",
|
|
6177
|
-
"name": "
|
|
6207
|
+
"name": "renderHelpTextIcon",
|
|
6178
6208
|
"privacy": "protected",
|
|
6179
|
-
"description": "
|
|
6209
|
+
"description": "creates the helpertext icon based on the helpTextType for validation.\nIf the helpTextType is not set, it defaults to 'default' and it doesn't display any icon.",
|
|
6180
6210
|
"return": {
|
|
6181
6211
|
"type": {
|
|
6182
6212
|
"text": ""
|
|
6183
6213
|
}
|
|
6184
6214
|
},
|
|
6185
6215
|
"inheritedFrom": {
|
|
6186
|
-
"name": "
|
|
6187
|
-
"module": "components/
|
|
6216
|
+
"name": "FormfieldWrapper",
|
|
6217
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
|
6188
6218
|
}
|
|
6189
6219
|
},
|
|
6190
6220
|
{
|
|
6191
6221
|
"kind": "method",
|
|
6192
|
-
"name": "
|
|
6222
|
+
"name": "renderHelpText",
|
|
6193
6223
|
"privacy": "protected",
|
|
6194
|
-
"description": "
|
|
6224
|
+
"description": "creates the helper text component when the helpertext value is set.\nIt is also used to display the validation message based on the helpTextType.",
|
|
6195
6225
|
"return": {
|
|
6196
6226
|
"type": {
|
|
6197
6227
|
"text": ""
|
|
6198
6228
|
}
|
|
6199
6229
|
},
|
|
6200
6230
|
"inheritedFrom": {
|
|
6201
|
-
"name": "
|
|
6202
|
-
"module": "components/
|
|
6231
|
+
"name": "FormfieldWrapper",
|
|
6232
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
|
6203
6233
|
}
|
|
6204
6234
|
},
|
|
6205
6235
|
{
|
|
6206
6236
|
"kind": "method",
|
|
6207
|
-
"name": "
|
|
6237
|
+
"name": "renderLabel",
|
|
6208
6238
|
"privacy": "protected",
|
|
6209
|
-
"description": "
|
|
6239
|
+
"description": "renders the mdc-label-text container that contains the label and labelInfoToggleTip.",
|
|
6210
6240
|
"return": {
|
|
6211
6241
|
"type": {
|
|
6212
6242
|
"text": ""
|
|
6213
6243
|
}
|
|
6214
6244
|
},
|
|
6215
6245
|
"inheritedFrom": {
|
|
6216
|
-
"name": "
|
|
6217
|
-
"module": "components/
|
|
6246
|
+
"name": "FormfieldWrapper",
|
|
6247
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
|
6218
6248
|
}
|
|
6219
6249
|
},
|
|
6220
6250
|
{
|
|
6221
6251
|
"kind": "method",
|
|
6222
|
-
"name": "
|
|
6252
|
+
"name": "renderHelperText",
|
|
6223
6253
|
"privacy": "protected",
|
|
6224
|
-
"description": "
|
|
6254
|
+
"description": "renders the mdc-help-text container that contains the helpertext icon and helpertext.",
|
|
6225
6255
|
"return": {
|
|
6226
6256
|
"type": {
|
|
6227
6257
|
"text": ""
|
|
6228
6258
|
}
|
|
6229
6259
|
},
|
|
6230
6260
|
"inheritedFrom": {
|
|
6231
|
-
"name": "
|
|
6232
|
-
"module": "components/
|
|
6261
|
+
"name": "FormfieldWrapper",
|
|
6262
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
|
6233
6263
|
}
|
|
6234
6264
|
}
|
|
6235
6265
|
],
|
|
6236
6266
|
"events": [
|
|
6237
6267
|
{
|
|
6238
|
-
"
|
|
6239
|
-
|
|
6240
|
-
|
|
6241
|
-
},
|
|
6242
|
-
{
|
|
6243
|
-
"description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the card. It toggles the checked state when enter key is used.",
|
|
6244
|
-
"name": "keydown",
|
|
6245
|
-
"reactName": "onKeyDown"
|
|
6246
|
-
},
|
|
6247
|
-
{
|
|
6248
|
-
"description": "(React: onKeyUp) This event is dispatched when a key is released on the card. It toggles the checked state when space key is used.",
|
|
6249
|
-
"name": "keyup",
|
|
6250
|
-
"reactName": "onKeyUp"
|
|
6268
|
+
"type": {
|
|
6269
|
+
"text": "EventConstructor"
|
|
6270
|
+
}
|
|
6251
6271
|
},
|
|
6252
6272
|
{
|
|
6253
|
-
"description": "(React: onChange) Event that gets dispatched when the
|
|
6273
|
+
"description": "(React: onChange) Event that gets dispatched when the checkbox state changes.",
|
|
6254
6274
|
"name": "change",
|
|
6255
6275
|
"reactName": "onChange"
|
|
6256
6276
|
},
|
|
6257
6277
|
{
|
|
6258
|
-
"description": "(React: onFocus) Event that gets dispatched when the
|
|
6278
|
+
"description": "(React: onFocus) Event that gets dispatched when the checkbox receives focus.",
|
|
6259
6279
|
"name": "focus",
|
|
6260
6280
|
"reactName": "onFocus"
|
|
6261
6281
|
}
|
|
@@ -6267,177 +6287,207 @@
|
|
|
6267
6287
|
"text": "boolean"
|
|
6268
6288
|
},
|
|
6269
6289
|
"default": "false",
|
|
6270
|
-
"description": "
|
|
6290
|
+
"description": "Determines whether the checkbox is selected or unselected.",
|
|
6271
6291
|
"fieldName": "checked"
|
|
6272
6292
|
},
|
|
6273
6293
|
{
|
|
6274
|
-
"name": "
|
|
6294
|
+
"name": "indeterminate",
|
|
6275
6295
|
"type": {
|
|
6276
|
-
"text": "
|
|
6296
|
+
"text": "boolean"
|
|
6277
6297
|
},
|
|
6278
|
-
"default": "
|
|
6279
|
-
"description": "
|
|
6280
|
-
"fieldName": "
|
|
6298
|
+
"default": "false",
|
|
6299
|
+
"description": "This property is used to determine the parent checkbox in a nested checkbox group.\nIf any one of the children is unselected, then the parent checkbox will be indeterminate.\nIf all children are either selected or unselected, then the parent checkbox will not be indeterminate.",
|
|
6300
|
+
"fieldName": "indeterminate"
|
|
6281
6301
|
},
|
|
6282
6302
|
{
|
|
6283
|
-
"name": "
|
|
6303
|
+
"name": "autofocus",
|
|
6284
6304
|
"type": {
|
|
6285
|
-
"text": "boolean
|
|
6305
|
+
"text": "boolean"
|
|
6286
6306
|
},
|
|
6287
|
-
"
|
|
6288
|
-
"
|
|
6289
|
-
"fieldName": "
|
|
6290
|
-
"inheritedFrom": {
|
|
6291
|
-
"name": "DisabledMixin",
|
|
6292
|
-
"module": "src/utils/mixins/DisabledMixin.ts"
|
|
6293
|
-
}
|
|
6307
|
+
"default": "false",
|
|
6308
|
+
"description": "Automatically focus on the element when the page loads.\n[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/autofocus)",
|
|
6309
|
+
"fieldName": "autofocus"
|
|
6294
6310
|
},
|
|
6295
6311
|
{
|
|
6296
|
-
"name": "
|
|
6312
|
+
"name": "name",
|
|
6297
6313
|
"type": {
|
|
6298
|
-
"text": "
|
|
6314
|
+
"text": "string"
|
|
6299
6315
|
},
|
|
6300
|
-
"default": "
|
|
6301
|
-
"description": "
|
|
6302
|
-
"fieldName": "
|
|
6316
|
+
"default": "''",
|
|
6317
|
+
"description": "Indicates the name of the component group.\nThey are used to group elements in a form together.",
|
|
6318
|
+
"fieldName": "name",
|
|
6303
6319
|
"inheritedFrom": {
|
|
6304
|
-
"name": "
|
|
6305
|
-
"module": "src/utils/mixins/
|
|
6320
|
+
"name": "FormInternalsMixin",
|
|
6321
|
+
"module": "src/utils/mixins/FormInternalsMixin.ts"
|
|
6306
6322
|
}
|
|
6307
6323
|
},
|
|
6308
6324
|
{
|
|
6309
|
-
"name": "
|
|
6325
|
+
"name": "value",
|
|
6310
6326
|
"type": {
|
|
6311
6327
|
"text": "string"
|
|
6312
6328
|
},
|
|
6313
6329
|
"default": "''",
|
|
6314
|
-
"description": "
|
|
6315
|
-
"fieldName": "
|
|
6330
|
+
"description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
|
|
6331
|
+
"fieldName": "value",
|
|
6316
6332
|
"inheritedFrom": {
|
|
6317
|
-
"name": "
|
|
6318
|
-
"module": "src/
|
|
6333
|
+
"name": "FormInternalsMixin",
|
|
6334
|
+
"module": "src/utils/mixins/FormInternalsMixin.ts"
|
|
6319
6335
|
}
|
|
6320
6336
|
},
|
|
6321
6337
|
{
|
|
6322
|
-
"name": "
|
|
6338
|
+
"name": "validation-message",
|
|
6323
6339
|
"type": {
|
|
6324
|
-
"text": "string"
|
|
6340
|
+
"text": "string | undefined"
|
|
6325
6341
|
},
|
|
6326
|
-
"
|
|
6327
|
-
"
|
|
6328
|
-
"fieldName": "subtitle",
|
|
6342
|
+
"description": "Custom validation message that will override the default message and displayed when the input is invalid.",
|
|
6343
|
+
"fieldName": "validationMessage",
|
|
6329
6344
|
"inheritedFrom": {
|
|
6330
|
-
"name": "
|
|
6331
|
-
"module": "src/
|
|
6345
|
+
"name": "FormInternalsMixin",
|
|
6346
|
+
"module": "src/utils/mixins/FormInternalsMixin.ts"
|
|
6332
6347
|
}
|
|
6333
6348
|
},
|
|
6334
6349
|
{
|
|
6335
|
-
"name": "
|
|
6350
|
+
"name": "data-aria-label",
|
|
6336
6351
|
"type": {
|
|
6337
|
-
"text": "string"
|
|
6352
|
+
"text": "string | null"
|
|
6338
6353
|
},
|
|
6339
|
-
"default": "
|
|
6340
|
-
"description": "
|
|
6341
|
-
"fieldName": "
|
|
6354
|
+
"default": "null",
|
|
6355
|
+
"description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
|
|
6356
|
+
"fieldName": "dataAriaLabel",
|
|
6342
6357
|
"inheritedFrom": {
|
|
6343
|
-
"name": "
|
|
6344
|
-
"module": "src/
|
|
6358
|
+
"name": "DataAriaLabelMixin",
|
|
6359
|
+
"module": "src/utils/mixins/DataAriaLabelMixin.ts"
|
|
6345
6360
|
}
|
|
6346
6361
|
},
|
|
6347
6362
|
{
|
|
6348
|
-
"name": "
|
|
6363
|
+
"name": "disabled",
|
|
6364
|
+
"type": {
|
|
6365
|
+
"text": "boolean | undefined"
|
|
6366
|
+
},
|
|
6367
|
+
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
|
6368
|
+
"default": "undefined",
|
|
6369
|
+
"fieldName": "disabled",
|
|
6370
|
+
"inheritedFrom": {
|
|
6371
|
+
"name": "DisabledMixin",
|
|
6372
|
+
"module": "src/utils/mixins/DisabledMixin.ts"
|
|
6373
|
+
}
|
|
6374
|
+
},
|
|
6375
|
+
{
|
|
6376
|
+
"name": "label",
|
|
6377
|
+
"type": {
|
|
6378
|
+
"text": "string | undefined"
|
|
6379
|
+
},
|
|
6380
|
+
"description": "The label of the input field. It is linked to the input field using the `for` attribute.",
|
|
6381
|
+
"fieldName": "label",
|
|
6382
|
+
"inheritedFrom": {
|
|
6383
|
+
"name": "FormfieldWrapper",
|
|
6384
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
|
6385
|
+
}
|
|
6386
|
+
},
|
|
6387
|
+
{
|
|
6388
|
+
"name": "required",
|
|
6389
|
+
"type": {
|
|
6390
|
+
"text": "boolean"
|
|
6391
|
+
},
|
|
6392
|
+
"default": "false",
|
|
6393
|
+
"description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
|
|
6394
|
+
"fieldName": "required",
|
|
6395
|
+
"inheritedFrom": {
|
|
6396
|
+
"name": "FormfieldWrapper",
|
|
6397
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
|
6398
|
+
}
|
|
6399
|
+
},
|
|
6400
|
+
{
|
|
6401
|
+
"name": "id",
|
|
6349
6402
|
"type": {
|
|
6350
6403
|
"text": "string"
|
|
6351
6404
|
},
|
|
6352
6405
|
"default": "''",
|
|
6353
|
-
"description": "The
|
|
6354
|
-
"fieldName": "
|
|
6406
|
+
"description": "The unique id of the input field. It is used to link the input field with the label.",
|
|
6407
|
+
"fieldName": "id",
|
|
6355
6408
|
"inheritedFrom": {
|
|
6356
|
-
"name": "
|
|
6357
|
-
"module": "src/components/
|
|
6409
|
+
"name": "FormfieldWrapper",
|
|
6410
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
|
6358
6411
|
}
|
|
6359
6412
|
},
|
|
6360
6413
|
{
|
|
6361
|
-
"name": "
|
|
6414
|
+
"name": "help-text-type",
|
|
6362
6415
|
"type": {
|
|
6363
|
-
"text": "
|
|
6416
|
+
"text": "ValidationType"
|
|
6364
6417
|
},
|
|
6365
|
-
"description": "The
|
|
6366
|
-
"
|
|
6367
|
-
"fieldName": "variant",
|
|
6418
|
+
"description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
|
|
6419
|
+
"fieldName": "helpTextType",
|
|
6368
6420
|
"inheritedFrom": {
|
|
6369
|
-
"name": "
|
|
6370
|
-
"module": "src/components/
|
|
6421
|
+
"name": "FormfieldWrapper",
|
|
6422
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
|
6371
6423
|
}
|
|
6372
6424
|
},
|
|
6373
6425
|
{
|
|
6374
|
-
"name": "
|
|
6426
|
+
"name": "help-text",
|
|
6375
6427
|
"type": {
|
|
6376
|
-
"text": "
|
|
6428
|
+
"text": "string | undefined"
|
|
6377
6429
|
},
|
|
6378
|
-
"description": "The
|
|
6379
|
-
"
|
|
6380
|
-
"fieldName": "orientation",
|
|
6430
|
+
"description": "The help text that is displayed below the input field.",
|
|
6431
|
+
"fieldName": "helpText",
|
|
6381
6432
|
"inheritedFrom": {
|
|
6382
|
-
"name": "
|
|
6383
|
-
"module": "src/components/
|
|
6433
|
+
"name": "FormfieldWrapper",
|
|
6434
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
|
6384
6435
|
}
|
|
6385
6436
|
},
|
|
6386
6437
|
{
|
|
6387
|
-
"name": "
|
|
6438
|
+
"name": "toggletip-text",
|
|
6388
6439
|
"type": {
|
|
6389
|
-
"text": "
|
|
6440
|
+
"text": "string | undefined"
|
|
6390
6441
|
},
|
|
6391
|
-
"description": "The
|
|
6392
|
-
"
|
|
6393
|
-
"fieldName": "titleTagName",
|
|
6442
|
+
"description": "The toggletip text that is displayed when the label is hovered.\nIt is used to provide additional information about the label.",
|
|
6443
|
+
"fieldName": "toggletipText",
|
|
6394
6444
|
"inheritedFrom": {
|
|
6395
|
-
"name": "
|
|
6396
|
-
"module": "src/components/
|
|
6445
|
+
"name": "FormfieldWrapper",
|
|
6446
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
|
6397
6447
|
}
|
|
6398
6448
|
},
|
|
6399
6449
|
{
|
|
6400
|
-
"name": "
|
|
6450
|
+
"name": "toggletip-placement",
|
|
6401
6451
|
"type": {
|
|
6402
|
-
"text": "
|
|
6452
|
+
"text": "PopoverPlacement"
|
|
6403
6453
|
},
|
|
6404
|
-
"description": "The
|
|
6405
|
-
"default": "'
|
|
6406
|
-
"fieldName": "
|
|
6454
|
+
"description": "The placement of the toggletip that is displayed when the info icon is hovered.",
|
|
6455
|
+
"default": "'top'",
|
|
6456
|
+
"fieldName": "toggletipPlacement",
|
|
6407
6457
|
"inheritedFrom": {
|
|
6408
|
-
"name": "
|
|
6409
|
-
"module": "src/components/
|
|
6458
|
+
"name": "FormfieldWrapper",
|
|
6459
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
|
6410
6460
|
}
|
|
6411
6461
|
},
|
|
6412
6462
|
{
|
|
6413
|
-
"name": "icon-
|
|
6463
|
+
"name": "info-icon-aria-label",
|
|
6414
6464
|
"type": {
|
|
6415
|
-
"text": "
|
|
6465
|
+
"text": "string | undefined"
|
|
6416
6466
|
},
|
|
6417
|
-
"description": "
|
|
6418
|
-
"fieldName": "
|
|
6467
|
+
"description": "Aria label for the info icon that is displayed next to the label when `toggletipText` is set.\nThis is used for accessibility purposes to provide a description of the icon.",
|
|
6468
|
+
"fieldName": "infoIconAriaLabel",
|
|
6419
6469
|
"inheritedFrom": {
|
|
6420
|
-
"name": "
|
|
6421
|
-
"module": "src/components/
|
|
6470
|
+
"name": "FormfieldWrapper",
|
|
6471
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
|
6422
6472
|
}
|
|
6423
6473
|
}
|
|
6424
6474
|
],
|
|
6425
6475
|
"mixins": [
|
|
6426
6476
|
{
|
|
6427
|
-
"name": "
|
|
6428
|
-
"module": "/src/utils/mixins/
|
|
6477
|
+
"name": "FormInternalsMixin",
|
|
6478
|
+
"module": "/src/utils/mixins/FormInternalsMixin"
|
|
6429
6479
|
},
|
|
6430
6480
|
{
|
|
6431
|
-
"name": "
|
|
6432
|
-
"module": "/src/utils/mixins/
|
|
6481
|
+
"name": "DataAriaLabelMixin",
|
|
6482
|
+
"module": "/src/utils/mixins/DataAriaLabelMixin"
|
|
6433
6483
|
}
|
|
6434
6484
|
],
|
|
6435
6485
|
"superclass": {
|
|
6436
|
-
"name": "
|
|
6437
|
-
"module": "/src/components/
|
|
6486
|
+
"name": "FormfieldWrapper",
|
|
6487
|
+
"module": "/src/components/formfieldwrapper/formfieldwrapper.component"
|
|
6438
6488
|
},
|
|
6439
|
-
"tagName": "mdc-
|
|
6440
|
-
"jsDoc": "/**\n *
|
|
6489
|
+
"tagName": "mdc-checkbox",
|
|
6490
|
+
"jsDoc": "/**\n * Checkboxes allow users to select multiple options from a list or turn an item/feature on or off.\n * These are often used in forms, settings, and selections in lists.\n *\n * A checkbox component contains an optional label and an optional helper text.\n *\n * To create a group of checkboxes, use the FormFieldGroup component.\n *\n * @dependency mdc-button\n * @dependency mdc-icon\n * @dependency mdc-staticcheckbox\n * @dependency mdc-text\n * @dependency mdc-toggletip\n *\n * @tagname mdc-checkbox\n *\n * @event change - (React: onChange) Event that gets dispatched when the checkbox state changes.\n * @event focus - (React: onFocus) Event that gets dispatched when the checkbox receives focus.\n *\n * @cssproperty --mdc-checkbox-background-color-hover - Allows customization of the background color on hover.\n * @cssproperty --mdc-checkbox-checked-background-color-hover - Background color for a selected checkbox when hovered.\n * @cssproperty --mdc-checkbox-checked-pressed-icon-color - Background color for a selected checkbox when pressed.\n * @cssproperty --mdc-checkbox-pressed-icon-color - Background color for a selected checkbox when pressed.\n * @cssproperty --mdc-checkbox-disabled-checked-icon-color - Background color for a selected checkbox when disabled.\n */",
|
|
6441
6491
|
"customElement": true
|
|
6442
6492
|
}
|
|
6443
6493
|
],
|
|
@@ -6446,40 +6496,76 @@
|
|
|
6446
6496
|
"kind": "js",
|
|
6447
6497
|
"name": "default",
|
|
6448
6498
|
"declaration": {
|
|
6449
|
-
"name": "
|
|
6450
|
-
"module": "components/
|
|
6499
|
+
"name": "Checkbox",
|
|
6500
|
+
"module": "components/checkbox/checkbox.component.js"
|
|
6451
6501
|
}
|
|
6452
6502
|
}
|
|
6453
6503
|
]
|
|
6454
6504
|
},
|
|
6455
6505
|
{
|
|
6456
6506
|
"kind": "javascript-module",
|
|
6457
|
-
"path": "components/
|
|
6507
|
+
"path": "components/cardradio/cardradio.component.js",
|
|
6458
6508
|
"declarations": [
|
|
6459
6509
|
{
|
|
6460
6510
|
"kind": "class",
|
|
6461
|
-
"description": "
|
|
6462
|
-
"name": "
|
|
6463
|
-
"
|
|
6511
|
+
"description": "cardradio component extends `mdc-card` and supports radio selection interaction addtionally.\n\nWhile using this component within a form or group of cards, make sure cards are in a role = \"radio-group\".\nThis card would have events for selected and unselected (similar to radio)\n\n**Note**: This is a single selection card i.e. interacting anywhere on the card would toggle the checked state.\nMake sure to pass only non-interactable elements within the slots.\n\nMake sure to pass the `card-title` mandatorily for this card.",
|
|
6512
|
+
"name": "CardRadio",
|
|
6513
|
+
"slots": [
|
|
6464
6514
|
{
|
|
6465
|
-
"description": "
|
|
6466
|
-
"name": "
|
|
6515
|
+
"description": "This slot is for passing the content before the body",
|
|
6516
|
+
"name": "before-body",
|
|
6517
|
+
"inheritedFrom": {
|
|
6518
|
+
"name": "Card",
|
|
6519
|
+
"module": "src/components/card/card.component.ts"
|
|
6520
|
+
}
|
|
6467
6521
|
},
|
|
6468
6522
|
{
|
|
6469
|
-
"description": "
|
|
6470
|
-
"name": "
|
|
6523
|
+
"description": "This slot is for passing the text content for the card",
|
|
6524
|
+
"name": "body",
|
|
6525
|
+
"inheritedFrom": {
|
|
6526
|
+
"name": "Card",
|
|
6527
|
+
"module": "src/components/card/card.component.ts"
|
|
6528
|
+
}
|
|
6471
6529
|
},
|
|
6472
6530
|
{
|
|
6473
|
-
"description": "
|
|
6474
|
-
"name": "
|
|
6531
|
+
"description": "This slot is for passing the content after the body",
|
|
6532
|
+
"name": "after-body",
|
|
6533
|
+
"inheritedFrom": {
|
|
6534
|
+
"name": "Card",
|
|
6535
|
+
"module": "src/components/card/card.component.ts"
|
|
6536
|
+
}
|
|
6475
6537
|
},
|
|
6476
6538
|
{
|
|
6477
|
-
"description": "
|
|
6478
|
-
"name": "
|
|
6539
|
+
"description": "This slot is for passing `mdc-link` component within the footer section.",
|
|
6540
|
+
"name": "footer-link",
|
|
6541
|
+
"inheritedFrom": {
|
|
6542
|
+
"name": "Card",
|
|
6543
|
+
"module": "src/components/card/card.component.ts"
|
|
6544
|
+
}
|
|
6479
6545
|
},
|
|
6480
6546
|
{
|
|
6481
|
-
"description": "
|
|
6482
|
-
"name": "
|
|
6547
|
+
"description": "This slot is for passing primary variant of `mdc-button` component within the footer section.",
|
|
6548
|
+
"name": "footer-button-primary",
|
|
6549
|
+
"inheritedFrom": {
|
|
6550
|
+
"name": "Card",
|
|
6551
|
+
"module": "src/components/card/card.component.ts"
|
|
6552
|
+
}
|
|
6553
|
+
},
|
|
6554
|
+
{
|
|
6555
|
+
"description": "This slot is for passing secondary variant of `mdc-button` component within the footer section.",
|
|
6556
|
+
"name": "footer-button-secondary",
|
|
6557
|
+
"inheritedFrom": {
|
|
6558
|
+
"name": "Card",
|
|
6559
|
+
"module": "src/components/card/card.component.ts"
|
|
6560
|
+
}
|
|
6561
|
+
},
|
|
6562
|
+
{
|
|
6563
|
+
"description": " This slot is for passing custom footer content. Only use this if really needed, using the footer-link and footer-button slots is preferred.",
|
|
6564
|
+
"name": "footer",
|
|
6565
|
+
"inheritedFrom": {
|
|
6566
|
+
"name": "Card",
|
|
6567
|
+
"module": "src/components/card/card.component.ts"
|
|
6568
|
+
}
|
|
6483
6569
|
}
|
|
6484
6570
|
],
|
|
6485
6571
|
"members": [
|
|
@@ -6490,59 +6576,45 @@
|
|
|
6490
6576
|
"text": "boolean"
|
|
6491
6577
|
},
|
|
6492
6578
|
"default": "false",
|
|
6493
|
-
"description": "
|
|
6579
|
+
"description": "The checked state of the card",
|
|
6494
6580
|
"attribute": "checked",
|
|
6495
6581
|
"reflects": true
|
|
6496
6582
|
},
|
|
6497
6583
|
{
|
|
6498
6584
|
"kind": "field",
|
|
6499
|
-
"name": "
|
|
6500
|
-
"type": {
|
|
6501
|
-
"text": "boolean"
|
|
6502
|
-
},
|
|
6503
|
-
"default": "false",
|
|
6504
|
-
"description": "This property is used to determine the parent checkbox in a nested checkbox group.\nIf any one of the children is unselected, then the parent checkbox will be indeterminate.\nIf all children are either selected or unselected, then the parent checkbox will not be indeterminate.",
|
|
6505
|
-
"attribute": "indeterminate",
|
|
6506
|
-
"reflects": true
|
|
6507
|
-
},
|
|
6508
|
-
{
|
|
6509
|
-
"kind": "field",
|
|
6510
|
-
"name": "autofocus",
|
|
6585
|
+
"name": "name",
|
|
6511
6586
|
"type": {
|
|
6512
|
-
"text": "
|
|
6587
|
+
"text": "string"
|
|
6513
6588
|
},
|
|
6514
|
-
"default": "
|
|
6515
|
-
"description": "
|
|
6516
|
-
"attribute": "
|
|
6517
|
-
"reflects": true
|
|
6518
|
-
},
|
|
6519
|
-
{
|
|
6520
|
-
"kind": "method",
|
|
6521
|
-
"name": "setFormValue",
|
|
6522
|
-
"privacy": "private",
|
|
6523
|
-
"description": "Updates the form value to reflect the current state of the checkbox.\nIf checked, the value is set to either the user-provided value or 'on' if no value is provided.\nIf unchecked, the value is set to null."
|
|
6589
|
+
"default": "''",
|
|
6590
|
+
"description": "The name of the radio.",
|
|
6591
|
+
"attribute": "name"
|
|
6524
6592
|
},
|
|
6525
6593
|
{
|
|
6526
6594
|
"kind": "method",
|
|
6527
|
-
"name": "
|
|
6595
|
+
"name": "getAllCardsWithinSameGroup",
|
|
6528
6596
|
"privacy": "private",
|
|
6529
|
-
"
|
|
6597
|
+
"return": {
|
|
6598
|
+
"type": {
|
|
6599
|
+
"text": "CardRadio[]"
|
|
6600
|
+
}
|
|
6601
|
+
},
|
|
6602
|
+
"description": "Returns all cards within the same group (name)."
|
|
6530
6603
|
},
|
|
6531
6604
|
{
|
|
6532
6605
|
"kind": "method",
|
|
6533
|
-
"name": "
|
|
6606
|
+
"name": "toggleChecked",
|
|
6534
6607
|
"privacy": "private",
|
|
6535
6608
|
"return": {
|
|
6536
6609
|
"type": {
|
|
6537
6610
|
"text": "void"
|
|
6538
6611
|
}
|
|
6539
6612
|
},
|
|
6540
|
-
"description": "
|
|
6613
|
+
"description": "Handles the change event on the radio element.\nThis will toggle the state of the radio element.\nDispatches the change event."
|
|
6541
6614
|
},
|
|
6542
6615
|
{
|
|
6543
6616
|
"kind": "method",
|
|
6544
|
-
"name": "
|
|
6545
|
-
"privacy": "private",
|
|
6617
|
+
"name": "setDisabled",
|
|
6546
6618
|
"return": {
|
|
6547
6619
|
"type": {
|
|
6548
6620
|
"text": "void"
|
|
@@ -6550,19 +6622,17 @@
|
|
|
6550
6622
|
},
|
|
6551
6623
|
"parameters": [
|
|
6552
6624
|
{
|
|
6553
|
-
"name": "
|
|
6625
|
+
"name": "disabled",
|
|
6554
6626
|
"type": {
|
|
6555
|
-
"text": "
|
|
6556
|
-
}
|
|
6557
|
-
"description": "The keyboard event."
|
|
6627
|
+
"text": "boolean"
|
|
6628
|
+
}
|
|
6558
6629
|
}
|
|
6559
|
-
]
|
|
6560
|
-
"description": "Handles the keydown event on the checkbox.\nWhen the user presses Enter, the form is submitted."
|
|
6630
|
+
]
|
|
6561
6631
|
},
|
|
6562
6632
|
{
|
|
6563
6633
|
"kind": "method",
|
|
6564
|
-
"name": "
|
|
6565
|
-
"privacy": "
|
|
6634
|
+
"name": "updateCardRadio",
|
|
6635
|
+
"privacy": "private",
|
|
6566
6636
|
"return": {
|
|
6567
6637
|
"type": {
|
|
6568
6638
|
"text": "void"
|
|
@@ -6570,352 +6640,312 @@
|
|
|
6570
6640
|
},
|
|
6571
6641
|
"parameters": [
|
|
6572
6642
|
{
|
|
6573
|
-
"name": "
|
|
6643
|
+
"name": "cards",
|
|
6574
6644
|
"type": {
|
|
6575
|
-
"text": "
|
|
6645
|
+
"text": "CardRadio[]"
|
|
6646
|
+
}
|
|
6647
|
+
},
|
|
6648
|
+
{
|
|
6649
|
+
"name": "index",
|
|
6650
|
+
"type": {
|
|
6651
|
+
"text": "number"
|
|
6576
6652
|
}
|
|
6577
6653
|
}
|
|
6578
|
-
]
|
|
6579
|
-
"description": "Toggles the state of the checkbox element.\nand dispatch the new change event."
|
|
6580
|
-
},
|
|
6581
|
-
{
|
|
6582
|
-
"kind": "field",
|
|
6583
|
-
"name": "renderLabelAndHelperText",
|
|
6584
|
-
"privacy": "private"
|
|
6585
|
-
},
|
|
6586
|
-
{
|
|
6587
|
-
"kind": "field",
|
|
6588
|
-
"name": "name",
|
|
6589
|
-
"type": {
|
|
6590
|
-
"text": "string"
|
|
6591
|
-
},
|
|
6592
|
-
"default": "''",
|
|
6593
|
-
"description": "Indicates the name of the component group.\nThey are used to group elements in a form together.",
|
|
6594
|
-
"attribute": "name",
|
|
6595
|
-
"reflects": true,
|
|
6596
|
-
"inheritedFrom": {
|
|
6597
|
-
"name": "FormInternalsMixin",
|
|
6598
|
-
"module": "utils/mixins/FormInternalsMixin.js"
|
|
6599
|
-
}
|
|
6600
|
-
},
|
|
6601
|
-
{
|
|
6602
|
-
"kind": "field",
|
|
6603
|
-
"name": "value",
|
|
6604
|
-
"type": {
|
|
6605
|
-
"text": "string"
|
|
6606
|
-
},
|
|
6607
|
-
"default": "''",
|
|
6608
|
-
"description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
|
|
6609
|
-
"attribute": "value",
|
|
6610
|
-
"reflects": true,
|
|
6611
|
-
"inheritedFrom": {
|
|
6612
|
-
"name": "FormInternalsMixin",
|
|
6613
|
-
"module": "utils/mixins/FormInternalsMixin.js"
|
|
6614
|
-
}
|
|
6615
|
-
},
|
|
6616
|
-
{
|
|
6617
|
-
"kind": "field",
|
|
6618
|
-
"name": "validationMessage",
|
|
6619
|
-
"type": {
|
|
6620
|
-
"text": "string | undefined"
|
|
6621
|
-
},
|
|
6622
|
-
"description": "Custom validation message that will override the default message and displayed when the input is invalid.",
|
|
6623
|
-
"attribute": "validation-message",
|
|
6624
|
-
"reflects": true,
|
|
6625
|
-
"inheritedFrom": {
|
|
6626
|
-
"name": "FormInternalsMixin",
|
|
6627
|
-
"module": "utils/mixins/FormInternalsMixin.js"
|
|
6628
|
-
}
|
|
6629
|
-
},
|
|
6630
|
-
{
|
|
6631
|
-
"kind": "field",
|
|
6632
|
-
"name": "validity",
|
|
6633
|
-
"type": {
|
|
6634
|
-
"text": "ValidityState"
|
|
6635
|
-
},
|
|
6636
|
-
"readonly": true,
|
|
6637
|
-
"inheritedFrom": {
|
|
6638
|
-
"name": "FormInternalsMixin",
|
|
6639
|
-
"module": "utils/mixins/FormInternalsMixin.js"
|
|
6640
|
-
}
|
|
6654
|
+
]
|
|
6641
6655
|
},
|
|
6642
6656
|
{
|
|
6643
|
-
"kind": "
|
|
6644
|
-
"name": "
|
|
6645
|
-
"
|
|
6646
|
-
"
|
|
6647
|
-
|
|
6648
|
-
|
|
6649
|
-
|
|
6657
|
+
"kind": "method",
|
|
6658
|
+
"name": "toggleOnEnter",
|
|
6659
|
+
"privacy": "private",
|
|
6660
|
+
"parameters": [
|
|
6661
|
+
{
|
|
6662
|
+
"name": "event",
|
|
6663
|
+
"type": {
|
|
6664
|
+
"text": "KeyboardEvent"
|
|
6665
|
+
},
|
|
6666
|
+
"description": "The keyboard event"
|
|
6667
|
+
}
|
|
6668
|
+
],
|
|
6669
|
+
"description": "Toggles the checked state when enter key is used"
|
|
6650
6670
|
},
|
|
6651
6671
|
{
|
|
6652
6672
|
"kind": "method",
|
|
6653
|
-
"name": "
|
|
6654
|
-
"
|
|
6655
|
-
"
|
|
6656
|
-
|
|
6657
|
-
"
|
|
6673
|
+
"name": "toggleOnSpace",
|
|
6674
|
+
"privacy": "private",
|
|
6675
|
+
"parameters": [
|
|
6676
|
+
{
|
|
6677
|
+
"name": "event",
|
|
6678
|
+
"type": {
|
|
6679
|
+
"text": "KeyboardEvent"
|
|
6680
|
+
},
|
|
6681
|
+
"description": "The keyboard event"
|
|
6658
6682
|
}
|
|
6659
|
-
|
|
6660
|
-
"
|
|
6661
|
-
"name": "FormInternalsMixin",
|
|
6662
|
-
"module": "utils/mixins/FormInternalsMixin.js"
|
|
6663
|
-
}
|
|
6683
|
+
],
|
|
6684
|
+
"description": "Toggles the checked state when space key is used"
|
|
6664
6685
|
},
|
|
6665
6686
|
{
|
|
6666
6687
|
"kind": "method",
|
|
6667
|
-
"name": "
|
|
6688
|
+
"name": "renderHeader",
|
|
6689
|
+
"privacy": "protected",
|
|
6690
|
+
"description": "Renders the header of the card",
|
|
6668
6691
|
"return": {
|
|
6669
6692
|
"type": {
|
|
6670
|
-
"text": "
|
|
6693
|
+
"text": ""
|
|
6671
6694
|
}
|
|
6672
6695
|
},
|
|
6673
6696
|
"inheritedFrom": {
|
|
6674
|
-
"name": "
|
|
6675
|
-
"module": "
|
|
6697
|
+
"name": "Card",
|
|
6698
|
+
"module": "components/card/card.component.js"
|
|
6676
6699
|
}
|
|
6677
6700
|
},
|
|
6678
6701
|
{
|
|
6679
|
-
"kind": "
|
|
6680
|
-
"name": "
|
|
6702
|
+
"kind": "field",
|
|
6703
|
+
"name": "disabled",
|
|
6704
|
+
"type": {
|
|
6705
|
+
"text": "boolean | undefined"
|
|
6706
|
+
},
|
|
6707
|
+
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
|
6708
|
+
"default": "undefined",
|
|
6709
|
+
"attribute": "disabled",
|
|
6710
|
+
"reflects": true,
|
|
6681
6711
|
"inheritedFrom": {
|
|
6682
|
-
"name": "
|
|
6683
|
-
"module": "utils/mixins/
|
|
6712
|
+
"name": "DisabledMixin",
|
|
6713
|
+
"module": "utils/mixins/DisabledMixin.js"
|
|
6684
6714
|
}
|
|
6685
6715
|
},
|
|
6686
6716
|
{
|
|
6687
6717
|
"kind": "field",
|
|
6688
|
-
"name": "
|
|
6718
|
+
"name": "tabIndex",
|
|
6689
6719
|
"type": {
|
|
6690
|
-
"text": "
|
|
6720
|
+
"text": "number"
|
|
6691
6721
|
},
|
|
6692
|
-
"default": "
|
|
6693
|
-
"description": "
|
|
6694
|
-
"attribute": "
|
|
6722
|
+
"default": "0",
|
|
6723
|
+
"description": "This property specifies the tab order of the element.",
|
|
6724
|
+
"attribute": "tabIndex",
|
|
6695
6725
|
"reflects": true,
|
|
6696
6726
|
"inheritedFrom": {
|
|
6697
|
-
"name": "
|
|
6698
|
-
"module": "utils/mixins/
|
|
6727
|
+
"name": "TabIndexMixin",
|
|
6728
|
+
"module": "utils/mixins/TabIndexMixin.js"
|
|
6699
6729
|
}
|
|
6700
6730
|
},
|
|
6701
6731
|
{
|
|
6702
6732
|
"kind": "field",
|
|
6703
|
-
"name": "
|
|
6733
|
+
"name": "cardTitle",
|
|
6704
6734
|
"type": {
|
|
6705
|
-
"text": "
|
|
6735
|
+
"text": "string"
|
|
6706
6736
|
},
|
|
6707
|
-
"
|
|
6708
|
-
"
|
|
6709
|
-
"attribute": "
|
|
6737
|
+
"default": "''",
|
|
6738
|
+
"description": "The title of the card - part of header section",
|
|
6739
|
+
"attribute": "card-title",
|
|
6710
6740
|
"reflects": true,
|
|
6711
6741
|
"inheritedFrom": {
|
|
6712
|
-
"name": "
|
|
6713
|
-
"module": "
|
|
6742
|
+
"name": "Card",
|
|
6743
|
+
"module": "components/card/card.component.js"
|
|
6714
6744
|
}
|
|
6715
6745
|
},
|
|
6716
6746
|
{
|
|
6717
6747
|
"kind": "field",
|
|
6718
|
-
"name": "
|
|
6748
|
+
"name": "subtitle",
|
|
6719
6749
|
"type": {
|
|
6720
|
-
"text": "string
|
|
6750
|
+
"text": "string"
|
|
6721
6751
|
},
|
|
6722
|
-
"
|
|
6723
|
-
"
|
|
6752
|
+
"default": "''",
|
|
6753
|
+
"description": "The subtitle of the card - part of header section",
|
|
6754
|
+
"attribute": "subtitle",
|
|
6724
6755
|
"reflects": true,
|
|
6725
6756
|
"inheritedFrom": {
|
|
6726
|
-
"name": "
|
|
6727
|
-
"module": "components/
|
|
6757
|
+
"name": "Card",
|
|
6758
|
+
"module": "components/card/card.component.js"
|
|
6728
6759
|
}
|
|
6729
6760
|
},
|
|
6730
6761
|
{
|
|
6731
6762
|
"kind": "field",
|
|
6732
|
-
"name": "
|
|
6763
|
+
"name": "imageSrc",
|
|
6733
6764
|
"type": {
|
|
6734
|
-
"text": "
|
|
6765
|
+
"text": "string"
|
|
6735
6766
|
},
|
|
6736
|
-
"default": "
|
|
6737
|
-
"description": "The
|
|
6738
|
-
"attribute": "
|
|
6767
|
+
"default": "''",
|
|
6768
|
+
"description": "The image source URL to render on the card",
|
|
6769
|
+
"attribute": "image-src",
|
|
6739
6770
|
"reflects": true,
|
|
6740
6771
|
"inheritedFrom": {
|
|
6741
|
-
"name": "
|
|
6742
|
-
"module": "components/
|
|
6772
|
+
"name": "Card",
|
|
6773
|
+
"module": "components/card/card.component.js"
|
|
6743
6774
|
}
|
|
6744
6775
|
},
|
|
6745
6776
|
{
|
|
6746
6777
|
"kind": "field",
|
|
6747
|
-
"name": "
|
|
6778
|
+
"name": "imageAlt",
|
|
6748
6779
|
"type": {
|
|
6749
6780
|
"text": "string"
|
|
6750
6781
|
},
|
|
6751
6782
|
"default": "''",
|
|
6752
|
-
"description": "The
|
|
6753
|
-
"attribute": "
|
|
6783
|
+
"description": "The image alt for accessibility support",
|
|
6784
|
+
"attribute": "image-alt",
|
|
6785
|
+
"reflects": true,
|
|
6754
6786
|
"inheritedFrom": {
|
|
6755
|
-
"name": "
|
|
6756
|
-
"module": "components/
|
|
6787
|
+
"name": "Card",
|
|
6788
|
+
"module": "components/card/card.component.js"
|
|
6757
6789
|
}
|
|
6758
6790
|
},
|
|
6759
6791
|
{
|
|
6760
6792
|
"kind": "field",
|
|
6761
|
-
"name": "
|
|
6793
|
+
"name": "variant",
|
|
6762
6794
|
"type": {
|
|
6763
|
-
"text": "
|
|
6795
|
+
"text": "CardVariant"
|
|
6764
6796
|
},
|
|
6765
|
-
"description": "The
|
|
6766
|
-
"
|
|
6797
|
+
"description": "The variant of the card. It can either be set to 'border' or 'ghost'",
|
|
6798
|
+
"default": "'border'",
|
|
6799
|
+
"attribute": "variant",
|
|
6767
6800
|
"reflects": true,
|
|
6768
6801
|
"inheritedFrom": {
|
|
6769
|
-
"name": "
|
|
6770
|
-
"module": "components/
|
|
6802
|
+
"name": "Card",
|
|
6803
|
+
"module": "components/card/card.component.js"
|
|
6771
6804
|
}
|
|
6772
6805
|
},
|
|
6773
6806
|
{
|
|
6774
6807
|
"kind": "field",
|
|
6775
|
-
"name": "
|
|
6808
|
+
"name": "orientation",
|
|
6776
6809
|
"type": {
|
|
6777
|
-
"text": "
|
|
6810
|
+
"text": "CardOrientation"
|
|
6778
6811
|
},
|
|
6779
|
-
"description": "The
|
|
6780
|
-
"
|
|
6812
|
+
"description": "The orientation of the card. It can either be set to 'vertical' or 'horizontal'",
|
|
6813
|
+
"default": "'vertical'",
|
|
6814
|
+
"attribute": "orientation",
|
|
6781
6815
|
"reflects": true,
|
|
6782
6816
|
"inheritedFrom": {
|
|
6783
|
-
"name": "
|
|
6784
|
-
"module": "components/
|
|
6817
|
+
"name": "Card",
|
|
6818
|
+
"module": "components/card/card.component.js"
|
|
6785
6819
|
}
|
|
6786
6820
|
},
|
|
6787
6821
|
{
|
|
6788
6822
|
"kind": "field",
|
|
6789
|
-
"name": "
|
|
6823
|
+
"name": "titleTagName",
|
|
6790
6824
|
"type": {
|
|
6791
|
-
"text": "
|
|
6825
|
+
"text": "TagNameType"
|
|
6792
6826
|
},
|
|
6793
|
-
"description": "The
|
|
6794
|
-
"
|
|
6827
|
+
"description": "The tag name for the card title. It supports all the types that `msc-text` supports",
|
|
6828
|
+
"default": "'span'",
|
|
6829
|
+
"attribute": "title-tag-name",
|
|
6795
6830
|
"reflects": true,
|
|
6796
6831
|
"inheritedFrom": {
|
|
6797
|
-
"name": "
|
|
6798
|
-
"module": "components/
|
|
6832
|
+
"name": "Card",
|
|
6833
|
+
"module": "components/card/card.component.js"
|
|
6799
6834
|
}
|
|
6800
6835
|
},
|
|
6801
6836
|
{
|
|
6802
6837
|
"kind": "field",
|
|
6803
|
-
"name": "
|
|
6838
|
+
"name": "subtitleTagName",
|
|
6804
6839
|
"type": {
|
|
6805
|
-
"text": "
|
|
6840
|
+
"text": "TagNameType"
|
|
6806
6841
|
},
|
|
6807
|
-
"description": "The
|
|
6808
|
-
"default": "'
|
|
6809
|
-
"attribute": "
|
|
6842
|
+
"description": "The tag name for the subtitle. It supports all the types that `msc-text` supports",
|
|
6843
|
+
"default": "'span'",
|
|
6844
|
+
"attribute": "subtitle-tag-name",
|
|
6810
6845
|
"reflects": true,
|
|
6811
6846
|
"inheritedFrom": {
|
|
6812
|
-
"name": "
|
|
6813
|
-
"module": "components/
|
|
6847
|
+
"name": "Card",
|
|
6848
|
+
"module": "components/card/card.component.js"
|
|
6814
6849
|
}
|
|
6815
6850
|
},
|
|
6816
6851
|
{
|
|
6817
6852
|
"kind": "field",
|
|
6818
|
-
"name": "
|
|
6853
|
+
"name": "iconName",
|
|
6819
6854
|
"type": {
|
|
6820
|
-
"text": "
|
|
6855
|
+
"text": "IconNames | undefined"
|
|
6821
6856
|
},
|
|
6822
|
-
"description": "
|
|
6823
|
-
"attribute": "
|
|
6857
|
+
"description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
|
|
6858
|
+
"attribute": "icon-name",
|
|
6824
6859
|
"reflects": true,
|
|
6825
6860
|
"inheritedFrom": {
|
|
6826
|
-
"name": "
|
|
6827
|
-
"module": "components/
|
|
6828
|
-
}
|
|
6829
|
-
},
|
|
6830
|
-
{
|
|
6831
|
-
"kind": "method",
|
|
6832
|
-
"name": "renderLabelElement",
|
|
6833
|
-
"privacy": "protected",
|
|
6834
|
-
"description": "creates the label element when the label property is set.\nid is used to link the label with the input field.",
|
|
6835
|
-
"return": {
|
|
6836
|
-
"type": {
|
|
6837
|
-
"text": ""
|
|
6838
|
-
}
|
|
6839
|
-
},
|
|
6840
|
-
"inheritedFrom": {
|
|
6841
|
-
"name": "FormfieldWrapper",
|
|
6842
|
-
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
|
6861
|
+
"name": "Card",
|
|
6862
|
+
"module": "components/card/card.component.js"
|
|
6843
6863
|
}
|
|
6844
6864
|
},
|
|
6845
6865
|
{
|
|
6846
6866
|
"kind": "method",
|
|
6847
|
-
"name": "
|
|
6867
|
+
"name": "renderImage",
|
|
6848
6868
|
"privacy": "protected",
|
|
6849
|
-
"description": "
|
|
6869
|
+
"description": "Renders the image on the card if image source is provided",
|
|
6850
6870
|
"return": {
|
|
6851
6871
|
"type": {
|
|
6852
6872
|
"text": ""
|
|
6853
6873
|
}
|
|
6854
6874
|
},
|
|
6855
6875
|
"inheritedFrom": {
|
|
6856
|
-
"name": "
|
|
6857
|
-
"module": "components/
|
|
6876
|
+
"name": "Card",
|
|
6877
|
+
"module": "components/card/card.component.js"
|
|
6858
6878
|
}
|
|
6859
6879
|
},
|
|
6860
6880
|
{
|
|
6861
6881
|
"kind": "method",
|
|
6862
|
-
"name": "
|
|
6882
|
+
"name": "renderIcon",
|
|
6863
6883
|
"privacy": "protected",
|
|
6864
|
-
"description": "
|
|
6884
|
+
"description": "Renders the icon on the card if icon name is provided",
|
|
6865
6885
|
"return": {
|
|
6866
6886
|
"type": {
|
|
6867
6887
|
"text": ""
|
|
6868
6888
|
}
|
|
6869
6889
|
},
|
|
6870
6890
|
"inheritedFrom": {
|
|
6871
|
-
"name": "
|
|
6872
|
-
"module": "components/
|
|
6891
|
+
"name": "Card",
|
|
6892
|
+
"module": "components/card/card.component.js"
|
|
6873
6893
|
}
|
|
6874
6894
|
},
|
|
6875
6895
|
{
|
|
6876
6896
|
"kind": "method",
|
|
6877
|
-
"name": "
|
|
6897
|
+
"name": "renderTitle",
|
|
6878
6898
|
"privacy": "protected",
|
|
6879
|
-
"description": "
|
|
6899
|
+
"description": "Renders the title and subtitle on the card",
|
|
6880
6900
|
"return": {
|
|
6881
6901
|
"type": {
|
|
6882
6902
|
"text": ""
|
|
6883
6903
|
}
|
|
6884
6904
|
},
|
|
6885
6905
|
"inheritedFrom": {
|
|
6886
|
-
"name": "
|
|
6887
|
-
"module": "components/
|
|
6906
|
+
"name": "Card",
|
|
6907
|
+
"module": "components/card/card.component.js"
|
|
6888
6908
|
}
|
|
6889
6909
|
},
|
|
6890
6910
|
{
|
|
6891
6911
|
"kind": "method",
|
|
6892
|
-
"name": "
|
|
6912
|
+
"name": "renderFooter",
|
|
6893
6913
|
"privacy": "protected",
|
|
6894
|
-
"description": "
|
|
6914
|
+
"description": "Renders the footer of the card if footer-link,\nfooter-button-primary, or footer-button-secondary slots are provided",
|
|
6895
6915
|
"return": {
|
|
6896
6916
|
"type": {
|
|
6897
6917
|
"text": ""
|
|
6898
6918
|
}
|
|
6899
6919
|
},
|
|
6900
6920
|
"inheritedFrom": {
|
|
6901
|
-
"name": "
|
|
6902
|
-
"module": "components/
|
|
6921
|
+
"name": "Card",
|
|
6922
|
+
"module": "components/card/card.component.js"
|
|
6903
6923
|
}
|
|
6904
6924
|
}
|
|
6905
6925
|
],
|
|
6906
6926
|
"events": [
|
|
6907
6927
|
{
|
|
6908
|
-
"
|
|
6909
|
-
|
|
6910
|
-
|
|
6928
|
+
"description": "(React: onClick) Event that gets dispatched when the card is clicked. It toggles the checked state.",
|
|
6929
|
+
"name": "click",
|
|
6930
|
+
"reactName": "onClick"
|
|
6911
6931
|
},
|
|
6912
6932
|
{
|
|
6913
|
-
"description": "(React:
|
|
6933
|
+
"description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the card. It toggles the checked state when enter key is used.",
|
|
6934
|
+
"name": "keydown",
|
|
6935
|
+
"reactName": "onKeyDown"
|
|
6936
|
+
},
|
|
6937
|
+
{
|
|
6938
|
+
"description": "(React: onKeyUp) This event is dispatched when a key is released on the card. It toggles the checked state when space key is used.",
|
|
6939
|
+
"name": "keyup",
|
|
6940
|
+
"reactName": "onKeyUp"
|
|
6941
|
+
},
|
|
6942
|
+
{
|
|
6943
|
+
"description": "(React: onChange) Event that gets dispatched when the card state changes.",
|
|
6914
6944
|
"name": "change",
|
|
6915
6945
|
"reactName": "onChange"
|
|
6916
6946
|
},
|
|
6917
6947
|
{
|
|
6918
|
-
"description": "(React: onFocus) Event that gets dispatched when the
|
|
6948
|
+
"description": "(React: onFocus) Event that gets dispatched when the card receives focus.",
|
|
6919
6949
|
"name": "focus",
|
|
6920
6950
|
"reactName": "onFocus"
|
|
6921
6951
|
}
|
|
@@ -6927,207 +6957,177 @@
|
|
|
6927
6957
|
"text": "boolean"
|
|
6928
6958
|
},
|
|
6929
6959
|
"default": "false",
|
|
6930
|
-
"description": "
|
|
6960
|
+
"description": "The checked state of the card",
|
|
6931
6961
|
"fieldName": "checked"
|
|
6932
6962
|
},
|
|
6933
|
-
{
|
|
6934
|
-
"name": "indeterminate",
|
|
6935
|
-
"type": {
|
|
6936
|
-
"text": "boolean"
|
|
6937
|
-
},
|
|
6938
|
-
"default": "false",
|
|
6939
|
-
"description": "This property is used to determine the parent checkbox in a nested checkbox group.\nIf any one of the children is unselected, then the parent checkbox will be indeterminate.\nIf all children are either selected or unselected, then the parent checkbox will not be indeterminate.",
|
|
6940
|
-
"fieldName": "indeterminate"
|
|
6941
|
-
},
|
|
6942
|
-
{
|
|
6943
|
-
"name": "autofocus",
|
|
6944
|
-
"type": {
|
|
6945
|
-
"text": "boolean"
|
|
6946
|
-
},
|
|
6947
|
-
"default": "false",
|
|
6948
|
-
"description": "Automatically focus on the element when the page loads.\n[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/autofocus)",
|
|
6949
|
-
"fieldName": "autofocus"
|
|
6950
|
-
},
|
|
6951
6963
|
{
|
|
6952
6964
|
"name": "name",
|
|
6953
6965
|
"type": {
|
|
6954
6966
|
"text": "string"
|
|
6955
6967
|
},
|
|
6956
6968
|
"default": "''",
|
|
6957
|
-
"description": "
|
|
6958
|
-
"fieldName": "name"
|
|
6959
|
-
"inheritedFrom": {
|
|
6960
|
-
"name": "FormInternalsMixin",
|
|
6961
|
-
"module": "src/utils/mixins/FormInternalsMixin.ts"
|
|
6962
|
-
}
|
|
6963
|
-
},
|
|
6964
|
-
{
|
|
6965
|
-
"name": "value",
|
|
6966
|
-
"type": {
|
|
6967
|
-
"text": "string"
|
|
6968
|
-
},
|
|
6969
|
-
"default": "''",
|
|
6970
|
-
"description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
|
|
6971
|
-
"fieldName": "value",
|
|
6972
|
-
"inheritedFrom": {
|
|
6973
|
-
"name": "FormInternalsMixin",
|
|
6974
|
-
"module": "src/utils/mixins/FormInternalsMixin.ts"
|
|
6975
|
-
}
|
|
6969
|
+
"description": "The name of the radio.",
|
|
6970
|
+
"fieldName": "name"
|
|
6976
6971
|
},
|
|
6977
6972
|
{
|
|
6978
|
-
"name": "
|
|
6973
|
+
"name": "disabled",
|
|
6979
6974
|
"type": {
|
|
6980
|
-
"text": "
|
|
6975
|
+
"text": "boolean | undefined"
|
|
6981
6976
|
},
|
|
6982
|
-
"description": "
|
|
6983
|
-
"
|
|
6977
|
+
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
|
6978
|
+
"default": "undefined",
|
|
6979
|
+
"fieldName": "disabled",
|
|
6984
6980
|
"inheritedFrom": {
|
|
6985
|
-
"name": "
|
|
6986
|
-
"module": "src/utils/mixins/
|
|
6981
|
+
"name": "DisabledMixin",
|
|
6982
|
+
"module": "src/utils/mixins/DisabledMixin.ts"
|
|
6987
6983
|
}
|
|
6988
6984
|
},
|
|
6989
6985
|
{
|
|
6990
|
-
"name": "
|
|
6986
|
+
"name": "tabIndex",
|
|
6991
6987
|
"type": {
|
|
6992
|
-
"text": "
|
|
6988
|
+
"text": "number"
|
|
6993
6989
|
},
|
|
6994
|
-
"default": "
|
|
6995
|
-
"description": "
|
|
6996
|
-
"fieldName": "
|
|
6990
|
+
"default": "0",
|
|
6991
|
+
"description": "This property specifies the tab order of the element.",
|
|
6992
|
+
"fieldName": "tabIndex",
|
|
6997
6993
|
"inheritedFrom": {
|
|
6998
|
-
"name": "
|
|
6999
|
-
"module": "src/utils/mixins/
|
|
6994
|
+
"name": "TabIndexMixin",
|
|
6995
|
+
"module": "src/utils/mixins/TabIndexMixin.ts"
|
|
7000
6996
|
}
|
|
7001
6997
|
},
|
|
7002
6998
|
{
|
|
7003
|
-
"name": "
|
|
6999
|
+
"name": "card-title",
|
|
7004
7000
|
"type": {
|
|
7005
|
-
"text": "
|
|
7001
|
+
"text": "string"
|
|
7006
7002
|
},
|
|
7007
|
-
"
|
|
7008
|
-
"
|
|
7009
|
-
"fieldName": "
|
|
7003
|
+
"default": "''",
|
|
7004
|
+
"description": "The title of the card - part of header section",
|
|
7005
|
+
"fieldName": "cardTitle",
|
|
7010
7006
|
"inheritedFrom": {
|
|
7011
|
-
"name": "
|
|
7012
|
-
"module": "src/
|
|
7007
|
+
"name": "Card",
|
|
7008
|
+
"module": "src/components/card/card.component.ts"
|
|
7013
7009
|
}
|
|
7014
7010
|
},
|
|
7015
7011
|
{
|
|
7016
|
-
"name": "
|
|
7012
|
+
"name": "subtitle",
|
|
7017
7013
|
"type": {
|
|
7018
|
-
"text": "string
|
|
7014
|
+
"text": "string"
|
|
7019
7015
|
},
|
|
7020
|
-
"
|
|
7021
|
-
"
|
|
7016
|
+
"default": "''",
|
|
7017
|
+
"description": "The subtitle of the card - part of header section",
|
|
7018
|
+
"fieldName": "subtitle",
|
|
7022
7019
|
"inheritedFrom": {
|
|
7023
|
-
"name": "
|
|
7024
|
-
"module": "src/components/
|
|
7020
|
+
"name": "Card",
|
|
7021
|
+
"module": "src/components/card/card.component.ts"
|
|
7025
7022
|
}
|
|
7026
7023
|
},
|
|
7027
7024
|
{
|
|
7028
|
-
"name": "
|
|
7025
|
+
"name": "image-src",
|
|
7029
7026
|
"type": {
|
|
7030
|
-
"text": "
|
|
7027
|
+
"text": "string"
|
|
7031
7028
|
},
|
|
7032
|
-
"default": "
|
|
7033
|
-
"description": "The
|
|
7034
|
-
"fieldName": "
|
|
7029
|
+
"default": "''",
|
|
7030
|
+
"description": "The image source URL to render on the card",
|
|
7031
|
+
"fieldName": "imageSrc",
|
|
7035
7032
|
"inheritedFrom": {
|
|
7036
|
-
"name": "
|
|
7037
|
-
"module": "src/components/
|
|
7033
|
+
"name": "Card",
|
|
7034
|
+
"module": "src/components/card/card.component.ts"
|
|
7038
7035
|
}
|
|
7039
7036
|
},
|
|
7040
7037
|
{
|
|
7041
|
-
"name": "
|
|
7038
|
+
"name": "image-alt",
|
|
7042
7039
|
"type": {
|
|
7043
7040
|
"text": "string"
|
|
7044
7041
|
},
|
|
7045
7042
|
"default": "''",
|
|
7046
|
-
"description": "The
|
|
7047
|
-
"fieldName": "
|
|
7043
|
+
"description": "The image alt for accessibility support",
|
|
7044
|
+
"fieldName": "imageAlt",
|
|
7048
7045
|
"inheritedFrom": {
|
|
7049
|
-
"name": "
|
|
7050
|
-
"module": "src/components/
|
|
7046
|
+
"name": "Card",
|
|
7047
|
+
"module": "src/components/card/card.component.ts"
|
|
7051
7048
|
}
|
|
7052
7049
|
},
|
|
7053
7050
|
{
|
|
7054
|
-
"name": "
|
|
7051
|
+
"name": "variant",
|
|
7055
7052
|
"type": {
|
|
7056
|
-
"text": "
|
|
7053
|
+
"text": "CardVariant"
|
|
7057
7054
|
},
|
|
7058
|
-
"description": "The
|
|
7059
|
-
"
|
|
7055
|
+
"description": "The variant of the card. It can either be set to 'border' or 'ghost'",
|
|
7056
|
+
"default": "'border'",
|
|
7057
|
+
"fieldName": "variant",
|
|
7060
7058
|
"inheritedFrom": {
|
|
7061
|
-
"name": "
|
|
7062
|
-
"module": "src/components/
|
|
7059
|
+
"name": "Card",
|
|
7060
|
+
"module": "src/components/card/card.component.ts"
|
|
7063
7061
|
}
|
|
7064
7062
|
},
|
|
7065
7063
|
{
|
|
7066
|
-
"name": "
|
|
7064
|
+
"name": "orientation",
|
|
7067
7065
|
"type": {
|
|
7068
|
-
"text": "
|
|
7066
|
+
"text": "CardOrientation"
|
|
7069
7067
|
},
|
|
7070
|
-
"description": "The
|
|
7071
|
-
"
|
|
7068
|
+
"description": "The orientation of the card. It can either be set to 'vertical' or 'horizontal'",
|
|
7069
|
+
"default": "'vertical'",
|
|
7070
|
+
"fieldName": "orientation",
|
|
7072
7071
|
"inheritedFrom": {
|
|
7073
|
-
"name": "
|
|
7074
|
-
"module": "src/components/
|
|
7072
|
+
"name": "Card",
|
|
7073
|
+
"module": "src/components/card/card.component.ts"
|
|
7075
7074
|
}
|
|
7076
7075
|
},
|
|
7077
7076
|
{
|
|
7078
|
-
"name": "
|
|
7077
|
+
"name": "title-tag-name",
|
|
7079
7078
|
"type": {
|
|
7080
|
-
"text": "
|
|
7079
|
+
"text": "TagNameType"
|
|
7081
7080
|
},
|
|
7082
|
-
"description": "The
|
|
7083
|
-
"
|
|
7081
|
+
"description": "The tag name for the card title. It supports all the types that `msc-text` supports",
|
|
7082
|
+
"default": "'span'",
|
|
7083
|
+
"fieldName": "titleTagName",
|
|
7084
7084
|
"inheritedFrom": {
|
|
7085
|
-
"name": "
|
|
7086
|
-
"module": "src/components/
|
|
7085
|
+
"name": "Card",
|
|
7086
|
+
"module": "src/components/card/card.component.ts"
|
|
7087
7087
|
}
|
|
7088
7088
|
},
|
|
7089
7089
|
{
|
|
7090
|
-
"name": "
|
|
7090
|
+
"name": "subtitle-tag-name",
|
|
7091
7091
|
"type": {
|
|
7092
|
-
"text": "
|
|
7092
|
+
"text": "TagNameType"
|
|
7093
7093
|
},
|
|
7094
|
-
"description": "The
|
|
7095
|
-
"default": "'
|
|
7096
|
-
"fieldName": "
|
|
7094
|
+
"description": "The tag name for the subtitle. It supports all the types that `msc-text` supports",
|
|
7095
|
+
"default": "'span'",
|
|
7096
|
+
"fieldName": "subtitleTagName",
|
|
7097
7097
|
"inheritedFrom": {
|
|
7098
|
-
"name": "
|
|
7099
|
-
"module": "src/components/
|
|
7098
|
+
"name": "Card",
|
|
7099
|
+
"module": "src/components/card/card.component.ts"
|
|
7100
7100
|
}
|
|
7101
7101
|
},
|
|
7102
7102
|
{
|
|
7103
|
-
"name": "
|
|
7103
|
+
"name": "icon-name",
|
|
7104
7104
|
"type": {
|
|
7105
|
-
"text": "
|
|
7105
|
+
"text": "IconNames | undefined"
|
|
7106
7106
|
},
|
|
7107
|
-
"description": "
|
|
7108
|
-
"fieldName": "
|
|
7107
|
+
"description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
|
|
7108
|
+
"fieldName": "iconName",
|
|
7109
7109
|
"inheritedFrom": {
|
|
7110
|
-
"name": "
|
|
7111
|
-
"module": "src/components/
|
|
7110
|
+
"name": "Card",
|
|
7111
|
+
"module": "src/components/card/card.component.ts"
|
|
7112
7112
|
}
|
|
7113
7113
|
}
|
|
7114
7114
|
],
|
|
7115
7115
|
"mixins": [
|
|
7116
7116
|
{
|
|
7117
|
-
"name": "
|
|
7118
|
-
"module": "/src/utils/mixins/
|
|
7117
|
+
"name": "DisabledMixin",
|
|
7118
|
+
"module": "/src/utils/mixins/DisabledMixin"
|
|
7119
7119
|
},
|
|
7120
7120
|
{
|
|
7121
|
-
"name": "
|
|
7122
|
-
"module": "/src/utils/mixins/
|
|
7121
|
+
"name": "TabIndexMixin",
|
|
7122
|
+
"module": "/src/utils/mixins/TabIndexMixin"
|
|
7123
7123
|
}
|
|
7124
7124
|
],
|
|
7125
7125
|
"superclass": {
|
|
7126
|
-
"name": "
|
|
7127
|
-
"module": "/src/components/
|
|
7126
|
+
"name": "Card",
|
|
7127
|
+
"module": "/src/components/card/card.component"
|
|
7128
7128
|
},
|
|
7129
|
-
"tagName": "mdc-
|
|
7130
|
-
"jsDoc": "/**\n *
|
|
7129
|
+
"tagName": "mdc-cardradio",
|
|
7130
|
+
"jsDoc": "/**\n * cardradio component extends `mdc-card` and supports radio selection interaction addtionally.\n *\n * While using this component within a form or group of cards, make sure cards are in a role = \"radio-group\".\n * This card would have events for selected and unselected (similar to radio)\n *\n * **Note**: This is a single selection card i.e. interacting anywhere on the card would toggle the checked state.\n * Make sure to pass only non-interactable elements within the slots.\n *\n * Make sure to pass the `card-title` mandatorily for this card.\n *\n * @tagname mdc-cardradio\n *\n * @dependency mdc-icon\n * @dependency mdc-staticradio\n * @dependency mdc-text\n *\n * @slot before-body - This slot is for passing the content before the body\n * @slot body - This slot is for passing the text content for the card\n * @slot after-body - This slot is for passing the content after the body\n *\n * @event click - (React: onClick) Event that gets dispatched when the card is clicked. It toggles the checked state.\n * @event keydown - (React: onKeyDown) This event is dispatched when a key is pressed down on the card.\n * It toggles the checked state when enter key is used.\n * @event keyup - (React: onKeyUp) This event is dispatched when a key is released on the card.\n * It toggles the checked state when space key is used.\n * @event change - (React: onChange) Event that gets dispatched when the card state changes.\n * @event focus - (React: onFocus) Event that gets dispatched when the card receives focus.\n *\n */",
|
|
7131
7131
|
"customElement": true
|
|
7132
7132
|
}
|
|
7133
7133
|
],
|
|
@@ -7136,8 +7136,8 @@
|
|
|
7136
7136
|
"kind": "js",
|
|
7137
7137
|
"name": "default",
|
|
7138
7138
|
"declaration": {
|
|
7139
|
-
"name": "
|
|
7140
|
-
"module": "components/
|
|
7139
|
+
"name": "CardRadio",
|
|
7140
|
+
"module": "components/cardradio/cardradio.component.js"
|
|
7141
7141
|
}
|
|
7142
7142
|
}
|
|
7143
7143
|
]
|
|
@@ -7883,7 +7883,7 @@
|
|
|
7883
7883
|
"text": "boolean"
|
|
7884
7884
|
},
|
|
7885
7885
|
"default": "true",
|
|
7886
|
-
"description": "Determines whether focus should wrap around when reaching the first or last focusable element.\nIf true, focus will cycle from end to start and vice versa.\n\nThis only applies when `
|
|
7886
|
+
"description": "Determines whether focus should wrap around when reaching the first or last focusable element.\nIf true, focus will cycle from end to start and vice versa.\n\nThis only applies when `focusTrap` is true.",
|
|
7887
7887
|
"attribute": "should-focus-trap-wrap",
|
|
7888
7888
|
"reflects": true,
|
|
7889
7889
|
"inheritedFrom": {
|
|
@@ -8167,7 +8167,7 @@
|
|
|
8167
8167
|
"description": "The set of focusable elements."
|
|
8168
8168
|
}
|
|
8169
8169
|
],
|
|
8170
|
-
"description": "Recursively finds all focusable elements within the given root and its descendants.",
|
|
8170
|
+
"description": "Recursively finds all focusable elements within the given root and its descendants.\n\nMake sure this is performant, as it will be called multiple times.",
|
|
8171
8171
|
"inheritedFrom": {
|
|
8172
8172
|
"name": "FocusTrapMixin",
|
|
8173
8173
|
"module": "utils/mixins/FocusTrapMixin.js"
|
|
@@ -8176,7 +8176,7 @@
|
|
|
8176
8176
|
{
|
|
8177
8177
|
"kind": "method",
|
|
8178
8178
|
"name": "setFocusableElements",
|
|
8179
|
-
"privacy": "
|
|
8179
|
+
"privacy": "private",
|
|
8180
8180
|
"description": "Updates the list of focusable elements within the component's shadow root.",
|
|
8181
8181
|
"inheritedFrom": {
|
|
8182
8182
|
"name": "FocusTrapMixin",
|
|
@@ -8492,6 +8492,21 @@
|
|
|
8492
8492
|
"module": "components/popover/popover.component.js"
|
|
8493
8493
|
}
|
|
8494
8494
|
},
|
|
8495
|
+
{
|
|
8496
|
+
"kind": "field",
|
|
8497
|
+
"name": "propagateEventOnEscape",
|
|
8498
|
+
"type": {
|
|
8499
|
+
"text": "boolean"
|
|
8500
|
+
},
|
|
8501
|
+
"description": "Propagates the event, when the escape key is pressed (only when pressed inside the popover)\nIf true, the escape key press close the popover and will propagate the keydown event.\nIf false, the escape key press will close the popover but will not propagate the keydown event.\n(set to false to prevent the event from bubbling up to the document).\n\nThis only works when `hideOnEscape` is true.",
|
|
8502
|
+
"default": "false",
|
|
8503
|
+
"attribute": "propagate-event-on-escape",
|
|
8504
|
+
"reflects": true,
|
|
8505
|
+
"inheritedFrom": {
|
|
8506
|
+
"name": "Popover",
|
|
8507
|
+
"module": "components/popover/popover.component.js"
|
|
8508
|
+
}
|
|
8509
|
+
},
|
|
8495
8510
|
{
|
|
8496
8511
|
"kind": "field",
|
|
8497
8512
|
"name": "hideOnBlur",
|
|
@@ -8753,7 +8768,7 @@
|
|
|
8753
8768
|
"kind": "field",
|
|
8754
8769
|
"name": "onEscapeKeydown",
|
|
8755
8770
|
"privacy": "private",
|
|
8756
|
-
"description": "Handles the escape keydown event to close the popover.",
|
|
8771
|
+
"description": "Handles the escape keydown event to close the popover.\n\nThis method is attached to the document.",
|
|
8757
8772
|
"parameters": [
|
|
8758
8773
|
{
|
|
8759
8774
|
"description": "The keyboard event.",
|
|
@@ -8984,7 +8999,7 @@
|
|
|
8984
8999
|
"text": "boolean"
|
|
8985
9000
|
},
|
|
8986
9001
|
"default": "true",
|
|
8987
|
-
"description": "Determines whether focus should wrap around when reaching the first or last focusable element.\nIf true, focus will cycle from end to start and vice versa.\n\nThis only applies when `
|
|
9002
|
+
"description": "Determines whether focus should wrap around when reaching the first or last focusable element.\nIf true, focus will cycle from end to start and vice versa.\n\nThis only applies when `focusTrap` is true.",
|
|
8988
9003
|
"fieldName": "shouldFocusTrapWrap",
|
|
8989
9004
|
"inheritedFrom": {
|
|
8990
9005
|
"name": "FocusTrapMixin",
|
|
@@ -9147,6 +9162,19 @@
|
|
|
9147
9162
|
"module": "src/components/popover/popover.component.ts"
|
|
9148
9163
|
}
|
|
9149
9164
|
},
|
|
9165
|
+
{
|
|
9166
|
+
"name": "propagate-event-on-escape",
|
|
9167
|
+
"type": {
|
|
9168
|
+
"text": "boolean"
|
|
9169
|
+
},
|
|
9170
|
+
"description": "Propagates the event, when the escape key is pressed (only when pressed inside the popover)\nIf true, the escape key press close the popover and will propagate the keydown event.\nIf false, the escape key press will close the popover but will not propagate the keydown event.\n(set to false to prevent the event from bubbling up to the document).\n\nThis only works when `hideOnEscape` is true.",
|
|
9171
|
+
"default": "false",
|
|
9172
|
+
"fieldName": "propagateEventOnEscape",
|
|
9173
|
+
"inheritedFrom": {
|
|
9174
|
+
"name": "Popover",
|
|
9175
|
+
"module": "src/components/popover/popover.component.ts"
|
|
9176
|
+
}
|
|
9177
|
+
},
|
|
9150
9178
|
{
|
|
9151
9179
|
"name": "hide-on-blur",
|
|
9152
9180
|
"type": {
|
|
@@ -9623,7 +9651,7 @@
|
|
|
9623
9651
|
"text": "boolean"
|
|
9624
9652
|
},
|
|
9625
9653
|
"default": "true",
|
|
9626
|
-
"description": "Determines whether focus should wrap around when reaching the first or last focusable element.\nIf true, focus will cycle from end to start and vice versa.\n\nThis only applies when `
|
|
9654
|
+
"description": "Determines whether focus should wrap around when reaching the first or last focusable element.\nIf true, focus will cycle from end to start and vice versa.\n\nThis only applies when `focusTrap` is true.",
|
|
9627
9655
|
"attribute": "should-focus-trap-wrap",
|
|
9628
9656
|
"reflects": true,
|
|
9629
9657
|
"inheritedFrom": {
|
|
@@ -9907,7 +9935,7 @@
|
|
|
9907
9935
|
"description": "The set of focusable elements."
|
|
9908
9936
|
}
|
|
9909
9937
|
],
|
|
9910
|
-
"description": "Recursively finds all focusable elements within the given root and its descendants.",
|
|
9938
|
+
"description": "Recursively finds all focusable elements within the given root and its descendants.\n\nMake sure this is performant, as it will be called multiple times.",
|
|
9911
9939
|
"inheritedFrom": {
|
|
9912
9940
|
"name": "FocusTrapMixin",
|
|
9913
9941
|
"module": "utils/mixins/FocusTrapMixin.js"
|
|
@@ -9916,7 +9944,7 @@
|
|
|
9916
9944
|
{
|
|
9917
9945
|
"kind": "method",
|
|
9918
9946
|
"name": "setFocusableElements",
|
|
9919
|
-
"privacy": "
|
|
9947
|
+
"privacy": "private",
|
|
9920
9948
|
"description": "Updates the list of focusable elements within the component's shadow root.",
|
|
9921
9949
|
"inheritedFrom": {
|
|
9922
9950
|
"name": "FocusTrapMixin",
|
|
@@ -10276,7 +10304,7 @@
|
|
|
10276
10304
|
"text": "boolean"
|
|
10277
10305
|
},
|
|
10278
10306
|
"default": "true",
|
|
10279
|
-
"description": "Determines whether focus should wrap around when reaching the first or last focusable element.\nIf true, focus will cycle from end to start and vice versa.\n\nThis only applies when `
|
|
10307
|
+
"description": "Determines whether focus should wrap around when reaching the first or last focusable element.\nIf true, focus will cycle from end to start and vice versa.\n\nThis only applies when `focusTrap` is true.",
|
|
10280
10308
|
"fieldName": "shouldFocusTrapWrap",
|
|
10281
10309
|
"inheritedFrom": {
|
|
10282
10310
|
"name": "FocusTrapMixin",
|
|
@@ -15641,13 +15669,135 @@
|
|
|
15641
15669
|
},
|
|
15642
15670
|
{
|
|
15643
15671
|
"kind": "javascript-module",
|
|
15644
|
-
"path": "components/
|
|
15672
|
+
"path": "components/menuitemcheckbox/menuitemcheckbox.component.js",
|
|
15645
15673
|
"declarations": [
|
|
15646
15674
|
{
|
|
15647
15675
|
"kind": "class",
|
|
15648
|
-
"description": "
|
|
15649
|
-
"name": "
|
|
15676
|
+
"description": "A menuitemcheckbox component is a checkable menuitem.\nThere should be no focusable descendants inside this menuitemcheckbox component.\n\nThe `aria-checked` attribute indicates whether the menuitemcheckbox is checked or not.\n\nThe `indicator` attribute is used to differentiate between <b>checkbox</b>, <b>checkmark</b> and <b>toggle</b>.\nBy default the `indicator` is set to <b>checkbox</b>.<br/>\n\nThe checkbox will always be positioned on the leading side of the menuitem label and\nthe toggle and checkmark will always be positioned on the trailing side.\n\nThe checkbox will have the possible states of `true` or `false`.\nIf the indicator is set to <b>checkmark</b> and if the `aria-checked` attribute is set to `true`,\nthen the checkmark will be displayed. if not, then no indicator will be displayed.\n\nIf you want only one item in a group to be checked, consider using menuitemradio component.\n\nIf a menuitemcheckbox is disabled, then the `aria-disabled` attribute is set to `true`.",
|
|
15677
|
+
"name": "MenuItemCheckbox",
|
|
15678
|
+
"cssProperties": [
|
|
15679
|
+
{
|
|
15680
|
+
"description": "Allows customization of the checkmark indicator color",
|
|
15681
|
+
"name": "--mdc-checkmark-indicator-color"
|
|
15682
|
+
},
|
|
15683
|
+
{
|
|
15684
|
+
"description": "Allows customization of the default background color.",
|
|
15685
|
+
"name": "--mdc-listitem-default-background-color",
|
|
15686
|
+
"inheritedFrom": {
|
|
15687
|
+
"name": "ListItem",
|
|
15688
|
+
"module": "src/components/listitem/listitem.component.ts"
|
|
15689
|
+
}
|
|
15690
|
+
},
|
|
15691
|
+
{
|
|
15692
|
+
"description": "Allows customization of the background color on hover.",
|
|
15693
|
+
"name": "--mdc-listitem-background-color-hover",
|
|
15694
|
+
"inheritedFrom": {
|
|
15695
|
+
"name": "ListItem",
|
|
15696
|
+
"module": "src/components/listitem/listitem.component.ts"
|
|
15697
|
+
}
|
|
15698
|
+
},
|
|
15699
|
+
{
|
|
15700
|
+
"description": "Allows customization of the background color when pressed.",
|
|
15701
|
+
"name": "--mdc-listitem-background-color-active",
|
|
15702
|
+
"inheritedFrom": {
|
|
15703
|
+
"name": "ListItem",
|
|
15704
|
+
"module": "src/components/listitem/listitem.component.ts"
|
|
15705
|
+
}
|
|
15706
|
+
},
|
|
15707
|
+
{
|
|
15708
|
+
"description": "Allows customization of the primary label, side header and subline text slot color.",
|
|
15709
|
+
"name": "--mdc-listitem-primary-label-color",
|
|
15710
|
+
"inheritedFrom": {
|
|
15711
|
+
"name": "ListItem",
|
|
15712
|
+
"module": "src/components/listitem/listitem.component.ts"
|
|
15713
|
+
}
|
|
15714
|
+
},
|
|
15715
|
+
{
|
|
15716
|
+
"description": "Allows customization of the secondary and tertiary label text slot color.",
|
|
15717
|
+
"name": "--mdc-listitem-secondary-label-color",
|
|
15718
|
+
"inheritedFrom": {
|
|
15719
|
+
"name": "ListItem",
|
|
15720
|
+
"module": "src/components/listitem/listitem.component.ts"
|
|
15721
|
+
}
|
|
15722
|
+
},
|
|
15723
|
+
{
|
|
15724
|
+
"description": "Allows customization of the disabled color.",
|
|
15725
|
+
"name": "--mdc-listitem-disabled-color",
|
|
15726
|
+
"inheritedFrom": {
|
|
15727
|
+
"name": "ListItem",
|
|
15728
|
+
"module": "src/components/listitem/listitem.component.ts"
|
|
15729
|
+
}
|
|
15730
|
+
},
|
|
15731
|
+
{
|
|
15732
|
+
"description": "Allows customization of column gap.",
|
|
15733
|
+
"name": "--mdc-listitem-column-gap",
|
|
15734
|
+
"inheritedFrom": {
|
|
15735
|
+
"name": "ListItem",
|
|
15736
|
+
"module": "src/components/listitem/listitem.component.ts"
|
|
15737
|
+
}
|
|
15738
|
+
},
|
|
15739
|
+
{
|
|
15740
|
+
"description": "Allows customization of padding left and right.",
|
|
15741
|
+
"name": "--mdc-listitem-padding-left-and-right",
|
|
15742
|
+
"inheritedFrom": {
|
|
15743
|
+
"name": "ListItem",
|
|
15744
|
+
"module": "src/components/listitem/listitem.component.ts"
|
|
15745
|
+
}
|
|
15746
|
+
}
|
|
15747
|
+
],
|
|
15650
15748
|
"members": [
|
|
15749
|
+
{
|
|
15750
|
+
"kind": "field",
|
|
15751
|
+
"name": "ariaChecked",
|
|
15752
|
+
"type": {
|
|
15753
|
+
"text": "AriaCheckedStates"
|
|
15754
|
+
},
|
|
15755
|
+
"description": "The aria-checked attribute is used to indicate that the menuitemcheckbox is checked or not.",
|
|
15756
|
+
"default": "'false'",
|
|
15757
|
+
"attribute": "aria-checked",
|
|
15758
|
+
"reflects": true
|
|
15759
|
+
},
|
|
15760
|
+
{
|
|
15761
|
+
"kind": "field",
|
|
15762
|
+
"name": "indicator",
|
|
15763
|
+
"type": {
|
|
15764
|
+
"text": "Indicator"
|
|
15765
|
+
},
|
|
15766
|
+
"description": "The indicator attribute is used to differentiate between <b>checkbox</b> and <b>toggle</b>.",
|
|
15767
|
+
"default": "'checkbox'",
|
|
15768
|
+
"attribute": "indicator",
|
|
15769
|
+
"reflects": true
|
|
15770
|
+
},
|
|
15771
|
+
{
|
|
15772
|
+
"kind": "method",
|
|
15773
|
+
"name": "staticCheckbox",
|
|
15774
|
+
"privacy": "private",
|
|
15775
|
+
"return": {
|
|
15776
|
+
"type": {
|
|
15777
|
+
"text": "TemplateResult | typeof nothing"
|
|
15778
|
+
}
|
|
15779
|
+
}
|
|
15780
|
+
},
|
|
15781
|
+
{
|
|
15782
|
+
"kind": "method",
|
|
15783
|
+
"name": "staticToggle",
|
|
15784
|
+
"privacy": "private",
|
|
15785
|
+
"return": {
|
|
15786
|
+
"type": {
|
|
15787
|
+
"text": "TemplateResult | typeof nothing"
|
|
15788
|
+
}
|
|
15789
|
+
}
|
|
15790
|
+
},
|
|
15791
|
+
{
|
|
15792
|
+
"kind": "method",
|
|
15793
|
+
"name": "getCheckmarkIcon",
|
|
15794
|
+
"privacy": "private",
|
|
15795
|
+
"return": {
|
|
15796
|
+
"type": {
|
|
15797
|
+
"text": "TemplateResult | typeof nothing"
|
|
15798
|
+
}
|
|
15799
|
+
}
|
|
15800
|
+
},
|
|
15651
15801
|
{
|
|
15652
15802
|
"kind": "field",
|
|
15653
15803
|
"name": "arrowPosition",
|
|
@@ -15656,7 +15806,11 @@
|
|
|
15656
15806
|
},
|
|
15657
15807
|
"description": "Defines where the arrow icon will appear.\n- `'leading'`: Icon appears on the leading edge (start).\n- `'trailing'`: Icon appears on the trailing edge (end).\n\nIf not set, no arrow is displayed.",
|
|
15658
15808
|
"attribute": "arrow-position",
|
|
15659
|
-
"reflects": true
|
|
15809
|
+
"reflects": true,
|
|
15810
|
+
"inheritedFrom": {
|
|
15811
|
+
"name": "MenuItem",
|
|
15812
|
+
"module": "components/menuitem/menuitem.component.js"
|
|
15813
|
+
}
|
|
15660
15814
|
},
|
|
15661
15815
|
{
|
|
15662
15816
|
"kind": "field",
|
|
@@ -15666,7 +15820,11 @@
|
|
|
15666
15820
|
},
|
|
15667
15821
|
"description": "Defines the direction the arrow icon points.\n- `'positive'`: Arrow points toward the trailing side.\n- `'negative'`: Arrow points toward the leading side.",
|
|
15668
15822
|
"attribute": "arrow-direction",
|
|
15669
|
-
"reflects": true
|
|
15823
|
+
"reflects": true,
|
|
15824
|
+
"inheritedFrom": {
|
|
15825
|
+
"name": "MenuItem",
|
|
15826
|
+
"module": "components/menuitem/menuitem.component.js"
|
|
15827
|
+
}
|
|
15670
15828
|
},
|
|
15671
15829
|
{
|
|
15672
15830
|
"kind": "method",
|
|
@@ -16011,7 +16169,12 @@
|
|
|
16011
16169
|
],
|
|
16012
16170
|
"events": [
|
|
16013
16171
|
{
|
|
16014
|
-
"description": "(React:
|
|
16172
|
+
"description": "(React: onChange) This event is dispatched when the menuitemcheckbox changes.",
|
|
16173
|
+
"name": "change",
|
|
16174
|
+
"reactName": "onChange"
|
|
16175
|
+
},
|
|
16176
|
+
{
|
|
16177
|
+
"description": "(React: onClick) This event is dispatched when the menuitemcheckbox is clicked.",
|
|
16015
16178
|
"name": "click",
|
|
16016
16179
|
"reactName": "onClick",
|
|
16017
16180
|
"inheritedFrom": {
|
|
@@ -16020,27 +16183,27 @@
|
|
|
16020
16183
|
}
|
|
16021
16184
|
},
|
|
16022
16185
|
{
|
|
16023
|
-
"description": "(React:
|
|
16024
|
-
"name": "
|
|
16025
|
-
"reactName": "
|
|
16186
|
+
"description": "(React: onFocus) This event is dispatched when the menuitemcheckbox receives focus.",
|
|
16187
|
+
"name": "focus",
|
|
16188
|
+
"reactName": "onFocus",
|
|
16026
16189
|
"inheritedFrom": {
|
|
16027
16190
|
"name": "ListItem",
|
|
16028
16191
|
"module": "src/components/listitem/listitem.component.ts"
|
|
16029
16192
|
}
|
|
16030
16193
|
},
|
|
16031
16194
|
{
|
|
16032
|
-
"description": "(React:
|
|
16033
|
-
"name": "
|
|
16034
|
-
"reactName": "
|
|
16195
|
+
"description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the menuitem.",
|
|
16196
|
+
"name": "keydown",
|
|
16197
|
+
"reactName": "onKeyDown",
|
|
16035
16198
|
"inheritedFrom": {
|
|
16036
16199
|
"name": "ListItem",
|
|
16037
16200
|
"module": "src/components/listitem/listitem.component.ts"
|
|
16038
16201
|
}
|
|
16039
16202
|
},
|
|
16040
16203
|
{
|
|
16041
|
-
"description": "(React:
|
|
16042
|
-
"name": "
|
|
16043
|
-
"reactName": "
|
|
16204
|
+
"description": "(React: onKeyUp) This event is dispatched when a key is released on the menuitem.",
|
|
16205
|
+
"name": "keyup",
|
|
16206
|
+
"reactName": "onKeyUp",
|
|
16044
16207
|
"inheritedFrom": {
|
|
16045
16208
|
"name": "ListItem",
|
|
16046
16209
|
"module": "src/components/listitem/listitem.component.ts"
|
|
@@ -16048,13 +16211,35 @@
|
|
|
16048
16211
|
}
|
|
16049
16212
|
],
|
|
16050
16213
|
"attributes": [
|
|
16214
|
+
{
|
|
16215
|
+
"name": "aria-checked",
|
|
16216
|
+
"type": {
|
|
16217
|
+
"text": "AriaCheckedStates"
|
|
16218
|
+
},
|
|
16219
|
+
"description": "The aria-checked attribute is used to indicate that the menuitemcheckbox is checked or not.",
|
|
16220
|
+
"default": "'false'",
|
|
16221
|
+
"fieldName": "ariaChecked"
|
|
16222
|
+
},
|
|
16223
|
+
{
|
|
16224
|
+
"name": "indicator",
|
|
16225
|
+
"type": {
|
|
16226
|
+
"text": "Indicator"
|
|
16227
|
+
},
|
|
16228
|
+
"description": "The indicator attribute is used to differentiate between <b>checkbox</b> and <b>toggle</b>.",
|
|
16229
|
+
"default": "'checkbox'",
|
|
16230
|
+
"fieldName": "indicator"
|
|
16231
|
+
},
|
|
16051
16232
|
{
|
|
16052
16233
|
"name": "arrow-position",
|
|
16053
16234
|
"type": {
|
|
16054
16235
|
"text": "ArrowPositions | undefined"
|
|
16055
16236
|
},
|
|
16056
16237
|
"description": "Defines where the arrow icon will appear.\n- `'leading'`: Icon appears on the leading edge (start).\n- `'trailing'`: Icon appears on the trailing edge (end).\n\nIf not set, no arrow is displayed.",
|
|
16057
|
-
"fieldName": "arrowPosition"
|
|
16238
|
+
"fieldName": "arrowPosition",
|
|
16239
|
+
"inheritedFrom": {
|
|
16240
|
+
"name": "MenuItem",
|
|
16241
|
+
"module": "src/components/menuitem/menuitem.component.ts"
|
|
16242
|
+
}
|
|
16058
16243
|
},
|
|
16059
16244
|
{
|
|
16060
16245
|
"name": "arrow-direction",
|
|
@@ -16062,7 +16247,11 @@
|
|
|
16062
16247
|
"text": "ArrowDirections | undefined"
|
|
16063
16248
|
},
|
|
16064
16249
|
"description": "Defines the direction the arrow icon points.\n- `'positive'`: Arrow points toward the trailing side.\n- `'negative'`: Arrow points toward the leading side.",
|
|
16065
|
-
"fieldName": "arrowDirection"
|
|
16250
|
+
"fieldName": "arrowDirection",
|
|
16251
|
+
"inheritedFrom": {
|
|
16252
|
+
"name": "MenuItem",
|
|
16253
|
+
"module": "src/components/menuitem/menuitem.component.ts"
|
|
16254
|
+
}
|
|
16066
16255
|
},
|
|
16067
16256
|
{
|
|
16068
16257
|
"name": "disabled",
|
|
@@ -16190,11 +16379,11 @@
|
|
|
16190
16379
|
}
|
|
16191
16380
|
],
|
|
16192
16381
|
"superclass": {
|
|
16193
|
-
"name": "
|
|
16194
|
-
"module": "/src/components/
|
|
16382
|
+
"name": "MenuItem",
|
|
16383
|
+
"module": "/src/components/menuitem/menuitem.component"
|
|
16195
16384
|
},
|
|
16196
|
-
"tagName": "mdc-
|
|
16197
|
-
"jsDoc": "/**\n *
|
|
16385
|
+
"tagName": "mdc-menuitemcheckbox",
|
|
16386
|
+
"jsDoc": "/**\n * A menuitemcheckbox component is a checkable menuitem.\n * There should be no focusable descendants inside this menuitemcheckbox component.\n *\n * The `aria-checked` attribute indicates whether the menuitemcheckbox is checked or not.\n *\n * The `indicator` attribute is used to differentiate between <b>checkbox</b>, <b>checkmark</b> and <b>toggle</b>.\n * By default the `indicator` is set to <b>checkbox</b>.<br/>\n *\n * The checkbox will always be positioned on the leading side of the menuitem label and\n * the toggle and checkmark will always be positioned on the trailing side.\n *\n * The checkbox will have the possible states of `true` or `false`.\n * If the indicator is set to <b>checkmark</b> and if the `aria-checked` attribute is set to `true`,\n * then the checkmark will be displayed. if not, then no indicator will be displayed.\n *\n * If you want only one item in a group to be checked, consider using menuitemradio component.\n *\n * If a menuitemcheckbox is disabled, then the `aria-disabled` attribute is set to `true`.\n *\n * @dependency mdc-staticcheckbox\n * @dependency mdc-statictoggle\n * @dependency mdc-icon\n *\n * @tagname mdc-menuitemcheckbox\n *\n * @cssproperty --mdc-checkmark-indicator-color - Allows customization of the checkmark indicator color\n *\n * @event change - (React: onChange) This event is dispatched when the menuitemcheckbox changes.\n * @event click - (React: onClick) This event is dispatched when the menuitemcheckbox is clicked.\n * @event focus - (React: onFocus) This event is dispatched when the menuitemcheckbox receives focus.\n */",
|
|
16198
16387
|
"customElement": true,
|
|
16199
16388
|
"slots": [
|
|
16200
16389
|
{
|
|
@@ -16253,72 +16442,6 @@
|
|
|
16253
16442
|
"module": "src/components/listitem/listitem.component.ts"
|
|
16254
16443
|
}
|
|
16255
16444
|
}
|
|
16256
|
-
],
|
|
16257
|
-
"cssProperties": [
|
|
16258
|
-
{
|
|
16259
|
-
"description": "Allows customization of the default background color.",
|
|
16260
|
-
"name": "--mdc-listitem-default-background-color",
|
|
16261
|
-
"inheritedFrom": {
|
|
16262
|
-
"name": "ListItem",
|
|
16263
|
-
"module": "src/components/listitem/listitem.component.ts"
|
|
16264
|
-
}
|
|
16265
|
-
},
|
|
16266
|
-
{
|
|
16267
|
-
"description": "Allows customization of the background color on hover.",
|
|
16268
|
-
"name": "--mdc-listitem-background-color-hover",
|
|
16269
|
-
"inheritedFrom": {
|
|
16270
|
-
"name": "ListItem",
|
|
16271
|
-
"module": "src/components/listitem/listitem.component.ts"
|
|
16272
|
-
}
|
|
16273
|
-
},
|
|
16274
|
-
{
|
|
16275
|
-
"description": "Allows customization of the background color when pressed.",
|
|
16276
|
-
"name": "--mdc-listitem-background-color-active",
|
|
16277
|
-
"inheritedFrom": {
|
|
16278
|
-
"name": "ListItem",
|
|
16279
|
-
"module": "src/components/listitem/listitem.component.ts"
|
|
16280
|
-
}
|
|
16281
|
-
},
|
|
16282
|
-
{
|
|
16283
|
-
"description": "Allows customization of the primary label, side header and subline text slot color.",
|
|
16284
|
-
"name": "--mdc-listitem-primary-label-color",
|
|
16285
|
-
"inheritedFrom": {
|
|
16286
|
-
"name": "ListItem",
|
|
16287
|
-
"module": "src/components/listitem/listitem.component.ts"
|
|
16288
|
-
}
|
|
16289
|
-
},
|
|
16290
|
-
{
|
|
16291
|
-
"description": "Allows customization of the secondary and tertiary label text slot color.",
|
|
16292
|
-
"name": "--mdc-listitem-secondary-label-color",
|
|
16293
|
-
"inheritedFrom": {
|
|
16294
|
-
"name": "ListItem",
|
|
16295
|
-
"module": "src/components/listitem/listitem.component.ts"
|
|
16296
|
-
}
|
|
16297
|
-
},
|
|
16298
|
-
{
|
|
16299
|
-
"description": "Allows customization of the disabled color.",
|
|
16300
|
-
"name": "--mdc-listitem-disabled-color",
|
|
16301
|
-
"inheritedFrom": {
|
|
16302
|
-
"name": "ListItem",
|
|
16303
|
-
"module": "src/components/listitem/listitem.component.ts"
|
|
16304
|
-
}
|
|
16305
|
-
},
|
|
16306
|
-
{
|
|
16307
|
-
"description": "Allows customization of column gap.",
|
|
16308
|
-
"name": "--mdc-listitem-column-gap",
|
|
16309
|
-
"inheritedFrom": {
|
|
16310
|
-
"name": "ListItem",
|
|
16311
|
-
"module": "src/components/listitem/listitem.component.ts"
|
|
16312
|
-
}
|
|
16313
|
-
},
|
|
16314
|
-
{
|
|
16315
|
-
"description": "Allows customization of padding left and right.",
|
|
16316
|
-
"name": "--mdc-listitem-padding-left-and-right",
|
|
16317
|
-
"inheritedFrom": {
|
|
16318
|
-
"name": "ListItem",
|
|
16319
|
-
"module": "src/components/listitem/listitem.component.ts"
|
|
16320
|
-
}
|
|
16321
|
-
}
|
|
16322
16445
|
]
|
|
16323
16446
|
}
|
|
16324
16447
|
],
|
|
@@ -16327,143 +16450,21 @@
|
|
|
16327
16450
|
"kind": "js",
|
|
16328
16451
|
"name": "default",
|
|
16329
16452
|
"declaration": {
|
|
16330
|
-
"name": "
|
|
16331
|
-
"module": "components/
|
|
16453
|
+
"name": "MenuItemCheckbox",
|
|
16454
|
+
"module": "components/menuitemcheckbox/menuitemcheckbox.component.js"
|
|
16332
16455
|
}
|
|
16333
16456
|
}
|
|
16334
16457
|
]
|
|
16335
16458
|
},
|
|
16336
16459
|
{
|
|
16337
16460
|
"kind": "javascript-module",
|
|
16338
|
-
"path": "components/
|
|
16461
|
+
"path": "components/menuitem/menuitem.component.js",
|
|
16339
16462
|
"declarations": [
|
|
16340
16463
|
{
|
|
16341
16464
|
"kind": "class",
|
|
16342
|
-
"description": "
|
|
16343
|
-
"name": "
|
|
16344
|
-
"cssProperties": [
|
|
16345
|
-
{
|
|
16346
|
-
"description": "Allows customization of the checkmark indicator color",
|
|
16347
|
-
"name": "--mdc-checkmark-indicator-color"
|
|
16348
|
-
},
|
|
16349
|
-
{
|
|
16350
|
-
"description": "Allows customization of the default background color.",
|
|
16351
|
-
"name": "--mdc-listitem-default-background-color",
|
|
16352
|
-
"inheritedFrom": {
|
|
16353
|
-
"name": "ListItem",
|
|
16354
|
-
"module": "src/components/listitem/listitem.component.ts"
|
|
16355
|
-
}
|
|
16356
|
-
},
|
|
16357
|
-
{
|
|
16358
|
-
"description": "Allows customization of the background color on hover.",
|
|
16359
|
-
"name": "--mdc-listitem-background-color-hover",
|
|
16360
|
-
"inheritedFrom": {
|
|
16361
|
-
"name": "ListItem",
|
|
16362
|
-
"module": "src/components/listitem/listitem.component.ts"
|
|
16363
|
-
}
|
|
16364
|
-
},
|
|
16365
|
-
{
|
|
16366
|
-
"description": "Allows customization of the background color when pressed.",
|
|
16367
|
-
"name": "--mdc-listitem-background-color-active",
|
|
16368
|
-
"inheritedFrom": {
|
|
16369
|
-
"name": "ListItem",
|
|
16370
|
-
"module": "src/components/listitem/listitem.component.ts"
|
|
16371
|
-
}
|
|
16372
|
-
},
|
|
16373
|
-
{
|
|
16374
|
-
"description": "Allows customization of the primary label, side header and subline text slot color.",
|
|
16375
|
-
"name": "--mdc-listitem-primary-label-color",
|
|
16376
|
-
"inheritedFrom": {
|
|
16377
|
-
"name": "ListItem",
|
|
16378
|
-
"module": "src/components/listitem/listitem.component.ts"
|
|
16379
|
-
}
|
|
16380
|
-
},
|
|
16381
|
-
{
|
|
16382
|
-
"description": "Allows customization of the secondary and tertiary label text slot color.",
|
|
16383
|
-
"name": "--mdc-listitem-secondary-label-color",
|
|
16384
|
-
"inheritedFrom": {
|
|
16385
|
-
"name": "ListItem",
|
|
16386
|
-
"module": "src/components/listitem/listitem.component.ts"
|
|
16387
|
-
}
|
|
16388
|
-
},
|
|
16389
|
-
{
|
|
16390
|
-
"description": "Allows customization of the disabled color.",
|
|
16391
|
-
"name": "--mdc-listitem-disabled-color",
|
|
16392
|
-
"inheritedFrom": {
|
|
16393
|
-
"name": "ListItem",
|
|
16394
|
-
"module": "src/components/listitem/listitem.component.ts"
|
|
16395
|
-
}
|
|
16396
|
-
},
|
|
16397
|
-
{
|
|
16398
|
-
"description": "Allows customization of column gap.",
|
|
16399
|
-
"name": "--mdc-listitem-column-gap",
|
|
16400
|
-
"inheritedFrom": {
|
|
16401
|
-
"name": "ListItem",
|
|
16402
|
-
"module": "src/components/listitem/listitem.component.ts"
|
|
16403
|
-
}
|
|
16404
|
-
},
|
|
16405
|
-
{
|
|
16406
|
-
"description": "Allows customization of padding left and right.",
|
|
16407
|
-
"name": "--mdc-listitem-padding-left-and-right",
|
|
16408
|
-
"inheritedFrom": {
|
|
16409
|
-
"name": "ListItem",
|
|
16410
|
-
"module": "src/components/listitem/listitem.component.ts"
|
|
16411
|
-
}
|
|
16412
|
-
}
|
|
16413
|
-
],
|
|
16465
|
+
"description": "menuitem component is inherited by listitem component with the role set `menuitem`.<br/>\nA menu item can contain an icon on the leading or trailing side.\n\nThe leading and trailing slots can be used to display controls and text.<br/>\nBased on the leading/trailing slot, the position of the controls and text can be adjusted.\n\nPlease use mdc-menu as a parent element even when there is only menuitem for a11y purpose.",
|
|
16466
|
+
"name": "MenuItem",
|
|
16414
16467
|
"members": [
|
|
16415
|
-
{
|
|
16416
|
-
"kind": "field",
|
|
16417
|
-
"name": "ariaChecked",
|
|
16418
|
-
"type": {
|
|
16419
|
-
"text": "AriaCheckedStates"
|
|
16420
|
-
},
|
|
16421
|
-
"description": "The aria-checked attribute is used to indicate that the menuitemcheckbox is checked or not.",
|
|
16422
|
-
"default": "'false'",
|
|
16423
|
-
"attribute": "aria-checked",
|
|
16424
|
-
"reflects": true
|
|
16425
|
-
},
|
|
16426
|
-
{
|
|
16427
|
-
"kind": "field",
|
|
16428
|
-
"name": "indicator",
|
|
16429
|
-
"type": {
|
|
16430
|
-
"text": "Indicator"
|
|
16431
|
-
},
|
|
16432
|
-
"description": "The indicator attribute is used to differentiate between <b>checkbox</b> and <b>toggle</b>.",
|
|
16433
|
-
"default": "'checkbox'",
|
|
16434
|
-
"attribute": "indicator",
|
|
16435
|
-
"reflects": true
|
|
16436
|
-
},
|
|
16437
|
-
{
|
|
16438
|
-
"kind": "method",
|
|
16439
|
-
"name": "staticCheckbox",
|
|
16440
|
-
"privacy": "private",
|
|
16441
|
-
"return": {
|
|
16442
|
-
"type": {
|
|
16443
|
-
"text": "TemplateResult | typeof nothing"
|
|
16444
|
-
}
|
|
16445
|
-
}
|
|
16446
|
-
},
|
|
16447
|
-
{
|
|
16448
|
-
"kind": "method",
|
|
16449
|
-
"name": "staticToggle",
|
|
16450
|
-
"privacy": "private",
|
|
16451
|
-
"return": {
|
|
16452
|
-
"type": {
|
|
16453
|
-
"text": "TemplateResult | typeof nothing"
|
|
16454
|
-
}
|
|
16455
|
-
}
|
|
16456
|
-
},
|
|
16457
|
-
{
|
|
16458
|
-
"kind": "method",
|
|
16459
|
-
"name": "getCheckmarkIcon",
|
|
16460
|
-
"privacy": "private",
|
|
16461
|
-
"return": {
|
|
16462
|
-
"type": {
|
|
16463
|
-
"text": "TemplateResult | typeof nothing"
|
|
16464
|
-
}
|
|
16465
|
-
}
|
|
16466
|
-
},
|
|
16467
16468
|
{
|
|
16468
16469
|
"kind": "field",
|
|
16469
16470
|
"name": "arrowPosition",
|
|
@@ -16472,11 +16473,7 @@
|
|
|
16472
16473
|
},
|
|
16473
16474
|
"description": "Defines where the arrow icon will appear.\n- `'leading'`: Icon appears on the leading edge (start).\n- `'trailing'`: Icon appears on the trailing edge (end).\n\nIf not set, no arrow is displayed.",
|
|
16474
16475
|
"attribute": "arrow-position",
|
|
16475
|
-
"reflects": true
|
|
16476
|
-
"inheritedFrom": {
|
|
16477
|
-
"name": "MenuItem",
|
|
16478
|
-
"module": "components/menuitem/menuitem.component.js"
|
|
16479
|
-
}
|
|
16476
|
+
"reflects": true
|
|
16480
16477
|
},
|
|
16481
16478
|
{
|
|
16482
16479
|
"kind": "field",
|
|
@@ -16486,11 +16483,7 @@
|
|
|
16486
16483
|
},
|
|
16487
16484
|
"description": "Defines the direction the arrow icon points.\n- `'positive'`: Arrow points toward the trailing side.\n- `'negative'`: Arrow points toward the leading side.",
|
|
16488
16485
|
"attribute": "arrow-direction",
|
|
16489
|
-
"reflects": true
|
|
16490
|
-
"inheritedFrom": {
|
|
16491
|
-
"name": "MenuItem",
|
|
16492
|
-
"module": "components/menuitem/menuitem.component.js"
|
|
16493
|
-
}
|
|
16486
|
+
"reflects": true
|
|
16494
16487
|
},
|
|
16495
16488
|
{
|
|
16496
16489
|
"kind": "method",
|
|
@@ -16835,12 +16828,7 @@
|
|
|
16835
16828
|
],
|
|
16836
16829
|
"events": [
|
|
16837
16830
|
{
|
|
16838
|
-
"description": "(React:
|
|
16839
|
-
"name": "change",
|
|
16840
|
-
"reactName": "onChange"
|
|
16841
|
-
},
|
|
16842
|
-
{
|
|
16843
|
-
"description": "(React: onClick) This event is dispatched when the menuitemcheckbox is clicked.",
|
|
16831
|
+
"description": "(React: onClick) This event is dispatched when the menuitem is clicked.",
|
|
16844
16832
|
"name": "click",
|
|
16845
16833
|
"reactName": "onClick",
|
|
16846
16834
|
"inheritedFrom": {
|
|
@@ -16848,15 +16836,6 @@
|
|
|
16848
16836
|
"module": "src/components/listitem/listitem.component.ts"
|
|
16849
16837
|
}
|
|
16850
16838
|
},
|
|
16851
|
-
{
|
|
16852
|
-
"description": "(React: onFocus) This event is dispatched when the menuitemcheckbox receives focus.",
|
|
16853
|
-
"name": "focus",
|
|
16854
|
-
"reactName": "onFocus",
|
|
16855
|
-
"inheritedFrom": {
|
|
16856
|
-
"name": "ListItem",
|
|
16857
|
-
"module": "src/components/listitem/listitem.component.ts"
|
|
16858
|
-
}
|
|
16859
|
-
},
|
|
16860
16839
|
{
|
|
16861
16840
|
"description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the menuitem.",
|
|
16862
16841
|
"name": "keydown",
|
|
@@ -16874,38 +16853,25 @@
|
|
|
16874
16853
|
"name": "ListItem",
|
|
16875
16854
|
"module": "src/components/listitem/listitem.component.ts"
|
|
16876
16855
|
}
|
|
16856
|
+
},
|
|
16857
|
+
{
|
|
16858
|
+
"description": "(React: onFocus) This event is dispatched when the menuitem receives focus.",
|
|
16859
|
+
"name": "focus",
|
|
16860
|
+
"reactName": "onFocus",
|
|
16861
|
+
"inheritedFrom": {
|
|
16862
|
+
"name": "ListItem",
|
|
16863
|
+
"module": "src/components/listitem/listitem.component.ts"
|
|
16864
|
+
}
|
|
16877
16865
|
}
|
|
16878
16866
|
],
|
|
16879
16867
|
"attributes": [
|
|
16880
|
-
{
|
|
16881
|
-
"name": "aria-checked",
|
|
16882
|
-
"type": {
|
|
16883
|
-
"text": "AriaCheckedStates"
|
|
16884
|
-
},
|
|
16885
|
-
"description": "The aria-checked attribute is used to indicate that the menuitemcheckbox is checked or not.",
|
|
16886
|
-
"default": "'false'",
|
|
16887
|
-
"fieldName": "ariaChecked"
|
|
16888
|
-
},
|
|
16889
|
-
{
|
|
16890
|
-
"name": "indicator",
|
|
16891
|
-
"type": {
|
|
16892
|
-
"text": "Indicator"
|
|
16893
|
-
},
|
|
16894
|
-
"description": "The indicator attribute is used to differentiate between <b>checkbox</b> and <b>toggle</b>.",
|
|
16895
|
-
"default": "'checkbox'",
|
|
16896
|
-
"fieldName": "indicator"
|
|
16897
|
-
},
|
|
16898
16868
|
{
|
|
16899
16869
|
"name": "arrow-position",
|
|
16900
16870
|
"type": {
|
|
16901
16871
|
"text": "ArrowPositions | undefined"
|
|
16902
16872
|
},
|
|
16903
16873
|
"description": "Defines where the arrow icon will appear.\n- `'leading'`: Icon appears on the leading edge (start).\n- `'trailing'`: Icon appears on the trailing edge (end).\n\nIf not set, no arrow is displayed.",
|
|
16904
|
-
"fieldName": "arrowPosition"
|
|
16905
|
-
"inheritedFrom": {
|
|
16906
|
-
"name": "MenuItem",
|
|
16907
|
-
"module": "src/components/menuitem/menuitem.component.ts"
|
|
16908
|
-
}
|
|
16874
|
+
"fieldName": "arrowPosition"
|
|
16909
16875
|
},
|
|
16910
16876
|
{
|
|
16911
16877
|
"name": "arrow-direction",
|
|
@@ -16913,11 +16879,7 @@
|
|
|
16913
16879
|
"text": "ArrowDirections | undefined"
|
|
16914
16880
|
},
|
|
16915
16881
|
"description": "Defines the direction the arrow icon points.\n- `'positive'`: Arrow points toward the trailing side.\n- `'negative'`: Arrow points toward the leading side.",
|
|
16916
|
-
"fieldName": "arrowDirection"
|
|
16917
|
-
"inheritedFrom": {
|
|
16918
|
-
"name": "MenuItem",
|
|
16919
|
-
"module": "src/components/menuitem/menuitem.component.ts"
|
|
16920
|
-
}
|
|
16882
|
+
"fieldName": "arrowDirection"
|
|
16921
16883
|
},
|
|
16922
16884
|
{
|
|
16923
16885
|
"name": "disabled",
|
|
@@ -17045,11 +17007,11 @@
|
|
|
17045
17007
|
}
|
|
17046
17008
|
],
|
|
17047
17009
|
"superclass": {
|
|
17048
|
-
"name": "
|
|
17049
|
-
"module": "/src/components/
|
|
17010
|
+
"name": "ListItem",
|
|
17011
|
+
"module": "/src/components/listitem/listitem.component"
|
|
17050
17012
|
},
|
|
17051
|
-
"tagName": "mdc-
|
|
17052
|
-
"jsDoc": "/**\n *
|
|
17013
|
+
"tagName": "mdc-menuitem",
|
|
17014
|
+
"jsDoc": "/**\n * menuitem component is inherited by listitem component with the role set `menuitem`.<br/>\n * A menu item can contain an icon on the leading or trailing side.\n *\n * The leading and trailing slots can be used to display controls and text.<br/>\n * Based on the leading/trailing slot, the position of the controls and text can be adjusted.\n *\n * Please use mdc-menu as a parent element even when there is only menuitem for a11y purpose.\n *\n * @dependency mdc-text\n * @dependency mdc-icon\n * @dependency mdc-tooltip\n *\n * @tagname mdc-menuitem\n *\n * @event click - (React: onClick) This event is dispatched when the menuitem is clicked.\n * @event keydown - (React: onKeyDown) This event is dispatched when a key is pressed down on the menuitem.\n * @event keyup - (React: onKeyUp) This event is dispatched when a key is released on the menuitem.\n * @event focus - (React: onFocus) This event is dispatched when the menuitem receives focus.\n */",
|
|
17053
17015
|
"customElement": true,
|
|
17054
17016
|
"slots": [
|
|
17055
17017
|
{
|
|
@@ -17108,6 +17070,72 @@
|
|
|
17108
17070
|
"module": "src/components/listitem/listitem.component.ts"
|
|
17109
17071
|
}
|
|
17110
17072
|
}
|
|
17073
|
+
],
|
|
17074
|
+
"cssProperties": [
|
|
17075
|
+
{
|
|
17076
|
+
"description": "Allows customization of the default background color.",
|
|
17077
|
+
"name": "--mdc-listitem-default-background-color",
|
|
17078
|
+
"inheritedFrom": {
|
|
17079
|
+
"name": "ListItem",
|
|
17080
|
+
"module": "src/components/listitem/listitem.component.ts"
|
|
17081
|
+
}
|
|
17082
|
+
},
|
|
17083
|
+
{
|
|
17084
|
+
"description": "Allows customization of the background color on hover.",
|
|
17085
|
+
"name": "--mdc-listitem-background-color-hover",
|
|
17086
|
+
"inheritedFrom": {
|
|
17087
|
+
"name": "ListItem",
|
|
17088
|
+
"module": "src/components/listitem/listitem.component.ts"
|
|
17089
|
+
}
|
|
17090
|
+
},
|
|
17091
|
+
{
|
|
17092
|
+
"description": "Allows customization of the background color when pressed.",
|
|
17093
|
+
"name": "--mdc-listitem-background-color-active",
|
|
17094
|
+
"inheritedFrom": {
|
|
17095
|
+
"name": "ListItem",
|
|
17096
|
+
"module": "src/components/listitem/listitem.component.ts"
|
|
17097
|
+
}
|
|
17098
|
+
},
|
|
17099
|
+
{
|
|
17100
|
+
"description": "Allows customization of the primary label, side header and subline text slot color.",
|
|
17101
|
+
"name": "--mdc-listitem-primary-label-color",
|
|
17102
|
+
"inheritedFrom": {
|
|
17103
|
+
"name": "ListItem",
|
|
17104
|
+
"module": "src/components/listitem/listitem.component.ts"
|
|
17105
|
+
}
|
|
17106
|
+
},
|
|
17107
|
+
{
|
|
17108
|
+
"description": "Allows customization of the secondary and tertiary label text slot color.",
|
|
17109
|
+
"name": "--mdc-listitem-secondary-label-color",
|
|
17110
|
+
"inheritedFrom": {
|
|
17111
|
+
"name": "ListItem",
|
|
17112
|
+
"module": "src/components/listitem/listitem.component.ts"
|
|
17113
|
+
}
|
|
17114
|
+
},
|
|
17115
|
+
{
|
|
17116
|
+
"description": "Allows customization of the disabled color.",
|
|
17117
|
+
"name": "--mdc-listitem-disabled-color",
|
|
17118
|
+
"inheritedFrom": {
|
|
17119
|
+
"name": "ListItem",
|
|
17120
|
+
"module": "src/components/listitem/listitem.component.ts"
|
|
17121
|
+
}
|
|
17122
|
+
},
|
|
17123
|
+
{
|
|
17124
|
+
"description": "Allows customization of column gap.",
|
|
17125
|
+
"name": "--mdc-listitem-column-gap",
|
|
17126
|
+
"inheritedFrom": {
|
|
17127
|
+
"name": "ListItem",
|
|
17128
|
+
"module": "src/components/listitem/listitem.component.ts"
|
|
17129
|
+
}
|
|
17130
|
+
},
|
|
17131
|
+
{
|
|
17132
|
+
"description": "Allows customization of padding left and right.",
|
|
17133
|
+
"name": "--mdc-listitem-padding-left-and-right",
|
|
17134
|
+
"inheritedFrom": {
|
|
17135
|
+
"name": "ListItem",
|
|
17136
|
+
"module": "src/components/listitem/listitem.component.ts"
|
|
17137
|
+
}
|
|
17138
|
+
}
|
|
17111
17139
|
]
|
|
17112
17140
|
}
|
|
17113
17141
|
],
|
|
@@ -17116,8 +17144,8 @@
|
|
|
17116
17144
|
"kind": "js",
|
|
17117
17145
|
"name": "default",
|
|
17118
17146
|
"declaration": {
|
|
17119
|
-
"name": "
|
|
17120
|
-
"module": "components/
|
|
17147
|
+
"name": "MenuItem",
|
|
17148
|
+
"module": "components/menuitem/menuitem.component.js"
|
|
17121
17149
|
}
|
|
17122
17150
|
}
|
|
17123
17151
|
]
|
|
@@ -18520,7 +18548,7 @@
|
|
|
18520
18548
|
"text": "boolean"
|
|
18521
18549
|
},
|
|
18522
18550
|
"default": "true",
|
|
18523
|
-
"description": "Determines whether focus should wrap around when reaching the first or last focusable element.\nIf true, focus will cycle from end to start and vice versa.\n\nThis only applies when `
|
|
18551
|
+
"description": "Determines whether focus should wrap around when reaching the first or last focusable element.\nIf true, focus will cycle from end to start and vice versa.\n\nThis only applies when `focusTrap` is true.",
|
|
18524
18552
|
"attribute": "should-focus-trap-wrap",
|
|
18525
18553
|
"reflects": true,
|
|
18526
18554
|
"inheritedFrom": {
|
|
@@ -18804,7 +18832,7 @@
|
|
|
18804
18832
|
"description": "The set of focusable elements."
|
|
18805
18833
|
}
|
|
18806
18834
|
],
|
|
18807
|
-
"description": "Recursively finds all focusable elements within the given root and its descendants.",
|
|
18835
|
+
"description": "Recursively finds all focusable elements within the given root and its descendants.\n\nMake sure this is performant, as it will be called multiple times.",
|
|
18808
18836
|
"inheritedFrom": {
|
|
18809
18837
|
"name": "FocusTrapMixin",
|
|
18810
18838
|
"module": "utils/mixins/FocusTrapMixin.js"
|
|
@@ -18813,7 +18841,7 @@
|
|
|
18813
18841
|
{
|
|
18814
18842
|
"kind": "method",
|
|
18815
18843
|
"name": "setFocusableElements",
|
|
18816
|
-
"privacy": "
|
|
18844
|
+
"privacy": "private",
|
|
18817
18845
|
"description": "Updates the list of focusable elements within the component's shadow root.",
|
|
18818
18846
|
"inheritedFrom": {
|
|
18819
18847
|
"name": "FocusTrapMixin",
|
|
@@ -19174,6 +19202,21 @@
|
|
|
19174
19202
|
"module": "components/popover/popover.component.js"
|
|
19175
19203
|
}
|
|
19176
19204
|
},
|
|
19205
|
+
{
|
|
19206
|
+
"kind": "field",
|
|
19207
|
+
"name": "propagateEventOnEscape",
|
|
19208
|
+
"type": {
|
|
19209
|
+
"text": "boolean"
|
|
19210
|
+
},
|
|
19211
|
+
"description": "Propagates the event, when the escape key is pressed (only when pressed inside the popover)\nIf true, the escape key press close the popover and will propagate the keydown event.\nIf false, the escape key press will close the popover but will not propagate the keydown event.\n(set to false to prevent the event from bubbling up to the document).\n\nThis only works when `hideOnEscape` is true.",
|
|
19212
|
+
"default": "false",
|
|
19213
|
+
"attribute": "propagate-event-on-escape",
|
|
19214
|
+
"reflects": true,
|
|
19215
|
+
"inheritedFrom": {
|
|
19216
|
+
"name": "Popover",
|
|
19217
|
+
"module": "components/popover/popover.component.js"
|
|
19218
|
+
}
|
|
19219
|
+
},
|
|
19177
19220
|
{
|
|
19178
19221
|
"kind": "field",
|
|
19179
19222
|
"name": "hideOnBlur",
|
|
@@ -19450,7 +19493,7 @@
|
|
|
19450
19493
|
"kind": "field",
|
|
19451
19494
|
"name": "onEscapeKeydown",
|
|
19452
19495
|
"privacy": "private",
|
|
19453
|
-
"description": "Handles the escape keydown event to close the popover.",
|
|
19496
|
+
"description": "Handles the escape keydown event to close the popover.\n\nThis method is attached to the document.",
|
|
19454
19497
|
"parameters": [
|
|
19455
19498
|
{
|
|
19456
19499
|
"description": "The keyboard event.",
|
|
@@ -19617,7 +19660,7 @@
|
|
|
19617
19660
|
"text": "boolean"
|
|
19618
19661
|
},
|
|
19619
19662
|
"default": "true",
|
|
19620
|
-
"description": "Determines whether focus should wrap around when reaching the first or last focusable element.\nIf true, focus will cycle from end to start and vice versa.\n\nThis only applies when `
|
|
19663
|
+
"description": "Determines whether focus should wrap around when reaching the first or last focusable element.\nIf true, focus will cycle from end to start and vice versa.\n\nThis only applies when `focusTrap` is true.",
|
|
19621
19664
|
"fieldName": "shouldFocusTrapWrap",
|
|
19622
19665
|
"inheritedFrom": {
|
|
19623
19666
|
"name": "FocusTrapMixin",
|
|
@@ -19819,6 +19862,19 @@
|
|
|
19819
19862
|
"module": "src/components/popover/popover.component.ts"
|
|
19820
19863
|
}
|
|
19821
19864
|
},
|
|
19865
|
+
{
|
|
19866
|
+
"name": "propagate-event-on-escape",
|
|
19867
|
+
"type": {
|
|
19868
|
+
"text": "boolean"
|
|
19869
|
+
},
|
|
19870
|
+
"description": "Propagates the event, when the escape key is pressed (only when pressed inside the popover)\nIf true, the escape key press close the popover and will propagate the keydown event.\nIf false, the escape key press will close the popover but will not propagate the keydown event.\n(set to false to prevent the event from bubbling up to the document).\n\nThis only works when `hideOnEscape` is true.",
|
|
19871
|
+
"default": "false",
|
|
19872
|
+
"fieldName": "propagateEventOnEscape",
|
|
19873
|
+
"inheritedFrom": {
|
|
19874
|
+
"name": "Popover",
|
|
19875
|
+
"module": "src/components/popover/popover.component.ts"
|
|
19876
|
+
}
|
|
19877
|
+
},
|
|
19822
19878
|
{
|
|
19823
19879
|
"name": "hide-on-blur",
|
|
19824
19880
|
"type": {
|
|
@@ -23084,6 +23140,17 @@
|
|
|
23084
23140
|
"attribute": "hide-on-escape",
|
|
23085
23141
|
"reflects": true
|
|
23086
23142
|
},
|
|
23143
|
+
{
|
|
23144
|
+
"kind": "field",
|
|
23145
|
+
"name": "propagateEventOnEscape",
|
|
23146
|
+
"type": {
|
|
23147
|
+
"text": "boolean"
|
|
23148
|
+
},
|
|
23149
|
+
"description": "Propagates the event, when the escape key is pressed (only when pressed inside the popover)\nIf true, the escape key press close the popover and will propagate the keydown event.\nIf false, the escape key press will close the popover but will not propagate the keydown event.\n(set to false to prevent the event from bubbling up to the document).\n\nThis only works when `hideOnEscape` is true.",
|
|
23150
|
+
"default": "false",
|
|
23151
|
+
"attribute": "propagate-event-on-escape",
|
|
23152
|
+
"reflects": true
|
|
23153
|
+
},
|
|
23087
23154
|
{
|
|
23088
23155
|
"kind": "field",
|
|
23089
23156
|
"name": "hideOnBlur",
|
|
@@ -23284,7 +23351,7 @@
|
|
|
23284
23351
|
"kind": "field",
|
|
23285
23352
|
"name": "onEscapeKeydown",
|
|
23286
23353
|
"privacy": "private",
|
|
23287
|
-
"description": "Handles the escape keydown event to close the popover.",
|
|
23354
|
+
"description": "Handles the escape keydown event to close the popover.\n\nThis method is attached to the document.",
|
|
23288
23355
|
"parameters": [
|
|
23289
23356
|
{
|
|
23290
23357
|
"description": "The keyboard event.",
|
|
@@ -23380,7 +23447,7 @@
|
|
|
23380
23447
|
"text": "boolean"
|
|
23381
23448
|
},
|
|
23382
23449
|
"default": "true",
|
|
23383
|
-
"description": "Determines whether focus should wrap around when reaching the first or last focusable element.\nIf true, focus will cycle from end to start and vice versa.\n\nThis only applies when `
|
|
23450
|
+
"description": "Determines whether focus should wrap around when reaching the first or last focusable element.\nIf true, focus will cycle from end to start and vice versa.\n\nThis only applies when `focusTrap` is true.",
|
|
23384
23451
|
"attribute": "should-focus-trap-wrap",
|
|
23385
23452
|
"reflects": true,
|
|
23386
23453
|
"inheritedFrom": {
|
|
@@ -23664,7 +23731,7 @@
|
|
|
23664
23731
|
"description": "The set of focusable elements."
|
|
23665
23732
|
}
|
|
23666
23733
|
],
|
|
23667
|
-
"description": "Recursively finds all focusable elements within the given root and its descendants.",
|
|
23734
|
+
"description": "Recursively finds all focusable elements within the given root and its descendants.\n\nMake sure this is performant, as it will be called multiple times.",
|
|
23668
23735
|
"inheritedFrom": {
|
|
23669
23736
|
"name": "FocusTrapMixin",
|
|
23670
23737
|
"module": "utils/mixins/FocusTrapMixin.js"
|
|
@@ -23673,7 +23740,7 @@
|
|
|
23673
23740
|
{
|
|
23674
23741
|
"kind": "method",
|
|
23675
23742
|
"name": "setFocusableElements",
|
|
23676
|
-
"privacy": "
|
|
23743
|
+
"privacy": "private",
|
|
23677
23744
|
"description": "Updates the list of focusable elements within the component's shadow root.",
|
|
23678
23745
|
"inheritedFrom": {
|
|
23679
23746
|
"name": "FocusTrapMixin",
|
|
@@ -23989,6 +24056,15 @@
|
|
|
23989
24056
|
"default": "false",
|
|
23990
24057
|
"fieldName": "hideOnEscape"
|
|
23991
24058
|
},
|
|
24059
|
+
{
|
|
24060
|
+
"name": "propagate-event-on-escape",
|
|
24061
|
+
"type": {
|
|
24062
|
+
"text": "boolean"
|
|
24063
|
+
},
|
|
24064
|
+
"description": "Propagates the event, when the escape key is pressed (only when pressed inside the popover)\nIf true, the escape key press close the popover and will propagate the keydown event.\nIf false, the escape key press will close the popover but will not propagate the keydown event.\n(set to false to prevent the event from bubbling up to the document).\n\nThis only works when `hideOnEscape` is true.",
|
|
24065
|
+
"default": "false",
|
|
24066
|
+
"fieldName": "propagateEventOnEscape"
|
|
24067
|
+
},
|
|
23992
24068
|
{
|
|
23993
24069
|
"name": "hide-on-blur",
|
|
23994
24070
|
"type": {
|
|
@@ -24121,7 +24197,7 @@
|
|
|
24121
24197
|
"text": "boolean"
|
|
24122
24198
|
},
|
|
24123
24199
|
"default": "true",
|
|
24124
|
-
"description": "Determines whether focus should wrap around when reaching the first or last focusable element.\nIf true, focus will cycle from end to start and vice versa.\n\nThis only applies when `
|
|
24200
|
+
"description": "Determines whether focus should wrap around when reaching the first or last focusable element.\nIf true, focus will cycle from end to start and vice versa.\n\nThis only applies when `focusTrap` is true.",
|
|
24125
24201
|
"fieldName": "shouldFocusTrapWrap",
|
|
24126
24202
|
"inheritedFrom": {
|
|
24127
24203
|
"name": "FocusTrapMixin",
|
|
@@ -32752,7 +32828,7 @@
|
|
|
32752
32828
|
"text": "boolean"
|
|
32753
32829
|
},
|
|
32754
32830
|
"default": "true",
|
|
32755
|
-
"description": "Determines whether focus should wrap around when reaching the first or last focusable element.\nIf true, focus will cycle from end to start and vice versa.\n\nThis only applies when `
|
|
32831
|
+
"description": "Determines whether focus should wrap around when reaching the first or last focusable element.\nIf true, focus will cycle from end to start and vice versa.\n\nThis only applies when `focusTrap` is true.",
|
|
32756
32832
|
"attribute": "should-focus-trap-wrap",
|
|
32757
32833
|
"reflects": true,
|
|
32758
32834
|
"inheritedFrom": {
|
|
@@ -33036,7 +33112,7 @@
|
|
|
33036
33112
|
"description": "The set of focusable elements."
|
|
33037
33113
|
}
|
|
33038
33114
|
],
|
|
33039
|
-
"description": "Recursively finds all focusable elements within the given root and its descendants.",
|
|
33115
|
+
"description": "Recursively finds all focusable elements within the given root and its descendants.\n\nMake sure this is performant, as it will be called multiple times.",
|
|
33040
33116
|
"inheritedFrom": {
|
|
33041
33117
|
"name": "Popover",
|
|
33042
33118
|
"module": "components/popover/popover.component.js"
|
|
@@ -33045,7 +33121,7 @@
|
|
|
33045
33121
|
{
|
|
33046
33122
|
"kind": "method",
|
|
33047
33123
|
"name": "setFocusableElements",
|
|
33048
|
-
"privacy": "
|
|
33124
|
+
"privacy": "private",
|
|
33049
33125
|
"description": "Updates the list of focusable elements within the component's shadow root.",
|
|
33050
33126
|
"inheritedFrom": {
|
|
33051
33127
|
"name": "Popover",
|
|
@@ -33406,6 +33482,21 @@
|
|
|
33406
33482
|
"module": "components/popover/popover.component.js"
|
|
33407
33483
|
}
|
|
33408
33484
|
},
|
|
33485
|
+
{
|
|
33486
|
+
"kind": "field",
|
|
33487
|
+
"name": "propagateEventOnEscape",
|
|
33488
|
+
"type": {
|
|
33489
|
+
"text": "boolean"
|
|
33490
|
+
},
|
|
33491
|
+
"description": "Propagates the event, when the escape key is pressed (only when pressed inside the popover)\nIf true, the escape key press close the popover and will propagate the keydown event.\nIf false, the escape key press will close the popover but will not propagate the keydown event.\n(set to false to prevent the event from bubbling up to the document).\n\nThis only works when `hideOnEscape` is true.",
|
|
33492
|
+
"default": "false",
|
|
33493
|
+
"attribute": "propagate-event-on-escape",
|
|
33494
|
+
"reflects": true,
|
|
33495
|
+
"inheritedFrom": {
|
|
33496
|
+
"name": "Popover",
|
|
33497
|
+
"module": "components/popover/popover.component.js"
|
|
33498
|
+
}
|
|
33499
|
+
},
|
|
33409
33500
|
{
|
|
33410
33501
|
"kind": "field",
|
|
33411
33502
|
"name": "hideOnBlur",
|
|
@@ -33682,7 +33773,7 @@
|
|
|
33682
33773
|
"kind": "field",
|
|
33683
33774
|
"name": "onEscapeKeydown",
|
|
33684
33775
|
"privacy": "private",
|
|
33685
|
-
"description": "Handles the escape keydown event to close the popover.",
|
|
33776
|
+
"description": "Handles the escape keydown event to close the popover.\n\nThis method is attached to the document.",
|
|
33686
33777
|
"parameters": [
|
|
33687
33778
|
{
|
|
33688
33779
|
"description": "The keyboard event.",
|
|
@@ -33869,7 +33960,7 @@
|
|
|
33869
33960
|
"text": "boolean"
|
|
33870
33961
|
},
|
|
33871
33962
|
"default": "true",
|
|
33872
|
-
"description": "Determines whether focus should wrap around when reaching the first or last focusable element.\nIf true, focus will cycle from end to start and vice versa.\n\nThis only applies when `
|
|
33963
|
+
"description": "Determines whether focus should wrap around when reaching the first or last focusable element.\nIf true, focus will cycle from end to start and vice versa.\n\nThis only applies when `focusTrap` is true.",
|
|
33873
33964
|
"fieldName": "shouldFocusTrapWrap",
|
|
33874
33965
|
"inheritedFrom": {
|
|
33875
33966
|
"name": "Popover",
|
|
@@ -34071,6 +34162,19 @@
|
|
|
34071
34162
|
"module": "src/components/popover/popover.component.ts"
|
|
34072
34163
|
}
|
|
34073
34164
|
},
|
|
34165
|
+
{
|
|
34166
|
+
"name": "propagate-event-on-escape",
|
|
34167
|
+
"type": {
|
|
34168
|
+
"text": "boolean"
|
|
34169
|
+
},
|
|
34170
|
+
"description": "Propagates the event, when the escape key is pressed (only when pressed inside the popover)\nIf true, the escape key press close the popover and will propagate the keydown event.\nIf false, the escape key press will close the popover but will not propagate the keydown event.\n(set to false to prevent the event from bubbling up to the document).\n\nThis only works when `hideOnEscape` is true.",
|
|
34171
|
+
"default": "false",
|
|
34172
|
+
"fieldName": "propagateEventOnEscape",
|
|
34173
|
+
"inheritedFrom": {
|
|
34174
|
+
"name": "Popover",
|
|
34175
|
+
"module": "src/components/popover/popover.component.ts"
|
|
34176
|
+
}
|
|
34177
|
+
},
|
|
34074
34178
|
{
|
|
34075
34179
|
"name": "hide-on-blur",
|
|
34076
34180
|
"type": {
|
|
@@ -34495,7 +34599,7 @@
|
|
|
34495
34599
|
"text": "boolean"
|
|
34496
34600
|
},
|
|
34497
34601
|
"default": "true",
|
|
34498
|
-
"description": "Determines whether focus should wrap around when reaching the first or last focusable element.\nIf true, focus will cycle from end to start and vice versa.\n\nThis only applies when `
|
|
34602
|
+
"description": "Determines whether focus should wrap around when reaching the first or last focusable element.\nIf true, focus will cycle from end to start and vice versa.\n\nThis only applies when `focusTrap` is true.",
|
|
34499
34603
|
"attribute": "should-focus-trap-wrap",
|
|
34500
34604
|
"reflects": true,
|
|
34501
34605
|
"inheritedFrom": {
|
|
@@ -34779,7 +34883,7 @@
|
|
|
34779
34883
|
"description": "The set of focusable elements."
|
|
34780
34884
|
}
|
|
34781
34885
|
],
|
|
34782
|
-
"description": "Recursively finds all focusable elements within the given root and its descendants.",
|
|
34886
|
+
"description": "Recursively finds all focusable elements within the given root and its descendants.\n\nMake sure this is performant, as it will be called multiple times.",
|
|
34783
34887
|
"inheritedFrom": {
|
|
34784
34888
|
"name": "Popover",
|
|
34785
34889
|
"module": "components/popover/popover.component.js"
|
|
@@ -34788,7 +34892,7 @@
|
|
|
34788
34892
|
{
|
|
34789
34893
|
"kind": "method",
|
|
34790
34894
|
"name": "setFocusableElements",
|
|
34791
|
-
"privacy": "
|
|
34895
|
+
"privacy": "private",
|
|
34792
34896
|
"description": "Updates the list of focusable elements within the component's shadow root.",
|
|
34793
34897
|
"inheritedFrom": {
|
|
34794
34898
|
"name": "Popover",
|
|
@@ -35149,6 +35253,21 @@
|
|
|
35149
35253
|
"module": "components/popover/popover.component.js"
|
|
35150
35254
|
}
|
|
35151
35255
|
},
|
|
35256
|
+
{
|
|
35257
|
+
"kind": "field",
|
|
35258
|
+
"name": "propagateEventOnEscape",
|
|
35259
|
+
"type": {
|
|
35260
|
+
"text": "boolean"
|
|
35261
|
+
},
|
|
35262
|
+
"description": "Propagates the event, when the escape key is pressed (only when pressed inside the popover)\nIf true, the escape key press close the popover and will propagate the keydown event.\nIf false, the escape key press will close the popover but will not propagate the keydown event.\n(set to false to prevent the event from bubbling up to the document).\n\nThis only works when `hideOnEscape` is true.",
|
|
35263
|
+
"default": "false",
|
|
35264
|
+
"attribute": "propagate-event-on-escape",
|
|
35265
|
+
"reflects": true,
|
|
35266
|
+
"inheritedFrom": {
|
|
35267
|
+
"name": "Popover",
|
|
35268
|
+
"module": "components/popover/popover.component.js"
|
|
35269
|
+
}
|
|
35270
|
+
},
|
|
35152
35271
|
{
|
|
35153
35272
|
"kind": "field",
|
|
35154
35273
|
"name": "hideOnBlur",
|
|
@@ -35425,7 +35544,7 @@
|
|
|
35425
35544
|
"kind": "field",
|
|
35426
35545
|
"name": "onEscapeKeydown",
|
|
35427
35546
|
"privacy": "private",
|
|
35428
|
-
"description": "Handles the escape keydown event to close the popover.",
|
|
35547
|
+
"description": "Handles the escape keydown event to close the popover.\n\nThis method is attached to the document.",
|
|
35429
35548
|
"parameters": [
|
|
35430
35549
|
{
|
|
35431
35550
|
"description": "The keyboard event.",
|
|
@@ -35613,7 +35732,7 @@
|
|
|
35613
35732
|
"text": "boolean"
|
|
35614
35733
|
},
|
|
35615
35734
|
"default": "true",
|
|
35616
|
-
"description": "Determines whether focus should wrap around when reaching the first or last focusable element.\nIf true, focus will cycle from end to start and vice versa.\n\nThis only applies when `
|
|
35735
|
+
"description": "Determines whether focus should wrap around when reaching the first or last focusable element.\nIf true, focus will cycle from end to start and vice versa.\n\nThis only applies when `focusTrap` is true.",
|
|
35617
35736
|
"fieldName": "shouldFocusTrapWrap",
|
|
35618
35737
|
"inheritedFrom": {
|
|
35619
35738
|
"name": "Popover",
|
|
@@ -35815,6 +35934,19 @@
|
|
|
35815
35934
|
"module": "src/components/popover/popover.component.ts"
|
|
35816
35935
|
}
|
|
35817
35936
|
},
|
|
35937
|
+
{
|
|
35938
|
+
"name": "propagate-event-on-escape",
|
|
35939
|
+
"type": {
|
|
35940
|
+
"text": "boolean"
|
|
35941
|
+
},
|
|
35942
|
+
"description": "Propagates the event, when the escape key is pressed (only when pressed inside the popover)\nIf true, the escape key press close the popover and will propagate the keydown event.\nIf false, the escape key press will close the popover but will not propagate the keydown event.\n(set to false to prevent the event from bubbling up to the document).\n\nThis only works when `hideOnEscape` is true.",
|
|
35943
|
+
"default": "false",
|
|
35944
|
+
"fieldName": "propagateEventOnEscape",
|
|
35945
|
+
"inheritedFrom": {
|
|
35946
|
+
"name": "Popover",
|
|
35947
|
+
"module": "src/components/popover/popover.component.ts"
|
|
35948
|
+
}
|
|
35949
|
+
},
|
|
35818
35950
|
{
|
|
35819
35951
|
"name": "hide-on-blur",
|
|
35820
35952
|
"type": {
|
|
@@ -37304,7 +37436,7 @@
|
|
|
37304
37436
|
"text": "boolean"
|
|
37305
37437
|
},
|
|
37306
37438
|
"default": "true",
|
|
37307
|
-
"description": "Determines whether focus should wrap around when reaching the first or last focusable element.\nIf true, focus will cycle from end to start and vice versa.\n\nThis only applies when `
|
|
37439
|
+
"description": "Determines whether focus should wrap around when reaching the first or last focusable element.\nIf true, focus will cycle from end to start and vice versa.\n\nThis only applies when `focusTrap` is true.",
|
|
37308
37440
|
"attribute": "should-focus-trap-wrap",
|
|
37309
37441
|
"reflects": true
|
|
37310
37442
|
},
|
|
@@ -37536,12 +37668,12 @@
|
|
|
37536
37668
|
"description": "The set of focusable elements."
|
|
37537
37669
|
}
|
|
37538
37670
|
],
|
|
37539
|
-
"description": "Recursively finds all focusable elements within the given root and its descendants."
|
|
37671
|
+
"description": "Recursively finds all focusable elements within the given root and its descendants.\n\nMake sure this is performant, as it will be called multiple times."
|
|
37540
37672
|
},
|
|
37541
37673
|
{
|
|
37542
37674
|
"kind": "method",
|
|
37543
37675
|
"name": "setFocusableElements",
|
|
37544
|
-
"privacy": "
|
|
37676
|
+
"privacy": "private",
|
|
37545
37677
|
"description": "Updates the list of focusable elements within the component's shadow root."
|
|
37546
37678
|
},
|
|
37547
37679
|
{
|
|
@@ -37683,7 +37815,7 @@
|
|
|
37683
37815
|
"text": "boolean"
|
|
37684
37816
|
},
|
|
37685
37817
|
"default": "true",
|
|
37686
|
-
"description": "Determines whether focus should wrap around when reaching the first or last focusable element.\nIf true, focus will cycle from end to start and vice versa.\n\nThis only applies when `
|
|
37818
|
+
"description": "Determines whether focus should wrap around when reaching the first or last focusable element.\nIf true, focus will cycle from end to start and vice versa.\n\nThis only applies when `focusTrap` is true.",
|
|
37687
37819
|
"fieldName": "shouldFocusTrapWrap"
|
|
37688
37820
|
},
|
|
37689
37821
|
{
|