@momentum-design/components 0.29.1 → 0.30.0
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.map +2 -2
- package/dist/components/themeprovider/themeprovider.component.d.ts +14 -0
- package/dist/components/themeprovider/themeprovider.component.js +14 -0
- package/dist/custom-elements.json +1545 -1545
- package/dist/react/index.d.ts +1 -1
- package/dist/react/index.js +1 -1
- package/dist/react/themeprovider/index.d.ts +14 -0
- package/dist/react/themeprovider/index.js +14 -0
- package/package.json +1 -1
@@ -1244,33 +1244,48 @@
|
|
1244
1244
|
},
|
1245
1245
|
{
|
1246
1246
|
"kind": "javascript-module",
|
1247
|
-
"path": "components/
|
1247
|
+
"path": "components/button/button.component.js",
|
1248
1248
|
"declarations": [
|
1249
1249
|
{
|
1250
1250
|
"kind": "class",
|
1251
|
-
"description": "`mdc-
|
1252
|
-
"name": "
|
1251
|
+
"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.",
|
1252
|
+
"name": "Button",
|
1253
|
+
"slots": [
|
1254
|
+
{
|
1255
|
+
"description": "Text label of the button.",
|
1256
|
+
"name": ""
|
1257
|
+
}
|
1258
|
+
],
|
1253
1259
|
"members": [
|
1254
1260
|
{
|
1255
1261
|
"kind": "field",
|
1256
|
-
"name": "
|
1262
|
+
"name": "prefixIcon",
|
1257
1263
|
"type": {
|
1258
|
-
"text": "
|
1264
|
+
"text": "string | undefined"
|
1259
1265
|
},
|
1260
|
-
"
|
1261
|
-
"
|
1262
|
-
"attribute": "active",
|
1266
|
+
"description": "The name of the icon to display as a prefix.\nThe icon is displayed on the left side of the button.",
|
1267
|
+
"attribute": "prefix-icon",
|
1263
1268
|
"reflects": true
|
1264
1269
|
},
|
1265
1270
|
{
|
1266
1271
|
"kind": "field",
|
1267
|
-
"name": "
|
1272
|
+
"name": "postfixIcon",
|
1268
1273
|
"type": {
|
1269
|
-
"text": "
|
1274
|
+
"text": "string | undefined"
|
1270
1275
|
},
|
1271
|
-
"
|
1272
|
-
"
|
1273
|
-
"
|
1276
|
+
"description": "The name of the icon to display as a postfix.\nThe icon is displayed on the right side of the button.",
|
1277
|
+
"attribute": "postfix-icon",
|
1278
|
+
"reflects": true
|
1279
|
+
},
|
1280
|
+
{
|
1281
|
+
"kind": "field",
|
1282
|
+
"name": "variant",
|
1283
|
+
"type": {
|
1284
|
+
"text": "ButtonVariant"
|
1285
|
+
},
|
1286
|
+
"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.",
|
1287
|
+
"default": "primary",
|
1288
|
+
"attribute": "variant"
|
1274
1289
|
},
|
1275
1290
|
{
|
1276
1291
|
"kind": "field",
|
@@ -1278,18 +1293,170 @@
|
|
1278
1293
|
"type": {
|
1279
1294
|
"text": "ButtonSize"
|
1280
1295
|
},
|
1281
|
-
"description": "
|
1296
|
+
"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.",
|
1282
1297
|
"default": "32",
|
1283
1298
|
"attribute": "size",
|
1284
|
-
"reflects": true
|
1299
|
+
"reflects": true,
|
1300
|
+
"inheritedFrom": {
|
1301
|
+
"name": "Buttonsimple",
|
1302
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
1303
|
+
}
|
1304
|
+
},
|
1305
|
+
{
|
1306
|
+
"kind": "field",
|
1307
|
+
"name": "color",
|
1308
|
+
"type": {
|
1309
|
+
"text": "ButtonColor"
|
1310
|
+
},
|
1311
|
+
"description": "There are 5 colors for button: positive, negative, accent, promotional, default.",
|
1312
|
+
"default": "default",
|
1313
|
+
"attribute": "color"
|
1285
1314
|
},
|
1286
1315
|
{
|
1287
1316
|
"kind": "field",
|
1288
1317
|
"name": "role",
|
1289
1318
|
"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.",
|
1290
|
-
"default": "button",
|
1319
|
+
"default": "'button'",
|
1291
1320
|
"attribute": "role",
|
1292
|
-
"reflects": true
|
1321
|
+
"reflects": true,
|
1322
|
+
"type": {
|
1323
|
+
"text": "string"
|
1324
|
+
},
|
1325
|
+
"inheritedFrom": {
|
1326
|
+
"name": "Buttonsimple",
|
1327
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
1328
|
+
}
|
1329
|
+
},
|
1330
|
+
{
|
1331
|
+
"kind": "method",
|
1332
|
+
"name": "modifyIconName",
|
1333
|
+
"privacy": "private",
|
1334
|
+
"parameters": [
|
1335
|
+
{
|
1336
|
+
"name": "active",
|
1337
|
+
"type": {
|
1338
|
+
"text": "boolean"
|
1339
|
+
},
|
1340
|
+
"description": "The active state."
|
1341
|
+
}
|
1342
|
+
],
|
1343
|
+
"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."
|
1344
|
+
},
|
1345
|
+
{
|
1346
|
+
"kind": "method",
|
1347
|
+
"name": "setVariant",
|
1348
|
+
"privacy": "private",
|
1349
|
+
"parameters": [
|
1350
|
+
{
|
1351
|
+
"name": "variant",
|
1352
|
+
"type": {
|
1353
|
+
"text": "ButtonVariant"
|
1354
|
+
},
|
1355
|
+
"description": "The variant to set."
|
1356
|
+
}
|
1357
|
+
],
|
1358
|
+
"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."
|
1359
|
+
},
|
1360
|
+
{
|
1361
|
+
"kind": "method",
|
1362
|
+
"name": "setSize",
|
1363
|
+
"privacy": "private",
|
1364
|
+
"parameters": [
|
1365
|
+
{
|
1366
|
+
"name": "size",
|
1367
|
+
"type": {
|
1368
|
+
"text": "PillButtonSize | IconButtonSize"
|
1369
|
+
},
|
1370
|
+
"description": "The size to set."
|
1371
|
+
}
|
1372
|
+
],
|
1373
|
+
"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."
|
1374
|
+
},
|
1375
|
+
{
|
1376
|
+
"kind": "method",
|
1377
|
+
"name": "setColor",
|
1378
|
+
"privacy": "private",
|
1379
|
+
"parameters": [
|
1380
|
+
{
|
1381
|
+
"name": "color",
|
1382
|
+
"type": {
|
1383
|
+
"text": "ButtonColor"
|
1384
|
+
},
|
1385
|
+
"description": "The color to set."
|
1386
|
+
}
|
1387
|
+
],
|
1388
|
+
"description": "Sets the color attribute for the button.\nDefaults to DEFAULTS.COLOR if invalid or for tertiary buttons."
|
1389
|
+
},
|
1390
|
+
{
|
1391
|
+
"kind": "method",
|
1392
|
+
"name": "inferButtonType",
|
1393
|
+
"privacy": "private",
|
1394
|
+
"description": "Infers the type of button based on the presence of slot and/or prefix and postfix icons.",
|
1395
|
+
"parameters": [
|
1396
|
+
{
|
1397
|
+
"description": "default slot of button",
|
1398
|
+
"name": "slot"
|
1399
|
+
}
|
1400
|
+
]
|
1401
|
+
},
|
1402
|
+
{
|
1403
|
+
"kind": "field",
|
1404
|
+
"name": "tabIndex",
|
1405
|
+
"type": {
|
1406
|
+
"text": "number"
|
1407
|
+
},
|
1408
|
+
"default": "0",
|
1409
|
+
"description": "This property specifies the tab order of the element.",
|
1410
|
+
"attribute": "tabIndex",
|
1411
|
+
"reflects": true,
|
1412
|
+
"inheritedFrom": {
|
1413
|
+
"name": "TabIndexMixin",
|
1414
|
+
"module": "utils/mixins/TabIndexMixin.js"
|
1415
|
+
}
|
1416
|
+
},
|
1417
|
+
{
|
1418
|
+
"kind": "field",
|
1419
|
+
"name": "disabled",
|
1420
|
+
"type": {
|
1421
|
+
"text": "boolean"
|
1422
|
+
},
|
1423
|
+
"default": "false",
|
1424
|
+
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
1425
|
+
"attribute": "disabled",
|
1426
|
+
"reflects": true,
|
1427
|
+
"inheritedFrom": {
|
1428
|
+
"name": "DisabledMixin",
|
1429
|
+
"module": "utils/mixins/DisabledMixin.js"
|
1430
|
+
}
|
1431
|
+
},
|
1432
|
+
{
|
1433
|
+
"kind": "field",
|
1434
|
+
"name": "active",
|
1435
|
+
"type": {
|
1436
|
+
"text": "boolean"
|
1437
|
+
},
|
1438
|
+
"default": "false",
|
1439
|
+
"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.",
|
1440
|
+
"attribute": "active",
|
1441
|
+
"reflects": true,
|
1442
|
+
"inheritedFrom": {
|
1443
|
+
"name": "Buttonsimple",
|
1444
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
1445
|
+
}
|
1446
|
+
},
|
1447
|
+
{
|
1448
|
+
"kind": "field",
|
1449
|
+
"name": "softDisabled",
|
1450
|
+
"type": {
|
1451
|
+
"text": "boolean"
|
1452
|
+
},
|
1453
|
+
"default": "false",
|
1454
|
+
"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.",
|
1455
|
+
"attribute": "soft-disabled",
|
1456
|
+
"inheritedFrom": {
|
1457
|
+
"name": "Buttonsimple",
|
1458
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
1459
|
+
}
|
1293
1460
|
},
|
1294
1461
|
{
|
1295
1462
|
"kind": "field",
|
@@ -1300,12 +1467,20 @@
|
|
1300
1467
|
"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.",
|
1301
1468
|
"default": "button",
|
1302
1469
|
"attribute": "type",
|
1303
|
-
"reflects": true
|
1470
|
+
"reflects": true,
|
1471
|
+
"inheritedFrom": {
|
1472
|
+
"name": "Buttonsimple",
|
1473
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
1474
|
+
}
|
1304
1475
|
},
|
1305
1476
|
{
|
1306
1477
|
"kind": "method",
|
1307
1478
|
"name": "executeAction",
|
1308
|
-
"privacy": "protected"
|
1479
|
+
"privacy": "protected",
|
1480
|
+
"inheritedFrom": {
|
1481
|
+
"name": "Buttonsimple",
|
1482
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
1483
|
+
}
|
1309
1484
|
},
|
1310
1485
|
{
|
1311
1486
|
"kind": "method",
|
@@ -1327,7 +1502,11 @@
|
|
1327
1502
|
"description": "The active state of the element"
|
1328
1503
|
}
|
1329
1504
|
],
|
1330
|
-
"description": "Sets the aria-pressed attribute based on the active state of the button."
|
1505
|
+
"description": "Sets the aria-pressed attribute based on the active state of the button.",
|
1506
|
+
"inheritedFrom": {
|
1507
|
+
"name": "Buttonsimple",
|
1508
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
1509
|
+
}
|
1331
1510
|
},
|
1332
1511
|
{
|
1333
1512
|
"kind": "method",
|
@@ -1349,7 +1528,11 @@
|
|
1349
1528
|
"description": "The soft-disabled state."
|
1350
1529
|
}
|
1351
1530
|
],
|
1352
|
-
"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."
|
1531
|
+
"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.",
|
1532
|
+
"inheritedFrom": {
|
1533
|
+
"name": "Buttonsimple",
|
1534
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
1535
|
+
}
|
1353
1536
|
},
|
1354
1537
|
{
|
1355
1538
|
"kind": "method",
|
@@ -1371,18 +1554,30 @@
|
|
1371
1554
|
"description": "The disabled state."
|
1372
1555
|
}
|
1373
1556
|
],
|
1374
|
-
"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."
|
1557
|
+
"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.",
|
1558
|
+
"inheritedFrom": {
|
1559
|
+
"name": "Buttonsimple",
|
1560
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
1561
|
+
}
|
1375
1562
|
},
|
1376
1563
|
{
|
1377
1564
|
"kind": "method",
|
1378
1565
|
"name": "triggerClickEvent",
|
1379
|
-
"privacy": "private"
|
1566
|
+
"privacy": "private",
|
1567
|
+
"inheritedFrom": {
|
1568
|
+
"name": "Buttonsimple",
|
1569
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
1570
|
+
}
|
1380
1571
|
},
|
1381
1572
|
{
|
1382
1573
|
"kind": "method",
|
1383
1574
|
"name": "handleBlur",
|
1384
1575
|
"privacy": "private",
|
1385
|
-
"description": "In case the button is pressed and the focus is lost while pressing,\nthe pressed class is removed."
|
1576
|
+
"description": "In case the button is pressed and the focus is lost while pressing,\nthe pressed class is removed.",
|
1577
|
+
"inheritedFrom": {
|
1578
|
+
"name": "Buttonsimple",
|
1579
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
1580
|
+
}
|
1386
1581
|
},
|
1387
1582
|
{
|
1388
1583
|
"kind": "method",
|
@@ -1397,7 +1592,11 @@
|
|
1397
1592
|
"description": "The keyboard event."
|
1398
1593
|
}
|
1399
1594
|
],
|
1400
|
-
"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."
|
1595
|
+
"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.",
|
1596
|
+
"inheritedFrom": {
|
1597
|
+
"name": "Buttonsimple",
|
1598
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
1599
|
+
}
|
1401
1600
|
},
|
1402
1601
|
{
|
1403
1602
|
"kind": "method",
|
@@ -1412,36 +1611,10 @@
|
|
1412
1611
|
"description": "The keyboard event."
|
1413
1612
|
}
|
1414
1613
|
],
|
1415
|
-
"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."
|
1416
|
-
},
|
1417
|
-
{
|
1418
|
-
"kind": "field",
|
1419
|
-
"name": "tabIndex",
|
1420
|
-
"type": {
|
1421
|
-
"text": "number"
|
1422
|
-
},
|
1423
|
-
"default": "0",
|
1424
|
-
"description": "This property specifies the tab order of the element.",
|
1425
|
-
"attribute": "tabIndex",
|
1426
|
-
"reflects": true,
|
1427
|
-
"inheritedFrom": {
|
1428
|
-
"name": "TabIndexMixin",
|
1429
|
-
"module": "utils/mixins/TabIndexMixin.js"
|
1430
|
-
}
|
1431
|
-
},
|
1432
|
-
{
|
1433
|
-
"kind": "field",
|
1434
|
-
"name": "disabled",
|
1435
|
-
"type": {
|
1436
|
-
"text": "boolean"
|
1437
|
-
},
|
1438
|
-
"default": "false",
|
1439
|
-
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
1440
|
-
"attribute": "disabled",
|
1441
|
-
"reflects": true,
|
1614
|
+
"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.",
|
1442
1615
|
"inheritedFrom": {
|
1443
|
-
"name": "
|
1444
|
-
"module": "
|
1616
|
+
"name": "Buttonsimple",
|
1617
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
1445
1618
|
}
|
1446
1619
|
}
|
1447
1620
|
],
|
@@ -1450,69 +1623,103 @@
|
|
1450
1623
|
"description": "(React: onClick) This event is dispatched when the button is clicked.",
|
1451
1624
|
"name": "click",
|
1452
1625
|
"reactName": "onClick",
|
1453
|
-
"eventName": "ClickEvent"
|
1626
|
+
"eventName": "ClickEvent",
|
1627
|
+
"inheritedFrom": {
|
1628
|
+
"name": "Buttonsimple",
|
1629
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
1630
|
+
}
|
1454
1631
|
},
|
1455
1632
|
{
|
1456
1633
|
"description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the button.",
|
1457
1634
|
"name": "keydown",
|
1458
1635
|
"reactName": "onKeyDown",
|
1459
|
-
"eventName": "KeydownEvent"
|
1636
|
+
"eventName": "KeydownEvent",
|
1637
|
+
"inheritedFrom": {
|
1638
|
+
"name": "Buttonsimple",
|
1639
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
1640
|
+
}
|
1460
1641
|
},
|
1461
1642
|
{
|
1462
1643
|
"description": "(React: onKeyUp) This event is dispatched when a key is released on the button.",
|
1463
1644
|
"name": "keyup",
|
1464
1645
|
"reactName": "onKeyUp",
|
1465
|
-
"eventName": "KeyupEvent"
|
1646
|
+
"eventName": "KeyupEvent",
|
1647
|
+
"inheritedFrom": {
|
1648
|
+
"name": "Buttonsimple",
|
1649
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
1650
|
+
}
|
1466
1651
|
},
|
1467
1652
|
{
|
1468
1653
|
"description": "(React: onFocus) This event is dispatched when the button receives focus.",
|
1469
1654
|
"name": "focus",
|
1470
1655
|
"reactName": "onFocus",
|
1471
|
-
"eventName": "FocusEvent"
|
1656
|
+
"eventName": "FocusEvent",
|
1657
|
+
"inheritedFrom": {
|
1658
|
+
"name": "Buttonsimple",
|
1659
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
1660
|
+
}
|
1472
1661
|
}
|
1473
1662
|
],
|
1474
1663
|
"attributes": [
|
1475
1664
|
{
|
1476
|
-
"name": "
|
1665
|
+
"name": "prefix-icon",
|
1477
1666
|
"type": {
|
1478
|
-
"text": "
|
1667
|
+
"text": "string | undefined"
|
1479
1668
|
},
|
1480
|
-
"
|
1481
|
-
"
|
1482
|
-
"fieldName": "active"
|
1669
|
+
"description": "The name of the icon to display as a prefix.\nThe icon is displayed on the left side of the button.",
|
1670
|
+
"fieldName": "prefixIcon"
|
1483
1671
|
},
|
1484
1672
|
{
|
1485
|
-
"name": "
|
1673
|
+
"name": "postfix-icon",
|
1486
1674
|
"type": {
|
1487
|
-
"text": "
|
1675
|
+
"text": "string | undefined"
|
1488
1676
|
},
|
1489
|
-
"
|
1490
|
-
"
|
1491
|
-
|
1677
|
+
"description": "The name of the icon to display as a postfix.\nThe icon is displayed on the right side of the button.",
|
1678
|
+
"fieldName": "postfixIcon"
|
1679
|
+
},
|
1680
|
+
{
|
1681
|
+
"name": "variant",
|
1682
|
+
"type": {
|
1683
|
+
"text": "ButtonVariant"
|
1684
|
+
},
|
1685
|
+
"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.",
|
1686
|
+
"default": "primary",
|
1687
|
+
"fieldName": "variant"
|
1492
1688
|
},
|
1493
1689
|
{
|
1494
1690
|
"name": "size",
|
1495
1691
|
"type": {
|
1496
1692
|
"text": "ButtonSize"
|
1497
1693
|
},
|
1498
|
-
"description": "
|
1694
|
+
"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.",
|
1499
1695
|
"default": "32",
|
1500
|
-
"fieldName": "size"
|
1696
|
+
"fieldName": "size",
|
1697
|
+
"inheritedFrom": {
|
1698
|
+
"name": "Buttonsimple",
|
1699
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
1700
|
+
}
|
1501
1701
|
},
|
1502
1702
|
{
|
1503
|
-
"name": "
|
1504
|
-
"
|
1505
|
-
|
1506
|
-
|
1703
|
+
"name": "color",
|
1704
|
+
"type": {
|
1705
|
+
"text": "ButtonColor"
|
1706
|
+
},
|
1707
|
+
"description": "There are 5 colors for button: positive, negative, accent, promotional, default.",
|
1708
|
+
"default": "default",
|
1709
|
+
"fieldName": "color"
|
1507
1710
|
},
|
1508
1711
|
{
|
1509
|
-
"name": "
|
1712
|
+
"name": "role",
|
1713
|
+
"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.",
|
1714
|
+
"default": "'button'",
|
1715
|
+
"fieldName": "role",
|
1510
1716
|
"type": {
|
1511
|
-
"text": "
|
1717
|
+
"text": "string"
|
1512
1718
|
},
|
1513
|
-
"
|
1514
|
-
|
1515
|
-
|
1719
|
+
"inheritedFrom": {
|
1720
|
+
"name": "Buttonsimple",
|
1721
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
1722
|
+
}
|
1516
1723
|
},
|
1517
1724
|
{
|
1518
1725
|
"name": "tabIndex",
|
@@ -1539,24 +1746,53 @@
|
|
1539
1746
|
"name": "DisabledMixin",
|
1540
1747
|
"module": "src/utils/mixins/DisabledMixin.ts"
|
1541
1748
|
}
|
1542
|
-
}
|
1543
|
-
],
|
1544
|
-
"mixins": [
|
1749
|
+
},
|
1545
1750
|
{
|
1546
|
-
"name": "
|
1547
|
-
"
|
1751
|
+
"name": "active",
|
1752
|
+
"type": {
|
1753
|
+
"text": "boolean"
|
1754
|
+
},
|
1755
|
+
"default": "false",
|
1756
|
+
"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.",
|
1757
|
+
"fieldName": "active",
|
1758
|
+
"inheritedFrom": {
|
1759
|
+
"name": "Buttonsimple",
|
1760
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
1761
|
+
}
|
1548
1762
|
},
|
1549
1763
|
{
|
1550
|
-
"name": "
|
1551
|
-
"
|
1764
|
+
"name": "soft-disabled",
|
1765
|
+
"type": {
|
1766
|
+
"text": "boolean"
|
1767
|
+
},
|
1768
|
+
"default": "false",
|
1769
|
+
"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.",
|
1770
|
+
"fieldName": "softDisabled",
|
1771
|
+
"inheritedFrom": {
|
1772
|
+
"name": "Buttonsimple",
|
1773
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
1774
|
+
}
|
1775
|
+
},
|
1776
|
+
{
|
1777
|
+
"name": "type",
|
1778
|
+
"type": {
|
1779
|
+
"text": "ButtonType"
|
1780
|
+
},
|
1781
|
+
"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.",
|
1782
|
+
"default": "button",
|
1783
|
+
"fieldName": "type",
|
1784
|
+
"inheritedFrom": {
|
1785
|
+
"name": "Buttonsimple",
|
1786
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
1787
|
+
}
|
1552
1788
|
}
|
1553
1789
|
],
|
1554
1790
|
"superclass": {
|
1555
|
-
"name": "
|
1556
|
-
"module": "/src/
|
1791
|
+
"name": "Buttonsimple",
|
1792
|
+
"module": "/src/components/buttonsimple/buttonsimple.component"
|
1557
1793
|
},
|
1558
|
-
"tagName": "mdc-
|
1559
|
-
"jsDoc": "/**\n * `mdc-
|
1794
|
+
"tagName": "mdc-button",
|
1795
|
+
"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 */",
|
1560
1796
|
"customElement": true
|
1561
1797
|
}
|
1562
1798
|
],
|
@@ -1565,140 +1801,158 @@
|
|
1565
1801
|
"kind": "js",
|
1566
1802
|
"name": "default",
|
1567
1803
|
"declaration": {
|
1568
|
-
"name": "
|
1569
|
-
"module": "components/
|
1804
|
+
"name": "Button",
|
1805
|
+
"module": "components/button/button.component.js"
|
1570
1806
|
}
|
1571
1807
|
}
|
1572
1808
|
]
|
1573
1809
|
},
|
1574
1810
|
{
|
1575
1811
|
"kind": "javascript-module",
|
1576
|
-
"path": "components/
|
1812
|
+
"path": "components/buttonsimple/buttonsimple.component.js",
|
1577
1813
|
"declarations": [
|
1578
1814
|
{
|
1579
1815
|
"kind": "class",
|
1580
|
-
"description": "
|
1581
|
-
"name": "
|
1582
|
-
"cssProperties": [
|
1583
|
-
{
|
1584
|
-
"description": "Allows customization of the background color on hover.",
|
1585
|
-
"name": "--mdc-checkbox-background-color-hover"
|
1586
|
-
},
|
1587
|
-
{
|
1588
|
-
"description": "Border color in high contrast.",
|
1589
|
-
"name": "--mdc-checkbox-border-color"
|
1590
|
-
},
|
1591
|
-
{
|
1592
|
-
"description": "Background color for a selected checkbox.",
|
1593
|
-
"name": "--mdc-checkbox-checked-background-color"
|
1594
|
-
},
|
1595
|
-
{
|
1596
|
-
"description": "Background color for a selected checkbox when hovered.",
|
1597
|
-
"name": "--mdc-checkbox-checked-background-color-hover"
|
1598
|
-
},
|
1599
|
-
{
|
1600
|
-
"description": "Background color for a selected checkbox when pressed.",
|
1601
|
-
"name": "--mdc-checkbox-checked-pressed-icon-color"
|
1602
|
-
},
|
1603
|
-
{
|
1604
|
-
"description": "Background color for a disabled checkbox.",
|
1605
|
-
"name": "--mdc-checkbox-disabled-background-color"
|
1606
|
-
},
|
1607
|
-
{
|
1608
|
-
"description": "Border color for a disabled checkbox.",
|
1609
|
-
"name": "--mdc-checkbox-disabled-border-color"
|
1610
|
-
},
|
1611
|
-
{
|
1612
|
-
"description": "Background color for a disabled, selected checkbox.",
|
1613
|
-
"name": "--mdc-checkbox-disabled-checked-icon-color"
|
1614
|
-
},
|
1615
|
-
{
|
1616
|
-
"description": "Icon color for a disabled checkbox.",
|
1617
|
-
"name": "--mdc-checkbox-disabled-icon-color"
|
1618
|
-
},
|
1619
|
-
{
|
1620
|
-
"description": "Background color for an unselected checkbox.",
|
1621
|
-
"name": "--mdc-checkbox-icon-background-color"
|
1622
|
-
},
|
1623
|
-
{
|
1624
|
-
"description": "Default background color for an unselected checkbox.",
|
1625
|
-
"name": "--mdc-checkbox-icon-border-color"
|
1626
|
-
},
|
1627
|
-
{
|
1628
|
-
"description": "Icon color for an unselected checkbox.",
|
1629
|
-
"name": "--mdc-checkbox-icon-color"
|
1630
|
-
},
|
1631
|
-
{
|
1632
|
-
"description": "Background color for a selected checkbox when pressed.",
|
1633
|
-
"name": "--mdc-checkbox-pressed-icon-color"
|
1634
|
-
}
|
1635
|
-
],
|
1816
|
+
"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.",
|
1817
|
+
"name": "Buttonsimple",
|
1636
1818
|
"members": [
|
1637
1819
|
{
|
1638
1820
|
"kind": "field",
|
1639
|
-
"name": "
|
1821
|
+
"name": "active",
|
1640
1822
|
"type": {
|
1641
1823
|
"text": "boolean"
|
1642
1824
|
},
|
1643
1825
|
"default": "false",
|
1644
|
-
"description": "
|
1645
|
-
"attribute": "
|
1826
|
+
"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.",
|
1827
|
+
"attribute": "active",
|
1646
1828
|
"reflects": true
|
1647
1829
|
},
|
1648
1830
|
{
|
1649
1831
|
"kind": "field",
|
1650
|
-
"name": "
|
1832
|
+
"name": "softDisabled",
|
1651
1833
|
"type": {
|
1652
1834
|
"text": "boolean"
|
1653
1835
|
},
|
1654
1836
|
"default": "false",
|
1655
|
-
"description": "
|
1656
|
-
"attribute": "
|
1657
|
-
"reflects": true
|
1837
|
+
"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.",
|
1838
|
+
"attribute": "soft-disabled"
|
1658
1839
|
},
|
1659
1840
|
{
|
1660
1841
|
"kind": "field",
|
1661
|
-
"name": "
|
1842
|
+
"name": "size",
|
1662
1843
|
"type": {
|
1663
|
-
"text": "
|
1844
|
+
"text": "ButtonSize"
|
1664
1845
|
},
|
1665
|
-
"
|
1666
|
-
"
|
1667
|
-
"attribute": "
|
1846
|
+
"description": "Simplebutton size is a super set of all the sizes supported by children components.",
|
1847
|
+
"default": "32",
|
1848
|
+
"attribute": "size",
|
1668
1849
|
"reflects": true
|
1669
1850
|
},
|
1670
1851
|
{
|
1671
|
-
"kind": "
|
1672
|
-
"name": "
|
1673
|
-
"
|
1674
|
-
"
|
1675
|
-
|
1676
|
-
|
1677
|
-
|
1678
|
-
|
1679
|
-
"
|
1680
|
-
"
|
1852
|
+
"kind": "field",
|
1853
|
+
"name": "role",
|
1854
|
+
"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.",
|
1855
|
+
"default": "button",
|
1856
|
+
"attribute": "role",
|
1857
|
+
"reflects": true
|
1858
|
+
},
|
1859
|
+
{
|
1860
|
+
"kind": "field",
|
1861
|
+
"name": "type",
|
1862
|
+
"type": {
|
1863
|
+
"text": "ButtonType"
|
1864
|
+
},
|
1865
|
+
"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.",
|
1866
|
+
"default": "button",
|
1867
|
+
"attribute": "type",
|
1868
|
+
"reflects": true
|
1681
1869
|
},
|
1682
1870
|
{
|
1683
1871
|
"kind": "method",
|
1684
|
-
"name": "
|
1872
|
+
"name": "executeAction",
|
1873
|
+
"privacy": "protected"
|
1874
|
+
},
|
1875
|
+
{
|
1876
|
+
"kind": "method",
|
1877
|
+
"name": "setActive",
|
1878
|
+
"privacy": "protected",
|
1879
|
+
"parameters": [
|
1880
|
+
{
|
1881
|
+
"name": "element",
|
1882
|
+
"type": {
|
1883
|
+
"text": "HTMLElement"
|
1884
|
+
},
|
1885
|
+
"description": "The button element"
|
1886
|
+
},
|
1887
|
+
{
|
1888
|
+
"name": "active",
|
1889
|
+
"type": {
|
1890
|
+
"text": "boolean"
|
1891
|
+
},
|
1892
|
+
"description": "The active state of the element"
|
1893
|
+
}
|
1894
|
+
],
|
1895
|
+
"description": "Sets the aria-pressed attribute based on the active state of the button."
|
1896
|
+
},
|
1897
|
+
{
|
1898
|
+
"kind": "method",
|
1899
|
+
"name": "setSoftDisabled",
|
1685
1900
|
"privacy": "private",
|
1686
|
-
"
|
1687
|
-
|
1688
|
-
"
|
1901
|
+
"parameters": [
|
1902
|
+
{
|
1903
|
+
"name": "element",
|
1904
|
+
"type": {
|
1905
|
+
"text": "HTMLElement"
|
1906
|
+
},
|
1907
|
+
"description": "The button element."
|
1908
|
+
},
|
1909
|
+
{
|
1910
|
+
"name": "softDisabled",
|
1911
|
+
"type": {
|
1912
|
+
"text": "boolean"
|
1913
|
+
},
|
1914
|
+
"description": "The soft-disabled state."
|
1689
1915
|
}
|
1690
|
-
|
1691
|
-
"description": "
|
1916
|
+
],
|
1917
|
+
"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."
|
1692
1918
|
},
|
1693
1919
|
{
|
1694
1920
|
"kind": "method",
|
1695
|
-
"name": "
|
1921
|
+
"name": "setDisabled",
|
1696
1922
|
"privacy": "private",
|
1697
|
-
"
|
1698
|
-
|
1699
|
-
"
|
1923
|
+
"parameters": [
|
1924
|
+
{
|
1925
|
+
"name": "element",
|
1926
|
+
"type": {
|
1927
|
+
"text": "HTMLElement"
|
1928
|
+
},
|
1929
|
+
"description": "The button element."
|
1930
|
+
},
|
1931
|
+
{
|
1932
|
+
"name": "disabled",
|
1933
|
+
"type": {
|
1934
|
+
"text": "boolean"
|
1935
|
+
},
|
1936
|
+
"description": "The disabled state."
|
1700
1937
|
}
|
1701
|
-
|
1938
|
+
],
|
1939
|
+
"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."
|
1940
|
+
},
|
1941
|
+
{
|
1942
|
+
"kind": "method",
|
1943
|
+
"name": "triggerClickEvent",
|
1944
|
+
"privacy": "private"
|
1945
|
+
},
|
1946
|
+
{
|
1947
|
+
"kind": "method",
|
1948
|
+
"name": "handleBlur",
|
1949
|
+
"privacy": "private",
|
1950
|
+
"description": "In case the button is pressed and the focus is lost while pressing,\nthe pressed class is removed."
|
1951
|
+
},
|
1952
|
+
{
|
1953
|
+
"kind": "method",
|
1954
|
+
"name": "handleKeyDown",
|
1955
|
+
"privacy": "private",
|
1702
1956
|
"parameters": [
|
1703
1957
|
{
|
1704
1958
|
"name": "event",
|
@@ -1708,501 +1962,812 @@
|
|
1708
1962
|
"description": "The keyboard event."
|
1709
1963
|
}
|
1710
1964
|
],
|
1711
|
-
"description": "Handles the keydown event on the
|
1965
|
+
"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."
|
1712
1966
|
},
|
1713
1967
|
{
|
1714
1968
|
"kind": "method",
|
1715
|
-
"name": "
|
1716
|
-
"privacy": "
|
1717
|
-
"return": {
|
1718
|
-
"type": {
|
1719
|
-
"text": "void"
|
1720
|
-
}
|
1721
|
-
},
|
1969
|
+
"name": "handleKeyUp",
|
1970
|
+
"privacy": "private",
|
1722
1971
|
"parameters": [
|
1723
1972
|
{
|
1724
1973
|
"name": "event",
|
1725
1974
|
"type": {
|
1726
|
-
"text": "
|
1727
|
-
}
|
1975
|
+
"text": "KeyboardEvent"
|
1976
|
+
},
|
1977
|
+
"description": "The keyboard event."
|
1728
1978
|
}
|
1729
1979
|
],
|
1730
|
-
"description": "
|
1731
|
-
},
|
1732
|
-
{
|
1733
|
-
"kind": "field",
|
1734
|
-
"name": "renderLabelAndHelperText",
|
1735
|
-
"privacy": "private"
|
1980
|
+
"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."
|
1736
1981
|
},
|
1737
1982
|
{
|
1738
1983
|
"kind": "field",
|
1739
|
-
"name": "
|
1984
|
+
"name": "tabIndex",
|
1740
1985
|
"type": {
|
1741
|
-
"text": "
|
1986
|
+
"text": "number"
|
1742
1987
|
},
|
1743
|
-
"
|
1744
|
-
"
|
1988
|
+
"default": "0",
|
1989
|
+
"description": "This property specifies the tab order of the element.",
|
1990
|
+
"attribute": "tabIndex",
|
1745
1991
|
"reflects": true,
|
1746
|
-
"default": "undefined as unknown",
|
1747
1992
|
"inheritedFrom": {
|
1748
|
-
"name": "
|
1749
|
-
"module": "
|
1993
|
+
"name": "TabIndexMixin",
|
1994
|
+
"module": "utils/mixins/TabIndexMixin.js"
|
1750
1995
|
}
|
1751
1996
|
},
|
1752
1997
|
{
|
1753
1998
|
"kind": "field",
|
1754
|
-
"name": "
|
1999
|
+
"name": "disabled",
|
1755
2000
|
"type": {
|
1756
|
-
"text": "
|
2001
|
+
"text": "boolean"
|
1757
2002
|
},
|
1758
|
-
"default": "
|
1759
|
-
"description": "Indicates the
|
1760
|
-
"attribute": "
|
2003
|
+
"default": "false",
|
2004
|
+
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
2005
|
+
"attribute": "disabled",
|
1761
2006
|
"reflects": true,
|
1762
2007
|
"inheritedFrom": {
|
1763
|
-
"name": "
|
1764
|
-
"module": "utils/mixins/
|
2008
|
+
"name": "DisabledMixin",
|
2009
|
+
"module": "utils/mixins/DisabledMixin.js"
|
1765
2010
|
}
|
2011
|
+
}
|
2012
|
+
],
|
2013
|
+
"events": [
|
2014
|
+
{
|
2015
|
+
"description": "(React: onClick) This event is dispatched when the button is clicked.",
|
2016
|
+
"name": "click",
|
2017
|
+
"reactName": "onClick",
|
2018
|
+
"eventName": "ClickEvent"
|
1766
2019
|
},
|
1767
2020
|
{
|
1768
|
-
"
|
1769
|
-
"name": "
|
2021
|
+
"description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the button.",
|
2022
|
+
"name": "keydown",
|
2023
|
+
"reactName": "onKeyDown",
|
2024
|
+
"eventName": "KeydownEvent"
|
2025
|
+
},
|
2026
|
+
{
|
2027
|
+
"description": "(React: onKeyUp) This event is dispatched when a key is released on the button.",
|
2028
|
+
"name": "keyup",
|
2029
|
+
"reactName": "onKeyUp",
|
2030
|
+
"eventName": "KeyupEvent"
|
2031
|
+
},
|
2032
|
+
{
|
2033
|
+
"description": "(React: onFocus) This event is dispatched when the button receives focus.",
|
2034
|
+
"name": "focus",
|
2035
|
+
"reactName": "onFocus",
|
2036
|
+
"eventName": "FocusEvent"
|
2037
|
+
}
|
2038
|
+
],
|
2039
|
+
"attributes": [
|
2040
|
+
{
|
2041
|
+
"name": "active",
|
1770
2042
|
"type": {
|
1771
|
-
"text": "
|
2043
|
+
"text": "boolean"
|
1772
2044
|
},
|
1773
|
-
"default": "
|
1774
|
-
"description": "
|
1775
|
-
"
|
1776
|
-
"reflects": true,
|
1777
|
-
"inheritedFrom": {
|
1778
|
-
"name": "FormInternalsMixin",
|
1779
|
-
"module": "utils/mixins/FormInternalsMixin.js"
|
1780
|
-
}
|
2045
|
+
"default": "false",
|
2046
|
+
"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.",
|
2047
|
+
"fieldName": "active"
|
1781
2048
|
},
|
1782
2049
|
{
|
1783
|
-
"
|
1784
|
-
"name": "validationMessage",
|
2050
|
+
"name": "soft-disabled",
|
1785
2051
|
"type": {
|
1786
|
-
"text": "
|
2052
|
+
"text": "boolean"
|
1787
2053
|
},
|
1788
|
-
"
|
1789
|
-
"
|
1790
|
-
"
|
1791
|
-
"inheritedFrom": {
|
1792
|
-
"name": "FormInternalsMixin",
|
1793
|
-
"module": "utils/mixins/FormInternalsMixin.js"
|
1794
|
-
}
|
2054
|
+
"default": "false",
|
2055
|
+
"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.",
|
2056
|
+
"fieldName": "softDisabled"
|
1795
2057
|
},
|
1796
2058
|
{
|
1797
|
-
"
|
1798
|
-
"name": "validity",
|
2059
|
+
"name": "size",
|
1799
2060
|
"type": {
|
1800
|
-
"text": "
|
2061
|
+
"text": "ButtonSize"
|
1801
2062
|
},
|
1802
|
-
"
|
1803
|
-
"
|
1804
|
-
|
1805
|
-
"module": "utils/mixins/FormInternalsMixin.js"
|
1806
|
-
}
|
2063
|
+
"description": "Simplebutton size is a super set of all the sizes supported by children components.",
|
2064
|
+
"default": "32",
|
2065
|
+
"fieldName": "size"
|
1807
2066
|
},
|
1808
2067
|
{
|
1809
|
-
"
|
1810
|
-
"
|
1811
|
-
"
|
1812
|
-
"
|
1813
|
-
"name": "FormInternalsMixin",
|
1814
|
-
"module": "utils/mixins/FormInternalsMixin.js"
|
1815
|
-
}
|
2068
|
+
"name": "role",
|
2069
|
+
"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.",
|
2070
|
+
"default": "button",
|
2071
|
+
"fieldName": "role"
|
1816
2072
|
},
|
1817
2073
|
{
|
1818
|
-
"
|
1819
|
-
"
|
1820
|
-
|
1821
|
-
"return": {
|
1822
|
-
"type": {
|
1823
|
-
"text": ""
|
1824
|
-
}
|
2074
|
+
"name": "type",
|
2075
|
+
"type": {
|
2076
|
+
"text": "ButtonType"
|
1825
2077
|
},
|
1826
|
-
"
|
1827
|
-
|
1828
|
-
|
1829
|
-
}
|
1830
|
-
},
|
1831
|
-
{
|
1832
|
-
"kind": "method",
|
1833
|
-
"name": "checkValidity",
|
1834
|
-
"return": {
|
1835
|
-
"type": {
|
1836
|
-
"text": "boolean"
|
1837
|
-
}
|
1838
|
-
},
|
1839
|
-
"inheritedFrom": {
|
1840
|
-
"name": "FormInternalsMixin",
|
1841
|
-
"module": "utils/mixins/FormInternalsMixin.js"
|
1842
|
-
}
|
1843
|
-
},
|
1844
|
-
{
|
1845
|
-
"kind": "method",
|
1846
|
-
"name": "reportValidity",
|
1847
|
-
"inheritedFrom": {
|
1848
|
-
"name": "FormInternalsMixin",
|
1849
|
-
"module": "utils/mixins/FormInternalsMixin.js"
|
1850
|
-
}
|
1851
|
-
},
|
1852
|
-
{
|
1853
|
-
"kind": "field",
|
1854
|
-
"name": "id",
|
1855
|
-
"type": {
|
1856
|
-
"text": "string"
|
1857
|
-
},
|
1858
|
-
"default": "`mdc-input-${uuidv4()}`",
|
1859
|
-
"description": "The unique id of the input field. It is used to link the input field with the label.",
|
1860
|
-
"attribute": "id",
|
1861
|
-
"inheritedFrom": {
|
1862
|
-
"name": "FormfieldWrapper",
|
1863
|
-
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
1864
|
-
}
|
2078
|
+
"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.",
|
2079
|
+
"default": "button",
|
2080
|
+
"fieldName": "type"
|
1865
2081
|
},
|
1866
2082
|
{
|
1867
|
-
"
|
1868
|
-
"name": "dataAriaLabel",
|
2083
|
+
"name": "tabIndex",
|
1869
2084
|
"type": {
|
1870
|
-
"text": "
|
2085
|
+
"text": "number"
|
1871
2086
|
},
|
1872
|
-
"default": "
|
1873
|
-
"description": "
|
1874
|
-
"
|
1875
|
-
"reflects": true,
|
2087
|
+
"default": "0",
|
2088
|
+
"description": "This property specifies the tab order of the element.",
|
2089
|
+
"fieldName": "tabIndex",
|
1876
2090
|
"inheritedFrom": {
|
1877
|
-
"name": "
|
1878
|
-
"module": "utils/mixins/
|
2091
|
+
"name": "TabIndexMixin",
|
2092
|
+
"module": "src/utils/mixins/TabIndexMixin.ts"
|
1879
2093
|
}
|
1880
2094
|
},
|
1881
2095
|
{
|
1882
|
-
"kind": "field",
|
1883
2096
|
"name": "disabled",
|
1884
2097
|
"type": {
|
1885
2098
|
"text": "boolean"
|
1886
2099
|
},
|
1887
2100
|
"default": "false",
|
1888
2101
|
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
1889
|
-
"
|
1890
|
-
"reflects": true,
|
2102
|
+
"fieldName": "disabled",
|
1891
2103
|
"inheritedFrom": {
|
1892
2104
|
"name": "DisabledMixin",
|
1893
|
-
"module": "utils/mixins/DisabledMixin.
|
2105
|
+
"module": "src/utils/mixins/DisabledMixin.ts"
|
1894
2106
|
}
|
2107
|
+
}
|
2108
|
+
],
|
2109
|
+
"mixins": [
|
2110
|
+
{
|
2111
|
+
"name": "TabIndexMixin",
|
2112
|
+
"module": "/src/utils/mixins/TabIndexMixin"
|
1895
2113
|
},
|
1896
2114
|
{
|
1897
|
-
"
|
1898
|
-
"
|
1899
|
-
|
1900
|
-
|
1901
|
-
|
1902
|
-
|
1903
|
-
|
1904
|
-
|
1905
|
-
|
1906
|
-
|
1907
|
-
|
1908
|
-
|
2115
|
+
"name": "DisabledMixin",
|
2116
|
+
"module": "/src/utils/mixins/DisabledMixin"
|
2117
|
+
}
|
2118
|
+
],
|
2119
|
+
"superclass": {
|
2120
|
+
"name": "Component",
|
2121
|
+
"module": "/src/models"
|
2122
|
+
},
|
2123
|
+
"tagName": "mdc-buttonsimple",
|
2124
|
+
"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 */",
|
2125
|
+
"customElement": true
|
2126
|
+
}
|
2127
|
+
],
|
2128
|
+
"exports": [
|
2129
|
+
{
|
2130
|
+
"kind": "js",
|
2131
|
+
"name": "default",
|
2132
|
+
"declaration": {
|
2133
|
+
"name": "Buttonsimple",
|
2134
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
2135
|
+
}
|
2136
|
+
}
|
2137
|
+
]
|
2138
|
+
},
|
2139
|
+
{
|
2140
|
+
"kind": "javascript-module",
|
2141
|
+
"path": "components/checkbox/checkbox.component.js",
|
2142
|
+
"declarations": [
|
2143
|
+
{
|
2144
|
+
"kind": "class",
|
2145
|
+
"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.",
|
2146
|
+
"name": "Checkbox",
|
2147
|
+
"cssProperties": [
|
2148
|
+
{
|
2149
|
+
"description": "Allows customization of the background color on hover.",
|
2150
|
+
"name": "--mdc-checkbox-background-color-hover"
|
1909
2151
|
},
|
1910
2152
|
{
|
1911
|
-
"
|
1912
|
-
"name": "
|
1913
|
-
"type": {
|
1914
|
-
"text": "string | undefined"
|
1915
|
-
},
|
1916
|
-
"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.",
|
1917
|
-
"attribute": "required-label",
|
1918
|
-
"reflects": true,
|
1919
|
-
"inheritedFrom": {
|
1920
|
-
"name": "FormfieldWrapper",
|
1921
|
-
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
1922
|
-
}
|
2153
|
+
"description": "Border color in high contrast.",
|
2154
|
+
"name": "--mdc-checkbox-border-color"
|
1923
2155
|
},
|
1924
2156
|
{
|
1925
|
-
"
|
1926
|
-
"name": "
|
1927
|
-
"type": {
|
1928
|
-
"text": "string | undefined"
|
1929
|
-
},
|
1930
|
-
"description": "The help text that is displayed below the input field.",
|
1931
|
-
"attribute": "help-text",
|
1932
|
-
"reflects": true,
|
1933
|
-
"inheritedFrom": {
|
1934
|
-
"name": "FormfieldWrapper",
|
1935
|
-
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
1936
|
-
}
|
2157
|
+
"description": "Background color for a selected checkbox.",
|
2158
|
+
"name": "--mdc-checkbox-checked-background-color"
|
1937
2159
|
},
|
1938
2160
|
{
|
1939
|
-
"
|
1940
|
-
"name": "
|
1941
|
-
"privacy": "protected",
|
1942
|
-
"description": "creates the label element when the label property is set.\nid is used to link the label with the input field.",
|
1943
|
-
"return": {
|
1944
|
-
"type": {
|
1945
|
-
"text": ""
|
1946
|
-
}
|
1947
|
-
},
|
1948
|
-
"inheritedFrom": {
|
1949
|
-
"name": "FormfieldWrapper",
|
1950
|
-
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
1951
|
-
}
|
2161
|
+
"description": "Background color for a selected checkbox when hovered.",
|
2162
|
+
"name": "--mdc-checkbox-checked-background-color-hover"
|
1952
2163
|
},
|
1953
2164
|
{
|
1954
|
-
"
|
1955
|
-
"name": "
|
1956
|
-
"privacy": "protected",
|
1957
|
-
"inheritedFrom": {
|
1958
|
-
"name": "FormfieldWrapper",
|
1959
|
-
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
1960
|
-
}
|
2165
|
+
"description": "Background color for a selected checkbox when pressed.",
|
2166
|
+
"name": "--mdc-checkbox-checked-pressed-icon-color"
|
1961
2167
|
},
|
1962
2168
|
{
|
1963
|
-
"
|
1964
|
-
"name": "
|
1965
|
-
"privacy": "protected",
|
1966
|
-
"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.",
|
1967
|
-
"return": {
|
1968
|
-
"type": {
|
1969
|
-
"text": ""
|
1970
|
-
}
|
1971
|
-
},
|
1972
|
-
"inheritedFrom": {
|
1973
|
-
"name": "FormfieldWrapper",
|
1974
|
-
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
1975
|
-
}
|
2169
|
+
"description": "Background color for a disabled checkbox.",
|
2170
|
+
"name": "--mdc-checkbox-disabled-background-color"
|
1976
2171
|
},
|
1977
2172
|
{
|
1978
|
-
"
|
1979
|
-
"name": "
|
1980
|
-
"privacy": "protected",
|
1981
|
-
"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.",
|
1982
|
-
"return": {
|
1983
|
-
"type": {
|
1984
|
-
"text": ""
|
1985
|
-
}
|
1986
|
-
},
|
1987
|
-
"inheritedFrom": {
|
1988
|
-
"name": "FormfieldWrapper",
|
1989
|
-
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
1990
|
-
}
|
2173
|
+
"description": "Border color for a disabled checkbox.",
|
2174
|
+
"name": "--mdc-checkbox-disabled-border-color"
|
1991
2175
|
},
|
1992
2176
|
{
|
1993
|
-
"
|
1994
|
-
"name": "
|
1995
|
-
"privacy": "protected",
|
1996
|
-
"description": "renders the mdc-label-text container that contains the label and labelInfoToggleTip.",
|
1997
|
-
"return": {
|
1998
|
-
"type": {
|
1999
|
-
"text": ""
|
2000
|
-
}
|
2001
|
-
},
|
2002
|
-
"inheritedFrom": {
|
2003
|
-
"name": "FormfieldWrapper",
|
2004
|
-
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
2005
|
-
}
|
2177
|
+
"description": "Background color for a disabled, selected checkbox.",
|
2178
|
+
"name": "--mdc-checkbox-disabled-checked-icon-color"
|
2006
2179
|
},
|
2007
2180
|
{
|
2008
|
-
"
|
2009
|
-
"name": "
|
2010
|
-
|
2011
|
-
"description": "renders the mdc-help-text container that contains the helpertext icon and helpertext.",
|
2012
|
-
"return": {
|
2013
|
-
"type": {
|
2014
|
-
"text": ""
|
2015
|
-
}
|
2016
|
-
},
|
2017
|
-
"inheritedFrom": {
|
2018
|
-
"name": "FormfieldWrapper",
|
2019
|
-
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
2020
|
-
}
|
2021
|
-
}
|
2022
|
-
],
|
2023
|
-
"events": [
|
2181
|
+
"description": "Icon color for a disabled checkbox.",
|
2182
|
+
"name": "--mdc-checkbox-disabled-icon-color"
|
2183
|
+
},
|
2024
2184
|
{
|
2025
|
-
"
|
2026
|
-
|
2027
|
-
}
|
2185
|
+
"description": "Background color for an unselected checkbox.",
|
2186
|
+
"name": "--mdc-checkbox-icon-background-color"
|
2028
2187
|
},
|
2029
2188
|
{
|
2030
|
-
"description": "
|
2031
|
-
"name": "
|
2032
|
-
"reactName": "onChange",
|
2033
|
-
"eventName": "ChangeEvent"
|
2189
|
+
"description": "Default background color for an unselected checkbox.",
|
2190
|
+
"name": "--mdc-checkbox-icon-border-color"
|
2034
2191
|
},
|
2035
2192
|
{
|
2036
|
-
"description": "
|
2037
|
-
"name": "
|
2038
|
-
|
2039
|
-
|
2193
|
+
"description": "Icon color for an unselected checkbox.",
|
2194
|
+
"name": "--mdc-checkbox-icon-color"
|
2195
|
+
},
|
2196
|
+
{
|
2197
|
+
"description": "Background color for a selected checkbox when pressed.",
|
2198
|
+
"name": "--mdc-checkbox-pressed-icon-color"
|
2040
2199
|
}
|
2041
2200
|
],
|
2042
|
-
"
|
2201
|
+
"members": [
|
2043
2202
|
{
|
2203
|
+
"kind": "field",
|
2044
2204
|
"name": "checked",
|
2045
2205
|
"type": {
|
2046
2206
|
"text": "boolean"
|
2047
2207
|
},
|
2048
2208
|
"default": "false",
|
2049
2209
|
"description": "Determines whether the checkbox is selected or unselected.",
|
2050
|
-
"
|
2210
|
+
"attribute": "checked",
|
2211
|
+
"reflects": true
|
2051
2212
|
},
|
2052
2213
|
{
|
2214
|
+
"kind": "field",
|
2053
2215
|
"name": "indeterminate",
|
2054
2216
|
"type": {
|
2055
2217
|
"text": "boolean"
|
2056
2218
|
},
|
2057
2219
|
"default": "false",
|
2058
2220
|
"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.",
|
2059
|
-
"
|
2221
|
+
"attribute": "indeterminate",
|
2222
|
+
"reflects": true
|
2060
2223
|
},
|
2061
2224
|
{
|
2225
|
+
"kind": "field",
|
2062
2226
|
"name": "autofocus",
|
2063
2227
|
"type": {
|
2064
2228
|
"text": "boolean"
|
2065
2229
|
},
|
2066
2230
|
"default": "false",
|
2067
2231
|
"description": "Automatically focus on the element when the page loads.\n[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/autofocus)",
|
2068
|
-
"
|
2232
|
+
"attribute": "autofocus",
|
2233
|
+
"reflects": true
|
2234
|
+
},
|
2235
|
+
{
|
2236
|
+
"kind": "method",
|
2237
|
+
"name": "setFormValue",
|
2238
|
+
"privacy": "private",
|
2239
|
+
"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."
|
2240
|
+
},
|
2241
|
+
{
|
2242
|
+
"kind": "method",
|
2243
|
+
"name": "manageRequired",
|
2244
|
+
"privacy": "private",
|
2245
|
+
"description": "Manages the required state of the checkbox.\nIf the checkbox is not checked and the requiredLabel property is set, then the checkbox is invalid."
|
2246
|
+
},
|
2247
|
+
{
|
2248
|
+
"kind": "method",
|
2249
|
+
"name": "toggleState",
|
2250
|
+
"privacy": "private",
|
2251
|
+
"return": {
|
2252
|
+
"type": {
|
2253
|
+
"text": "void"
|
2254
|
+
}
|
2255
|
+
},
|
2256
|
+
"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."
|
2257
|
+
},
|
2258
|
+
{
|
2259
|
+
"kind": "method",
|
2260
|
+
"name": "handleKeyDown",
|
2261
|
+
"privacy": "private",
|
2262
|
+
"return": {
|
2263
|
+
"type": {
|
2264
|
+
"text": "void"
|
2265
|
+
}
|
2266
|
+
},
|
2267
|
+
"parameters": [
|
2268
|
+
{
|
2269
|
+
"name": "event",
|
2270
|
+
"type": {
|
2271
|
+
"text": "KeyboardEvent"
|
2272
|
+
},
|
2273
|
+
"description": "The keyboard event."
|
2274
|
+
}
|
2275
|
+
],
|
2276
|
+
"description": "Handles the keydown event on the checkbox.\nWhen the user presses Enter, the form is submitted."
|
2277
|
+
},
|
2278
|
+
{
|
2279
|
+
"kind": "method",
|
2280
|
+
"name": "handleChange",
|
2281
|
+
"privacy": "public",
|
2282
|
+
"return": {
|
2283
|
+
"type": {
|
2284
|
+
"text": "void"
|
2285
|
+
}
|
2286
|
+
},
|
2287
|
+
"parameters": [
|
2288
|
+
{
|
2289
|
+
"name": "event",
|
2290
|
+
"type": {
|
2291
|
+
"text": "Event"
|
2292
|
+
}
|
2293
|
+
}
|
2294
|
+
],
|
2295
|
+
"description": "Toggles the state of the checkbox element.\nand dispatch the new change event."
|
2296
|
+
},
|
2297
|
+
{
|
2298
|
+
"kind": "field",
|
2299
|
+
"name": "renderLabelAndHelperText",
|
2300
|
+
"privacy": "private"
|
2301
|
+
},
|
2302
|
+
{
|
2303
|
+
"kind": "field",
|
2304
|
+
"name": "helpTextType",
|
2305
|
+
"type": {
|
2306
|
+
"text": "ValidationType"
|
2307
|
+
},
|
2308
|
+
"description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
|
2309
|
+
"attribute": "help-text-type",
|
2310
|
+
"reflects": true,
|
2311
|
+
"default": "undefined as unknown",
|
2312
|
+
"inheritedFrom": {
|
2313
|
+
"name": "FormfieldWrapper",
|
2314
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
2315
|
+
}
|
2069
2316
|
},
|
2070
2317
|
{
|
2318
|
+
"kind": "field",
|
2071
2319
|
"name": "name",
|
2072
2320
|
"type": {
|
2073
2321
|
"text": "string"
|
2074
2322
|
},
|
2075
2323
|
"default": "''",
|
2076
2324
|
"description": "Indicates the name of the component group.\nThey are used to group elements in a form together.",
|
2077
|
-
"
|
2325
|
+
"attribute": "name",
|
2326
|
+
"reflects": true,
|
2078
2327
|
"inheritedFrom": {
|
2079
2328
|
"name": "FormInternalsMixin",
|
2080
|
-
"module": "
|
2329
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
2081
2330
|
}
|
2082
2331
|
},
|
2083
2332
|
{
|
2333
|
+
"kind": "field",
|
2084
2334
|
"name": "value",
|
2085
2335
|
"type": {
|
2086
2336
|
"text": "string"
|
2087
2337
|
},
|
2088
2338
|
"default": "''",
|
2089
2339
|
"description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
|
2090
|
-
"
|
2340
|
+
"attribute": "value",
|
2341
|
+
"reflects": true,
|
2091
2342
|
"inheritedFrom": {
|
2092
2343
|
"name": "FormInternalsMixin",
|
2093
|
-
"module": "
|
2344
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
2094
2345
|
}
|
2095
2346
|
},
|
2096
2347
|
{
|
2097
|
-
"
|
2348
|
+
"kind": "field",
|
2349
|
+
"name": "validationMessage",
|
2098
2350
|
"type": {
|
2099
2351
|
"text": "string | undefined"
|
2100
2352
|
},
|
2101
2353
|
"description": "Custom validation message that will override the default message and displayed when the input is invalid.",
|
2102
|
-
"
|
2354
|
+
"attribute": "validation-message",
|
2355
|
+
"reflects": true,
|
2103
2356
|
"inheritedFrom": {
|
2104
2357
|
"name": "FormInternalsMixin",
|
2105
|
-
"module": "
|
2358
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
2106
2359
|
}
|
2107
2360
|
},
|
2108
2361
|
{
|
2109
|
-
"
|
2362
|
+
"kind": "field",
|
2363
|
+
"name": "validity",
|
2364
|
+
"type": {
|
2365
|
+
"text": "ValidityState"
|
2366
|
+
},
|
2367
|
+
"readonly": true,
|
2368
|
+
"inheritedFrom": {
|
2369
|
+
"name": "FormInternalsMixin",
|
2370
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
2371
|
+
}
|
2372
|
+
},
|
2373
|
+
{
|
2374
|
+
"kind": "field",
|
2375
|
+
"name": "willValidate",
|
2376
|
+
"readonly": true,
|
2377
|
+
"inheritedFrom": {
|
2378
|
+
"name": "FormInternalsMixin",
|
2379
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
2380
|
+
}
|
2381
|
+
},
|
2382
|
+
{
|
2383
|
+
"kind": "method",
|
2384
|
+
"name": "setValidity",
|
2385
|
+
"description": "Sets the validity of the input field based on the input field's validity.",
|
2386
|
+
"return": {
|
2387
|
+
"type": {
|
2388
|
+
"text": ""
|
2389
|
+
}
|
2390
|
+
},
|
2391
|
+
"inheritedFrom": {
|
2392
|
+
"name": "FormInternalsMixin",
|
2393
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
2394
|
+
}
|
2395
|
+
},
|
2396
|
+
{
|
2397
|
+
"kind": "method",
|
2398
|
+
"name": "checkValidity",
|
2399
|
+
"return": {
|
2400
|
+
"type": {
|
2401
|
+
"text": "boolean"
|
2402
|
+
}
|
2403
|
+
},
|
2404
|
+
"inheritedFrom": {
|
2405
|
+
"name": "FormInternalsMixin",
|
2406
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
2407
|
+
}
|
2408
|
+
},
|
2409
|
+
{
|
2410
|
+
"kind": "method",
|
2411
|
+
"name": "reportValidity",
|
2412
|
+
"inheritedFrom": {
|
2413
|
+
"name": "FormInternalsMixin",
|
2414
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
2415
|
+
}
|
2416
|
+
},
|
2417
|
+
{
|
2418
|
+
"kind": "field",
|
2419
|
+
"name": "id",
|
2420
|
+
"type": {
|
2421
|
+
"text": "string"
|
2422
|
+
},
|
2423
|
+
"default": "`mdc-input-${uuidv4()}`",
|
2424
|
+
"description": "The unique id of the input field. It is used to link the input field with the label.",
|
2425
|
+
"attribute": "id",
|
2426
|
+
"inheritedFrom": {
|
2427
|
+
"name": "FormfieldWrapper",
|
2428
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
2429
|
+
}
|
2430
|
+
},
|
2431
|
+
{
|
2432
|
+
"kind": "field",
|
2433
|
+
"name": "dataAriaLabel",
|
2110
2434
|
"type": {
|
2111
2435
|
"text": "string | null"
|
2112
2436
|
},
|
2113
2437
|
"default": "null",
|
2114
2438
|
"description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
|
2115
|
-
"
|
2439
|
+
"attribute": "data-aria-label",
|
2440
|
+
"reflects": true,
|
2116
2441
|
"inheritedFrom": {
|
2117
2442
|
"name": "DataAriaLabelMixin",
|
2118
|
-
"module": "
|
2443
|
+
"module": "utils/mixins/DataAriaLabelMixin.js"
|
2119
2444
|
}
|
2120
2445
|
},
|
2121
2446
|
{
|
2447
|
+
"kind": "field",
|
2122
2448
|
"name": "disabled",
|
2123
2449
|
"type": {
|
2124
2450
|
"text": "boolean"
|
2125
2451
|
},
|
2126
2452
|
"default": "false",
|
2127
2453
|
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
2128
|
-
"
|
2454
|
+
"attribute": "disabled",
|
2455
|
+
"reflects": true,
|
2129
2456
|
"inheritedFrom": {
|
2130
2457
|
"name": "DisabledMixin",
|
2131
|
-
"module": "
|
2458
|
+
"module": "utils/mixins/DisabledMixin.js"
|
2132
2459
|
}
|
2133
2460
|
},
|
2134
2461
|
{
|
2462
|
+
"kind": "field",
|
2135
2463
|
"name": "label",
|
2136
2464
|
"type": {
|
2137
2465
|
"text": "string | undefined"
|
2138
2466
|
},
|
2139
2467
|
"description": "The label of the input field. It is linked to the input field using the `for` attribute.",
|
2140
|
-
"
|
2468
|
+
"attribute": "label",
|
2469
|
+
"reflects": true,
|
2141
2470
|
"inheritedFrom": {
|
2142
2471
|
"name": "FormfieldWrapper",
|
2143
|
-
"module": "
|
2472
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
2144
2473
|
}
|
2145
2474
|
},
|
2146
2475
|
{
|
2147
|
-
"
|
2476
|
+
"kind": "field",
|
2477
|
+
"name": "requiredLabel",
|
2148
2478
|
"type": {
|
2149
2479
|
"text": "string | undefined"
|
2150
2480
|
},
|
2151
2481
|
"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.",
|
2152
|
-
"
|
2482
|
+
"attribute": "required-label",
|
2483
|
+
"reflects": true,
|
2153
2484
|
"inheritedFrom": {
|
2154
2485
|
"name": "FormfieldWrapper",
|
2155
|
-
"module": "
|
2486
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
2156
2487
|
}
|
2157
2488
|
},
|
2158
2489
|
{
|
2159
|
-
"
|
2490
|
+
"kind": "field",
|
2491
|
+
"name": "helpText",
|
2160
2492
|
"type": {
|
2161
|
-
"text": "string"
|
2493
|
+
"text": "string | undefined"
|
2162
2494
|
},
|
2163
|
-
"
|
2164
|
-
"
|
2165
|
-
"
|
2495
|
+
"description": "The help text that is displayed below the input field.",
|
2496
|
+
"attribute": "help-text",
|
2497
|
+
"reflects": true,
|
2166
2498
|
"inheritedFrom": {
|
2167
2499
|
"name": "FormfieldWrapper",
|
2168
|
-
"module": "
|
2500
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
2169
2501
|
}
|
2170
2502
|
},
|
2171
2503
|
{
|
2172
|
-
"
|
2173
|
-
"
|
2174
|
-
|
2504
|
+
"kind": "method",
|
2505
|
+
"name": "renderLabelElement",
|
2506
|
+
"privacy": "protected",
|
2507
|
+
"description": "creates the label element when the label property is set.\nid is used to link the label with the input field.",
|
2508
|
+
"return": {
|
2509
|
+
"type": {
|
2510
|
+
"text": ""
|
2511
|
+
}
|
2175
2512
|
},
|
2176
|
-
"description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
|
2177
|
-
"fieldName": "helpTextType",
|
2178
2513
|
"inheritedFrom": {
|
2179
2514
|
"name": "FormfieldWrapper",
|
2180
|
-
"module": "
|
2515
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
2181
2516
|
}
|
2182
2517
|
},
|
2183
2518
|
{
|
2184
|
-
"
|
2185
|
-
"
|
2186
|
-
|
2187
|
-
},
|
2188
|
-
"description": "The help text that is displayed below the input field.",
|
2189
|
-
"fieldName": "helpText",
|
2519
|
+
"kind": "method",
|
2520
|
+
"name": "renderRequiredLabel",
|
2521
|
+
"privacy": "protected",
|
2190
2522
|
"inheritedFrom": {
|
2191
2523
|
"name": "FormfieldWrapper",
|
2192
|
-
"module": "
|
2524
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
2193
2525
|
}
|
2194
|
-
}
|
2195
|
-
],
|
2196
|
-
"mixins": [
|
2197
|
-
{
|
2198
|
-
"name": "FormInternalsMixin",
|
2199
|
-
"module": "/src/utils/mixins/FormInternalsMixin"
|
2200
2526
|
},
|
2201
2527
|
{
|
2202
|
-
"
|
2203
|
-
"
|
2204
|
-
|
2205
|
-
|
2528
|
+
"kind": "method",
|
2529
|
+
"name": "renderHelpTextIcon",
|
2530
|
+
"privacy": "protected",
|
2531
|
+
"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.",
|
2532
|
+
"return": {
|
2533
|
+
"type": {
|
2534
|
+
"text": ""
|
2535
|
+
}
|
2536
|
+
},
|
2537
|
+
"inheritedFrom": {
|
2538
|
+
"name": "FormfieldWrapper",
|
2539
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
2540
|
+
}
|
2541
|
+
},
|
2542
|
+
{
|
2543
|
+
"kind": "method",
|
2544
|
+
"name": "renderHelpText",
|
2545
|
+
"privacy": "protected",
|
2546
|
+
"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.",
|
2547
|
+
"return": {
|
2548
|
+
"type": {
|
2549
|
+
"text": ""
|
2550
|
+
}
|
2551
|
+
},
|
2552
|
+
"inheritedFrom": {
|
2553
|
+
"name": "FormfieldWrapper",
|
2554
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
2555
|
+
}
|
2556
|
+
},
|
2557
|
+
{
|
2558
|
+
"kind": "method",
|
2559
|
+
"name": "renderLabel",
|
2560
|
+
"privacy": "protected",
|
2561
|
+
"description": "renders the mdc-label-text container that contains the label and labelInfoToggleTip.",
|
2562
|
+
"return": {
|
2563
|
+
"type": {
|
2564
|
+
"text": ""
|
2565
|
+
}
|
2566
|
+
},
|
2567
|
+
"inheritedFrom": {
|
2568
|
+
"name": "FormfieldWrapper",
|
2569
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
2570
|
+
}
|
2571
|
+
},
|
2572
|
+
{
|
2573
|
+
"kind": "method",
|
2574
|
+
"name": "renderHelperText",
|
2575
|
+
"privacy": "protected",
|
2576
|
+
"description": "renders the mdc-help-text container that contains the helpertext icon and helpertext.",
|
2577
|
+
"return": {
|
2578
|
+
"type": {
|
2579
|
+
"text": ""
|
2580
|
+
}
|
2581
|
+
},
|
2582
|
+
"inheritedFrom": {
|
2583
|
+
"name": "FormfieldWrapper",
|
2584
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
2585
|
+
}
|
2586
|
+
}
|
2587
|
+
],
|
2588
|
+
"events": [
|
2589
|
+
{
|
2590
|
+
"type": {
|
2591
|
+
"text": "EventConstructor"
|
2592
|
+
}
|
2593
|
+
},
|
2594
|
+
{
|
2595
|
+
"description": "(React: onChange) Event that gets dispatched when the checkbox state changes.",
|
2596
|
+
"name": "change",
|
2597
|
+
"reactName": "onChange",
|
2598
|
+
"eventName": "ChangeEvent"
|
2599
|
+
},
|
2600
|
+
{
|
2601
|
+
"description": "(React: onFocus) Event that gets dispatched when the checkbox receives focus.",
|
2602
|
+
"name": "focus",
|
2603
|
+
"reactName": "onFocus",
|
2604
|
+
"eventName": "FocusEvent"
|
2605
|
+
}
|
2606
|
+
],
|
2607
|
+
"attributes": [
|
2608
|
+
{
|
2609
|
+
"name": "checked",
|
2610
|
+
"type": {
|
2611
|
+
"text": "boolean"
|
2612
|
+
},
|
2613
|
+
"default": "false",
|
2614
|
+
"description": "Determines whether the checkbox is selected or unselected.",
|
2615
|
+
"fieldName": "checked"
|
2616
|
+
},
|
2617
|
+
{
|
2618
|
+
"name": "indeterminate",
|
2619
|
+
"type": {
|
2620
|
+
"text": "boolean"
|
2621
|
+
},
|
2622
|
+
"default": "false",
|
2623
|
+
"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.",
|
2624
|
+
"fieldName": "indeterminate"
|
2625
|
+
},
|
2626
|
+
{
|
2627
|
+
"name": "autofocus",
|
2628
|
+
"type": {
|
2629
|
+
"text": "boolean"
|
2630
|
+
},
|
2631
|
+
"default": "false",
|
2632
|
+
"description": "Automatically focus on the element when the page loads.\n[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/autofocus)",
|
2633
|
+
"fieldName": "autofocus"
|
2634
|
+
},
|
2635
|
+
{
|
2636
|
+
"name": "name",
|
2637
|
+
"type": {
|
2638
|
+
"text": "string"
|
2639
|
+
},
|
2640
|
+
"default": "''",
|
2641
|
+
"description": "Indicates the name of the component group.\nThey are used to group elements in a form together.",
|
2642
|
+
"fieldName": "name",
|
2643
|
+
"inheritedFrom": {
|
2644
|
+
"name": "FormInternalsMixin",
|
2645
|
+
"module": "src/utils/mixins/FormInternalsMixin.ts"
|
2646
|
+
}
|
2647
|
+
},
|
2648
|
+
{
|
2649
|
+
"name": "value",
|
2650
|
+
"type": {
|
2651
|
+
"text": "string"
|
2652
|
+
},
|
2653
|
+
"default": "''",
|
2654
|
+
"description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
|
2655
|
+
"fieldName": "value",
|
2656
|
+
"inheritedFrom": {
|
2657
|
+
"name": "FormInternalsMixin",
|
2658
|
+
"module": "src/utils/mixins/FormInternalsMixin.ts"
|
2659
|
+
}
|
2660
|
+
},
|
2661
|
+
{
|
2662
|
+
"name": "validation-message",
|
2663
|
+
"type": {
|
2664
|
+
"text": "string | undefined"
|
2665
|
+
},
|
2666
|
+
"description": "Custom validation message that will override the default message and displayed when the input is invalid.",
|
2667
|
+
"fieldName": "validationMessage",
|
2668
|
+
"inheritedFrom": {
|
2669
|
+
"name": "FormInternalsMixin",
|
2670
|
+
"module": "src/utils/mixins/FormInternalsMixin.ts"
|
2671
|
+
}
|
2672
|
+
},
|
2673
|
+
{
|
2674
|
+
"name": "data-aria-label",
|
2675
|
+
"type": {
|
2676
|
+
"text": "string | null"
|
2677
|
+
},
|
2678
|
+
"default": "null",
|
2679
|
+
"description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
|
2680
|
+
"fieldName": "dataAriaLabel",
|
2681
|
+
"inheritedFrom": {
|
2682
|
+
"name": "DataAriaLabelMixin",
|
2683
|
+
"module": "src/utils/mixins/DataAriaLabelMixin.ts"
|
2684
|
+
}
|
2685
|
+
},
|
2686
|
+
{
|
2687
|
+
"name": "disabled",
|
2688
|
+
"type": {
|
2689
|
+
"text": "boolean"
|
2690
|
+
},
|
2691
|
+
"default": "false",
|
2692
|
+
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
2693
|
+
"fieldName": "disabled",
|
2694
|
+
"inheritedFrom": {
|
2695
|
+
"name": "DisabledMixin",
|
2696
|
+
"module": "src/utils/mixins/DisabledMixin.ts"
|
2697
|
+
}
|
2698
|
+
},
|
2699
|
+
{
|
2700
|
+
"name": "label",
|
2701
|
+
"type": {
|
2702
|
+
"text": "string | undefined"
|
2703
|
+
},
|
2704
|
+
"description": "The label of the input field. It is linked to the input field using the `for` attribute.",
|
2705
|
+
"fieldName": "label",
|
2706
|
+
"inheritedFrom": {
|
2707
|
+
"name": "FormfieldWrapper",
|
2708
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
2709
|
+
}
|
2710
|
+
},
|
2711
|
+
{
|
2712
|
+
"name": "required-label",
|
2713
|
+
"type": {
|
2714
|
+
"text": "string | undefined"
|
2715
|
+
},
|
2716
|
+
"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.",
|
2717
|
+
"fieldName": "requiredLabel",
|
2718
|
+
"inheritedFrom": {
|
2719
|
+
"name": "FormfieldWrapper",
|
2720
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
2721
|
+
}
|
2722
|
+
},
|
2723
|
+
{
|
2724
|
+
"name": "id",
|
2725
|
+
"type": {
|
2726
|
+
"text": "string"
|
2727
|
+
},
|
2728
|
+
"default": "''",
|
2729
|
+
"description": "The unique id of the input field. It is used to link the input field with the label.",
|
2730
|
+
"fieldName": "id",
|
2731
|
+
"inheritedFrom": {
|
2732
|
+
"name": "FormfieldWrapper",
|
2733
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
2734
|
+
}
|
2735
|
+
},
|
2736
|
+
{
|
2737
|
+
"name": "help-text-type",
|
2738
|
+
"type": {
|
2739
|
+
"text": "ValidationType"
|
2740
|
+
},
|
2741
|
+
"description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
|
2742
|
+
"fieldName": "helpTextType",
|
2743
|
+
"inheritedFrom": {
|
2744
|
+
"name": "FormfieldWrapper",
|
2745
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
2746
|
+
}
|
2747
|
+
},
|
2748
|
+
{
|
2749
|
+
"name": "help-text",
|
2750
|
+
"type": {
|
2751
|
+
"text": "string | undefined"
|
2752
|
+
},
|
2753
|
+
"description": "The help text that is displayed below the input field.",
|
2754
|
+
"fieldName": "helpText",
|
2755
|
+
"inheritedFrom": {
|
2756
|
+
"name": "FormfieldWrapper",
|
2757
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
2758
|
+
}
|
2759
|
+
}
|
2760
|
+
],
|
2761
|
+
"mixins": [
|
2762
|
+
{
|
2763
|
+
"name": "FormInternalsMixin",
|
2764
|
+
"module": "/src/utils/mixins/FormInternalsMixin"
|
2765
|
+
},
|
2766
|
+
{
|
2767
|
+
"name": "DataAriaLabelMixin",
|
2768
|
+
"module": "/src/utils/mixins/DataAriaLabelMixin"
|
2769
|
+
}
|
2770
|
+
],
|
2206
2771
|
"superclass": {
|
2207
2772
|
"name": "FormfieldWrapper",
|
2208
2773
|
"module": "/src/components/formfieldwrapper/formfieldwrapper.component"
|
@@ -7143,562 +7708,138 @@
|
|
7143
7708
|
"text": "KeyboardEvent"
|
7144
7709
|
}
|
7145
7710
|
}
|
7146
|
-
],
|
7147
|
-
"description": "Handles the keydown event (Arrow Up/Down/Left/Right) on the radio element."
|
7148
|
-
},
|
7149
|
-
{
|
7150
|
-
"kind": "method",
|
7151
|
-
"name": "updateTabIndex",
|
7152
|
-
"privacy": "private",
|
7153
|
-
"return": {
|
7154
|
-
"type": {
|
7155
|
-
"text": "void"
|
7156
|
-
}
|
7157
|
-
},
|
7158
|
-
"description": "Update tab index for all radios in the same group (name)\nIf any radio group is checked, it will have a tab index of 0\nIf no radio group is checked, the first enabled radio will have a tab index of 0"
|
7159
|
-
},
|
7160
|
-
{
|
7161
|
-
"kind": "field",
|
7162
|
-
"name": "renderLabelAndHelperText",
|
7163
|
-
"privacy": "private"
|
7164
|
-
},
|
7165
|
-
{
|
7166
|
-
"kind": "field",
|
7167
|
-
"name": "helpTextType",
|
7168
|
-
"type": {
|
7169
|
-
"text": "ValidationType"
|
7170
|
-
},
|
7171
|
-
"description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
|
7172
|
-
"attribute": "help-text-type",
|
7173
|
-
"reflects": true,
|
7174
|
-
"default": "undefined as unknown",
|
7175
|
-
"inheritedFrom": {
|
7176
|
-
"name": "FormfieldWrapper",
|
7177
|
-
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
7178
|
-
}
|
7179
|
-
},
|
7180
|
-
{
|
7181
|
-
"kind": "field",
|
7182
|
-
"name": "name",
|
7183
|
-
"type": {
|
7184
|
-
"text": "string"
|
7185
|
-
},
|
7186
|
-
"default": "''",
|
7187
|
-
"description": "Indicates the name of the component group.\nThey are used to group elements in a form together.",
|
7188
|
-
"attribute": "name",
|
7189
|
-
"reflects": true,
|
7190
|
-
"inheritedFrom": {
|
7191
|
-
"name": "FormInternalsMixin",
|
7192
|
-
"module": "utils/mixins/FormInternalsMixin.js"
|
7193
|
-
}
|
7194
|
-
},
|
7195
|
-
{
|
7196
|
-
"kind": "field",
|
7197
|
-
"name": "value",
|
7198
|
-
"type": {
|
7199
|
-
"text": "string"
|
7200
|
-
},
|
7201
|
-
"default": "''",
|
7202
|
-
"description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
|
7203
|
-
"attribute": "value",
|
7204
|
-
"reflects": true,
|
7205
|
-
"inheritedFrom": {
|
7206
|
-
"name": "FormInternalsMixin",
|
7207
|
-
"module": "utils/mixins/FormInternalsMixin.js"
|
7208
|
-
}
|
7209
|
-
},
|
7210
|
-
{
|
7211
|
-
"kind": "field",
|
7212
|
-
"name": "validationMessage",
|
7213
|
-
"type": {
|
7214
|
-
"text": "string | undefined"
|
7215
|
-
},
|
7216
|
-
"description": "Custom validation message that will override the default message and displayed when the input is invalid.",
|
7217
|
-
"attribute": "validation-message",
|
7218
|
-
"reflects": true,
|
7219
|
-
"inheritedFrom": {
|
7220
|
-
"name": "FormInternalsMixin",
|
7221
|
-
"module": "utils/mixins/FormInternalsMixin.js"
|
7222
|
-
}
|
7223
|
-
},
|
7224
|
-
{
|
7225
|
-
"kind": "field",
|
7226
|
-
"name": "validity",
|
7227
|
-
"type": {
|
7228
|
-
"text": "ValidityState"
|
7229
|
-
},
|
7230
|
-
"readonly": true,
|
7231
|
-
"inheritedFrom": {
|
7232
|
-
"name": "FormInternalsMixin",
|
7233
|
-
"module": "utils/mixins/FormInternalsMixin.js"
|
7234
|
-
}
|
7235
|
-
},
|
7236
|
-
{
|
7237
|
-
"kind": "field",
|
7238
|
-
"name": "willValidate",
|
7239
|
-
"readonly": true,
|
7240
|
-
"inheritedFrom": {
|
7241
|
-
"name": "FormInternalsMixin",
|
7242
|
-
"module": "utils/mixins/FormInternalsMixin.js"
|
7243
|
-
}
|
7244
|
-
},
|
7245
|
-
{
|
7246
|
-
"kind": "method",
|
7247
|
-
"name": "setValidity",
|
7248
|
-
"description": "Sets the validity of the input field based on the input field's validity.",
|
7249
|
-
"return": {
|
7250
|
-
"type": {
|
7251
|
-
"text": ""
|
7252
|
-
}
|
7253
|
-
},
|
7254
|
-
"inheritedFrom": {
|
7255
|
-
"name": "FormInternalsMixin",
|
7256
|
-
"module": "utils/mixins/FormInternalsMixin.js"
|
7257
|
-
}
|
7258
|
-
},
|
7259
|
-
{
|
7260
|
-
"kind": "method",
|
7261
|
-
"name": "checkValidity",
|
7262
|
-
"return": {
|
7263
|
-
"type": {
|
7264
|
-
"text": "boolean"
|
7265
|
-
}
|
7266
|
-
},
|
7267
|
-
"inheritedFrom": {
|
7268
|
-
"name": "FormInternalsMixin",
|
7269
|
-
"module": "utils/mixins/FormInternalsMixin.js"
|
7270
|
-
}
|
7271
|
-
},
|
7272
|
-
{
|
7273
|
-
"kind": "method",
|
7274
|
-
"name": "reportValidity",
|
7275
|
-
"inheritedFrom": {
|
7276
|
-
"name": "FormInternalsMixin",
|
7277
|
-
"module": "utils/mixins/FormInternalsMixin.js"
|
7278
|
-
}
|
7279
|
-
},
|
7280
|
-
{
|
7281
|
-
"kind": "field",
|
7282
|
-
"name": "id",
|
7283
|
-
"type": {
|
7284
|
-
"text": "string"
|
7285
|
-
},
|
7286
|
-
"default": "`mdc-input-${uuidv4()}`",
|
7287
|
-
"description": "The unique id of the input field. It is used to link the input field with the label.",
|
7288
|
-
"attribute": "id",
|
7289
|
-
"inheritedFrom": {
|
7290
|
-
"name": "FormfieldWrapper",
|
7291
|
-
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
7292
|
-
}
|
7293
|
-
},
|
7294
|
-
{
|
7295
|
-
"kind": "field",
|
7296
|
-
"name": "dataAriaLabel",
|
7297
|
-
"type": {
|
7298
|
-
"text": "string | null"
|
7299
|
-
},
|
7300
|
-
"default": "null",
|
7301
|
-
"description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
|
7302
|
-
"attribute": "data-aria-label",
|
7303
|
-
"reflects": true,
|
7304
|
-
"inheritedFrom": {
|
7305
|
-
"name": "DataAriaLabelMixin",
|
7306
|
-
"module": "utils/mixins/DataAriaLabelMixin.js"
|
7307
|
-
}
|
7308
|
-
},
|
7309
|
-
{
|
7310
|
-
"kind": "field",
|
7311
|
-
"name": "disabled",
|
7312
|
-
"type": {
|
7313
|
-
"text": "boolean"
|
7314
|
-
},
|
7315
|
-
"default": "false",
|
7316
|
-
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
7317
|
-
"attribute": "disabled",
|
7318
|
-
"reflects": true,
|
7319
|
-
"inheritedFrom": {
|
7320
|
-
"name": "FormfieldWrapper",
|
7321
|
-
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
7322
|
-
}
|
7323
|
-
},
|
7324
|
-
{
|
7325
|
-
"kind": "field",
|
7326
|
-
"name": "label",
|
7327
|
-
"type": {
|
7328
|
-
"text": "string | undefined"
|
7329
|
-
},
|
7330
|
-
"description": "The label of the input field. It is linked to the input field using the `for` attribute.",
|
7331
|
-
"attribute": "label",
|
7332
|
-
"reflects": true,
|
7333
|
-
"inheritedFrom": {
|
7334
|
-
"name": "FormfieldWrapper",
|
7335
|
-
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
7336
|
-
}
|
7337
|
-
},
|
7338
|
-
{
|
7339
|
-
"kind": "field",
|
7340
|
-
"name": "requiredLabel",
|
7341
|
-
"type": {
|
7342
|
-
"text": "string | undefined"
|
7343
|
-
},
|
7344
|
-
"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.",
|
7345
|
-
"attribute": "required-label",
|
7346
|
-
"reflects": true,
|
7347
|
-
"inheritedFrom": {
|
7348
|
-
"name": "FormfieldWrapper",
|
7349
|
-
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
7350
|
-
}
|
7351
|
-
},
|
7352
|
-
{
|
7353
|
-
"kind": "field",
|
7354
|
-
"name": "helpText",
|
7355
|
-
"type": {
|
7356
|
-
"text": "string | undefined"
|
7357
|
-
},
|
7358
|
-
"description": "The help text that is displayed below the input field.",
|
7359
|
-
"attribute": "help-text",
|
7360
|
-
"reflects": true,
|
7361
|
-
"inheritedFrom": {
|
7362
|
-
"name": "FormfieldWrapper",
|
7363
|
-
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
7364
|
-
}
|
7365
|
-
},
|
7366
|
-
{
|
7367
|
-
"kind": "method",
|
7368
|
-
"name": "renderLabelElement",
|
7369
|
-
"privacy": "protected",
|
7370
|
-
"description": "creates the label element when the label property is set.\nid is used to link the label with the input field.",
|
7371
|
-
"return": {
|
7372
|
-
"type": {
|
7373
|
-
"text": ""
|
7374
|
-
}
|
7375
|
-
},
|
7376
|
-
"inheritedFrom": {
|
7377
|
-
"name": "FormfieldWrapper",
|
7378
|
-
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
7379
|
-
}
|
7380
|
-
},
|
7381
|
-
{
|
7382
|
-
"kind": "method",
|
7383
|
-
"name": "renderRequiredLabel",
|
7384
|
-
"privacy": "protected",
|
7385
|
-
"inheritedFrom": {
|
7386
|
-
"name": "FormfieldWrapper",
|
7387
|
-
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
7388
|
-
}
|
7389
|
-
},
|
7390
|
-
{
|
7391
|
-
"kind": "method",
|
7392
|
-
"name": "renderHelpTextIcon",
|
7393
|
-
"privacy": "protected",
|
7394
|
-
"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.",
|
7395
|
-
"return": {
|
7396
|
-
"type": {
|
7397
|
-
"text": ""
|
7398
|
-
}
|
7399
|
-
},
|
7400
|
-
"inheritedFrom": {
|
7401
|
-
"name": "FormfieldWrapper",
|
7402
|
-
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
7403
|
-
}
|
7404
|
-
},
|
7405
|
-
{
|
7406
|
-
"kind": "method",
|
7407
|
-
"name": "renderHelpText",
|
7408
|
-
"privacy": "protected",
|
7409
|
-
"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.",
|
7410
|
-
"return": {
|
7411
|
-
"type": {
|
7412
|
-
"text": ""
|
7413
|
-
}
|
7414
|
-
},
|
7415
|
-
"inheritedFrom": {
|
7416
|
-
"name": "FormfieldWrapper",
|
7417
|
-
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
7418
|
-
}
|
7419
|
-
},
|
7420
|
-
{
|
7421
|
-
"kind": "method",
|
7422
|
-
"name": "renderLabel",
|
7423
|
-
"privacy": "protected",
|
7424
|
-
"description": "renders the mdc-label-text container that contains the label and labelInfoToggleTip.",
|
7425
|
-
"return": {
|
7426
|
-
"type": {
|
7427
|
-
"text": ""
|
7428
|
-
}
|
7429
|
-
},
|
7430
|
-
"inheritedFrom": {
|
7431
|
-
"name": "FormfieldWrapper",
|
7432
|
-
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
7433
|
-
}
|
7711
|
+
],
|
7712
|
+
"description": "Handles the keydown event (Arrow Up/Down/Left/Right) on the radio element."
|
7434
7713
|
},
|
7435
7714
|
{
|
7436
7715
|
"kind": "method",
|
7437
|
-
"name": "
|
7438
|
-
"privacy": "
|
7439
|
-
"description": "renders the mdc-help-text container that contains the helpertext icon and helpertext.",
|
7716
|
+
"name": "updateTabIndex",
|
7717
|
+
"privacy": "private",
|
7440
7718
|
"return": {
|
7441
7719
|
"type": {
|
7442
|
-
"text": ""
|
7720
|
+
"text": "void"
|
7443
7721
|
}
|
7444
7722
|
},
|
7445
|
-
"
|
7446
|
-
"name": "FormfieldWrapper",
|
7447
|
-
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
7448
|
-
}
|
7449
|
-
}
|
7450
|
-
],
|
7451
|
-
"events": [
|
7452
|
-
{
|
7453
|
-
"type": {
|
7454
|
-
"text": "EventConstructor"
|
7455
|
-
}
|
7456
|
-
},
|
7457
|
-
{
|
7458
|
-
"description": "(React: onChange) Event that gets dispatched when the radio state changes.",
|
7459
|
-
"name": "change",
|
7460
|
-
"reactName": "onChange",
|
7461
|
-
"eventName": "ChangeEvent"
|
7462
|
-
},
|
7463
|
-
{
|
7464
|
-
"description": "(React: onFocus) Event that gets dispatched when the radio receives focus.",
|
7465
|
-
"name": "focus",
|
7466
|
-
"reactName": "onFocus",
|
7467
|
-
"eventName": "FocusEvent"
|
7468
|
-
}
|
7469
|
-
],
|
7470
|
-
"attributes": [
|
7471
|
-
{
|
7472
|
-
"name": "checked",
|
7473
|
-
"type": {
|
7474
|
-
"text": "boolean"
|
7475
|
-
},
|
7476
|
-
"default": "false",
|
7477
|
-
"description": "Determines whether the radio is selected or unselected.",
|
7478
|
-
"fieldName": "checked"
|
7723
|
+
"description": "Update tab index for all radios in the same group (name)\nIf any radio group is checked, it will have a tab index of 0\nIf no radio group is checked, the first enabled radio will have a tab index of 0"
|
7479
7724
|
},
|
7480
7725
|
{
|
7481
|
-
"
|
7482
|
-
"
|
7483
|
-
|
7484
|
-
},
|
7485
|
-
"default": "false",
|
7486
|
-
"description": "Determines whether the radio is read-only.",
|
7487
|
-
"fieldName": "readonly"
|
7726
|
+
"kind": "field",
|
7727
|
+
"name": "renderLabelAndHelperText",
|
7728
|
+
"privacy": "private"
|
7488
7729
|
},
|
7489
7730
|
{
|
7490
|
-
"
|
7731
|
+
"kind": "field",
|
7732
|
+
"name": "helpTextType",
|
7491
7733
|
"type": {
|
7492
|
-
"text": "
|
7734
|
+
"text": "ValidationType"
|
7493
7735
|
},
|
7494
|
-
"
|
7495
|
-
"
|
7496
|
-
"
|
7736
|
+
"description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
|
7737
|
+
"attribute": "help-text-type",
|
7738
|
+
"reflects": true,
|
7739
|
+
"default": "undefined as unknown",
|
7740
|
+
"inheritedFrom": {
|
7741
|
+
"name": "FormfieldWrapper",
|
7742
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
7743
|
+
}
|
7497
7744
|
},
|
7498
7745
|
{
|
7746
|
+
"kind": "field",
|
7499
7747
|
"name": "name",
|
7500
7748
|
"type": {
|
7501
7749
|
"text": "string"
|
7502
7750
|
},
|
7503
7751
|
"default": "''",
|
7504
7752
|
"description": "Indicates the name of the component group.\nThey are used to group elements in a form together.",
|
7505
|
-
"
|
7753
|
+
"attribute": "name",
|
7754
|
+
"reflects": true,
|
7506
7755
|
"inheritedFrom": {
|
7507
7756
|
"name": "FormInternalsMixin",
|
7508
|
-
"module": "
|
7757
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
7509
7758
|
}
|
7510
7759
|
},
|
7511
7760
|
{
|
7761
|
+
"kind": "field",
|
7512
7762
|
"name": "value",
|
7513
7763
|
"type": {
|
7514
7764
|
"text": "string"
|
7515
7765
|
},
|
7516
7766
|
"default": "''",
|
7517
7767
|
"description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
|
7518
|
-
"
|
7768
|
+
"attribute": "value",
|
7769
|
+
"reflects": true,
|
7519
7770
|
"inheritedFrom": {
|
7520
7771
|
"name": "FormInternalsMixin",
|
7521
|
-
"module": "
|
7772
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
7522
7773
|
}
|
7523
7774
|
},
|
7524
7775
|
{
|
7525
|
-
"
|
7776
|
+
"kind": "field",
|
7777
|
+
"name": "validationMessage",
|
7526
7778
|
"type": {
|
7527
7779
|
"text": "string | undefined"
|
7528
7780
|
},
|
7529
7781
|
"description": "Custom validation message that will override the default message and displayed when the input is invalid.",
|
7530
|
-
"
|
7782
|
+
"attribute": "validation-message",
|
7783
|
+
"reflects": true,
|
7531
7784
|
"inheritedFrom": {
|
7532
7785
|
"name": "FormInternalsMixin",
|
7533
|
-
"module": "
|
7534
|
-
}
|
7535
|
-
},
|
7536
|
-
{
|
7537
|
-
"name": "data-aria-label",
|
7538
|
-
"type": {
|
7539
|
-
"text": "string | null"
|
7540
|
-
},
|
7541
|
-
"default": "null",
|
7542
|
-
"description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
|
7543
|
-
"fieldName": "dataAriaLabel",
|
7544
|
-
"inheritedFrom": {
|
7545
|
-
"name": "DataAriaLabelMixin",
|
7546
|
-
"module": "src/utils/mixins/DataAriaLabelMixin.ts"
|
7547
|
-
}
|
7548
|
-
},
|
7549
|
-
{
|
7550
|
-
"name": "disabled",
|
7551
|
-
"type": {
|
7552
|
-
"text": "boolean"
|
7553
|
-
},
|
7554
|
-
"default": "false",
|
7555
|
-
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
7556
|
-
"fieldName": "disabled",
|
7557
|
-
"inheritedFrom": {
|
7558
|
-
"name": "FormfieldWrapper",
|
7559
|
-
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
7560
|
-
}
|
7561
|
-
},
|
7562
|
-
{
|
7563
|
-
"name": "label",
|
7564
|
-
"type": {
|
7565
|
-
"text": "string | undefined"
|
7566
|
-
},
|
7567
|
-
"description": "The label of the input field. It is linked to the input field using the `for` attribute.",
|
7568
|
-
"fieldName": "label",
|
7569
|
-
"inheritedFrom": {
|
7570
|
-
"name": "FormfieldWrapper",
|
7571
|
-
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
7572
|
-
}
|
7573
|
-
},
|
7574
|
-
{
|
7575
|
-
"name": "required-label",
|
7576
|
-
"type": {
|
7577
|
-
"text": "string | undefined"
|
7578
|
-
},
|
7579
|
-
"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.",
|
7580
|
-
"fieldName": "requiredLabel",
|
7581
|
-
"inheritedFrom": {
|
7582
|
-
"name": "FormfieldWrapper",
|
7583
|
-
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
7786
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
7584
7787
|
}
|
7585
7788
|
},
|
7586
7789
|
{
|
7587
|
-
"
|
7790
|
+
"kind": "field",
|
7791
|
+
"name": "validity",
|
7588
7792
|
"type": {
|
7589
|
-
"text": "
|
7793
|
+
"text": "ValidityState"
|
7590
7794
|
},
|
7591
|
-
"
|
7592
|
-
"description": "The unique id of the input field. It is used to link the input field with the label.",
|
7593
|
-
"fieldName": "id",
|
7795
|
+
"readonly": true,
|
7594
7796
|
"inheritedFrom": {
|
7595
|
-
"name": "
|
7596
|
-
"module": "
|
7797
|
+
"name": "FormInternalsMixin",
|
7798
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
7597
7799
|
}
|
7598
7800
|
},
|
7599
7801
|
{
|
7600
|
-
"
|
7601
|
-
"
|
7602
|
-
|
7603
|
-
},
|
7604
|
-
"description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
|
7605
|
-
"fieldName": "helpTextType",
|
7802
|
+
"kind": "field",
|
7803
|
+
"name": "willValidate",
|
7804
|
+
"readonly": true,
|
7606
7805
|
"inheritedFrom": {
|
7607
|
-
"name": "
|
7608
|
-
"module": "
|
7806
|
+
"name": "FormInternalsMixin",
|
7807
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
7609
7808
|
}
|
7610
7809
|
},
|
7611
7810
|
{
|
7612
|
-
"
|
7613
|
-
"
|
7614
|
-
|
7811
|
+
"kind": "method",
|
7812
|
+
"name": "setValidity",
|
7813
|
+
"description": "Sets the validity of the input field based on the input field's validity.",
|
7814
|
+
"return": {
|
7815
|
+
"type": {
|
7816
|
+
"text": ""
|
7817
|
+
}
|
7615
7818
|
},
|
7616
|
-
"description": "The help text that is displayed below the input field.",
|
7617
|
-
"fieldName": "helpText",
|
7618
7819
|
"inheritedFrom": {
|
7619
|
-
"name": "
|
7620
|
-
"module": "
|
7820
|
+
"name": "FormInternalsMixin",
|
7821
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
7621
7822
|
}
|
7622
|
-
}
|
7623
|
-
],
|
7624
|
-
"mixins": [
|
7625
|
-
{
|
7626
|
-
"name": "FormInternalsMixin",
|
7627
|
-
"module": "/src/utils/mixins/FormInternalsMixin"
|
7628
7823
|
},
|
7629
7824
|
{
|
7630
|
-
"
|
7631
|
-
"
|
7632
|
-
|
7633
|
-
|
7634
|
-
|
7635
|
-
|
7636
|
-
"module": "/src/components/formfieldwrapper/formfieldwrapper.component"
|
7637
|
-
},
|
7638
|
-
"tagName": "mdc-radio",
|
7639
|
-
"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 */",
|
7640
|
-
"customElement": true,
|
7641
|
-
"slots": [
|
7642
|
-
{
|
7643
|
-
"description": "slot to add the label info icon",
|
7644
|
-
"name": "label-info",
|
7645
|
-
"inheritedFrom": {
|
7646
|
-
"name": "FormfieldWrapper",
|
7647
|
-
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
7648
|
-
}
|
7649
|
-
}
|
7650
|
-
]
|
7651
|
-
}
|
7652
|
-
],
|
7653
|
-
"exports": [
|
7654
|
-
{
|
7655
|
-
"kind": "js",
|
7656
|
-
"name": "default",
|
7657
|
-
"declaration": {
|
7658
|
-
"name": "Radio",
|
7659
|
-
"module": "components/radio/radio.component.js"
|
7660
|
-
}
|
7661
|
-
}
|
7662
|
-
]
|
7663
|
-
},
|
7664
|
-
{
|
7665
|
-
"kind": "javascript-module",
|
7666
|
-
"path": "components/radiogroup/radiogroup.component.js",
|
7667
|
-
"declarations": [
|
7668
|
-
{
|
7669
|
-
"kind": "class",
|
7670
|
-
"description": "`mdc-radiogroup` - This is the wrapper component for radio buttons which are grouped together.\nIt can have a header text and a description. It enables users to select a single option from a set of options.\nIt is often used in forms, settings, and selection in lists. It automatically group the radio buttons inside it.",
|
7671
|
-
"name": "RadioGroup",
|
7672
|
-
"cssProperties": [
|
7673
|
-
{
|
7674
|
-
"description": "color of the description text",
|
7675
|
-
"name": "--mdc-radiogroup-description-text-normal"
|
7676
|
-
}
|
7677
|
-
],
|
7678
|
-
"members": [
|
7679
|
-
{
|
7680
|
-
"kind": "field",
|
7681
|
-
"name": "name",
|
7682
|
-
"type": {
|
7683
|
-
"text": "string"
|
7825
|
+
"kind": "method",
|
7826
|
+
"name": "checkValidity",
|
7827
|
+
"return": {
|
7828
|
+
"type": {
|
7829
|
+
"text": "boolean"
|
7830
|
+
}
|
7684
7831
|
},
|
7685
|
-
"
|
7686
|
-
|
7687
|
-
|
7832
|
+
"inheritedFrom": {
|
7833
|
+
"name": "FormInternalsMixin",
|
7834
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
7835
|
+
}
|
7688
7836
|
},
|
7689
7837
|
{
|
7690
|
-
"kind": "
|
7691
|
-
"name": "
|
7692
|
-
"type": {
|
7693
|
-
"text": "string | null"
|
7694
|
-
},
|
7695
|
-
"default": "null",
|
7696
|
-
"description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
|
7697
|
-
"attribute": "data-aria-label",
|
7698
|
-
"reflects": true,
|
7838
|
+
"kind": "method",
|
7839
|
+
"name": "reportValidity",
|
7699
7840
|
"inheritedFrom": {
|
7700
|
-
"name": "
|
7701
|
-
"module": "utils/mixins/
|
7841
|
+
"name": "FormInternalsMixin",
|
7842
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
7702
7843
|
}
|
7703
7844
|
},
|
7704
7845
|
{
|
@@ -7707,7 +7848,7 @@
|
|
7707
7848
|
"type": {
|
7708
7849
|
"text": "string"
|
7709
7850
|
},
|
7710
|
-
"default": "
|
7851
|
+
"default": "`mdc-input-${uuidv4()}`",
|
7711
7852
|
"description": "The unique id of the input field. It is used to link the input field with the label.",
|
7712
7853
|
"attribute": "id",
|
7713
7854
|
"inheritedFrom": {
|
@@ -7717,17 +7858,17 @@
|
|
7717
7858
|
},
|
7718
7859
|
{
|
7719
7860
|
"kind": "field",
|
7720
|
-
"name": "
|
7861
|
+
"name": "dataAriaLabel",
|
7721
7862
|
"type": {
|
7722
|
-
"text": "
|
7863
|
+
"text": "string | null"
|
7723
7864
|
},
|
7724
|
-
"
|
7725
|
-
"
|
7865
|
+
"default": "null",
|
7866
|
+
"description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
|
7867
|
+
"attribute": "data-aria-label",
|
7726
7868
|
"reflects": true,
|
7727
|
-
"default": "undefined as unknown",
|
7728
7869
|
"inheritedFrom": {
|
7729
|
-
"name": "
|
7730
|
-
"module": "
|
7870
|
+
"name": "DataAriaLabelMixin",
|
7871
|
+
"module": "utils/mixins/DataAriaLabelMixin.js"
|
7731
7872
|
}
|
7732
7873
|
},
|
7733
7874
|
{
|
@@ -7736,7 +7877,7 @@
|
|
7736
7877
|
"type": {
|
7737
7878
|
"text": "boolean"
|
7738
7879
|
},
|
7739
|
-
"default": "
|
7880
|
+
"default": "false",
|
7740
7881
|
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
7741
7882
|
"attribute": "disabled",
|
7742
7883
|
"reflects": true,
|
@@ -7872,262 +8013,206 @@
|
|
7872
8013
|
}
|
7873
8014
|
}
|
7874
8015
|
],
|
8016
|
+
"events": [
|
8017
|
+
{
|
8018
|
+
"type": {
|
8019
|
+
"text": "EventConstructor"
|
8020
|
+
}
|
8021
|
+
},
|
8022
|
+
{
|
8023
|
+
"description": "(React: onChange) Event that gets dispatched when the radio state changes.",
|
8024
|
+
"name": "change",
|
8025
|
+
"reactName": "onChange",
|
8026
|
+
"eventName": "ChangeEvent"
|
8027
|
+
},
|
8028
|
+
{
|
8029
|
+
"description": "(React: onFocus) Event that gets dispatched when the radio receives focus.",
|
8030
|
+
"name": "focus",
|
8031
|
+
"reactName": "onFocus",
|
8032
|
+
"eventName": "FocusEvent"
|
8033
|
+
}
|
8034
|
+
],
|
7875
8035
|
"attributes": [
|
7876
8036
|
{
|
7877
|
-
"name": "
|
8037
|
+
"name": "checked",
|
7878
8038
|
"type": {
|
7879
|
-
"text": "
|
8039
|
+
"text": "boolean"
|
7880
8040
|
},
|
7881
|
-
"default": "
|
7882
|
-
"description": "
|
7883
|
-
"fieldName": "
|
8041
|
+
"default": "false",
|
8042
|
+
"description": "Determines whether the radio is selected or unselected.",
|
8043
|
+
"fieldName": "checked"
|
7884
8044
|
},
|
7885
8045
|
{
|
7886
|
-
"name": "
|
8046
|
+
"name": "readonly",
|
7887
8047
|
"type": {
|
7888
|
-
"text": "
|
8048
|
+
"text": "boolean"
|
7889
8049
|
},
|
7890
|
-
"default": "
|
7891
|
-
"description": "
|
7892
|
-
"fieldName": "
|
7893
|
-
"inheritedFrom": {
|
7894
|
-
"name": "DataAriaLabelMixin",
|
7895
|
-
"module": "src/utils/mixins/DataAriaLabelMixin.ts"
|
7896
|
-
}
|
8050
|
+
"default": "false",
|
8051
|
+
"description": "Determines whether the radio is read-only.",
|
8052
|
+
"fieldName": "readonly"
|
7897
8053
|
},
|
7898
8054
|
{
|
7899
|
-
"name": "
|
8055
|
+
"name": "autofocus",
|
7900
8056
|
"type": {
|
7901
8057
|
"text": "boolean"
|
7902
8058
|
},
|
7903
8059
|
"default": "false",
|
7904
|
-
"description": "
|
7905
|
-
"fieldName": "
|
8060
|
+
"description": "Automatically focus on the element when the page loads.\n[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/autofocus)",
|
8061
|
+
"fieldName": "autofocus"
|
8062
|
+
},
|
8063
|
+
{
|
8064
|
+
"name": "name",
|
8065
|
+
"type": {
|
8066
|
+
"text": "string"
|
8067
|
+
},
|
8068
|
+
"default": "''",
|
8069
|
+
"description": "Indicates the name of the component group.\nThey are used to group elements in a form together.",
|
8070
|
+
"fieldName": "name",
|
7906
8071
|
"inheritedFrom": {
|
7907
|
-
"name": "
|
7908
|
-
"module": "src/
|
8072
|
+
"name": "FormInternalsMixin",
|
8073
|
+
"module": "src/utils/mixins/FormInternalsMixin.ts"
|
7909
8074
|
}
|
7910
8075
|
},
|
7911
8076
|
{
|
7912
|
-
"name": "
|
8077
|
+
"name": "value",
|
7913
8078
|
"type": {
|
7914
|
-
"text": "string
|
8079
|
+
"text": "string"
|
7915
8080
|
},
|
7916
|
-
"
|
7917
|
-
"
|
8081
|
+
"default": "''",
|
8082
|
+
"description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
|
8083
|
+
"fieldName": "value",
|
7918
8084
|
"inheritedFrom": {
|
7919
|
-
"name": "
|
7920
|
-
"module": "src/
|
8085
|
+
"name": "FormInternalsMixin",
|
8086
|
+
"module": "src/utils/mixins/FormInternalsMixin.ts"
|
7921
8087
|
}
|
7922
8088
|
},
|
7923
8089
|
{
|
7924
|
-
"name": "
|
8090
|
+
"name": "validation-message",
|
7925
8091
|
"type": {
|
7926
8092
|
"text": "string | undefined"
|
7927
8093
|
},
|
7928
|
-
"description": "
|
7929
|
-
"fieldName": "
|
8094
|
+
"description": "Custom validation message that will override the default message and displayed when the input is invalid.",
|
8095
|
+
"fieldName": "validationMessage",
|
7930
8096
|
"inheritedFrom": {
|
7931
|
-
"name": "
|
7932
|
-
"module": "src/
|
8097
|
+
"name": "FormInternalsMixin",
|
8098
|
+
"module": "src/utils/mixins/FormInternalsMixin.ts"
|
7933
8099
|
}
|
7934
8100
|
},
|
7935
8101
|
{
|
7936
|
-
"name": "
|
8102
|
+
"name": "data-aria-label",
|
7937
8103
|
"type": {
|
7938
|
-
"text": "string"
|
8104
|
+
"text": "string | null"
|
7939
8105
|
},
|
7940
|
-
"default": "
|
7941
|
-
"description": "
|
7942
|
-
"fieldName": "
|
8106
|
+
"default": "null",
|
8107
|
+
"description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
|
8108
|
+
"fieldName": "dataAriaLabel",
|
7943
8109
|
"inheritedFrom": {
|
7944
|
-
"name": "
|
7945
|
-
"module": "src/
|
8110
|
+
"name": "DataAriaLabelMixin",
|
8111
|
+
"module": "src/utils/mixins/DataAriaLabelMixin.ts"
|
7946
8112
|
}
|
7947
8113
|
},
|
7948
8114
|
{
|
7949
|
-
"name": "
|
8115
|
+
"name": "disabled",
|
7950
8116
|
"type": {
|
7951
|
-
"text": "
|
8117
|
+
"text": "boolean"
|
7952
8118
|
},
|
7953
|
-
"
|
7954
|
-
"
|
8119
|
+
"default": "false",
|
8120
|
+
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
8121
|
+
"fieldName": "disabled",
|
7955
8122
|
"inheritedFrom": {
|
7956
8123
|
"name": "FormfieldWrapper",
|
7957
8124
|
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
7958
8125
|
}
|
7959
8126
|
},
|
7960
8127
|
{
|
7961
|
-
"name": "
|
8128
|
+
"name": "label",
|
7962
8129
|
"type": {
|
7963
8130
|
"text": "string | undefined"
|
7964
8131
|
},
|
7965
|
-
"description": "The
|
7966
|
-
"fieldName": "
|
8132
|
+
"description": "The label of the input field. It is linked to the input field using the `for` attribute.",
|
8133
|
+
"fieldName": "label",
|
7967
8134
|
"inheritedFrom": {
|
7968
8135
|
"name": "FormfieldWrapper",
|
7969
8136
|
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
7970
8137
|
}
|
7971
|
-
}
|
7972
|
-
],
|
7973
|
-
"superclass": {
|
7974
|
-
"name": "FormfieldGroup",
|
7975
|
-
"module": "/src/components/formfieldgroup"
|
7976
|
-
},
|
7977
|
-
"tagName": "mdc-radiogroup",
|
7978
|
-
"jsDoc": "/**\n * `mdc-radiogroup` - This is the wrapper component for radio buttons which are grouped together.\n * It can have a header text and a description. It enables users to select a single option from a set of options.\n * It is often used in forms, settings, and selection in lists. It automatically group the radio buttons inside it.\n *\n * @tagname mdc-radiogroup\n *\n * @cssproperty --mdc-radiogroup-description-text-normal - color of the description text\n *\n */",
|
7979
|
-
"customElement": true,
|
7980
|
-
"slots": [
|
7981
|
-
{
|
7982
|
-
"description": "This is a default slot for checkbox or toggle components.",
|
7983
|
-
"name": "default",
|
7984
|
-
"inheritedFrom": {
|
7985
|
-
"name": "FormfieldGroup",
|
7986
|
-
"module": "src/components/formfieldgroup/formfieldgroup.component.ts"
|
7987
|
-
}
|
7988
8138
|
},
|
7989
8139
|
{
|
7990
|
-
"
|
7991
|
-
"
|
8140
|
+
"name": "required-label",
|
8141
|
+
"type": {
|
8142
|
+
"text": "string | undefined"
|
8143
|
+
},
|
8144
|
+
"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.",
|
8145
|
+
"fieldName": "requiredLabel",
|
7992
8146
|
"inheritedFrom": {
|
7993
8147
|
"name": "FormfieldWrapper",
|
7994
8148
|
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
7995
8149
|
}
|
7996
|
-
}
|
7997
|
-
]
|
7998
|
-
}
|
7999
|
-
],
|
8000
|
-
"exports": [
|
8001
|
-
{
|
8002
|
-
"kind": "js",
|
8003
|
-
"name": "default",
|
8004
|
-
"declaration": {
|
8005
|
-
"name": "RadioGroup",
|
8006
|
-
"module": "components/radiogroup/radiogroup.component.js"
|
8007
|
-
}
|
8008
|
-
}
|
8009
|
-
]
|
8010
|
-
},
|
8011
|
-
{
|
8012
|
-
"kind": "javascript-module",
|
8013
|
-
"path": "components/spinner/spinner.component.js",
|
8014
|
-
"declarations": [
|
8015
|
-
{
|
8016
|
-
"kind": "class",
|
8017
|
-
"description": "`mdc-spinner` is loading spinner which is an indeterminate progress indicator, meaning\nit's best for cases where the progress or duration of a process is variable or unknown.\n\nSpinner Variants:\n- **Standalone (Default)**: Track has a blue color.\n- **Button**: To be used when placed in a button to show that the button’s action is currently in progress.\nTo ensure a minimum 3:1 contrast ratio, the color is changed internally to be the same color as the button’s\nicon or label text.\n\nSpinner Sizes:\n- **Large (96px)**: Use when replacing entire regions or pages that are still loading\n- **MidSize (48px) (Default)**: Use for most use cases.\n- **Small (24px)**: Use for inline with loading text.\n\nCustomisation of the spinner size is allowed by setting the size to undefined and using the --mdc-spinner-size\nCSS property.\n\nSpinner Colors:\n- **Default**: Use for most use cases.\n- **Inverted**: Only to be used within inverted components, such as coachmarks.\n\nRegarding accessibility, if an aria-label is provided, the role will be set to 'img'; if it is absent, the role\nwill be unset\nand aria-hidden will be set to 'true' so the spinner will be ignored by screen readers.",
|
8018
|
-
"name": "Spinner",
|
8019
|
-
"cssProperties": [
|
8020
|
-
{
|
8021
|
-
"description": "Allows customization of the default spinner color.",
|
8022
|
-
"name": "--mdc-spinner-default-color"
|
8023
|
-
},
|
8024
|
-
{
|
8025
|
-
"description": "Allows customization of the inverted spinner color.",
|
8026
|
-
"name": "--mdc-spinner-inverted-color"
|
8027
|
-
},
|
8028
|
-
{
|
8029
|
-
"description": "Allows customization of the spinner Button variant color.",
|
8030
|
-
"name": "--mdc-spinner-button-variant-color"
|
8031
|
-
},
|
8032
|
-
{
|
8033
|
-
"description": "Allows customization of the spinner size.",
|
8034
|
-
"name": "--mdc-spinner-size"
|
8035
|
-
}
|
8036
|
-
],
|
8037
|
-
"cssParts": [
|
8038
|
-
{
|
8039
|
-
"description": "The svg which contains the circle spinner.",
|
8040
|
-
"name": "container"
|
8041
|
-
},
|
8042
|
-
{
|
8043
|
-
"description": "The circle of the spinner.",
|
8044
|
-
"name": "circle"
|
8045
|
-
}
|
8046
|
-
],
|
8047
|
-
"members": [
|
8048
|
-
{
|
8049
|
-
"kind": "field",
|
8050
|
-
"name": "inverted",
|
8051
|
-
"description": "The spinner color can be inverted by setting the inverted attribute to true.",
|
8052
|
-
"default": "false",
|
8053
|
-
"attribute": "inverted",
|
8054
|
-
"reflects": true
|
8055
|
-
},
|
8056
|
-
{
|
8057
|
-
"kind": "field",
|
8058
|
-
"name": "size",
|
8059
|
-
"type": {
|
8060
|
-
"text": "SpinnerSize | undefined"
|
8061
|
-
},
|
8062
|
-
"description": "Size of the spinner.\nAcceptable values include:\n\n- 'small'\n- 'midsize'\n- 'large'\n- 'undefined'",
|
8063
|
-
"default": "midsize",
|
8064
|
-
"attribute": "size",
|
8065
|
-
"reflects": true
|
8066
|
-
},
|
8067
|
-
{
|
8068
|
-
"kind": "field",
|
8069
|
-
"name": "ariaLabel",
|
8070
|
-
"type": {
|
8071
|
-
"text": "string | null"
|
8072
|
-
},
|
8073
|
-
"default": "null",
|
8074
|
-
"description": "Aria-label attribute to be set for accessibility",
|
8075
|
-
"attribute": "aria-label"
|
8076
8150
|
},
|
8077
8151
|
{
|
8078
|
-
"
|
8079
|
-
"name": "variant",
|
8152
|
+
"name": "id",
|
8080
8153
|
"type": {
|
8081
|
-
"text": "
|
8154
|
+
"text": "string"
|
8082
8155
|
},
|
8083
|
-
"
|
8084
|
-
"
|
8085
|
-
"
|
8086
|
-
"
|
8087
|
-
|
8088
|
-
|
8089
|
-
|
8090
|
-
{
|
8091
|
-
"name": "inverted",
|
8092
|
-
"description": "The spinner color can be inverted by setting the inverted attribute to true.",
|
8093
|
-
"default": "false",
|
8094
|
-
"fieldName": "inverted"
|
8156
|
+
"default": "''",
|
8157
|
+
"description": "The unique id of the input field. It is used to link the input field with the label.",
|
8158
|
+
"fieldName": "id",
|
8159
|
+
"inheritedFrom": {
|
8160
|
+
"name": "FormfieldWrapper",
|
8161
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
8162
|
+
}
|
8095
8163
|
},
|
8096
8164
|
{
|
8097
|
-
"name": "
|
8165
|
+
"name": "help-text-type",
|
8098
8166
|
"type": {
|
8099
|
-
"text": "
|
8167
|
+
"text": "ValidationType"
|
8100
8168
|
},
|
8101
|
-
"description": "
|
8102
|
-
"
|
8103
|
-
"
|
8169
|
+
"description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
|
8170
|
+
"fieldName": "helpTextType",
|
8171
|
+
"inheritedFrom": {
|
8172
|
+
"name": "FormfieldWrapper",
|
8173
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
8174
|
+
}
|
8104
8175
|
},
|
8105
8176
|
{
|
8106
|
-
"name": "
|
8177
|
+
"name": "help-text",
|
8107
8178
|
"type": {
|
8108
|
-
"text": "string |
|
8179
|
+
"text": "string | undefined"
|
8109
8180
|
},
|
8110
|
-
"
|
8111
|
-
"
|
8112
|
-
"
|
8181
|
+
"description": "The help text that is displayed below the input field.",
|
8182
|
+
"fieldName": "helpText",
|
8183
|
+
"inheritedFrom": {
|
8184
|
+
"name": "FormfieldWrapper",
|
8185
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
8186
|
+
}
|
8187
|
+
}
|
8188
|
+
],
|
8189
|
+
"mixins": [
|
8190
|
+
{
|
8191
|
+
"name": "FormInternalsMixin",
|
8192
|
+
"module": "/src/utils/mixins/FormInternalsMixin"
|
8113
8193
|
},
|
8114
8194
|
{
|
8115
|
-
"name": "
|
8116
|
-
"
|
8117
|
-
"text": "SpinnerVariant"
|
8118
|
-
},
|
8119
|
-
"description": "There are 2 variants of spinner: default and button. Their coloring is different.\n- **Standalone (Default)**: Track has a blue color.\n- **Button**: To be used when placed in a button to show that the button’s action is currently in progress.\nTo ensure a minimum 3:1 contrast ratio, change the active indicator color to be the same color as the button’s\nicon or label text.",
|
8120
|
-
"default": "standalone",
|
8121
|
-
"fieldName": "variant"
|
8195
|
+
"name": "DataAriaLabelMixin",
|
8196
|
+
"module": "/src/utils/mixins/DataAriaLabelMixin"
|
8122
8197
|
}
|
8123
8198
|
],
|
8124
8199
|
"superclass": {
|
8125
|
-
"name": "
|
8126
|
-
"module": "/src/
|
8200
|
+
"name": "FormfieldWrapper",
|
8201
|
+
"module": "/src/components/formfieldwrapper/formfieldwrapper.component"
|
8127
8202
|
},
|
8128
|
-
"tagName": "mdc-
|
8129
|
-
"jsDoc": "/**\n *
|
8130
|
-
"customElement": true
|
8203
|
+
"tagName": "mdc-radio",
|
8204
|
+
"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 */",
|
8205
|
+
"customElement": true,
|
8206
|
+
"slots": [
|
8207
|
+
{
|
8208
|
+
"description": "slot to add the label info icon",
|
8209
|
+
"name": "label-info",
|
8210
|
+
"inheritedFrom": {
|
8211
|
+
"name": "FormfieldWrapper",
|
8212
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
8213
|
+
}
|
8214
|
+
}
|
8215
|
+
]
|
8131
8216
|
}
|
8132
8217
|
],
|
8133
8218
|
"exports": [
|
@@ -8135,182 +8220,79 @@
|
|
8135
8220
|
"kind": "js",
|
8136
8221
|
"name": "default",
|
8137
8222
|
"declaration": {
|
8138
|
-
"name": "
|
8139
|
-
"module": "components/
|
8223
|
+
"name": "Radio",
|
8224
|
+
"module": "components/radio/radio.component.js"
|
8140
8225
|
}
|
8141
8226
|
}
|
8142
8227
|
]
|
8143
8228
|
},
|
8144
8229
|
{
|
8145
8230
|
"kind": "javascript-module",
|
8146
|
-
"path": "components/
|
8231
|
+
"path": "components/radiogroup/radiogroup.component.js",
|
8147
8232
|
"declarations": [
|
8148
8233
|
{
|
8149
8234
|
"kind": "class",
|
8150
|
-
"description": "`mdc-
|
8151
|
-
"name": "
|
8152
|
-
"
|
8235
|
+
"description": "`mdc-radiogroup` - This is the wrapper component for radio buttons which are grouped together.\nIt can have a header text and a description. It enables users to select a single option from a set of options.\nIt is often used in forms, settings, and selection in lists. It automatically group the radio buttons inside it.",
|
8236
|
+
"name": "RadioGroup",
|
8237
|
+
"cssProperties": [
|
8153
8238
|
{
|
8154
|
-
"description": "
|
8155
|
-
"name": ""
|
8239
|
+
"description": "color of the description text",
|
8240
|
+
"name": "--mdc-radiogroup-description-text-normal"
|
8156
8241
|
}
|
8157
8242
|
],
|
8158
8243
|
"members": [
|
8159
8244
|
{
|
8160
8245
|
"kind": "field",
|
8161
|
-
"name": "
|
8162
|
-
"type": {
|
8163
|
-
"text": "string | undefined"
|
8164
|
-
},
|
8165
|
-
"description": "The name of the icon to display as a prefix.\nThe icon is displayed on the left side of the button.",
|
8166
|
-
"attribute": "prefix-icon",
|
8167
|
-
"reflects": true
|
8168
|
-
},
|
8169
|
-
{
|
8170
|
-
"kind": "field",
|
8171
|
-
"name": "postfixIcon",
|
8172
|
-
"type": {
|
8173
|
-
"text": "string | undefined"
|
8174
|
-
},
|
8175
|
-
"description": "The name of the icon to display as a postfix.\nThe icon is displayed on the right side of the button.",
|
8176
|
-
"attribute": "postfix-icon",
|
8177
|
-
"reflects": true
|
8178
|
-
},
|
8179
|
-
{
|
8180
|
-
"kind": "field",
|
8181
|
-
"name": "variant",
|
8246
|
+
"name": "name",
|
8182
8247
|
"type": {
|
8183
|
-
"text": "
|
8248
|
+
"text": "string"
|
8184
8249
|
},
|
8185
|
-
"
|
8186
|
-
"
|
8187
|
-
"attribute": "
|
8250
|
+
"default": "''",
|
8251
|
+
"description": "Name of the radio group.\nThey are used to group elements in a form together.",
|
8252
|
+
"attribute": "name"
|
8188
8253
|
},
|
8189
8254
|
{
|
8190
8255
|
"kind": "field",
|
8191
|
-
"name": "
|
8256
|
+
"name": "dataAriaLabel",
|
8192
8257
|
"type": {
|
8193
|
-
"text": "
|
8258
|
+
"text": "string | null"
|
8194
8259
|
},
|
8195
|
-
"
|
8196
|
-
"
|
8197
|
-
"attribute": "
|
8260
|
+
"default": "null",
|
8261
|
+
"description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
|
8262
|
+
"attribute": "data-aria-label",
|
8198
8263
|
"reflects": true,
|
8199
8264
|
"inheritedFrom": {
|
8200
|
-
"name": "
|
8201
|
-
"module": "
|
8265
|
+
"name": "DataAriaLabelMixin",
|
8266
|
+
"module": "utils/mixins/DataAriaLabelMixin.js"
|
8202
8267
|
}
|
8203
8268
|
},
|
8204
8269
|
{
|
8205
8270
|
"kind": "field",
|
8206
|
-
"name": "
|
8207
|
-
"type": {
|
8208
|
-
"text": "ButtonColor"
|
8209
|
-
},
|
8210
|
-
"description": "There are 5 colors for button: positive, negative, accent, promotional, default.",
|
8211
|
-
"default": "default",
|
8212
|
-
"attribute": "color"
|
8213
|
-
},
|
8214
|
-
{
|
8215
|
-
"kind": "field",
|
8216
|
-
"name": "role",
|
8217
|
-
"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.",
|
8218
|
-
"default": "'button'",
|
8219
|
-
"attribute": "role",
|
8220
|
-
"reflects": true,
|
8271
|
+
"name": "id",
|
8221
8272
|
"type": {
|
8222
8273
|
"text": "string"
|
8223
8274
|
},
|
8275
|
+
"default": "''",
|
8276
|
+
"description": "The unique id of the input field. It is used to link the input field with the label.",
|
8277
|
+
"attribute": "id",
|
8224
8278
|
"inheritedFrom": {
|
8225
|
-
"name": "
|
8226
|
-
"module": "components/
|
8279
|
+
"name": "FormfieldWrapper",
|
8280
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
8227
8281
|
}
|
8228
8282
|
},
|
8229
|
-
{
|
8230
|
-
"kind": "method",
|
8231
|
-
"name": "modifyIconName",
|
8232
|
-
"privacy": "private",
|
8233
|
-
"parameters": [
|
8234
|
-
{
|
8235
|
-
"name": "active",
|
8236
|
-
"type": {
|
8237
|
-
"text": "boolean"
|
8238
|
-
},
|
8239
|
-
"description": "The active state."
|
8240
|
-
}
|
8241
|
-
],
|
8242
|
-
"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."
|
8243
|
-
},
|
8244
|
-
{
|
8245
|
-
"kind": "method",
|
8246
|
-
"name": "setVariant",
|
8247
|
-
"privacy": "private",
|
8248
|
-
"parameters": [
|
8249
|
-
{
|
8250
|
-
"name": "variant",
|
8251
|
-
"type": {
|
8252
|
-
"text": "ButtonVariant"
|
8253
|
-
},
|
8254
|
-
"description": "The variant to set."
|
8255
|
-
}
|
8256
|
-
],
|
8257
|
-
"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."
|
8258
|
-
},
|
8259
|
-
{
|
8260
|
-
"kind": "method",
|
8261
|
-
"name": "setSize",
|
8262
|
-
"privacy": "private",
|
8263
|
-
"parameters": [
|
8264
|
-
{
|
8265
|
-
"name": "size",
|
8266
|
-
"type": {
|
8267
|
-
"text": "PillButtonSize | IconButtonSize"
|
8268
|
-
},
|
8269
|
-
"description": "The size to set."
|
8270
|
-
}
|
8271
|
-
],
|
8272
|
-
"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."
|
8273
|
-
},
|
8274
|
-
{
|
8275
|
-
"kind": "method",
|
8276
|
-
"name": "setColor",
|
8277
|
-
"privacy": "private",
|
8278
|
-
"parameters": [
|
8279
|
-
{
|
8280
|
-
"name": "color",
|
8281
|
-
"type": {
|
8282
|
-
"text": "ButtonColor"
|
8283
|
-
},
|
8284
|
-
"description": "The color to set."
|
8285
|
-
}
|
8286
|
-
],
|
8287
|
-
"description": "Sets the color attribute for the button.\nDefaults to DEFAULTS.COLOR if invalid or for tertiary buttons."
|
8288
|
-
},
|
8289
|
-
{
|
8290
|
-
"kind": "method",
|
8291
|
-
"name": "inferButtonType",
|
8292
|
-
"privacy": "private",
|
8293
|
-
"description": "Infers the type of button based on the presence of slot and/or prefix and postfix icons.",
|
8294
|
-
"parameters": [
|
8295
|
-
{
|
8296
|
-
"description": "default slot of button",
|
8297
|
-
"name": "slot"
|
8298
|
-
}
|
8299
|
-
]
|
8300
|
-
},
|
8301
8283
|
{
|
8302
8284
|
"kind": "field",
|
8303
|
-
"name": "
|
8285
|
+
"name": "helpTextType",
|
8304
8286
|
"type": {
|
8305
|
-
"text": "
|
8287
|
+
"text": "ValidationType"
|
8306
8288
|
},
|
8307
|
-
"
|
8308
|
-
"
|
8309
|
-
"attribute": "tabIndex",
|
8289
|
+
"description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
|
8290
|
+
"attribute": "help-text-type",
|
8310
8291
|
"reflects": true,
|
8292
|
+
"default": "undefined as unknown",
|
8311
8293
|
"inheritedFrom": {
|
8312
|
-
"name": "
|
8313
|
-
"module": "components/
|
8294
|
+
"name": "FormfieldWrapper",
|
8295
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
8314
8296
|
}
|
8315
8297
|
},
|
8316
8298
|
{
|
@@ -8319,379 +8301,397 @@
|
|
8319
8301
|
"type": {
|
8320
8302
|
"text": "boolean"
|
8321
8303
|
},
|
8322
|
-
"default": "
|
8304
|
+
"default": "undefined as unknown",
|
8323
8305
|
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
8324
8306
|
"attribute": "disabled",
|
8325
8307
|
"reflects": true,
|
8326
8308
|
"inheritedFrom": {
|
8327
|
-
"name": "
|
8328
|
-
"module": "components/
|
8309
|
+
"name": "FormfieldWrapper",
|
8310
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
8329
8311
|
}
|
8330
8312
|
},
|
8331
8313
|
{
|
8332
8314
|
"kind": "field",
|
8333
|
-
"name": "
|
8315
|
+
"name": "label",
|
8334
8316
|
"type": {
|
8335
|
-
"text": "
|
8317
|
+
"text": "string | undefined"
|
8336
8318
|
},
|
8337
|
-
"
|
8338
|
-
"
|
8339
|
-
"attribute": "active",
|
8319
|
+
"description": "The label of the input field. It is linked to the input field using the `for` attribute.",
|
8320
|
+
"attribute": "label",
|
8340
8321
|
"reflects": true,
|
8341
8322
|
"inheritedFrom": {
|
8342
|
-
"name": "
|
8343
|
-
"module": "components/
|
8323
|
+
"name": "FormfieldWrapper",
|
8324
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
8344
8325
|
}
|
8345
8326
|
},
|
8346
8327
|
{
|
8347
8328
|
"kind": "field",
|
8348
|
-
"name": "
|
8329
|
+
"name": "requiredLabel",
|
8349
8330
|
"type": {
|
8350
|
-
"text": "
|
8331
|
+
"text": "string | undefined"
|
8351
8332
|
},
|
8352
|
-
"
|
8353
|
-
"
|
8354
|
-
"
|
8333
|
+
"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.",
|
8334
|
+
"attribute": "required-label",
|
8335
|
+
"reflects": true,
|
8355
8336
|
"inheritedFrom": {
|
8356
|
-
"name": "
|
8357
|
-
"module": "components/
|
8337
|
+
"name": "FormfieldWrapper",
|
8338
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
8358
8339
|
}
|
8359
8340
|
},
|
8360
8341
|
{
|
8361
8342
|
"kind": "field",
|
8362
|
-
"name": "
|
8343
|
+
"name": "helpText",
|
8363
8344
|
"type": {
|
8364
|
-
"text": "
|
8345
|
+
"text": "string | undefined"
|
8365
8346
|
},
|
8366
|
-
"description": "
|
8367
|
-
"
|
8368
|
-
"attribute": "type",
|
8347
|
+
"description": "The help text that is displayed below the input field.",
|
8348
|
+
"attribute": "help-text",
|
8369
8349
|
"reflects": true,
|
8370
8350
|
"inheritedFrom": {
|
8371
|
-
"name": "
|
8372
|
-
"module": "components/
|
8351
|
+
"name": "FormfieldWrapper",
|
8352
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
8373
8353
|
}
|
8374
8354
|
},
|
8375
8355
|
{
|
8376
8356
|
"kind": "method",
|
8377
|
-
"name": "
|
8357
|
+
"name": "renderLabelElement",
|
8378
8358
|
"privacy": "protected",
|
8359
|
+
"description": "creates the label element when the label property is set.\nid is used to link the label with the input field.",
|
8360
|
+
"return": {
|
8361
|
+
"type": {
|
8362
|
+
"text": ""
|
8363
|
+
}
|
8364
|
+
},
|
8379
8365
|
"inheritedFrom": {
|
8380
|
-
"name": "
|
8381
|
-
"module": "components/
|
8366
|
+
"name": "FormfieldWrapper",
|
8367
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
8382
8368
|
}
|
8383
8369
|
},
|
8384
8370
|
{
|
8385
8371
|
"kind": "method",
|
8386
|
-
"name": "
|
8372
|
+
"name": "renderRequiredLabel",
|
8387
8373
|
"privacy": "protected",
|
8388
|
-
"parameters": [
|
8389
|
-
{
|
8390
|
-
"name": "element",
|
8391
|
-
"type": {
|
8392
|
-
"text": "HTMLElement"
|
8393
|
-
},
|
8394
|
-
"description": "The button element"
|
8395
|
-
},
|
8396
|
-
{
|
8397
|
-
"name": "active",
|
8398
|
-
"type": {
|
8399
|
-
"text": "boolean"
|
8400
|
-
},
|
8401
|
-
"description": "The active state of the element"
|
8402
|
-
}
|
8403
|
-
],
|
8404
|
-
"description": "Sets the aria-pressed attribute based on the active state of the button.",
|
8405
8374
|
"inheritedFrom": {
|
8406
|
-
"name": "
|
8407
|
-
"module": "components/
|
8375
|
+
"name": "FormfieldWrapper",
|
8376
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
8408
8377
|
}
|
8409
8378
|
},
|
8410
8379
|
{
|
8411
8380
|
"kind": "method",
|
8412
|
-
"name": "
|
8413
|
-
"privacy": "
|
8414
|
-
"
|
8415
|
-
|
8416
|
-
|
8417
|
-
"
|
8418
|
-
"text": "HTMLElement"
|
8419
|
-
},
|
8420
|
-
"description": "The button element."
|
8421
|
-
},
|
8422
|
-
{
|
8423
|
-
"name": "softDisabled",
|
8424
|
-
"type": {
|
8425
|
-
"text": "boolean"
|
8426
|
-
},
|
8427
|
-
"description": "The soft-disabled state."
|
8381
|
+
"name": "renderHelpTextIcon",
|
8382
|
+
"privacy": "protected",
|
8383
|
+
"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.",
|
8384
|
+
"return": {
|
8385
|
+
"type": {
|
8386
|
+
"text": ""
|
8428
8387
|
}
|
8429
|
-
|
8430
|
-
"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.",
|
8388
|
+
},
|
8431
8389
|
"inheritedFrom": {
|
8432
|
-
"name": "
|
8433
|
-
"module": "components/
|
8390
|
+
"name": "FormfieldWrapper",
|
8391
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
8434
8392
|
}
|
8435
8393
|
},
|
8436
8394
|
{
|
8437
8395
|
"kind": "method",
|
8438
|
-
"name": "
|
8439
|
-
"privacy": "
|
8440
|
-
"
|
8441
|
-
|
8442
|
-
|
8443
|
-
"
|
8444
|
-
"text": "HTMLElement"
|
8445
|
-
},
|
8446
|
-
"description": "The button element."
|
8447
|
-
},
|
8448
|
-
{
|
8449
|
-
"name": "disabled",
|
8450
|
-
"type": {
|
8451
|
-
"text": "boolean"
|
8452
|
-
},
|
8453
|
-
"description": "The disabled state."
|
8396
|
+
"name": "renderHelpText",
|
8397
|
+
"privacy": "protected",
|
8398
|
+
"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.",
|
8399
|
+
"return": {
|
8400
|
+
"type": {
|
8401
|
+
"text": ""
|
8454
8402
|
}
|
8455
|
-
|
8456
|
-
"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.",
|
8457
|
-
"inheritedFrom": {
|
8458
|
-
"name": "Buttonsimple",
|
8459
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
8460
|
-
}
|
8461
|
-
},
|
8462
|
-
{
|
8463
|
-
"kind": "method",
|
8464
|
-
"name": "triggerClickEvent",
|
8465
|
-
"privacy": "private",
|
8466
|
-
"inheritedFrom": {
|
8467
|
-
"name": "Buttonsimple",
|
8468
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
8469
|
-
}
|
8470
|
-
},
|
8471
|
-
{
|
8472
|
-
"kind": "method",
|
8473
|
-
"name": "handleBlur",
|
8474
|
-
"privacy": "private",
|
8475
|
-
"description": "In case the button is pressed and the focus is lost while pressing,\nthe pressed class is removed.",
|
8403
|
+
},
|
8476
8404
|
"inheritedFrom": {
|
8477
|
-
"name": "
|
8478
|
-
"module": "components/
|
8405
|
+
"name": "FormfieldWrapper",
|
8406
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
8479
8407
|
}
|
8480
8408
|
},
|
8481
8409
|
{
|
8482
8410
|
"kind": "method",
|
8483
|
-
"name": "
|
8484
|
-
"privacy": "
|
8485
|
-
"
|
8486
|
-
|
8487
|
-
|
8488
|
-
"
|
8489
|
-
"text": "KeyboardEvent"
|
8490
|
-
},
|
8491
|
-
"description": "The keyboard event."
|
8411
|
+
"name": "renderLabel",
|
8412
|
+
"privacy": "protected",
|
8413
|
+
"description": "renders the mdc-label-text container that contains the label and labelInfoToggleTip.",
|
8414
|
+
"return": {
|
8415
|
+
"type": {
|
8416
|
+
"text": ""
|
8492
8417
|
}
|
8493
|
-
|
8494
|
-
"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.",
|
8418
|
+
},
|
8495
8419
|
"inheritedFrom": {
|
8496
|
-
"name": "
|
8497
|
-
"module": "components/
|
8420
|
+
"name": "FormfieldWrapper",
|
8421
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
8498
8422
|
}
|
8499
8423
|
},
|
8500
8424
|
{
|
8501
8425
|
"kind": "method",
|
8502
|
-
"name": "
|
8503
|
-
"privacy": "
|
8504
|
-
"
|
8505
|
-
|
8506
|
-
|
8507
|
-
"
|
8508
|
-
"text": "KeyboardEvent"
|
8509
|
-
},
|
8510
|
-
"description": "The keyboard event."
|
8426
|
+
"name": "renderHelperText",
|
8427
|
+
"privacy": "protected",
|
8428
|
+
"description": "renders the mdc-help-text container that contains the helpertext icon and helpertext.",
|
8429
|
+
"return": {
|
8430
|
+
"type": {
|
8431
|
+
"text": ""
|
8511
8432
|
}
|
8512
|
-
|
8513
|
-
"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.",
|
8433
|
+
},
|
8514
8434
|
"inheritedFrom": {
|
8515
|
-
"name": "
|
8516
|
-
"module": "components/
|
8435
|
+
"name": "FormfieldWrapper",
|
8436
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
8517
8437
|
}
|
8518
8438
|
}
|
8519
8439
|
],
|
8520
|
-
"
|
8521
|
-
{
|
8522
|
-
"description": "(React: onClick) This event is dispatched when the button is clicked.",
|
8523
|
-
"name": "click",
|
8524
|
-
"reactName": "onClick",
|
8525
|
-
"eventName": "ClickEvent",
|
8526
|
-
"inheritedFrom": {
|
8527
|
-
"name": "Buttonsimple",
|
8528
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
8529
|
-
}
|
8530
|
-
},
|
8440
|
+
"attributes": [
|
8531
8441
|
{
|
8532
|
-
"
|
8533
|
-
"
|
8534
|
-
|
8535
|
-
|
8536
|
-
"
|
8537
|
-
|
8538
|
-
|
8539
|
-
}
|
8442
|
+
"name": "name",
|
8443
|
+
"type": {
|
8444
|
+
"text": "string"
|
8445
|
+
},
|
8446
|
+
"default": "''",
|
8447
|
+
"description": "Name of the radio group.\nThey are used to group elements in a form together.",
|
8448
|
+
"fieldName": "name"
|
8540
8449
|
},
|
8541
8450
|
{
|
8542
|
-
"
|
8543
|
-
"
|
8544
|
-
|
8545
|
-
|
8451
|
+
"name": "data-aria-label",
|
8452
|
+
"type": {
|
8453
|
+
"text": "string | null"
|
8454
|
+
},
|
8455
|
+
"default": "null",
|
8456
|
+
"description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
|
8457
|
+
"fieldName": "dataAriaLabel",
|
8546
8458
|
"inheritedFrom": {
|
8547
|
-
"name": "
|
8548
|
-
"module": "src/
|
8459
|
+
"name": "DataAriaLabelMixin",
|
8460
|
+
"module": "src/utils/mixins/DataAriaLabelMixin.ts"
|
8549
8461
|
}
|
8550
8462
|
},
|
8551
8463
|
{
|
8552
|
-
"
|
8553
|
-
"
|
8554
|
-
|
8555
|
-
|
8464
|
+
"name": "disabled",
|
8465
|
+
"type": {
|
8466
|
+
"text": "boolean"
|
8467
|
+
},
|
8468
|
+
"default": "false",
|
8469
|
+
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
8470
|
+
"fieldName": "disabled",
|
8556
8471
|
"inheritedFrom": {
|
8557
|
-
"name": "
|
8558
|
-
"module": "src/components/
|
8472
|
+
"name": "FormfieldWrapper",
|
8473
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
8559
8474
|
}
|
8560
|
-
}
|
8561
|
-
],
|
8562
|
-
"attributes": [
|
8475
|
+
},
|
8563
8476
|
{
|
8564
|
-
"name": "
|
8477
|
+
"name": "label",
|
8565
8478
|
"type": {
|
8566
8479
|
"text": "string | undefined"
|
8567
8480
|
},
|
8568
|
-
"description": "The
|
8569
|
-
"fieldName": "
|
8481
|
+
"description": "The label of the input field. It is linked to the input field using the `for` attribute.",
|
8482
|
+
"fieldName": "label",
|
8483
|
+
"inheritedFrom": {
|
8484
|
+
"name": "FormfieldWrapper",
|
8485
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
8486
|
+
}
|
8570
8487
|
},
|
8571
8488
|
{
|
8572
|
-
"name": "
|
8489
|
+
"name": "required-label",
|
8573
8490
|
"type": {
|
8574
8491
|
"text": "string | undefined"
|
8575
8492
|
},
|
8576
|
-
"description": "The
|
8577
|
-
"fieldName": "
|
8493
|
+
"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.",
|
8494
|
+
"fieldName": "requiredLabel",
|
8495
|
+
"inheritedFrom": {
|
8496
|
+
"name": "FormfieldWrapper",
|
8497
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
8498
|
+
}
|
8578
8499
|
},
|
8579
8500
|
{
|
8580
|
-
"name": "
|
8501
|
+
"name": "id",
|
8581
8502
|
"type": {
|
8582
|
-
"text": "
|
8503
|
+
"text": "string"
|
8583
8504
|
},
|
8584
|
-
"
|
8585
|
-
"
|
8586
|
-
"fieldName": "
|
8505
|
+
"default": "''",
|
8506
|
+
"description": "The unique id of the input field. It is used to link the input field with the label.",
|
8507
|
+
"fieldName": "id",
|
8508
|
+
"inheritedFrom": {
|
8509
|
+
"name": "FormfieldWrapper",
|
8510
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
8511
|
+
}
|
8587
8512
|
},
|
8588
8513
|
{
|
8589
|
-
"name": "
|
8514
|
+
"name": "help-text-type",
|
8590
8515
|
"type": {
|
8591
|
-
"text": "
|
8516
|
+
"text": "ValidationType"
|
8592
8517
|
},
|
8593
|
-
"description": "
|
8594
|
-
"
|
8595
|
-
"fieldName": "size",
|
8518
|
+
"description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
|
8519
|
+
"fieldName": "helpTextType",
|
8596
8520
|
"inheritedFrom": {
|
8597
|
-
"name": "
|
8598
|
-
"module": "src/components/
|
8521
|
+
"name": "FormfieldWrapper",
|
8522
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
8599
8523
|
}
|
8600
8524
|
},
|
8601
8525
|
{
|
8602
|
-
"name": "
|
8526
|
+
"name": "help-text",
|
8603
8527
|
"type": {
|
8604
|
-
"text": "
|
8528
|
+
"text": "string | undefined"
|
8605
8529
|
},
|
8606
|
-
"description": "
|
8607
|
-
"
|
8608
|
-
"
|
8530
|
+
"description": "The help text that is displayed below the input field.",
|
8531
|
+
"fieldName": "helpText",
|
8532
|
+
"inheritedFrom": {
|
8533
|
+
"name": "FormfieldWrapper",
|
8534
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
8535
|
+
}
|
8536
|
+
}
|
8537
|
+
],
|
8538
|
+
"superclass": {
|
8539
|
+
"name": "FormfieldGroup",
|
8540
|
+
"module": "/src/components/formfieldgroup"
|
8541
|
+
},
|
8542
|
+
"tagName": "mdc-radiogroup",
|
8543
|
+
"jsDoc": "/**\n * `mdc-radiogroup` - This is the wrapper component for radio buttons which are grouped together.\n * It can have a header text and a description. It enables users to select a single option from a set of options.\n * It is often used in forms, settings, and selection in lists. It automatically group the radio buttons inside it.\n *\n * @tagname mdc-radiogroup\n *\n * @cssproperty --mdc-radiogroup-description-text-normal - color of the description text\n *\n */",
|
8544
|
+
"customElement": true,
|
8545
|
+
"slots": [
|
8546
|
+
{
|
8547
|
+
"description": "This is a default slot for checkbox or toggle components.",
|
8548
|
+
"name": "default",
|
8549
|
+
"inheritedFrom": {
|
8550
|
+
"name": "FormfieldGroup",
|
8551
|
+
"module": "src/components/formfieldgroup/formfieldgroup.component.ts"
|
8552
|
+
}
|
8609
8553
|
},
|
8610
8554
|
{
|
8611
|
-
"
|
8612
|
-
"
|
8613
|
-
"default": "'button'",
|
8614
|
-
"fieldName": "role",
|
8615
|
-
"type": {
|
8616
|
-
"text": "string"
|
8617
|
-
},
|
8555
|
+
"description": "slot to add the label info icon",
|
8556
|
+
"name": "label-info",
|
8618
8557
|
"inheritedFrom": {
|
8619
|
-
"name": "
|
8620
|
-
"module": "src/components/
|
8558
|
+
"name": "FormfieldWrapper",
|
8559
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
8621
8560
|
}
|
8561
|
+
}
|
8562
|
+
]
|
8563
|
+
}
|
8564
|
+
],
|
8565
|
+
"exports": [
|
8566
|
+
{
|
8567
|
+
"kind": "js",
|
8568
|
+
"name": "default",
|
8569
|
+
"declaration": {
|
8570
|
+
"name": "RadioGroup",
|
8571
|
+
"module": "components/radiogroup/radiogroup.component.js"
|
8572
|
+
}
|
8573
|
+
}
|
8574
|
+
]
|
8575
|
+
},
|
8576
|
+
{
|
8577
|
+
"kind": "javascript-module",
|
8578
|
+
"path": "components/spinner/spinner.component.js",
|
8579
|
+
"declarations": [
|
8580
|
+
{
|
8581
|
+
"kind": "class",
|
8582
|
+
"description": "`mdc-spinner` is loading spinner which is an indeterminate progress indicator, meaning\nit's best for cases where the progress or duration of a process is variable or unknown.\n\nSpinner Variants:\n- **Standalone (Default)**: Track has a blue color.\n- **Button**: To be used when placed in a button to show that the button’s action is currently in progress.\nTo ensure a minimum 3:1 contrast ratio, the color is changed internally to be the same color as the button’s\nicon or label text.\n\nSpinner Sizes:\n- **Large (96px)**: Use when replacing entire regions or pages that are still loading\n- **MidSize (48px) (Default)**: Use for most use cases.\n- **Small (24px)**: Use for inline with loading text.\n\nCustomisation of the spinner size is allowed by setting the size to undefined and using the --mdc-spinner-size\nCSS property.\n\nSpinner Colors:\n- **Default**: Use for most use cases.\n- **Inverted**: Only to be used within inverted components, such as coachmarks.\n\nRegarding accessibility, if an aria-label is provided, the role will be set to 'img'; if it is absent, the role\nwill be unset\nand aria-hidden will be set to 'true' so the spinner will be ignored by screen readers.",
|
8583
|
+
"name": "Spinner",
|
8584
|
+
"cssProperties": [
|
8585
|
+
{
|
8586
|
+
"description": "Allows customization of the default spinner color.",
|
8587
|
+
"name": "--mdc-spinner-default-color"
|
8622
8588
|
},
|
8623
8589
|
{
|
8624
|
-
"
|
8590
|
+
"description": "Allows customization of the inverted spinner color.",
|
8591
|
+
"name": "--mdc-spinner-inverted-color"
|
8592
|
+
},
|
8593
|
+
{
|
8594
|
+
"description": "Allows customization of the spinner Button variant color.",
|
8595
|
+
"name": "--mdc-spinner-button-variant-color"
|
8596
|
+
},
|
8597
|
+
{
|
8598
|
+
"description": "Allows customization of the spinner size.",
|
8599
|
+
"name": "--mdc-spinner-size"
|
8600
|
+
}
|
8601
|
+
],
|
8602
|
+
"cssParts": [
|
8603
|
+
{
|
8604
|
+
"description": "The svg which contains the circle spinner.",
|
8605
|
+
"name": "container"
|
8606
|
+
},
|
8607
|
+
{
|
8608
|
+
"description": "The circle of the spinner.",
|
8609
|
+
"name": "circle"
|
8610
|
+
}
|
8611
|
+
],
|
8612
|
+
"members": [
|
8613
|
+
{
|
8614
|
+
"kind": "field",
|
8615
|
+
"name": "inverted",
|
8616
|
+
"description": "The spinner color can be inverted by setting the inverted attribute to true.",
|
8617
|
+
"default": "false",
|
8618
|
+
"attribute": "inverted",
|
8619
|
+
"reflects": true
|
8620
|
+
},
|
8621
|
+
{
|
8622
|
+
"kind": "field",
|
8623
|
+
"name": "size",
|
8625
8624
|
"type": {
|
8626
|
-
"text": "
|
8625
|
+
"text": "SpinnerSize | undefined"
|
8627
8626
|
},
|
8628
|
-
"
|
8629
|
-
"
|
8630
|
-
"
|
8631
|
-
"
|
8632
|
-
"name": "Buttonsimple",
|
8633
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
8634
|
-
}
|
8627
|
+
"description": "Size of the spinner.\nAcceptable values include:\n\n- 'small'\n- 'midsize'\n- 'large'\n- 'undefined'",
|
8628
|
+
"default": "midsize",
|
8629
|
+
"attribute": "size",
|
8630
|
+
"reflects": true
|
8635
8631
|
},
|
8636
8632
|
{
|
8637
|
-
"
|
8633
|
+
"kind": "field",
|
8634
|
+
"name": "ariaLabel",
|
8638
8635
|
"type": {
|
8639
|
-
"text": "
|
8636
|
+
"text": "string | null"
|
8640
8637
|
},
|
8641
|
-
"default": "
|
8642
|
-
"description": "
|
8643
|
-
"
|
8644
|
-
"inheritedFrom": {
|
8645
|
-
"name": "Buttonsimple",
|
8646
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
8647
|
-
}
|
8638
|
+
"default": "null",
|
8639
|
+
"description": "Aria-label attribute to be set for accessibility",
|
8640
|
+
"attribute": "aria-label"
|
8648
8641
|
},
|
8649
8642
|
{
|
8650
|
-
"
|
8643
|
+
"kind": "field",
|
8644
|
+
"name": "variant",
|
8651
8645
|
"type": {
|
8652
|
-
"text": "
|
8646
|
+
"text": "SpinnerVariant"
|
8653
8647
|
},
|
8648
|
+
"description": "There are 2 variants of spinner: default and button. Their coloring is different.\n- **Standalone (Default)**: Track has a blue color.\n- **Button**: To be used when placed in a button to show that the button’s action is currently in progress.\nTo ensure a minimum 3:1 contrast ratio, change the active indicator color to be the same color as the button’s\nicon or label text.",
|
8649
|
+
"default": "standalone",
|
8650
|
+
"attribute": "variant",
|
8651
|
+
"reflects": true
|
8652
|
+
}
|
8653
|
+
],
|
8654
|
+
"attributes": [
|
8655
|
+
{
|
8656
|
+
"name": "inverted",
|
8657
|
+
"description": "The spinner color can be inverted by setting the inverted attribute to true.",
|
8654
8658
|
"default": "false",
|
8655
|
-
"
|
8656
|
-
"fieldName": "active",
|
8657
|
-
"inheritedFrom": {
|
8658
|
-
"name": "Buttonsimple",
|
8659
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
8660
|
-
}
|
8659
|
+
"fieldName": "inverted"
|
8661
8660
|
},
|
8662
8661
|
{
|
8663
|
-
"name": "
|
8662
|
+
"name": "size",
|
8664
8663
|
"type": {
|
8665
|
-
"text": "
|
8664
|
+
"text": "SpinnerSize | undefined"
|
8666
8665
|
},
|
8667
|
-
"
|
8668
|
-
"
|
8669
|
-
"fieldName": "
|
8670
|
-
"inheritedFrom": {
|
8671
|
-
"name": "Buttonsimple",
|
8672
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
8673
|
-
}
|
8666
|
+
"description": "Size of the spinner.\nAcceptable values include:\n\n- 'small'\n- 'midsize'\n- 'large'\n- 'undefined'",
|
8667
|
+
"default": "midsize",
|
8668
|
+
"fieldName": "size"
|
8674
8669
|
},
|
8675
8670
|
{
|
8676
|
-
"name": "
|
8671
|
+
"name": "aria-label",
|
8677
8672
|
"type": {
|
8678
|
-
"text": "
|
8673
|
+
"text": "string | null"
|
8679
8674
|
},
|
8680
|
-
"
|
8681
|
-
"
|
8682
|
-
"fieldName": "
|
8683
|
-
|
8684
|
-
|
8685
|
-
|
8686
|
-
|
8675
|
+
"default": "null",
|
8676
|
+
"description": "Aria-label attribute to be set for accessibility",
|
8677
|
+
"fieldName": "ariaLabel"
|
8678
|
+
},
|
8679
|
+
{
|
8680
|
+
"name": "variant",
|
8681
|
+
"type": {
|
8682
|
+
"text": "SpinnerVariant"
|
8683
|
+
},
|
8684
|
+
"description": "There are 2 variants of spinner: default and button. Their coloring is different.\n- **Standalone (Default)**: Track has a blue color.\n- **Button**: To be used when placed in a button to show that the button’s action is currently in progress.\nTo ensure a minimum 3:1 contrast ratio, change the active indicator color to be the same color as the button’s\nicon or label text.",
|
8685
|
+
"default": "standalone",
|
8686
|
+
"fieldName": "variant"
|
8687
8687
|
}
|
8688
8688
|
],
|
8689
8689
|
"superclass": {
|
8690
|
-
"name": "
|
8691
|
-
"module": "/src/
|
8690
|
+
"name": "Component",
|
8691
|
+
"module": "/src/models"
|
8692
8692
|
},
|
8693
|
-
"tagName": "mdc-
|
8694
|
-
"jsDoc": "/**\n * `mdc-
|
8693
|
+
"tagName": "mdc-spinner",
|
8694
|
+
"jsDoc": "/**\n * `mdc-spinner` is loading spinner which is an indeterminate progress indicator, meaning\n * it's best for cases where the progress or duration of a process is variable or unknown.\n *\n * Spinner Variants:\n * - **Standalone (Default)**: Track has a blue color.\n * - **Button**: To be used when placed in a button to show that the button’s action is currently in progress.\n * To ensure a minimum 3:1 contrast ratio, the color is changed internally to be the same color as the button’s\n * icon or label text.\n *\n * Spinner Sizes:\n * - **Large (96px)**: Use when replacing entire regions or pages that are still loading\n * - **MidSize (48px) (Default)**: Use for most use cases.\n * - **Small (24px)**: Use for inline with loading text.\n *\n * Customisation of the spinner size is allowed by setting the size to undefined and using the --mdc-spinner-size\n * CSS property.\n *\n * Spinner Colors:\n * - **Default**: Use for most use cases.\n * - **Inverted**: Only to be used within inverted components, such as coachmarks.\n *\n * Regarding accessibility, if an aria-label is provided, the role will be set to 'img'; if it is absent, the role\n * will be unset\n * and aria-hidden will be set to 'true' so the spinner will be ignored by screen readers.\n *\n * @tagname mdc-spinner\n *\n * @cssproperty --mdc-spinner-default-color - Allows customization of the default spinner color.\n * @cssproperty --mdc-spinner-inverted-color - Allows customization of the inverted spinner color.\n * @cssproperty --mdc-spinner-button-variant-color - Allows customization of the spinner Button variant color.\n * @cssproperty --mdc-spinner-size - Allows customization of the spinner size.\n *\n * @csspart container - The svg which contains the circle spinner.\n * @csspart circle - The circle of the spinner.\n */",
|
8695
8695
|
"customElement": true
|
8696
8696
|
}
|
8697
8697
|
],
|
@@ -8700,8 +8700,8 @@
|
|
8700
8700
|
"kind": "js",
|
8701
8701
|
"name": "default",
|
8702
8702
|
"declaration": {
|
8703
|
-
"name": "
|
8704
|
-
"module": "components/
|
8703
|
+
"name": "Spinner",
|
8704
|
+
"module": "components/spinner/spinner.component.js"
|
8705
8705
|
}
|
8706
8706
|
}
|
8707
8707
|
]
|
@@ -9517,7 +9517,7 @@
|
|
9517
9517
|
"declarations": [
|
9518
9518
|
{
|
9519
9519
|
"kind": "class",
|
9520
|
-
"description": "ThemeProvider component, which sets the passed in themeclass as class.\nIf the themeclass switches, the existing themeclass will be removed as a class\nand the new themeclass will be added.\n\nCSS variables defined in the themeclass will be used for the styling of child dom nodes.\n\nThemeclass context can be be consumed from Lit child components\n(see providerUtils.consume for how to consume)\n\nThemeProvider also includes basic font defaults for text.",
|
9520
|
+
"description": "ThemeProvider component, which sets the passed in themeclass as class.\nIf the themeclass switches, the existing themeclass will be removed as a class\nand the new themeclass will be added.\n\nCSS variables defined in the themeclass will be used for the styling of child dom nodes.\n\nAvailable Momentum theme classes:\n\n`mds-theme-stable-darkWebex`, `mds-theme-stable-lightWebex`\n\n`mds-theme-stable-darkBronzeWebex`, `mds-theme-stable-lightBronzeWebex`\n\n`mds-theme-stable-darkIndigoWebex`, `mds-theme-stable-lightIndigoWebex`\n\n`mds-theme-stable-darkJadeWebex`, `mds-theme-stable-lightJadeWebex`\n\n`mds-theme-stable-darkLavenderWebex`, `mds-theme-stable-lightLavenderWebex`\n\n`mds-theme-stable-darkRoseWebex`, `mds-theme-stable-lightRoseWebex`\n\nThemeclass context can be be consumed from Lit child components\n(see providerUtils.consume for how to consume)\n\nThemeProvider also includes basic font defaults for text.",
|
9521
9521
|
"name": "ThemeProvider",
|
9522
9522
|
"cssProperties": [
|
9523
9523
|
{
|
@@ -9614,7 +9614,7 @@
|
|
9614
9614
|
"module": "/src/models"
|
9615
9615
|
},
|
9616
9616
|
"tagName": "mdc-themeprovider",
|
9617
|
-
"jsDoc": "/**\n * ThemeProvider component, which sets the passed in themeclass as class.\n * If the themeclass switches, the existing themeclass will be removed as a class\n * and the new themeclass will be added.\n *\n * CSS variables defined in the themeclass will be used for the styling of child dom nodes.\n *\n * Themeclass context can be be consumed from Lit child components\n * (see providerUtils.consume for how to consume)\n *\n * ThemeProvider also includes basic font defaults for text.\n *\n * @tagname mdc-themeprovider\n *\n * @slot - children\n *\n * @cssproperty --mdc-themeprovider-color-default - Option to override the default color,\n * default: color-theme-text-primary-normal\n * @cssproperty --mdc-themeprovider-font-family - Option to override the font family,\n * default: `Momentum` (from momentum-design/fonts)\n * @cssproperty --mdc-themeprovider-font-weight - Option to override the font weight, default: `400`\n * @cssproperty --mdc-themeprovider-letter-spacing-adjustment - Option to override the default letter-spacing,\n * default: `-0.25px` (this is to match the old CiscoSans)\n * @cssproperty --mdc-themeprovider-font-feature-settings - Option to override the font feature settings,\n * default: `\"ss02\" on`\n * @cssproperty --mdc-themeprovider-scrollbar-track-color - Option to override the color of the scrollbar track.\n * @cssproperty --mdc-themeprovider-scrollbar-thumb-color - Option to override the color of the scrollbar thumb.\n * @cssproperty --mdc-themeprovider-scrollbar-thumb-hover-color - Option to override the color of the\n * scrollbar thumb on hover. Applicable only on webkit browsers.\n * @cssproperty --mdc-themeprovider-scrollbar-thumb-active-color - Option to override the color of the\n * scrollbar thumb on press. Applicable only on webkit browsers.\n */",
|
9617
|
+
"jsDoc": "/**\n * ThemeProvider component, which sets the passed in themeclass as class.\n * If the themeclass switches, the existing themeclass will be removed as a class\n * and the new themeclass will be added.\n *\n * CSS variables defined in the themeclass will be used for the styling of child dom nodes.\n *\n * Available Momentum theme classes:\n *\n * `mds-theme-stable-darkWebex`, `mds-theme-stable-lightWebex`\n *\n * `mds-theme-stable-darkBronzeWebex`, `mds-theme-stable-lightBronzeWebex`\n *\n * `mds-theme-stable-darkIndigoWebex`, `mds-theme-stable-lightIndigoWebex`\n *\n * `mds-theme-stable-darkJadeWebex`, `mds-theme-stable-lightJadeWebex`\n *\n * `mds-theme-stable-darkLavenderWebex`, `mds-theme-stable-lightLavenderWebex`\n *\n * `mds-theme-stable-darkRoseWebex`, `mds-theme-stable-lightRoseWebex`\n *\n * Themeclass context can be be consumed from Lit child components\n * (see providerUtils.consume for how to consume)\n *\n * ThemeProvider also includes basic font defaults for text.\n *\n * @tagname mdc-themeprovider\n *\n * @slot - children\n *\n * @cssproperty --mdc-themeprovider-color-default - Option to override the default color,\n * default: color-theme-text-primary-normal\n * @cssproperty --mdc-themeprovider-font-family - Option to override the font family,\n * default: `Momentum` (from momentum-design/fonts)\n * @cssproperty --mdc-themeprovider-font-weight - Option to override the font weight, default: `400`\n * @cssproperty --mdc-themeprovider-letter-spacing-adjustment - Option to override the default letter-spacing,\n * default: `-0.25px` (this is to match the old CiscoSans)\n * @cssproperty --mdc-themeprovider-font-feature-settings - Option to override the font feature settings,\n * default: `\"ss02\" on`\n * @cssproperty --mdc-themeprovider-scrollbar-track-color - Option to override the color of the scrollbar track.\n * @cssproperty --mdc-themeprovider-scrollbar-thumb-color - Option to override the color of the scrollbar thumb.\n * @cssproperty --mdc-themeprovider-scrollbar-thumb-hover-color - Option to override the color of the\n * scrollbar thumb on hover. Applicable only on webkit browsers.\n * @cssproperty --mdc-themeprovider-scrollbar-thumb-active-color - Option to override the color of the\n * scrollbar thumb on press. Applicable only on webkit browsers.\n */",
|
9618
9618
|
"customElement": true
|
9619
9619
|
}
|
9620
9620
|
],
|