@momentum-design/components 0.27.3 → 0.27.5
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 +15 -15
- package/dist/browser/index.js.map +3 -3
- package/dist/components/avatarbutton/avatarbutton.component.d.ts +5 -0
- package/dist/components/avatarbutton/avatarbutton.component.js +5 -0
- package/dist/components/button/button.component.d.ts +5 -0
- package/dist/components/button/button.component.js +26 -17
- package/dist/components/buttonsimple/buttonsimple.component.d.ts +5 -0
- package/dist/components/buttonsimple/buttonsimple.component.js +5 -0
- package/dist/components/checkbox/checkbox.component.d.ts +3 -0
- package/dist/components/checkbox/checkbox.component.js +3 -0
- package/dist/components/input/input.component.d.ts +5 -0
- package/dist/components/input/input.component.js +5 -0
- package/dist/components/radio/radio.component.d.ts +3 -0
- package/dist/components/radio/radio.component.js +3 -0
- package/dist/components/tab/tab.component.d.ts +5 -0
- package/dist/components/tab/tab.component.js +5 -0
- package/dist/components/toggle/toggle.component.d.ts +3 -0
- package/dist/components/toggle/toggle.component.js +3 -0
- package/dist/components/virtualizedlist/virtualizedlist.component.d.ts +2 -0
- package/dist/components/virtualizedlist/virtualizedlist.component.js +2 -0
- package/dist/custom-elements.json +1052 -832
- package/dist/react/avatarbutton/index.d.ts +11 -1
- package/dist/react/avatarbutton/index.js +11 -1
- package/dist/react/button/index.d.ts +11 -1
- package/dist/react/button/index.js +11 -1
- package/dist/react/buttonsimple/index.d.ts +11 -1
- package/dist/react/buttonsimple/index.js +11 -1
- package/dist/react/checkbox/index.d.ts +8 -1
- package/dist/react/checkbox/index.js +8 -1
- package/dist/react/index.d.ts +1 -1
- package/dist/react/index.js +1 -1
- package/dist/react/input/index.d.ts +12 -1
- package/dist/react/input/index.js +12 -1
- package/dist/react/radio/index.d.ts +8 -1
- package/dist/react/radio/index.js +8 -1
- package/dist/react/tab/index.d.ts +11 -1
- package/dist/react/tab/index.js +11 -1
- package/dist/react/toggle/index.d.ts +8 -1
- package/dist/react/toggle/index.js +8 -1
- package/dist/react/virtualizedlist/index.d.ts +5 -1
- package/dist/react/virtualizedlist/index.js +5 -1
- package/package.json +1 -1
@@ -596,6 +596,48 @@
|
|
596
596
|
}
|
597
597
|
}
|
598
598
|
],
|
599
|
+
"events": [
|
600
|
+
{
|
601
|
+
"description": "(React: onClick) This event is dispatched when the avatarbutton is clicked.",
|
602
|
+
"name": "click",
|
603
|
+
"reactName": "onClick",
|
604
|
+
"eventName": "ClickEvent",
|
605
|
+
"inheritedFrom": {
|
606
|
+
"name": "Buttonsimple",
|
607
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
608
|
+
}
|
609
|
+
},
|
610
|
+
{
|
611
|
+
"description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the avatarbutton.",
|
612
|
+
"name": "keydown",
|
613
|
+
"reactName": "onKeyDown",
|
614
|
+
"eventName": "KeydownEvent",
|
615
|
+
"inheritedFrom": {
|
616
|
+
"name": "Buttonsimple",
|
617
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
618
|
+
}
|
619
|
+
},
|
620
|
+
{
|
621
|
+
"description": "(React: onKeyUp) This event is dispatched when a key is released on the avatarbutton.",
|
622
|
+
"name": "keyup",
|
623
|
+
"reactName": "onKeyUp",
|
624
|
+
"eventName": "KeyupEvent",
|
625
|
+
"inheritedFrom": {
|
626
|
+
"name": "Buttonsimple",
|
627
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
628
|
+
}
|
629
|
+
},
|
630
|
+
{
|
631
|
+
"description": "(React: onFocus) This event is dispatched when the avatarbutton receives focus.",
|
632
|
+
"name": "focus",
|
633
|
+
"reactName": "onFocus",
|
634
|
+
"eventName": "FocusEvent",
|
635
|
+
"inheritedFrom": {
|
636
|
+
"name": "Buttonsimple",
|
637
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
638
|
+
}
|
639
|
+
}
|
640
|
+
],
|
599
641
|
"attributes": [
|
600
642
|
{
|
601
643
|
"name": "aria-label",
|
@@ -783,7 +825,7 @@
|
|
783
825
|
"module": "/src/components/buttonsimple/buttonsimple.component"
|
784
826
|
},
|
785
827
|
"tagName": "mdc-avatarbutton",
|
786
|
-
"jsDoc": "/**\n * The `mdc-avatarbutton` component is an interactable version of the `mdc-avatar` component.\n *\n * This component is made by extending `buttonsimple` class.\n * The button component acts as a wrapper for the avatar component.\n *\n * @dependency mdc-avatar\n *\n * @tagname mdc-avatarbutton\n */",
|
828
|
+
"jsDoc": "/**\n * The `mdc-avatarbutton` component is an interactable version of the `mdc-avatar` component.\n *\n * This component is made by extending `buttonsimple` class.\n * The button component acts as a wrapper for the avatar component.\n *\n * @dependency mdc-avatar\n *\n * @event click - (React: onClick) This event is dispatched when the avatarbutton is clicked.\n * @event keydown - (React: onKeyDown) This event is dispatched when a key is pressed down on the avatarbutton.\n * @event keyup - (React: onKeyUp) This event is dispatched when a key is released on the avatarbutton.\n * @event focus - (React: onFocus) This event is dispatched when the avatarbutton receives focus.\n *\n * @tagname mdc-avatarbutton\n */",
|
787
829
|
"customElement": true
|
788
830
|
}
|
789
831
|
],
|
@@ -1192,33 +1234,48 @@
|
|
1192
1234
|
},
|
1193
1235
|
{
|
1194
1236
|
"kind": "javascript-module",
|
1195
|
-
"path": "components/
|
1237
|
+
"path": "components/button/button.component.js",
|
1196
1238
|
"declarations": [
|
1197
1239
|
{
|
1198
1240
|
"kind": "class",
|
1199
|
-
"description": "`mdc-
|
1200
|
-
"name": "
|
1241
|
+
"description": "`mdc-button` is a component that can be configured in various ways to suit different use cases.\n\nButton Variants:\n- **Primary**: Solid background color.\n- **Secondary**: Transparent background with a solid border.\n- **Tertiary**: No background or border, appears as plain text but retains all button functionalities.\n\nButton Colors:\n- **Positive**: Green color.\n- **Negative**: Red color.\n- **Accent**: Blue color.\n- **Promotional**: Purple color.\n- **Default**: White color.\n\nButton Sizes (in REM units):\n- **Pill button**: 40, 32, 28, 24.\n- **Icon button**: 64, 52, 40, 32, 28, 24.\n- **Tertiary icon button**: 20.\n\nButton Types:\n- **Pill button**: A button that contains text value. Commonly used for call to action, tags, or filters.\n- **Pill button with icons**: A button containing an icon either on the left or right side of the button.\n- **Icon button**: A button represented by just an icon without any text.\nThe type of button is inferred based on the presence of slot and/or prefix and postfix icons.",
|
1242
|
+
"name": "Button",
|
1243
|
+
"slots": [
|
1244
|
+
{
|
1245
|
+
"description": "Text label of the button.",
|
1246
|
+
"name": ""
|
1247
|
+
}
|
1248
|
+
],
|
1201
1249
|
"members": [
|
1202
1250
|
{
|
1203
1251
|
"kind": "field",
|
1204
|
-
"name": "
|
1252
|
+
"name": "prefixIcon",
|
1205
1253
|
"type": {
|
1206
|
-
"text": "
|
1254
|
+
"text": "string | undefined"
|
1207
1255
|
},
|
1208
|
-
"
|
1209
|
-
"
|
1210
|
-
"attribute": "active",
|
1256
|
+
"description": "The name of the icon to display as a prefix.\nThe icon is displayed on the left side of the button.",
|
1257
|
+
"attribute": "prefix-icon",
|
1211
1258
|
"reflects": true
|
1212
1259
|
},
|
1213
1260
|
{
|
1214
1261
|
"kind": "field",
|
1215
|
-
"name": "
|
1262
|
+
"name": "postfixIcon",
|
1216
1263
|
"type": {
|
1217
|
-
"text": "
|
1264
|
+
"text": "string | undefined"
|
1218
1265
|
},
|
1219
|
-
"
|
1220
|
-
"
|
1221
|
-
"
|
1266
|
+
"description": "The name of the icon to display as a postfix.\nThe icon is displayed on the right side of the button.",
|
1267
|
+
"attribute": "postfix-icon",
|
1268
|
+
"reflects": true
|
1269
|
+
},
|
1270
|
+
{
|
1271
|
+
"kind": "field",
|
1272
|
+
"name": "variant",
|
1273
|
+
"type": {
|
1274
|
+
"text": "ButtonVariant"
|
1275
|
+
},
|
1276
|
+
"description": "There are 3 variants of button: primary, secondary, tertiary. They are styled differently.\n- **Primary**: Solid background color.\n- **Secondary**: Transparent background with a solid border.\n- **Tertiary**: No background or border, appears as plain text but retains all button functionalities.",
|
1277
|
+
"default": "primary",
|
1278
|
+
"attribute": "variant"
|
1222
1279
|
},
|
1223
1280
|
{
|
1224
1281
|
"kind": "field",
|
@@ -1226,135 +1283,111 @@
|
|
1226
1283
|
"type": {
|
1227
1284
|
"text": "ButtonSize"
|
1228
1285
|
},
|
1229
|
-
"description": "
|
1286
|
+
"description": "Button sizing is based on the button type.\n- **Pill button**: 40, 32, 28, 24.\n- **Icon button**: 64, 52, 40, 32, 28, 24.\n- Tertiary icon button can also be 20.",
|
1230
1287
|
"default": "32",
|
1231
1288
|
"attribute": "size",
|
1232
|
-
"reflects": true
|
1289
|
+
"reflects": true,
|
1290
|
+
"inheritedFrom": {
|
1291
|
+
"name": "Buttonsimple",
|
1292
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
1293
|
+
}
|
1233
1294
|
},
|
1234
1295
|
{
|
1235
1296
|
"kind": "field",
|
1236
|
-
"name": "
|
1237
|
-
"
|
1238
|
-
|
1239
|
-
|
1240
|
-
"
|
1297
|
+
"name": "color",
|
1298
|
+
"type": {
|
1299
|
+
"text": "ButtonColor"
|
1300
|
+
},
|
1301
|
+
"description": "There are 5 colors for button: positive, negative, accent, promotional, default.",
|
1302
|
+
"default": "default",
|
1303
|
+
"attribute": "color"
|
1241
1304
|
},
|
1242
1305
|
{
|
1243
1306
|
"kind": "field",
|
1244
|
-
"name": "
|
1307
|
+
"name": "role",
|
1308
|
+
"description": "This property defines the ARIA role for the element. By default, it is set to 'button'.\nConsumers should override this role when:\n- The element is being used in a context where a different role is more appropriate.\n- Custom behaviors are implemented that require a specific ARIA role for accessibility purposes.",
|
1309
|
+
"default": "'button'",
|
1310
|
+
"attribute": "role",
|
1311
|
+
"reflects": true,
|
1245
1312
|
"type": {
|
1246
|
-
"text": "
|
1313
|
+
"text": "string"
|
1247
1314
|
},
|
1248
|
-
"
|
1249
|
-
|
1250
|
-
|
1251
|
-
|
1252
|
-
},
|
1253
|
-
{
|
1254
|
-
"kind": "method",
|
1255
|
-
"name": "executeAction",
|
1256
|
-
"privacy": "protected"
|
1315
|
+
"inheritedFrom": {
|
1316
|
+
"name": "Buttonsimple",
|
1317
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
1318
|
+
}
|
1257
1319
|
},
|
1258
1320
|
{
|
1259
1321
|
"kind": "method",
|
1260
|
-
"name": "
|
1261
|
-
"privacy": "
|
1322
|
+
"name": "modifyIconName",
|
1323
|
+
"privacy": "private",
|
1262
1324
|
"parameters": [
|
1263
|
-
{
|
1264
|
-
"name": "element",
|
1265
|
-
"type": {
|
1266
|
-
"text": "HTMLElement"
|
1267
|
-
},
|
1268
|
-
"description": "The button element"
|
1269
|
-
},
|
1270
1325
|
{
|
1271
1326
|
"name": "active",
|
1272
1327
|
"type": {
|
1273
1328
|
"text": "boolean"
|
1274
1329
|
},
|
1275
|
-
"description": "The active state
|
1330
|
+
"description": "The active state."
|
1276
1331
|
}
|
1277
1332
|
],
|
1278
|
-
"description": "
|
1333
|
+
"description": "Modifies the icon name based on the active state.\nIf the button is active, the icon name is suffixed with '-filled'.\nIf the button is inactive, the icon name is restored to its original value.\nIf '-filled' icon is not available, the icon name remains unchanged."
|
1279
1334
|
},
|
1280
1335
|
{
|
1281
1336
|
"kind": "method",
|
1282
|
-
"name": "
|
1337
|
+
"name": "setVariant",
|
1283
1338
|
"privacy": "private",
|
1284
1339
|
"parameters": [
|
1285
1340
|
{
|
1286
|
-
"name": "
|
1287
|
-
"type": {
|
1288
|
-
"text": "HTMLElement"
|
1289
|
-
},
|
1290
|
-
"description": "The button element."
|
1291
|
-
},
|
1292
|
-
{
|
1293
|
-
"name": "softDisabled",
|
1341
|
+
"name": "variant",
|
1294
1342
|
"type": {
|
1295
|
-
"text": "
|
1343
|
+
"text": "ButtonVariant"
|
1296
1344
|
},
|
1297
|
-
"description": "The
|
1345
|
+
"description": "The variant to set."
|
1298
1346
|
}
|
1299
1347
|
],
|
1300
|
-
"description": "Sets the
|
1348
|
+
"description": "Sets the variant attribute for the button component.\nIf the provided variant is not included in the BUTTON_VARIANTS,\nit defaults to the value specified in DEFAULTS.VARIANT."
|
1301
1349
|
},
|
1302
1350
|
{
|
1303
1351
|
"kind": "method",
|
1304
|
-
"name": "
|
1352
|
+
"name": "setSize",
|
1305
1353
|
"privacy": "private",
|
1306
1354
|
"parameters": [
|
1307
1355
|
{
|
1308
|
-
"name": "
|
1309
|
-
"type": {
|
1310
|
-
"text": "HTMLElement"
|
1311
|
-
},
|
1312
|
-
"description": "The button element."
|
1313
|
-
},
|
1314
|
-
{
|
1315
|
-
"name": "disabled",
|
1356
|
+
"name": "size",
|
1316
1357
|
"type": {
|
1317
|
-
"text": "
|
1358
|
+
"text": "PillButtonSize | IconButtonSize"
|
1318
1359
|
},
|
1319
|
-
"description": "The
|
1360
|
+
"description": "The size to set."
|
1320
1361
|
}
|
1321
1362
|
],
|
1322
|
-
"description": "Sets the
|
1323
|
-
},
|
1324
|
-
{
|
1325
|
-
"kind": "method",
|
1326
|
-
"name": "triggerClickEvent",
|
1327
|
-
"privacy": "private"
|
1363
|
+
"description": "Sets the size attribute for the button component.\nValidates the size based on the button type (icon, pill, or tertiary).\nDefaults to DEFAULTS.SIZE if invalid."
|
1328
1364
|
},
|
1329
1365
|
{
|
1330
1366
|
"kind": "method",
|
1331
|
-
"name": "
|
1367
|
+
"name": "setColor",
|
1332
1368
|
"privacy": "private",
|
1333
1369
|
"parameters": [
|
1334
1370
|
{
|
1335
|
-
"name": "
|
1371
|
+
"name": "color",
|
1336
1372
|
"type": {
|
1337
|
-
"text": "
|
1373
|
+
"text": "ButtonColor"
|
1338
1374
|
},
|
1339
|
-
"description": "The
|
1375
|
+
"description": "The color to set."
|
1340
1376
|
}
|
1341
1377
|
],
|
1342
|
-
"description": "
|
1378
|
+
"description": "Sets the color attribute for the button.\nDefaults to DEFAULTS.COLOR if invalid or for tertiary buttons."
|
1343
1379
|
},
|
1344
1380
|
{
|
1345
1381
|
"kind": "method",
|
1346
|
-
"name": "
|
1382
|
+
"name": "inferButtonType",
|
1347
1383
|
"privacy": "private",
|
1384
|
+
"description": "Infers the type of button based on the presence of slot and/or prefix and postfix icons.",
|
1348
1385
|
"parameters": [
|
1349
1386
|
{
|
1350
|
-
"
|
1351
|
-
"
|
1352
|
-
"text": "KeyboardEvent"
|
1353
|
-
},
|
1354
|
-
"description": "The keyboard event."
|
1387
|
+
"description": "default slot of button",
|
1388
|
+
"name": "slot"
|
1355
1389
|
}
|
1356
|
-
]
|
1357
|
-
"description": "Handles the keyup event on the button.\nIf the key is 'Enter' or 'Space', the button is clicked.\nIf the key is 'Space', the button is pressed. The native HTML button works in the same way."
|
1390
|
+
]
|
1358
1391
|
},
|
1359
1392
|
{
|
1360
1393
|
"kind": "field",
|
@@ -1385,238 +1418,170 @@
|
|
1385
1418
|
"name": "DisabledMixin",
|
1386
1419
|
"module": "utils/mixins/DisabledMixin.js"
|
1387
1420
|
}
|
1388
|
-
}
|
1389
|
-
],
|
1390
|
-
"attributes": [
|
1421
|
+
},
|
1391
1422
|
{
|
1423
|
+
"kind": "field",
|
1392
1424
|
"name": "active",
|
1393
1425
|
"type": {
|
1394
1426
|
"text": "boolean"
|
1395
1427
|
},
|
1396
1428
|
"default": "false",
|
1397
1429
|
"description": "The button's active state indicates whether it is currently toggled on (active) or off (inactive).\nWhen the active state is true, the button is considered to be in an active state, meaning it is toggled on.\nConversely, when the active state is false, the button is in an inactive state, indicating it is toggled off.",
|
1398
|
-
"
|
1430
|
+
"attribute": "active",
|
1431
|
+
"reflects": true,
|
1432
|
+
"inheritedFrom": {
|
1433
|
+
"name": "Buttonsimple",
|
1434
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
1435
|
+
}
|
1399
1436
|
},
|
1400
1437
|
{
|
1401
|
-
"
|
1438
|
+
"kind": "field",
|
1439
|
+
"name": "softDisabled",
|
1402
1440
|
"type": {
|
1403
1441
|
"text": "boolean"
|
1404
1442
|
},
|
1405
1443
|
"default": "false",
|
1406
1444
|
"description": "Indicates whether the button is soft disabled.\nWhen set to `true`, the button appears visually disabled but still allows\nfocus, click, and keyboard actions to be passed through.\n\n**Important:** When using soft disabled, consumers must ensure that\nthe button behaves like a disabled button, allowing only focus and\npreventing any interactions (clicks or keyboard actions) from triggering unintended actions.",
|
1407
|
-
"
|
1408
|
-
|
1409
|
-
|
1410
|
-
|
1411
|
-
|
1412
|
-
"text": "ButtonSize"
|
1413
|
-
},
|
1414
|
-
"description": "Simplebutton size is a super set of all the sizes supported by children components.",
|
1415
|
-
"default": "32",
|
1416
|
-
"fieldName": "size"
|
1417
|
-
},
|
1418
|
-
{
|
1419
|
-
"name": "role",
|
1420
|
-
"description": "This property defines the ARIA role for the element. By default, it is set to 'button'.\nConsumers should override this role when:\n- The element is being used in a context where a different role is more appropriate.\n- Custom behaviors are implemented that require a specific ARIA role for accessibility purposes.",
|
1421
|
-
"default": "button",
|
1422
|
-
"fieldName": "role"
|
1445
|
+
"attribute": "soft-disabled",
|
1446
|
+
"inheritedFrom": {
|
1447
|
+
"name": "Buttonsimple",
|
1448
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
1449
|
+
}
|
1423
1450
|
},
|
1424
1451
|
{
|
1452
|
+
"kind": "field",
|
1425
1453
|
"name": "type",
|
1426
1454
|
"type": {
|
1427
1455
|
"text": "ButtonType"
|
1428
1456
|
},
|
1429
1457
|
"description": "This property defines the type attribute for the button element.\nThe type attribute specifies the behavior of the button when it is clicked.\n- **submit**: The button submits the form data to the server.\n- **reset**: The button resets the form data to its initial state.\n- **button**: The button does nothing when clicked.",
|
1430
1458
|
"default": "button",
|
1431
|
-
"
|
1432
|
-
|
1433
|
-
{
|
1434
|
-
"name": "tabIndex",
|
1435
|
-
"type": {
|
1436
|
-
"text": "number"
|
1437
|
-
},
|
1438
|
-
"default": "0",
|
1439
|
-
"description": "This property specifies the tab order of the element.",
|
1440
|
-
"fieldName": "tabIndex",
|
1459
|
+
"attribute": "type",
|
1460
|
+
"reflects": true,
|
1441
1461
|
"inheritedFrom": {
|
1442
|
-
"name": "
|
1443
|
-
"module": "
|
1462
|
+
"name": "Buttonsimple",
|
1463
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
1444
1464
|
}
|
1445
1465
|
},
|
1446
1466
|
{
|
1447
|
-
"
|
1448
|
-
"
|
1449
|
-
|
1450
|
-
},
|
1451
|
-
"default": "false",
|
1452
|
-
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
1453
|
-
"fieldName": "disabled",
|
1467
|
+
"kind": "method",
|
1468
|
+
"name": "executeAction",
|
1469
|
+
"privacy": "protected",
|
1454
1470
|
"inheritedFrom": {
|
1455
|
-
"name": "
|
1456
|
-
"module": "
|
1471
|
+
"name": "Buttonsimple",
|
1472
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
1457
1473
|
}
|
1458
|
-
}
|
1459
|
-
],
|
1460
|
-
"mixins": [
|
1474
|
+
},
|
1461
1475
|
{
|
1462
|
-
"
|
1463
|
-
"
|
1464
|
-
|
1465
|
-
|
1466
|
-
|
1467
|
-
|
1468
|
-
|
1469
|
-
|
1470
|
-
|
1471
|
-
|
1472
|
-
|
1473
|
-
|
1474
|
-
|
1475
|
-
|
1476
|
-
|
1477
|
-
|
1478
|
-
|
1479
|
-
|
1480
|
-
|
1481
|
-
|
1482
|
-
|
1483
|
-
|
1484
|
-
|
1485
|
-
|
1486
|
-
}
|
1487
|
-
}
|
1488
|
-
]
|
1489
|
-
},
|
1490
|
-
{
|
1491
|
-
"kind": "javascript-module",
|
1492
|
-
"path": "components/checkbox/checkbox.component.js",
|
1493
|
-
"declarations": [
|
1494
|
-
{
|
1495
|
-
"kind": "class",
|
1496
|
-
"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.",
|
1497
|
-
"name": "Checkbox",
|
1498
|
-
"cssProperties": [
|
1499
|
-
{
|
1500
|
-
"description": "Allows customization of the background color on hover.",
|
1501
|
-
"name": "--mdc-checkbox-background-color-hover"
|
1502
|
-
},
|
1503
|
-
{
|
1504
|
-
"description": "Border color in high contrast.",
|
1505
|
-
"name": "--mdc-checkbox-border-color"
|
1506
|
-
},
|
1507
|
-
{
|
1508
|
-
"description": "Background color for a selected checkbox.",
|
1509
|
-
"name": "--mdc-checkbox-checked-background-color"
|
1510
|
-
},
|
1511
|
-
{
|
1512
|
-
"description": "Background color for a selected checkbox when hovered.",
|
1513
|
-
"name": "--mdc-checkbox-checked-background-color-hover"
|
1514
|
-
},
|
1515
|
-
{
|
1516
|
-
"description": "Background color for a selected checkbox when pressed.",
|
1517
|
-
"name": "--mdc-checkbox-checked-pressed-icon-color"
|
1518
|
-
},
|
1519
|
-
{
|
1520
|
-
"description": "Background color for a disabled checkbox.",
|
1521
|
-
"name": "--mdc-checkbox-disabled-background-color"
|
1522
|
-
},
|
1523
|
-
{
|
1524
|
-
"description": "Border color for a disabled checkbox.",
|
1525
|
-
"name": "--mdc-checkbox-disabled-border-color"
|
1526
|
-
},
|
1527
|
-
{
|
1528
|
-
"description": "Background color for a disabled, selected checkbox.",
|
1529
|
-
"name": "--mdc-checkbox-disabled-checked-icon-color"
|
1530
|
-
},
|
1531
|
-
{
|
1532
|
-
"description": "Icon color for a disabled checkbox.",
|
1533
|
-
"name": "--mdc-checkbox-disabled-icon-color"
|
1534
|
-
},
|
1535
|
-
{
|
1536
|
-
"description": "Background color for an unselected checkbox.",
|
1537
|
-
"name": "--mdc-checkbox-icon-background-color"
|
1538
|
-
},
|
1539
|
-
{
|
1540
|
-
"description": "Default background color for an unselected checkbox.",
|
1541
|
-
"name": "--mdc-checkbox-icon-border-color"
|
1542
|
-
},
|
1543
|
-
{
|
1544
|
-
"description": "Icon color for an unselected checkbox.",
|
1545
|
-
"name": "--mdc-checkbox-icon-color"
|
1546
|
-
},
|
1547
|
-
{
|
1548
|
-
"description": "Background color for a selected checkbox when pressed.",
|
1549
|
-
"name": "--mdc-checkbox-pressed-icon-color"
|
1550
|
-
}
|
1551
|
-
],
|
1552
|
-
"members": [
|
1553
|
-
{
|
1554
|
-
"kind": "field",
|
1555
|
-
"name": "checked",
|
1556
|
-
"type": {
|
1557
|
-
"text": "boolean"
|
1558
|
-
},
|
1559
|
-
"default": "false",
|
1560
|
-
"description": "Determines whether the checkbox is selected or unselected.",
|
1561
|
-
"attribute": "checked",
|
1562
|
-
"reflects": true
|
1476
|
+
"kind": "method",
|
1477
|
+
"name": "setActive",
|
1478
|
+
"privacy": "protected",
|
1479
|
+
"parameters": [
|
1480
|
+
{
|
1481
|
+
"name": "element",
|
1482
|
+
"type": {
|
1483
|
+
"text": "HTMLElement"
|
1484
|
+
},
|
1485
|
+
"description": "The button element"
|
1486
|
+
},
|
1487
|
+
{
|
1488
|
+
"name": "active",
|
1489
|
+
"type": {
|
1490
|
+
"text": "boolean"
|
1491
|
+
},
|
1492
|
+
"description": "The active state of the element"
|
1493
|
+
}
|
1494
|
+
],
|
1495
|
+
"description": "Sets the aria-pressed attribute based on the active state of the button.",
|
1496
|
+
"inheritedFrom": {
|
1497
|
+
"name": "Buttonsimple",
|
1498
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
1499
|
+
}
|
1563
1500
|
},
|
1564
1501
|
{
|
1565
|
-
"kind": "
|
1566
|
-
"name": "
|
1567
|
-
"
|
1568
|
-
|
1569
|
-
|
1570
|
-
|
1571
|
-
|
1572
|
-
|
1573
|
-
|
1502
|
+
"kind": "method",
|
1503
|
+
"name": "setSoftDisabled",
|
1504
|
+
"privacy": "private",
|
1505
|
+
"parameters": [
|
1506
|
+
{
|
1507
|
+
"name": "element",
|
1508
|
+
"type": {
|
1509
|
+
"text": "HTMLElement"
|
1510
|
+
},
|
1511
|
+
"description": "The button element."
|
1512
|
+
},
|
1513
|
+
{
|
1514
|
+
"name": "softDisabled",
|
1515
|
+
"type": {
|
1516
|
+
"text": "boolean"
|
1517
|
+
},
|
1518
|
+
"description": "The soft-disabled state."
|
1519
|
+
}
|
1520
|
+
],
|
1521
|
+
"description": "Sets the soft-disabled attribute for the button.\nWhen soft-disabled, the button looks to be disabled but remains focusable and clickable.\nAlso sets/removes aria-disabled attribute.",
|
1522
|
+
"inheritedFrom": {
|
1523
|
+
"name": "Buttonsimple",
|
1524
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
1525
|
+
}
|
1574
1526
|
},
|
1575
1527
|
{
|
1576
1528
|
"kind": "method",
|
1577
|
-
"name": "
|
1529
|
+
"name": "setDisabled",
|
1578
1530
|
"privacy": "private",
|
1579
|
-
"
|
1531
|
+
"parameters": [
|
1532
|
+
{
|
1533
|
+
"name": "element",
|
1534
|
+
"type": {
|
1535
|
+
"text": "HTMLElement"
|
1536
|
+
},
|
1537
|
+
"description": "The button element."
|
1538
|
+
},
|
1539
|
+
{
|
1540
|
+
"name": "disabled",
|
1541
|
+
"type": {
|
1542
|
+
"text": "boolean"
|
1543
|
+
},
|
1544
|
+
"description": "The disabled state."
|
1545
|
+
}
|
1546
|
+
],
|
1547
|
+
"description": "Sets the disabled attribute for the button.\nWhen disabled, the button is not focusable or clickable, and tabindex is set to -1.\nThe previous tabindex is stored and restored when enabled.\nAlso sets/removes aria-disabled attribute.",
|
1548
|
+
"inheritedFrom": {
|
1549
|
+
"name": "Buttonsimple",
|
1550
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
1551
|
+
}
|
1580
1552
|
},
|
1581
1553
|
{
|
1582
1554
|
"kind": "method",
|
1583
|
-
"name": "
|
1555
|
+
"name": "triggerClickEvent",
|
1584
1556
|
"privacy": "private",
|
1585
|
-
"
|
1586
|
-
"
|
1587
|
-
|
1588
|
-
|
1589
|
-
},
|
1590
|
-
"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."
|
1557
|
+
"inheritedFrom": {
|
1558
|
+
"name": "Buttonsimple",
|
1559
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
1560
|
+
}
|
1591
1561
|
},
|
1592
1562
|
{
|
1593
1563
|
"kind": "method",
|
1594
|
-
"name": "
|
1595
|
-
"privacy": "
|
1596
|
-
"return": {
|
1597
|
-
"type": {
|
1598
|
-
"text": "void"
|
1599
|
-
}
|
1600
|
-
},
|
1564
|
+
"name": "handleKeyDown",
|
1565
|
+
"privacy": "private",
|
1601
1566
|
"parameters": [
|
1602
1567
|
{
|
1603
1568
|
"name": "event",
|
1604
1569
|
"type": {
|
1605
|
-
"text": "
|
1606
|
-
}
|
1570
|
+
"text": "KeyboardEvent"
|
1571
|
+
},
|
1572
|
+
"description": "The keyboard event."
|
1607
1573
|
}
|
1608
1574
|
],
|
1609
|
-
"description": "
|
1575
|
+
"description": "Handles the keydown event on the button.\nIf the key is 'Enter' or 'Space', the button is pressed.\nIf the key is 'Enter', the button is pressed. The native HTML button works in the same way.",
|
1576
|
+
"inheritedFrom": {
|
1577
|
+
"name": "Buttonsimple",
|
1578
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
1579
|
+
}
|
1610
1580
|
},
|
1611
1581
|
{
|
1612
1582
|
"kind": "method",
|
1613
|
-
"name": "
|
1583
|
+
"name": "handleKeyUp",
|
1614
1584
|
"privacy": "private",
|
1615
|
-
"return": {
|
1616
|
-
"type": {
|
1617
|
-
"text": "void"
|
1618
|
-
}
|
1619
|
-
},
|
1620
1585
|
"parameters": [
|
1621
1586
|
{
|
1622
1587
|
"name": "event",
|
@@ -1626,393 +1591,512 @@
|
|
1626
1591
|
"description": "The keyboard event."
|
1627
1592
|
}
|
1628
1593
|
],
|
1629
|
-
"description": "Handles the
|
1594
|
+
"description": "Handles the keyup event on the button.\nIf the key is 'Enter' or 'Space', the button is clicked.\nIf the key is 'Space', the button is pressed. The native HTML button works in the same way.",
|
1595
|
+
"inheritedFrom": {
|
1596
|
+
"name": "Buttonsimple",
|
1597
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
1598
|
+
}
|
1599
|
+
}
|
1600
|
+
],
|
1601
|
+
"events": [
|
1602
|
+
{
|
1603
|
+
"description": "(React: onClick) This event is dispatched when the button is clicked.",
|
1604
|
+
"name": "click",
|
1605
|
+
"reactName": "onClick",
|
1606
|
+
"eventName": "ClickEvent",
|
1607
|
+
"inheritedFrom": {
|
1608
|
+
"name": "Buttonsimple",
|
1609
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
1610
|
+
}
|
1630
1611
|
},
|
1631
1612
|
{
|
1632
|
-
"
|
1633
|
-
"name": "
|
1613
|
+
"description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the button.",
|
1614
|
+
"name": "keydown",
|
1615
|
+
"reactName": "onKeyDown",
|
1616
|
+
"eventName": "KeydownEvent",
|
1617
|
+
"inheritedFrom": {
|
1618
|
+
"name": "Buttonsimple",
|
1619
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
1620
|
+
}
|
1634
1621
|
},
|
1635
1622
|
{
|
1636
|
-
"
|
1637
|
-
"name": "
|
1638
|
-
"
|
1639
|
-
|
1640
|
-
},
|
1641
|
-
"description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
|
1642
|
-
"attribute": "help-text-type",
|
1643
|
-
"reflects": true,
|
1644
|
-
"default": "undefined as unknown",
|
1623
|
+
"description": "(React: onKeyUp) This event is dispatched when a key is released on the button.",
|
1624
|
+
"name": "keyup",
|
1625
|
+
"reactName": "onKeyUp",
|
1626
|
+
"eventName": "KeyupEvent",
|
1645
1627
|
"inheritedFrom": {
|
1646
|
-
"name": "
|
1647
|
-
"module": "components/
|
1628
|
+
"name": "Buttonsimple",
|
1629
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
1648
1630
|
}
|
1649
1631
|
},
|
1650
1632
|
{
|
1651
|
-
"
|
1652
|
-
"name": "
|
1633
|
+
"description": "(React: onFocus) This event is dispatched when the button receives focus.",
|
1634
|
+
"name": "focus",
|
1635
|
+
"reactName": "onFocus",
|
1636
|
+
"eventName": "FocusEvent",
|
1637
|
+
"inheritedFrom": {
|
1638
|
+
"name": "Buttonsimple",
|
1639
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
1640
|
+
}
|
1641
|
+
}
|
1642
|
+
],
|
1643
|
+
"attributes": [
|
1644
|
+
{
|
1645
|
+
"name": "prefix-icon",
|
1653
1646
|
"type": {
|
1654
|
-
"text": "string"
|
1647
|
+
"text": "string | undefined"
|
1655
1648
|
},
|
1656
|
-
"
|
1657
|
-
"
|
1658
|
-
|
1659
|
-
|
1649
|
+
"description": "The name of the icon to display as a prefix.\nThe icon is displayed on the left side of the button.",
|
1650
|
+
"fieldName": "prefixIcon"
|
1651
|
+
},
|
1652
|
+
{
|
1653
|
+
"name": "postfix-icon",
|
1654
|
+
"type": {
|
1655
|
+
"text": "string | undefined"
|
1656
|
+
},
|
1657
|
+
"description": "The name of the icon to display as a postfix.\nThe icon is displayed on the right side of the button.",
|
1658
|
+
"fieldName": "postfixIcon"
|
1659
|
+
},
|
1660
|
+
{
|
1661
|
+
"name": "variant",
|
1662
|
+
"type": {
|
1663
|
+
"text": "ButtonVariant"
|
1664
|
+
},
|
1665
|
+
"description": "There are 3 variants of button: primary, secondary, tertiary. They are styled differently.\n- **Primary**: Solid background color.\n- **Secondary**: Transparent background with a solid border.\n- **Tertiary**: No background or border, appears as plain text but retains all button functionalities.",
|
1666
|
+
"default": "primary",
|
1667
|
+
"fieldName": "variant"
|
1668
|
+
},
|
1669
|
+
{
|
1670
|
+
"name": "size",
|
1671
|
+
"type": {
|
1672
|
+
"text": "ButtonSize"
|
1673
|
+
},
|
1674
|
+
"description": "Button sizing is based on the button type.\n- **Pill button**: 40, 32, 28, 24.\n- **Icon button**: 64, 52, 40, 32, 28, 24.\n- Tertiary icon button can also be 20.",
|
1675
|
+
"default": "32",
|
1676
|
+
"fieldName": "size",
|
1660
1677
|
"inheritedFrom": {
|
1661
|
-
"name": "
|
1662
|
-
"module": "
|
1678
|
+
"name": "Buttonsimple",
|
1679
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
1663
1680
|
}
|
1664
1681
|
},
|
1665
1682
|
{
|
1666
|
-
"
|
1667
|
-
"
|
1683
|
+
"name": "color",
|
1684
|
+
"type": {
|
1685
|
+
"text": "ButtonColor"
|
1686
|
+
},
|
1687
|
+
"description": "There are 5 colors for button: positive, negative, accent, promotional, default.",
|
1688
|
+
"default": "default",
|
1689
|
+
"fieldName": "color"
|
1690
|
+
},
|
1691
|
+
{
|
1692
|
+
"name": "role",
|
1693
|
+
"description": "This property defines the ARIA role for the element. By default, it is set to 'button'.\nConsumers should override this role when:\n- The element is being used in a context where a different role is more appropriate.\n- Custom behaviors are implemented that require a specific ARIA role for accessibility purposes.",
|
1694
|
+
"default": "'button'",
|
1695
|
+
"fieldName": "role",
|
1668
1696
|
"type": {
|
1669
1697
|
"text": "string"
|
1670
1698
|
},
|
1671
|
-
"default": "''",
|
1672
|
-
"description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
|
1673
|
-
"attribute": "value",
|
1674
|
-
"reflects": true,
|
1675
1699
|
"inheritedFrom": {
|
1676
|
-
"name": "
|
1677
|
-
"module": "
|
1700
|
+
"name": "Buttonsimple",
|
1701
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
1678
1702
|
}
|
1679
1703
|
},
|
1680
1704
|
{
|
1681
|
-
"
|
1682
|
-
"name": "dataAriaLabel",
|
1705
|
+
"name": "tabIndex",
|
1683
1706
|
"type": {
|
1684
|
-
"text": "
|
1707
|
+
"text": "number"
|
1685
1708
|
},
|
1686
|
-
"default": "
|
1687
|
-
"description": "
|
1688
|
-
"
|
1689
|
-
"reflects": true,
|
1709
|
+
"default": "0",
|
1710
|
+
"description": "This property specifies the tab order of the element.",
|
1711
|
+
"fieldName": "tabIndex",
|
1690
1712
|
"inheritedFrom": {
|
1691
|
-
"name": "
|
1692
|
-
"module": "utils/mixins/
|
1713
|
+
"name": "TabIndexMixin",
|
1714
|
+
"module": "src/utils/mixins/TabIndexMixin.ts"
|
1693
1715
|
}
|
1694
1716
|
},
|
1695
1717
|
{
|
1696
|
-
"kind": "field",
|
1697
1718
|
"name": "disabled",
|
1698
1719
|
"type": {
|
1699
1720
|
"text": "boolean"
|
1700
1721
|
},
|
1701
1722
|
"default": "false",
|
1702
1723
|
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
1703
|
-
"
|
1704
|
-
"reflects": true,
|
1724
|
+
"fieldName": "disabled",
|
1705
1725
|
"inheritedFrom": {
|
1706
1726
|
"name": "DisabledMixin",
|
1707
|
-
"module": "utils/mixins/DisabledMixin.
|
1727
|
+
"module": "src/utils/mixins/DisabledMixin.ts"
|
1708
1728
|
}
|
1709
1729
|
},
|
1710
1730
|
{
|
1711
|
-
"
|
1712
|
-
"name": "label",
|
1731
|
+
"name": "active",
|
1713
1732
|
"type": {
|
1714
|
-
"text": "
|
1733
|
+
"text": "boolean"
|
1715
1734
|
},
|
1716
|
-
"
|
1717
|
-
"
|
1718
|
-
"
|
1735
|
+
"default": "false",
|
1736
|
+
"description": "The button's active state indicates whether it is currently toggled on (active) or off (inactive).\nWhen the active state is true, the button is considered to be in an active state, meaning it is toggled on.\nConversely, when the active state is false, the button is in an inactive state, indicating it is toggled off.",
|
1737
|
+
"fieldName": "active",
|
1719
1738
|
"inheritedFrom": {
|
1720
|
-
"name": "
|
1721
|
-
"module": "components/
|
1739
|
+
"name": "Buttonsimple",
|
1740
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
1722
1741
|
}
|
1723
1742
|
},
|
1724
1743
|
{
|
1725
|
-
"
|
1726
|
-
"name": "requiredLabel",
|
1744
|
+
"name": "soft-disabled",
|
1727
1745
|
"type": {
|
1728
|
-
"text": "
|
1746
|
+
"text": "boolean"
|
1729
1747
|
},
|
1730
|
-
"
|
1731
|
-
"
|
1732
|
-
"
|
1748
|
+
"default": "false",
|
1749
|
+
"description": "Indicates whether the button is soft disabled.\nWhen set to `true`, the button appears visually disabled but still allows\nfocus, click, and keyboard actions to be passed through.\n\n**Important:** When using soft disabled, consumers must ensure that\nthe button behaves like a disabled button, allowing only focus and\npreventing any interactions (clicks or keyboard actions) from triggering unintended actions.",
|
1750
|
+
"fieldName": "softDisabled",
|
1733
1751
|
"inheritedFrom": {
|
1734
|
-
"name": "
|
1735
|
-
"module": "components/
|
1752
|
+
"name": "Buttonsimple",
|
1753
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
1736
1754
|
}
|
1737
1755
|
},
|
1738
1756
|
{
|
1739
|
-
"
|
1740
|
-
"
|
1741
|
-
|
1742
|
-
|
1743
|
-
"
|
1757
|
+
"name": "type",
|
1758
|
+
"type": {
|
1759
|
+
"text": "ButtonType"
|
1760
|
+
},
|
1761
|
+
"description": "This property defines the type attribute for the button element.\nThe type attribute specifies the behavior of the button when it is clicked.\n- **submit**: The button submits the form data to the server.\n- **reset**: The button resets the form data to its initial state.\n- **button**: The button does nothing when clicked.",
|
1762
|
+
"default": "button",
|
1763
|
+
"fieldName": "type",
|
1744
1764
|
"inheritedFrom": {
|
1745
|
-
"name": "
|
1746
|
-
"module": "components/
|
1765
|
+
"name": "Buttonsimple",
|
1766
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
1747
1767
|
}
|
1768
|
+
}
|
1769
|
+
],
|
1770
|
+
"superclass": {
|
1771
|
+
"name": "Buttonsimple",
|
1772
|
+
"module": "/src/components/buttonsimple/buttonsimple.component"
|
1773
|
+
},
|
1774
|
+
"tagName": "mdc-button",
|
1775
|
+
"jsDoc": "/**\n * `mdc-button` is a component that can be configured in various ways to suit different use cases.\n *\n * Button Variants:\n * - **Primary**: Solid background color.\n * - **Secondary**: Transparent background with a solid border.\n * - **Tertiary**: No background or border, appears as plain text but retains all button functionalities.\n *\n * Button Colors:\n * - **Positive**: Green color.\n * - **Negative**: Red color.\n * - **Accent**: Blue color.\n * - **Promotional**: Purple color.\n * - **Default**: White color.\n *\n * Button Sizes (in REM units):\n * - **Pill button**: 40, 32, 28, 24.\n * - **Icon button**: 64, 52, 40, 32, 28, 24.\n * - **Tertiary icon button**: 20.\n *\n * Button Types:\n * - **Pill button**: A button that contains text value. Commonly used for call to action, tags, or filters.\n * - **Pill button with icons**: A button containing an icon either on the left or right side of the button.\n * - **Icon button**: A button represented by just an icon without any text.\n * The type of button is inferred based on the presence of slot and/or prefix and postfix icons.\n *\n * @dependency mdc-icon\n *\n * @event click - (React: onClick) This event is dispatched when the button is clicked.\n * @event keydown - (React: onKeyDown) This event is dispatched when a key is pressed down on the button.\n * @event keyup - (React: onKeyUp) This event is dispatched when a key is released on the button.\n * @event focus - (React: onFocus) This event is dispatched when the button receives focus.\n *\n * @tagname mdc-button\n *\n * @slot - Text label of the button.\n */",
|
1776
|
+
"customElement": true
|
1777
|
+
}
|
1778
|
+
],
|
1779
|
+
"exports": [
|
1780
|
+
{
|
1781
|
+
"kind": "js",
|
1782
|
+
"name": "default",
|
1783
|
+
"declaration": {
|
1784
|
+
"name": "Button",
|
1785
|
+
"module": "components/button/button.component.js"
|
1786
|
+
}
|
1787
|
+
}
|
1788
|
+
]
|
1789
|
+
},
|
1790
|
+
{
|
1791
|
+
"kind": "javascript-module",
|
1792
|
+
"path": "components/buttonsimple/buttonsimple.component.js",
|
1793
|
+
"declarations": [
|
1794
|
+
{
|
1795
|
+
"kind": "class",
|
1796
|
+
"description": "`mdc-buttonsimple` is a component that can be configured in various ways to suit different use cases.\nIt is used as an internal component and is not intended to be used directly by consumers.\nConsumers should use the `mdc-button` component instead.",
|
1797
|
+
"name": "Buttonsimple",
|
1798
|
+
"members": [
|
1799
|
+
{
|
1800
|
+
"kind": "field",
|
1801
|
+
"name": "active",
|
1802
|
+
"type": {
|
1803
|
+
"text": "boolean"
|
1804
|
+
},
|
1805
|
+
"default": "false",
|
1806
|
+
"description": "The button's active state indicates whether it is currently toggled on (active) or off (inactive).\nWhen the active state is true, the button is considered to be in an active state, meaning it is toggled on.\nConversely, when the active state is false, the button is in an inactive state, indicating it is toggled off.",
|
1807
|
+
"attribute": "active",
|
1808
|
+
"reflects": true
|
1748
1809
|
},
|
1749
1810
|
{
|
1750
1811
|
"kind": "field",
|
1751
|
-
"name": "
|
1812
|
+
"name": "softDisabled",
|
1752
1813
|
"type": {
|
1753
|
-
"text": "
|
1814
|
+
"text": "boolean"
|
1754
1815
|
},
|
1755
|
-
"
|
1756
|
-
"
|
1757
|
-
"
|
1758
|
-
|
1759
|
-
|
1760
|
-
|
1761
|
-
|
1816
|
+
"default": "false",
|
1817
|
+
"description": "Indicates whether the button is soft disabled.\nWhen set to `true`, the button appears visually disabled but still allows\nfocus, click, and keyboard actions to be passed through.\n\n**Important:** When using soft disabled, consumers must ensure that\nthe button behaves like a disabled button, allowing only focus and\npreventing any interactions (clicks or keyboard actions) from triggering unintended actions.",
|
1818
|
+
"attribute": "soft-disabled"
|
1819
|
+
},
|
1820
|
+
{
|
1821
|
+
"kind": "field",
|
1822
|
+
"name": "size",
|
1823
|
+
"type": {
|
1824
|
+
"text": "ButtonSize"
|
1825
|
+
},
|
1826
|
+
"description": "Simplebutton size is a super set of all the sizes supported by children components.",
|
1827
|
+
"default": "32",
|
1828
|
+
"attribute": "size",
|
1829
|
+
"reflects": true
|
1830
|
+
},
|
1831
|
+
{
|
1832
|
+
"kind": "field",
|
1833
|
+
"name": "role",
|
1834
|
+
"description": "This property defines the ARIA role for the element. By default, it is set to 'button'.\nConsumers should override this role when:\n- The element is being used in a context where a different role is more appropriate.\n- Custom behaviors are implemented that require a specific ARIA role for accessibility purposes.",
|
1835
|
+
"default": "button",
|
1836
|
+
"attribute": "role",
|
1837
|
+
"reflects": true
|
1838
|
+
},
|
1839
|
+
{
|
1840
|
+
"kind": "field",
|
1841
|
+
"name": "type",
|
1842
|
+
"type": {
|
1843
|
+
"text": "ButtonType"
|
1844
|
+
},
|
1845
|
+
"description": "This property defines the type attribute for the button element.\nThe type attribute specifies the behavior of the button when it is clicked.\n- **submit**: The button submits the form data to the server.\n- **reset**: The button resets the form data to its initial state.\n- **button**: The button does nothing when clicked.",
|
1846
|
+
"default": "button",
|
1847
|
+
"attribute": "type",
|
1848
|
+
"reflects": true
|
1849
|
+
},
|
1850
|
+
{
|
1851
|
+
"kind": "method",
|
1852
|
+
"name": "executeAction",
|
1853
|
+
"privacy": "protected"
|
1762
1854
|
},
|
1763
1855
|
{
|
1764
1856
|
"kind": "method",
|
1765
|
-
"name": "
|
1857
|
+
"name": "setActive",
|
1766
1858
|
"privacy": "protected",
|
1767
|
-
"
|
1768
|
-
|
1769
|
-
|
1770
|
-
"
|
1859
|
+
"parameters": [
|
1860
|
+
{
|
1861
|
+
"name": "element",
|
1862
|
+
"type": {
|
1863
|
+
"text": "HTMLElement"
|
1864
|
+
},
|
1865
|
+
"description": "The button element"
|
1866
|
+
},
|
1867
|
+
{
|
1868
|
+
"name": "active",
|
1869
|
+
"type": {
|
1870
|
+
"text": "boolean"
|
1871
|
+
},
|
1872
|
+
"description": "The active state of the element"
|
1771
1873
|
}
|
1772
|
-
|
1773
|
-
"
|
1774
|
-
"name": "FormfieldWrapper",
|
1775
|
-
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
1776
|
-
}
|
1874
|
+
],
|
1875
|
+
"description": "Sets the aria-pressed attribute based on the active state of the button."
|
1777
1876
|
},
|
1778
1877
|
{
|
1779
1878
|
"kind": "method",
|
1780
|
-
"name": "
|
1781
|
-
"privacy": "
|
1782
|
-
"
|
1783
|
-
|
1784
|
-
|
1785
|
-
|
1879
|
+
"name": "setSoftDisabled",
|
1880
|
+
"privacy": "private",
|
1881
|
+
"parameters": [
|
1882
|
+
{
|
1883
|
+
"name": "element",
|
1884
|
+
"type": {
|
1885
|
+
"text": "HTMLElement"
|
1886
|
+
},
|
1887
|
+
"description": "The button element."
|
1888
|
+
},
|
1889
|
+
{
|
1890
|
+
"name": "softDisabled",
|
1891
|
+
"type": {
|
1892
|
+
"text": "boolean"
|
1893
|
+
},
|
1894
|
+
"description": "The soft-disabled state."
|
1895
|
+
}
|
1896
|
+
],
|
1897
|
+
"description": "Sets the soft-disabled attribute for the button.\nWhen soft-disabled, the button looks to be disabled but remains focusable and clickable.\nAlso sets/removes aria-disabled attribute."
|
1786
1898
|
},
|
1787
1899
|
{
|
1788
1900
|
"kind": "method",
|
1789
|
-
"name": "
|
1790
|
-
"privacy": "
|
1791
|
-
"
|
1792
|
-
|
1793
|
-
|
1794
|
-
"
|
1901
|
+
"name": "setDisabled",
|
1902
|
+
"privacy": "private",
|
1903
|
+
"parameters": [
|
1904
|
+
{
|
1905
|
+
"name": "element",
|
1906
|
+
"type": {
|
1907
|
+
"text": "HTMLElement"
|
1908
|
+
},
|
1909
|
+
"description": "The button element."
|
1910
|
+
},
|
1911
|
+
{
|
1912
|
+
"name": "disabled",
|
1913
|
+
"type": {
|
1914
|
+
"text": "boolean"
|
1915
|
+
},
|
1916
|
+
"description": "The disabled state."
|
1795
1917
|
}
|
1796
|
-
|
1797
|
-
"
|
1798
|
-
"name": "FormfieldWrapper",
|
1799
|
-
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
1800
|
-
}
|
1918
|
+
],
|
1919
|
+
"description": "Sets the disabled attribute for the button.\nWhen disabled, the button is not focusable or clickable, and tabindex is set to -1.\nThe previous tabindex is stored and restored when enabled.\nAlso sets/removes aria-disabled attribute."
|
1801
1920
|
},
|
1802
1921
|
{
|
1803
1922
|
"kind": "method",
|
1804
|
-
"name": "
|
1805
|
-
"privacy": "
|
1806
|
-
"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.",
|
1807
|
-
"return": {
|
1808
|
-
"type": {
|
1809
|
-
"text": ""
|
1810
|
-
}
|
1811
|
-
},
|
1812
|
-
"inheritedFrom": {
|
1813
|
-
"name": "FormfieldWrapper",
|
1814
|
-
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
1815
|
-
}
|
1923
|
+
"name": "triggerClickEvent",
|
1924
|
+
"privacy": "private"
|
1816
1925
|
},
|
1817
1926
|
{
|
1818
1927
|
"kind": "method",
|
1819
|
-
"name": "
|
1820
|
-
"privacy": "
|
1821
|
-
"
|
1822
|
-
|
1823
|
-
|
1824
|
-
"
|
1928
|
+
"name": "handleKeyDown",
|
1929
|
+
"privacy": "private",
|
1930
|
+
"parameters": [
|
1931
|
+
{
|
1932
|
+
"name": "event",
|
1933
|
+
"type": {
|
1934
|
+
"text": "KeyboardEvent"
|
1935
|
+
},
|
1936
|
+
"description": "The keyboard event."
|
1825
1937
|
}
|
1826
|
-
|
1827
|
-
"
|
1828
|
-
"name": "FormfieldWrapper",
|
1829
|
-
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
1830
|
-
}
|
1938
|
+
],
|
1939
|
+
"description": "Handles the keydown event on the button.\nIf the key is 'Enter' or 'Space', the button is pressed.\nIf the key is 'Enter', the button is pressed. The native HTML button works in the same way."
|
1831
1940
|
},
|
1832
1941
|
{
|
1833
1942
|
"kind": "method",
|
1834
|
-
"name": "
|
1835
|
-
"privacy": "
|
1836
|
-
"
|
1837
|
-
|
1838
|
-
|
1839
|
-
"
|
1943
|
+
"name": "handleKeyUp",
|
1944
|
+
"privacy": "private",
|
1945
|
+
"parameters": [
|
1946
|
+
{
|
1947
|
+
"name": "event",
|
1948
|
+
"type": {
|
1949
|
+
"text": "KeyboardEvent"
|
1950
|
+
},
|
1951
|
+
"description": "The keyboard event."
|
1840
1952
|
}
|
1953
|
+
],
|
1954
|
+
"description": "Handles the keyup event on the button.\nIf the key is 'Enter' or 'Space', the button is clicked.\nIf the key is 'Space', the button is pressed. The native HTML button works in the same way."
|
1955
|
+
},
|
1956
|
+
{
|
1957
|
+
"kind": "field",
|
1958
|
+
"name": "tabIndex",
|
1959
|
+
"type": {
|
1960
|
+
"text": "number"
|
1841
1961
|
},
|
1962
|
+
"default": "0",
|
1963
|
+
"description": "This property specifies the tab order of the element.",
|
1964
|
+
"attribute": "tabIndex",
|
1965
|
+
"reflects": true,
|
1842
1966
|
"inheritedFrom": {
|
1843
|
-
"name": "
|
1844
|
-
"module": "
|
1967
|
+
"name": "TabIndexMixin",
|
1968
|
+
"module": "utils/mixins/TabIndexMixin.js"
|
1845
1969
|
}
|
1846
|
-
}
|
1847
|
-
],
|
1848
|
-
"events": [
|
1970
|
+
},
|
1849
1971
|
{
|
1972
|
+
"kind": "field",
|
1973
|
+
"name": "disabled",
|
1850
1974
|
"type": {
|
1851
|
-
"text": "
|
1975
|
+
"text": "boolean"
|
1976
|
+
},
|
1977
|
+
"default": "false",
|
1978
|
+
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
1979
|
+
"attribute": "disabled",
|
1980
|
+
"reflects": true,
|
1981
|
+
"inheritedFrom": {
|
1982
|
+
"name": "DisabledMixin",
|
1983
|
+
"module": "utils/mixins/DisabledMixin.js"
|
1852
1984
|
}
|
1853
1985
|
}
|
1854
1986
|
],
|
1855
|
-
"
|
1987
|
+
"events": [
|
1856
1988
|
{
|
1857
|
-
"
|
1858
|
-
"
|
1859
|
-
|
1860
|
-
|
1861
|
-
"default": "false",
|
1862
|
-
"description": "Determines whether the checkbox is selected or unselected.",
|
1863
|
-
"fieldName": "checked"
|
1989
|
+
"description": "(React: onClick) This event is dispatched when the button is clicked.",
|
1990
|
+
"name": "click",
|
1991
|
+
"reactName": "onClick",
|
1992
|
+
"eventName": "ClickEvent"
|
1864
1993
|
},
|
1865
1994
|
{
|
1866
|
-
"
|
1867
|
-
"
|
1868
|
-
|
1869
|
-
|
1870
|
-
"default": "false",
|
1871
|
-
"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.",
|
1872
|
-
"fieldName": "indeterminate"
|
1995
|
+
"description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the button.",
|
1996
|
+
"name": "keydown",
|
1997
|
+
"reactName": "onKeyDown",
|
1998
|
+
"eventName": "KeydownEvent"
|
1873
1999
|
},
|
1874
2000
|
{
|
1875
|
-
"
|
1876
|
-
"
|
1877
|
-
|
1878
|
-
|
1879
|
-
"default": "''",
|
1880
|
-
"description": "Indicates the name of the component group (ex: checkbox, radio group).\nThey are used to group elements in a form together.",
|
1881
|
-
"fieldName": "name",
|
1882
|
-
"inheritedFrom": {
|
1883
|
-
"name": "NameMixin",
|
1884
|
-
"module": "src/utils/mixins/NameMixin.ts"
|
1885
|
-
}
|
2001
|
+
"description": "(React: onKeyUp) This event is dispatched when a key is released on the button.",
|
2002
|
+
"name": "keyup",
|
2003
|
+
"reactName": "onKeyUp",
|
2004
|
+
"eventName": "KeyupEvent"
|
1886
2005
|
},
|
1887
2006
|
{
|
1888
|
-
"
|
1889
|
-
"
|
1890
|
-
|
1891
|
-
|
1892
|
-
|
1893
|
-
|
1894
|
-
|
1895
|
-
"inheritedFrom": {
|
1896
|
-
"name": "ValueMixin",
|
1897
|
-
"module": "src/utils/mixins/ValueMixin.ts"
|
1898
|
-
}
|
1899
|
-
},
|
2007
|
+
"description": "(React: onFocus) This event is dispatched when the button receives focus.",
|
2008
|
+
"name": "focus",
|
2009
|
+
"reactName": "onFocus",
|
2010
|
+
"eventName": "FocusEvent"
|
2011
|
+
}
|
2012
|
+
],
|
2013
|
+
"attributes": [
|
1900
2014
|
{
|
1901
|
-
"name": "
|
2015
|
+
"name": "active",
|
1902
2016
|
"type": {
|
1903
|
-
"text": "
|
2017
|
+
"text": "boolean"
|
1904
2018
|
},
|
1905
|
-
"default": "
|
1906
|
-
"description": "
|
1907
|
-
"fieldName": "
|
1908
|
-
"inheritedFrom": {
|
1909
|
-
"name": "DataAriaLabelMixin",
|
1910
|
-
"module": "src/utils/mixins/DataAriaLabelMixin.ts"
|
1911
|
-
}
|
2019
|
+
"default": "false",
|
2020
|
+
"description": "The button's active state indicates whether it is currently toggled on (active) or off (inactive).\nWhen the active state is true, the button is considered to be in an active state, meaning it is toggled on.\nConversely, when the active state is false, the button is in an inactive state, indicating it is toggled off.",
|
2021
|
+
"fieldName": "active"
|
1912
2022
|
},
|
1913
2023
|
{
|
1914
|
-
"name": "disabled",
|
2024
|
+
"name": "soft-disabled",
|
1915
2025
|
"type": {
|
1916
2026
|
"text": "boolean"
|
1917
2027
|
},
|
1918
2028
|
"default": "false",
|
1919
|
-
"description": "Indicates whether the
|
1920
|
-
"fieldName": "
|
1921
|
-
"inheritedFrom": {
|
1922
|
-
"name": "DisabledMixin",
|
1923
|
-
"module": "src/utils/mixins/DisabledMixin.ts"
|
1924
|
-
}
|
2029
|
+
"description": "Indicates whether the button is soft disabled.\nWhen set to `true`, the button appears visually disabled but still allows\nfocus, click, and keyboard actions to be passed through.\n\n**Important:** When using soft disabled, consumers must ensure that\nthe button behaves like a disabled button, allowing only focus and\npreventing any interactions (clicks or keyboard actions) from triggering unintended actions.",
|
2030
|
+
"fieldName": "softDisabled"
|
1925
2031
|
},
|
1926
2032
|
{
|
1927
|
-
"name": "
|
2033
|
+
"name": "size",
|
1928
2034
|
"type": {
|
1929
|
-
"text": "
|
2035
|
+
"text": "ButtonSize"
|
1930
2036
|
},
|
1931
|
-
"description": "
|
1932
|
-
"
|
1933
|
-
"
|
1934
|
-
"name": "FormfieldWrapper",
|
1935
|
-
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
1936
|
-
}
|
2037
|
+
"description": "Simplebutton size is a super set of all the sizes supported by children components.",
|
2038
|
+
"default": "32",
|
2039
|
+
"fieldName": "size"
|
1937
2040
|
},
|
1938
2041
|
{
|
1939
|
-
"name": "
|
1940
|
-
"
|
1941
|
-
|
1942
|
-
|
1943
|
-
"description": "The required label of the input field.\nWhen an appropriate string value is set,\nthe input field is marked as required and the label is appended with this text.",
|
1944
|
-
"fieldName": "requiredLabel",
|
1945
|
-
"inheritedFrom": {
|
1946
|
-
"name": "FormfieldWrapper",
|
1947
|
-
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
1948
|
-
}
|
2042
|
+
"name": "role",
|
2043
|
+
"description": "This property defines the ARIA role for the element. By default, it is set to 'button'.\nConsumers should override this role when:\n- The element is being used in a context where a different role is more appropriate.\n- Custom behaviors are implemented that require a specific ARIA role for accessibility purposes.",
|
2044
|
+
"default": "button",
|
2045
|
+
"fieldName": "role"
|
1949
2046
|
},
|
1950
2047
|
{
|
1951
|
-
"name": "
|
1952
|
-
"
|
1953
|
-
|
1954
|
-
|
1955
|
-
"
|
1956
|
-
|
1957
|
-
|
1958
|
-
}
|
2048
|
+
"name": "type",
|
2049
|
+
"type": {
|
2050
|
+
"text": "ButtonType"
|
2051
|
+
},
|
2052
|
+
"description": "This property defines the type attribute for the button element.\nThe type attribute specifies the behavior of the button when it is clicked.\n- **submit**: The button submits the form data to the server.\n- **reset**: The button resets the form data to its initial state.\n- **button**: The button does nothing when clicked.",
|
2053
|
+
"default": "button",
|
2054
|
+
"fieldName": "type"
|
1959
2055
|
},
|
1960
2056
|
{
|
1961
|
-
"name": "
|
2057
|
+
"name": "tabIndex",
|
1962
2058
|
"type": {
|
1963
|
-
"text": "
|
2059
|
+
"text": "number"
|
1964
2060
|
},
|
1965
|
-
"
|
1966
|
-
"
|
2061
|
+
"default": "0",
|
2062
|
+
"description": "This property specifies the tab order of the element.",
|
2063
|
+
"fieldName": "tabIndex",
|
1967
2064
|
"inheritedFrom": {
|
1968
|
-
"name": "
|
1969
|
-
"module": "src/
|
2065
|
+
"name": "TabIndexMixin",
|
2066
|
+
"module": "src/utils/mixins/TabIndexMixin.ts"
|
1970
2067
|
}
|
1971
2068
|
},
|
1972
2069
|
{
|
1973
|
-
"name": "
|
2070
|
+
"name": "disabled",
|
1974
2071
|
"type": {
|
1975
|
-
"text": "
|
2072
|
+
"text": "boolean"
|
1976
2073
|
},
|
1977
|
-
"
|
1978
|
-
"
|
2074
|
+
"default": "false",
|
2075
|
+
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
2076
|
+
"fieldName": "disabled",
|
1979
2077
|
"inheritedFrom": {
|
1980
|
-
"name": "
|
1981
|
-
"module": "src/
|
2078
|
+
"name": "DisabledMixin",
|
2079
|
+
"module": "src/utils/mixins/DisabledMixin.ts"
|
1982
2080
|
}
|
1983
2081
|
}
|
1984
2082
|
],
|
1985
2083
|
"mixins": [
|
1986
2084
|
{
|
1987
|
-
"name": "
|
1988
|
-
"module": "/src/utils/mixins/
|
1989
|
-
},
|
1990
|
-
{
|
1991
|
-
"name": "ValueMixin",
|
1992
|
-
"module": "/src/utils/mixins/ValueMixin"
|
2085
|
+
"name": "TabIndexMixin",
|
2086
|
+
"module": "/src/utils/mixins/TabIndexMixin"
|
1993
2087
|
},
|
1994
2088
|
{
|
1995
|
-
"name": "
|
1996
|
-
"module": "/src/utils/mixins/
|
2089
|
+
"name": "DisabledMixin",
|
2090
|
+
"module": "/src/utils/mixins/DisabledMixin"
|
1997
2091
|
}
|
1998
2092
|
],
|
1999
2093
|
"superclass": {
|
2000
|
-
"name": "
|
2001
|
-
"module": "/src/
|
2094
|
+
"name": "Component",
|
2095
|
+
"module": "/src/models"
|
2002
2096
|
},
|
2003
|
-
"tagName": "mdc-
|
2004
|
-
"jsDoc": "/**\n *
|
2005
|
-
"customElement": true
|
2006
|
-
"slots": [
|
2007
|
-
{
|
2008
|
-
"description": "slot to add the label info icon",
|
2009
|
-
"name": "label-info",
|
2010
|
-
"inheritedFrom": {
|
2011
|
-
"name": "FormfieldWrapper",
|
2012
|
-
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
2013
|
-
}
|
2014
|
-
}
|
2015
|
-
]
|
2097
|
+
"tagName": "mdc-buttonsimple",
|
2098
|
+
"jsDoc": "/**\n * `mdc-buttonsimple` is a component that can be configured in various ways to suit different use cases.\n * It is used as an internal component and is not intended to be used directly by consumers.\n * Consumers should use the `mdc-button` component instead.\n *\n * @event click - (React: onClick) This event is dispatched when the button is clicked.\n * @event keydown - (React: onKeyDown) This event is dispatched when a key is pressed down on the button.\n * @event keyup - (React: onKeyUp) This event is dispatched when a key is released on the button.\n * @event focus - (React: onFocus) This event is dispatched when the button receives focus.\n *\n * @tagname mdc-buttonsimple\n */",
|
2099
|
+
"customElement": true
|
2016
2100
|
}
|
2017
2101
|
],
|
2018
2102
|
"exports": [
|
@@ -2020,450 +2104,445 @@
|
|
2020
2104
|
"kind": "js",
|
2021
2105
|
"name": "default",
|
2022
2106
|
"declaration": {
|
2023
|
-
"name": "
|
2024
|
-
"module": "components/
|
2107
|
+
"name": "Buttonsimple",
|
2108
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
2025
2109
|
}
|
2026
2110
|
}
|
2027
2111
|
]
|
2028
2112
|
},
|
2029
2113
|
{
|
2030
2114
|
"kind": "javascript-module",
|
2031
|
-
"path": "components/
|
2115
|
+
"path": "components/checkbox/checkbox.component.js",
|
2032
2116
|
"declarations": [
|
2033
2117
|
{
|
2034
2118
|
"kind": "class",
|
2035
|
-
"description": "
|
2036
|
-
"name": "
|
2037
|
-
"
|
2119
|
+
"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.",
|
2120
|
+
"name": "Checkbox",
|
2121
|
+
"cssProperties": [
|
2038
2122
|
{
|
2039
|
-
"description": "
|
2040
|
-
"name": ""
|
2041
|
-
}
|
2042
|
-
],
|
2043
|
-
"members": [
|
2123
|
+
"description": "Allows customization of the background color on hover.",
|
2124
|
+
"name": "--mdc-checkbox-background-color-hover"
|
2125
|
+
},
|
2044
2126
|
{
|
2045
|
-
"
|
2046
|
-
"name": "
|
2047
|
-
"type": {
|
2048
|
-
"text": "string | undefined"
|
2049
|
-
},
|
2050
|
-
"description": "The name of the icon to display as a prefix.\nThe icon is displayed on the left side of the button.",
|
2051
|
-
"attribute": "prefix-icon",
|
2052
|
-
"reflects": true
|
2127
|
+
"description": "Border color in high contrast.",
|
2128
|
+
"name": "--mdc-checkbox-border-color"
|
2053
2129
|
},
|
2054
2130
|
{
|
2055
|
-
"
|
2056
|
-
"name": "
|
2057
|
-
"type": {
|
2058
|
-
"text": "string | undefined"
|
2059
|
-
},
|
2060
|
-
"description": "The name of the icon to display as a postfix.\nThe icon is displayed on the right side of the button.",
|
2061
|
-
"attribute": "postfix-icon",
|
2062
|
-
"reflects": true
|
2131
|
+
"description": "Background color for a selected checkbox.",
|
2132
|
+
"name": "--mdc-checkbox-checked-background-color"
|
2063
2133
|
},
|
2064
2134
|
{
|
2065
|
-
"
|
2066
|
-
"name": "
|
2067
|
-
"type": {
|
2068
|
-
"text": "ButtonVariant"
|
2069
|
-
},
|
2070
|
-
"description": "There are 3 variants of button: primary, secondary, tertiary. They are styled differently.\n- **Primary**: Solid background color.\n- **Secondary**: Transparent background with a solid border.\n- **Tertiary**: No background or border, appears as plain text but retains all button functionalities.",
|
2071
|
-
"default": "primary",
|
2072
|
-
"attribute": "variant"
|
2135
|
+
"description": "Background color for a selected checkbox when hovered.",
|
2136
|
+
"name": "--mdc-checkbox-checked-background-color-hover"
|
2073
2137
|
},
|
2074
2138
|
{
|
2075
|
-
"
|
2076
|
-
"name": "
|
2077
|
-
|
2078
|
-
|
2079
|
-
|
2080
|
-
"
|
2081
|
-
|
2082
|
-
|
2083
|
-
"
|
2084
|
-
"
|
2085
|
-
|
2086
|
-
|
2087
|
-
|
2139
|
+
"description": "Background color for a selected checkbox when pressed.",
|
2140
|
+
"name": "--mdc-checkbox-checked-pressed-icon-color"
|
2141
|
+
},
|
2142
|
+
{
|
2143
|
+
"description": "Background color for a disabled checkbox.",
|
2144
|
+
"name": "--mdc-checkbox-disabled-background-color"
|
2145
|
+
},
|
2146
|
+
{
|
2147
|
+
"description": "Border color for a disabled checkbox.",
|
2148
|
+
"name": "--mdc-checkbox-disabled-border-color"
|
2149
|
+
},
|
2150
|
+
{
|
2151
|
+
"description": "Background color for a disabled, selected checkbox.",
|
2152
|
+
"name": "--mdc-checkbox-disabled-checked-icon-color"
|
2153
|
+
},
|
2154
|
+
{
|
2155
|
+
"description": "Icon color for a disabled checkbox.",
|
2156
|
+
"name": "--mdc-checkbox-disabled-icon-color"
|
2157
|
+
},
|
2158
|
+
{
|
2159
|
+
"description": "Background color for an unselected checkbox.",
|
2160
|
+
"name": "--mdc-checkbox-icon-background-color"
|
2088
2161
|
},
|
2162
|
+
{
|
2163
|
+
"description": "Default background color for an unselected checkbox.",
|
2164
|
+
"name": "--mdc-checkbox-icon-border-color"
|
2165
|
+
},
|
2166
|
+
{
|
2167
|
+
"description": "Icon color for an unselected checkbox.",
|
2168
|
+
"name": "--mdc-checkbox-icon-color"
|
2169
|
+
},
|
2170
|
+
{
|
2171
|
+
"description": "Background color for a selected checkbox when pressed.",
|
2172
|
+
"name": "--mdc-checkbox-pressed-icon-color"
|
2173
|
+
}
|
2174
|
+
],
|
2175
|
+
"members": [
|
2089
2176
|
{
|
2090
2177
|
"kind": "field",
|
2091
|
-
"name": "
|
2178
|
+
"name": "checked",
|
2092
2179
|
"type": {
|
2093
|
-
"text": "
|
2180
|
+
"text": "boolean"
|
2094
2181
|
},
|
2095
|
-
"
|
2096
|
-
"
|
2097
|
-
"attribute": "
|
2182
|
+
"default": "false",
|
2183
|
+
"description": "Determines whether the checkbox is selected or unselected.",
|
2184
|
+
"attribute": "checked",
|
2185
|
+
"reflects": true
|
2098
2186
|
},
|
2099
2187
|
{
|
2100
2188
|
"kind": "field",
|
2101
|
-
"name": "
|
2102
|
-
"description": "This property defines the ARIA role for the element. By default, it is set to 'button'.\nConsumers should override this role when:\n- The element is being used in a context where a different role is more appropriate.\n- Custom behaviors are implemented that require a specific ARIA role for accessibility purposes.",
|
2103
|
-
"default": "'button'",
|
2104
|
-
"attribute": "role",
|
2105
|
-
"reflects": true,
|
2189
|
+
"name": "indeterminate",
|
2106
2190
|
"type": {
|
2107
|
-
"text": "
|
2191
|
+
"text": "boolean"
|
2108
2192
|
},
|
2109
|
-
"
|
2110
|
-
|
2111
|
-
|
2112
|
-
|
2193
|
+
"default": "false",
|
2194
|
+
"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.",
|
2195
|
+
"attribute": "indeterminate",
|
2196
|
+
"reflects": true
|
2113
2197
|
},
|
2114
2198
|
{
|
2115
2199
|
"kind": "method",
|
2116
|
-
"name": "
|
2200
|
+
"name": "setFormValue",
|
2117
2201
|
"privacy": "private",
|
2118
|
-
"
|
2119
|
-
{
|
2120
|
-
"name": "active",
|
2121
|
-
"type": {
|
2122
|
-
"text": "boolean"
|
2123
|
-
},
|
2124
|
-
"description": "The active state."
|
2125
|
-
}
|
2126
|
-
],
|
2127
|
-
"description": "Modifies the icon name based on the active state.\nIf the button is active, the icon name is suffixed with '-filled'.\nIf the button is inactive, the icon name is restored to its original value.\nIf '-filled' icon is not available, the icon name remains unchanged."
|
2202
|
+
"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."
|
2128
2203
|
},
|
2129
2204
|
{
|
2130
2205
|
"kind": "method",
|
2131
|
-
"name": "
|
2206
|
+
"name": "toggleState",
|
2132
2207
|
"privacy": "private",
|
2133
|
-
"
|
2134
|
-
{
|
2135
|
-
"
|
2136
|
-
"type": {
|
2137
|
-
"text": "ButtonVariant"
|
2138
|
-
},
|
2139
|
-
"description": "The variant to set."
|
2208
|
+
"return": {
|
2209
|
+
"type": {
|
2210
|
+
"text": "void"
|
2140
2211
|
}
|
2141
|
-
|
2142
|
-
"description": "
|
2212
|
+
},
|
2213
|
+
"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."
|
2143
2214
|
},
|
2144
2215
|
{
|
2145
2216
|
"kind": "method",
|
2146
|
-
"name": "
|
2147
|
-
"privacy": "
|
2217
|
+
"name": "handleChange",
|
2218
|
+
"privacy": "public",
|
2219
|
+
"return": {
|
2220
|
+
"type": {
|
2221
|
+
"text": "void"
|
2222
|
+
}
|
2223
|
+
},
|
2148
2224
|
"parameters": [
|
2149
2225
|
{
|
2150
|
-
"name": "
|
2226
|
+
"name": "event",
|
2151
2227
|
"type": {
|
2152
|
-
"text": "
|
2153
|
-
}
|
2154
|
-
"description": "The size to set."
|
2228
|
+
"text": "Event"
|
2229
|
+
}
|
2155
2230
|
}
|
2156
2231
|
],
|
2157
|
-
"description": "
|
2232
|
+
"description": "Toggles the state of the checkbox element.\nand dispatch the new change event."
|
2158
2233
|
},
|
2159
2234
|
{
|
2160
2235
|
"kind": "method",
|
2161
|
-
"name": "
|
2236
|
+
"name": "handleKeyDown",
|
2162
2237
|
"privacy": "private",
|
2238
|
+
"return": {
|
2239
|
+
"type": {
|
2240
|
+
"text": "void"
|
2241
|
+
}
|
2242
|
+
},
|
2163
2243
|
"parameters": [
|
2164
2244
|
{
|
2165
|
-
"name": "
|
2245
|
+
"name": "event",
|
2166
2246
|
"type": {
|
2167
|
-
"text": "
|
2247
|
+
"text": "KeyboardEvent"
|
2168
2248
|
},
|
2169
|
-
"description": "The
|
2249
|
+
"description": "The keyboard event."
|
2170
2250
|
}
|
2171
2251
|
],
|
2172
|
-
"description": "
|
2252
|
+
"description": "Handles the keydown event on the checkbox.\nWhen the user presses Enter, the form is submitted."
|
2173
2253
|
},
|
2174
2254
|
{
|
2175
|
-
"kind": "
|
2176
|
-
"name": "
|
2177
|
-
"privacy": "private",
|
2178
|
-
"description": "Infers the type of button based on the presence of slot and/or prefix and postfix icons.",
|
2179
|
-
"parameters": [
|
2180
|
-
{
|
2181
|
-
"description": "default slot of button",
|
2182
|
-
"name": "slot"
|
2183
|
-
}
|
2184
|
-
]
|
2255
|
+
"kind": "field",
|
2256
|
+
"name": "internals"
|
2185
2257
|
},
|
2186
2258
|
{
|
2187
2259
|
"kind": "field",
|
2188
|
-
"name": "
|
2260
|
+
"name": "helpTextType",
|
2189
2261
|
"type": {
|
2190
|
-
"text": "
|
2262
|
+
"text": "ValidationType"
|
2191
2263
|
},
|
2192
|
-
"
|
2193
|
-
"
|
2194
|
-
"attribute": "tabIndex",
|
2264
|
+
"description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
|
2265
|
+
"attribute": "help-text-type",
|
2195
2266
|
"reflects": true,
|
2267
|
+
"default": "undefined as unknown",
|
2196
2268
|
"inheritedFrom": {
|
2197
|
-
"name": "
|
2198
|
-
"module": "components/
|
2269
|
+
"name": "FormfieldWrapper",
|
2270
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
2199
2271
|
}
|
2200
2272
|
},
|
2201
2273
|
{
|
2202
2274
|
"kind": "field",
|
2203
|
-
"name": "
|
2275
|
+
"name": "name",
|
2204
2276
|
"type": {
|
2205
|
-
"text": "
|
2277
|
+
"text": "string"
|
2206
2278
|
},
|
2207
|
-
"default": "
|
2208
|
-
"description": "Indicates
|
2209
|
-
"attribute": "
|
2279
|
+
"default": "''",
|
2280
|
+
"description": "Indicates the name of the component group (ex: checkbox, radio group).\nThey are used to group elements in a form together.",
|
2281
|
+
"attribute": "name",
|
2210
2282
|
"reflects": true,
|
2211
2283
|
"inheritedFrom": {
|
2212
|
-
"name": "
|
2213
|
-
"module": "
|
2284
|
+
"name": "NameMixin",
|
2285
|
+
"module": "utils/mixins/NameMixin.js"
|
2214
2286
|
}
|
2215
2287
|
},
|
2216
2288
|
{
|
2217
2289
|
"kind": "field",
|
2218
|
-
"name": "
|
2290
|
+
"name": "value",
|
2219
2291
|
"type": {
|
2220
|
-
"text": "
|
2292
|
+
"text": "string"
|
2221
2293
|
},
|
2222
|
-
"default": "
|
2223
|
-
"description": "
|
2224
|
-
"attribute": "
|
2294
|
+
"default": "''",
|
2295
|
+
"description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
|
2296
|
+
"attribute": "value",
|
2225
2297
|
"reflects": true,
|
2226
2298
|
"inheritedFrom": {
|
2227
|
-
"name": "
|
2228
|
-
"module": "
|
2299
|
+
"name": "ValueMixin",
|
2300
|
+
"module": "utils/mixins/ValueMixin.js"
|
2229
2301
|
}
|
2230
2302
|
},
|
2231
2303
|
{
|
2232
2304
|
"kind": "field",
|
2233
|
-
"name": "
|
2305
|
+
"name": "dataAriaLabel",
|
2306
|
+
"type": {
|
2307
|
+
"text": "string | null"
|
2308
|
+
},
|
2309
|
+
"default": "null",
|
2310
|
+
"description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
|
2311
|
+
"attribute": "data-aria-label",
|
2312
|
+
"reflects": true,
|
2313
|
+
"inheritedFrom": {
|
2314
|
+
"name": "DataAriaLabelMixin",
|
2315
|
+
"module": "utils/mixins/DataAriaLabelMixin.js"
|
2316
|
+
}
|
2317
|
+
},
|
2318
|
+
{
|
2319
|
+
"kind": "field",
|
2320
|
+
"name": "disabled",
|
2234
2321
|
"type": {
|
2235
2322
|
"text": "boolean"
|
2236
2323
|
},
|
2237
2324
|
"default": "false",
|
2238
|
-
"description": "Indicates whether the
|
2239
|
-
"attribute": "
|
2325
|
+
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
2326
|
+
"attribute": "disabled",
|
2327
|
+
"reflects": true,
|
2240
2328
|
"inheritedFrom": {
|
2241
|
-
"name": "
|
2242
|
-
"module": "
|
2329
|
+
"name": "DisabledMixin",
|
2330
|
+
"module": "utils/mixins/DisabledMixin.js"
|
2243
2331
|
}
|
2244
2332
|
},
|
2245
2333
|
{
|
2246
2334
|
"kind": "field",
|
2247
|
-
"name": "
|
2335
|
+
"name": "label",
|
2248
2336
|
"type": {
|
2249
|
-
"text": "
|
2337
|
+
"text": "string | undefined"
|
2250
2338
|
},
|
2251
|
-
"description": "
|
2252
|
-
"
|
2253
|
-
"attribute": "type",
|
2339
|
+
"description": "The label of the input field. It is linked to the input field using the `for` attribute.",
|
2340
|
+
"attribute": "label",
|
2254
2341
|
"reflects": true,
|
2255
2342
|
"inheritedFrom": {
|
2256
|
-
"name": "
|
2257
|
-
"module": "components/
|
2343
|
+
"name": "FormfieldWrapper",
|
2344
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
2258
2345
|
}
|
2259
2346
|
},
|
2260
2347
|
{
|
2261
|
-
"kind": "
|
2262
|
-
"name": "
|
2263
|
-
"
|
2348
|
+
"kind": "field",
|
2349
|
+
"name": "requiredLabel",
|
2350
|
+
"type": {
|
2351
|
+
"text": "string | undefined"
|
2352
|
+
},
|
2353
|
+
"description": "The required label of the input field.\nWhen an appropriate string value is set,\nthe input field is marked as required and the label is appended with this text.",
|
2354
|
+
"attribute": "required-label",
|
2355
|
+
"reflects": true,
|
2264
2356
|
"inheritedFrom": {
|
2265
|
-
"name": "
|
2266
|
-
"module": "components/
|
2357
|
+
"name": "FormfieldWrapper",
|
2358
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
2359
|
+
}
|
2360
|
+
},
|
2361
|
+
{
|
2362
|
+
"kind": "field",
|
2363
|
+
"name": "id",
|
2364
|
+
"default": "`mdc-input-${uuidv4()}`",
|
2365
|
+
"description": "The unique id of the input field. It is used to link the input field with the label.",
|
2366
|
+
"attribute": "id",
|
2367
|
+
"inheritedFrom": {
|
2368
|
+
"name": "FormfieldWrapper",
|
2369
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
2370
|
+
}
|
2371
|
+
},
|
2372
|
+
{
|
2373
|
+
"kind": "field",
|
2374
|
+
"name": "helpText",
|
2375
|
+
"type": {
|
2376
|
+
"text": "string | undefined"
|
2377
|
+
},
|
2378
|
+
"description": "The help text that is displayed below the input field.",
|
2379
|
+
"attribute": "help-text",
|
2380
|
+
"reflects": true,
|
2381
|
+
"inheritedFrom": {
|
2382
|
+
"name": "FormfieldWrapper",
|
2383
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
2267
2384
|
}
|
2268
2385
|
},
|
2269
2386
|
{
|
2270
2387
|
"kind": "method",
|
2271
|
-
"name": "
|
2388
|
+
"name": "renderLabelElement",
|
2272
2389
|
"privacy": "protected",
|
2273
|
-
"
|
2274
|
-
|
2275
|
-
|
2276
|
-
"
|
2277
|
-
"text": "HTMLElement"
|
2278
|
-
},
|
2279
|
-
"description": "The button element"
|
2280
|
-
},
|
2281
|
-
{
|
2282
|
-
"name": "active",
|
2283
|
-
"type": {
|
2284
|
-
"text": "boolean"
|
2285
|
-
},
|
2286
|
-
"description": "The active state of the element"
|
2390
|
+
"description": "creates the label element when the label property is set.\nid is used to link the label with the input field.",
|
2391
|
+
"return": {
|
2392
|
+
"type": {
|
2393
|
+
"text": ""
|
2287
2394
|
}
|
2288
|
-
|
2289
|
-
"description": "Sets the aria-pressed attribute based on the active state of the button.",
|
2395
|
+
},
|
2290
2396
|
"inheritedFrom": {
|
2291
|
-
"name": "
|
2292
|
-
"module": "components/
|
2397
|
+
"name": "FormfieldWrapper",
|
2398
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
2293
2399
|
}
|
2294
2400
|
},
|
2295
2401
|
{
|
2296
2402
|
"kind": "method",
|
2297
|
-
"name": "
|
2298
|
-
"privacy": "
|
2299
|
-
"parameters": [
|
2300
|
-
{
|
2301
|
-
"name": "element",
|
2302
|
-
"type": {
|
2303
|
-
"text": "HTMLElement"
|
2304
|
-
},
|
2305
|
-
"description": "The button element."
|
2306
|
-
},
|
2307
|
-
{
|
2308
|
-
"name": "softDisabled",
|
2309
|
-
"type": {
|
2310
|
-
"text": "boolean"
|
2311
|
-
},
|
2312
|
-
"description": "The soft-disabled state."
|
2313
|
-
}
|
2314
|
-
],
|
2315
|
-
"description": "Sets the soft-disabled attribute for the button.\nWhen soft-disabled, the button looks to be disabled but remains focusable and clickable.\nAlso sets/removes aria-disabled attribute.",
|
2403
|
+
"name": "renderRequiredLabel",
|
2404
|
+
"privacy": "protected",
|
2316
2405
|
"inheritedFrom": {
|
2317
|
-
"name": "
|
2318
|
-
"module": "components/
|
2406
|
+
"name": "FormfieldWrapper",
|
2407
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
2319
2408
|
}
|
2320
2409
|
},
|
2321
2410
|
{
|
2322
2411
|
"kind": "method",
|
2323
|
-
"name": "
|
2324
|
-
"privacy": "
|
2325
|
-
"
|
2326
|
-
|
2327
|
-
|
2328
|
-
"
|
2329
|
-
"text": "HTMLElement"
|
2330
|
-
},
|
2331
|
-
"description": "The button element."
|
2332
|
-
},
|
2333
|
-
{
|
2334
|
-
"name": "disabled",
|
2335
|
-
"type": {
|
2336
|
-
"text": "boolean"
|
2337
|
-
},
|
2338
|
-
"description": "The disabled state."
|
2412
|
+
"name": "renderHelpTextIcon",
|
2413
|
+
"privacy": "protected",
|
2414
|
+
"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.",
|
2415
|
+
"return": {
|
2416
|
+
"type": {
|
2417
|
+
"text": ""
|
2339
2418
|
}
|
2340
|
-
|
2341
|
-
"description": "Sets the disabled attribute for the button.\nWhen disabled, the button is not focusable or clickable, and tabindex is set to -1.\nThe previous tabindex is stored and restored when enabled.\nAlso sets/removes aria-disabled attribute.",
|
2419
|
+
},
|
2342
2420
|
"inheritedFrom": {
|
2343
|
-
"name": "
|
2344
|
-
"module": "components/
|
2421
|
+
"name": "FormfieldWrapper",
|
2422
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
2345
2423
|
}
|
2346
2424
|
},
|
2347
2425
|
{
|
2348
2426
|
"kind": "method",
|
2349
|
-
"name": "
|
2350
|
-
"privacy": "
|
2427
|
+
"name": "renderHelpText",
|
2428
|
+
"privacy": "protected",
|
2429
|
+
"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.",
|
2430
|
+
"return": {
|
2431
|
+
"type": {
|
2432
|
+
"text": ""
|
2433
|
+
}
|
2434
|
+
},
|
2351
2435
|
"inheritedFrom": {
|
2352
|
-
"name": "
|
2353
|
-
"module": "components/
|
2436
|
+
"name": "FormfieldWrapper",
|
2437
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
2354
2438
|
}
|
2355
2439
|
},
|
2356
2440
|
{
|
2357
2441
|
"kind": "method",
|
2358
|
-
"name": "
|
2359
|
-
"privacy": "
|
2360
|
-
"
|
2361
|
-
|
2362
|
-
|
2363
|
-
"
|
2364
|
-
"text": "KeyboardEvent"
|
2365
|
-
},
|
2366
|
-
"description": "The keyboard event."
|
2442
|
+
"name": "renderLabel",
|
2443
|
+
"privacy": "protected",
|
2444
|
+
"description": "renders the mdc-label-text container that contains the label and labelInfoToggleTip.",
|
2445
|
+
"return": {
|
2446
|
+
"type": {
|
2447
|
+
"text": ""
|
2367
2448
|
}
|
2368
|
-
|
2369
|
-
"
|
2370
|
-
|
2371
|
-
"
|
2372
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
2449
|
+
},
|
2450
|
+
"inheritedFrom": {
|
2451
|
+
"name": "FormfieldWrapper",
|
2452
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
2373
2453
|
}
|
2374
2454
|
},
|
2375
2455
|
{
|
2376
2456
|
"kind": "method",
|
2377
|
-
"name": "
|
2378
|
-
"privacy": "
|
2379
|
-
"
|
2380
|
-
|
2381
|
-
|
2382
|
-
"
|
2383
|
-
"text": "KeyboardEvent"
|
2384
|
-
},
|
2385
|
-
"description": "The keyboard event."
|
2457
|
+
"name": "renderHelperText",
|
2458
|
+
"privacy": "protected",
|
2459
|
+
"description": "renders the mdc-help-text container that contains the helpertext icon and helpertext.",
|
2460
|
+
"return": {
|
2461
|
+
"type": {
|
2462
|
+
"text": ""
|
2386
2463
|
}
|
2387
|
-
|
2388
|
-
"description": "Handles the keyup event on the button.\nIf the key is 'Enter' or 'Space', the button is clicked.\nIf the key is 'Space', the button is pressed. The native HTML button works in the same way.",
|
2464
|
+
},
|
2389
2465
|
"inheritedFrom": {
|
2390
|
-
"name": "
|
2391
|
-
"module": "components/
|
2466
|
+
"name": "FormfieldWrapper",
|
2467
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
2392
2468
|
}
|
2393
2469
|
}
|
2394
2470
|
],
|
2395
|
-
"
|
2471
|
+
"events": [
|
2396
2472
|
{
|
2397
|
-
"name": "prefix-icon",
|
2398
2473
|
"type": {
|
2399
|
-
"text": "
|
2400
|
-
}
|
2401
|
-
"description": "The name of the icon to display as a prefix.\nThe icon is displayed on the left side of the button.",
|
2402
|
-
"fieldName": "prefixIcon"
|
2474
|
+
"text": "EventConstructor"
|
2475
|
+
}
|
2403
2476
|
},
|
2404
2477
|
{
|
2405
|
-
"
|
2406
|
-
"
|
2407
|
-
|
2408
|
-
|
2409
|
-
"description": "The name of the icon to display as a postfix.\nThe icon is displayed on the right side of the button.",
|
2410
|
-
"fieldName": "postfixIcon"
|
2478
|
+
"description": "(React: onChange) Event that gets dispatched when the checkbox state changes.",
|
2479
|
+
"name": "change",
|
2480
|
+
"reactName": "onChange",
|
2481
|
+
"eventName": "ChangeEvent"
|
2411
2482
|
},
|
2412
2483
|
{
|
2413
|
-
"
|
2484
|
+
"description": "(React: onFocus) Event that gets dispatched when the checkbox receives focus.",
|
2485
|
+
"name": "focus",
|
2486
|
+
"reactName": "onFocus",
|
2487
|
+
"eventName": "FocusEvent"
|
2488
|
+
}
|
2489
|
+
],
|
2490
|
+
"attributes": [
|
2491
|
+
{
|
2492
|
+
"name": "checked",
|
2414
2493
|
"type": {
|
2415
|
-
"text": "
|
2494
|
+
"text": "boolean"
|
2416
2495
|
},
|
2417
|
-
"
|
2418
|
-
"
|
2419
|
-
"fieldName": "
|
2496
|
+
"default": "false",
|
2497
|
+
"description": "Determines whether the checkbox is selected or unselected.",
|
2498
|
+
"fieldName": "checked"
|
2420
2499
|
},
|
2421
2500
|
{
|
2422
|
-
"name": "
|
2501
|
+
"name": "indeterminate",
|
2423
2502
|
"type": {
|
2424
|
-
"text": "
|
2503
|
+
"text": "boolean"
|
2425
2504
|
},
|
2426
|
-
"
|
2427
|
-
"
|
2428
|
-
"fieldName": "
|
2429
|
-
"inheritedFrom": {
|
2430
|
-
"name": "Buttonsimple",
|
2431
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
2432
|
-
}
|
2505
|
+
"default": "false",
|
2506
|
+
"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.",
|
2507
|
+
"fieldName": "indeterminate"
|
2433
2508
|
},
|
2434
2509
|
{
|
2435
|
-
"name": "
|
2510
|
+
"name": "name",
|
2436
2511
|
"type": {
|
2437
|
-
"text": "
|
2512
|
+
"text": "string"
|
2438
2513
|
},
|
2439
|
-
"
|
2440
|
-
"
|
2441
|
-
"fieldName": "
|
2514
|
+
"default": "''",
|
2515
|
+
"description": "Indicates the name of the component group (ex: checkbox, radio group).\nThey are used to group elements in a form together.",
|
2516
|
+
"fieldName": "name",
|
2517
|
+
"inheritedFrom": {
|
2518
|
+
"name": "NameMixin",
|
2519
|
+
"module": "src/utils/mixins/NameMixin.ts"
|
2520
|
+
}
|
2442
2521
|
},
|
2443
2522
|
{
|
2444
|
-
"name": "
|
2445
|
-
"description": "This property defines the ARIA role for the element. By default, it is set to 'button'.\nConsumers should override this role when:\n- The element is being used in a context where a different role is more appropriate.\n- Custom behaviors are implemented that require a specific ARIA role for accessibility purposes.",
|
2446
|
-
"default": "'button'",
|
2447
|
-
"fieldName": "role",
|
2523
|
+
"name": "value",
|
2448
2524
|
"type": {
|
2449
2525
|
"text": "string"
|
2450
2526
|
},
|
2527
|
+
"default": "''",
|
2528
|
+
"description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
|
2529
|
+
"fieldName": "value",
|
2451
2530
|
"inheritedFrom": {
|
2452
|
-
"name": "
|
2453
|
-
"module": "src/
|
2531
|
+
"name": "ValueMixin",
|
2532
|
+
"module": "src/utils/mixins/ValueMixin.ts"
|
2454
2533
|
}
|
2455
2534
|
},
|
2456
2535
|
{
|
2457
|
-
"name": "
|
2536
|
+
"name": "data-aria-label",
|
2458
2537
|
"type": {
|
2459
|
-
"text": "
|
2538
|
+
"text": "string | null"
|
2460
2539
|
},
|
2461
|
-
"default": "
|
2462
|
-
"description": "
|
2463
|
-
"fieldName": "
|
2540
|
+
"default": "null",
|
2541
|
+
"description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
|
2542
|
+
"fieldName": "dataAriaLabel",
|
2464
2543
|
"inheritedFrom": {
|
2465
|
-
"name": "
|
2466
|
-
"module": "src/
|
2544
|
+
"name": "DataAriaLabelMixin",
|
2545
|
+
"module": "src/utils/mixins/DataAriaLabelMixin.ts"
|
2467
2546
|
}
|
2468
2547
|
},
|
2469
2548
|
{
|
@@ -2475,57 +2554,100 @@
|
|
2475
2554
|
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
2476
2555
|
"fieldName": "disabled",
|
2477
2556
|
"inheritedFrom": {
|
2478
|
-
"name": "
|
2479
|
-
"module": "src/
|
2557
|
+
"name": "DisabledMixin",
|
2558
|
+
"module": "src/utils/mixins/DisabledMixin.ts"
|
2480
2559
|
}
|
2481
2560
|
},
|
2482
2561
|
{
|
2483
|
-
"name": "
|
2562
|
+
"name": "label",
|
2484
2563
|
"type": {
|
2485
|
-
"text": "
|
2564
|
+
"text": "string | undefined"
|
2486
2565
|
},
|
2487
|
-
"
|
2488
|
-
"
|
2489
|
-
"fieldName": "active",
|
2566
|
+
"description": "The label of the input field. It is linked to the input field using the `for` attribute.",
|
2567
|
+
"fieldName": "label",
|
2490
2568
|
"inheritedFrom": {
|
2491
|
-
"name": "
|
2492
|
-
"module": "src/components/
|
2569
|
+
"name": "FormfieldWrapper",
|
2570
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
2493
2571
|
}
|
2494
2572
|
},
|
2495
2573
|
{
|
2496
|
-
"name": "
|
2574
|
+
"name": "required-label",
|
2497
2575
|
"type": {
|
2498
|
-
"text": "
|
2576
|
+
"text": "string | undefined"
|
2499
2577
|
},
|
2500
|
-
"
|
2501
|
-
"
|
2502
|
-
"fieldName": "softDisabled",
|
2578
|
+
"description": "The required label of the input field.\nWhen an appropriate string value is set,\nthe input field is marked as required and the label is appended with this text.",
|
2579
|
+
"fieldName": "requiredLabel",
|
2503
2580
|
"inheritedFrom": {
|
2504
|
-
"name": "
|
2505
|
-
"module": "src/components/
|
2581
|
+
"name": "FormfieldWrapper",
|
2582
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
2506
2583
|
}
|
2507
2584
|
},
|
2508
2585
|
{
|
2509
|
-
"name": "
|
2586
|
+
"name": "id",
|
2587
|
+
"default": "`mdc-input-${uuidv4()}`",
|
2588
|
+
"description": "The unique id of the input field. It is used to link the input field with the label.",
|
2589
|
+
"fieldName": "id",
|
2590
|
+
"inheritedFrom": {
|
2591
|
+
"name": "FormfieldWrapper",
|
2592
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
2593
|
+
}
|
2594
|
+
},
|
2595
|
+
{
|
2596
|
+
"name": "help-text-type",
|
2510
2597
|
"type": {
|
2511
|
-
"text": "
|
2598
|
+
"text": "ValidationType"
|
2512
2599
|
},
|
2513
|
-
"description": "
|
2514
|
-
"
|
2515
|
-
"fieldName": "type",
|
2600
|
+
"description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
|
2601
|
+
"fieldName": "helpTextType",
|
2516
2602
|
"inheritedFrom": {
|
2517
|
-
"name": "
|
2518
|
-
"module": "src/components/
|
2603
|
+
"name": "FormfieldWrapper",
|
2604
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
2605
|
+
}
|
2606
|
+
},
|
2607
|
+
{
|
2608
|
+
"name": "help-text",
|
2609
|
+
"type": {
|
2610
|
+
"text": "string | undefined"
|
2611
|
+
},
|
2612
|
+
"description": "The help text that is displayed below the input field.",
|
2613
|
+
"fieldName": "helpText",
|
2614
|
+
"inheritedFrom": {
|
2615
|
+
"name": "FormfieldWrapper",
|
2616
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
2519
2617
|
}
|
2520
2618
|
}
|
2521
2619
|
],
|
2620
|
+
"mixins": [
|
2621
|
+
{
|
2622
|
+
"name": "NameMixin",
|
2623
|
+
"module": "/src/utils/mixins/NameMixin"
|
2624
|
+
},
|
2625
|
+
{
|
2626
|
+
"name": "ValueMixin",
|
2627
|
+
"module": "/src/utils/mixins/ValueMixin"
|
2628
|
+
},
|
2629
|
+
{
|
2630
|
+
"name": "DataAriaLabelMixin",
|
2631
|
+
"module": "/src/utils/mixins/DataAriaLabelMixin"
|
2632
|
+
}
|
2633
|
+
],
|
2522
2634
|
"superclass": {
|
2523
|
-
"name": "
|
2524
|
-
"module": "/src/components/
|
2635
|
+
"name": "FormfieldWrapper",
|
2636
|
+
"module": "/src/components/formfieldwrapper/formfieldwrapper.component"
|
2525
2637
|
},
|
2526
|
-
"tagName": "mdc-
|
2527
|
-
"jsDoc": "/**\n *
|
2528
|
-
"customElement": true
|
2638
|
+
"tagName": "mdc-checkbox",
|
2639
|
+
"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-icon\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-border-color - Border color in high contrast.\n * @cssproperty --mdc-checkbox-checked-background-color - Background color for a selected checkbox.\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-disabled-background-color - Background color for a disabled checkbox.\n * @cssproperty --mdc-checkbox-disabled-border-color - Border color for a disabled checkbox.\n * @cssproperty --mdc-checkbox-disabled-checked-icon-color - Background color for a disabled, selected checkbox.\n * @cssproperty --mdc-checkbox-disabled-icon-color - Icon color for a disabled checkbox.\n * @cssproperty --mdc-checkbox-icon-background-color - Background color for an unselected checkbox.\n * @cssproperty --mdc-checkbox-icon-border-color - Default background color for an unselected checkbox.\n * @cssproperty --mdc-checkbox-icon-color - Icon color for an unselected checkbox.\n * @cssproperty --mdc-checkbox-pressed-icon-color - Background color for a selected checkbox when pressed.\n */",
|
2640
|
+
"customElement": true,
|
2641
|
+
"slots": [
|
2642
|
+
{
|
2643
|
+
"description": "slot to add the label info icon",
|
2644
|
+
"name": "label-info",
|
2645
|
+
"inheritedFrom": {
|
2646
|
+
"name": "FormfieldWrapper",
|
2647
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
2648
|
+
}
|
2649
|
+
}
|
2650
|
+
]
|
2529
2651
|
}
|
2530
2652
|
],
|
2531
2653
|
"exports": [
|
@@ -2533,8 +2655,8 @@
|
|
2533
2655
|
"kind": "js",
|
2534
2656
|
"name": "default",
|
2535
2657
|
"declaration": {
|
2536
|
-
"name": "
|
2537
|
-
"module": "components/
|
2658
|
+
"name": "Checkbox",
|
2659
|
+
"module": "components/checkbox/checkbox.component.js"
|
2538
2660
|
}
|
2539
2661
|
}
|
2540
2662
|
]
|
@@ -4294,6 +4416,30 @@
|
|
4294
4416
|
"type": {
|
4295
4417
|
"text": "EventConstructor"
|
4296
4418
|
}
|
4419
|
+
},
|
4420
|
+
{
|
4421
|
+
"description": "(React: onInput) This event is dispatched when the value of the input field changes (every press).",
|
4422
|
+
"name": "input",
|
4423
|
+
"reactName": "onInput",
|
4424
|
+
"eventName": "InputEvent"
|
4425
|
+
},
|
4426
|
+
{
|
4427
|
+
"description": "(React: onChange) This event is dispatched when the value of the input field changes (on blur).",
|
4428
|
+
"name": "change",
|
4429
|
+
"reactName": "onChange",
|
4430
|
+
"eventName": "ChangeEvent"
|
4431
|
+
},
|
4432
|
+
{
|
4433
|
+
"description": "(React: onFocus) This event is dispatched when the input receives focus.",
|
4434
|
+
"name": "focus",
|
4435
|
+
"reactName": "onFocus",
|
4436
|
+
"eventName": "FocusEvent"
|
4437
|
+
},
|
4438
|
+
{
|
4439
|
+
"description": "(React: onBlur) This event is dispatched when the input loses focus.",
|
4440
|
+
"name": "blur",
|
4441
|
+
"reactName": "onBlur",
|
4442
|
+
"eventName": "BlurEvent"
|
4297
4443
|
}
|
4298
4444
|
],
|
4299
4445
|
"attributes": [
|
@@ -4555,7 +4701,7 @@
|
|
4555
4701
|
"module": "/src/components/formfieldwrapper"
|
4556
4702
|
},
|
4557
4703
|
"tagName": "mdc-input",
|
4558
|
-
"jsDoc": "/**\n * mdc-input is a component that allows users to input text.\n * It contains:\n * - label field - describe the input field.\n * - input field - contains the value\n * - help text or validation message - displayed below the input field.\n * - trailing button - it displays a clear the input field.\n * - prefix text - displayed before the input field.\n * - leading icon - displayed before the input field.\n * - clear-aria-label - aria label for the trailing button.\n * - all the attributes of the input field.\n *\n * @tagname mdc-input\n *\n * @dependency mdc-icon\n * @dependency mdc-text\n * @dependency mdc-button\n *\n * @cssproperty --mdc-input-disabled-border-color - Border color for the input container when disabled\n * @cssproperty --mdc-input-disabled-text-color - Text color for the input field when disabled\n * @cssproperty --mdc-input-disabled-background-color - Background color for the input field when disabled\n * @cssproperty --mdc-input-border-color - Border color for the input container\n * @cssproperty --mdc-input-text-color - Text color for the input field\n * @cssproperty --mdc-input-background-color - Background color for the input field\n * @cssproperty --mdc-input-selection-background-color - Background color for the selected text\n * @cssproperty --mdc-input-selection-text-color - Text color for the selected text\n * @cssproperty --mdc-input-support-text-color - Text color for the help text\n * @cssproperty --mdc-input-hover-background-color - Background color for the input field when hovered\n * @cssproperty --mdc-input-focused-background-color - Background color for the input field when focused\n * @cssproperty --mdc-input-focused-border-color - Border color for the input container when focused\n * @cssproperty --mdc-input-error-border-color - Border color for the input container when error\n * @cssproperty --mdc-input-warning-border-color - Border color for the input container when warning\n * @cssproperty --mdc-input-success-border-color - Border color for the input container when success\n * @cssproperty --mdc-input-primary-border-color - Border color for the input container when primary\n *\n */",
|
4704
|
+
"jsDoc": "/**\n * mdc-input is a component that allows users to input text.\n * It contains:\n * - label field - describe the input field.\n * - input field - contains the value\n * - help text or validation message - displayed below the input field.\n * - trailing button - it displays a clear the input field.\n * - prefix text - displayed before the input field.\n * - leading icon - displayed before the input field.\n * - clear-aria-label - aria label for the trailing button.\n * - all the attributes of the input field.\n *\n * @tagname mdc-input\n *\n * @event input - (React: onInput) This event is dispatched when the value of the input field changes (every press).\n * @event change - (React: onChange) This event is dispatched when the value of the input field changes (on blur).\n * @event focus - (React: onFocus) This event is dispatched when the input receives focus.\n * @event blur - (React: onBlur) This event is dispatched when the input loses focus.\n *\n * @dependency mdc-icon\n * @dependency mdc-text\n * @dependency mdc-button\n *\n * @cssproperty --mdc-input-disabled-border-color - Border color for the input container when disabled\n * @cssproperty --mdc-input-disabled-text-color - Text color for the input field when disabled\n * @cssproperty --mdc-input-disabled-background-color - Background color for the input field when disabled\n * @cssproperty --mdc-input-border-color - Border color for the input container\n * @cssproperty --mdc-input-text-color - Text color for the input field\n * @cssproperty --mdc-input-background-color - Background color for the input field\n * @cssproperty --mdc-input-selection-background-color - Background color for the selected text\n * @cssproperty --mdc-input-selection-text-color - Text color for the selected text\n * @cssproperty --mdc-input-support-text-color - Text color for the help text\n * @cssproperty --mdc-input-hover-background-color - Background color for the input field when hovered\n * @cssproperty --mdc-input-focused-background-color - Background color for the input field when focused\n * @cssproperty --mdc-input-focused-border-color - Border color for the input container when focused\n * @cssproperty --mdc-input-error-border-color - Border color for the input container when error\n * @cssproperty --mdc-input-warning-border-color - Border color for the input container when warning\n * @cssproperty --mdc-input-success-border-color - Border color for the input container when success\n * @cssproperty --mdc-input-primary-border-color - Border color for the input container when primary\n *\n */",
|
4559
4705
|
"customElement": true,
|
4560
4706
|
"slots": [
|
4561
4707
|
{
|
@@ -5593,6 +5739,18 @@
|
|
5593
5739
|
"type": {
|
5594
5740
|
"text": "EventConstructor"
|
5595
5741
|
}
|
5742
|
+
},
|
5743
|
+
{
|
5744
|
+
"description": "(React: onChange) Event that gets dispatched when the radio state changes.",
|
5745
|
+
"name": "change",
|
5746
|
+
"reactName": "onChange",
|
5747
|
+
"eventName": "ChangeEvent"
|
5748
|
+
},
|
5749
|
+
{
|
5750
|
+
"description": "(React: onFocus) Event that gets dispatched when the radio receives focus.",
|
5751
|
+
"name": "focus",
|
5752
|
+
"reactName": "onFocus",
|
5753
|
+
"eventName": "FocusEvent"
|
5596
5754
|
}
|
5597
5755
|
],
|
5598
5756
|
"attributes": [
|
@@ -5744,7 +5902,7 @@
|
|
5744
5902
|
"module": "/src/components/formfieldwrapper/formfieldwrapper.component"
|
5745
5903
|
},
|
5746
5904
|
"tagName": "mdc-radio",
|
5747
|
-
"jsDoc": "/**\n * Radio allow users to select single options from a list or turn an item/feature on or off.\n * These are often used in forms, settings, and selection in lists.\n *\n * A radio component contains an optional label, optional info icon and an optional helper text.\n * @dependency mdc-formfieldwrapper\n *\n * @tagname mdc-radio\n *\n * @cssproperty --mdc-radio-inner-circle-size - size of the inner circle\n * @cssproperty --mdc-radio-text-disabled-color - color of the label when disabled\n * @cssproperty --mdc-radio-disabled-border-color - color of the radio button border when disabled\n * @cssproperty --mdc-radio-normal-border-color - color of the radio button border when normal\n * @cssproperty --mdc-radio-inner-circle-normal-background - background color of the inner circle when normal\n * @cssproperty --mdc-radio-inner-circle-disabled-background - background color of the inner circle when disabled\n * @cssproperty --mdc-radio-control-inactive-color - color of the radio button when inactive\n * @cssproperty --mdc-radio-control-inactive-hover - color of the radio button when inactive and hovered\n * @cssproperty --mdc-radio-control-inactive-pressed-color - color of the radio button when inactive and pressed\n * @cssproperty --mdc-radio-control-inactive-disabled-background - background color of the radio button when\n * inactive and disabled\n * @cssproperty --mdc-radio-control-active-color - color of the radio button when active\n * @cssproperty --mdc-radio-control-active-hover-color - color of the radio button when active and hovered\n * @cssproperty --mdc-radio-control-active-pressed-color - color of the radio button when active and pressed\n * @cssproperty --mdc-radio-control-active-disabled-background - background color of the radio button\n * when active and disabled\n *\n */",
|
5905
|
+
"jsDoc": "/**\n * Radio allow users to select single options from a list or turn an item/feature on or off.\n * These are often used in forms, settings, and selection in lists.\n *\n * A radio component contains an optional label, optional info icon and an optional helper text.\n * @dependency mdc-formfieldwrapper\n *\n * @tagname mdc-radio\n *\n * @event change - (React: onChange) Event that gets dispatched when the radio state changes.\n * @event focus - (React: onFocus) Event that gets dispatched when the radio receives focus.\n *\n * @cssproperty --mdc-radio-inner-circle-size - size of the inner circle\n * @cssproperty --mdc-radio-text-disabled-color - color of the label when disabled\n * @cssproperty --mdc-radio-disabled-border-color - color of the radio button border when disabled\n * @cssproperty --mdc-radio-normal-border-color - color of the radio button border when normal\n * @cssproperty --mdc-radio-inner-circle-normal-background - background color of the inner circle when normal\n * @cssproperty --mdc-radio-inner-circle-disabled-background - background color of the inner circle when disabled\n * @cssproperty --mdc-radio-control-inactive-color - color of the radio button when inactive\n * @cssproperty --mdc-radio-control-inactive-hover - color of the radio button when inactive and hovered\n * @cssproperty --mdc-radio-control-inactive-pressed-color - color of the radio button when inactive and pressed\n * @cssproperty --mdc-radio-control-inactive-disabled-background - background color of the radio button when\n * inactive and disabled\n * @cssproperty --mdc-radio-control-active-color - color of the radio button when active\n * @cssproperty --mdc-radio-control-active-hover-color - color of the radio button when active and hovered\n * @cssproperty --mdc-radio-control-active-pressed-color - color of the radio button when active and pressed\n * @cssproperty --mdc-radio-control-active-disabled-background - background color of the radio button\n * when active and disabled\n *\n */",
|
5748
5906
|
"customElement": true,
|
5749
5907
|
"slots": [
|
5750
5908
|
{
|
@@ -6426,6 +6584,48 @@
|
|
6426
6584
|
}
|
6427
6585
|
}
|
6428
6586
|
],
|
6587
|
+
"events": [
|
6588
|
+
{
|
6589
|
+
"description": "(React: onClick) This event is dispatched when the tab is clicked.",
|
6590
|
+
"name": "click",
|
6591
|
+
"reactName": "onClick",
|
6592
|
+
"eventName": "ClickEvent",
|
6593
|
+
"inheritedFrom": {
|
6594
|
+
"name": "Buttonsimple",
|
6595
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
6596
|
+
}
|
6597
|
+
},
|
6598
|
+
{
|
6599
|
+
"description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the tab.",
|
6600
|
+
"name": "keydown",
|
6601
|
+
"reactName": "onKeyDown",
|
6602
|
+
"eventName": "KeydownEvent",
|
6603
|
+
"inheritedFrom": {
|
6604
|
+
"name": "Buttonsimple",
|
6605
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
6606
|
+
}
|
6607
|
+
},
|
6608
|
+
{
|
6609
|
+
"description": "(React: onKeyUp) This event is dispatched when a key is released on the tab.",
|
6610
|
+
"name": "keyup",
|
6611
|
+
"reactName": "onKeyUp",
|
6612
|
+
"eventName": "KeyupEvent",
|
6613
|
+
"inheritedFrom": {
|
6614
|
+
"name": "Buttonsimple",
|
6615
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
6616
|
+
}
|
6617
|
+
},
|
6618
|
+
{
|
6619
|
+
"description": "(React: onFocus) This event is dispatched when the tab receives focus.",
|
6620
|
+
"name": "focus",
|
6621
|
+
"reactName": "onFocus",
|
6622
|
+
"eventName": "FocusEvent",
|
6623
|
+
"inheritedFrom": {
|
6624
|
+
"name": "Buttonsimple",
|
6625
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
6626
|
+
}
|
6627
|
+
}
|
6628
|
+
],
|
6429
6629
|
"attributes": [
|
6430
6630
|
{
|
6431
6631
|
"name": "text",
|
@@ -6556,7 +6756,7 @@
|
|
6556
6756
|
"module": "/src/components/buttonsimple/buttonsimple.component"
|
6557
6757
|
},
|
6558
6758
|
"tagName": "mdc-tab",
|
6559
|
-
"jsDoc": "/**\n * `mdc-tab` is Tab component to be used within the Tabgroup.\n *\n * Passing in the attribute `text` to the tab component is changing the text displayed in the tab.\n *\n * The `slot=\"badge\"` can be used to add a badge to the tab.\n *\n * The `slot=\"chip\"` can be used to add a chip to the tab.\n *\n * For `icon`, the `mdc-icon` component is used to render the icon.\n *\n * Note: Icons can be used in conjunction with badges or chips.\n * Badges and chips should not be used at the same time.\n *\n * @dependency mdc-icon\n * @dependency mdc-text\n *\n * @tagname mdc-tab\n *\n * @cssproperty --mdc-tab-content-gap - Gap between the badge(if provided), icon and text.\n * @cssproperty --mdc-tab-height - Height of the tab.\n * @cssproperty --mdc-tab-glass-active-background-color-disabled - Background color for active glass tab\n * in disabled state.\n * @cssproperty --mdc-tab-glass-active-background-color-hover - Background color for active glass tab in hover state.\n * @cssproperty --mdc-tab-glass-active-background-color-normal - Background color for active glass tab in rest state.\n * @cssproperty --mdc-tab-glass-active-background-color-pressed - Background color for active glass tab\n * in pressed state.\n * @cssproperty --mdc-tab-glass-active-color - Text and icon color for active glass tab.\n * @cssproperty --mdc-tab-glass-active-color-disabled - Text and icon color for active glass tab in disabled state.\n * @cssproperty --mdc-tab-glass-border-radius - Border radius for glass tab.\n * @cssproperty --mdc-tab-glass-inactive-background-color-disabled - Background color for inactive glass tab\n * in disabled state.\n * @cssproperty --mdc-tab-glass-inactive-background-color-hover - Background color for inactive glass tab\n * in hover state.\n * @cssproperty --mdc-tab-glass-inactive-background-color-normal - Background color for inactive glass tab\n * in rest state.\n * @cssproperty --mdc-tab-glass-inactive-background-color-pressed - Background color for inactive glass tab\n * in pressed state.\n * @cssproperty --mdc-tab-glass-inactive-color - Text and icon color for inactive glass tab.\n * @cssproperty --mdc-tab-glass-inactive-color-disabled - Text and icon color for inactive glass tab in disabled state.\n * @cssproperty --mdc-tab-line-active-background-color-pressed - Background color for active line tab in pressed state.\n * @cssproperty --mdc-tab-line-active-background-color-disabled - Background color for active line tab\n * in disabled state.\n * @cssproperty --mdc-tab-line-active-background-color-hover - Background color for active line tab in hover state.\n * @cssproperty --mdc-tab-line-active-background-color-normal - Background color for active line tab in rest state.\n * @cssproperty --mdc-tab-line-active-color - Text and icon color for active line tab.\n * @cssproperty --mdc-tab-line-active-color-disabled - Text and icon color for active line tab in disabled state.\n * @cssproperty --mdc-tab-line-active-indicator-color - color for indicator in active line tab.\n * @cssproperty --mdc-tab-line-active-indicator-color-disabled - Color for indicator in active line tab\n * in disabled state.\n * @cssproperty --mdc-tab-line-active-indicator-height - Height for indicator in active line tab.\n * @cssproperty --mdc-tab-line-active-indicator-width - Width for indicator in active line tab.\n * @cssproperty --mdc-tab-line-border-bottom-left-radius - Bottom left border radius for line tab.\n * @cssproperty --mdc-tab-line-border-bottom-right-radius - Bottom right border radius for line tab.\n * @cssproperty --mdc-tab-line-border-top-left-radius - Top left border radius for line tab.\n * @cssproperty --mdc-tab-line-border-top-right-radius - Top right border radius for line tab.\n * @cssproperty --mdc-tab-line-inactive-background-color-pressed - Background color for inactive line tab\n * in pressed state.\n * @cssproperty --mdc-tab-line-inactive-background-color-disabled - Background color for inactive line tab\n * in disabled state\n * @cssproperty --mdc-tab-line-inactive-background-color-hover - Background color for inactive line tab in hover state.\n * @cssproperty --mdc-tab-line-inactive-background-color-normal - Background color for inactive line tab\n * in rest state.\n * @cssproperty --mdc-tab-line-inactive-color - Text and icon color for inactive line tab.\n * @cssproperty --mdc-tab-line-inactive-color-disabled - Text and icon color for inactive line tab in disabled state.\n * @cssproperty --mdc-tab-padding-left - Padding left for the tab.\n * @cssproperty --mdc-tab-padding-right - Padding right for the tab.\n * @cssproperty --mdc-tab-pill-active-background-color-pressed - Background color for active pill tab in pressed state.\n * @cssproperty --mdc-tab-pill-active-background-color-disabled - Background color for active pill tab\n * in disabled state.\n * @cssproperty --mdc-tab-pill-active-background-color-hover - Background color for active pill tab in hover state.\n * @cssproperty --mdc-tab-pill-active-background-color-normal - Background color for active pill tab in rest state.\n * @cssproperty --mdc-tab-pill-active-color - Text and icon color for active pill tab.\n * @cssproperty --mdc-tab-pill-active-color-disabled - Text and icon color for active pill tab in disabled state.\n * @cssproperty --mdc-tab-pill-border-radius - Border radius for pill tab.\n * @cssproperty --mdc-tab-pill-inactive-background-color-pressed - Background color for inactive pill tab\n * in pressed state.\n * @cssproperty --mdc-tab-pill-inactive-background-color-disabled - Background color for inactive pill tab\n * in disabled state.\n * @cssproperty --mdc-tab-pill-inactive-background-color-hover - Background color for inactive pill tab in hover state.\n * @cssproperty --mdc-tab-pill-inactive-background-color-normal - Background color for inactive pill tab in rest state.\n * @cssproperty --mdc-tab-pill-inactive-color - Text and icon color for inactive pill tab.\n * @cssproperty --mdc-tab-pill-inactive-color-disabled - Text and icon color for inactive pill tab in disabled state.\n */",
|
6759
|
+
"jsDoc": "/**\n * `mdc-tab` is Tab component to be used within the Tabgroup.\n *\n * Passing in the attribute `text` to the tab component is changing the text displayed in the tab.\n *\n * The `slot=\"badge\"` can be used to add a badge to the tab.\n *\n * The `slot=\"chip\"` can be used to add a chip to the tab.\n *\n * For `icon`, the `mdc-icon` component is used to render the icon.\n *\n * Note: Icons can be used in conjunction with badges or chips.\n * Badges and chips should not be used at the same time.\n *\n * @dependency mdc-icon\n * @dependency mdc-text\n *\n * @event click - (React: onClick) This event is dispatched when the tab is clicked.\n * @event keydown - (React: onKeyDown) This event is dispatched when a key is pressed down on the tab.\n * @event keyup - (React: onKeyUp) This event is dispatched when a key is released on the tab.\n * @event focus - (React: onFocus) This event is dispatched when the tab receives focus.\n *\n * @tagname mdc-tab\n *\n * @cssproperty --mdc-tab-content-gap - Gap between the badge(if provided), icon and text.\n * @cssproperty --mdc-tab-height - Height of the tab.\n * @cssproperty --mdc-tab-glass-active-background-color-disabled - Background color for active glass tab\n * in disabled state.\n * @cssproperty --mdc-tab-glass-active-background-color-hover - Background color for active glass tab in hover state.\n * @cssproperty --mdc-tab-glass-active-background-color-normal - Background color for active glass tab in rest state.\n * @cssproperty --mdc-tab-glass-active-background-color-pressed - Background color for active glass tab\n * in pressed state.\n * @cssproperty --mdc-tab-glass-active-color - Text and icon color for active glass tab.\n * @cssproperty --mdc-tab-glass-active-color-disabled - Text and icon color for active glass tab in disabled state.\n * @cssproperty --mdc-tab-glass-border-radius - Border radius for glass tab.\n * @cssproperty --mdc-tab-glass-inactive-background-color-disabled - Background color for inactive glass tab\n * in disabled state.\n * @cssproperty --mdc-tab-glass-inactive-background-color-hover - Background color for inactive glass tab\n * in hover state.\n * @cssproperty --mdc-tab-glass-inactive-background-color-normal - Background color for inactive glass tab\n * in rest state.\n * @cssproperty --mdc-tab-glass-inactive-background-color-pressed - Background color for inactive glass tab\n * in pressed state.\n * @cssproperty --mdc-tab-glass-inactive-color - Text and icon color for inactive glass tab.\n * @cssproperty --mdc-tab-glass-inactive-color-disabled - Text and icon color for inactive glass tab in disabled state.\n * @cssproperty --mdc-tab-line-active-background-color-pressed - Background color for active line tab in pressed state.\n * @cssproperty --mdc-tab-line-active-background-color-disabled - Background color for active line tab\n * in disabled state.\n * @cssproperty --mdc-tab-line-active-background-color-hover - Background color for active line tab in hover state.\n * @cssproperty --mdc-tab-line-active-background-color-normal - Background color for active line tab in rest state.\n * @cssproperty --mdc-tab-line-active-color - Text and icon color for active line tab.\n * @cssproperty --mdc-tab-line-active-color-disabled - Text and icon color for active line tab in disabled state.\n * @cssproperty --mdc-tab-line-active-indicator-color - color for indicator in active line tab.\n * @cssproperty --mdc-tab-line-active-indicator-color-disabled - Color for indicator in active line tab\n * in disabled state.\n * @cssproperty --mdc-tab-line-active-indicator-height - Height for indicator in active line tab.\n * @cssproperty --mdc-tab-line-active-indicator-width - Width for indicator in active line tab.\n * @cssproperty --mdc-tab-line-border-bottom-left-radius - Bottom left border radius for line tab.\n * @cssproperty --mdc-tab-line-border-bottom-right-radius - Bottom right border radius for line tab.\n * @cssproperty --mdc-tab-line-border-top-left-radius - Top left border radius for line tab.\n * @cssproperty --mdc-tab-line-border-top-right-radius - Top right border radius for line tab.\n * @cssproperty --mdc-tab-line-inactive-background-color-pressed - Background color for inactive line tab\n * in pressed state.\n * @cssproperty --mdc-tab-line-inactive-background-color-disabled - Background color for inactive line tab\n * in disabled state\n * @cssproperty --mdc-tab-line-inactive-background-color-hover - Background color for inactive line tab in hover state.\n * @cssproperty --mdc-tab-line-inactive-background-color-normal - Background color for inactive line tab\n * in rest state.\n * @cssproperty --mdc-tab-line-inactive-color - Text and icon color for inactive line tab.\n * @cssproperty --mdc-tab-line-inactive-color-disabled - Text and icon color for inactive line tab in disabled state.\n * @cssproperty --mdc-tab-padding-left - Padding left for the tab.\n * @cssproperty --mdc-tab-padding-right - Padding right for the tab.\n * @cssproperty --mdc-tab-pill-active-background-color-pressed - Background color for active pill tab in pressed state.\n * @cssproperty --mdc-tab-pill-active-background-color-disabled - Background color for active pill tab\n * in disabled state.\n * @cssproperty --mdc-tab-pill-active-background-color-hover - Background color for active pill tab in hover state.\n * @cssproperty --mdc-tab-pill-active-background-color-normal - Background color for active pill tab in rest state.\n * @cssproperty --mdc-tab-pill-active-color - Text and icon color for active pill tab.\n * @cssproperty --mdc-tab-pill-active-color-disabled - Text and icon color for active pill tab in disabled state.\n * @cssproperty --mdc-tab-pill-border-radius - Border radius for pill tab.\n * @cssproperty --mdc-tab-pill-inactive-background-color-pressed - Background color for inactive pill tab\n * in pressed state.\n * @cssproperty --mdc-tab-pill-inactive-background-color-disabled - Background color for inactive pill tab\n * in disabled state.\n * @cssproperty --mdc-tab-pill-inactive-background-color-hover - Background color for inactive pill tab in hover state.\n * @cssproperty --mdc-tab-pill-inactive-background-color-normal - Background color for inactive pill tab in rest state.\n * @cssproperty --mdc-tab-pill-inactive-color - Text and icon color for inactive pill tab.\n * @cssproperty --mdc-tab-pill-inactive-color-disabled - Text and icon color for inactive pill tab in disabled state.\n */",
|
6560
6760
|
"customElement": true
|
6561
6761
|
}
|
6562
6762
|
],
|
@@ -7118,6 +7318,18 @@
|
|
7118
7318
|
"type": {
|
7119
7319
|
"text": "EventConstructor"
|
7120
7320
|
}
|
7321
|
+
},
|
7322
|
+
{
|
7323
|
+
"description": "(React: onChange) Event that gets dispatched when the toggle state changes.",
|
7324
|
+
"name": "change",
|
7325
|
+
"reactName": "onChange",
|
7326
|
+
"eventName": "ChangeEvent"
|
7327
|
+
},
|
7328
|
+
{
|
7329
|
+
"description": "(React: onFocus) Event that gets dispatched when the toggle receives focus.",
|
7330
|
+
"name": "focus",
|
7331
|
+
"reactName": "onFocus",
|
7332
|
+
"eventName": "FocusEvent"
|
7121
7333
|
}
|
7122
7334
|
],
|
7123
7335
|
"attributes": [
|
@@ -7269,7 +7481,7 @@
|
|
7269
7481
|
"module": "/src/components/formfieldwrapper"
|
7270
7482
|
},
|
7271
7483
|
"tagName": "mdc-toggle",
|
7272
|
-
"jsDoc": "/**\n * Toggle Component is an interactive control used to switch between two mutually exclusive options,\n * such as On/Off, Active/Inactive. These are commonly used in settings panels, forms, and preference selections\n * where users need to enable or disable a feature.\n * It contains an optional label and an optional helper text.\n *\n * To create a group of toggles, use the FormFieldGroup component.\n *\n * Note: It internally renders a checkbox styled as a toggle switch.\n *\n * @dependency mdc-icon\n *\n * @tagname mdc-toggle\n *\n * @cssproperty --mdc-toggle-width - width of the toggle\n * @cssproperty --mdc-toggle-height - height of the toggle\n * @cssproperty --mdc-toggle-width-compact - width of the toggle when it's size is compact\n * @cssproperty --mdc-toggle-height-compact - height of the toggle when it's size is compact\n * @cssproperty --mdc-toggle-border-radius - border radius of the toggle\n * @cssproperty --mdc-toggle-border-radius-compact - border radius of the toggle when it's size is compact\n * @cssproperty --mdc-toggle-border - border of the toggle\n * @cssproperty --mdc-toggle-inactive-rest-color - background color of the inactive toggle in rest state\n * @cssproperty --mdc-toggle-inactive-hover-color - background color of the inactive toggle in hover state\n * @cssproperty --mdc-toggle-inactive-pressed-color - background color of the inactive toggle in pressed state\n * @cssproperty --mdc-toggle-inactive-disabled-color - background color of the inactive toggle in disabled state\n * @cssproperty --mdc-toggle-active-rest-color - background color of the active toggle in rest state\n * @cssproperty --mdc-toggle-active-hover-color - background color of the active toggle in hover state\n * @cssproperty --mdc-toggle-active-pressed-color - background color of the active toggle in pressed state\n * @cssproperty --mdc-toggle-active-disabled-color - background color of the active toggle in disabled state\n * @cssproperty --mdc-toggle-help-text-color - color of the help text label\n * @cssproperty --mdc-toggle-label-color-disabled - color of the toggle label and help text in disabled state\n *\n */",
|
7484
|
+
"jsDoc": "/**\n * Toggle Component is an interactive control used to switch between two mutually exclusive options,\n * such as On/Off, Active/Inactive. These are commonly used in settings panels, forms, and preference selections\n * where users need to enable or disable a feature.\n * It contains an optional label and an optional helper text.\n *\n * To create a group of toggles, use the FormFieldGroup component.\n *\n * Note: It internally renders a checkbox styled as a toggle switch.\n *\n * @dependency mdc-icon\n *\n * @tagname mdc-toggle\n *\n * @event change - (React: onChange) Event that gets dispatched when the toggle state changes.\n * @event focus - (React: onFocus) Event that gets dispatched when the toggle receives focus.\n *\n * @cssproperty --mdc-toggle-width - width of the toggle\n * @cssproperty --mdc-toggle-height - height of the toggle\n * @cssproperty --mdc-toggle-width-compact - width of the toggle when it's size is compact\n * @cssproperty --mdc-toggle-height-compact - height of the toggle when it's size is compact\n * @cssproperty --mdc-toggle-border-radius - border radius of the toggle\n * @cssproperty --mdc-toggle-border-radius-compact - border radius of the toggle when it's size is compact\n * @cssproperty --mdc-toggle-border - border of the toggle\n * @cssproperty --mdc-toggle-inactive-rest-color - background color of the inactive toggle in rest state\n * @cssproperty --mdc-toggle-inactive-hover-color - background color of the inactive toggle in hover state\n * @cssproperty --mdc-toggle-inactive-pressed-color - background color of the inactive toggle in pressed state\n * @cssproperty --mdc-toggle-inactive-disabled-color - background color of the inactive toggle in disabled state\n * @cssproperty --mdc-toggle-active-rest-color - background color of the active toggle in rest state\n * @cssproperty --mdc-toggle-active-hover-color - background color of the active toggle in hover state\n * @cssproperty --mdc-toggle-active-pressed-color - background color of the active toggle in pressed state\n * @cssproperty --mdc-toggle-active-disabled-color - background color of the active toggle in disabled state\n * @cssproperty --mdc-toggle-help-text-color - color of the help text label\n * @cssproperty --mdc-toggle-label-color-disabled - color of the toggle label and help text in disabled state\n *\n */",
|
7273
7485
|
"customElement": true,
|
7274
7486
|
"slots": [
|
7275
7487
|
{
|
@@ -7364,6 +7576,14 @@
|
|
7364
7576
|
"default": "null"
|
7365
7577
|
}
|
7366
7578
|
],
|
7579
|
+
"events": [
|
7580
|
+
{
|
7581
|
+
"description": "(React: onScroll) Event that gets called when user scrolls inside of list.",
|
7582
|
+
"name": "onscroll",
|
7583
|
+
"reactName": "onScroll",
|
7584
|
+
"eventName": "OnscrollEvent"
|
7585
|
+
}
|
7586
|
+
],
|
7367
7587
|
"attributes": [
|
7368
7588
|
{
|
7369
7589
|
"name": "onscroll",
|
@@ -7397,7 +7617,7 @@
|
|
7397
7617
|
"module": "/src/models"
|
7398
7618
|
},
|
7399
7619
|
"tagName": "mdc-virtualizedlist",
|
7400
|
-
"jsDoc": "/**\n * `mdc-virtualizedlist` component for creating custom virtualized lists.\n * IMPORTANT: This component does not create it's own list/list items.\n * Use the setlistdata callback prop to update client state in order to\n * Pass list/listitems as a child of this component, which this will virtuailze\n * This implementation handles dynamic lists as well as fixed sized lists.\n * Please refer to [Tanstack Virtual Docs](https://tanstack.com/virtual/latest) for more in depth documentation.\n *\n * @tagname mdc-virtualizedlist\n *\n * @slot - Client side List with nested list items.\n */",
|
7620
|
+
"jsDoc": "/**\n * `mdc-virtualizedlist` component for creating custom virtualized lists.\n * IMPORTANT: This component does not create it's own list/list items.\n * Use the setlistdata callback prop to update client state in order to\n * Pass list/listitems as a child of this component, which this will virtuailze\n * This implementation handles dynamic lists as well as fixed sized lists.\n * Please refer to [Tanstack Virtual Docs](https://tanstack.com/virtual/latest) for more in depth documentation.\n *\n * @tagname mdc-virtualizedlist\n *\n * @event onscroll - (React: onScroll) Event that gets called when user scrolls inside of list.\n *\n * @slot - Client side List with nested list items.\n */",
|
7401
7621
|
"customElement": true
|
7402
7622
|
}
|
7403
7623
|
],
|