@momentum-design/components 0.29.0 → 0.29.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/browser/index.js +72 -72
- package/dist/browser/index.js.map +4 -4
- package/dist/components/buttonsimple/buttonsimple.component.d.ts +7 -1
- package/dist/components/buttonsimple/buttonsimple.component.js +9 -2
- package/dist/components/checkbox/checkbox.component.js +0 -2
- package/dist/components/input/input.component.d.ts +0 -1
- package/dist/components/input/input.component.js +1 -3
- package/dist/components/radio/radio.component.js +0 -2
- package/dist/components/toggle/toggle.component.js +0 -2
- package/dist/custom-elements.json +1515 -2066
- package/dist/react/index.d.ts +1 -1
- package/dist/react/index.js +1 -1
- package/dist/utils/mixins/FormInternalsMixin.js +2 -0
- package/package.json +1 -1
@@ -446,106 +446,6 @@
|
|
446
446
|
"module": "utils/mixins/IconNameMixin.js"
|
447
447
|
}
|
448
448
|
},
|
449
|
-
{
|
450
|
-
"kind": "field",
|
451
|
-
"name": "name",
|
452
|
-
"type": {
|
453
|
-
"text": "string"
|
454
|
-
},
|
455
|
-
"default": "''",
|
456
|
-
"description": "Indicates the name of the component group.\nThey are used to group elements in a form together.",
|
457
|
-
"attribute": "name",
|
458
|
-
"reflects": true,
|
459
|
-
"inheritedFrom": {
|
460
|
-
"name": "FormInternalsMixin",
|
461
|
-
"module": "utils/mixins/FormInternalsMixin.js"
|
462
|
-
}
|
463
|
-
},
|
464
|
-
{
|
465
|
-
"kind": "field",
|
466
|
-
"name": "value",
|
467
|
-
"type": {
|
468
|
-
"text": "string"
|
469
|
-
},
|
470
|
-
"default": "''",
|
471
|
-
"description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
|
472
|
-
"attribute": "value",
|
473
|
-
"reflects": true,
|
474
|
-
"inheritedFrom": {
|
475
|
-
"name": "FormInternalsMixin",
|
476
|
-
"module": "utils/mixins/FormInternalsMixin.js"
|
477
|
-
}
|
478
|
-
},
|
479
|
-
{
|
480
|
-
"kind": "field",
|
481
|
-
"name": "validationMessage",
|
482
|
-
"type": {
|
483
|
-
"text": "string | undefined"
|
484
|
-
},
|
485
|
-
"description": "Custom validation message that will override the default message and displayed when the input is invalid.",
|
486
|
-
"attribute": "validation-message",
|
487
|
-
"reflects": true,
|
488
|
-
"inheritedFrom": {
|
489
|
-
"name": "FormInternalsMixin",
|
490
|
-
"module": "utils/mixins/FormInternalsMixin.js"
|
491
|
-
}
|
492
|
-
},
|
493
|
-
{
|
494
|
-
"kind": "field",
|
495
|
-
"name": "validity",
|
496
|
-
"type": {
|
497
|
-
"text": "ValidityState"
|
498
|
-
},
|
499
|
-
"readonly": true,
|
500
|
-
"inheritedFrom": {
|
501
|
-
"name": "FormInternalsMixin",
|
502
|
-
"module": "utils/mixins/FormInternalsMixin.js"
|
503
|
-
}
|
504
|
-
},
|
505
|
-
{
|
506
|
-
"kind": "field",
|
507
|
-
"name": "willValidate",
|
508
|
-
"readonly": true,
|
509
|
-
"inheritedFrom": {
|
510
|
-
"name": "FormInternalsMixin",
|
511
|
-
"module": "utils/mixins/FormInternalsMixin.js"
|
512
|
-
}
|
513
|
-
},
|
514
|
-
{
|
515
|
-
"kind": "method",
|
516
|
-
"name": "setValidity",
|
517
|
-
"description": "Sets the validity of the input field based on the input field's validity.",
|
518
|
-
"return": {
|
519
|
-
"type": {
|
520
|
-
"text": ""
|
521
|
-
}
|
522
|
-
},
|
523
|
-
"inheritedFrom": {
|
524
|
-
"name": "FormInternalsMixin",
|
525
|
-
"module": "utils/mixins/FormInternalsMixin.js"
|
526
|
-
}
|
527
|
-
},
|
528
|
-
{
|
529
|
-
"kind": "method",
|
530
|
-
"name": "checkValidity",
|
531
|
-
"return": {
|
532
|
-
"type": {
|
533
|
-
"text": "boolean"
|
534
|
-
}
|
535
|
-
},
|
536
|
-
"inheritedFrom": {
|
537
|
-
"name": "FormInternalsMixin",
|
538
|
-
"module": "utils/mixins/FormInternalsMixin.js"
|
539
|
-
}
|
540
|
-
},
|
541
|
-
{
|
542
|
-
"kind": "method",
|
543
|
-
"name": "reportValidity",
|
544
|
-
"inheritedFrom": {
|
545
|
-
"name": "FormInternalsMixin",
|
546
|
-
"module": "utils/mixins/FormInternalsMixin.js"
|
547
|
-
}
|
548
|
-
},
|
549
449
|
{
|
550
450
|
"kind": "field",
|
551
451
|
"name": "tabIndex",
|
@@ -844,44 +744,6 @@
|
|
844
744
|
"module": "src/utils/mixins/IconNameMixin.ts"
|
845
745
|
}
|
846
746
|
},
|
847
|
-
{
|
848
|
-
"name": "name",
|
849
|
-
"type": {
|
850
|
-
"text": "string"
|
851
|
-
},
|
852
|
-
"default": "''",
|
853
|
-
"description": "Indicates the name of the component group.\nThey are used to group elements in a form together.",
|
854
|
-
"fieldName": "name",
|
855
|
-
"inheritedFrom": {
|
856
|
-
"name": "FormInternalsMixin",
|
857
|
-
"module": "src/utils/mixins/FormInternalsMixin.ts"
|
858
|
-
}
|
859
|
-
},
|
860
|
-
{
|
861
|
-
"name": "value",
|
862
|
-
"type": {
|
863
|
-
"text": "string"
|
864
|
-
},
|
865
|
-
"default": "''",
|
866
|
-
"description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
|
867
|
-
"fieldName": "value",
|
868
|
-
"inheritedFrom": {
|
869
|
-
"name": "FormInternalsMixin",
|
870
|
-
"module": "src/utils/mixins/FormInternalsMixin.ts"
|
871
|
-
}
|
872
|
-
},
|
873
|
-
{
|
874
|
-
"name": "validation-message",
|
875
|
-
"type": {
|
876
|
-
"text": "string | undefined"
|
877
|
-
},
|
878
|
-
"description": "Custom validation message that will override the default message and displayed when the input is invalid.",
|
879
|
-
"fieldName": "validationMessage",
|
880
|
-
"inheritedFrom": {
|
881
|
-
"name": "FormInternalsMixin",
|
882
|
-
"module": "src/utils/mixins/FormInternalsMixin.ts"
|
883
|
-
}
|
884
|
-
},
|
885
747
|
{
|
886
748
|
"name": "tabIndex",
|
887
749
|
"type": {
|
@@ -1382,48 +1244,33 @@
|
|
1382
1244
|
},
|
1383
1245
|
{
|
1384
1246
|
"kind": "javascript-module",
|
1385
|
-
"path": "components/
|
1247
|
+
"path": "components/buttonsimple/buttonsimple.component.js",
|
1386
1248
|
"declarations": [
|
1387
1249
|
{
|
1388
1250
|
"kind": "class",
|
1389
|
-
"description": "`mdc-
|
1390
|
-
"name": "
|
1391
|
-
"slots": [
|
1392
|
-
{
|
1393
|
-
"description": "Text label of the button.",
|
1394
|
-
"name": ""
|
1395
|
-
}
|
1396
|
-
],
|
1251
|
+
"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.",
|
1252
|
+
"name": "Buttonsimple",
|
1397
1253
|
"members": [
|
1398
1254
|
{
|
1399
1255
|
"kind": "field",
|
1400
|
-
"name": "
|
1401
|
-
"type": {
|
1402
|
-
"text": "string | undefined"
|
1403
|
-
},
|
1404
|
-
"description": "The name of the icon to display as a prefix.\nThe icon is displayed on the left side of the button.",
|
1405
|
-
"attribute": "prefix-icon",
|
1406
|
-
"reflects": true
|
1407
|
-
},
|
1408
|
-
{
|
1409
|
-
"kind": "field",
|
1410
|
-
"name": "postfixIcon",
|
1256
|
+
"name": "active",
|
1411
1257
|
"type": {
|
1412
|
-
"text": "
|
1258
|
+
"text": "boolean"
|
1413
1259
|
},
|
1414
|
-
"
|
1415
|
-
"
|
1260
|
+
"default": "false",
|
1261
|
+
"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.",
|
1262
|
+
"attribute": "active",
|
1416
1263
|
"reflects": true
|
1417
1264
|
},
|
1418
1265
|
{
|
1419
1266
|
"kind": "field",
|
1420
|
-
"name": "
|
1267
|
+
"name": "softDisabled",
|
1421
1268
|
"type": {
|
1422
|
-
"text": "
|
1269
|
+
"text": "boolean"
|
1423
1270
|
},
|
1424
|
-
"
|
1425
|
-
"
|
1426
|
-
"attribute": "
|
1271
|
+
"default": "false",
|
1272
|
+
"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.",
|
1273
|
+
"attribute": "soft-disabled"
|
1427
1274
|
},
|
1428
1275
|
{
|
1429
1276
|
"kind": "field",
|
@@ -1431,211 +1278,141 @@
|
|
1431
1278
|
"type": {
|
1432
1279
|
"text": "ButtonSize"
|
1433
1280
|
},
|
1434
|
-
"description": "
|
1281
|
+
"description": "Simplebutton size is a super set of all the sizes supported by children components.",
|
1435
1282
|
"default": "32",
|
1436
1283
|
"attribute": "size",
|
1437
|
-
"reflects": true
|
1438
|
-
"inheritedFrom": {
|
1439
|
-
"name": "Buttonsimple",
|
1440
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
1441
|
-
}
|
1442
|
-
},
|
1443
|
-
{
|
1444
|
-
"kind": "field",
|
1445
|
-
"name": "color",
|
1446
|
-
"type": {
|
1447
|
-
"text": "ButtonColor"
|
1448
|
-
},
|
1449
|
-
"description": "There are 5 colors for button: positive, negative, accent, promotional, default.",
|
1450
|
-
"default": "default",
|
1451
|
-
"attribute": "color"
|
1284
|
+
"reflects": true
|
1452
1285
|
},
|
1453
1286
|
{
|
1454
1287
|
"kind": "field",
|
1455
1288
|
"name": "role",
|
1456
1289
|
"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.",
|
1457
|
-
"default": "
|
1290
|
+
"default": "button",
|
1458
1291
|
"attribute": "role",
|
1459
|
-
"reflects": true
|
1292
|
+
"reflects": true
|
1293
|
+
},
|
1294
|
+
{
|
1295
|
+
"kind": "field",
|
1296
|
+
"name": "type",
|
1460
1297
|
"type": {
|
1461
|
-
"text": "
|
1298
|
+
"text": "ButtonType"
|
1462
1299
|
},
|
1463
|
-
"
|
1464
|
-
|
1465
|
-
|
1466
|
-
|
1300
|
+
"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
|
+
"default": "button",
|
1302
|
+
"attribute": "type",
|
1303
|
+
"reflects": true
|
1467
1304
|
},
|
1468
1305
|
{
|
1469
1306
|
"kind": "method",
|
1470
|
-
"name": "
|
1471
|
-
"privacy": "
|
1307
|
+
"name": "executeAction",
|
1308
|
+
"privacy": "protected"
|
1309
|
+
},
|
1310
|
+
{
|
1311
|
+
"kind": "method",
|
1312
|
+
"name": "setActive",
|
1313
|
+
"privacy": "protected",
|
1472
1314
|
"parameters": [
|
1315
|
+
{
|
1316
|
+
"name": "element",
|
1317
|
+
"type": {
|
1318
|
+
"text": "HTMLElement"
|
1319
|
+
},
|
1320
|
+
"description": "The button element"
|
1321
|
+
},
|
1473
1322
|
{
|
1474
1323
|
"name": "active",
|
1475
1324
|
"type": {
|
1476
1325
|
"text": "boolean"
|
1477
1326
|
},
|
1478
|
-
"description": "The active state
|
1327
|
+
"description": "The active state of the element"
|
1479
1328
|
}
|
1480
1329
|
],
|
1481
|
-
"description": "
|
1330
|
+
"description": "Sets the aria-pressed attribute based on the active state of the button."
|
1482
1331
|
},
|
1483
1332
|
{
|
1484
1333
|
"kind": "method",
|
1485
|
-
"name": "
|
1334
|
+
"name": "setSoftDisabled",
|
1486
1335
|
"privacy": "private",
|
1487
1336
|
"parameters": [
|
1488
1337
|
{
|
1489
|
-
"name": "
|
1338
|
+
"name": "element",
|
1490
1339
|
"type": {
|
1491
|
-
"text": "
|
1340
|
+
"text": "HTMLElement"
|
1492
1341
|
},
|
1493
|
-
"description": "The
|
1342
|
+
"description": "The button element."
|
1343
|
+
},
|
1344
|
+
{
|
1345
|
+
"name": "softDisabled",
|
1346
|
+
"type": {
|
1347
|
+
"text": "boolean"
|
1348
|
+
},
|
1349
|
+
"description": "The soft-disabled state."
|
1494
1350
|
}
|
1495
1351
|
],
|
1496
|
-
"description": "Sets the
|
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."
|
1497
1353
|
},
|
1498
1354
|
{
|
1499
1355
|
"kind": "method",
|
1500
|
-
"name": "
|
1356
|
+
"name": "setDisabled",
|
1501
1357
|
"privacy": "private",
|
1502
1358
|
"parameters": [
|
1503
1359
|
{
|
1504
|
-
"name": "
|
1360
|
+
"name": "element",
|
1505
1361
|
"type": {
|
1506
|
-
"text": "
|
1362
|
+
"text": "HTMLElement"
|
1507
1363
|
},
|
1508
|
-
"description": "The
|
1364
|
+
"description": "The button element."
|
1365
|
+
},
|
1366
|
+
{
|
1367
|
+
"name": "disabled",
|
1368
|
+
"type": {
|
1369
|
+
"text": "boolean"
|
1370
|
+
},
|
1371
|
+
"description": "The disabled state."
|
1509
1372
|
}
|
1510
1373
|
],
|
1511
|
-
"description": "Sets the
|
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."
|
1512
1375
|
},
|
1513
1376
|
{
|
1514
1377
|
"kind": "method",
|
1515
|
-
"name": "
|
1378
|
+
"name": "triggerClickEvent",
|
1379
|
+
"privacy": "private"
|
1380
|
+
},
|
1381
|
+
{
|
1382
|
+
"kind": "method",
|
1383
|
+
"name": "handleBlur",
|
1384
|
+
"privacy": "private",
|
1385
|
+
"description": "In case the button is pressed and the focus is lost while pressing,\nthe pressed class is removed."
|
1386
|
+
},
|
1387
|
+
{
|
1388
|
+
"kind": "method",
|
1389
|
+
"name": "handleKeyDown",
|
1516
1390
|
"privacy": "private",
|
1517
1391
|
"parameters": [
|
1518
1392
|
{
|
1519
|
-
"name": "
|
1393
|
+
"name": "event",
|
1520
1394
|
"type": {
|
1521
|
-
"text": "
|
1395
|
+
"text": "KeyboardEvent"
|
1522
1396
|
},
|
1523
|
-
"description": "The
|
1397
|
+
"description": "The keyboard event."
|
1524
1398
|
}
|
1525
1399
|
],
|
1526
|
-
"description": "
|
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."
|
1527
1401
|
},
|
1528
1402
|
{
|
1529
1403
|
"kind": "method",
|
1530
|
-
"name": "
|
1404
|
+
"name": "handleKeyUp",
|
1531
1405
|
"privacy": "private",
|
1532
|
-
"description": "Infers the type of button based on the presence of slot and/or prefix and postfix icons.",
|
1533
1406
|
"parameters": [
|
1534
1407
|
{
|
1535
|
-
"
|
1536
|
-
"
|
1537
|
-
|
1538
|
-
|
1539
|
-
|
1540
|
-
{
|
1541
|
-
"kind": "field",
|
1542
|
-
"name": "name",
|
1543
|
-
"type": {
|
1544
|
-
"text": "string"
|
1545
|
-
},
|
1546
|
-
"default": "''",
|
1547
|
-
"description": "Indicates the name of the component group.\nThey are used to group elements in a form together.",
|
1548
|
-
"attribute": "name",
|
1549
|
-
"reflects": true,
|
1550
|
-
"inheritedFrom": {
|
1551
|
-
"name": "FormInternalsMixin",
|
1552
|
-
"module": "utils/mixins/FormInternalsMixin.js"
|
1553
|
-
}
|
1554
|
-
},
|
1555
|
-
{
|
1556
|
-
"kind": "field",
|
1557
|
-
"name": "value",
|
1558
|
-
"type": {
|
1559
|
-
"text": "string"
|
1560
|
-
},
|
1561
|
-
"default": "''",
|
1562
|
-
"description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
|
1563
|
-
"attribute": "value",
|
1564
|
-
"reflects": true,
|
1565
|
-
"inheritedFrom": {
|
1566
|
-
"name": "FormInternalsMixin",
|
1567
|
-
"module": "utils/mixins/FormInternalsMixin.js"
|
1568
|
-
}
|
1569
|
-
},
|
1570
|
-
{
|
1571
|
-
"kind": "field",
|
1572
|
-
"name": "validationMessage",
|
1573
|
-
"type": {
|
1574
|
-
"text": "string | undefined"
|
1575
|
-
},
|
1576
|
-
"description": "Custom validation message that will override the default message and displayed when the input is invalid.",
|
1577
|
-
"attribute": "validation-message",
|
1578
|
-
"reflects": true,
|
1579
|
-
"inheritedFrom": {
|
1580
|
-
"name": "FormInternalsMixin",
|
1581
|
-
"module": "utils/mixins/FormInternalsMixin.js"
|
1582
|
-
}
|
1583
|
-
},
|
1584
|
-
{
|
1585
|
-
"kind": "field",
|
1586
|
-
"name": "validity",
|
1587
|
-
"type": {
|
1588
|
-
"text": "ValidityState"
|
1589
|
-
},
|
1590
|
-
"readonly": true,
|
1591
|
-
"inheritedFrom": {
|
1592
|
-
"name": "FormInternalsMixin",
|
1593
|
-
"module": "utils/mixins/FormInternalsMixin.js"
|
1594
|
-
}
|
1595
|
-
},
|
1596
|
-
{
|
1597
|
-
"kind": "field",
|
1598
|
-
"name": "willValidate",
|
1599
|
-
"readonly": true,
|
1600
|
-
"inheritedFrom": {
|
1601
|
-
"name": "FormInternalsMixin",
|
1602
|
-
"module": "utils/mixins/FormInternalsMixin.js"
|
1603
|
-
}
|
1604
|
-
},
|
1605
|
-
{
|
1606
|
-
"kind": "method",
|
1607
|
-
"name": "setValidity",
|
1608
|
-
"description": "Sets the validity of the input field based on the input field's validity.",
|
1609
|
-
"return": {
|
1610
|
-
"type": {
|
1611
|
-
"text": ""
|
1612
|
-
}
|
1613
|
-
},
|
1614
|
-
"inheritedFrom": {
|
1615
|
-
"name": "FormInternalsMixin",
|
1616
|
-
"module": "utils/mixins/FormInternalsMixin.js"
|
1617
|
-
}
|
1618
|
-
},
|
1619
|
-
{
|
1620
|
-
"kind": "method",
|
1621
|
-
"name": "checkValidity",
|
1622
|
-
"return": {
|
1623
|
-
"type": {
|
1624
|
-
"text": "boolean"
|
1408
|
+
"name": "event",
|
1409
|
+
"type": {
|
1410
|
+
"text": "KeyboardEvent"
|
1411
|
+
},
|
1412
|
+
"description": "The keyboard event."
|
1625
1413
|
}
|
1626
|
-
|
1627
|
-
"
|
1628
|
-
"name": "FormInternalsMixin",
|
1629
|
-
"module": "utils/mixins/FormInternalsMixin.js"
|
1630
|
-
}
|
1631
|
-
},
|
1632
|
-
{
|
1633
|
-
"kind": "method",
|
1634
|
-
"name": "reportValidity",
|
1635
|
-
"inheritedFrom": {
|
1636
|
-
"name": "FormInternalsMixin",
|
1637
|
-
"module": "utils/mixins/FormInternalsMixin.js"
|
1638
|
-
}
|
1414
|
+
],
|
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."
|
1639
1416
|
},
|
1640
1417
|
{
|
1641
1418
|
"kind": "field",
|
@@ -1666,868 +1443,108 @@
|
|
1666
1443
|
"name": "DisabledMixin",
|
1667
1444
|
"module": "utils/mixins/DisabledMixin.js"
|
1668
1445
|
}
|
1446
|
+
}
|
1447
|
+
],
|
1448
|
+
"events": [
|
1449
|
+
{
|
1450
|
+
"description": "(React: onClick) This event is dispatched when the button is clicked.",
|
1451
|
+
"name": "click",
|
1452
|
+
"reactName": "onClick",
|
1453
|
+
"eventName": "ClickEvent"
|
1669
1454
|
},
|
1670
1455
|
{
|
1671
|
-
"
|
1456
|
+
"description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the button.",
|
1457
|
+
"name": "keydown",
|
1458
|
+
"reactName": "onKeyDown",
|
1459
|
+
"eventName": "KeydownEvent"
|
1460
|
+
},
|
1461
|
+
{
|
1462
|
+
"description": "(React: onKeyUp) This event is dispatched when a key is released on the button.",
|
1463
|
+
"name": "keyup",
|
1464
|
+
"reactName": "onKeyUp",
|
1465
|
+
"eventName": "KeyupEvent"
|
1466
|
+
},
|
1467
|
+
{
|
1468
|
+
"description": "(React: onFocus) This event is dispatched when the button receives focus.",
|
1469
|
+
"name": "focus",
|
1470
|
+
"reactName": "onFocus",
|
1471
|
+
"eventName": "FocusEvent"
|
1472
|
+
}
|
1473
|
+
],
|
1474
|
+
"attributes": [
|
1475
|
+
{
|
1672
1476
|
"name": "active",
|
1673
1477
|
"type": {
|
1674
1478
|
"text": "boolean"
|
1675
1479
|
},
|
1676
1480
|
"default": "false",
|
1677
1481
|
"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.",
|
1678
|
-
"
|
1679
|
-
"reflects": true,
|
1680
|
-
"inheritedFrom": {
|
1681
|
-
"name": "Buttonsimple",
|
1682
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
1683
|
-
}
|
1482
|
+
"fieldName": "active"
|
1684
1483
|
},
|
1685
1484
|
{
|
1686
|
-
"
|
1687
|
-
"name": "softDisabled",
|
1485
|
+
"name": "soft-disabled",
|
1688
1486
|
"type": {
|
1689
1487
|
"text": "boolean"
|
1690
1488
|
},
|
1691
1489
|
"default": "false",
|
1692
1490
|
"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.",
|
1693
|
-
"
|
1694
|
-
|
1695
|
-
|
1696
|
-
|
1697
|
-
|
1491
|
+
"fieldName": "softDisabled"
|
1492
|
+
},
|
1493
|
+
{
|
1494
|
+
"name": "size",
|
1495
|
+
"type": {
|
1496
|
+
"text": "ButtonSize"
|
1497
|
+
},
|
1498
|
+
"description": "Simplebutton size is a super set of all the sizes supported by children components.",
|
1499
|
+
"default": "32",
|
1500
|
+
"fieldName": "size"
|
1501
|
+
},
|
1502
|
+
{
|
1503
|
+
"name": "role",
|
1504
|
+
"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.",
|
1505
|
+
"default": "button",
|
1506
|
+
"fieldName": "role"
|
1698
1507
|
},
|
1699
1508
|
{
|
1700
|
-
"kind": "field",
|
1701
1509
|
"name": "type",
|
1702
1510
|
"type": {
|
1703
1511
|
"text": "ButtonType"
|
1704
1512
|
},
|
1705
1513
|
"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.",
|
1706
1514
|
"default": "button",
|
1707
|
-
"
|
1708
|
-
|
1515
|
+
"fieldName": "type"
|
1516
|
+
},
|
1517
|
+
{
|
1518
|
+
"name": "tabIndex",
|
1519
|
+
"type": {
|
1520
|
+
"text": "number"
|
1521
|
+
},
|
1522
|
+
"default": "0",
|
1523
|
+
"description": "This property specifies the tab order of the element.",
|
1524
|
+
"fieldName": "tabIndex",
|
1709
1525
|
"inheritedFrom": {
|
1710
|
-
"name": "
|
1711
|
-
"module": "
|
1526
|
+
"name": "TabIndexMixin",
|
1527
|
+
"module": "src/utils/mixins/TabIndexMixin.ts"
|
1712
1528
|
}
|
1713
1529
|
},
|
1714
1530
|
{
|
1715
|
-
"
|
1716
|
-
"
|
1717
|
-
|
1531
|
+
"name": "disabled",
|
1532
|
+
"type": {
|
1533
|
+
"text": "boolean"
|
1534
|
+
},
|
1535
|
+
"default": "false",
|
1536
|
+
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
1537
|
+
"fieldName": "disabled",
|
1718
1538
|
"inheritedFrom": {
|
1719
|
-
"name": "
|
1720
|
-
"module": "
|
1539
|
+
"name": "DisabledMixin",
|
1540
|
+
"module": "src/utils/mixins/DisabledMixin.ts"
|
1721
1541
|
}
|
1722
|
-
}
|
1723
|
-
|
1724
|
-
|
1725
|
-
|
1726
|
-
"
|
1727
|
-
"
|
1728
|
-
{
|
1729
|
-
"name": "element",
|
1730
|
-
"type": {
|
1731
|
-
"text": "HTMLElement"
|
1732
|
-
},
|
1733
|
-
"description": "The button element"
|
1734
|
-
},
|
1735
|
-
{
|
1736
|
-
"name": "active",
|
1737
|
-
"type": {
|
1738
|
-
"text": "boolean"
|
1739
|
-
},
|
1740
|
-
"description": "The active state of the element"
|
1741
|
-
}
|
1742
|
-
],
|
1743
|
-
"description": "Sets the aria-pressed attribute based on the active state of the button.",
|
1744
|
-
"inheritedFrom": {
|
1745
|
-
"name": "Buttonsimple",
|
1746
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
1747
|
-
}
|
1748
|
-
},
|
1749
|
-
{
|
1750
|
-
"kind": "method",
|
1751
|
-
"name": "setSoftDisabled",
|
1752
|
-
"privacy": "private",
|
1753
|
-
"parameters": [
|
1754
|
-
{
|
1755
|
-
"name": "element",
|
1756
|
-
"type": {
|
1757
|
-
"text": "HTMLElement"
|
1758
|
-
},
|
1759
|
-
"description": "The button element."
|
1760
|
-
},
|
1761
|
-
{
|
1762
|
-
"name": "softDisabled",
|
1763
|
-
"type": {
|
1764
|
-
"text": "boolean"
|
1765
|
-
},
|
1766
|
-
"description": "The soft-disabled state."
|
1767
|
-
}
|
1768
|
-
],
|
1769
|
-
"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.",
|
1770
|
-
"inheritedFrom": {
|
1771
|
-
"name": "Buttonsimple",
|
1772
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
1773
|
-
}
|
1774
|
-
},
|
1775
|
-
{
|
1776
|
-
"kind": "method",
|
1777
|
-
"name": "setDisabled",
|
1778
|
-
"privacy": "private",
|
1779
|
-
"parameters": [
|
1780
|
-
{
|
1781
|
-
"name": "element",
|
1782
|
-
"type": {
|
1783
|
-
"text": "HTMLElement"
|
1784
|
-
},
|
1785
|
-
"description": "The button element."
|
1786
|
-
},
|
1787
|
-
{
|
1788
|
-
"name": "disabled",
|
1789
|
-
"type": {
|
1790
|
-
"text": "boolean"
|
1791
|
-
},
|
1792
|
-
"description": "The disabled state."
|
1793
|
-
}
|
1794
|
-
],
|
1795
|
-
"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.",
|
1796
|
-
"inheritedFrom": {
|
1797
|
-
"name": "Buttonsimple",
|
1798
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
1799
|
-
}
|
1800
|
-
},
|
1801
|
-
{
|
1802
|
-
"kind": "method",
|
1803
|
-
"name": "triggerClickEvent",
|
1804
|
-
"privacy": "private",
|
1805
|
-
"inheritedFrom": {
|
1806
|
-
"name": "Buttonsimple",
|
1807
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
1808
|
-
}
|
1809
|
-
},
|
1810
|
-
{
|
1811
|
-
"kind": "method",
|
1812
|
-
"name": "handleBlur",
|
1813
|
-
"privacy": "private",
|
1814
|
-
"description": "In case the button is pressed and the focus is lost while pressing,\nthe pressed class is removed.",
|
1815
|
-
"inheritedFrom": {
|
1816
|
-
"name": "Buttonsimple",
|
1817
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
1818
|
-
}
|
1819
|
-
},
|
1820
|
-
{
|
1821
|
-
"kind": "method",
|
1822
|
-
"name": "handleKeyDown",
|
1823
|
-
"privacy": "private",
|
1824
|
-
"parameters": [
|
1825
|
-
{
|
1826
|
-
"name": "event",
|
1827
|
-
"type": {
|
1828
|
-
"text": "KeyboardEvent"
|
1829
|
-
},
|
1830
|
-
"description": "The keyboard event."
|
1831
|
-
}
|
1832
|
-
],
|
1833
|
-
"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.",
|
1834
|
-
"inheritedFrom": {
|
1835
|
-
"name": "Buttonsimple",
|
1836
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
1837
|
-
}
|
1838
|
-
},
|
1839
|
-
{
|
1840
|
-
"kind": "method",
|
1841
|
-
"name": "handleKeyUp",
|
1842
|
-
"privacy": "private",
|
1843
|
-
"parameters": [
|
1844
|
-
{
|
1845
|
-
"name": "event",
|
1846
|
-
"type": {
|
1847
|
-
"text": "KeyboardEvent"
|
1848
|
-
},
|
1849
|
-
"description": "The keyboard event."
|
1850
|
-
}
|
1851
|
-
],
|
1852
|
-
"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.",
|
1853
|
-
"inheritedFrom": {
|
1854
|
-
"name": "Buttonsimple",
|
1855
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
1856
|
-
}
|
1857
|
-
}
|
1858
|
-
],
|
1859
|
-
"events": [
|
1860
|
-
{
|
1861
|
-
"description": "(React: onClick) This event is dispatched when the button is clicked.",
|
1862
|
-
"name": "click",
|
1863
|
-
"reactName": "onClick",
|
1864
|
-
"eventName": "ClickEvent",
|
1865
|
-
"inheritedFrom": {
|
1866
|
-
"name": "Buttonsimple",
|
1867
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
1868
|
-
}
|
1869
|
-
},
|
1870
|
-
{
|
1871
|
-
"description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the button.",
|
1872
|
-
"name": "keydown",
|
1873
|
-
"reactName": "onKeyDown",
|
1874
|
-
"eventName": "KeydownEvent",
|
1875
|
-
"inheritedFrom": {
|
1876
|
-
"name": "Buttonsimple",
|
1877
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
1878
|
-
}
|
1879
|
-
},
|
1880
|
-
{
|
1881
|
-
"description": "(React: onKeyUp) This event is dispatched when a key is released on the button.",
|
1882
|
-
"name": "keyup",
|
1883
|
-
"reactName": "onKeyUp",
|
1884
|
-
"eventName": "KeyupEvent",
|
1885
|
-
"inheritedFrom": {
|
1886
|
-
"name": "Buttonsimple",
|
1887
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
1888
|
-
}
|
1889
|
-
},
|
1890
|
-
{
|
1891
|
-
"description": "(React: onFocus) This event is dispatched when the button receives focus.",
|
1892
|
-
"name": "focus",
|
1893
|
-
"reactName": "onFocus",
|
1894
|
-
"eventName": "FocusEvent",
|
1895
|
-
"inheritedFrom": {
|
1896
|
-
"name": "Buttonsimple",
|
1897
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
1898
|
-
}
|
1899
|
-
}
|
1900
|
-
],
|
1901
|
-
"attributes": [
|
1902
|
-
{
|
1903
|
-
"name": "prefix-icon",
|
1904
|
-
"type": {
|
1905
|
-
"text": "string | undefined"
|
1906
|
-
},
|
1907
|
-
"description": "The name of the icon to display as a prefix.\nThe icon is displayed on the left side of the button.",
|
1908
|
-
"fieldName": "prefixIcon"
|
1909
|
-
},
|
1910
|
-
{
|
1911
|
-
"name": "postfix-icon",
|
1912
|
-
"type": {
|
1913
|
-
"text": "string | undefined"
|
1914
|
-
},
|
1915
|
-
"description": "The name of the icon to display as a postfix.\nThe icon is displayed on the right side of the button.",
|
1916
|
-
"fieldName": "postfixIcon"
|
1917
|
-
},
|
1918
|
-
{
|
1919
|
-
"name": "variant",
|
1920
|
-
"type": {
|
1921
|
-
"text": "ButtonVariant"
|
1922
|
-
},
|
1923
|
-
"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.",
|
1924
|
-
"default": "primary",
|
1925
|
-
"fieldName": "variant"
|
1926
|
-
},
|
1927
|
-
{
|
1928
|
-
"name": "size",
|
1929
|
-
"type": {
|
1930
|
-
"text": "ButtonSize"
|
1931
|
-
},
|
1932
|
-
"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.",
|
1933
|
-
"default": "32",
|
1934
|
-
"fieldName": "size",
|
1935
|
-
"inheritedFrom": {
|
1936
|
-
"name": "Buttonsimple",
|
1937
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
1938
|
-
}
|
1939
|
-
},
|
1940
|
-
{
|
1941
|
-
"name": "color",
|
1942
|
-
"type": {
|
1943
|
-
"text": "ButtonColor"
|
1944
|
-
},
|
1945
|
-
"description": "There are 5 colors for button: positive, negative, accent, promotional, default.",
|
1946
|
-
"default": "default",
|
1947
|
-
"fieldName": "color"
|
1948
|
-
},
|
1949
|
-
{
|
1950
|
-
"name": "role",
|
1951
|
-
"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.",
|
1952
|
-
"default": "'button'",
|
1953
|
-
"fieldName": "role",
|
1954
|
-
"type": {
|
1955
|
-
"text": "string"
|
1956
|
-
},
|
1957
|
-
"inheritedFrom": {
|
1958
|
-
"name": "Buttonsimple",
|
1959
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
1960
|
-
}
|
1961
|
-
},
|
1962
|
-
{
|
1963
|
-
"name": "name",
|
1964
|
-
"type": {
|
1965
|
-
"text": "string"
|
1966
|
-
},
|
1967
|
-
"default": "''",
|
1968
|
-
"description": "Indicates the name of the component group.\nThey are used to group elements in a form together.",
|
1969
|
-
"fieldName": "name",
|
1970
|
-
"inheritedFrom": {
|
1971
|
-
"name": "FormInternalsMixin",
|
1972
|
-
"module": "src/utils/mixins/FormInternalsMixin.ts"
|
1973
|
-
}
|
1974
|
-
},
|
1975
|
-
{
|
1976
|
-
"name": "value",
|
1977
|
-
"type": {
|
1978
|
-
"text": "string"
|
1979
|
-
},
|
1980
|
-
"default": "''",
|
1981
|
-
"description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
|
1982
|
-
"fieldName": "value",
|
1983
|
-
"inheritedFrom": {
|
1984
|
-
"name": "FormInternalsMixin",
|
1985
|
-
"module": "src/utils/mixins/FormInternalsMixin.ts"
|
1986
|
-
}
|
1987
|
-
},
|
1988
|
-
{
|
1989
|
-
"name": "validation-message",
|
1990
|
-
"type": {
|
1991
|
-
"text": "string | undefined"
|
1992
|
-
},
|
1993
|
-
"description": "Custom validation message that will override the default message and displayed when the input is invalid.",
|
1994
|
-
"fieldName": "validationMessage",
|
1995
|
-
"inheritedFrom": {
|
1996
|
-
"name": "FormInternalsMixin",
|
1997
|
-
"module": "src/utils/mixins/FormInternalsMixin.ts"
|
1998
|
-
}
|
1999
|
-
},
|
2000
|
-
{
|
2001
|
-
"name": "tabIndex",
|
2002
|
-
"type": {
|
2003
|
-
"text": "number"
|
2004
|
-
},
|
2005
|
-
"default": "0",
|
2006
|
-
"description": "This property specifies the tab order of the element.",
|
2007
|
-
"fieldName": "tabIndex",
|
2008
|
-
"inheritedFrom": {
|
2009
|
-
"name": "TabIndexMixin",
|
2010
|
-
"module": "src/utils/mixins/TabIndexMixin.ts"
|
2011
|
-
}
|
2012
|
-
},
|
2013
|
-
{
|
2014
|
-
"name": "disabled",
|
2015
|
-
"type": {
|
2016
|
-
"text": "boolean"
|
2017
|
-
},
|
2018
|
-
"default": "false",
|
2019
|
-
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
2020
|
-
"fieldName": "disabled",
|
2021
|
-
"inheritedFrom": {
|
2022
|
-
"name": "DisabledMixin",
|
2023
|
-
"module": "src/utils/mixins/DisabledMixin.ts"
|
2024
|
-
}
|
2025
|
-
},
|
2026
|
-
{
|
2027
|
-
"name": "active",
|
2028
|
-
"type": {
|
2029
|
-
"text": "boolean"
|
2030
|
-
},
|
2031
|
-
"default": "false",
|
2032
|
-
"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.",
|
2033
|
-
"fieldName": "active",
|
2034
|
-
"inheritedFrom": {
|
2035
|
-
"name": "Buttonsimple",
|
2036
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
2037
|
-
}
|
2038
|
-
},
|
2039
|
-
{
|
2040
|
-
"name": "soft-disabled",
|
2041
|
-
"type": {
|
2042
|
-
"text": "boolean"
|
2043
|
-
},
|
2044
|
-
"default": "false",
|
2045
|
-
"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.",
|
2046
|
-
"fieldName": "softDisabled",
|
2047
|
-
"inheritedFrom": {
|
2048
|
-
"name": "Buttonsimple",
|
2049
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
2050
|
-
}
|
2051
|
-
},
|
2052
|
-
{
|
2053
|
-
"name": "type",
|
2054
|
-
"type": {
|
2055
|
-
"text": "ButtonType"
|
2056
|
-
},
|
2057
|
-
"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.",
|
2058
|
-
"default": "button",
|
2059
|
-
"fieldName": "type",
|
2060
|
-
"inheritedFrom": {
|
2061
|
-
"name": "Buttonsimple",
|
2062
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
2063
|
-
}
|
2064
|
-
}
|
2065
|
-
],
|
2066
|
-
"superclass": {
|
2067
|
-
"name": "Buttonsimple",
|
2068
|
-
"module": "/src/components/buttonsimple/buttonsimple.component"
|
2069
|
-
},
|
2070
|
-
"tagName": "mdc-button",
|
2071
|
-
"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 */",
|
2072
|
-
"customElement": true
|
2073
|
-
}
|
2074
|
-
],
|
2075
|
-
"exports": [
|
2076
|
-
{
|
2077
|
-
"kind": "js",
|
2078
|
-
"name": "default",
|
2079
|
-
"declaration": {
|
2080
|
-
"name": "Button",
|
2081
|
-
"module": "components/button/button.component.js"
|
2082
|
-
}
|
2083
|
-
}
|
2084
|
-
]
|
2085
|
-
},
|
2086
|
-
{
|
2087
|
-
"kind": "javascript-module",
|
2088
|
-
"path": "components/buttonsimple/buttonsimple.component.js",
|
2089
|
-
"declarations": [
|
2090
|
-
{
|
2091
|
-
"kind": "class",
|
2092
|
-
"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.",
|
2093
|
-
"name": "Buttonsimple",
|
2094
|
-
"members": [
|
2095
|
-
{
|
2096
|
-
"kind": "field",
|
2097
|
-
"name": "active",
|
2098
|
-
"type": {
|
2099
|
-
"text": "boolean"
|
2100
|
-
},
|
2101
|
-
"default": "false",
|
2102
|
-
"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.",
|
2103
|
-
"attribute": "active",
|
2104
|
-
"reflects": true
|
2105
|
-
},
|
2106
|
-
{
|
2107
|
-
"kind": "field",
|
2108
|
-
"name": "softDisabled",
|
2109
|
-
"type": {
|
2110
|
-
"text": "boolean"
|
2111
|
-
},
|
2112
|
-
"default": "false",
|
2113
|
-
"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.",
|
2114
|
-
"attribute": "soft-disabled"
|
2115
|
-
},
|
2116
|
-
{
|
2117
|
-
"kind": "field",
|
2118
|
-
"name": "size",
|
2119
|
-
"type": {
|
2120
|
-
"text": "ButtonSize"
|
2121
|
-
},
|
2122
|
-
"description": "Simplebutton size is a super set of all the sizes supported by children components.",
|
2123
|
-
"default": "32",
|
2124
|
-
"attribute": "size",
|
2125
|
-
"reflects": true
|
2126
|
-
},
|
2127
|
-
{
|
2128
|
-
"kind": "field",
|
2129
|
-
"name": "role",
|
2130
|
-
"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.",
|
2131
|
-
"default": "button",
|
2132
|
-
"attribute": "role",
|
2133
|
-
"reflects": true
|
2134
|
-
},
|
2135
|
-
{
|
2136
|
-
"kind": "field",
|
2137
|
-
"name": "type",
|
2138
|
-
"type": {
|
2139
|
-
"text": "ButtonType"
|
2140
|
-
},
|
2141
|
-
"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.",
|
2142
|
-
"default": "button",
|
2143
|
-
"attribute": "type",
|
2144
|
-
"reflects": true
|
2145
|
-
},
|
2146
|
-
{
|
2147
|
-
"kind": "method",
|
2148
|
-
"name": "executeAction",
|
2149
|
-
"privacy": "protected"
|
2150
|
-
},
|
2151
|
-
{
|
2152
|
-
"kind": "method",
|
2153
|
-
"name": "setActive",
|
2154
|
-
"privacy": "protected",
|
2155
|
-
"parameters": [
|
2156
|
-
{
|
2157
|
-
"name": "element",
|
2158
|
-
"type": {
|
2159
|
-
"text": "HTMLElement"
|
2160
|
-
},
|
2161
|
-
"description": "The button element"
|
2162
|
-
},
|
2163
|
-
{
|
2164
|
-
"name": "active",
|
2165
|
-
"type": {
|
2166
|
-
"text": "boolean"
|
2167
|
-
},
|
2168
|
-
"description": "The active state of the element"
|
2169
|
-
}
|
2170
|
-
],
|
2171
|
-
"description": "Sets the aria-pressed attribute based on the active state of the button."
|
2172
|
-
},
|
2173
|
-
{
|
2174
|
-
"kind": "method",
|
2175
|
-
"name": "setSoftDisabled",
|
2176
|
-
"privacy": "private",
|
2177
|
-
"parameters": [
|
2178
|
-
{
|
2179
|
-
"name": "element",
|
2180
|
-
"type": {
|
2181
|
-
"text": "HTMLElement"
|
2182
|
-
},
|
2183
|
-
"description": "The button element."
|
2184
|
-
},
|
2185
|
-
{
|
2186
|
-
"name": "softDisabled",
|
2187
|
-
"type": {
|
2188
|
-
"text": "boolean"
|
2189
|
-
},
|
2190
|
-
"description": "The soft-disabled state."
|
2191
|
-
}
|
2192
|
-
],
|
2193
|
-
"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."
|
2194
|
-
},
|
2195
|
-
{
|
2196
|
-
"kind": "method",
|
2197
|
-
"name": "setDisabled",
|
2198
|
-
"privacy": "private",
|
2199
|
-
"parameters": [
|
2200
|
-
{
|
2201
|
-
"name": "element",
|
2202
|
-
"type": {
|
2203
|
-
"text": "HTMLElement"
|
2204
|
-
},
|
2205
|
-
"description": "The button element."
|
2206
|
-
},
|
2207
|
-
{
|
2208
|
-
"name": "disabled",
|
2209
|
-
"type": {
|
2210
|
-
"text": "boolean"
|
2211
|
-
},
|
2212
|
-
"description": "The disabled state."
|
2213
|
-
}
|
2214
|
-
],
|
2215
|
-
"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."
|
2216
|
-
},
|
2217
|
-
{
|
2218
|
-
"kind": "method",
|
2219
|
-
"name": "triggerClickEvent",
|
2220
|
-
"privacy": "private"
|
2221
|
-
},
|
2222
|
-
{
|
2223
|
-
"kind": "method",
|
2224
|
-
"name": "handleBlur",
|
2225
|
-
"privacy": "private",
|
2226
|
-
"description": "In case the button is pressed and the focus is lost while pressing,\nthe pressed class is removed."
|
2227
|
-
},
|
2228
|
-
{
|
2229
|
-
"kind": "method",
|
2230
|
-
"name": "handleKeyDown",
|
2231
|
-
"privacy": "private",
|
2232
|
-
"parameters": [
|
2233
|
-
{
|
2234
|
-
"name": "event",
|
2235
|
-
"type": {
|
2236
|
-
"text": "KeyboardEvent"
|
2237
|
-
},
|
2238
|
-
"description": "The keyboard event."
|
2239
|
-
}
|
2240
|
-
],
|
2241
|
-
"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."
|
2242
|
-
},
|
2243
|
-
{
|
2244
|
-
"kind": "method",
|
2245
|
-
"name": "handleKeyUp",
|
2246
|
-
"privacy": "private",
|
2247
|
-
"parameters": [
|
2248
|
-
{
|
2249
|
-
"name": "event",
|
2250
|
-
"type": {
|
2251
|
-
"text": "KeyboardEvent"
|
2252
|
-
},
|
2253
|
-
"description": "The keyboard event."
|
2254
|
-
}
|
2255
|
-
],
|
2256
|
-
"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."
|
2257
|
-
},
|
2258
|
-
{
|
2259
|
-
"kind": "field",
|
2260
|
-
"name": "name",
|
2261
|
-
"type": {
|
2262
|
-
"text": "string"
|
2263
|
-
},
|
2264
|
-
"default": "''",
|
2265
|
-
"description": "Indicates the name of the component group.\nThey are used to group elements in a form together.",
|
2266
|
-
"attribute": "name",
|
2267
|
-
"reflects": true,
|
2268
|
-
"inheritedFrom": {
|
2269
|
-
"name": "FormInternalsMixin",
|
2270
|
-
"module": "utils/mixins/FormInternalsMixin.js"
|
2271
|
-
}
|
2272
|
-
},
|
2273
|
-
{
|
2274
|
-
"kind": "field",
|
2275
|
-
"name": "value",
|
2276
|
-
"type": {
|
2277
|
-
"text": "string"
|
2278
|
-
},
|
2279
|
-
"default": "''",
|
2280
|
-
"description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
|
2281
|
-
"attribute": "value",
|
2282
|
-
"reflects": true,
|
2283
|
-
"inheritedFrom": {
|
2284
|
-
"name": "FormInternalsMixin",
|
2285
|
-
"module": "utils/mixins/FormInternalsMixin.js"
|
2286
|
-
}
|
2287
|
-
},
|
2288
|
-
{
|
2289
|
-
"kind": "field",
|
2290
|
-
"name": "validationMessage",
|
2291
|
-
"type": {
|
2292
|
-
"text": "string | undefined"
|
2293
|
-
},
|
2294
|
-
"description": "Custom validation message that will override the default message and displayed when the input is invalid.",
|
2295
|
-
"attribute": "validation-message",
|
2296
|
-
"reflects": true,
|
2297
|
-
"inheritedFrom": {
|
2298
|
-
"name": "FormInternalsMixin",
|
2299
|
-
"module": "utils/mixins/FormInternalsMixin.js"
|
2300
|
-
}
|
2301
|
-
},
|
2302
|
-
{
|
2303
|
-
"kind": "field",
|
2304
|
-
"name": "validity",
|
2305
|
-
"type": {
|
2306
|
-
"text": "ValidityState"
|
2307
|
-
},
|
2308
|
-
"readonly": true,
|
2309
|
-
"inheritedFrom": {
|
2310
|
-
"name": "FormInternalsMixin",
|
2311
|
-
"module": "utils/mixins/FormInternalsMixin.js"
|
2312
|
-
}
|
2313
|
-
},
|
2314
|
-
{
|
2315
|
-
"kind": "field",
|
2316
|
-
"name": "willValidate",
|
2317
|
-
"readonly": true,
|
2318
|
-
"inheritedFrom": {
|
2319
|
-
"name": "FormInternalsMixin",
|
2320
|
-
"module": "utils/mixins/FormInternalsMixin.js"
|
2321
|
-
}
|
2322
|
-
},
|
2323
|
-
{
|
2324
|
-
"kind": "method",
|
2325
|
-
"name": "setValidity",
|
2326
|
-
"description": "Sets the validity of the input field based on the input field's validity.",
|
2327
|
-
"return": {
|
2328
|
-
"type": {
|
2329
|
-
"text": ""
|
2330
|
-
}
|
2331
|
-
},
|
2332
|
-
"inheritedFrom": {
|
2333
|
-
"name": "FormInternalsMixin",
|
2334
|
-
"module": "utils/mixins/FormInternalsMixin.js"
|
2335
|
-
}
|
2336
|
-
},
|
2337
|
-
{
|
2338
|
-
"kind": "method",
|
2339
|
-
"name": "checkValidity",
|
2340
|
-
"return": {
|
2341
|
-
"type": {
|
2342
|
-
"text": "boolean"
|
2343
|
-
}
|
2344
|
-
},
|
2345
|
-
"inheritedFrom": {
|
2346
|
-
"name": "FormInternalsMixin",
|
2347
|
-
"module": "utils/mixins/FormInternalsMixin.js"
|
2348
|
-
}
|
2349
|
-
},
|
2350
|
-
{
|
2351
|
-
"kind": "method",
|
2352
|
-
"name": "reportValidity",
|
2353
|
-
"inheritedFrom": {
|
2354
|
-
"name": "FormInternalsMixin",
|
2355
|
-
"module": "utils/mixins/FormInternalsMixin.js"
|
2356
|
-
}
|
2357
|
-
},
|
2358
|
-
{
|
2359
|
-
"kind": "field",
|
2360
|
-
"name": "tabIndex",
|
2361
|
-
"type": {
|
2362
|
-
"text": "number"
|
2363
|
-
},
|
2364
|
-
"default": "0",
|
2365
|
-
"description": "This property specifies the tab order of the element.",
|
2366
|
-
"attribute": "tabIndex",
|
2367
|
-
"reflects": true,
|
2368
|
-
"inheritedFrom": {
|
2369
|
-
"name": "TabIndexMixin",
|
2370
|
-
"module": "utils/mixins/TabIndexMixin.js"
|
2371
|
-
}
|
2372
|
-
},
|
2373
|
-
{
|
2374
|
-
"kind": "field",
|
2375
|
-
"name": "disabled",
|
2376
|
-
"type": {
|
2377
|
-
"text": "boolean"
|
2378
|
-
},
|
2379
|
-
"default": "false",
|
2380
|
-
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
2381
|
-
"attribute": "disabled",
|
2382
|
-
"reflects": true,
|
2383
|
-
"inheritedFrom": {
|
2384
|
-
"name": "DisabledMixin",
|
2385
|
-
"module": "utils/mixins/DisabledMixin.js"
|
2386
|
-
}
|
2387
|
-
}
|
2388
|
-
],
|
2389
|
-
"events": [
|
2390
|
-
{
|
2391
|
-
"description": "(React: onClick) This event is dispatched when the button is clicked.",
|
2392
|
-
"name": "click",
|
2393
|
-
"reactName": "onClick",
|
2394
|
-
"eventName": "ClickEvent"
|
2395
|
-
},
|
2396
|
-
{
|
2397
|
-
"description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the button.",
|
2398
|
-
"name": "keydown",
|
2399
|
-
"reactName": "onKeyDown",
|
2400
|
-
"eventName": "KeydownEvent"
|
2401
|
-
},
|
2402
|
-
{
|
2403
|
-
"description": "(React: onKeyUp) This event is dispatched when a key is released on the button.",
|
2404
|
-
"name": "keyup",
|
2405
|
-
"reactName": "onKeyUp",
|
2406
|
-
"eventName": "KeyupEvent"
|
2407
|
-
},
|
2408
|
-
{
|
2409
|
-
"description": "(React: onFocus) This event is dispatched when the button receives focus.",
|
2410
|
-
"name": "focus",
|
2411
|
-
"reactName": "onFocus",
|
2412
|
-
"eventName": "FocusEvent"
|
2413
|
-
}
|
2414
|
-
],
|
2415
|
-
"attributes": [
|
2416
|
-
{
|
2417
|
-
"name": "active",
|
2418
|
-
"type": {
|
2419
|
-
"text": "boolean"
|
2420
|
-
},
|
2421
|
-
"default": "false",
|
2422
|
-
"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.",
|
2423
|
-
"fieldName": "active"
|
2424
|
-
},
|
2425
|
-
{
|
2426
|
-
"name": "soft-disabled",
|
2427
|
-
"type": {
|
2428
|
-
"text": "boolean"
|
2429
|
-
},
|
2430
|
-
"default": "false",
|
2431
|
-
"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.",
|
2432
|
-
"fieldName": "softDisabled"
|
2433
|
-
},
|
2434
|
-
{
|
2435
|
-
"name": "size",
|
2436
|
-
"type": {
|
2437
|
-
"text": "ButtonSize"
|
2438
|
-
},
|
2439
|
-
"description": "Simplebutton size is a super set of all the sizes supported by children components.",
|
2440
|
-
"default": "32",
|
2441
|
-
"fieldName": "size"
|
2442
|
-
},
|
2443
|
-
{
|
2444
|
-
"name": "role",
|
2445
|
-
"description": "This property defines the ARIA role for the element. By default, it is set to 'button'.\nConsumers should override this role when:\n- The element is being used in a context where a different role is more appropriate.\n- Custom behaviors are implemented that require a specific ARIA role for accessibility purposes.",
|
2446
|
-
"default": "button",
|
2447
|
-
"fieldName": "role"
|
2448
|
-
},
|
2449
|
-
{
|
2450
|
-
"name": "type",
|
2451
|
-
"type": {
|
2452
|
-
"text": "ButtonType"
|
2453
|
-
},
|
2454
|
-
"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.",
|
2455
|
-
"default": "button",
|
2456
|
-
"fieldName": "type"
|
2457
|
-
},
|
2458
|
-
{
|
2459
|
-
"name": "name",
|
2460
|
-
"type": {
|
2461
|
-
"text": "string"
|
2462
|
-
},
|
2463
|
-
"default": "''",
|
2464
|
-
"description": "Indicates the name of the component group.\nThey are used to group elements in a form together.",
|
2465
|
-
"fieldName": "name",
|
2466
|
-
"inheritedFrom": {
|
2467
|
-
"name": "FormInternalsMixin",
|
2468
|
-
"module": "src/utils/mixins/FormInternalsMixin.ts"
|
2469
|
-
}
|
2470
|
-
},
|
2471
|
-
{
|
2472
|
-
"name": "value",
|
2473
|
-
"type": {
|
2474
|
-
"text": "string"
|
2475
|
-
},
|
2476
|
-
"default": "''",
|
2477
|
-
"description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
|
2478
|
-
"fieldName": "value",
|
2479
|
-
"inheritedFrom": {
|
2480
|
-
"name": "FormInternalsMixin",
|
2481
|
-
"module": "src/utils/mixins/FormInternalsMixin.ts"
|
2482
|
-
}
|
2483
|
-
},
|
2484
|
-
{
|
2485
|
-
"name": "validation-message",
|
2486
|
-
"type": {
|
2487
|
-
"text": "string | undefined"
|
2488
|
-
},
|
2489
|
-
"description": "Custom validation message that will override the default message and displayed when the input is invalid.",
|
2490
|
-
"fieldName": "validationMessage",
|
2491
|
-
"inheritedFrom": {
|
2492
|
-
"name": "FormInternalsMixin",
|
2493
|
-
"module": "src/utils/mixins/FormInternalsMixin.ts"
|
2494
|
-
}
|
2495
|
-
},
|
2496
|
-
{
|
2497
|
-
"name": "tabIndex",
|
2498
|
-
"type": {
|
2499
|
-
"text": "number"
|
2500
|
-
},
|
2501
|
-
"default": "0",
|
2502
|
-
"description": "This property specifies the tab order of the element.",
|
2503
|
-
"fieldName": "tabIndex",
|
2504
|
-
"inheritedFrom": {
|
2505
|
-
"name": "TabIndexMixin",
|
2506
|
-
"module": "src/utils/mixins/TabIndexMixin.ts"
|
2507
|
-
}
|
2508
|
-
},
|
2509
|
-
{
|
2510
|
-
"name": "disabled",
|
2511
|
-
"type": {
|
2512
|
-
"text": "boolean"
|
2513
|
-
},
|
2514
|
-
"default": "false",
|
2515
|
-
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
2516
|
-
"fieldName": "disabled",
|
2517
|
-
"inheritedFrom": {
|
2518
|
-
"name": "DisabledMixin",
|
2519
|
-
"module": "src/utils/mixins/DisabledMixin.ts"
|
2520
|
-
}
|
2521
|
-
}
|
2522
|
-
],
|
2523
|
-
"mixins": [
|
2524
|
-
{
|
2525
|
-
"name": "FormInternalsMixin",
|
2526
|
-
"module": "/src/utils/mixins/FormInternalsMixin"
|
2527
|
-
},
|
2528
|
-
{
|
2529
|
-
"name": "TabIndexMixin",
|
2530
|
-
"module": "/src/utils/mixins/TabIndexMixin"
|
1542
|
+
}
|
1543
|
+
],
|
1544
|
+
"mixins": [
|
1545
|
+
{
|
1546
|
+
"name": "TabIndexMixin",
|
1547
|
+
"module": "/src/utils/mixins/TabIndexMixin"
|
2531
1548
|
},
|
2532
1549
|
{
|
2533
1550
|
"name": "DisabledMixin",
|
@@ -2732,20 +1749,6 @@
|
|
2732
1749
|
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
2733
1750
|
}
|
2734
1751
|
},
|
2735
|
-
{
|
2736
|
-
"kind": "field",
|
2737
|
-
"name": "id",
|
2738
|
-
"type": {
|
2739
|
-
"text": "string"
|
2740
|
-
},
|
2741
|
-
"default": "`mdc-input-${uuidv4()}`",
|
2742
|
-
"description": "The unique id of the input field. It is used to link the input field with the label.",
|
2743
|
-
"attribute": "id",
|
2744
|
-
"inheritedFrom": {
|
2745
|
-
"name": "FormfieldWrapper",
|
2746
|
-
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
2747
|
-
}
|
2748
|
-
},
|
2749
1752
|
{
|
2750
1753
|
"kind": "field",
|
2751
1754
|
"name": "name",
|
@@ -2846,6 +1849,20 @@
|
|
2846
1849
|
"module": "utils/mixins/FormInternalsMixin.js"
|
2847
1850
|
}
|
2848
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
|
+
}
|
1865
|
+
},
|
2849
1866
|
{
|
2850
1867
|
"kind": "field",
|
2851
1868
|
"name": "dataAriaLabel",
|
@@ -4747,20 +3764,6 @@
|
|
4747
3764
|
}
|
4748
3765
|
}
|
4749
3766
|
},
|
4750
|
-
{
|
4751
|
-
"kind": "field",
|
4752
|
-
"name": "id",
|
4753
|
-
"type": {
|
4754
|
-
"text": "string"
|
4755
|
-
},
|
4756
|
-
"default": "`mdc-input-${uuidv4()}`",
|
4757
|
-
"description": "The unique id of the input field. It is used to link the input field with the label.",
|
4758
|
-
"attribute": "id",
|
4759
|
-
"inheritedFrom": {
|
4760
|
-
"name": "FormfieldWrapper",
|
4761
|
-
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
4762
|
-
}
|
4763
|
-
},
|
4764
3767
|
{
|
4765
3768
|
"kind": "field",
|
4766
3769
|
"name": "name",
|
@@ -4861,6 +3864,20 @@
|
|
4861
3864
|
"module": "utils/mixins/FormInternalsMixin.js"
|
4862
3865
|
}
|
4863
3866
|
},
|
3867
|
+
{
|
3868
|
+
"kind": "field",
|
3869
|
+
"name": "id",
|
3870
|
+
"type": {
|
3871
|
+
"text": "string"
|
3872
|
+
},
|
3873
|
+
"default": "`mdc-input-${uuidv4()}`",
|
3874
|
+
"description": "The unique id of the input field. It is used to link the input field with the label.",
|
3875
|
+
"attribute": "id",
|
3876
|
+
"inheritedFrom": {
|
3877
|
+
"name": "FormfieldWrapper",
|
3878
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
3879
|
+
}
|
3880
|
+
},
|
4864
3881
|
{
|
4865
3882
|
"kind": "field",
|
4866
3883
|
"name": "dataAriaLabel",
|
@@ -7818,475 +6835,899 @@
|
|
7818
6835
|
},
|
7819
6836
|
{
|
7820
6837
|
"kind": "field",
|
7821
|
-
"name": "size",
|
6838
|
+
"name": "size",
|
6839
|
+
"type": {
|
6840
|
+
"text": "PresenceSize"
|
6841
|
+
},
|
6842
|
+
"description": "Acceptable values include:\n- XX_SMALL\n- X_SMALL\n- SMALL\n- MIDSIZE\n- LARGE\n- X_LARGE\n- XX_LARGE\n\nPresence icons are minimum 14px in size, meaning XX_Small, X_Small and Small presence\nicons will be no smaller than 14px.",
|
6843
|
+
"default": "small",
|
6844
|
+
"attribute": "size",
|
6845
|
+
"reflects": true
|
6846
|
+
},
|
6847
|
+
{
|
6848
|
+
"kind": "field",
|
6849
|
+
"name": "iconSize",
|
6850
|
+
"privacy": "private",
|
6851
|
+
"description": "Get the size of the presence icon based on the given size type",
|
6852
|
+
"readonly": true
|
6853
|
+
},
|
6854
|
+
{
|
6855
|
+
"kind": "field",
|
6856
|
+
"name": "icon",
|
6857
|
+
"privacy": "private",
|
6858
|
+
"description": "Get the icon name based on the presence type",
|
6859
|
+
"readonly": true
|
6860
|
+
},
|
6861
|
+
{
|
6862
|
+
"kind": "method",
|
6863
|
+
"name": "handleOnLoad",
|
6864
|
+
"privacy": "private",
|
6865
|
+
"return": {
|
6866
|
+
"type": {
|
6867
|
+
"text": "void"
|
6868
|
+
}
|
6869
|
+
},
|
6870
|
+
"description": "Handles the successful load of an icon.\nSets the `currentIconType` property to match the `type` property."
|
6871
|
+
},
|
6872
|
+
{
|
6873
|
+
"kind": "method",
|
6874
|
+
"name": "handleOnError",
|
6875
|
+
"privacy": "private",
|
6876
|
+
"return": {
|
6877
|
+
"type": {
|
6878
|
+
"text": "void"
|
6879
|
+
}
|
6880
|
+
},
|
6881
|
+
"description": "Handles an error that occurs when loading an icon."
|
6882
|
+
}
|
6883
|
+
],
|
6884
|
+
"attributes": [
|
6885
|
+
{
|
6886
|
+
"name": "type",
|
6887
|
+
"type": {
|
6888
|
+
"text": "PresenceType"
|
6889
|
+
},
|
6890
|
+
"description": "Supported presence types:\n- `active`\n- `away`\n- `away-calling`\n- `busy`\n- `dnd`\n- `meeting`\n- `on-call`\n- `on-device`\n- `on-mobile`\n- `pause`\n- `pto`\n- `presenting`\n- `quiet`\n- `scheduled`",
|
6891
|
+
"default": "active",
|
6892
|
+
"fieldName": "type"
|
6893
|
+
},
|
6894
|
+
{
|
6895
|
+
"name": "size",
|
6896
|
+
"type": {
|
6897
|
+
"text": "PresenceSize"
|
6898
|
+
},
|
6899
|
+
"description": "Acceptable values include:\n- XX_SMALL\n- X_SMALL\n- SMALL\n- MIDSIZE\n- LARGE\n- X_LARGE\n- XX_LARGE\n\nPresence icons are minimum 14px in size, meaning XX_Small, X_Small and Small presence\nicons will be no smaller than 14px.",
|
6900
|
+
"default": "small",
|
6901
|
+
"fieldName": "size"
|
6902
|
+
}
|
6903
|
+
],
|
6904
|
+
"superclass": {
|
6905
|
+
"name": "Component",
|
6906
|
+
"module": "/src/models"
|
6907
|
+
},
|
6908
|
+
"tagName": "mdc-presence",
|
6909
|
+
"jsDoc": "/**\n * The `mdc-presence` component is a versatile UI element used to\n * display the presence status of a user or entity within an avatar component.\n *\n * This component is ideal for use within avatar UIs where the presence status\n * needs to be visually represented.\n *\n * @dependency mdc-icon\n *\n * @tagname mdc-presence\n *\n * @cssproperty --mdc-presence-active-background-color - The background color of the presence type active.\n * @cssproperty --mdc-presence-away-background-color - The background color of the presence type away.\n * @cssproperty --mdc-presence-away-calling-background-color - The background color of the presence type away-calling.\n * @cssproperty --mdc-presence-busy-background-color - The background color of the presence type busy.\n * @cssproperty --mdc-presence-dnd-background-color - The background color of the presence type dnd.\n * @cssproperty --mdc-presence-meeting-background-color - The background color of the presence type meeting.\n * @cssproperty --mdc-presence-on-call-background-color - The background color of the presence type on-call.\n * @cssproperty --mdc-presence-on-device-background-color - The background color of the presence type on-device.\n * @cssproperty --mdc-presence-on-mobile-background-color - The background color of the presence type on-mobile.\n * @cssproperty --mdc-presence-pause-background-color - The background color of the presence type pause.\n * @cssproperty --mdc-presence-pto-background-color - The background color of the presence type pto.\n * @cssproperty --mdc-presence-presenting-background-color - The background color of the presence type presenting.\n * @cssproperty --mdc-presence-quiet-background-color - The background color of the presence type quiet.\n * @cssproperty --mdc-presence-scheduled-background-color - The background color of the presence type scheduled.\n * @cssproperty --mdc-presence-overlay-background-color - The background color of the presence type overlay.\n */",
|
6910
|
+
"customElement": true
|
6911
|
+
}
|
6912
|
+
],
|
6913
|
+
"exports": [
|
6914
|
+
{
|
6915
|
+
"kind": "js",
|
6916
|
+
"name": "default",
|
6917
|
+
"declaration": {
|
6918
|
+
"name": "Presence",
|
6919
|
+
"module": "components/presence/presence.component.js"
|
6920
|
+
}
|
6921
|
+
}
|
6922
|
+
]
|
6923
|
+
},
|
6924
|
+
{
|
6925
|
+
"kind": "javascript-module",
|
6926
|
+
"path": "components/radio/radio.component.js",
|
6927
|
+
"declarations": [
|
6928
|
+
{
|
6929
|
+
"kind": "class",
|
6930
|
+
"description": "Radio allow users to select single options from a list or turn an item/feature on or off.\nThese are often used in forms, settings, and selection in lists.\n\nA radio component contains an optional label, optional info icon and an optional helper text.",
|
6931
|
+
"name": "Radio",
|
6932
|
+
"cssProperties": [
|
6933
|
+
{
|
6934
|
+
"description": "size of the inner circle",
|
6935
|
+
"name": "--mdc-radio-inner-circle-size"
|
6936
|
+
},
|
6937
|
+
{
|
6938
|
+
"description": "color of the label when disabled",
|
6939
|
+
"name": "--mdc-radio-text-disabled-color"
|
6940
|
+
},
|
6941
|
+
{
|
6942
|
+
"description": "color of the radio button border when disabled",
|
6943
|
+
"name": "--mdc-radio-disabled-border-color"
|
6944
|
+
},
|
6945
|
+
{
|
6946
|
+
"description": "color of the radio button border when normal",
|
6947
|
+
"name": "--mdc-radio-normal-border-color"
|
6948
|
+
},
|
6949
|
+
{
|
6950
|
+
"description": "background color of the inner circle when normal",
|
6951
|
+
"name": "--mdc-radio-inner-circle-normal-background"
|
6952
|
+
},
|
6953
|
+
{
|
6954
|
+
"description": "background color of the inner circle when disabled",
|
6955
|
+
"name": "--mdc-radio-inner-circle-disabled-background"
|
6956
|
+
},
|
6957
|
+
{
|
6958
|
+
"description": "color of the radio button when inactive",
|
6959
|
+
"name": "--mdc-radio-control-inactive-color"
|
6960
|
+
},
|
6961
|
+
{
|
6962
|
+
"description": "color of the radio button when inactive and hovered",
|
6963
|
+
"name": "--mdc-radio-control-inactive-hover"
|
6964
|
+
},
|
6965
|
+
{
|
6966
|
+
"description": "color of the radio button when inactive and pressed",
|
6967
|
+
"name": "--mdc-radio-control-inactive-pressed-color"
|
6968
|
+
},
|
6969
|
+
{
|
6970
|
+
"description": "background color of the radio button when inactive and disabled",
|
6971
|
+
"name": "--mdc-radio-control-inactive-disabled-background"
|
6972
|
+
},
|
6973
|
+
{
|
6974
|
+
"description": "color of the radio button when active",
|
6975
|
+
"name": "--mdc-radio-control-active-color"
|
6976
|
+
},
|
6977
|
+
{
|
6978
|
+
"description": "color of the radio button when active and hovered",
|
6979
|
+
"name": "--mdc-radio-control-active-hover-color"
|
6980
|
+
},
|
6981
|
+
{
|
6982
|
+
"description": "color of the radio button when active and pressed",
|
6983
|
+
"name": "--mdc-radio-control-active-pressed-color"
|
6984
|
+
},
|
6985
|
+
{
|
6986
|
+
"description": "background color of the radio button when active and disabled",
|
6987
|
+
"name": "--mdc-radio-control-active-disabled-background"
|
6988
|
+
}
|
6989
|
+
],
|
6990
|
+
"members": [
|
6991
|
+
{
|
6992
|
+
"kind": "field",
|
6993
|
+
"name": "checked",
|
6994
|
+
"type": {
|
6995
|
+
"text": "boolean"
|
6996
|
+
},
|
6997
|
+
"default": "false",
|
6998
|
+
"description": "Determines whether the radio is selected or unselected.",
|
6999
|
+
"attribute": "checked",
|
7000
|
+
"reflects": true
|
7001
|
+
},
|
7002
|
+
{
|
7003
|
+
"kind": "field",
|
7004
|
+
"name": "readonly",
|
7822
7005
|
"type": {
|
7823
|
-
"text": "
|
7006
|
+
"text": "boolean"
|
7824
7007
|
},
|
7825
|
-
"
|
7826
|
-
"
|
7827
|
-
"attribute": "
|
7008
|
+
"default": "false",
|
7009
|
+
"description": "Determines whether the radio is read-only.",
|
7010
|
+
"attribute": "readonly",
|
7828
7011
|
"reflects": true
|
7829
7012
|
},
|
7830
7013
|
{
|
7831
7014
|
"kind": "field",
|
7832
|
-
"name": "
|
7833
|
-
"
|
7834
|
-
|
7835
|
-
|
7015
|
+
"name": "autofocus",
|
7016
|
+
"type": {
|
7017
|
+
"text": "boolean"
|
7018
|
+
},
|
7019
|
+
"default": "false",
|
7020
|
+
"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)",
|
7021
|
+
"attribute": "autofocus",
|
7022
|
+
"reflects": true
|
7836
7023
|
},
|
7837
7024
|
{
|
7838
|
-
"kind": "
|
7839
|
-
"name": "
|
7025
|
+
"kind": "method",
|
7026
|
+
"name": "getAllRadiosWithinSameGroup",
|
7840
7027
|
"privacy": "private",
|
7841
|
-
"
|
7842
|
-
|
7028
|
+
"return": {
|
7029
|
+
"type": {
|
7030
|
+
"text": "Radio[]"
|
7031
|
+
}
|
7032
|
+
},
|
7033
|
+
"description": "Returns all radios within the same group (name)."
|
7843
7034
|
},
|
7844
7035
|
{
|
7845
7036
|
"kind": "method",
|
7846
|
-
"name": "
|
7037
|
+
"name": "dispatchChangeEvent",
|
7847
7038
|
"privacy": "private",
|
7848
7039
|
"return": {
|
7849
7040
|
"type": {
|
7850
7041
|
"text": "void"
|
7851
7042
|
}
|
7852
7043
|
},
|
7853
|
-
"
|
7044
|
+
"parameters": [
|
7045
|
+
{
|
7046
|
+
"name": "event",
|
7047
|
+
"type": {
|
7048
|
+
"text": "Event"
|
7049
|
+
}
|
7050
|
+
}
|
7051
|
+
],
|
7052
|
+
"description": "The 'change' event does not bubble up through the shadow DOM as it was not composed.\nTherefore, we need to re-dispatch the same event to ensure it is propagated correctly.\nRead more: https://developer.mozilla.org/en-US/docs/Web/API/Event/composed"
|
7854
7053
|
},
|
7855
7054
|
{
|
7856
7055
|
"kind": "method",
|
7857
|
-
"name": "
|
7056
|
+
"name": "setGroupValidity",
|
7057
|
+
"privacy": "private",
|
7058
|
+
"parameters": [
|
7059
|
+
{
|
7060
|
+
"name": "radios",
|
7061
|
+
"type": {
|
7062
|
+
"text": "Radio[]"
|
7063
|
+
},
|
7064
|
+
"description": "Array of radios of the same group"
|
7065
|
+
},
|
7066
|
+
{
|
7067
|
+
"name": "isValid",
|
7068
|
+
"type": {
|
7069
|
+
"text": "boolean"
|
7070
|
+
},
|
7071
|
+
"description": "Boolean value to set the validity of the group"
|
7072
|
+
}
|
7073
|
+
],
|
7074
|
+
"description": "Sets the validity of the group of radios."
|
7075
|
+
},
|
7076
|
+
{
|
7077
|
+
"kind": "method",
|
7078
|
+
"name": "setActualFormValue",
|
7079
|
+
"privacy": "private",
|
7080
|
+
"description": "Updates the form value to reflect the current state of the radio.\nIf checked, the value is set to the user-provided value.\nIf unchecked, the value is set to null."
|
7081
|
+
},
|
7082
|
+
{
|
7083
|
+
"kind": "method",
|
7084
|
+
"name": "handleChange",
|
7858
7085
|
"privacy": "private",
|
7859
7086
|
"return": {
|
7860
7087
|
"type": {
|
7861
7088
|
"text": "void"
|
7862
7089
|
}
|
7863
7090
|
},
|
7864
|
-
"
|
7865
|
-
|
7866
|
-
|
7867
|
-
|
7091
|
+
"parameters": [
|
7092
|
+
{
|
7093
|
+
"name": "event",
|
7094
|
+
"type": {
|
7095
|
+
"text": "Event"
|
7096
|
+
}
|
7097
|
+
}
|
7098
|
+
],
|
7099
|
+
"description": "Handles the change event on the radio element.\nThis will toggle the state of the radio element.\nDispatches the change event."
|
7100
|
+
},
|
7868
7101
|
{
|
7869
|
-
"
|
7870
|
-
"
|
7871
|
-
|
7872
|
-
|
7873
|
-
|
7874
|
-
|
7875
|
-
|
7102
|
+
"kind": "method",
|
7103
|
+
"name": "updateRadio",
|
7104
|
+
"privacy": "private",
|
7105
|
+
"parameters": [
|
7106
|
+
{
|
7107
|
+
"name": "enabledRadios",
|
7108
|
+
"type": {
|
7109
|
+
"text": "Radio[]"
|
7110
|
+
},
|
7111
|
+
"description": "An array of enabled radio buttons within the same group."
|
7112
|
+
},
|
7113
|
+
{
|
7114
|
+
"name": "index",
|
7115
|
+
"type": {
|
7116
|
+
"text": "number"
|
7117
|
+
},
|
7118
|
+
"description": "The index of the radio button to be updated within the enabled radios array."
|
7119
|
+
},
|
7120
|
+
{
|
7121
|
+
"name": "event",
|
7122
|
+
"type": {
|
7123
|
+
"text": "Event"
|
7124
|
+
},
|
7125
|
+
"description": "The event that triggered the update."
|
7126
|
+
}
|
7127
|
+
],
|
7128
|
+
"description": "Updates the state of the radio button at the specified index within the enabled radios.\nFocuses the radio button and triggers the change event if the radio button is not read-only."
|
7876
7129
|
},
|
7877
7130
|
{
|
7878
|
-
"
|
7879
|
-
"
|
7880
|
-
|
7131
|
+
"kind": "method",
|
7132
|
+
"name": "handleKeyDown",
|
7133
|
+
"privacy": "private",
|
7134
|
+
"return": {
|
7135
|
+
"type": {
|
7136
|
+
"text": "void"
|
7137
|
+
}
|
7881
7138
|
},
|
7882
|
-
"
|
7883
|
-
|
7884
|
-
|
7885
|
-
|
7886
|
-
|
7887
|
-
|
7888
|
-
|
7889
|
-
|
7890
|
-
|
7891
|
-
"tagName": "mdc-presence",
|
7892
|
-
"jsDoc": "/**\n * The `mdc-presence` component is a versatile UI element used to\n * display the presence status of a user or entity within an avatar component.\n *\n * This component is ideal for use within avatar UIs where the presence status\n * needs to be visually represented.\n *\n * @dependency mdc-icon\n *\n * @tagname mdc-presence\n *\n * @cssproperty --mdc-presence-active-background-color - The background color of the presence type active.\n * @cssproperty --mdc-presence-away-background-color - The background color of the presence type away.\n * @cssproperty --mdc-presence-away-calling-background-color - The background color of the presence type away-calling.\n * @cssproperty --mdc-presence-busy-background-color - The background color of the presence type busy.\n * @cssproperty --mdc-presence-dnd-background-color - The background color of the presence type dnd.\n * @cssproperty --mdc-presence-meeting-background-color - The background color of the presence type meeting.\n * @cssproperty --mdc-presence-on-call-background-color - The background color of the presence type on-call.\n * @cssproperty --mdc-presence-on-device-background-color - The background color of the presence type on-device.\n * @cssproperty --mdc-presence-on-mobile-background-color - The background color of the presence type on-mobile.\n * @cssproperty --mdc-presence-pause-background-color - The background color of the presence type pause.\n * @cssproperty --mdc-presence-pto-background-color - The background color of the presence type pto.\n * @cssproperty --mdc-presence-presenting-background-color - The background color of the presence type presenting.\n * @cssproperty --mdc-presence-quiet-background-color - The background color of the presence type quiet.\n * @cssproperty --mdc-presence-scheduled-background-color - The background color of the presence type scheduled.\n * @cssproperty --mdc-presence-overlay-background-color - The background color of the presence type overlay.\n */",
|
7893
|
-
"customElement": true
|
7894
|
-
}
|
7895
|
-
],
|
7896
|
-
"exports": [
|
7897
|
-
{
|
7898
|
-
"kind": "js",
|
7899
|
-
"name": "default",
|
7900
|
-
"declaration": {
|
7901
|
-
"name": "Presence",
|
7902
|
-
"module": "components/presence/presence.component.js"
|
7903
|
-
}
|
7904
|
-
}
|
7905
|
-
]
|
7906
|
-
},
|
7907
|
-
{
|
7908
|
-
"kind": "javascript-module",
|
7909
|
-
"path": "components/radio/radio.component.js",
|
7910
|
-
"declarations": [
|
7911
|
-
{
|
7912
|
-
"kind": "class",
|
7913
|
-
"description": "Radio allow users to select single options from a list or turn an item/feature on or off.\nThese are often used in forms, settings, and selection in lists.\n\nA radio component contains an optional label, optional info icon and an optional helper text.",
|
7914
|
-
"name": "Radio",
|
7915
|
-
"cssProperties": [
|
7916
|
-
{
|
7917
|
-
"description": "size of the inner circle",
|
7918
|
-
"name": "--mdc-radio-inner-circle-size"
|
7139
|
+
"parameters": [
|
7140
|
+
{
|
7141
|
+
"name": "event",
|
7142
|
+
"type": {
|
7143
|
+
"text": "KeyboardEvent"
|
7144
|
+
}
|
7145
|
+
}
|
7146
|
+
],
|
7147
|
+
"description": "Handles the keydown event (Arrow Up/Down/Left/Right) on the radio element."
|
7919
7148
|
},
|
7920
7149
|
{
|
7921
|
-
"
|
7922
|
-
"name": "
|
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"
|
7923
7159
|
},
|
7924
7160
|
{
|
7925
|
-
"
|
7926
|
-
"name": "
|
7161
|
+
"kind": "field",
|
7162
|
+
"name": "renderLabelAndHelperText",
|
7163
|
+
"privacy": "private"
|
7927
7164
|
},
|
7928
7165
|
{
|
7929
|
-
"
|
7930
|
-
"name": "
|
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
|
+
}
|
7931
7179
|
},
|
7932
7180
|
{
|
7933
|
-
"
|
7934
|
-
"name": "
|
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
|
+
}
|
7935
7194
|
},
|
7936
7195
|
{
|
7937
|
-
"
|
7938
|
-
"name": "
|
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
|
+
}
|
7939
7209
|
},
|
7940
7210
|
{
|
7941
|
-
"
|
7942
|
-
"name": "
|
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
|
+
}
|
7943
7223
|
},
|
7944
7224
|
{
|
7945
|
-
"
|
7946
|
-
"name": "
|
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
|
+
}
|
7947
7235
|
},
|
7948
7236
|
{
|
7949
|
-
"
|
7950
|
-
"name": "
|
7237
|
+
"kind": "field",
|
7238
|
+
"name": "willValidate",
|
7239
|
+
"readonly": true,
|
7240
|
+
"inheritedFrom": {
|
7241
|
+
"name": "FormInternalsMixin",
|
7242
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
7243
|
+
}
|
7951
7244
|
},
|
7952
7245
|
{
|
7953
|
-
"
|
7954
|
-
"name": "
|
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
|
+
}
|
7955
7258
|
},
|
7956
7259
|
{
|
7957
|
-
"
|
7958
|
-
"name": "
|
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
|
+
}
|
7959
7271
|
},
|
7960
7272
|
{
|
7961
|
-
"
|
7962
|
-
"name": "
|
7273
|
+
"kind": "method",
|
7274
|
+
"name": "reportValidity",
|
7275
|
+
"inheritedFrom": {
|
7276
|
+
"name": "FormInternalsMixin",
|
7277
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
7278
|
+
}
|
7963
7279
|
},
|
7964
7280
|
{
|
7965
|
-
"
|
7966
|
-
"name": "
|
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
|
+
}
|
7967
7293
|
},
|
7968
7294
|
{
|
7969
|
-
"
|
7970
|
-
"name": "
|
7971
|
-
|
7972
|
-
|
7973
|
-
|
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
|
+
},
|
7974
7309
|
{
|
7975
7310
|
"kind": "field",
|
7976
|
-
"name": "
|
7311
|
+
"name": "disabled",
|
7977
7312
|
"type": {
|
7978
7313
|
"text": "boolean"
|
7979
7314
|
},
|
7980
7315
|
"default": "false",
|
7981
|
-
"description": "
|
7982
|
-
"attribute": "
|
7983
|
-
"reflects": true
|
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
|
+
}
|
7984
7323
|
},
|
7985
7324
|
{
|
7986
7325
|
"kind": "field",
|
7987
|
-
"name": "
|
7326
|
+
"name": "label",
|
7988
7327
|
"type": {
|
7989
|
-
"text": "
|
7328
|
+
"text": "string | undefined"
|
7990
7329
|
},
|
7991
|
-
"
|
7992
|
-
"
|
7993
|
-
"
|
7994
|
-
"
|
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
|
+
}
|
7995
7337
|
},
|
7996
7338
|
{
|
7997
7339
|
"kind": "field",
|
7998
|
-
"name": "
|
7340
|
+
"name": "requiredLabel",
|
7999
7341
|
"type": {
|
8000
|
-
"text": "
|
7342
|
+
"text": "string | undefined"
|
8001
7343
|
},
|
8002
|
-
"
|
8003
|
-
"
|
8004
|
-
"
|
8005
|
-
"
|
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
|
+
}
|
8006
7351
|
},
|
8007
7352
|
{
|
8008
|
-
"kind": "
|
8009
|
-
"name": "
|
8010
|
-
"
|
8011
|
-
|
8012
|
-
"type": {
|
8013
|
-
"text": "Radio[]"
|
8014
|
-
}
|
7353
|
+
"kind": "field",
|
7354
|
+
"name": "helpText",
|
7355
|
+
"type": {
|
7356
|
+
"text": "string | undefined"
|
8015
7357
|
},
|
8016
|
-
"description": "
|
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
|
+
}
|
8017
7365
|
},
|
8018
7366
|
{
|
8019
7367
|
"kind": "method",
|
8020
|
-
"name": "
|
8021
|
-
"privacy": "
|
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.",
|
8022
7371
|
"return": {
|
8023
7372
|
"type": {
|
8024
|
-
"text": "
|
7373
|
+
"text": ""
|
8025
7374
|
}
|
8026
7375
|
},
|
8027
|
-
"
|
8028
|
-
|
8029
|
-
|
8030
|
-
|
8031
|
-
"text": "Event"
|
8032
|
-
}
|
8033
|
-
}
|
8034
|
-
],
|
8035
|
-
"description": "The 'change' event does not bubble up through the shadow DOM as it was not composed.\nTherefore, we need to re-dispatch the same event to ensure it is propagated correctly.\nRead more: https://developer.mozilla.org/en-US/docs/Web/API/Event/composed"
|
8036
|
-
},
|
8037
|
-
{
|
8038
|
-
"kind": "method",
|
8039
|
-
"name": "setGroupValidity",
|
8040
|
-
"privacy": "private",
|
8041
|
-
"parameters": [
|
8042
|
-
{
|
8043
|
-
"name": "radios",
|
8044
|
-
"type": {
|
8045
|
-
"text": "Radio[]"
|
8046
|
-
},
|
8047
|
-
"description": "Array of radios of the same group"
|
8048
|
-
},
|
8049
|
-
{
|
8050
|
-
"name": "isValid",
|
8051
|
-
"type": {
|
8052
|
-
"text": "boolean"
|
8053
|
-
},
|
8054
|
-
"description": "Boolean value to set the validity of the group"
|
8055
|
-
}
|
8056
|
-
],
|
8057
|
-
"description": "Sets the validity of the group of radios."
|
7376
|
+
"inheritedFrom": {
|
7377
|
+
"name": "FormfieldWrapper",
|
7378
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
7379
|
+
}
|
8058
7380
|
},
|
8059
7381
|
{
|
8060
7382
|
"kind": "method",
|
8061
|
-
"name": "
|
8062
|
-
"privacy": "
|
8063
|
-
"
|
7383
|
+
"name": "renderRequiredLabel",
|
7384
|
+
"privacy": "protected",
|
7385
|
+
"inheritedFrom": {
|
7386
|
+
"name": "FormfieldWrapper",
|
7387
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
7388
|
+
}
|
8064
7389
|
},
|
8065
7390
|
{
|
8066
7391
|
"kind": "method",
|
8067
|
-
"name": "
|
8068
|
-
"privacy": "
|
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.",
|
8069
7395
|
"return": {
|
8070
7396
|
"type": {
|
8071
|
-
"text": "
|
7397
|
+
"text": ""
|
8072
7398
|
}
|
8073
7399
|
},
|
8074
|
-
"
|
8075
|
-
|
8076
|
-
|
8077
|
-
|
8078
|
-
"text": "Event"
|
8079
|
-
}
|
8080
|
-
}
|
8081
|
-
],
|
8082
|
-
"description": "Handles the change event on the radio element.\nThis will toggle the state of the radio element.\nDispatches the change event."
|
7400
|
+
"inheritedFrom": {
|
7401
|
+
"name": "FormfieldWrapper",
|
7402
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
7403
|
+
}
|
8083
7404
|
},
|
8084
7405
|
{
|
8085
7406
|
"kind": "method",
|
8086
|
-
"name": "
|
8087
|
-
"privacy": "
|
8088
|
-
"
|
8089
|
-
|
8090
|
-
|
8091
|
-
"
|
8092
|
-
"text": "Radio[]"
|
8093
|
-
},
|
8094
|
-
"description": "An array of enabled radio buttons within the same group."
|
8095
|
-
},
|
8096
|
-
{
|
8097
|
-
"name": "index",
|
8098
|
-
"type": {
|
8099
|
-
"text": "number"
|
8100
|
-
},
|
8101
|
-
"description": "The index of the radio button to be updated within the enabled radios array."
|
8102
|
-
},
|
8103
|
-
{
|
8104
|
-
"name": "event",
|
8105
|
-
"type": {
|
8106
|
-
"text": "Event"
|
8107
|
-
},
|
8108
|
-
"description": "The event that triggered the update."
|
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": ""
|
8109
7413
|
}
|
8110
|
-
|
8111
|
-
"
|
7414
|
+
},
|
7415
|
+
"inheritedFrom": {
|
7416
|
+
"name": "FormfieldWrapper",
|
7417
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
7418
|
+
}
|
8112
7419
|
},
|
8113
7420
|
{
|
8114
7421
|
"kind": "method",
|
8115
|
-
"name": "
|
8116
|
-
"privacy": "
|
7422
|
+
"name": "renderLabel",
|
7423
|
+
"privacy": "protected",
|
7424
|
+
"description": "renders the mdc-label-text container that contains the label and labelInfoToggleTip.",
|
8117
7425
|
"return": {
|
8118
7426
|
"type": {
|
8119
|
-
"text": "
|
7427
|
+
"text": ""
|
8120
7428
|
}
|
8121
7429
|
},
|
8122
|
-
"
|
8123
|
-
|
8124
|
-
|
8125
|
-
|
8126
|
-
"text": "KeyboardEvent"
|
8127
|
-
}
|
8128
|
-
}
|
8129
|
-
],
|
8130
|
-
"description": "Handles the keydown event (Arrow Up/Down/Left/Right) on the radio element."
|
7430
|
+
"inheritedFrom": {
|
7431
|
+
"name": "FormfieldWrapper",
|
7432
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
7433
|
+
}
|
8131
7434
|
},
|
8132
7435
|
{
|
8133
7436
|
"kind": "method",
|
8134
|
-
"name": "
|
8135
|
-
"privacy": "
|
7437
|
+
"name": "renderHelperText",
|
7438
|
+
"privacy": "protected",
|
7439
|
+
"description": "renders the mdc-help-text container that contains the helpertext icon and helpertext.",
|
8136
7440
|
"return": {
|
8137
7441
|
"type": {
|
8138
|
-
"text": "
|
7442
|
+
"text": ""
|
8139
7443
|
}
|
8140
7444
|
},
|
8141
|
-
"
|
7445
|
+
"inheritedFrom": {
|
7446
|
+
"name": "FormfieldWrapper",
|
7447
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
7448
|
+
}
|
7449
|
+
}
|
7450
|
+
],
|
7451
|
+
"events": [
|
7452
|
+
{
|
7453
|
+
"type": {
|
7454
|
+
"text": "EventConstructor"
|
7455
|
+
}
|
8142
7456
|
},
|
8143
7457
|
{
|
8144
|
-
"
|
8145
|
-
"name": "
|
8146
|
-
"
|
7458
|
+
"description": "(React: onChange) Event that gets dispatched when the radio state changes.",
|
7459
|
+
"name": "change",
|
7460
|
+
"reactName": "onChange",
|
7461
|
+
"eventName": "ChangeEvent"
|
8147
7462
|
},
|
8148
7463
|
{
|
8149
|
-
"
|
8150
|
-
"name": "
|
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",
|
8151
7473
|
"type": {
|
8152
|
-
"text": "
|
7474
|
+
"text": "boolean"
|
8153
7475
|
},
|
8154
|
-
"
|
8155
|
-
"
|
8156
|
-
"
|
8157
|
-
"default": "undefined as unknown",
|
8158
|
-
"inheritedFrom": {
|
8159
|
-
"name": "FormfieldWrapper",
|
8160
|
-
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
8161
|
-
}
|
7476
|
+
"default": "false",
|
7477
|
+
"description": "Determines whether the radio is selected or unselected.",
|
7478
|
+
"fieldName": "checked"
|
8162
7479
|
},
|
8163
7480
|
{
|
8164
|
-
"
|
8165
|
-
"name": "id",
|
7481
|
+
"name": "readonly",
|
8166
7482
|
"type": {
|
8167
|
-
"text": "
|
7483
|
+
"text": "boolean"
|
8168
7484
|
},
|
8169
|
-
"default": "
|
8170
|
-
"description": "
|
8171
|
-
"
|
8172
|
-
|
8173
|
-
|
8174
|
-
|
8175
|
-
|
7485
|
+
"default": "false",
|
7486
|
+
"description": "Determines whether the radio is read-only.",
|
7487
|
+
"fieldName": "readonly"
|
7488
|
+
},
|
7489
|
+
{
|
7490
|
+
"name": "autofocus",
|
7491
|
+
"type": {
|
7492
|
+
"text": "boolean"
|
7493
|
+
},
|
7494
|
+
"default": "false",
|
7495
|
+
"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)",
|
7496
|
+
"fieldName": "autofocus"
|
8176
7497
|
},
|
8177
7498
|
{
|
8178
|
-
"kind": "field",
|
8179
7499
|
"name": "name",
|
8180
7500
|
"type": {
|
8181
7501
|
"text": "string"
|
8182
7502
|
},
|
8183
7503
|
"default": "''",
|
8184
7504
|
"description": "Indicates the name of the component group.\nThey are used to group elements in a form together.",
|
8185
|
-
"
|
8186
|
-
"reflects": true,
|
7505
|
+
"fieldName": "name",
|
8187
7506
|
"inheritedFrom": {
|
8188
7507
|
"name": "FormInternalsMixin",
|
8189
|
-
"module": "utils/mixins/FormInternalsMixin.
|
7508
|
+
"module": "src/utils/mixins/FormInternalsMixin.ts"
|
8190
7509
|
}
|
8191
7510
|
},
|
8192
7511
|
{
|
8193
|
-
"kind": "field",
|
8194
7512
|
"name": "value",
|
8195
7513
|
"type": {
|
8196
7514
|
"text": "string"
|
8197
7515
|
},
|
8198
7516
|
"default": "''",
|
8199
7517
|
"description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
|
8200
|
-
"
|
8201
|
-
"reflects": true,
|
7518
|
+
"fieldName": "value",
|
8202
7519
|
"inheritedFrom": {
|
8203
7520
|
"name": "FormInternalsMixin",
|
8204
|
-
"module": "utils/mixins/FormInternalsMixin.
|
7521
|
+
"module": "src/utils/mixins/FormInternalsMixin.ts"
|
8205
7522
|
}
|
8206
7523
|
},
|
8207
7524
|
{
|
8208
|
-
"
|
8209
|
-
"name": "validationMessage",
|
7525
|
+
"name": "validation-message",
|
8210
7526
|
"type": {
|
8211
7527
|
"text": "string | undefined"
|
8212
7528
|
},
|
8213
7529
|
"description": "Custom validation message that will override the default message and displayed when the input is invalid.",
|
8214
|
-
"
|
8215
|
-
"reflects": true,
|
7530
|
+
"fieldName": "validationMessage",
|
8216
7531
|
"inheritedFrom": {
|
8217
7532
|
"name": "FormInternalsMixin",
|
8218
|
-
"module": "utils/mixins/FormInternalsMixin.
|
7533
|
+
"module": "src/utils/mixins/FormInternalsMixin.ts"
|
8219
7534
|
}
|
8220
7535
|
},
|
8221
7536
|
{
|
8222
|
-
"
|
8223
|
-
"name": "validity",
|
7537
|
+
"name": "data-aria-label",
|
8224
7538
|
"type": {
|
8225
|
-
"text": "
|
7539
|
+
"text": "string | null"
|
8226
7540
|
},
|
8227
|
-
"
|
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",
|
8228
7544
|
"inheritedFrom": {
|
8229
|
-
"name": "
|
8230
|
-
"module": "utils/mixins/
|
7545
|
+
"name": "DataAriaLabelMixin",
|
7546
|
+
"module": "src/utils/mixins/DataAriaLabelMixin.ts"
|
8231
7547
|
}
|
8232
7548
|
},
|
8233
7549
|
{
|
8234
|
-
"
|
8235
|
-
"
|
8236
|
-
|
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",
|
8237
7557
|
"inheritedFrom": {
|
8238
|
-
"name": "
|
8239
|
-
"module": "
|
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"
|
7584
|
+
}
|
7585
|
+
},
|
7586
|
+
{
|
7587
|
+
"name": "id",
|
7588
|
+
"type": {
|
7589
|
+
"text": "string"
|
7590
|
+
},
|
7591
|
+
"default": "''",
|
7592
|
+
"description": "The unique id of the input field. It is used to link the input field with the label.",
|
7593
|
+
"fieldName": "id",
|
7594
|
+
"inheritedFrom": {
|
7595
|
+
"name": "FormfieldWrapper",
|
7596
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
7597
|
+
}
|
7598
|
+
},
|
7599
|
+
{
|
7600
|
+
"name": "help-text-type",
|
7601
|
+
"type": {
|
7602
|
+
"text": "ValidationType"
|
7603
|
+
},
|
7604
|
+
"description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
|
7605
|
+
"fieldName": "helpTextType",
|
7606
|
+
"inheritedFrom": {
|
7607
|
+
"name": "FormfieldWrapper",
|
7608
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
7609
|
+
}
|
7610
|
+
},
|
7611
|
+
{
|
7612
|
+
"name": "help-text",
|
7613
|
+
"type": {
|
7614
|
+
"text": "string | undefined"
|
7615
|
+
},
|
7616
|
+
"description": "The help text that is displayed below the input field.",
|
7617
|
+
"fieldName": "helpText",
|
7618
|
+
"inheritedFrom": {
|
7619
|
+
"name": "FormfieldWrapper",
|
7620
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
8240
7621
|
}
|
7622
|
+
}
|
7623
|
+
],
|
7624
|
+
"mixins": [
|
7625
|
+
{
|
7626
|
+
"name": "FormInternalsMixin",
|
7627
|
+
"module": "/src/utils/mixins/FormInternalsMixin"
|
8241
7628
|
},
|
8242
7629
|
{
|
8243
|
-
"
|
8244
|
-
"
|
8245
|
-
|
8246
|
-
|
8247
|
-
|
8248
|
-
|
8249
|
-
|
7630
|
+
"name": "DataAriaLabelMixin",
|
7631
|
+
"module": "/src/utils/mixins/DataAriaLabelMixin"
|
7632
|
+
}
|
7633
|
+
],
|
7634
|
+
"superclass": {
|
7635
|
+
"name": "FormfieldWrapper",
|
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"
|
8250
7684
|
},
|
8251
|
-
"
|
8252
|
-
|
8253
|
-
|
8254
|
-
}
|
7685
|
+
"default": "''",
|
7686
|
+
"description": "Name of the radio group.\nThey are used to group elements in a form together.",
|
7687
|
+
"attribute": "name"
|
8255
7688
|
},
|
8256
7689
|
{
|
8257
|
-
"kind": "
|
8258
|
-
"name": "
|
8259
|
-
"
|
8260
|
-
"
|
8261
|
-
"text": "boolean"
|
8262
|
-
}
|
7690
|
+
"kind": "field",
|
7691
|
+
"name": "dataAriaLabel",
|
7692
|
+
"type": {
|
7693
|
+
"text": "string | null"
|
8263
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,
|
8264
7699
|
"inheritedFrom": {
|
8265
|
-
"name": "
|
8266
|
-
"module": "utils/mixins/
|
7700
|
+
"name": "DataAriaLabelMixin",
|
7701
|
+
"module": "utils/mixins/DataAriaLabelMixin.js"
|
8267
7702
|
}
|
8268
7703
|
},
|
8269
7704
|
{
|
8270
|
-
"kind": "
|
8271
|
-
"name": "
|
7705
|
+
"kind": "field",
|
7706
|
+
"name": "id",
|
7707
|
+
"type": {
|
7708
|
+
"text": "string"
|
7709
|
+
},
|
7710
|
+
"default": "''",
|
7711
|
+
"description": "The unique id of the input field. It is used to link the input field with the label.",
|
7712
|
+
"attribute": "id",
|
8272
7713
|
"inheritedFrom": {
|
8273
|
-
"name": "
|
8274
|
-
"module": "
|
7714
|
+
"name": "FormfieldWrapper",
|
7715
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
8275
7716
|
}
|
8276
7717
|
},
|
8277
7718
|
{
|
8278
7719
|
"kind": "field",
|
8279
|
-
"name": "
|
7720
|
+
"name": "helpTextType",
|
8280
7721
|
"type": {
|
8281
|
-
"text": "
|
7722
|
+
"text": "ValidationType"
|
8282
7723
|
},
|
8283
|
-
"
|
8284
|
-
"
|
8285
|
-
"attribute": "data-aria-label",
|
7724
|
+
"description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
|
7725
|
+
"attribute": "help-text-type",
|
8286
7726
|
"reflects": true,
|
7727
|
+
"default": "undefined as unknown",
|
8287
7728
|
"inheritedFrom": {
|
8288
|
-
"name": "
|
8289
|
-
"module": "
|
7729
|
+
"name": "FormfieldWrapper",
|
7730
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
8290
7731
|
}
|
8291
7732
|
},
|
8292
7733
|
{
|
@@ -8295,7 +7736,7 @@
|
|
8295
7736
|
"type": {
|
8296
7737
|
"text": "boolean"
|
8297
7738
|
},
|
8298
|
-
"default": "
|
7739
|
+
"default": "undefined as unknown",
|
8299
7740
|
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
8300
7741
|
"attribute": "disabled",
|
8301
7742
|
"reflects": true,
|
@@ -8431,206 +7872,262 @@
|
|
8431
7872
|
}
|
8432
7873
|
}
|
8433
7874
|
],
|
8434
|
-
"
|
7875
|
+
"attributes": [
|
8435
7876
|
{
|
7877
|
+
"name": "name",
|
8436
7878
|
"type": {
|
8437
|
-
"text": "
|
8438
|
-
}
|
7879
|
+
"text": "string"
|
7880
|
+
},
|
7881
|
+
"default": "''",
|
7882
|
+
"description": "Name of the radio group.\nThey are used to group elements in a form together.",
|
7883
|
+
"fieldName": "name"
|
8439
7884
|
},
|
8440
7885
|
{
|
8441
|
-
"
|
8442
|
-
"
|
8443
|
-
|
8444
|
-
|
7886
|
+
"name": "data-aria-label",
|
7887
|
+
"type": {
|
7888
|
+
"text": "string | null"
|
7889
|
+
},
|
7890
|
+
"default": "null",
|
7891
|
+
"description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
|
7892
|
+
"fieldName": "dataAriaLabel",
|
7893
|
+
"inheritedFrom": {
|
7894
|
+
"name": "DataAriaLabelMixin",
|
7895
|
+
"module": "src/utils/mixins/DataAriaLabelMixin.ts"
|
7896
|
+
}
|
8445
7897
|
},
|
8446
7898
|
{
|
8447
|
-
"
|
8448
|
-
"name": "focus",
|
8449
|
-
"reactName": "onFocus",
|
8450
|
-
"eventName": "FocusEvent"
|
8451
|
-
}
|
8452
|
-
],
|
8453
|
-
"attributes": [
|
8454
|
-
{
|
8455
|
-
"name": "checked",
|
7899
|
+
"name": "disabled",
|
8456
7900
|
"type": {
|
8457
7901
|
"text": "boolean"
|
8458
7902
|
},
|
8459
7903
|
"default": "false",
|
8460
|
-
"description": "
|
8461
|
-
"fieldName": "
|
7904
|
+
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
7905
|
+
"fieldName": "disabled",
|
7906
|
+
"inheritedFrom": {
|
7907
|
+
"name": "FormfieldWrapper",
|
7908
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
7909
|
+
}
|
8462
7910
|
},
|
8463
7911
|
{
|
8464
|
-
"name": "
|
7912
|
+
"name": "label",
|
8465
7913
|
"type": {
|
8466
|
-
"text": "
|
7914
|
+
"text": "string | undefined"
|
8467
7915
|
},
|
8468
|
-
"
|
8469
|
-
"
|
8470
|
-
"
|
7916
|
+
"description": "The label of the input field. It is linked to the input field using the `for` attribute.",
|
7917
|
+
"fieldName": "label",
|
7918
|
+
"inheritedFrom": {
|
7919
|
+
"name": "FormfieldWrapper",
|
7920
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
7921
|
+
}
|
8471
7922
|
},
|
8472
7923
|
{
|
8473
|
-
"name": "
|
7924
|
+
"name": "required-label",
|
8474
7925
|
"type": {
|
8475
|
-
"text": "
|
7926
|
+
"text": "string | undefined"
|
8476
7927
|
},
|
8477
|
-
"
|
8478
|
-
"
|
8479
|
-
"
|
7928
|
+
"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.",
|
7929
|
+
"fieldName": "requiredLabel",
|
7930
|
+
"inheritedFrom": {
|
7931
|
+
"name": "FormfieldWrapper",
|
7932
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
7933
|
+
}
|
8480
7934
|
},
|
8481
7935
|
{
|
8482
|
-
"name": "
|
7936
|
+
"name": "id",
|
8483
7937
|
"type": {
|
8484
7938
|
"text": "string"
|
8485
7939
|
},
|
8486
7940
|
"default": "''",
|
8487
|
-
"description": "
|
8488
|
-
"fieldName": "
|
7941
|
+
"description": "The unique id of the input field. It is used to link the input field with the label.",
|
7942
|
+
"fieldName": "id",
|
8489
7943
|
"inheritedFrom": {
|
8490
|
-
"name": "
|
8491
|
-
"module": "src/
|
7944
|
+
"name": "FormfieldWrapper",
|
7945
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
8492
7946
|
}
|
8493
7947
|
},
|
8494
7948
|
{
|
8495
|
-
"name": "
|
7949
|
+
"name": "help-text-type",
|
8496
7950
|
"type": {
|
8497
|
-
"text": "
|
7951
|
+
"text": "ValidationType"
|
8498
7952
|
},
|
8499
|
-
"
|
8500
|
-
"
|
8501
|
-
"fieldName": "value",
|
7953
|
+
"description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
|
7954
|
+
"fieldName": "helpTextType",
|
8502
7955
|
"inheritedFrom": {
|
8503
|
-
"name": "
|
8504
|
-
"module": "src/
|
7956
|
+
"name": "FormfieldWrapper",
|
7957
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
7958
|
+
}
|
7959
|
+
},
|
7960
|
+
{
|
7961
|
+
"name": "help-text",
|
7962
|
+
"type": {
|
7963
|
+
"text": "string | undefined"
|
7964
|
+
},
|
7965
|
+
"description": "The help text that is displayed below the input field.",
|
7966
|
+
"fieldName": "helpText",
|
7967
|
+
"inheritedFrom": {
|
7968
|
+
"name": "FormfieldWrapper",
|
7969
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
7970
|
+
}
|
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
|
+
},
|
7989
|
+
{
|
7990
|
+
"description": "slot to add the label info icon",
|
7991
|
+
"name": "label-info",
|
7992
|
+
"inheritedFrom": {
|
7993
|
+
"name": "FormfieldWrapper",
|
7994
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
8505
7995
|
}
|
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
|
8506
8055
|
},
|
8507
8056
|
{
|
8508
|
-
"
|
8057
|
+
"kind": "field",
|
8058
|
+
"name": "size",
|
8509
8059
|
"type": {
|
8510
|
-
"text": "
|
8060
|
+
"text": "SpinnerSize | undefined"
|
8511
8061
|
},
|
8512
|
-
"description": "
|
8513
|
-
"
|
8514
|
-
"
|
8515
|
-
|
8516
|
-
"module": "src/utils/mixins/FormInternalsMixin.ts"
|
8517
|
-
}
|
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
|
8518
8066
|
},
|
8519
8067
|
{
|
8520
|
-
"
|
8068
|
+
"kind": "field",
|
8069
|
+
"name": "ariaLabel",
|
8521
8070
|
"type": {
|
8522
8071
|
"text": "string | null"
|
8523
8072
|
},
|
8524
8073
|
"default": "null",
|
8525
|
-
"description": "
|
8526
|
-
"
|
8527
|
-
"inheritedFrom": {
|
8528
|
-
"name": "DataAriaLabelMixin",
|
8529
|
-
"module": "src/utils/mixins/DataAriaLabelMixin.ts"
|
8530
|
-
}
|
8531
|
-
},
|
8532
|
-
{
|
8533
|
-
"name": "disabled",
|
8534
|
-
"type": {
|
8535
|
-
"text": "boolean"
|
8536
|
-
},
|
8537
|
-
"default": "false",
|
8538
|
-
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
8539
|
-
"fieldName": "disabled",
|
8540
|
-
"inheritedFrom": {
|
8541
|
-
"name": "FormfieldWrapper",
|
8542
|
-
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
8543
|
-
}
|
8074
|
+
"description": "Aria-label attribute to be set for accessibility",
|
8075
|
+
"attribute": "aria-label"
|
8544
8076
|
},
|
8545
8077
|
{
|
8546
|
-
"
|
8078
|
+
"kind": "field",
|
8079
|
+
"name": "variant",
|
8547
8080
|
"type": {
|
8548
|
-
"text": "
|
8081
|
+
"text": "SpinnerVariant"
|
8549
8082
|
},
|
8550
|
-
"description": "
|
8551
|
-
"
|
8552
|
-
"
|
8553
|
-
|
8554
|
-
|
8555
|
-
|
8556
|
-
|
8083
|
+
"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.",
|
8084
|
+
"default": "standalone",
|
8085
|
+
"attribute": "variant",
|
8086
|
+
"reflects": true
|
8087
|
+
}
|
8088
|
+
],
|
8089
|
+
"attributes": [
|
8557
8090
|
{
|
8558
|
-
"name": "
|
8559
|
-
"
|
8560
|
-
|
8561
|
-
|
8562
|
-
"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.",
|
8563
|
-
"fieldName": "requiredLabel",
|
8564
|
-
"inheritedFrom": {
|
8565
|
-
"name": "FormfieldWrapper",
|
8566
|
-
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
8567
|
-
}
|
8091
|
+
"name": "inverted",
|
8092
|
+
"description": "The spinner color can be inverted by setting the inverted attribute to true.",
|
8093
|
+
"default": "false",
|
8094
|
+
"fieldName": "inverted"
|
8568
8095
|
},
|
8569
8096
|
{
|
8570
|
-
"name": "
|
8097
|
+
"name": "size",
|
8571
8098
|
"type": {
|
8572
|
-
"text": "
|
8099
|
+
"text": "SpinnerSize | undefined"
|
8573
8100
|
},
|
8574
|
-
"
|
8575
|
-
"
|
8576
|
-
"fieldName": "
|
8577
|
-
"inheritedFrom": {
|
8578
|
-
"name": "FormfieldWrapper",
|
8579
|
-
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
8580
|
-
}
|
8101
|
+
"description": "Size of the spinner.\nAcceptable values include:\n\n- 'small'\n- 'midsize'\n- 'large'\n- 'undefined'",
|
8102
|
+
"default": "midsize",
|
8103
|
+
"fieldName": "size"
|
8581
8104
|
},
|
8582
8105
|
{
|
8583
|
-
"name": "
|
8106
|
+
"name": "aria-label",
|
8584
8107
|
"type": {
|
8585
|
-
"text": "
|
8108
|
+
"text": "string | null"
|
8586
8109
|
},
|
8587
|
-
"
|
8588
|
-
"
|
8589
|
-
"
|
8590
|
-
"name": "FormfieldWrapper",
|
8591
|
-
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
8592
|
-
}
|
8110
|
+
"default": "null",
|
8111
|
+
"description": "Aria-label attribute to be set for accessibility",
|
8112
|
+
"fieldName": "ariaLabel"
|
8593
8113
|
},
|
8594
8114
|
{
|
8595
|
-
"name": "
|
8115
|
+
"name": "variant",
|
8596
8116
|
"type": {
|
8597
|
-
"text": "
|
8117
|
+
"text": "SpinnerVariant"
|
8598
8118
|
},
|
8599
|
-
"description": "
|
8600
|
-
"
|
8601
|
-
"
|
8602
|
-
"name": "FormfieldWrapper",
|
8603
|
-
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
8604
|
-
}
|
8605
|
-
}
|
8606
|
-
],
|
8607
|
-
"mixins": [
|
8608
|
-
{
|
8609
|
-
"name": "FormInternalsMixin",
|
8610
|
-
"module": "/src/utils/mixins/FormInternalsMixin"
|
8611
|
-
},
|
8612
|
-
{
|
8613
|
-
"name": "DataAriaLabelMixin",
|
8614
|
-
"module": "/src/utils/mixins/DataAriaLabelMixin"
|
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"
|
8615
8122
|
}
|
8616
8123
|
],
|
8617
8124
|
"superclass": {
|
8618
|
-
"name": "
|
8619
|
-
"module": "/src/
|
8125
|
+
"name": "Component",
|
8126
|
+
"module": "/src/models"
|
8620
8127
|
},
|
8621
|
-
"tagName": "mdc-
|
8622
|
-
"jsDoc": "/**\n *
|
8623
|
-
"customElement": true
|
8624
|
-
"slots": [
|
8625
|
-
{
|
8626
|
-
"description": "slot to add the label info icon",
|
8627
|
-
"name": "label-info",
|
8628
|
-
"inheritedFrom": {
|
8629
|
-
"name": "FormfieldWrapper",
|
8630
|
-
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
8631
|
-
}
|
8632
|
-
}
|
8633
|
-
]
|
8128
|
+
"tagName": "mdc-spinner",
|
8129
|
+
"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 */",
|
8130
|
+
"customElement": true
|
8634
8131
|
}
|
8635
8132
|
],
|
8636
8133
|
"exports": [
|
@@ -8638,79 +8135,182 @@
|
|
8638
8135
|
"kind": "js",
|
8639
8136
|
"name": "default",
|
8640
8137
|
"declaration": {
|
8641
|
-
"name": "
|
8642
|
-
"module": "components/
|
8138
|
+
"name": "Spinner",
|
8139
|
+
"module": "components/spinner/spinner.component.js"
|
8643
8140
|
}
|
8644
8141
|
}
|
8645
8142
|
]
|
8646
8143
|
},
|
8647
8144
|
{
|
8648
8145
|
"kind": "javascript-module",
|
8649
|
-
"path": "components/
|
8146
|
+
"path": "components/button/button.component.js",
|
8650
8147
|
"declarations": [
|
8651
8148
|
{
|
8652
8149
|
"kind": "class",
|
8653
|
-
"description": "`mdc-
|
8654
|
-
"name": "
|
8655
|
-
"
|
8150
|
+
"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.",
|
8151
|
+
"name": "Button",
|
8152
|
+
"slots": [
|
8656
8153
|
{
|
8657
|
-
"description": "
|
8658
|
-
"name": "
|
8154
|
+
"description": "Text label of the button.",
|
8155
|
+
"name": ""
|
8659
8156
|
}
|
8660
8157
|
],
|
8661
8158
|
"members": [
|
8662
8159
|
{
|
8663
|
-
"kind": "field",
|
8664
|
-
"name": "
|
8665
|
-
"type": {
|
8666
|
-
"text": "string"
|
8667
|
-
},
|
8668
|
-
"
|
8669
|
-
"
|
8670
|
-
"
|
8160
|
+
"kind": "field",
|
8161
|
+
"name": "prefixIcon",
|
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",
|
8182
|
+
"type": {
|
8183
|
+
"text": "ButtonVariant"
|
8184
|
+
},
|
8185
|
+
"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.",
|
8186
|
+
"default": "primary",
|
8187
|
+
"attribute": "variant"
|
8188
|
+
},
|
8189
|
+
{
|
8190
|
+
"kind": "field",
|
8191
|
+
"name": "size",
|
8192
|
+
"type": {
|
8193
|
+
"text": "ButtonSize"
|
8194
|
+
},
|
8195
|
+
"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.",
|
8196
|
+
"default": "32",
|
8197
|
+
"attribute": "size",
|
8198
|
+
"reflects": true,
|
8199
|
+
"inheritedFrom": {
|
8200
|
+
"name": "Buttonsimple",
|
8201
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
8202
|
+
}
|
8203
|
+
},
|
8204
|
+
{
|
8205
|
+
"kind": "field",
|
8206
|
+
"name": "color",
|
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,
|
8221
|
+
"type": {
|
8222
|
+
"text": "string"
|
8223
|
+
},
|
8224
|
+
"inheritedFrom": {
|
8225
|
+
"name": "Buttonsimple",
|
8226
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
8227
|
+
}
|
8228
|
+
},
|
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."
|
8671
8273
|
},
|
8672
8274
|
{
|
8673
|
-
"kind": "
|
8674
|
-
"name": "
|
8675
|
-
"
|
8676
|
-
|
8677
|
-
|
8678
|
-
|
8679
|
-
|
8680
|
-
|
8681
|
-
|
8682
|
-
|
8683
|
-
|
8684
|
-
|
8685
|
-
|
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."
|
8686
8288
|
},
|
8687
8289
|
{
|
8688
|
-
"kind": "
|
8689
|
-
"name": "
|
8690
|
-
"
|
8691
|
-
|
8692
|
-
|
8693
|
-
|
8694
|
-
|
8695
|
-
|
8696
|
-
|
8697
|
-
|
8698
|
-
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
8699
|
-
}
|
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
|
+
]
|
8700
8300
|
},
|
8701
8301
|
{
|
8702
8302
|
"kind": "field",
|
8703
|
-
"name": "
|
8303
|
+
"name": "tabIndex",
|
8704
8304
|
"type": {
|
8705
|
-
"text": "
|
8305
|
+
"text": "number"
|
8706
8306
|
},
|
8707
|
-
"
|
8708
|
-
"
|
8307
|
+
"default": "0",
|
8308
|
+
"description": "This property specifies the tab order of the element.",
|
8309
|
+
"attribute": "tabIndex",
|
8709
8310
|
"reflects": true,
|
8710
|
-
"default": "undefined as unknown",
|
8711
8311
|
"inheritedFrom": {
|
8712
|
-
"name": "
|
8713
|
-
"module": "components/
|
8312
|
+
"name": "Buttonsimple",
|
8313
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
8714
8314
|
}
|
8715
8315
|
},
|
8716
8316
|
{
|
@@ -8719,397 +8319,379 @@
|
|
8719
8319
|
"type": {
|
8720
8320
|
"text": "boolean"
|
8721
8321
|
},
|
8722
|
-
"default": "
|
8322
|
+
"default": "false",
|
8723
8323
|
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
8724
8324
|
"attribute": "disabled",
|
8725
8325
|
"reflects": true,
|
8726
8326
|
"inheritedFrom": {
|
8727
|
-
"name": "
|
8728
|
-
"module": "components/
|
8327
|
+
"name": "Buttonsimple",
|
8328
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
8729
8329
|
}
|
8730
8330
|
},
|
8731
8331
|
{
|
8732
8332
|
"kind": "field",
|
8733
|
-
"name": "
|
8333
|
+
"name": "active",
|
8734
8334
|
"type": {
|
8735
|
-
"text": "
|
8335
|
+
"text": "boolean"
|
8736
8336
|
},
|
8737
|
-
"
|
8738
|
-
"
|
8337
|
+
"default": "false",
|
8338
|
+
"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.",
|
8339
|
+
"attribute": "active",
|
8739
8340
|
"reflects": true,
|
8740
8341
|
"inheritedFrom": {
|
8741
|
-
"name": "
|
8742
|
-
"module": "components/
|
8342
|
+
"name": "Buttonsimple",
|
8343
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
8743
8344
|
}
|
8744
8345
|
},
|
8745
8346
|
{
|
8746
8347
|
"kind": "field",
|
8747
|
-
"name": "
|
8348
|
+
"name": "softDisabled",
|
8748
8349
|
"type": {
|
8749
|
-
"text": "
|
8350
|
+
"text": "boolean"
|
8750
8351
|
},
|
8751
|
-
"
|
8752
|
-
"
|
8753
|
-
"
|
8352
|
+
"default": "false",
|
8353
|
+
"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.",
|
8354
|
+
"attribute": "soft-disabled",
|
8754
8355
|
"inheritedFrom": {
|
8755
|
-
"name": "
|
8756
|
-
"module": "components/
|
8356
|
+
"name": "Buttonsimple",
|
8357
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
8757
8358
|
}
|
8758
8359
|
},
|
8759
8360
|
{
|
8760
8361
|
"kind": "field",
|
8761
|
-
"name": "
|
8362
|
+
"name": "type",
|
8762
8363
|
"type": {
|
8763
|
-
"text": "
|
8364
|
+
"text": "ButtonType"
|
8764
8365
|
},
|
8765
|
-
"description": "
|
8766
|
-
"
|
8366
|
+
"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.",
|
8367
|
+
"default": "button",
|
8368
|
+
"attribute": "type",
|
8767
8369
|
"reflects": true,
|
8768
8370
|
"inheritedFrom": {
|
8769
|
-
"name": "
|
8770
|
-
"module": "components/
|
8371
|
+
"name": "Buttonsimple",
|
8372
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
8771
8373
|
}
|
8772
8374
|
},
|
8773
8375
|
{
|
8774
8376
|
"kind": "method",
|
8775
|
-
"name": "
|
8377
|
+
"name": "executeAction",
|
8776
8378
|
"privacy": "protected",
|
8777
|
-
"description": "creates the label element when the label property is set.\nid is used to link the label with the input field.",
|
8778
|
-
"return": {
|
8779
|
-
"type": {
|
8780
|
-
"text": ""
|
8781
|
-
}
|
8782
|
-
},
|
8783
8379
|
"inheritedFrom": {
|
8784
|
-
"name": "
|
8785
|
-
"module": "components/
|
8380
|
+
"name": "Buttonsimple",
|
8381
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
8786
8382
|
}
|
8787
8383
|
},
|
8788
8384
|
{
|
8789
8385
|
"kind": "method",
|
8790
|
-
"name": "
|
8386
|
+
"name": "setActive",
|
8791
8387
|
"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.",
|
8792
8405
|
"inheritedFrom": {
|
8793
|
-
"name": "
|
8794
|
-
"module": "components/
|
8406
|
+
"name": "Buttonsimple",
|
8407
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
8795
8408
|
}
|
8796
8409
|
},
|
8797
8410
|
{
|
8798
8411
|
"kind": "method",
|
8799
|
-
"name": "
|
8800
|
-
"privacy": "
|
8801
|
-
"
|
8802
|
-
|
8803
|
-
|
8804
|
-
"
|
8412
|
+
"name": "setSoftDisabled",
|
8413
|
+
"privacy": "private",
|
8414
|
+
"parameters": [
|
8415
|
+
{
|
8416
|
+
"name": "element",
|
8417
|
+
"type": {
|
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."
|
8805
8428
|
}
|
8806
|
-
|
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.",
|
8807
8431
|
"inheritedFrom": {
|
8808
|
-
"name": "
|
8809
|
-
"module": "components/
|
8432
|
+
"name": "Buttonsimple",
|
8433
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
8810
8434
|
}
|
8811
8435
|
},
|
8812
8436
|
{
|
8813
8437
|
"kind": "method",
|
8814
|
-
"name": "
|
8815
|
-
"privacy": "
|
8816
|
-
"
|
8817
|
-
|
8818
|
-
|
8819
|
-
"
|
8438
|
+
"name": "setDisabled",
|
8439
|
+
"privacy": "private",
|
8440
|
+
"parameters": [
|
8441
|
+
{
|
8442
|
+
"name": "element",
|
8443
|
+
"type": {
|
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."
|
8820
8454
|
}
|
8821
|
-
|
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.",
|
8822
8457
|
"inheritedFrom": {
|
8823
|
-
"name": "
|
8824
|
-
"module": "components/
|
8458
|
+
"name": "Buttonsimple",
|
8459
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
8825
8460
|
}
|
8826
8461
|
},
|
8827
8462
|
{
|
8828
8463
|
"kind": "method",
|
8829
|
-
"name": "
|
8830
|
-
"privacy": "
|
8831
|
-
"
|
8832
|
-
|
8833
|
-
"
|
8834
|
-
|
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.",
|
8476
|
+
"inheritedFrom": {
|
8477
|
+
"name": "Buttonsimple",
|
8478
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
8479
|
+
}
|
8480
|
+
},
|
8481
|
+
{
|
8482
|
+
"kind": "method",
|
8483
|
+
"name": "handleKeyDown",
|
8484
|
+
"privacy": "private",
|
8485
|
+
"parameters": [
|
8486
|
+
{
|
8487
|
+
"name": "event",
|
8488
|
+
"type": {
|
8489
|
+
"text": "KeyboardEvent"
|
8490
|
+
},
|
8491
|
+
"description": "The keyboard event."
|
8835
8492
|
}
|
8836
|
-
|
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.",
|
8837
8495
|
"inheritedFrom": {
|
8838
|
-
"name": "
|
8839
|
-
"module": "components/
|
8496
|
+
"name": "Buttonsimple",
|
8497
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
8840
8498
|
}
|
8841
8499
|
},
|
8842
8500
|
{
|
8843
8501
|
"kind": "method",
|
8844
|
-
"name": "
|
8845
|
-
"privacy": "
|
8846
|
-
"
|
8847
|
-
|
8848
|
-
|
8849
|
-
"
|
8502
|
+
"name": "handleKeyUp",
|
8503
|
+
"privacy": "private",
|
8504
|
+
"parameters": [
|
8505
|
+
{
|
8506
|
+
"name": "event",
|
8507
|
+
"type": {
|
8508
|
+
"text": "KeyboardEvent"
|
8509
|
+
},
|
8510
|
+
"description": "The keyboard event."
|
8850
8511
|
}
|
8851
|
-
|
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.",
|
8852
8514
|
"inheritedFrom": {
|
8853
|
-
"name": "
|
8854
|
-
"module": "components/
|
8515
|
+
"name": "Buttonsimple",
|
8516
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
8855
8517
|
}
|
8856
8518
|
}
|
8857
8519
|
],
|
8858
|
-
"
|
8520
|
+
"events": [
|
8859
8521
|
{
|
8860
|
-
"
|
8861
|
-
"
|
8862
|
-
|
8863
|
-
|
8864
|
-
"
|
8865
|
-
|
8866
|
-
|
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
|
+
}
|
8867
8530
|
},
|
8868
8531
|
{
|
8869
|
-
"
|
8870
|
-
"
|
8871
|
-
|
8872
|
-
|
8873
|
-
"default": "null",
|
8874
|
-
"description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
|
8875
|
-
"fieldName": "dataAriaLabel",
|
8532
|
+
"description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the button.",
|
8533
|
+
"name": "keydown",
|
8534
|
+
"reactName": "onKeyDown",
|
8535
|
+
"eventName": "KeydownEvent",
|
8876
8536
|
"inheritedFrom": {
|
8877
|
-
"name": "
|
8878
|
-
"module": "src/
|
8537
|
+
"name": "Buttonsimple",
|
8538
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
8879
8539
|
}
|
8880
8540
|
},
|
8881
8541
|
{
|
8882
|
-
"
|
8883
|
-
"
|
8884
|
-
|
8885
|
-
|
8886
|
-
"default": "false",
|
8887
|
-
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
8888
|
-
"fieldName": "disabled",
|
8542
|
+
"description": "(React: onKeyUp) This event is dispatched when a key is released on the button.",
|
8543
|
+
"name": "keyup",
|
8544
|
+
"reactName": "onKeyUp",
|
8545
|
+
"eventName": "KeyupEvent",
|
8889
8546
|
"inheritedFrom": {
|
8890
|
-
"name": "
|
8891
|
-
"module": "src/components/
|
8547
|
+
"name": "Buttonsimple",
|
8548
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
8892
8549
|
}
|
8893
8550
|
},
|
8894
8551
|
{
|
8895
|
-
"
|
8896
|
-
"
|
8897
|
-
|
8898
|
-
|
8899
|
-
"description": "The label of the input field. It is linked to the input field using the `for` attribute.",
|
8900
|
-
"fieldName": "label",
|
8552
|
+
"description": "(React: onFocus) This event is dispatched when the button receives focus.",
|
8553
|
+
"name": "focus",
|
8554
|
+
"reactName": "onFocus",
|
8555
|
+
"eventName": "FocusEvent",
|
8901
8556
|
"inheritedFrom": {
|
8902
|
-
"name": "
|
8903
|
-
"module": "src/components/
|
8557
|
+
"name": "Buttonsimple",
|
8558
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
8904
8559
|
}
|
8905
|
-
}
|
8560
|
+
}
|
8561
|
+
],
|
8562
|
+
"attributes": [
|
8906
8563
|
{
|
8907
|
-
"name": "
|
8564
|
+
"name": "prefix-icon",
|
8908
8565
|
"type": {
|
8909
8566
|
"text": "string | undefined"
|
8910
8567
|
},
|
8911
|
-
"description": "The
|
8912
|
-
"fieldName": "
|
8913
|
-
"inheritedFrom": {
|
8914
|
-
"name": "FormfieldWrapper",
|
8915
|
-
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
8916
|
-
}
|
8568
|
+
"description": "The name of the icon to display as a prefix.\nThe icon is displayed on the left side of the button.",
|
8569
|
+
"fieldName": "prefixIcon"
|
8917
8570
|
},
|
8918
8571
|
{
|
8919
|
-
"name": "
|
8572
|
+
"name": "postfix-icon",
|
8920
8573
|
"type": {
|
8921
|
-
"text": "string"
|
8574
|
+
"text": "string | undefined"
|
8922
8575
|
},
|
8923
|
-
"
|
8924
|
-
"
|
8925
|
-
"fieldName": "id",
|
8926
|
-
"inheritedFrom": {
|
8927
|
-
"name": "FormfieldWrapper",
|
8928
|
-
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
8929
|
-
}
|
8576
|
+
"description": "The name of the icon to display as a postfix.\nThe icon is displayed on the right side of the button.",
|
8577
|
+
"fieldName": "postfixIcon"
|
8930
8578
|
},
|
8931
8579
|
{
|
8932
|
-
"name": "
|
8580
|
+
"name": "variant",
|
8933
8581
|
"type": {
|
8934
|
-
"text": "
|
8582
|
+
"text": "ButtonVariant"
|
8935
8583
|
},
|
8936
|
-
"description": "
|
8937
|
-
"
|
8938
|
-
"
|
8939
|
-
"name": "FormfieldWrapper",
|
8940
|
-
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
8941
|
-
}
|
8584
|
+
"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.",
|
8585
|
+
"default": "primary",
|
8586
|
+
"fieldName": "variant"
|
8942
8587
|
},
|
8943
8588
|
{
|
8944
|
-
"name": "
|
8589
|
+
"name": "size",
|
8945
8590
|
"type": {
|
8946
|
-
"text": "
|
8591
|
+
"text": "ButtonSize"
|
8947
8592
|
},
|
8948
|
-
"description": "
|
8949
|
-
"
|
8950
|
-
"
|
8951
|
-
"name": "FormfieldWrapper",
|
8952
|
-
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
8953
|
-
}
|
8954
|
-
}
|
8955
|
-
],
|
8956
|
-
"superclass": {
|
8957
|
-
"name": "FormfieldGroup",
|
8958
|
-
"module": "/src/components/formfieldgroup"
|
8959
|
-
},
|
8960
|
-
"tagName": "mdc-radiogroup",
|
8961
|
-
"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 */",
|
8962
|
-
"customElement": true,
|
8963
|
-
"slots": [
|
8964
|
-
{
|
8965
|
-
"description": "This is a default slot for checkbox or toggle components.",
|
8966
|
-
"name": "default",
|
8967
|
-
"inheritedFrom": {
|
8968
|
-
"name": "FormfieldGroup",
|
8969
|
-
"module": "src/components/formfieldgroup/formfieldgroup.component.ts"
|
8970
|
-
}
|
8971
|
-
},
|
8972
|
-
{
|
8973
|
-
"description": "slot to add the label info icon",
|
8974
|
-
"name": "label-info",
|
8593
|
+
"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.",
|
8594
|
+
"default": "32",
|
8595
|
+
"fieldName": "size",
|
8975
8596
|
"inheritedFrom": {
|
8976
|
-
"name": "
|
8977
|
-
"module": "src/components/
|
8597
|
+
"name": "Buttonsimple",
|
8598
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
8978
8599
|
}
|
8979
|
-
}
|
8980
|
-
]
|
8981
|
-
}
|
8982
|
-
],
|
8983
|
-
"exports": [
|
8984
|
-
{
|
8985
|
-
"kind": "js",
|
8986
|
-
"name": "default",
|
8987
|
-
"declaration": {
|
8988
|
-
"name": "RadioGroup",
|
8989
|
-
"module": "components/radiogroup/radiogroup.component.js"
|
8990
|
-
}
|
8991
|
-
}
|
8992
|
-
]
|
8993
|
-
},
|
8994
|
-
{
|
8995
|
-
"kind": "javascript-module",
|
8996
|
-
"path": "components/spinner/spinner.component.js",
|
8997
|
-
"declarations": [
|
8998
|
-
{
|
8999
|
-
"kind": "class",
|
9000
|
-
"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.",
|
9001
|
-
"name": "Spinner",
|
9002
|
-
"cssProperties": [
|
9003
|
-
{
|
9004
|
-
"description": "Allows customization of the default spinner color.",
|
9005
|
-
"name": "--mdc-spinner-default-color"
|
9006
|
-
},
|
9007
|
-
{
|
9008
|
-
"description": "Allows customization of the inverted spinner color.",
|
9009
|
-
"name": "--mdc-spinner-inverted-color"
|
9010
|
-
},
|
9011
|
-
{
|
9012
|
-
"description": "Allows customization of the spinner Button variant color.",
|
9013
|
-
"name": "--mdc-spinner-button-variant-color"
|
9014
|
-
},
|
9015
|
-
{
|
9016
|
-
"description": "Allows customization of the spinner size.",
|
9017
|
-
"name": "--mdc-spinner-size"
|
9018
|
-
}
|
9019
|
-
],
|
9020
|
-
"cssParts": [
|
9021
|
-
{
|
9022
|
-
"description": "The svg which contains the circle spinner.",
|
9023
|
-
"name": "container"
|
9024
|
-
},
|
9025
|
-
{
|
9026
|
-
"description": "The circle of the spinner.",
|
9027
|
-
"name": "circle"
|
9028
|
-
}
|
9029
|
-
],
|
9030
|
-
"members": [
|
9031
|
-
{
|
9032
|
-
"kind": "field",
|
9033
|
-
"name": "inverted",
|
9034
|
-
"description": "The spinner color can be inverted by setting the inverted attribute to true.",
|
9035
|
-
"default": "false",
|
9036
|
-
"attribute": "inverted",
|
9037
|
-
"reflects": true
|
9038
8600
|
},
|
9039
8601
|
{
|
9040
|
-
"
|
9041
|
-
"name": "size",
|
8602
|
+
"name": "color",
|
9042
8603
|
"type": {
|
9043
|
-
"text": "
|
8604
|
+
"text": "ButtonColor"
|
9044
8605
|
},
|
9045
|
-
"description": "
|
9046
|
-
"default": "
|
9047
|
-
"
|
9048
|
-
"reflects": true
|
8606
|
+
"description": "There are 5 colors for button: positive, negative, accent, promotional, default.",
|
8607
|
+
"default": "default",
|
8608
|
+
"fieldName": "color"
|
9049
8609
|
},
|
9050
8610
|
{
|
9051
|
-
"
|
9052
|
-
"
|
8611
|
+
"name": "role",
|
8612
|
+
"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.",
|
8613
|
+
"default": "'button'",
|
8614
|
+
"fieldName": "role",
|
9053
8615
|
"type": {
|
9054
|
-
"text": "string
|
8616
|
+
"text": "string"
|
9055
8617
|
},
|
9056
|
-
"
|
9057
|
-
|
9058
|
-
|
8618
|
+
"inheritedFrom": {
|
8619
|
+
"name": "Buttonsimple",
|
8620
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
8621
|
+
}
|
9059
8622
|
},
|
9060
8623
|
{
|
9061
|
-
"
|
9062
|
-
"name": "variant",
|
8624
|
+
"name": "tabIndex",
|
9063
8625
|
"type": {
|
9064
|
-
"text": "
|
8626
|
+
"text": "number"
|
9065
8627
|
},
|
9066
|
-
"
|
9067
|
-
"
|
9068
|
-
"
|
9069
|
-
"
|
9070
|
-
|
9071
|
-
|
9072
|
-
|
8628
|
+
"default": "0",
|
8629
|
+
"description": "This property specifies the tab order of the element.",
|
8630
|
+
"fieldName": "tabIndex",
|
8631
|
+
"inheritedFrom": {
|
8632
|
+
"name": "Buttonsimple",
|
8633
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
8634
|
+
}
|
8635
|
+
},
|
9073
8636
|
{
|
9074
|
-
"name": "
|
9075
|
-
"
|
8637
|
+
"name": "disabled",
|
8638
|
+
"type": {
|
8639
|
+
"text": "boolean"
|
8640
|
+
},
|
9076
8641
|
"default": "false",
|
9077
|
-
"
|
8642
|
+
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
8643
|
+
"fieldName": "disabled",
|
8644
|
+
"inheritedFrom": {
|
8645
|
+
"name": "Buttonsimple",
|
8646
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
8647
|
+
}
|
9078
8648
|
},
|
9079
8649
|
{
|
9080
|
-
"name": "
|
8650
|
+
"name": "active",
|
9081
8651
|
"type": {
|
9082
|
-
"text": "
|
8652
|
+
"text": "boolean"
|
9083
8653
|
},
|
9084
|
-
"
|
9085
|
-
"
|
9086
|
-
"fieldName": "
|
8654
|
+
"default": "false",
|
8655
|
+
"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.",
|
8656
|
+
"fieldName": "active",
|
8657
|
+
"inheritedFrom": {
|
8658
|
+
"name": "Buttonsimple",
|
8659
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
8660
|
+
}
|
9087
8661
|
},
|
9088
8662
|
{
|
9089
|
-
"name": "
|
8663
|
+
"name": "soft-disabled",
|
9090
8664
|
"type": {
|
9091
|
-
"text": "
|
8665
|
+
"text": "boolean"
|
9092
8666
|
},
|
9093
|
-
"default": "
|
9094
|
-
"description": "
|
9095
|
-
"fieldName": "
|
8667
|
+
"default": "false",
|
8668
|
+
"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.",
|
8669
|
+
"fieldName": "softDisabled",
|
8670
|
+
"inheritedFrom": {
|
8671
|
+
"name": "Buttonsimple",
|
8672
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
8673
|
+
}
|
9096
8674
|
},
|
9097
8675
|
{
|
9098
|
-
"name": "
|
8676
|
+
"name": "type",
|
9099
8677
|
"type": {
|
9100
|
-
"text": "
|
8678
|
+
"text": "ButtonType"
|
9101
8679
|
},
|
9102
|
-
"description": "
|
9103
|
-
"default": "
|
9104
|
-
"fieldName": "
|
8680
|
+
"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.",
|
8681
|
+
"default": "button",
|
8682
|
+
"fieldName": "type",
|
8683
|
+
"inheritedFrom": {
|
8684
|
+
"name": "Buttonsimple",
|
8685
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
8686
|
+
}
|
9105
8687
|
}
|
9106
8688
|
],
|
9107
8689
|
"superclass": {
|
9108
|
-
"name": "
|
9109
|
-
"module": "/src/
|
8690
|
+
"name": "Buttonsimple",
|
8691
|
+
"module": "/src/components/buttonsimple/buttonsimple.component"
|
9110
8692
|
},
|
9111
|
-
"tagName": "mdc-
|
9112
|
-
"jsDoc": "/**\n * `mdc-
|
8693
|
+
"tagName": "mdc-button",
|
8694
|
+
"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 */",
|
9113
8695
|
"customElement": true
|
9114
8696
|
}
|
9115
8697
|
],
|
@@ -9118,8 +8700,8 @@
|
|
9118
8700
|
"kind": "js",
|
9119
8701
|
"name": "default",
|
9120
8702
|
"declaration": {
|
9121
|
-
"name": "
|
9122
|
-
"module": "components/
|
8703
|
+
"name": "Button",
|
8704
|
+
"module": "components/button/button.component.js"
|
9123
8705
|
}
|
9124
8706
|
}
|
9125
8707
|
]
|
@@ -9503,106 +9085,6 @@
|
|
9503
9085
|
"module": "utils/mixins/IconNameMixin.js"
|
9504
9086
|
}
|
9505
9087
|
},
|
9506
|
-
{
|
9507
|
-
"kind": "field",
|
9508
|
-
"name": "name",
|
9509
|
-
"type": {
|
9510
|
-
"text": "string"
|
9511
|
-
},
|
9512
|
-
"default": "''",
|
9513
|
-
"description": "Indicates the name of the component group.\nThey are used to group elements in a form together.",
|
9514
|
-
"attribute": "name",
|
9515
|
-
"reflects": true,
|
9516
|
-
"inheritedFrom": {
|
9517
|
-
"name": "Buttonsimple",
|
9518
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
9519
|
-
}
|
9520
|
-
},
|
9521
|
-
{
|
9522
|
-
"kind": "field",
|
9523
|
-
"name": "value",
|
9524
|
-
"type": {
|
9525
|
-
"text": "string"
|
9526
|
-
},
|
9527
|
-
"default": "''",
|
9528
|
-
"description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
|
9529
|
-
"attribute": "value",
|
9530
|
-
"reflects": true,
|
9531
|
-
"inheritedFrom": {
|
9532
|
-
"name": "Buttonsimple",
|
9533
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
9534
|
-
}
|
9535
|
-
},
|
9536
|
-
{
|
9537
|
-
"kind": "field",
|
9538
|
-
"name": "validationMessage",
|
9539
|
-
"type": {
|
9540
|
-
"text": "string | undefined"
|
9541
|
-
},
|
9542
|
-
"description": "Custom validation message that will override the default message and displayed when the input is invalid.",
|
9543
|
-
"attribute": "validation-message",
|
9544
|
-
"reflects": true,
|
9545
|
-
"inheritedFrom": {
|
9546
|
-
"name": "Buttonsimple",
|
9547
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
9548
|
-
}
|
9549
|
-
},
|
9550
|
-
{
|
9551
|
-
"kind": "field",
|
9552
|
-
"name": "validity",
|
9553
|
-
"type": {
|
9554
|
-
"text": "ValidityState"
|
9555
|
-
},
|
9556
|
-
"readonly": true,
|
9557
|
-
"inheritedFrom": {
|
9558
|
-
"name": "Buttonsimple",
|
9559
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
9560
|
-
}
|
9561
|
-
},
|
9562
|
-
{
|
9563
|
-
"kind": "field",
|
9564
|
-
"name": "willValidate",
|
9565
|
-
"readonly": true,
|
9566
|
-
"inheritedFrom": {
|
9567
|
-
"name": "Buttonsimple",
|
9568
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
9569
|
-
}
|
9570
|
-
},
|
9571
|
-
{
|
9572
|
-
"kind": "method",
|
9573
|
-
"name": "setValidity",
|
9574
|
-
"description": "Sets the validity of the input field based on the input field's validity.",
|
9575
|
-
"return": {
|
9576
|
-
"type": {
|
9577
|
-
"text": ""
|
9578
|
-
}
|
9579
|
-
},
|
9580
|
-
"inheritedFrom": {
|
9581
|
-
"name": "Buttonsimple",
|
9582
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
9583
|
-
}
|
9584
|
-
},
|
9585
|
-
{
|
9586
|
-
"kind": "method",
|
9587
|
-
"name": "checkValidity",
|
9588
|
-
"return": {
|
9589
|
-
"type": {
|
9590
|
-
"text": "boolean"
|
9591
|
-
}
|
9592
|
-
},
|
9593
|
-
"inheritedFrom": {
|
9594
|
-
"name": "Buttonsimple",
|
9595
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
9596
|
-
}
|
9597
|
-
},
|
9598
|
-
{
|
9599
|
-
"kind": "method",
|
9600
|
-
"name": "reportValidity",
|
9601
|
-
"inheritedFrom": {
|
9602
|
-
"name": "Buttonsimple",
|
9603
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
9604
|
-
}
|
9605
|
-
},
|
9606
9088
|
{
|
9607
9089
|
"kind": "field",
|
9608
9090
|
"name": "tabIndex",
|
@@ -9830,44 +9312,6 @@
|
|
9830
9312
|
"module": "src/utils/mixins/IconNameMixin.ts"
|
9831
9313
|
}
|
9832
9314
|
},
|
9833
|
-
{
|
9834
|
-
"name": "name",
|
9835
|
-
"type": {
|
9836
|
-
"text": "string"
|
9837
|
-
},
|
9838
|
-
"default": "''",
|
9839
|
-
"description": "Indicates the name of the component group.\nThey are used to group elements in a form together.",
|
9840
|
-
"fieldName": "name",
|
9841
|
-
"inheritedFrom": {
|
9842
|
-
"name": "Buttonsimple",
|
9843
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
9844
|
-
}
|
9845
|
-
},
|
9846
|
-
{
|
9847
|
-
"name": "value",
|
9848
|
-
"type": {
|
9849
|
-
"text": "string"
|
9850
|
-
},
|
9851
|
-
"default": "''",
|
9852
|
-
"description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
|
9853
|
-
"fieldName": "value",
|
9854
|
-
"inheritedFrom": {
|
9855
|
-
"name": "Buttonsimple",
|
9856
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
9857
|
-
}
|
9858
|
-
},
|
9859
|
-
{
|
9860
|
-
"name": "validation-message",
|
9861
|
-
"type": {
|
9862
|
-
"text": "string | undefined"
|
9863
|
-
},
|
9864
|
-
"description": "Custom validation message that will override the default message and displayed when the input is invalid.",
|
9865
|
-
"fieldName": "validationMessage",
|
9866
|
-
"inheritedFrom": {
|
9867
|
-
"name": "Buttonsimple",
|
9868
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
9869
|
-
}
|
9870
|
-
},
|
9871
9315
|
{
|
9872
9316
|
"name": "tabIndex",
|
9873
9317
|
"type": {
|
@@ -10384,20 +9828,6 @@
|
|
10384
9828
|
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
10385
9829
|
}
|
10386
9830
|
},
|
10387
|
-
{
|
10388
|
-
"kind": "field",
|
10389
|
-
"name": "id",
|
10390
|
-
"type": {
|
10391
|
-
"text": "string"
|
10392
|
-
},
|
10393
|
-
"default": "`mdc-toggle-${uuidv4()}`",
|
10394
|
-
"description": "The unique id of the input field. It is used to link the input field with the label.",
|
10395
|
-
"attribute": "id",
|
10396
|
-
"inheritedFrom": {
|
10397
|
-
"name": "FormfieldWrapper",
|
10398
|
-
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
10399
|
-
}
|
10400
|
-
},
|
10401
9831
|
{
|
10402
9832
|
"kind": "field",
|
10403
9833
|
"name": "name",
|
@@ -10498,6 +9928,20 @@
|
|
10498
9928
|
"module": "utils/mixins/FormInternalsMixin.js"
|
10499
9929
|
}
|
10500
9930
|
},
|
9931
|
+
{
|
9932
|
+
"kind": "field",
|
9933
|
+
"name": "id",
|
9934
|
+
"type": {
|
9935
|
+
"text": "string"
|
9936
|
+
},
|
9937
|
+
"default": "`mdc-input-${uuidv4()}`",
|
9938
|
+
"description": "The unique id of the input field. It is used to link the input field with the label.",
|
9939
|
+
"attribute": "id",
|
9940
|
+
"inheritedFrom": {
|
9941
|
+
"name": "FormfieldWrapper",
|
9942
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
9943
|
+
}
|
9944
|
+
},
|
10501
9945
|
{
|
10502
9946
|
"kind": "field",
|
10503
9947
|
"name": "dataAriaLabel",
|
@@ -11859,6 +11303,11 @@
|
|
11859
11303
|
{
|
11860
11304
|
"kind": "method",
|
11861
11305
|
"name": "reportValidity"
|
11306
|
+
},
|
11307
|
+
{
|
11308
|
+
"kind": "field",
|
11309
|
+
"name": "id",
|
11310
|
+
"default": "`mdc-input-${uuidv4()}`"
|
11862
11311
|
}
|
11863
11312
|
],
|
11864
11313
|
"attributes": [
|