@momentum-design/components 0.57.0 → 0.58.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 +304 -283
- package/dist/browser/index.js.map +4 -4
- package/dist/components/button/button.component.d.ts +3 -56
- package/dist/components/button/button.component.js +3 -96
- package/dist/components/buttonlink/buttonlink.component.d.ts +59 -0
- package/dist/components/buttonlink/buttonlink.component.js +106 -0
- package/dist/components/buttonlink/buttonlink.constants.d.ts +2 -0
- package/dist/components/buttonlink/buttonlink.constants.js +3 -0
- package/dist/components/buttonlink/buttonlink.types.d.ts +7 -0
- package/dist/components/buttonlink/buttonlink.types.js +1 -0
- package/dist/components/buttonlink/index.d.ts +8 -0
- package/dist/components/buttonlink/index.js +5 -0
- package/dist/components/statictoggle/index.d.ts +8 -0
- package/dist/components/statictoggle/index.js +5 -0
- package/dist/components/statictoggle/statictoggle.component.d.ts +48 -0
- package/dist/components/statictoggle/statictoggle.component.js +82 -0
- package/dist/components/statictoggle/statictoggle.constants.d.ts +17 -0
- package/dist/components/statictoggle/statictoggle.constants.js +18 -0
- package/dist/components/statictoggle/statictoggle.styles.d.ts +2 -0
- package/dist/components/statictoggle/statictoggle.styles.js +82 -0
- package/dist/components/statictoggle/statictoggle.types.d.ts +4 -0
- package/dist/components/statictoggle/statictoggle.types.js +1 -0
- package/dist/components/toggle/index.d.ts +2 -1
- package/dist/components/toggle/index.js +2 -1
- package/dist/components/toggle/toggle.component.d.ts +16 -20
- package/dist/components/toggle/toggle.component.js +27 -33
- package/dist/components/toggle/toggle.styles.js +26 -96
- package/dist/custom-elements.json +1806 -828
- package/dist/index.d.ts +3 -1
- package/dist/index.js +3 -1
- package/dist/react/buttonlink/index.d.ts +30 -0
- package/dist/react/buttonlink/index.js +38 -0
- package/dist/react/index.d.ts +3 -1
- package/dist/react/index.js +3 -1
- package/dist/react/statictoggle/index.d.ts +30 -0
- package/dist/react/statictoggle/index.js +39 -0
- package/dist/react/toggle/index.d.ts +14 -18
- package/dist/react/toggle/index.js +14 -18
- package/dist/utils/mixins/ButtonComponentMixin.d.ts +16 -0
- package/dist/utils/mixins/ButtonComponentMixin.js +114 -0
- package/package.json +1 -1
@@ -1439,472 +1439,821 @@
|
|
1439
1439
|
},
|
1440
1440
|
{
|
1441
1441
|
"kind": "javascript-module",
|
1442
|
-
"path": "components/
|
1442
|
+
"path": "components/badge/badge.component.js",
|
1443
1443
|
"declarations": [
|
1444
1444
|
{
|
1445
1445
|
"kind": "class",
|
1446
|
-
"description": "The `mdc-
|
1447
|
-
"name": "
|
1448
|
-
"
|
1446
|
+
"description": "The `mdc-badge` component is a versatile UI element used to\ndisplay dot, icons, counters, success, warning and error type badge.\n\nSupported badge types:\n- `dot`: Displays a dot notification badge with a blue color.\n- `icon`: Displays a badge with a specified icon using the `icon-name` attribute.\n- `counter`: Displays a badge with a counter value. If the counter exceeds the `max-counter`,\nit shows `maxCounter+`. The maximum value of the counter is 999 and anything above that will be set to `999+`.\n- `success`: Displays a success badge with a check circle icon and green color.\n- `warning`: Displays a warning badge with a warning icon and yellow color.\n- `error`: Displays a error badge with a error legacy icon and red color.\n\nFor `icon`, `success`, `warning` and `error` types, the `mdc-icon` component is used to render the icon.\n\nFor the `counter` type, the `mdc-text` component is used to render the counter value.",
|
1447
|
+
"name": "Badge",
|
1448
|
+
"cssProperties": [
|
1449
1449
|
{
|
1450
|
-
"
|
1451
|
-
"name": "
|
1452
|
-
"type": {
|
1453
|
-
"text": "HTMLElement | undefined"
|
1454
|
-
},
|
1455
|
-
"privacy": "private"
|
1450
|
+
"description": "The foreground color of the primary badge.",
|
1451
|
+
"name": "--mdc-badge-primary-foreground-color"
|
1456
1452
|
},
|
1457
1453
|
{
|
1458
|
-
"
|
1459
|
-
"name": "
|
1460
|
-
"type": {
|
1461
|
-
"text": "BrandVisualNames | undefined"
|
1462
|
-
},
|
1463
|
-
"description": "Name of the brandVisual (= filename)",
|
1464
|
-
"attribute": "name",
|
1465
|
-
"reflects": true
|
1454
|
+
"description": "The background color of the primary badge.",
|
1455
|
+
"name": "--mdc-badge-primary-background-color"
|
1466
1456
|
},
|
1467
1457
|
{
|
1468
|
-
"
|
1469
|
-
"name": "
|
1470
|
-
"privacy": "private"
|
1458
|
+
"description": "The foreground color of the secondary badge.",
|
1459
|
+
"name": "--mdc-badge-secondary-foreground-color"
|
1471
1460
|
},
|
1472
1461
|
{
|
1473
|
-
"
|
1474
|
-
"name": "
|
1475
|
-
"privacy": "private",
|
1476
|
-
"parameters": [
|
1477
|
-
{
|
1478
|
-
"name": "brandVisualHtml",
|
1479
|
-
"type": {
|
1480
|
-
"text": "HTMLElement"
|
1481
|
-
},
|
1482
|
-
"description": "The brandvisual html element which has been fetched from the brandvisual provider."
|
1483
|
-
}
|
1484
|
-
],
|
1485
|
-
"description": "Sets the brandVisualData state to the fetched brandvisual.\nDispatches a 'load' event on the component once the brandvisual has been successfully loaded."
|
1462
|
+
"description": "The background color of the secondary badge.",
|
1463
|
+
"name": "--mdc-badge-secondary-background-color"
|
1486
1464
|
},
|
1487
1465
|
{
|
1488
|
-
"
|
1489
|
-
"name": "
|
1490
|
-
"privacy": "private",
|
1491
|
-
"parameters": [
|
1492
|
-
{
|
1493
|
-
"name": "error",
|
1494
|
-
"type": {
|
1495
|
-
"text": "unknown"
|
1496
|
-
}
|
1497
|
-
}
|
1498
|
-
],
|
1499
|
-
"description": "Dispatches an 'error' event on the component when the brandvisual import has failed.\nThis event bubbles and is cancelable.\nThe error detail is set to the error object."
|
1500
|
-
}
|
1501
|
-
],
|
1502
|
-
"events": [
|
1503
|
-
{
|
1504
|
-
"description": "(React: onLoad) This event is dispatched when the brandvisual has been successfully loaded.",
|
1505
|
-
"name": "load",
|
1506
|
-
"reactName": "onLoad"
|
1466
|
+
"description": "The foreground color of the success badge.",
|
1467
|
+
"name": "--mdc-badge-success-foreground-color"
|
1507
1468
|
},
|
1508
1469
|
{
|
1509
|
-
"description": "
|
1510
|
-
"name": "
|
1511
|
-
|
1512
|
-
}
|
1513
|
-
],
|
1514
|
-
"attributes": [
|
1470
|
+
"description": "The background color of the success badge.",
|
1471
|
+
"name": "--mdc-badge-success-background-color"
|
1472
|
+
},
|
1515
1473
|
{
|
1516
|
-
"
|
1517
|
-
"
|
1518
|
-
|
1519
|
-
},
|
1520
|
-
"description": "Name of the brandVisual (= filename)",
|
1521
|
-
"fieldName": "name"
|
1522
|
-
}
|
1523
|
-
],
|
1524
|
-
"superclass": {
|
1525
|
-
"name": "Component",
|
1526
|
-
"module": "/src/models"
|
1527
|
-
},
|
1528
|
-
"tagName": "mdc-brandvisual",
|
1529
|
-
"jsDoc": "/**\n * The `mdc-brandvisual` component is responsible for rendering logos dynamically & ensures they are\n * displayed correctly within applications.\n *\n * Features:\n * - Dynamically loads brandvisuals based on the `name` attribute.\n * - Emits a `load` event when the brandvisual is successfully fetched.\n * - Emits an `error` event when the brandvisual import fails.\n * - Supports accessibility best practices.\n * - Used for brand representation within the design system.\n *\n * @tagname mdc-brandvisual\n *\n * @event load - (React: onLoad) This event is dispatched when the brandvisual has been successfully loaded.\n * @event error - (React: onError) This event is dispatched when the brandvisual fetching has failed.\n *\n */",
|
1530
|
-
"customElement": true
|
1531
|
-
}
|
1532
|
-
],
|
1533
|
-
"exports": [
|
1534
|
-
{
|
1535
|
-
"kind": "js",
|
1536
|
-
"name": "default",
|
1537
|
-
"declaration": {
|
1538
|
-
"name": "Brandvisual",
|
1539
|
-
"module": "components/brandvisual/brandvisual.component.js"
|
1540
|
-
}
|
1541
|
-
}
|
1542
|
-
]
|
1543
|
-
},
|
1544
|
-
{
|
1545
|
-
"kind": "javascript-module",
|
1546
|
-
"path": "components/bullet/bullet.component.js",
|
1547
|
-
"declarations": [
|
1548
|
-
{
|
1549
|
-
"kind": "class",
|
1550
|
-
"description": "Bullet component, which is a visual marker\nand be used to organize and present items in a list format.",
|
1551
|
-
"name": "Bullet",
|
1552
|
-
"cssProperties": [
|
1474
|
+
"description": "The foreground color of the warning badge.",
|
1475
|
+
"name": "--mdc-badge-warning-foreground-color"
|
1476
|
+
},
|
1553
1477
|
{
|
1554
|
-
"description": "background color of the
|
1555
|
-
"name": "--mdc-
|
1478
|
+
"description": "The background color of the warning badge.",
|
1479
|
+
"name": "--mdc-badge-warning-background-color"
|
1556
1480
|
},
|
1557
1481
|
{
|
1558
|
-
"description": "
|
1559
|
-
"name": "--mdc-
|
1482
|
+
"description": "The foreground color of the error badge.",
|
1483
|
+
"name": "--mdc-badge-error-foreground-color"
|
1560
1484
|
},
|
1561
1485
|
{
|
1562
|
-
"description": "
|
1563
|
-
"name": "--mdc-
|
1486
|
+
"description": "The background color of the error badge.",
|
1487
|
+
"name": "--mdc-badge-error-background-color"
|
1564
1488
|
},
|
1565
1489
|
{
|
1566
|
-
"description": "
|
1567
|
-
"name": "--mdc-
|
1490
|
+
"description": "The background color of the badge overlay.",
|
1491
|
+
"name": "--mdc-badge-overlay-background-color"
|
1568
1492
|
}
|
1569
1493
|
],
|
1570
1494
|
"members": [
|
1571
1495
|
{
|
1572
1496
|
"kind": "field",
|
1573
|
-
"name": "
|
1497
|
+
"name": "type",
|
1574
1498
|
"type": {
|
1575
|
-
"text": "
|
1499
|
+
"text": "BadgeType | undefined"
|
1576
1500
|
},
|
1577
|
-
"
|
1578
|
-
"
|
1579
|
-
"default": "small",
|
1580
|
-
"attribute": "size",
|
1501
|
+
"description": "Type of the badge\nCan be `dot` (notification) , `icon`, `counter`, `success`, `warning` or `error`.",
|
1502
|
+
"attribute": "type",
|
1581
1503
|
"reflects": true
|
1582
|
-
}
|
1583
|
-
],
|
1584
|
-
"attributes": [
|
1585
|
-
{
|
1586
|
-
"name": "size",
|
1587
|
-
"type": {
|
1588
|
-
"text": "Size"
|
1589
|
-
},
|
1590
|
-
"description": "Size of the bullet\n\nPossible values: 'small', 'medium', 'large'",
|
1591
|
-
"default": "small",
|
1592
|
-
"fieldName": "size"
|
1593
|
-
}
|
1594
|
-
],
|
1595
|
-
"superclass": {
|
1596
|
-
"name": "Component",
|
1597
|
-
"module": "/src/models"
|
1598
|
-
},
|
1599
|
-
"tagName": "mdc-bullet",
|
1600
|
-
"jsDoc": "/**\n * Bullet component, which is a visual marker\n * and be used to organize and present items in a list format.\n *\n * @tagname mdc-bullet\n *\n * @cssproperty --mdc-bullet-background-color - background color of the bullet\n * @cssproperty --mdc-bullet-size-small - small size value of the bullet\n * @cssproperty --mdc-bullet-size-medium - medium size value of the bullet\n * @cssproperty --mdc-bullet-size-large - large size value of the bullet\n*/",
|
1601
|
-
"customElement": true
|
1602
|
-
}
|
1603
|
-
],
|
1604
|
-
"exports": [
|
1605
|
-
{
|
1606
|
-
"kind": "js",
|
1607
|
-
"name": "default",
|
1608
|
-
"declaration": {
|
1609
|
-
"name": "Bullet",
|
1610
|
-
"module": "components/bullet/bullet.component.js"
|
1611
|
-
}
|
1612
|
-
}
|
1613
|
-
]
|
1614
|
-
},
|
1615
|
-
{
|
1616
|
-
"kind": "javascript-module",
|
1617
|
-
"path": "components/button/button.component.js",
|
1618
|
-
"declarations": [
|
1619
|
-
{
|
1620
|
-
"kind": "class",
|
1621
|
-
"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.",
|
1622
|
-
"name": "Button",
|
1623
|
-
"slots": [
|
1624
|
-
{
|
1625
|
-
"description": "Text label of the button.",
|
1626
|
-
"name": ""
|
1627
|
-
}
|
1628
|
-
],
|
1629
|
-
"members": [
|
1504
|
+
},
|
1630
1505
|
{
|
1631
1506
|
"kind": "field",
|
1632
|
-
"name": "
|
1507
|
+
"name": "variant",
|
1633
1508
|
"type": {
|
1634
|
-
"text": "
|
1509
|
+
"text": "IconVariant"
|
1635
1510
|
},
|
1636
|
-
"description": "
|
1637
|
-
"
|
1511
|
+
"description": "Type of the variant can be `primary` or `secondary`.\nIt defines the background and foreground color of the icon.",
|
1512
|
+
"default": "primary",
|
1513
|
+
"attribute": "variant",
|
1638
1514
|
"reflects": true
|
1639
1515
|
},
|
1640
1516
|
{
|
1641
1517
|
"kind": "field",
|
1642
|
-
"name": "
|
1518
|
+
"name": "counter",
|
1643
1519
|
"type": {
|
1644
|
-
"text": "
|
1520
|
+
"text": "number | undefined"
|
1645
1521
|
},
|
1646
|
-
"description": "
|
1647
|
-
"attribute": "
|
1648
|
-
"reflects": true
|
1522
|
+
"description": "Counter is the number which can be provided in the badge.",
|
1523
|
+
"attribute": "counter"
|
1649
1524
|
},
|
1650
1525
|
{
|
1651
1526
|
"kind": "field",
|
1652
|
-
"name": "
|
1527
|
+
"name": "maxCounter",
|
1653
1528
|
"type": {
|
1654
|
-
"text": "
|
1529
|
+
"text": "number"
|
1655
1530
|
},
|
1656
|
-
"description": "
|
1657
|
-
"default": "
|
1658
|
-
"attribute": "
|
1531
|
+
"description": "The maximum number can be set up to 999, anything above that will be rendered as _999+_.\nThe max counter can be `9`, `99` or `999`.",
|
1532
|
+
"default": "99",
|
1533
|
+
"attribute": "max-counter",
|
1534
|
+
"reflects": true
|
1659
1535
|
},
|
1660
1536
|
{
|
1661
1537
|
"kind": "field",
|
1662
|
-
"name": "
|
1538
|
+
"name": "overlay",
|
1663
1539
|
"type": {
|
1664
|
-
"text": "
|
1540
|
+
"text": "boolean"
|
1665
1541
|
},
|
1666
|
-
"
|
1667
|
-
"
|
1668
|
-
"attribute": "
|
1669
|
-
"reflects": true,
|
1670
|
-
"inheritedFrom": {
|
1671
|
-
"name": "Buttonsimple",
|
1672
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
1673
|
-
}
|
1542
|
+
"default": "false",
|
1543
|
+
"description": "Overlay is to add a thin outline to the badge.\nThis will help distinguish between the badge and the button,\nwhere the badge will be layered on top of a button.",
|
1544
|
+
"attribute": "overlay"
|
1674
1545
|
},
|
1675
1546
|
{
|
1676
1547
|
"kind": "field",
|
1677
|
-
"name": "
|
1548
|
+
"name": "ariaLabel",
|
1678
1549
|
"type": {
|
1679
|
-
"text": "
|
1550
|
+
"text": "string | null"
|
1680
1551
|
},
|
1681
|
-
"
|
1682
|
-
"
|
1683
|
-
"attribute": "
|
1684
|
-
},
|
1685
|
-
{
|
1686
|
-
"kind": "field",
|
1687
|
-
"name": "role",
|
1688
|
-
"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.",
|
1689
|
-
"default": "'button'",
|
1690
|
-
"attribute": "role",
|
1691
|
-
"reflects": true,
|
1692
|
-
"type": {
|
1693
|
-
"text": "string"
|
1694
|
-
},
|
1695
|
-
"inheritedFrom": {
|
1696
|
-
"name": "Buttonsimple",
|
1697
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
1698
|
-
}
|
1552
|
+
"default": "null",
|
1553
|
+
"description": "Aria-label attribute to be set for accessibility",
|
1554
|
+
"attribute": "aria-label"
|
1699
1555
|
},
|
1700
1556
|
{
|
1701
1557
|
"kind": "method",
|
1702
|
-
"name": "
|
1558
|
+
"name": "getCounterText",
|
1703
1559
|
"privacy": "private",
|
1560
|
+
"return": {
|
1561
|
+
"type": {
|
1562
|
+
"text": ""
|
1563
|
+
}
|
1564
|
+
},
|
1704
1565
|
"parameters": [
|
1705
1566
|
{
|
1706
|
-
"name": "
|
1567
|
+
"name": "maxCounter",
|
1568
|
+
"type": {
|
1569
|
+
"text": "number"
|
1570
|
+
},
|
1571
|
+
"description": "the maximum limit which can be displayed on the badge"
|
1572
|
+
},
|
1573
|
+
{
|
1574
|
+
"name": "counter",
|
1707
1575
|
"optional": true,
|
1708
1576
|
"type": {
|
1709
|
-
"text": "
|
1577
|
+
"text": "number"
|
1710
1578
|
},
|
1711
|
-
"description": "
|
1579
|
+
"description": "the number to be displayed on the badge"
|
1712
1580
|
}
|
1713
1581
|
],
|
1714
|
-
"description": "
|
1582
|
+
"description": "If `type` is set to `counter` and if `counter` is greater than `maxCounter`,\nthen it will return a string the maxCounter value as string.\nOtherwise, it will return a string representation of `counter`.\nIf `counter` is not a number, it will return an empty string."
|
1715
1583
|
},
|
1716
1584
|
{
|
1717
1585
|
"kind": "method",
|
1718
|
-
"name": "
|
1586
|
+
"name": "getBadgeIcon",
|
1719
1587
|
"privacy": "private",
|
1588
|
+
"return": {
|
1589
|
+
"type": {
|
1590
|
+
"text": ""
|
1591
|
+
}
|
1592
|
+
},
|
1720
1593
|
"parameters": [
|
1721
1594
|
{
|
1722
|
-
"name": "
|
1595
|
+
"name": "iconName",
|
1723
1596
|
"type": {
|
1724
|
-
"text": "
|
1597
|
+
"text": "string"
|
1725
1598
|
},
|
1726
|
-
"description": "
|
1599
|
+
"description": "the name of the icon from the icon set"
|
1600
|
+
},
|
1601
|
+
{
|
1602
|
+
"name": "backgroundClassPostfix",
|
1603
|
+
"type": {
|
1604
|
+
"text": "string"
|
1605
|
+
},
|
1606
|
+
"description": "postfix for the class to style the badge icon."
|
1727
1607
|
}
|
1728
1608
|
],
|
1729
|
-
"description": "
|
1609
|
+
"description": "Method to generate the badge icon."
|
1730
1610
|
},
|
1731
1611
|
{
|
1732
1612
|
"kind": "method",
|
1733
|
-
"name": "
|
1613
|
+
"name": "getBadgeDot",
|
1734
1614
|
"privacy": "private",
|
1735
|
-
"
|
1736
|
-
{
|
1737
|
-
"
|
1738
|
-
"type": {
|
1739
|
-
"text": "PillButtonSize | IconButtonSize"
|
1740
|
-
},
|
1741
|
-
"description": "The size to set."
|
1615
|
+
"return": {
|
1616
|
+
"type": {
|
1617
|
+
"text": ""
|
1742
1618
|
}
|
1743
|
-
|
1744
|
-
"description": "
|
1619
|
+
},
|
1620
|
+
"description": "Method to generate the badge dot template."
|
1745
1621
|
},
|
1746
1622
|
{
|
1747
1623
|
"kind": "method",
|
1748
|
-
"name": "
|
1624
|
+
"name": "getBadgeCounterText",
|
1749
1625
|
"privacy": "private",
|
1750
|
-
"
|
1751
|
-
{
|
1752
|
-
"
|
1753
|
-
"type": {
|
1754
|
-
"text": "ButtonColor"
|
1755
|
-
},
|
1756
|
-
"description": "The color to set."
|
1626
|
+
"return": {
|
1627
|
+
"type": {
|
1628
|
+
"text": ""
|
1757
1629
|
}
|
1758
|
-
|
1759
|
-
"description": "
|
1630
|
+
},
|
1631
|
+
"description": "Method to generate the badge text and counter template."
|
1760
1632
|
},
|
1761
1633
|
{
|
1762
1634
|
"kind": "method",
|
1763
|
-
"name": "
|
1635
|
+
"name": "setRoleByAriaLabel",
|
1764
1636
|
"privacy": "private",
|
1765
|
-
"
|
1766
|
-
|
1767
|
-
|
1768
|
-
"description": "default slot of button",
|
1769
|
-
"name": "slot"
|
1637
|
+
"return": {
|
1638
|
+
"type": {
|
1639
|
+
"text": "void"
|
1770
1640
|
}
|
1771
|
-
|
1641
|
+
},
|
1642
|
+
"description": "Method to set the role based on the aria-label provided.\nIf the aria-label is provided, the role of the element will be 'img'.\nOtherwise, the role will be null."
|
1772
1643
|
},
|
1773
1644
|
{
|
1774
|
-
"kind": "
|
1775
|
-
"name": "
|
1776
|
-
"
|
1777
|
-
|
1645
|
+
"kind": "method",
|
1646
|
+
"name": "getBadgeContentBasedOnType",
|
1647
|
+
"privacy": "private",
|
1648
|
+
"return": {
|
1649
|
+
"type": {
|
1650
|
+
"text": ""
|
1651
|
+
}
|
1778
1652
|
},
|
1779
|
-
"
|
1780
|
-
"description": "This property specifies the tab order of the element.",
|
1781
|
-
"attribute": "tabIndex",
|
1782
|
-
"reflects": true,
|
1783
|
-
"inheritedFrom": {
|
1784
|
-
"name": "TabIndexMixin",
|
1785
|
-
"module": "utils/mixins/TabIndexMixin.js"
|
1786
|
-
}
|
1653
|
+
"description": "Generates the badge content based on the badge type.\nUtilizes various helper methods to create the appropriate badge template based on the\ncurrent badge type. Supports 'dot', 'icon', 'counter', 'success', 'warning', and 'error'\ntypes, returning the corresponding template result for each type."
|
1787
1654
|
},
|
1788
1655
|
{
|
1789
1656
|
"kind": "field",
|
1790
|
-
"name": "
|
1657
|
+
"name": "iconName",
|
1791
1658
|
"type": {
|
1792
|
-
"text": "
|
1659
|
+
"text": "IconNames | undefined"
|
1793
1660
|
},
|
1794
|
-
"description": "
|
1795
|
-
"
|
1796
|
-
"attribute": "disabled",
|
1797
|
-
"reflects": true,
|
1661
|
+
"description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
|
1662
|
+
"attribute": "icon-name",
|
1798
1663
|
"inheritedFrom": {
|
1799
|
-
"name": "
|
1800
|
-
"module": "utils/mixins/
|
1664
|
+
"name": "IconNameMixin",
|
1665
|
+
"module": "utils/mixins/IconNameMixin.js"
|
1801
1666
|
}
|
1667
|
+
}
|
1668
|
+
],
|
1669
|
+
"attributes": [
|
1670
|
+
{
|
1671
|
+
"name": "type",
|
1672
|
+
"type": {
|
1673
|
+
"text": "BadgeType | undefined"
|
1674
|
+
},
|
1675
|
+
"description": "Type of the badge\nCan be `dot` (notification) , `icon`, `counter`, `success`, `warning` or `error`.",
|
1676
|
+
"fieldName": "type"
|
1802
1677
|
},
|
1803
1678
|
{
|
1804
|
-
"
|
1805
|
-
"name": "active",
|
1679
|
+
"name": "variant",
|
1806
1680
|
"type": {
|
1807
|
-
"text": "
|
1681
|
+
"text": "IconVariant"
|
1808
1682
|
},
|
1809
|
-
"description": "
|
1810
|
-
"default": "
|
1811
|
-
"
|
1812
|
-
"reflects": true,
|
1813
|
-
"inheritedFrom": {
|
1814
|
-
"name": "Buttonsimple",
|
1815
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
1816
|
-
}
|
1683
|
+
"description": "Type of the variant can be `primary` or `secondary`.\nIt defines the background and foreground color of the icon.",
|
1684
|
+
"default": "primary",
|
1685
|
+
"fieldName": "variant"
|
1817
1686
|
},
|
1818
1687
|
{
|
1819
|
-
"
|
1820
|
-
"name": "softDisabled",
|
1688
|
+
"name": "counter",
|
1821
1689
|
"type": {
|
1822
|
-
"text": "
|
1690
|
+
"text": "number | undefined"
|
1823
1691
|
},
|
1824
|
-
"description": "
|
1825
|
-
"
|
1826
|
-
"attribute": "soft-disabled",
|
1827
|
-
"inheritedFrom": {
|
1828
|
-
"name": "Buttonsimple",
|
1829
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
1830
|
-
}
|
1692
|
+
"description": "Counter is the number which can be provided in the badge.",
|
1693
|
+
"fieldName": "counter"
|
1831
1694
|
},
|
1832
1695
|
{
|
1833
|
-
"
|
1834
|
-
"name": "ariaStateKey",
|
1696
|
+
"name": "max-counter",
|
1835
1697
|
"type": {
|
1836
|
-
"text": "
|
1698
|
+
"text": "number"
|
1837
1699
|
},
|
1838
|
-
"description": "
|
1839
|
-
"default": "
|
1840
|
-
"
|
1841
|
-
"reflects": true,
|
1842
|
-
"inheritedFrom": {
|
1843
|
-
"name": "Buttonsimple",
|
1844
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
1845
|
-
}
|
1700
|
+
"description": "The maximum number can be set up to 999, anything above that will be rendered as _999+_.\nThe max counter can be `9`, `99` or `999`.",
|
1701
|
+
"default": "99",
|
1702
|
+
"fieldName": "maxCounter"
|
1846
1703
|
},
|
1847
1704
|
{
|
1848
|
-
"
|
1849
|
-
"name": "type",
|
1705
|
+
"name": "overlay",
|
1850
1706
|
"type": {
|
1851
|
-
"text": "
|
1707
|
+
"text": "boolean"
|
1852
1708
|
},
|
1853
|
-
"
|
1854
|
-
"
|
1855
|
-
"
|
1856
|
-
"reflects": true,
|
1857
|
-
"inheritedFrom": {
|
1858
|
-
"name": "Buttonsimple",
|
1859
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
1860
|
-
}
|
1709
|
+
"default": "false",
|
1710
|
+
"description": "Overlay is to add a thin outline to the badge.\nThis will help distinguish between the badge and the button,\nwhere the badge will be layered on top of a button.",
|
1711
|
+
"fieldName": "overlay"
|
1861
1712
|
},
|
1862
1713
|
{
|
1863
|
-
"
|
1864
|
-
"
|
1865
|
-
|
1866
|
-
|
1867
|
-
|
1868
|
-
|
1869
|
-
|
1714
|
+
"name": "aria-label",
|
1715
|
+
"type": {
|
1716
|
+
"text": "string | null"
|
1717
|
+
},
|
1718
|
+
"default": "null",
|
1719
|
+
"description": "Aria-label attribute to be set for accessibility",
|
1720
|
+
"fieldName": "ariaLabel"
|
1870
1721
|
},
|
1871
1722
|
{
|
1872
|
-
"
|
1873
|
-
"
|
1874
|
-
|
1875
|
-
|
1876
|
-
|
1877
|
-
|
1878
|
-
"type": {
|
1879
|
-
"text": "HTMLElement"
|
1880
|
-
},
|
1881
|
-
"description": "The button element"
|
1882
|
-
},
|
1883
|
-
{
|
1884
|
-
"name": "active",
|
1885
|
-
"optional": true,
|
1886
|
-
"type": {
|
1887
|
-
"text": "boolean"
|
1888
|
-
},
|
1889
|
-
"description": "The active state of the element"
|
1890
|
-
}
|
1891
|
-
],
|
1892
|
-
"description": "Sets the ariaStateKey attributes based on the active state of the button.",
|
1723
|
+
"name": "icon-name",
|
1724
|
+
"type": {
|
1725
|
+
"text": "IconNames | undefined"
|
1726
|
+
},
|
1727
|
+
"description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
|
1728
|
+
"fieldName": "iconName",
|
1893
1729
|
"inheritedFrom": {
|
1894
|
-
"name": "
|
1895
|
-
"module": "
|
1730
|
+
"name": "IconNameMixin",
|
1731
|
+
"module": "src/utils/mixins/IconNameMixin.ts"
|
1896
1732
|
}
|
1897
|
-
}
|
1733
|
+
}
|
1734
|
+
],
|
1735
|
+
"mixins": [
|
1898
1736
|
{
|
1899
|
-
"
|
1900
|
-
"
|
1901
|
-
|
1902
|
-
|
1903
|
-
|
1904
|
-
|
1905
|
-
|
1906
|
-
|
1907
|
-
|
1737
|
+
"name": "IconNameMixin",
|
1738
|
+
"module": "/src/utils/mixins/IconNameMixin"
|
1739
|
+
}
|
1740
|
+
],
|
1741
|
+
"superclass": {
|
1742
|
+
"name": "Component",
|
1743
|
+
"module": "/src/models"
|
1744
|
+
},
|
1745
|
+
"tagName": "mdc-badge",
|
1746
|
+
"jsDoc": "/**\n * The `mdc-badge` component is a versatile UI element used to\n * display dot, icons, counters, success, warning and error type badge.\n *\n * Supported badge types:\n * - `dot`: Displays a dot notification badge with a blue color.\n * - `icon`: Displays a badge with a specified icon using the `icon-name` attribute.\n * - `counter`: Displays a badge with a counter value. If the counter exceeds the `max-counter`,\n * it shows `maxCounter+`. The maximum value of the counter is 999 and anything above that will be set to `999+`.\n * - `success`: Displays a success badge with a check circle icon and green color.\n * - `warning`: Displays a warning badge with a warning icon and yellow color.\n * - `error`: Displays a error badge with a error legacy icon and red color.\n *\n * For `icon`, `success`, `warning` and `error` types, the `mdc-icon` component is used to render the icon.\n *\n * For the `counter` type, the `mdc-text` component is used to render the counter value.\n *\n * @dependency mdc-icon\n * @dependency mdc-text\n *\n * @tagname mdc-badge\n *\n * @cssproperty --mdc-badge-primary-foreground-color - The foreground color of the primary badge.\n * @cssproperty --mdc-badge-primary-background-color - The background color of the primary badge.\n * @cssproperty --mdc-badge-secondary-foreground-color - The foreground color of the secondary badge.\n * @cssproperty --mdc-badge-secondary-background-color - The background color of the secondary badge.\n * @cssproperty --mdc-badge-success-foreground-color - The foreground color of the success badge.\n * @cssproperty --mdc-badge-success-background-color - The background color of the success badge.\n * @cssproperty --mdc-badge-warning-foreground-color - The foreground color of the warning badge.\n * @cssproperty --mdc-badge-warning-background-color - The background color of the warning badge.\n * @cssproperty --mdc-badge-error-foreground-color - The foreground color of the error badge.\n * @cssproperty --mdc-badge-error-background-color - The background color of the error badge.\n * @cssproperty --mdc-badge-overlay-background-color - The background color of the badge overlay.\n */",
|
1747
|
+
"customElement": true
|
1748
|
+
}
|
1749
|
+
],
|
1750
|
+
"exports": [
|
1751
|
+
{
|
1752
|
+
"kind": "js",
|
1753
|
+
"name": "default",
|
1754
|
+
"declaration": {
|
1755
|
+
"name": "Badge",
|
1756
|
+
"module": "components/badge/badge.component.js"
|
1757
|
+
}
|
1758
|
+
}
|
1759
|
+
]
|
1760
|
+
},
|
1761
|
+
{
|
1762
|
+
"kind": "javascript-module",
|
1763
|
+
"path": "components/brandvisual/brandvisual.component.js",
|
1764
|
+
"declarations": [
|
1765
|
+
{
|
1766
|
+
"kind": "class",
|
1767
|
+
"description": "The `mdc-brandvisual` component is responsible for rendering logos dynamically & ensures they are\ndisplayed correctly within applications.\n\nFeatures:\n- Dynamically loads brandvisuals based on the `name` attribute.\n- Emits a `load` event when the brandvisual is successfully fetched.\n- Emits an `error` event when the brandvisual import fails.\n- Supports accessibility best practices.\n- Used for brand representation within the design system.",
|
1768
|
+
"name": "Brandvisual",
|
1769
|
+
"members": [
|
1770
|
+
{
|
1771
|
+
"kind": "field",
|
1772
|
+
"name": "brandVisualData",
|
1773
|
+
"type": {
|
1774
|
+
"text": "HTMLElement | undefined"
|
1775
|
+
},
|
1776
|
+
"privacy": "private"
|
1777
|
+
},
|
1778
|
+
{
|
1779
|
+
"kind": "field",
|
1780
|
+
"name": "name",
|
1781
|
+
"type": {
|
1782
|
+
"text": "BrandVisualNames | undefined"
|
1783
|
+
},
|
1784
|
+
"description": "Name of the brandVisual (= filename)",
|
1785
|
+
"attribute": "name",
|
1786
|
+
"reflects": true
|
1787
|
+
},
|
1788
|
+
{
|
1789
|
+
"kind": "method",
|
1790
|
+
"name": "getBrandVisualData",
|
1791
|
+
"privacy": "private"
|
1792
|
+
},
|
1793
|
+
{
|
1794
|
+
"kind": "method",
|
1795
|
+
"name": "handleBrandVisualLoadedSuccess",
|
1796
|
+
"privacy": "private",
|
1797
|
+
"parameters": [
|
1798
|
+
{
|
1799
|
+
"name": "brandVisualHtml",
|
1800
|
+
"type": {
|
1801
|
+
"text": "HTMLElement"
|
1802
|
+
},
|
1803
|
+
"description": "The brandvisual html element which has been fetched from the brandvisual provider."
|
1804
|
+
}
|
1805
|
+
],
|
1806
|
+
"description": "Sets the brandVisualData state to the fetched brandvisual.\nDispatches a 'load' event on the component once the brandvisual has been successfully loaded."
|
1807
|
+
},
|
1808
|
+
{
|
1809
|
+
"kind": "method",
|
1810
|
+
"name": "handleBrandVisualLoadedFailure",
|
1811
|
+
"privacy": "private",
|
1812
|
+
"parameters": [
|
1813
|
+
{
|
1814
|
+
"name": "error",
|
1815
|
+
"type": {
|
1816
|
+
"text": "unknown"
|
1817
|
+
}
|
1818
|
+
}
|
1819
|
+
],
|
1820
|
+
"description": "Dispatches an 'error' event on the component when the brandvisual import has failed.\nThis event bubbles and is cancelable.\nThe error detail is set to the error object."
|
1821
|
+
}
|
1822
|
+
],
|
1823
|
+
"events": [
|
1824
|
+
{
|
1825
|
+
"description": "(React: onLoad) This event is dispatched when the brandvisual has been successfully loaded.",
|
1826
|
+
"name": "load",
|
1827
|
+
"reactName": "onLoad"
|
1828
|
+
},
|
1829
|
+
{
|
1830
|
+
"description": "(React: onError) This event is dispatched when the brandvisual fetching has failed.",
|
1831
|
+
"name": "error",
|
1832
|
+
"reactName": "onError"
|
1833
|
+
}
|
1834
|
+
],
|
1835
|
+
"attributes": [
|
1836
|
+
{
|
1837
|
+
"name": "name",
|
1838
|
+
"type": {
|
1839
|
+
"text": "BrandVisualNames | undefined"
|
1840
|
+
},
|
1841
|
+
"description": "Name of the brandVisual (= filename)",
|
1842
|
+
"fieldName": "name"
|
1843
|
+
}
|
1844
|
+
],
|
1845
|
+
"superclass": {
|
1846
|
+
"name": "Component",
|
1847
|
+
"module": "/src/models"
|
1848
|
+
},
|
1849
|
+
"tagName": "mdc-brandvisual",
|
1850
|
+
"jsDoc": "/**\n * The `mdc-brandvisual` component is responsible for rendering logos dynamically & ensures they are\n * displayed correctly within applications.\n *\n * Features:\n * - Dynamically loads brandvisuals based on the `name` attribute.\n * - Emits a `load` event when the brandvisual is successfully fetched.\n * - Emits an `error` event when the brandvisual import fails.\n * - Supports accessibility best practices.\n * - Used for brand representation within the design system.\n *\n * @tagname mdc-brandvisual\n *\n * @event load - (React: onLoad) This event is dispatched when the brandvisual has been successfully loaded.\n * @event error - (React: onError) This event is dispatched when the brandvisual fetching has failed.\n *\n */",
|
1851
|
+
"customElement": true
|
1852
|
+
}
|
1853
|
+
],
|
1854
|
+
"exports": [
|
1855
|
+
{
|
1856
|
+
"kind": "js",
|
1857
|
+
"name": "default",
|
1858
|
+
"declaration": {
|
1859
|
+
"name": "Brandvisual",
|
1860
|
+
"module": "components/brandvisual/brandvisual.component.js"
|
1861
|
+
}
|
1862
|
+
}
|
1863
|
+
]
|
1864
|
+
},
|
1865
|
+
{
|
1866
|
+
"kind": "javascript-module",
|
1867
|
+
"path": "components/bullet/bullet.component.js",
|
1868
|
+
"declarations": [
|
1869
|
+
{
|
1870
|
+
"kind": "class",
|
1871
|
+
"description": "Bullet component, which is a visual marker\nand be used to organize and present items in a list format.",
|
1872
|
+
"name": "Bullet",
|
1873
|
+
"cssProperties": [
|
1874
|
+
{
|
1875
|
+
"description": "background color of the bullet",
|
1876
|
+
"name": "--mdc-bullet-background-color"
|
1877
|
+
},
|
1878
|
+
{
|
1879
|
+
"description": "small size value of the bullet",
|
1880
|
+
"name": "--mdc-bullet-size-small"
|
1881
|
+
},
|
1882
|
+
{
|
1883
|
+
"description": "medium size value of the bullet",
|
1884
|
+
"name": "--mdc-bullet-size-medium"
|
1885
|
+
},
|
1886
|
+
{
|
1887
|
+
"description": "large size value of the bullet",
|
1888
|
+
"name": "--mdc-bullet-size-large"
|
1889
|
+
}
|
1890
|
+
],
|
1891
|
+
"members": [
|
1892
|
+
{
|
1893
|
+
"kind": "field",
|
1894
|
+
"name": "size",
|
1895
|
+
"type": {
|
1896
|
+
"text": "Size"
|
1897
|
+
},
|
1898
|
+
"privacy": "public",
|
1899
|
+
"description": "Size of the bullet\n\nPossible values: 'small', 'medium', 'large'",
|
1900
|
+
"default": "small",
|
1901
|
+
"attribute": "size",
|
1902
|
+
"reflects": true
|
1903
|
+
}
|
1904
|
+
],
|
1905
|
+
"attributes": [
|
1906
|
+
{
|
1907
|
+
"name": "size",
|
1908
|
+
"type": {
|
1909
|
+
"text": "Size"
|
1910
|
+
},
|
1911
|
+
"description": "Size of the bullet\n\nPossible values: 'small', 'medium', 'large'",
|
1912
|
+
"default": "small",
|
1913
|
+
"fieldName": "size"
|
1914
|
+
}
|
1915
|
+
],
|
1916
|
+
"superclass": {
|
1917
|
+
"name": "Component",
|
1918
|
+
"module": "/src/models"
|
1919
|
+
},
|
1920
|
+
"tagName": "mdc-bullet",
|
1921
|
+
"jsDoc": "/**\n * Bullet component, which is a visual marker\n * and be used to organize and present items in a list format.\n *\n * @tagname mdc-bullet\n *\n * @cssproperty --mdc-bullet-background-color - background color of the bullet\n * @cssproperty --mdc-bullet-size-small - small size value of the bullet\n * @cssproperty --mdc-bullet-size-medium - medium size value of the bullet\n * @cssproperty --mdc-bullet-size-large - large size value of the bullet\n*/",
|
1922
|
+
"customElement": true
|
1923
|
+
}
|
1924
|
+
],
|
1925
|
+
"exports": [
|
1926
|
+
{
|
1927
|
+
"kind": "js",
|
1928
|
+
"name": "default",
|
1929
|
+
"declaration": {
|
1930
|
+
"name": "Bullet",
|
1931
|
+
"module": "components/bullet/bullet.component.js"
|
1932
|
+
}
|
1933
|
+
}
|
1934
|
+
]
|
1935
|
+
},
|
1936
|
+
{
|
1937
|
+
"kind": "javascript-module",
|
1938
|
+
"path": "components/button/button.component.js",
|
1939
|
+
"declarations": [
|
1940
|
+
{
|
1941
|
+
"kind": "class",
|
1942
|
+
"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.",
|
1943
|
+
"name": "Button",
|
1944
|
+
"slots": [
|
1945
|
+
{
|
1946
|
+
"description": "Text label of the button.",
|
1947
|
+
"name": ""
|
1948
|
+
}
|
1949
|
+
],
|
1950
|
+
"members": [
|
1951
|
+
{
|
1952
|
+
"kind": "field",
|
1953
|
+
"name": "size",
|
1954
|
+
"type": {
|
1955
|
+
"text": "ButtonSize"
|
1956
|
+
},
|
1957
|
+
"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.",
|
1958
|
+
"default": "32",
|
1959
|
+
"attribute": "size",
|
1960
|
+
"reflects": true,
|
1961
|
+
"inheritedFrom": {
|
1962
|
+
"name": "Buttonsimple",
|
1963
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
1964
|
+
}
|
1965
|
+
},
|
1966
|
+
{
|
1967
|
+
"kind": "field",
|
1968
|
+
"name": "role",
|
1969
|
+
"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.",
|
1970
|
+
"default": "'button'",
|
1971
|
+
"attribute": "role",
|
1972
|
+
"reflects": true,
|
1973
|
+
"type": {
|
1974
|
+
"text": "string"
|
1975
|
+
},
|
1976
|
+
"inheritedFrom": {
|
1977
|
+
"name": "Buttonsimple",
|
1978
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
1979
|
+
}
|
1980
|
+
},
|
1981
|
+
{
|
1982
|
+
"kind": "method",
|
1983
|
+
"name": "inferFilledIconName",
|
1984
|
+
"privacy": "private",
|
1985
|
+
"parameters": [
|
1986
|
+
{
|
1987
|
+
"name": "active",
|
1988
|
+
"optional": true,
|
1989
|
+
"type": {
|
1990
|
+
"text": "boolean"
|
1991
|
+
},
|
1992
|
+
"description": "The active state."
|
1993
|
+
}
|
1994
|
+
],
|
1995
|
+
"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."
|
1996
|
+
},
|
1997
|
+
{
|
1998
|
+
"kind": "field",
|
1999
|
+
"name": "prefixIcon",
|
2000
|
+
"type": {
|
2001
|
+
"text": "IconNames | undefined"
|
2002
|
+
},
|
2003
|
+
"description": "The name of the icon to display as a prefix.\nThe icon is displayed on the left side of the button.",
|
2004
|
+
"attribute": "prefix-icon",
|
2005
|
+
"reflects": true,
|
2006
|
+
"inheritedFrom": {
|
2007
|
+
"name": "ButtonComponentMixin",
|
2008
|
+
"module": "utils/mixins/ButtonComponentMixin.js"
|
2009
|
+
}
|
2010
|
+
},
|
2011
|
+
{
|
2012
|
+
"kind": "field",
|
2013
|
+
"name": "postfixIcon",
|
2014
|
+
"type": {
|
2015
|
+
"text": "IconNames | undefined"
|
2016
|
+
},
|
2017
|
+
"description": "The name of the icon to display as a postfix.\nThe icon is displayed on the right side of the button.",
|
2018
|
+
"attribute": "postfix-icon",
|
2019
|
+
"reflects": true,
|
2020
|
+
"inheritedFrom": {
|
2021
|
+
"name": "ButtonComponentMixin",
|
2022
|
+
"module": "utils/mixins/ButtonComponentMixin.js"
|
2023
|
+
}
|
2024
|
+
},
|
2025
|
+
{
|
2026
|
+
"kind": "field",
|
2027
|
+
"name": "variant",
|
2028
|
+
"type": {
|
2029
|
+
"text": "ButtonVariant"
|
2030
|
+
},
|
2031
|
+
"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.",
|
2032
|
+
"default": "primary",
|
2033
|
+
"attribute": "variant",
|
2034
|
+
"inheritedFrom": {
|
2035
|
+
"name": "ButtonComponentMixin",
|
2036
|
+
"module": "utils/mixins/ButtonComponentMixin.js"
|
2037
|
+
}
|
2038
|
+
},
|
2039
|
+
{
|
2040
|
+
"kind": "field",
|
2041
|
+
"name": "color",
|
2042
|
+
"type": {
|
2043
|
+
"text": "ButtonColor"
|
2044
|
+
},
|
2045
|
+
"description": "There are 5 colors for button: positive, negative, accent, promotional, default.",
|
2046
|
+
"default": "default",
|
2047
|
+
"attribute": "color",
|
2048
|
+
"inheritedFrom": {
|
2049
|
+
"name": "ButtonComponentMixin",
|
2050
|
+
"module": "utils/mixins/ButtonComponentMixin.js"
|
2051
|
+
}
|
2052
|
+
},
|
2053
|
+
{
|
2054
|
+
"kind": "method",
|
2055
|
+
"name": "setVariant",
|
2056
|
+
"parameters": [
|
2057
|
+
{
|
2058
|
+
"name": "variant",
|
2059
|
+
"type": {
|
2060
|
+
"text": "ButtonVariant"
|
2061
|
+
},
|
2062
|
+
"description": "The variant to set."
|
2063
|
+
}
|
2064
|
+
],
|
2065
|
+
"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.",
|
2066
|
+
"inheritedFrom": {
|
2067
|
+
"name": "ButtonComponentMixin",
|
2068
|
+
"module": "utils/mixins/ButtonComponentMixin.js"
|
2069
|
+
}
|
2070
|
+
},
|
2071
|
+
{
|
2072
|
+
"kind": "method",
|
2073
|
+
"name": "setColor",
|
2074
|
+
"parameters": [
|
2075
|
+
{
|
2076
|
+
"name": "color",
|
2077
|
+
"type": {
|
2078
|
+
"text": "ButtonColor"
|
2079
|
+
},
|
2080
|
+
"description": "The color to set."
|
2081
|
+
}
|
2082
|
+
],
|
2083
|
+
"description": "Sets the color attribute for the button.\nDefaults to DEFAULTS.COLOR if invalid or for tertiary button.",
|
2084
|
+
"inheritedFrom": {
|
2085
|
+
"name": "ButtonComponentMixin",
|
2086
|
+
"module": "utils/mixins/ButtonComponentMixin.js"
|
2087
|
+
}
|
2088
|
+
},
|
2089
|
+
{
|
2090
|
+
"kind": "method",
|
2091
|
+
"name": "setSize",
|
2092
|
+
"parameters": [
|
2093
|
+
{
|
2094
|
+
"name": "size",
|
2095
|
+
"type": {
|
2096
|
+
"text": "PillButtonSize | IconButtonSize"
|
2097
|
+
},
|
2098
|
+
"description": "The size to set."
|
2099
|
+
}
|
2100
|
+
],
|
2101
|
+
"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.",
|
2102
|
+
"inheritedFrom": {
|
2103
|
+
"name": "ButtonComponentMixin",
|
2104
|
+
"module": "utils/mixins/ButtonComponentMixin.js"
|
2105
|
+
}
|
2106
|
+
},
|
2107
|
+
{
|
2108
|
+
"kind": "method",
|
2109
|
+
"name": "inferButtonType",
|
2110
|
+
"description": "Infers the type of button based on the presence of slot and/or prefix and postfix icons.",
|
2111
|
+
"parameters": [
|
2112
|
+
{
|
2113
|
+
"description": "default slot of button",
|
2114
|
+
"name": "slot"
|
2115
|
+
}
|
2116
|
+
],
|
2117
|
+
"inheritedFrom": {
|
2118
|
+
"name": "ButtonComponentMixin",
|
2119
|
+
"module": "utils/mixins/ButtonComponentMixin.js"
|
2120
|
+
}
|
2121
|
+
},
|
2122
|
+
{
|
2123
|
+
"kind": "field",
|
2124
|
+
"name": "tabIndex",
|
2125
|
+
"type": {
|
2126
|
+
"text": "number"
|
2127
|
+
},
|
2128
|
+
"default": "0",
|
2129
|
+
"description": "This property specifies the tab order of the element.",
|
2130
|
+
"attribute": "tabIndex",
|
2131
|
+
"reflects": true,
|
2132
|
+
"inheritedFrom": {
|
2133
|
+
"name": "TabIndexMixin",
|
2134
|
+
"module": "utils/mixins/TabIndexMixin.js"
|
2135
|
+
}
|
2136
|
+
},
|
2137
|
+
{
|
2138
|
+
"kind": "field",
|
2139
|
+
"name": "disabled",
|
2140
|
+
"type": {
|
2141
|
+
"text": "boolean | undefined"
|
2142
|
+
},
|
2143
|
+
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
2144
|
+
"default": "undefined",
|
2145
|
+
"attribute": "disabled",
|
2146
|
+
"reflects": true,
|
2147
|
+
"inheritedFrom": {
|
2148
|
+
"name": "DisabledMixin",
|
2149
|
+
"module": "utils/mixins/DisabledMixin.js"
|
2150
|
+
}
|
2151
|
+
},
|
2152
|
+
{
|
2153
|
+
"kind": "field",
|
2154
|
+
"name": "active",
|
2155
|
+
"type": {
|
2156
|
+
"text": "boolean | undefined"
|
2157
|
+
},
|
2158
|
+
"description": "The button's active state indicates whether it is currently toggled on (active) or off (inactive).\nWhen the active state is true, the button is considered to be in an active state, meaning it is toggled on.\nConversely, when the active state is false, the button is in an inactive state, indicating it is toggled off.\n\nThis attribute is used to set the provided `ariaStateKey` to true or false.",
|
2159
|
+
"default": "undefined",
|
2160
|
+
"attribute": "active",
|
2161
|
+
"reflects": true,
|
2162
|
+
"inheritedFrom": {
|
2163
|
+
"name": "Buttonsimple",
|
2164
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
2165
|
+
}
|
2166
|
+
},
|
2167
|
+
{
|
2168
|
+
"kind": "field",
|
2169
|
+
"name": "softDisabled",
|
2170
|
+
"type": {
|
2171
|
+
"text": "boolean | undefined"
|
2172
|
+
},
|
2173
|
+
"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.",
|
2174
|
+
"default": "undefined",
|
2175
|
+
"attribute": "soft-disabled",
|
2176
|
+
"inheritedFrom": {
|
2177
|
+
"name": "Buttonsimple",
|
2178
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
2179
|
+
}
|
2180
|
+
},
|
2181
|
+
{
|
2182
|
+
"kind": "field",
|
2183
|
+
"name": "ariaStateKey",
|
2184
|
+
"type": {
|
2185
|
+
"text": "string | undefined"
|
2186
|
+
},
|
2187
|
+
"description": "This property defines the ARIA state key, which will be toggled when the\nButton is set to `active`.\nThe default value is 'aria-pressed', which is commonly used for toggle buttons.\n\nConsumers can override this property to use a different ARIA state key if needed.\nIn case multiple aria attributes should be toggled, they can be passed in as\na comma separated string.\nFor example: `aria-pressed,aria-expanded`",
|
2188
|
+
"default": "'aria-pressed' (when)",
|
2189
|
+
"attribute": "ariaStateKey",
|
2190
|
+
"reflects": true,
|
2191
|
+
"inheritedFrom": {
|
2192
|
+
"name": "Buttonsimple",
|
2193
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
2194
|
+
}
|
2195
|
+
},
|
2196
|
+
{
|
2197
|
+
"kind": "field",
|
2198
|
+
"name": "type",
|
2199
|
+
"type": {
|
2200
|
+
"text": "ButtonType"
|
2201
|
+
},
|
2202
|
+
"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.",
|
2203
|
+
"default": "button",
|
2204
|
+
"attribute": "type",
|
2205
|
+
"reflects": true,
|
2206
|
+
"inheritedFrom": {
|
2207
|
+
"name": "Buttonsimple",
|
2208
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
2209
|
+
}
|
2210
|
+
},
|
2211
|
+
{
|
2212
|
+
"kind": "method",
|
2213
|
+
"name": "executeAction",
|
2214
|
+
"privacy": "protected",
|
2215
|
+
"inheritedFrom": {
|
2216
|
+
"name": "Buttonsimple",
|
2217
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
2218
|
+
}
|
2219
|
+
},
|
2220
|
+
{
|
2221
|
+
"kind": "method",
|
2222
|
+
"name": "setActive",
|
2223
|
+
"privacy": "protected",
|
2224
|
+
"parameters": [
|
2225
|
+
{
|
2226
|
+
"name": "element",
|
2227
|
+
"type": {
|
2228
|
+
"text": "HTMLElement"
|
2229
|
+
},
|
2230
|
+
"description": "The button element"
|
2231
|
+
},
|
2232
|
+
{
|
2233
|
+
"name": "active",
|
2234
|
+
"optional": true,
|
2235
|
+
"type": {
|
2236
|
+
"text": "boolean"
|
2237
|
+
},
|
2238
|
+
"description": "The active state of the element"
|
2239
|
+
}
|
2240
|
+
],
|
2241
|
+
"description": "Sets the ariaStateKey attributes based on the active state of the button.",
|
2242
|
+
"inheritedFrom": {
|
2243
|
+
"name": "Buttonsimple",
|
2244
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
2245
|
+
}
|
2246
|
+
},
|
2247
|
+
{
|
2248
|
+
"kind": "method",
|
2249
|
+
"name": "setSoftDisabled",
|
2250
|
+
"privacy": "private",
|
2251
|
+
"parameters": [
|
2252
|
+
{
|
2253
|
+
"name": "element",
|
2254
|
+
"type": {
|
2255
|
+
"text": "HTMLElement"
|
2256
|
+
},
|
1908
2257
|
"description": "The button element."
|
1909
2258
|
},
|
1910
2259
|
{
|
@@ -1919,599 +2268,910 @@
|
|
1919
2268
|
"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.",
|
1920
2269
|
"inheritedFrom": {
|
1921
2270
|
"name": "Buttonsimple",
|
1922
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
2271
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
2272
|
+
}
|
2273
|
+
},
|
2274
|
+
{
|
2275
|
+
"kind": "method",
|
2276
|
+
"name": "setDisabled",
|
2277
|
+
"privacy": "private",
|
2278
|
+
"parameters": [
|
2279
|
+
{
|
2280
|
+
"name": "element",
|
2281
|
+
"type": {
|
2282
|
+
"text": "HTMLElement"
|
2283
|
+
},
|
2284
|
+
"description": "The button element."
|
2285
|
+
},
|
2286
|
+
{
|
2287
|
+
"name": "disabled",
|
2288
|
+
"type": {
|
2289
|
+
"text": "boolean"
|
2290
|
+
},
|
2291
|
+
"description": "The disabled state."
|
2292
|
+
}
|
2293
|
+
],
|
2294
|
+
"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.",
|
2295
|
+
"inheritedFrom": {
|
2296
|
+
"name": "Buttonsimple",
|
2297
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
2298
|
+
}
|
2299
|
+
},
|
2300
|
+
{
|
2301
|
+
"kind": "method",
|
2302
|
+
"name": "triggerClickEvent",
|
2303
|
+
"privacy": "private",
|
2304
|
+
"inheritedFrom": {
|
2305
|
+
"name": "Buttonsimple",
|
2306
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
2307
|
+
}
|
2308
|
+
},
|
2309
|
+
{
|
2310
|
+
"kind": "method",
|
2311
|
+
"name": "handleBlur",
|
2312
|
+
"privacy": "private",
|
2313
|
+
"description": "In case the button is pressed and the focus is lost while pressing,\nthe pressed class is removed.",
|
2314
|
+
"inheritedFrom": {
|
2315
|
+
"name": "Buttonsimple",
|
2316
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
2317
|
+
}
|
2318
|
+
},
|
2319
|
+
{
|
2320
|
+
"kind": "method",
|
2321
|
+
"name": "handleKeyDown",
|
2322
|
+
"privacy": "private",
|
2323
|
+
"parameters": [
|
2324
|
+
{
|
2325
|
+
"name": "event",
|
2326
|
+
"type": {
|
2327
|
+
"text": "KeyboardEvent"
|
2328
|
+
},
|
2329
|
+
"description": "The keyboard event."
|
2330
|
+
}
|
2331
|
+
],
|
2332
|
+
"description": "Handles the keydown event on the button.\nIf the key is 'Enter' or 'Space', the button is pressed.\nIf the key is 'Enter', the button is pressed. The native HTML button works in the same way.\nIf the key is 'Space', the button's default is prevent to avoid scrolling etc in the host application.",
|
2333
|
+
"inheritedFrom": {
|
2334
|
+
"name": "Buttonsimple",
|
2335
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
2336
|
+
}
|
2337
|
+
},
|
2338
|
+
{
|
2339
|
+
"kind": "method",
|
2340
|
+
"name": "handleKeyUp",
|
2341
|
+
"privacy": "private",
|
2342
|
+
"parameters": [
|
2343
|
+
{
|
2344
|
+
"name": "event",
|
2345
|
+
"type": {
|
2346
|
+
"text": "KeyboardEvent"
|
2347
|
+
},
|
2348
|
+
"description": "The keyboard event."
|
2349
|
+
}
|
2350
|
+
],
|
2351
|
+
"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.",
|
2352
|
+
"inheritedFrom": {
|
2353
|
+
"name": "Buttonsimple",
|
2354
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
2355
|
+
}
|
2356
|
+
}
|
2357
|
+
],
|
2358
|
+
"attributes": [
|
2359
|
+
{
|
2360
|
+
"name": "size",
|
2361
|
+
"type": {
|
2362
|
+
"text": "ButtonSize"
|
2363
|
+
},
|
2364
|
+
"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.",
|
2365
|
+
"default": "32",
|
2366
|
+
"fieldName": "size",
|
2367
|
+
"inheritedFrom": {
|
2368
|
+
"name": "Buttonsimple",
|
2369
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
2370
|
+
}
|
2371
|
+
},
|
2372
|
+
{
|
2373
|
+
"name": "role",
|
2374
|
+
"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.",
|
2375
|
+
"default": "'button'",
|
2376
|
+
"fieldName": "role",
|
2377
|
+
"type": {
|
2378
|
+
"text": "string"
|
2379
|
+
},
|
2380
|
+
"inheritedFrom": {
|
2381
|
+
"name": "Buttonsimple",
|
2382
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
2383
|
+
}
|
2384
|
+
},
|
2385
|
+
{
|
2386
|
+
"name": "prefix-icon",
|
2387
|
+
"type": {
|
2388
|
+
"text": "IconNames | undefined"
|
2389
|
+
},
|
2390
|
+
"description": "The name of the icon to display as a prefix.\nThe icon is displayed on the left side of the button.",
|
2391
|
+
"fieldName": "prefixIcon",
|
2392
|
+
"inheritedFrom": {
|
2393
|
+
"name": "ButtonComponentMixin",
|
2394
|
+
"module": "src/utils/mixins/ButtonComponentMixin.ts"
|
2395
|
+
}
|
2396
|
+
},
|
2397
|
+
{
|
2398
|
+
"name": "postfix-icon",
|
2399
|
+
"type": {
|
2400
|
+
"text": "IconNames | undefined"
|
2401
|
+
},
|
2402
|
+
"description": "The name of the icon to display as a postfix.\nThe icon is displayed on the right side of the button.",
|
2403
|
+
"fieldName": "postfixIcon",
|
2404
|
+
"inheritedFrom": {
|
2405
|
+
"name": "ButtonComponentMixin",
|
2406
|
+
"module": "src/utils/mixins/ButtonComponentMixin.ts"
|
2407
|
+
}
|
2408
|
+
},
|
2409
|
+
{
|
2410
|
+
"name": "variant",
|
2411
|
+
"type": {
|
2412
|
+
"text": "ButtonVariant"
|
2413
|
+
},
|
2414
|
+
"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.",
|
2415
|
+
"default": "primary",
|
2416
|
+
"fieldName": "variant",
|
2417
|
+
"inheritedFrom": {
|
2418
|
+
"name": "ButtonComponentMixin",
|
2419
|
+
"module": "src/utils/mixins/ButtonComponentMixin.ts"
|
2420
|
+
}
|
2421
|
+
},
|
2422
|
+
{
|
2423
|
+
"name": "color",
|
2424
|
+
"type": {
|
2425
|
+
"text": "ButtonColor"
|
2426
|
+
},
|
2427
|
+
"description": "There are 5 colors for button: positive, negative, accent, promotional, default.",
|
2428
|
+
"default": "default",
|
2429
|
+
"fieldName": "color",
|
2430
|
+
"inheritedFrom": {
|
2431
|
+
"name": "ButtonComponentMixin",
|
2432
|
+
"module": "src/utils/mixins/ButtonComponentMixin.ts"
|
2433
|
+
}
|
2434
|
+
},
|
2435
|
+
{
|
2436
|
+
"name": "tabIndex",
|
2437
|
+
"type": {
|
2438
|
+
"text": "number"
|
2439
|
+
},
|
2440
|
+
"default": "0",
|
2441
|
+
"description": "This property specifies the tab order of the element.",
|
2442
|
+
"fieldName": "tabIndex",
|
2443
|
+
"inheritedFrom": {
|
2444
|
+
"name": "TabIndexMixin",
|
2445
|
+
"module": "src/utils/mixins/TabIndexMixin.ts"
|
2446
|
+
}
|
2447
|
+
},
|
2448
|
+
{
|
2449
|
+
"name": "disabled",
|
2450
|
+
"type": {
|
2451
|
+
"text": "boolean | undefined"
|
2452
|
+
},
|
2453
|
+
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
2454
|
+
"default": "undefined",
|
2455
|
+
"fieldName": "disabled",
|
2456
|
+
"inheritedFrom": {
|
2457
|
+
"name": "DisabledMixin",
|
2458
|
+
"module": "src/utils/mixins/DisabledMixin.ts"
|
2459
|
+
}
|
2460
|
+
},
|
2461
|
+
{
|
2462
|
+
"name": "active",
|
2463
|
+
"type": {
|
2464
|
+
"text": "boolean | undefined"
|
2465
|
+
},
|
2466
|
+
"description": "The button's active state indicates whether it is currently toggled on (active) or off (inactive).\nWhen the active state is true, the button is considered to be in an active state, meaning it is toggled on.\nConversely, when the active state is false, the button is in an inactive state, indicating it is toggled off.\n\nThis attribute is used to set the provided `ariaStateKey` to true or false.",
|
2467
|
+
"default": "undefined",
|
2468
|
+
"fieldName": "active",
|
2469
|
+
"inheritedFrom": {
|
2470
|
+
"name": "Buttonsimple",
|
2471
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
1923
2472
|
}
|
1924
2473
|
},
|
1925
2474
|
{
|
1926
|
-
"
|
1927
|
-
"
|
1928
|
-
|
1929
|
-
|
1930
|
-
|
1931
|
-
|
1932
|
-
|
1933
|
-
"text": "HTMLElement"
|
1934
|
-
},
|
1935
|
-
"description": "The button element."
|
1936
|
-
},
|
1937
|
-
{
|
1938
|
-
"name": "disabled",
|
1939
|
-
"type": {
|
1940
|
-
"text": "boolean"
|
1941
|
-
},
|
1942
|
-
"description": "The disabled state."
|
1943
|
-
}
|
1944
|
-
],
|
1945
|
-
"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.",
|
2475
|
+
"name": "soft-disabled",
|
2476
|
+
"type": {
|
2477
|
+
"text": "boolean | undefined"
|
2478
|
+
},
|
2479
|
+
"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.",
|
2480
|
+
"default": "undefined",
|
2481
|
+
"fieldName": "softDisabled",
|
1946
2482
|
"inheritedFrom": {
|
1947
2483
|
"name": "Buttonsimple",
|
1948
|
-
"module": "components/buttonsimple/buttonsimple.component.
|
2484
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
1949
2485
|
}
|
1950
2486
|
},
|
1951
2487
|
{
|
1952
|
-
"
|
1953
|
-
"
|
1954
|
-
|
2488
|
+
"name": "ariaStateKey",
|
2489
|
+
"type": {
|
2490
|
+
"text": "string | undefined"
|
2491
|
+
},
|
2492
|
+
"description": "This property defines the ARIA state key, which will be toggled when the\nButton is set to `active`.\nThe default value is 'aria-pressed', which is commonly used for toggle buttons.\n\nConsumers can override this property to use a different ARIA state key if needed.\nIn case multiple aria attributes should be toggled, they can be passed in as\na comma separated string.\nFor example: `aria-pressed,aria-expanded`",
|
2493
|
+
"default": "'aria-pressed' (when)",
|
2494
|
+
"fieldName": "ariaStateKey",
|
1955
2495
|
"inheritedFrom": {
|
1956
2496
|
"name": "Buttonsimple",
|
1957
|
-
"module": "components/buttonsimple/buttonsimple.component.
|
2497
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
1958
2498
|
}
|
1959
2499
|
},
|
1960
2500
|
{
|
1961
|
-
"
|
1962
|
-
"
|
1963
|
-
|
1964
|
-
|
2501
|
+
"name": "type",
|
2502
|
+
"type": {
|
2503
|
+
"text": "ButtonType"
|
2504
|
+
},
|
2505
|
+
"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.",
|
2506
|
+
"default": "button",
|
2507
|
+
"fieldName": "type",
|
1965
2508
|
"inheritedFrom": {
|
1966
2509
|
"name": "Buttonsimple",
|
1967
|
-
"module": "components/buttonsimple/buttonsimple.component.
|
2510
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
2511
|
+
}
|
2512
|
+
}
|
2513
|
+
],
|
2514
|
+
"mixins": [
|
2515
|
+
{
|
2516
|
+
"name": "ButtonComponentMixin",
|
2517
|
+
"module": "/src/utils/mixins/ButtonComponentMixin"
|
2518
|
+
}
|
2519
|
+
],
|
2520
|
+
"superclass": {
|
2521
|
+
"name": "Buttonsimple",
|
2522
|
+
"module": "/src/components/buttonsimple/buttonsimple.component"
|
2523
|
+
},
|
2524
|
+
"tagName": "mdc-button",
|
2525
|
+
"jsDoc": "/**\n * `mdc-button` is a component that can be configured in various ways to suit different use cases.\n *\n * Button Variants:\n * - **Primary**: Solid background color.\n * - **Secondary**: Transparent background with a solid border.\n * - **Tertiary**: No background or border, appears as plain text but retains all button functionalities.\n *\n * Button Colors:\n * - **Positive**: Green color.\n * - **Negative**: Red color.\n * - **Accent**: Blue color.\n * - **Promotional**: Purple color.\n * - **Default**: White color.\n *\n * Button Sizes (in REM units):\n * - **Pill button**: 40, 32, 28, 24.\n * - **Icon button**: 64, 52, 40, 32, 28, 24.\n * - **Tertiary icon button**: 20.\n *\n * Button Types:\n * - **Pill button**: A button that contains text value. Commonly used for call to action, tags, or filters.\n * - **Pill button with icons**: A button containing an icon either on the left or right side of the button.\n * - **Icon button**: A button represented by just an icon without any text.\n * The type of button is inferred based on the presence of slot and/or prefix and postfix icons.\n *\n * @dependency mdc-icon\n *\n * @tagname mdc-button\n *\n * @slot - Text label of the button.\n */",
|
2526
|
+
"customElement": true,
|
2527
|
+
"events": [
|
2528
|
+
{
|
2529
|
+
"description": "(React: onClick) This event is dispatched when the button is clicked.",
|
2530
|
+
"name": "click",
|
2531
|
+
"reactName": "onClick",
|
2532
|
+
"inheritedFrom": {
|
2533
|
+
"name": "Buttonsimple",
|
2534
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
1968
2535
|
}
|
1969
2536
|
},
|
1970
2537
|
{
|
1971
|
-
"
|
1972
|
-
"name": "
|
1973
|
-
"
|
1974
|
-
"parameters": [
|
1975
|
-
{
|
1976
|
-
"name": "event",
|
1977
|
-
"type": {
|
1978
|
-
"text": "KeyboardEvent"
|
1979
|
-
},
|
1980
|
-
"description": "The keyboard event."
|
1981
|
-
}
|
1982
|
-
],
|
1983
|
-
"description": "Handles the keydown event on the button.\nIf the key is 'Enter' or 'Space', the button is pressed.\nIf the key is 'Enter', the button is pressed. The native HTML button works in the same way.\nIf the key is 'Space', the button's default is prevent to avoid scrolling etc in the host application.",
|
2538
|
+
"description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the button.",
|
2539
|
+
"name": "keydown",
|
2540
|
+
"reactName": "onKeyDown",
|
1984
2541
|
"inheritedFrom": {
|
1985
2542
|
"name": "Buttonsimple",
|
1986
|
-
"module": "components/buttonsimple/buttonsimple.component.
|
2543
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
2544
|
+
}
|
2545
|
+
},
|
2546
|
+
{
|
2547
|
+
"description": "(React: onKeyUp) This event is dispatched when a key is released on the button.",
|
2548
|
+
"name": "keyup",
|
2549
|
+
"reactName": "onKeyUp",
|
2550
|
+
"inheritedFrom": {
|
2551
|
+
"name": "Buttonsimple",
|
2552
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
2553
|
+
}
|
2554
|
+
},
|
2555
|
+
{
|
2556
|
+
"description": "(React: onFocus) This event is dispatched when the button receives focus.",
|
2557
|
+
"name": "focus",
|
2558
|
+
"reactName": "onFocus",
|
2559
|
+
"inheritedFrom": {
|
2560
|
+
"name": "Buttonsimple",
|
2561
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
1987
2562
|
}
|
2563
|
+
}
|
2564
|
+
]
|
2565
|
+
}
|
2566
|
+
],
|
2567
|
+
"exports": [
|
2568
|
+
{
|
2569
|
+
"kind": "js",
|
2570
|
+
"name": "default",
|
2571
|
+
"declaration": {
|
2572
|
+
"name": "Button",
|
2573
|
+
"module": "components/button/button.component.js"
|
2574
|
+
}
|
2575
|
+
}
|
2576
|
+
]
|
2577
|
+
},
|
2578
|
+
{
|
2579
|
+
"kind": "javascript-module",
|
2580
|
+
"path": "components/buttonlink/buttonlink.component.js",
|
2581
|
+
"declarations": [
|
2582
|
+
{
|
2583
|
+
"kind": "class",
|
2584
|
+
"description": "`mdc-buttonlink` combines the functional behavior of `mdc-linksimple` with the visual and structural\nfeatures of `mdc-button`. This includes support for variants, sizing, and optional\nprefix and postfix icons via slots.\n\n### Features:\n- Behaves like an link while visually resembling a button.\n- Supports slots for `prefix-icon` and `postfix-icon`.\n- Customizable size, color, and variant through attributes.\n- Inherits accessibility and keyboard interaction support from `mdc-linksimple`.",
|
2585
|
+
"name": "ButtonLink",
|
2586
|
+
"members": [
|
2587
|
+
{
|
2588
|
+
"kind": "field",
|
2589
|
+
"name": "size",
|
2590
|
+
"type": {
|
2591
|
+
"text": "PillButtonSize | IconButtonSize"
|
2592
|
+
},
|
2593
|
+
"description": "ButtonLink sizing is based on the buttonlink type.\n - **Pill buttonlink**: 40, 32, 28, 24.\n - **Icon buttonlink**: 64, 52, 40, 32, 28, 24.\n - Tertiary icon buttonlink can also be 20.",
|
2594
|
+
"default": "32",
|
2595
|
+
"attribute": "size",
|
2596
|
+
"reflects": true
|
2597
|
+
},
|
2598
|
+
{
|
2599
|
+
"kind": "field",
|
2600
|
+
"name": "softDisabled",
|
2601
|
+
"type": {
|
2602
|
+
"text": "boolean | undefined"
|
2603
|
+
},
|
2604
|
+
"description": "Indicates whether the buttonlink is soft disabled.\nWhen set to `true`, the buttonlink 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 buttonlink behaves like a disabled buttonlink, allowing only focus and\npreventing any interactions (clicks or keyboard actions) from triggering unintended actions.",
|
2605
|
+
"default": "undefined",
|
2606
|
+
"attribute": "soft-disabled",
|
2607
|
+
"reflects": true
|
1988
2608
|
},
|
1989
2609
|
{
|
1990
2610
|
"kind": "method",
|
1991
|
-
"name": "
|
2611
|
+
"name": "setSoftDisabled",
|
1992
2612
|
"privacy": "private",
|
1993
2613
|
"parameters": [
|
1994
2614
|
{
|
1995
|
-
"name": "
|
2615
|
+
"name": "element",
|
1996
2616
|
"type": {
|
1997
|
-
"text": "
|
2617
|
+
"text": "HTMLElement"
|
1998
2618
|
},
|
1999
|
-
"description": "The
|
2619
|
+
"description": "The buttonlink element."
|
2620
|
+
},
|
2621
|
+
{
|
2622
|
+
"name": "softDisabled",
|
2623
|
+
"optional": true,
|
2624
|
+
"type": {
|
2625
|
+
"text": "boolean"
|
2626
|
+
},
|
2627
|
+
"description": "The soft-disabled state."
|
2000
2628
|
}
|
2001
2629
|
],
|
2002
|
-
"description": "
|
2003
|
-
|
2004
|
-
"name": "Buttonsimple",
|
2005
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
2006
|
-
}
|
2007
|
-
}
|
2008
|
-
],
|
2009
|
-
"attributes": [
|
2630
|
+
"description": "Sets the soft-disabled attribute for the buttonlink.\nWhen soft-disabled, the buttonlink looks to be disabled but remains focusable and clickable.\nAlso sets/removes aria-disabled attribute."
|
2631
|
+
},
|
2010
2632
|
{
|
2011
|
-
"
|
2633
|
+
"kind": "field",
|
2634
|
+
"name": "prefixIcon",
|
2012
2635
|
"type": {
|
2013
2636
|
"text": "IconNames | undefined"
|
2014
2637
|
},
|
2015
2638
|
"description": "The name of the icon to display as a prefix.\nThe icon is displayed on the left side of the button.",
|
2016
|
-
"
|
2639
|
+
"attribute": "prefix-icon",
|
2640
|
+
"reflects": true,
|
2641
|
+
"inheritedFrom": {
|
2642
|
+
"name": "ButtonComponentMixin",
|
2643
|
+
"module": "utils/mixins/ButtonComponentMixin.js"
|
2644
|
+
}
|
2017
2645
|
},
|
2018
2646
|
{
|
2019
|
-
"
|
2647
|
+
"kind": "field",
|
2648
|
+
"name": "postfixIcon",
|
2020
2649
|
"type": {
|
2021
2650
|
"text": "IconNames | undefined"
|
2022
2651
|
},
|
2023
2652
|
"description": "The name of the icon to display as a postfix.\nThe icon is displayed on the right side of the button.",
|
2024
|
-
"
|
2653
|
+
"attribute": "postfix-icon",
|
2654
|
+
"reflects": true,
|
2655
|
+
"inheritedFrom": {
|
2656
|
+
"name": "ButtonComponentMixin",
|
2657
|
+
"module": "utils/mixins/ButtonComponentMixin.js"
|
2658
|
+
}
|
2025
2659
|
},
|
2026
2660
|
{
|
2661
|
+
"kind": "field",
|
2027
2662
|
"name": "variant",
|
2028
2663
|
"type": {
|
2029
2664
|
"text": "ButtonVariant"
|
2030
2665
|
},
|
2031
2666
|
"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.",
|
2032
2667
|
"default": "primary",
|
2033
|
-
"
|
2668
|
+
"attribute": "variant",
|
2669
|
+
"inheritedFrom": {
|
2670
|
+
"name": "ButtonComponentMixin",
|
2671
|
+
"module": "utils/mixins/ButtonComponentMixin.js"
|
2672
|
+
}
|
2034
2673
|
},
|
2035
2674
|
{
|
2036
|
-
"
|
2675
|
+
"kind": "field",
|
2676
|
+
"name": "color",
|
2037
2677
|
"type": {
|
2038
|
-
"text": "
|
2678
|
+
"text": "ButtonColor"
|
2039
2679
|
},
|
2040
|
-
"description": "
|
2041
|
-
"default": "
|
2042
|
-
"
|
2680
|
+
"description": "There are 5 colors for button: positive, negative, accent, promotional, default.",
|
2681
|
+
"default": "default",
|
2682
|
+
"attribute": "color",
|
2683
|
+
"inheritedFrom": {
|
2684
|
+
"name": "ButtonComponentMixin",
|
2685
|
+
"module": "utils/mixins/ButtonComponentMixin.js"
|
2686
|
+
}
|
2687
|
+
},
|
2688
|
+
{
|
2689
|
+
"kind": "method",
|
2690
|
+
"name": "setVariant",
|
2691
|
+
"parameters": [
|
2692
|
+
{
|
2693
|
+
"name": "variant",
|
2694
|
+
"type": {
|
2695
|
+
"text": "ButtonVariant"
|
2696
|
+
},
|
2697
|
+
"description": "The variant to set."
|
2698
|
+
}
|
2699
|
+
],
|
2700
|
+
"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.",
|
2701
|
+
"inheritedFrom": {
|
2702
|
+
"name": "ButtonComponentMixin",
|
2703
|
+
"module": "utils/mixins/ButtonComponentMixin.js"
|
2704
|
+
}
|
2705
|
+
},
|
2706
|
+
{
|
2707
|
+
"kind": "method",
|
2708
|
+
"name": "setColor",
|
2709
|
+
"parameters": [
|
2710
|
+
{
|
2711
|
+
"name": "color",
|
2712
|
+
"type": {
|
2713
|
+
"text": "ButtonColor"
|
2714
|
+
},
|
2715
|
+
"description": "The color to set."
|
2716
|
+
}
|
2717
|
+
],
|
2718
|
+
"description": "Sets the color attribute for the button.\nDefaults to DEFAULTS.COLOR if invalid or for tertiary button.",
|
2719
|
+
"inheritedFrom": {
|
2720
|
+
"name": "ButtonComponentMixin",
|
2721
|
+
"module": "utils/mixins/ButtonComponentMixin.js"
|
2722
|
+
}
|
2723
|
+
},
|
2724
|
+
{
|
2725
|
+
"kind": "method",
|
2726
|
+
"name": "setSize",
|
2727
|
+
"parameters": [
|
2728
|
+
{
|
2729
|
+
"name": "size",
|
2730
|
+
"type": {
|
2731
|
+
"text": "PillButtonSize | IconButtonSize"
|
2732
|
+
},
|
2733
|
+
"description": "The size to set."
|
2734
|
+
}
|
2735
|
+
],
|
2736
|
+
"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.",
|
2043
2737
|
"inheritedFrom": {
|
2044
|
-
"name": "
|
2045
|
-
"module": "
|
2738
|
+
"name": "ButtonComponentMixin",
|
2739
|
+
"module": "utils/mixins/ButtonComponentMixin.js"
|
2046
2740
|
}
|
2047
2741
|
},
|
2048
2742
|
{
|
2049
|
-
"
|
2050
|
-
"
|
2051
|
-
|
2052
|
-
|
2053
|
-
|
2054
|
-
|
2055
|
-
|
2743
|
+
"kind": "method",
|
2744
|
+
"name": "inferButtonType",
|
2745
|
+
"description": "Infers the type of button based on the presence of slot and/or prefix and postfix icons.",
|
2746
|
+
"parameters": [
|
2747
|
+
{
|
2748
|
+
"description": "default slot of button",
|
2749
|
+
"name": "slot"
|
2750
|
+
}
|
2751
|
+
],
|
2752
|
+
"inheritedFrom": {
|
2753
|
+
"name": "ButtonComponentMixin",
|
2754
|
+
"module": "utils/mixins/ButtonComponentMixin.js"
|
2755
|
+
}
|
2056
2756
|
},
|
2057
2757
|
{
|
2058
|
-
"
|
2059
|
-
"
|
2060
|
-
"default": "'button'",
|
2061
|
-
"fieldName": "role",
|
2758
|
+
"kind": "field",
|
2759
|
+
"name": "disabled",
|
2062
2760
|
"type": {
|
2063
|
-
"text": "
|
2761
|
+
"text": "boolean | undefined"
|
2064
2762
|
},
|
2763
|
+
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
2764
|
+
"default": "undefined",
|
2765
|
+
"attribute": "disabled",
|
2766
|
+
"reflects": true,
|
2065
2767
|
"inheritedFrom": {
|
2066
|
-
"name": "
|
2067
|
-
"module": "
|
2768
|
+
"name": "DisabledMixin",
|
2769
|
+
"module": "utils/mixins/DisabledMixin.js"
|
2068
2770
|
}
|
2069
2771
|
},
|
2070
2772
|
{
|
2773
|
+
"kind": "field",
|
2071
2774
|
"name": "tabIndex",
|
2072
2775
|
"type": {
|
2073
2776
|
"text": "number"
|
2074
2777
|
},
|
2075
2778
|
"default": "0",
|
2076
2779
|
"description": "This property specifies the tab order of the element.",
|
2077
|
-
"
|
2780
|
+
"attribute": "tabIndex",
|
2781
|
+
"reflects": true,
|
2078
2782
|
"inheritedFrom": {
|
2079
2783
|
"name": "TabIndexMixin",
|
2080
|
-
"module": "
|
2784
|
+
"module": "utils/mixins/TabIndexMixin.js"
|
2081
2785
|
}
|
2082
2786
|
},
|
2083
2787
|
{
|
2084
|
-
"
|
2788
|
+
"kind": "field",
|
2789
|
+
"name": "inline",
|
2085
2790
|
"type": {
|
2086
|
-
"text": "boolean
|
2791
|
+
"text": "boolean"
|
2087
2792
|
},
|
2088
|
-
"description": "
|
2089
|
-
"default": "
|
2090
|
-
"
|
2793
|
+
"description": "The link can be inline or standalone.",
|
2794
|
+
"default": "false",
|
2795
|
+
"attribute": "inline",
|
2796
|
+
"reflects": true,
|
2091
2797
|
"inheritedFrom": {
|
2092
|
-
"name": "
|
2093
|
-
"module": "
|
2798
|
+
"name": "Linksimple",
|
2799
|
+
"module": "components/linksimple/linksimple.component.js"
|
2094
2800
|
}
|
2095
2801
|
},
|
2096
2802
|
{
|
2097
|
-
"
|
2803
|
+
"kind": "field",
|
2804
|
+
"name": "inverted",
|
2098
2805
|
"type": {
|
2099
|
-
"text": "boolean
|
2806
|
+
"text": "boolean"
|
2100
2807
|
},
|
2101
|
-
"description": "The
|
2102
|
-
"default": "
|
2103
|
-
"
|
2808
|
+
"description": "The link color can be inverted by setting the inverted attribute to true.",
|
2809
|
+
"default": "false",
|
2810
|
+
"attribute": "inverted",
|
2811
|
+
"reflects": true,
|
2104
2812
|
"inheritedFrom": {
|
2105
|
-
"name": "
|
2106
|
-
"module": "
|
2813
|
+
"name": "Linksimple",
|
2814
|
+
"module": "components/linksimple/linksimple.component.js"
|
2107
2815
|
}
|
2108
2816
|
},
|
2109
2817
|
{
|
2110
|
-
"
|
2818
|
+
"kind": "field",
|
2819
|
+
"name": "href",
|
2111
2820
|
"type": {
|
2112
|
-
"text": "
|
2821
|
+
"text": "string"
|
2113
2822
|
},
|
2114
|
-
"
|
2115
|
-
"
|
2116
|
-
"
|
2823
|
+
"default": "'#'",
|
2824
|
+
"description": "Href for navigation. The URL that the hyperlink points to",
|
2825
|
+
"attribute": "href",
|
2826
|
+
"reflects": true,
|
2117
2827
|
"inheritedFrom": {
|
2118
|
-
"name": "
|
2119
|
-
"module": "
|
2828
|
+
"name": "Linksimple",
|
2829
|
+
"module": "components/linksimple/linksimple.component.js"
|
2120
2830
|
}
|
2121
2831
|
},
|
2122
2832
|
{
|
2123
|
-
"
|
2833
|
+
"kind": "field",
|
2834
|
+
"name": "target",
|
2124
2835
|
"type": {
|
2125
|
-
"text": "string
|
2836
|
+
"text": "string"
|
2126
2837
|
},
|
2127
|
-
"
|
2128
|
-
"
|
2129
|
-
"
|
2838
|
+
"default": "'_self'",
|
2839
|
+
"description": "Optional target: _blank, _self, _parent, _top and _unfencedTop",
|
2840
|
+
"attribute": "target",
|
2841
|
+
"reflects": true,
|
2130
2842
|
"inheritedFrom": {
|
2131
|
-
"name": "
|
2132
|
-
"module": "
|
2843
|
+
"name": "Linksimple",
|
2844
|
+
"module": "components/linksimple/linksimple.component.js"
|
2133
2845
|
}
|
2134
2846
|
},
|
2135
2847
|
{
|
2136
|
-
"
|
2848
|
+
"kind": "field",
|
2849
|
+
"name": "rel",
|
2137
2850
|
"type": {
|
2138
|
-
"text": "
|
2851
|
+
"text": "string | undefined"
|
2139
2852
|
},
|
2140
|
-
"description": "
|
2141
|
-
"
|
2142
|
-
"
|
2853
|
+
"description": "Optional rel attribute that defines the relationship of the linked URL as space-separated link types.",
|
2854
|
+
"attribute": "rel",
|
2855
|
+
"reflects": true,
|
2143
2856
|
"inheritedFrom": {
|
2144
|
-
"name": "
|
2145
|
-
"module": "
|
2857
|
+
"name": "Linksimple",
|
2858
|
+
"module": "components/linksimple/linksimple.component.js"
|
2859
|
+
}
|
2860
|
+
},
|
2861
|
+
{
|
2862
|
+
"kind": "field",
|
2863
|
+
"name": "handleNavigation",
|
2864
|
+
"privacy": "private",
|
2865
|
+
"inheritedFrom": {
|
2866
|
+
"name": "Linksimple",
|
2867
|
+
"module": "components/linksimple/linksimple.component.js"
|
2868
|
+
}
|
2869
|
+
},
|
2870
|
+
{
|
2871
|
+
"kind": "method",
|
2872
|
+
"name": "setDisabled",
|
2873
|
+
"privacy": "private",
|
2874
|
+
"parameters": [
|
2875
|
+
{
|
2876
|
+
"name": "disabled",
|
2877
|
+
"type": {
|
2878
|
+
"text": "boolean"
|
2879
|
+
},
|
2880
|
+
"description": "Whether the element should be disabled"
|
2881
|
+
}
|
2882
|
+
],
|
2883
|
+
"description": "Sets or removes `aria-disabled` and updates `tabIndex` to reflect\nthe disabled state. When disabled, the element becomes unfocusable;\nwhen enabled, the previous `tabIndex` is restored.",
|
2884
|
+
"inheritedFrom": {
|
2885
|
+
"name": "Linksimple",
|
2886
|
+
"module": "components/linksimple/linksimple.component.js"
|
2146
2887
|
}
|
2147
2888
|
}
|
2148
2889
|
],
|
2149
|
-
"superclass": {
|
2150
|
-
"name": "Buttonsimple",
|
2151
|
-
"module": "/src/components/buttonsimple/buttonsimple.component"
|
2152
|
-
},
|
2153
|
-
"tagName": "mdc-button",
|
2154
|
-
"jsDoc": "/**\n * `mdc-button` is a component that can be configured in various ways to suit different use cases.\n *\n * Button Variants:\n * - **Primary**: Solid background color.\n * - **Secondary**: Transparent background with a solid border.\n * - **Tertiary**: No background or border, appears as plain text but retains all button functionalities.\n *\n * Button Colors:\n * - **Positive**: Green color.\n * - **Negative**: Red color.\n * - **Accent**: Blue color.\n * - **Promotional**: Purple color.\n * - **Default**: White color.\n *\n * Button Sizes (in REM units):\n * - **Pill button**: 40, 32, 28, 24.\n * - **Icon button**: 64, 52, 40, 32, 28, 24.\n * - **Tertiary icon button**: 20.\n *\n * Button Types:\n * - **Pill button**: A button that contains text value. Commonly used for call to action, tags, or filters.\n * - **Pill button with icons**: A button containing an icon either on the left or right side of the button.\n * - **Icon button**: A button represented by just an icon without any text.\n * The type of button is inferred based on the presence of slot and/or prefix and postfix icons.\n *\n * @dependency mdc-icon\n *\n * @tagname mdc-button\n *\n * @slot - Text label of the button.\n */",
|
2155
|
-
"customElement": true,
|
2156
2890
|
"events": [
|
2157
2891
|
{
|
2158
|
-
"description": "(React: onClick)
|
2892
|
+
"description": "(React: onClick) Fired when the user activates the buttonLink using a mouse or assistive technology.",
|
2159
2893
|
"name": "click",
|
2160
2894
|
"reactName": "onClick",
|
2161
2895
|
"inheritedFrom": {
|
2162
|
-
"name": "
|
2163
|
-
"module": "src/components/
|
2896
|
+
"name": "Linksimple",
|
2897
|
+
"module": "src/components/linksimple/linksimple.component.ts"
|
2164
2898
|
}
|
2165
2899
|
},
|
2166
2900
|
{
|
2167
|
-
"description": "(React: onKeyDown)
|
2901
|
+
"description": "(React: onKeyDown) Fired when the user presses a key while the buttonLink has focus.",
|
2168
2902
|
"name": "keydown",
|
2169
2903
|
"reactName": "onKeyDown",
|
2170
2904
|
"inheritedFrom": {
|
2171
|
-
"name": "
|
2172
|
-
"module": "src/components/
|
2173
|
-
}
|
2174
|
-
},
|
2175
|
-
{
|
2176
|
-
"description": "(React: onKeyUp) This event is dispatched when a key is released on the button.",
|
2177
|
-
"name": "keyup",
|
2178
|
-
"reactName": "onKeyUp",
|
2179
|
-
"inheritedFrom": {
|
2180
|
-
"name": "Buttonsimple",
|
2181
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
2905
|
+
"name": "Linksimple",
|
2906
|
+
"module": "src/components/linksimple/linksimple.component.ts"
|
2182
2907
|
}
|
2183
2908
|
},
|
2184
2909
|
{
|
2185
|
-
"description": "(React: onFocus)
|
2910
|
+
"description": "(React: onFocus) Fired when the buttonLink receives keyboard or mouse focus.",
|
2186
2911
|
"name": "focus",
|
2187
2912
|
"reactName": "onFocus",
|
2188
|
-
"inheritedFrom": {
|
2189
|
-
"name": "
|
2190
|
-
"module": "src/components/
|
2191
|
-
}
|
2192
|
-
}
|
2193
|
-
]
|
2194
|
-
}
|
2195
|
-
],
|
2196
|
-
"exports": [
|
2197
|
-
{
|
2198
|
-
"kind": "js",
|
2199
|
-
"name": "default",
|
2200
|
-
"declaration": {
|
2201
|
-
"name": "Button",
|
2202
|
-
"module": "components/button/button.component.js"
|
2203
|
-
}
|
2204
|
-
}
|
2205
|
-
]
|
2206
|
-
},
|
2207
|
-
{
|
2208
|
-
"kind": "javascript-module",
|
2209
|
-
"path": "components/badge/badge.component.js",
|
2210
|
-
"declarations": [
|
2211
|
-
{
|
2212
|
-
"kind": "class",
|
2213
|
-
"description": "The `mdc-badge` component is a versatile UI element used to\ndisplay dot, icons, counters, success, warning and error type badge.\n\nSupported badge types:\n- `dot`: Displays a dot notification badge with a blue color.\n- `icon`: Displays a badge with a specified icon using the `icon-name` attribute.\n- `counter`: Displays a badge with a counter value. If the counter exceeds the `max-counter`,\nit shows `maxCounter+`. The maximum value of the counter is 999 and anything above that will be set to `999+`.\n- `success`: Displays a success badge with a check circle icon and green color.\n- `warning`: Displays a warning badge with a warning icon and yellow color.\n- `error`: Displays a error badge with a error legacy icon and red color.\n\nFor `icon`, `success`, `warning` and `error` types, the `mdc-icon` component is used to render the icon.\n\nFor the `counter` type, the `mdc-text` component is used to render the counter value.",
|
2214
|
-
"name": "Badge",
|
2215
|
-
"cssProperties": [
|
2216
|
-
{
|
2217
|
-
"description": "The foreground color of the primary badge.",
|
2218
|
-
"name": "--mdc-badge-primary-foreground-color"
|
2219
|
-
},
|
2220
|
-
{
|
2221
|
-
"description": "The background color of the primary badge.",
|
2222
|
-
"name": "--mdc-badge-primary-background-color"
|
2223
|
-
},
|
2224
|
-
{
|
2225
|
-
"description": "The foreground color of the secondary badge.",
|
2226
|
-
"name": "--mdc-badge-secondary-foreground-color"
|
2227
|
-
},
|
2228
|
-
{
|
2229
|
-
"description": "The background color of the secondary badge.",
|
2230
|
-
"name": "--mdc-badge-secondary-background-color"
|
2231
|
-
},
|
2232
|
-
{
|
2233
|
-
"description": "The foreground color of the success badge.",
|
2234
|
-
"name": "--mdc-badge-success-foreground-color"
|
2235
|
-
},
|
2236
|
-
{
|
2237
|
-
"description": "The background color of the success badge.",
|
2238
|
-
"name": "--mdc-badge-success-background-color"
|
2239
|
-
},
|
2240
|
-
{
|
2241
|
-
"description": "The foreground color of the warning badge.",
|
2242
|
-
"name": "--mdc-badge-warning-foreground-color"
|
2243
|
-
},
|
2244
|
-
{
|
2245
|
-
"description": "The background color of the warning badge.",
|
2246
|
-
"name": "--mdc-badge-warning-background-color"
|
2247
|
-
},
|
2248
|
-
{
|
2249
|
-
"description": "The foreground color of the error badge.",
|
2250
|
-
"name": "--mdc-badge-error-foreground-color"
|
2251
|
-
},
|
2252
|
-
{
|
2253
|
-
"description": "The background color of the error badge.",
|
2254
|
-
"name": "--mdc-badge-error-background-color"
|
2913
|
+
"inheritedFrom": {
|
2914
|
+
"name": "Linksimple",
|
2915
|
+
"module": "src/components/linksimple/linksimple.component.ts"
|
2916
|
+
}
|
2255
2917
|
},
|
2256
2918
|
{
|
2257
|
-
"description": "
|
2258
|
-
"name": "
|
2919
|
+
"description": "(React: onBlur) Fired when the buttonLink loses keyboard or mouse focus.",
|
2920
|
+
"name": "blur",
|
2921
|
+
"reactName": "onBlur",
|
2922
|
+
"inheritedFrom": {
|
2923
|
+
"name": "Linksimple",
|
2924
|
+
"module": "src/components/linksimple/linksimple.component.ts"
|
2925
|
+
}
|
2259
2926
|
}
|
2260
2927
|
],
|
2261
|
-
"
|
2928
|
+
"attributes": [
|
2262
2929
|
{
|
2263
|
-
"
|
2264
|
-
"name": "type",
|
2930
|
+
"name": "size",
|
2265
2931
|
"type": {
|
2266
|
-
"text": "
|
2932
|
+
"text": "PillButtonSize | IconButtonSize"
|
2267
2933
|
},
|
2268
|
-
"description": "
|
2269
|
-
"
|
2270
|
-
"
|
2934
|
+
"description": "ButtonLink sizing is based on the buttonlink type.\n - **Pill buttonlink**: 40, 32, 28, 24.\n - **Icon buttonlink**: 64, 52, 40, 32, 28, 24.\n - Tertiary icon buttonlink can also be 20.",
|
2935
|
+
"default": "32",
|
2936
|
+
"fieldName": "size"
|
2271
2937
|
},
|
2272
2938
|
{
|
2273
|
-
"
|
2274
|
-
"name": "variant",
|
2939
|
+
"name": "soft-disabled",
|
2275
2940
|
"type": {
|
2276
|
-
"text": "
|
2941
|
+
"text": "boolean | undefined"
|
2277
2942
|
},
|
2278
|
-
"description": "
|
2279
|
-
"default": "
|
2280
|
-
"
|
2281
|
-
"reflects": true
|
2943
|
+
"description": "Indicates whether the buttonlink is soft disabled.\nWhen set to `true`, the buttonlink 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 buttonlink behaves like a disabled buttonlink, allowing only focus and\npreventing any interactions (clicks or keyboard actions) from triggering unintended actions.",
|
2944
|
+
"default": "undefined",
|
2945
|
+
"fieldName": "softDisabled"
|
2282
2946
|
},
|
2283
2947
|
{
|
2284
|
-
"
|
2285
|
-
"name": "counter",
|
2948
|
+
"name": "prefix-icon",
|
2286
2949
|
"type": {
|
2287
|
-
"text": "
|
2950
|
+
"text": "IconNames | undefined"
|
2288
2951
|
},
|
2289
|
-
"description": "
|
2290
|
-
"
|
2952
|
+
"description": "The name of the icon to display as a prefix.\nThe icon is displayed on the left side of the button.",
|
2953
|
+
"fieldName": "prefixIcon",
|
2954
|
+
"inheritedFrom": {
|
2955
|
+
"name": "ButtonComponentMixin",
|
2956
|
+
"module": "src/utils/mixins/ButtonComponentMixin.ts"
|
2957
|
+
}
|
2291
2958
|
},
|
2292
2959
|
{
|
2293
|
-
"
|
2294
|
-
"name": "maxCounter",
|
2960
|
+
"name": "postfix-icon",
|
2295
2961
|
"type": {
|
2296
|
-
"text": "
|
2962
|
+
"text": "IconNames | undefined"
|
2297
2963
|
},
|
2298
|
-
"description": "The
|
2299
|
-
"
|
2300
|
-
"
|
2301
|
-
|
2964
|
+
"description": "The name of the icon to display as a postfix.\nThe icon is displayed on the right side of the button.",
|
2965
|
+
"fieldName": "postfixIcon",
|
2966
|
+
"inheritedFrom": {
|
2967
|
+
"name": "ButtonComponentMixin",
|
2968
|
+
"module": "src/utils/mixins/ButtonComponentMixin.ts"
|
2969
|
+
}
|
2302
2970
|
},
|
2303
2971
|
{
|
2304
|
-
"
|
2305
|
-
"name": "overlay",
|
2972
|
+
"name": "variant",
|
2306
2973
|
"type": {
|
2307
|
-
"text": "
|
2974
|
+
"text": "ButtonVariant"
|
2308
2975
|
},
|
2309
|
-
"
|
2310
|
-
"
|
2311
|
-
"
|
2976
|
+
"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.",
|
2977
|
+
"default": "primary",
|
2978
|
+
"fieldName": "variant",
|
2979
|
+
"inheritedFrom": {
|
2980
|
+
"name": "ButtonComponentMixin",
|
2981
|
+
"module": "src/utils/mixins/ButtonComponentMixin.ts"
|
2982
|
+
}
|
2312
2983
|
},
|
2313
2984
|
{
|
2314
|
-
"
|
2315
|
-
"name": "ariaLabel",
|
2985
|
+
"name": "color",
|
2316
2986
|
"type": {
|
2317
|
-
"text": "
|
2987
|
+
"text": "ButtonColor"
|
2318
2988
|
},
|
2319
|
-
"
|
2320
|
-
"
|
2321
|
-
"
|
2989
|
+
"description": "There are 5 colors for button: positive, negative, accent, promotional, default.",
|
2990
|
+
"default": "default",
|
2991
|
+
"fieldName": "color",
|
2992
|
+
"inheritedFrom": {
|
2993
|
+
"name": "ButtonComponentMixin",
|
2994
|
+
"module": "src/utils/mixins/ButtonComponentMixin.ts"
|
2995
|
+
}
|
2322
2996
|
},
|
2323
2997
|
{
|
2324
|
-
"
|
2325
|
-
"
|
2326
|
-
|
2327
|
-
"return": {
|
2328
|
-
"type": {
|
2329
|
-
"text": ""
|
2330
|
-
}
|
2998
|
+
"name": "disabled",
|
2999
|
+
"type": {
|
3000
|
+
"text": "boolean | undefined"
|
2331
3001
|
},
|
2332
|
-
"
|
2333
|
-
|
2334
|
-
|
2335
|
-
|
2336
|
-
|
2337
|
-
|
2338
|
-
|
2339
|
-
},
|
2340
|
-
{
|
2341
|
-
"name": "counter",
|
2342
|
-
"optional": true,
|
2343
|
-
"type": {
|
2344
|
-
"text": "number"
|
2345
|
-
},
|
2346
|
-
"description": "the number to be displayed on the badge"
|
2347
|
-
}
|
2348
|
-
],
|
2349
|
-
"description": "If `type` is set to `counter` and if `counter` is greater than `maxCounter`,\nthen it will return a string the maxCounter value as string.\nOtherwise, it will return a string representation of `counter`.\nIf `counter` is not a number, it will return an empty string."
|
3002
|
+
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
3003
|
+
"default": "undefined",
|
3004
|
+
"fieldName": "disabled",
|
3005
|
+
"inheritedFrom": {
|
3006
|
+
"name": "DisabledMixin",
|
3007
|
+
"module": "src/utils/mixins/DisabledMixin.ts"
|
3008
|
+
}
|
2350
3009
|
},
|
2351
3010
|
{
|
2352
|
-
"
|
2353
|
-
"
|
2354
|
-
|
2355
|
-
"return": {
|
2356
|
-
"type": {
|
2357
|
-
"text": ""
|
2358
|
-
}
|
3011
|
+
"name": "tabIndex",
|
3012
|
+
"type": {
|
3013
|
+
"text": "number"
|
2359
3014
|
},
|
2360
|
-
"
|
2361
|
-
|
2362
|
-
|
2363
|
-
|
2364
|
-
|
2365
|
-
|
2366
|
-
|
2367
|
-
},
|
2368
|
-
{
|
2369
|
-
"name": "backgroundClassPostfix",
|
2370
|
-
"type": {
|
2371
|
-
"text": "string"
|
2372
|
-
},
|
2373
|
-
"description": "postfix for the class to style the badge icon."
|
2374
|
-
}
|
2375
|
-
],
|
2376
|
-
"description": "Method to generate the badge icon."
|
3015
|
+
"default": "0",
|
3016
|
+
"description": "This property specifies the tab order of the element.",
|
3017
|
+
"fieldName": "tabIndex",
|
3018
|
+
"inheritedFrom": {
|
3019
|
+
"name": "TabIndexMixin",
|
3020
|
+
"module": "src/utils/mixins/TabIndexMixin.ts"
|
3021
|
+
}
|
2377
3022
|
},
|
2378
3023
|
{
|
2379
|
-
"
|
2380
|
-
"
|
2381
|
-
|
2382
|
-
"return": {
|
2383
|
-
"type": {
|
2384
|
-
"text": ""
|
2385
|
-
}
|
3024
|
+
"name": "inline",
|
3025
|
+
"type": {
|
3026
|
+
"text": "boolean"
|
2386
3027
|
},
|
2387
|
-
"description": "
|
3028
|
+
"description": "The link can be inline or standalone.",
|
3029
|
+
"default": "false",
|
3030
|
+
"fieldName": "inline",
|
3031
|
+
"inheritedFrom": {
|
3032
|
+
"name": "Linksimple",
|
3033
|
+
"module": "src/components/linksimple/linksimple.component.ts"
|
3034
|
+
}
|
2388
3035
|
},
|
2389
3036
|
{
|
2390
|
-
"
|
2391
|
-
"
|
2392
|
-
|
2393
|
-
"return": {
|
2394
|
-
"type": {
|
2395
|
-
"text": ""
|
2396
|
-
}
|
3037
|
+
"name": "inverted",
|
3038
|
+
"type": {
|
3039
|
+
"text": "boolean"
|
2397
3040
|
},
|
2398
|
-
"description": "
|
3041
|
+
"description": "The link color can be inverted by setting the inverted attribute to true.",
|
3042
|
+
"default": "false",
|
3043
|
+
"fieldName": "inverted",
|
3044
|
+
"inheritedFrom": {
|
3045
|
+
"name": "Linksimple",
|
3046
|
+
"module": "src/components/linksimple/linksimple.component.ts"
|
3047
|
+
}
|
2399
3048
|
},
|
2400
3049
|
{
|
2401
|
-
"
|
2402
|
-
"
|
2403
|
-
|
2404
|
-
"return": {
|
2405
|
-
"type": {
|
2406
|
-
"text": "void"
|
2407
|
-
}
|
3050
|
+
"name": "href",
|
3051
|
+
"type": {
|
3052
|
+
"text": "string"
|
2408
3053
|
},
|
2409
|
-
"
|
3054
|
+
"default": "'#'",
|
3055
|
+
"description": "Href for navigation. The URL that the hyperlink points to",
|
3056
|
+
"fieldName": "href",
|
3057
|
+
"inheritedFrom": {
|
3058
|
+
"name": "Linksimple",
|
3059
|
+
"module": "src/components/linksimple/linksimple.component.ts"
|
3060
|
+
}
|
2410
3061
|
},
|
2411
3062
|
{
|
2412
|
-
"
|
2413
|
-
"
|
2414
|
-
|
2415
|
-
"return": {
|
2416
|
-
"type": {
|
2417
|
-
"text": ""
|
2418
|
-
}
|
3063
|
+
"name": "target",
|
3064
|
+
"type": {
|
3065
|
+
"text": "string"
|
2419
3066
|
},
|
2420
|
-
"
|
3067
|
+
"default": "'_self'",
|
3068
|
+
"description": "Optional target: _blank, _self, _parent, _top and _unfencedTop",
|
3069
|
+
"fieldName": "target",
|
3070
|
+
"inheritedFrom": {
|
3071
|
+
"name": "Linksimple",
|
3072
|
+
"module": "src/components/linksimple/linksimple.component.ts"
|
3073
|
+
}
|
2421
3074
|
},
|
2422
3075
|
{
|
2423
|
-
"
|
2424
|
-
"name": "iconName",
|
3076
|
+
"name": "rel",
|
2425
3077
|
"type": {
|
2426
|
-
"text": "
|
3078
|
+
"text": "string | undefined"
|
2427
3079
|
},
|
2428
|
-
"description": "
|
2429
|
-
"
|
3080
|
+
"description": "Optional rel attribute that defines the relationship of the linked URL as space-separated link types.",
|
3081
|
+
"fieldName": "rel",
|
2430
3082
|
"inheritedFrom": {
|
2431
|
-
"name": "
|
2432
|
-
"module": "
|
3083
|
+
"name": "Linksimple",
|
3084
|
+
"module": "src/components/linksimple/linksimple.component.ts"
|
2433
3085
|
}
|
2434
3086
|
}
|
2435
3087
|
],
|
2436
|
-
"
|
3088
|
+
"mixins": [
|
3089
|
+
{
|
3090
|
+
"name": "ButtonComponentMixin",
|
3091
|
+
"module": "/src/utils/mixins/ButtonComponentMixin"
|
3092
|
+
}
|
3093
|
+
],
|
3094
|
+
"superclass": {
|
3095
|
+
"name": "Linksimple",
|
3096
|
+
"module": "/src/components/linksimple/linksimple.component"
|
3097
|
+
},
|
3098
|
+
"tagName": "mdc-buttonlink",
|
3099
|
+
"jsDoc": "/**\n * `mdc-buttonlink` combines the functional behavior of `mdc-linksimple` with the visual and structural\n * features of `mdc-button`. This includes support for variants, sizing, and optional\n * prefix and postfix icons via slots.\n *\n * ### Features:\n * - Behaves like an link while visually resembling a button.\n * - Supports slots for `prefix-icon` and `postfix-icon`.\n * - Customizable size, color, and variant through attributes.\n * - Inherits accessibility and keyboard interaction support from `mdc-linksimple`.\n *\n * @dependency mdc-icon\n *\n * @tagname mdc-buttonlink\n *\n * @event click - (React: onClick) Fired when the user activates the buttonLink using a mouse or assistive technology.\n * @event keydown - (React: onKeyDown) Fired when the user presses a key while the buttonLink has focus.\n * @event focus - (React: onFocus) Fired when the buttonLink receives keyboard or mouse focus.\n * @event blur - (React: onBlur) Fired when the buttonLink loses keyboard or mouse focus.\n *\n */",
|
3100
|
+
"customElement": true,
|
3101
|
+
"cssProperties": [
|
3102
|
+
{
|
3103
|
+
"description": "Border radius of the link.",
|
3104
|
+
"name": "--mdc-link-border-radius",
|
3105
|
+
"inheritedFrom": {
|
3106
|
+
"name": "Linksimple",
|
3107
|
+
"module": "src/components/linksimple/linksimple.component.ts"
|
3108
|
+
}
|
3109
|
+
},
|
2437
3110
|
{
|
2438
|
-
"
|
2439
|
-
"
|
2440
|
-
|
2441
|
-
|
2442
|
-
|
2443
|
-
|
3111
|
+
"description": "Color of the link’s child content in the active state.",
|
3112
|
+
"name": "--mdc-link-color-active",
|
3113
|
+
"inheritedFrom": {
|
3114
|
+
"name": "Linksimple",
|
3115
|
+
"module": "src/components/linksimple/linksimple.component.ts"
|
3116
|
+
}
|
2444
3117
|
},
|
2445
3118
|
{
|
2446
|
-
"
|
2447
|
-
"
|
2448
|
-
|
2449
|
-
|
2450
|
-
|
2451
|
-
|
2452
|
-
"fieldName": "variant"
|
3119
|
+
"description": "Color of the link’s child content in the disabled state.",
|
3120
|
+
"name": "--mdc-link-color-disabled",
|
3121
|
+
"inheritedFrom": {
|
3122
|
+
"name": "Linksimple",
|
3123
|
+
"module": "src/components/linksimple/linksimple.component.ts"
|
3124
|
+
}
|
2453
3125
|
},
|
2454
3126
|
{
|
2455
|
-
"
|
2456
|
-
"
|
2457
|
-
|
2458
|
-
|
2459
|
-
|
2460
|
-
|
3127
|
+
"description": "Color of the link’s child content in the hover state.",
|
3128
|
+
"name": "--mdc-link-color-hover",
|
3129
|
+
"inheritedFrom": {
|
3130
|
+
"name": "Linksimple",
|
3131
|
+
"module": "src/components/linksimple/linksimple.component.ts"
|
3132
|
+
}
|
2461
3133
|
},
|
2462
3134
|
{
|
2463
|
-
"
|
2464
|
-
"
|
2465
|
-
|
2466
|
-
|
2467
|
-
|
2468
|
-
|
2469
|
-
"fieldName": "maxCounter"
|
3135
|
+
"description": "Color of the link’s child content in the normal state.",
|
3136
|
+
"name": "--mdc-link-color-normal",
|
3137
|
+
"inheritedFrom": {
|
3138
|
+
"name": "Linksimple",
|
3139
|
+
"module": "src/components/linksimple/linksimple.component.ts"
|
3140
|
+
}
|
2470
3141
|
},
|
2471
3142
|
{
|
2472
|
-
"
|
2473
|
-
"
|
2474
|
-
|
2475
|
-
|
2476
|
-
|
2477
|
-
|
2478
|
-
"fieldName": "overlay"
|
3143
|
+
"description": "Color of the inverted link’s child content in the active state.",
|
3144
|
+
"name": "--mdc-link-inverted-color-active",
|
3145
|
+
"inheritedFrom": {
|
3146
|
+
"name": "Linksimple",
|
3147
|
+
"module": "src/components/linksimple/linksimple.component.ts"
|
3148
|
+
}
|
2479
3149
|
},
|
2480
3150
|
{
|
2481
|
-
"
|
2482
|
-
"
|
2483
|
-
|
2484
|
-
|
2485
|
-
|
2486
|
-
|
2487
|
-
"fieldName": "ariaLabel"
|
3151
|
+
"description": "Color of the inverted link’s child content in the disabled state.",
|
3152
|
+
"name": "--mdc-link-inverted-color-disabled",
|
3153
|
+
"inheritedFrom": {
|
3154
|
+
"name": "Linksimple",
|
3155
|
+
"module": "src/components/linksimple/linksimple.component.ts"
|
3156
|
+
}
|
2488
3157
|
},
|
2489
3158
|
{
|
2490
|
-
"
|
2491
|
-
"
|
2492
|
-
"text": "IconNames | undefined"
|
2493
|
-
},
|
2494
|
-
"description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
|
2495
|
-
"fieldName": "iconName",
|
3159
|
+
"description": "Color of the inverted link’s child content in the hover state.",
|
3160
|
+
"name": "--mdc-link-inverted-color-hover",
|
2496
3161
|
"inheritedFrom": {
|
2497
|
-
"name": "
|
2498
|
-
"module": "src/
|
3162
|
+
"name": "Linksimple",
|
3163
|
+
"module": "src/components/linksimple/linksimple.component.ts"
|
2499
3164
|
}
|
2500
|
-
}
|
2501
|
-
],
|
2502
|
-
"mixins": [
|
3165
|
+
},
|
2503
3166
|
{
|
2504
|
-
"
|
2505
|
-
"
|
3167
|
+
"description": "Color of the inverted link’s child content in the normal state.",
|
3168
|
+
"name": "--mdc-link-inverted-color-normal",
|
3169
|
+
"inheritedFrom": {
|
3170
|
+
"name": "Linksimple",
|
3171
|
+
"module": "src/components/linksimple/linksimple.component.ts"
|
3172
|
+
}
|
2506
3173
|
}
|
2507
|
-
]
|
2508
|
-
"superclass": {
|
2509
|
-
"name": "Component",
|
2510
|
-
"module": "/src/models"
|
2511
|
-
},
|
2512
|
-
"tagName": "mdc-badge",
|
2513
|
-
"jsDoc": "/**\n * The `mdc-badge` component is a versatile UI element used to\n * display dot, icons, counters, success, warning and error type badge.\n *\n * Supported badge types:\n * - `dot`: Displays a dot notification badge with a blue color.\n * - `icon`: Displays a badge with a specified icon using the `icon-name` attribute.\n * - `counter`: Displays a badge with a counter value. If the counter exceeds the `max-counter`,\n * it shows `maxCounter+`. The maximum value of the counter is 999 and anything above that will be set to `999+`.\n * - `success`: Displays a success badge with a check circle icon and green color.\n * - `warning`: Displays a warning badge with a warning icon and yellow color.\n * - `error`: Displays a error badge with a error legacy icon and red color.\n *\n * For `icon`, `success`, `warning` and `error` types, the `mdc-icon` component is used to render the icon.\n *\n * For the `counter` type, the `mdc-text` component is used to render the counter value.\n *\n * @dependency mdc-icon\n * @dependency mdc-text\n *\n * @tagname mdc-badge\n *\n * @cssproperty --mdc-badge-primary-foreground-color - The foreground color of the primary badge.\n * @cssproperty --mdc-badge-primary-background-color - The background color of the primary badge.\n * @cssproperty --mdc-badge-secondary-foreground-color - The foreground color of the secondary badge.\n * @cssproperty --mdc-badge-secondary-background-color - The background color of the secondary badge.\n * @cssproperty --mdc-badge-success-foreground-color - The foreground color of the success badge.\n * @cssproperty --mdc-badge-success-background-color - The background color of the success badge.\n * @cssproperty --mdc-badge-warning-foreground-color - The foreground color of the warning badge.\n * @cssproperty --mdc-badge-warning-background-color - The background color of the warning badge.\n * @cssproperty --mdc-badge-error-foreground-color - The foreground color of the error badge.\n * @cssproperty --mdc-badge-error-background-color - The background color of the error badge.\n * @cssproperty --mdc-badge-overlay-background-color - The background color of the badge overlay.\n */",
|
2514
|
-
"customElement": true
|
3174
|
+
]
|
2515
3175
|
}
|
2516
3176
|
],
|
2517
3177
|
"exports": [
|
@@ -2519,8 +3179,8 @@
|
|
2519
3179
|
"kind": "js",
|
2520
3180
|
"name": "default",
|
2521
3181
|
"declaration": {
|
2522
|
-
"name": "
|
2523
|
-
"module": "components/
|
3182
|
+
"name": "ButtonLink",
|
3183
|
+
"module": "components/buttonlink/buttonlink.component.js"
|
2524
3184
|
}
|
2525
3185
|
}
|
2526
3186
|
]
|
@@ -16835,17 +17495,165 @@
|
|
16835
17495
|
"text": "boolean"
|
16836
17496
|
},
|
16837
17497
|
"default": "false",
|
16838
|
-
"description": "Determines whether the checkbox is selected or unselected.",
|
17498
|
+
"description": "Determines whether the checkbox is selected or unselected.",
|
17499
|
+
"fieldName": "checked"
|
17500
|
+
},
|
17501
|
+
{
|
17502
|
+
"name": "indeterminate",
|
17503
|
+
"type": {
|
17504
|
+
"text": "boolean"
|
17505
|
+
},
|
17506
|
+
"default": "false",
|
17507
|
+
"description": "Determines whether the checkbox is in an indeterminate state.",
|
17508
|
+
"fieldName": "indeterminate"
|
17509
|
+
},
|
17510
|
+
{
|
17511
|
+
"name": "disabled",
|
17512
|
+
"type": {
|
17513
|
+
"text": "boolean | undefined"
|
17514
|
+
},
|
17515
|
+
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
17516
|
+
"default": "undefined",
|
17517
|
+
"fieldName": "disabled",
|
17518
|
+
"inheritedFrom": {
|
17519
|
+
"name": "DisabledMixin",
|
17520
|
+
"module": "src/utils/mixins/DisabledMixin.ts"
|
17521
|
+
}
|
17522
|
+
}
|
17523
|
+
],
|
17524
|
+
"mixins": [
|
17525
|
+
{
|
17526
|
+
"name": "DisabledMixin",
|
17527
|
+
"module": "/src/utils/mixins/DisabledMixin"
|
17528
|
+
}
|
17529
|
+
],
|
17530
|
+
"superclass": {
|
17531
|
+
"name": "Component",
|
17532
|
+
"module": "/src/models"
|
17533
|
+
},
|
17534
|
+
"tagName": "mdc-staticcheckbox",
|
17535
|
+
"jsDoc": "/**\n * This is a decorative component that is styled to look as a checkbox.\n *\n * It has 3 properties - checked, indeterminate and disabled.\n *\n * We are using the same styling that has been created for the `mdc-checkbox` component.\n *\n * @tagname mdc-staticcheckbox\n *\n * @dependency mdc-icon\n *\n * @cssproperty --mdc-staticcheckbox-border-color - Border color in high contrast.\n * @cssproperty --mdc-staticcheckbox-checked-background-color - Background color for a selected checkbox.\n * @cssproperty --mdc-staticcheckbox-disabled-background-color - Background color for a disabled checkbox.\n * @cssproperty --mdc-checkbox-disabled-border-color - Border color for a disabled checkbox.\n * @cssproperty --mdc-checkbox-disabled-checked-icon-color - Background color for a disabled, selected checkbox.\n * @cssproperty --mdc-staticcheckbox-disabled-icon-color - Icon color for a disabled checkbox.\n * @cssproperty --mdc-staticcheckbox-icon-background-color - Background color for an unselected checkbox.\n * @cssproperty --mdc-staticcheckbox-icon-border-color - Default background color for an unselected checkbox.\n * @cssproperty --mdc-staticcheckbox-icon-color - Icon color for an unselected checkbox.\n *\n */",
|
17536
|
+
"customElement": true
|
17537
|
+
}
|
17538
|
+
],
|
17539
|
+
"exports": [
|
17540
|
+
{
|
17541
|
+
"kind": "js",
|
17542
|
+
"name": "default",
|
17543
|
+
"declaration": {
|
17544
|
+
"name": "StaticCheckbox",
|
17545
|
+
"module": "components/staticcheckbox/staticcheckbox.component.js"
|
17546
|
+
}
|
17547
|
+
}
|
17548
|
+
]
|
17549
|
+
},
|
17550
|
+
{
|
17551
|
+
"kind": "javascript-module",
|
17552
|
+
"path": "components/staticradio/staticradio.component.js",
|
17553
|
+
"declarations": [
|
17554
|
+
{
|
17555
|
+
"kind": "class",
|
17556
|
+
"description": "This is a decorative component that is styled to look as a radio.\nIt has 2 properties - checked and disabled.\n\nWe are using the same styling that has been created for the `mdc-radio` component.",
|
17557
|
+
"name": "StaticRadio",
|
17558
|
+
"cssProperties": [
|
17559
|
+
{
|
17560
|
+
"description": "size of the inner circle",
|
17561
|
+
"name": "--mdc-staticradio-inner-circle-size"
|
17562
|
+
},
|
17563
|
+
{
|
17564
|
+
"description": "color of the label when disabled",
|
17565
|
+
"name": "--mdc-staticradio-text-disabled-color"
|
17566
|
+
},
|
17567
|
+
{
|
17568
|
+
"description": "color of the radio button border when normal",
|
17569
|
+
"name": "--mdc-staticradio-normal-border-color"
|
17570
|
+
},
|
17571
|
+
{
|
17572
|
+
"description": "color of the radio button border when disabled",
|
17573
|
+
"name": "--mdc-staticradio-disabled-border-color"
|
17574
|
+
},
|
17575
|
+
{
|
17576
|
+
"description": "background color of the inner circle when normal",
|
17577
|
+
"name": "--mdc-staticradio-inner-circle-normal-background"
|
17578
|
+
},
|
17579
|
+
{
|
17580
|
+
"description": "background color of the inner circle when disabled",
|
17581
|
+
"name": "--mdc-staticradio-inner-circle-disabled-background"
|
17582
|
+
},
|
17583
|
+
{
|
17584
|
+
"description": "color of the radio button when inactive",
|
17585
|
+
"name": "--mdc-staticradio-control-inactive-color"
|
17586
|
+
},
|
17587
|
+
{
|
17588
|
+
"description": "background color of the radio button when inactive and disabled",
|
17589
|
+
"name": "--mdc-staticradio-control-inactive-disabled-background"
|
17590
|
+
},
|
17591
|
+
{
|
17592
|
+
"description": "color of the radio button when active",
|
17593
|
+
"name": "--mdc-staticradio-control-active-color"
|
17594
|
+
},
|
17595
|
+
{
|
17596
|
+
"description": "background color of the radio button when active and disabled",
|
17597
|
+
"name": "--mdc-staticradio-control-active-disabled-background"
|
17598
|
+
}
|
17599
|
+
],
|
17600
|
+
"members": [
|
17601
|
+
{
|
17602
|
+
"kind": "field",
|
17603
|
+
"name": "checked",
|
17604
|
+
"type": {
|
17605
|
+
"text": "boolean"
|
17606
|
+
},
|
17607
|
+
"default": "false",
|
17608
|
+
"description": "Determines whether the radio is selected or unselected.",
|
17609
|
+
"attribute": "checked",
|
17610
|
+
"reflects": true
|
17611
|
+
},
|
17612
|
+
{
|
17613
|
+
"kind": "field",
|
17614
|
+
"name": "readonly",
|
17615
|
+
"type": {
|
17616
|
+
"text": "boolean"
|
17617
|
+
},
|
17618
|
+
"default": "false",
|
17619
|
+
"description": "Determines whether the radio is read-only.",
|
17620
|
+
"attribute": "readonly",
|
17621
|
+
"reflects": true
|
17622
|
+
},
|
17623
|
+
{
|
17624
|
+
"kind": "field",
|
17625
|
+
"name": "disabled",
|
17626
|
+
"type": {
|
17627
|
+
"text": "boolean | undefined"
|
17628
|
+
},
|
17629
|
+
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
17630
|
+
"default": "undefined",
|
17631
|
+
"attribute": "disabled",
|
17632
|
+
"reflects": true,
|
17633
|
+
"inheritedFrom": {
|
17634
|
+
"name": "DisabledMixin",
|
17635
|
+
"module": "utils/mixins/DisabledMixin.js"
|
17636
|
+
}
|
17637
|
+
}
|
17638
|
+
],
|
17639
|
+
"attributes": [
|
17640
|
+
{
|
17641
|
+
"name": "checked",
|
17642
|
+
"type": {
|
17643
|
+
"text": "boolean"
|
17644
|
+
},
|
17645
|
+
"default": "false",
|
17646
|
+
"description": "Determines whether the radio is selected or unselected.",
|
16839
17647
|
"fieldName": "checked"
|
16840
17648
|
},
|
16841
17649
|
{
|
16842
|
-
"name": "
|
17650
|
+
"name": "readonly",
|
16843
17651
|
"type": {
|
16844
17652
|
"text": "boolean"
|
16845
17653
|
},
|
16846
17654
|
"default": "false",
|
16847
|
-
"description": "Determines whether the
|
16848
|
-
"fieldName": "
|
17655
|
+
"description": "Determines whether the radio is read-only.",
|
17656
|
+
"fieldName": "readonly"
|
16849
17657
|
},
|
16850
17658
|
{
|
16851
17659
|
"name": "disabled",
|
@@ -16871,8 +17679,8 @@
|
|
16871
17679
|
"name": "Component",
|
16872
17680
|
"module": "/src/models"
|
16873
17681
|
},
|
16874
|
-
"tagName": "mdc-
|
16875
|
-
"jsDoc": "/**\n * This is a decorative component that is styled to look as a
|
17682
|
+
"tagName": "mdc-staticradio",
|
17683
|
+
"jsDoc": "/**\n * This is a decorative component that is styled to look as a radio.\n * It has 2 properties - checked and disabled.\n *\n * We are using the same styling that has been created for the `mdc-radio` component.\n *\n * @tagname mdc-staticradio\n *\n * @cssproperty --mdc-staticradio-inner-circle-size - size of the inner circle\n * @cssproperty --mdc-staticradio-text-disabled-color - color of the label when disabled\n * @cssproperty --mdc-staticradio-normal-border-color - color of the radio button border when normal\n * @cssproperty --mdc-staticradio-disabled-border-color - color of the radio button border when disabled\n * @cssproperty --mdc-staticradio-inner-circle-normal-background - background color of the inner circle when normal\n * @cssproperty --mdc-staticradio-inner-circle-disabled-background - background color of the inner circle when disabled\n * @cssproperty --mdc-staticradio-control-inactive-color - color of the radio button when inactive\n * @cssproperty --mdc-staticradio-control-inactive-disabled-background - background color of the radio button when\n * inactive and disabled\n * @cssproperty --mdc-staticradio-control-active-color - color of the radio button when active\n * @cssproperty --mdc-staticradio-control-active-disabled-background - background color of the radio button\n * when active and disabled\n */",
|
16876
17684
|
"customElement": true
|
16877
17685
|
}
|
16878
17686
|
],
|
@@ -16881,60 +17689,86 @@
|
|
16881
17689
|
"kind": "js",
|
16882
17690
|
"name": "default",
|
16883
17691
|
"declaration": {
|
16884
|
-
"name": "
|
16885
|
-
"module": "components/
|
17692
|
+
"name": "StaticRadio",
|
17693
|
+
"module": "components/staticradio/staticradio.component.js"
|
16886
17694
|
}
|
16887
17695
|
}
|
16888
17696
|
]
|
16889
17697
|
},
|
16890
17698
|
{
|
16891
17699
|
"kind": "javascript-module",
|
16892
|
-
"path": "components/
|
17700
|
+
"path": "components/statictoggle/statictoggle.component.js",
|
16893
17701
|
"declarations": [
|
16894
17702
|
{
|
16895
17703
|
"kind": "class",
|
16896
|
-
"description": "This is a decorative component that is styled to look as a
|
16897
|
-
"name": "
|
17704
|
+
"description": "This is a decorative component that is styled to look as a toggle. <br/>\nIt has 3 properties - checked, size and disabled. <br/>\nWe are using the same styling that has been created for the `mdc-toggle` component.",
|
17705
|
+
"name": "StaticToggle",
|
16898
17706
|
"cssProperties": [
|
16899
17707
|
{
|
16900
|
-
"description": "
|
16901
|
-
"name": "--mdc-
|
17708
|
+
"description": "Width of the toggle",
|
17709
|
+
"name": "--mdc-statictoggle-width"
|
16902
17710
|
},
|
16903
17711
|
{
|
16904
|
-
"description": "
|
16905
|
-
"name": "--mdc-
|
17712
|
+
"description": "Height of the toggle",
|
17713
|
+
"name": "--mdc-statictoggle-height"
|
16906
17714
|
},
|
16907
17715
|
{
|
16908
|
-
"description": "
|
16909
|
-
"name": "--mdc-
|
17716
|
+
"description": "Width of the toggle when it's size is compact",
|
17717
|
+
"name": "--mdc-statictoggle-width-compact"
|
16910
17718
|
},
|
16911
17719
|
{
|
16912
|
-
"description": "
|
16913
|
-
"name": "--mdc-
|
17720
|
+
"description": "Height of the toggle when it's size is compact",
|
17721
|
+
"name": "--mdc-statictoggle-height-compact"
|
16914
17722
|
},
|
16915
17723
|
{
|
16916
|
-
"description": "
|
16917
|
-
"name": "--mdc-
|
17724
|
+
"description": "Border radius of the toggle",
|
17725
|
+
"name": "--mdc-statictoggle-border-radius"
|
16918
17726
|
},
|
16919
17727
|
{
|
16920
|
-
"description": "
|
16921
|
-
"name": "--mdc-
|
17728
|
+
"description": "Border radius of the toggle when it's size is compact",
|
17729
|
+
"name": "--mdc-statictoggle-border-radius-compact"
|
16922
17730
|
},
|
16923
17731
|
{
|
16924
|
-
"description": "
|
16925
|
-
"name": "--mdc-
|
17732
|
+
"description": "Border of the toggle",
|
17733
|
+
"name": "--mdc-statictoggle-border"
|
16926
17734
|
},
|
16927
17735
|
{
|
16928
|
-
"description": "
|
16929
|
-
"name": "--mdc-
|
17736
|
+
"description": "Background color of the inactive toggle in rest state",
|
17737
|
+
"name": "--mdc-statictoggle-inactive-rest-color"
|
16930
17738
|
},
|
16931
17739
|
{
|
16932
|
-
"description": "color of the
|
16933
|
-
"name": "--mdc-
|
17740
|
+
"description": "Background color of the inactive toggle in disabled state",
|
17741
|
+
"name": "--mdc-statictoggle-inactive-disabled-color"
|
16934
17742
|
},
|
16935
17743
|
{
|
16936
|
-
"description": "
|
16937
|
-
"name": "--mdc-
|
17744
|
+
"description": "Background color of the active toggle in rest state",
|
17745
|
+
"name": "--mdc-statictoggle-active-rest-color"
|
17746
|
+
},
|
17747
|
+
{
|
17748
|
+
"description": "Background color of the active toggle in disabled state",
|
17749
|
+
"name": "--mdc-statictoggle-active-disabled-color"
|
17750
|
+
},
|
17751
|
+
{
|
17752
|
+
"description": "Color of the icon in normal state",
|
17753
|
+
"name": "--mdc-statictoggle-icon-color-normal"
|
17754
|
+
},
|
17755
|
+
{
|
17756
|
+
"description": "Color of the icon in disabled state",
|
17757
|
+
"name": "--mdc-statictoggle-icon-color-disabled"
|
17758
|
+
},
|
17759
|
+
{
|
17760
|
+
"description": "Background color of the icon in normal state",
|
17761
|
+
"name": "--mdc-statictoggle-icon-background-color-normal"
|
17762
|
+
},
|
17763
|
+
{
|
17764
|
+
"description": "Background color of the icon in disabled state",
|
17765
|
+
"name": "--mdc-statictoggle-icon-background-color-disabled"
|
17766
|
+
}
|
17767
|
+
],
|
17768
|
+
"slots": [
|
17769
|
+
{
|
17770
|
+
"description": "This is a default/unnamed slot",
|
17771
|
+
"name": "default"
|
16938
17772
|
}
|
16939
17773
|
],
|
16940
17774
|
"members": [
|
@@ -16945,19 +17779,19 @@
|
|
16945
17779
|
"text": "boolean"
|
16946
17780
|
},
|
16947
17781
|
"default": "false",
|
16948
|
-
"description": "Determines whether the
|
17782
|
+
"description": "Determines whether the toggle is active or inactive.",
|
16949
17783
|
"attribute": "checked",
|
16950
17784
|
"reflects": true
|
16951
17785
|
},
|
16952
17786
|
{
|
16953
17787
|
"kind": "field",
|
16954
|
-
"name": "
|
17788
|
+
"name": "size",
|
16955
17789
|
"type": {
|
16956
|
-
"text": "
|
17790
|
+
"text": "ToggleSize"
|
16957
17791
|
},
|
16958
|
-
"
|
16959
|
-
"
|
16960
|
-
"attribute": "
|
17792
|
+
"description": "Determines toggle size in rem (height is specified here).\n- **Default**: 1.5\n- **Compact**: 1",
|
17793
|
+
"default": "default",
|
17794
|
+
"attribute": "size",
|
16961
17795
|
"reflects": true
|
16962
17796
|
},
|
16963
17797
|
{
|
@@ -16983,17 +17817,17 @@
|
|
16983
17817
|
"text": "boolean"
|
16984
17818
|
},
|
16985
17819
|
"default": "false",
|
16986
|
-
"description": "Determines whether the
|
17820
|
+
"description": "Determines whether the toggle is active or inactive.",
|
16987
17821
|
"fieldName": "checked"
|
16988
17822
|
},
|
16989
17823
|
{
|
16990
|
-
"name": "
|
17824
|
+
"name": "size",
|
16991
17825
|
"type": {
|
16992
|
-
"text": "
|
17826
|
+
"text": "ToggleSize"
|
16993
17827
|
},
|
16994
|
-
"
|
16995
|
-
"
|
16996
|
-
"fieldName": "
|
17828
|
+
"description": "Determines toggle size in rem (height is specified here).\n- **Default**: 1.5\n- **Compact**: 1",
|
17829
|
+
"default": "default",
|
17830
|
+
"fieldName": "size"
|
16997
17831
|
},
|
16998
17832
|
{
|
16999
17833
|
"name": "disabled",
|
@@ -17019,8 +17853,8 @@
|
|
17019
17853
|
"name": "Component",
|
17020
17854
|
"module": "/src/models"
|
17021
17855
|
},
|
17022
|
-
"tagName": "mdc-
|
17023
|
-
"jsDoc": "/**\n * This is a decorative component that is styled to look as a
|
17856
|
+
"tagName": "mdc-statictoggle",
|
17857
|
+
"jsDoc": "/**\n * This is a decorative component that is styled to look as a toggle. <br/>\n * It has 3 properties - checked, size and disabled. <br/>\n * We are using the same styling that has been created for the `mdc-toggle` component.\n *\n * @dependency mdc-icon\n *\n * @tagname mdc-statictoggle\n *\n * @slot default - This is a default/unnamed slot\n *\n * @cssproperty --mdc-statictoggle-width - Width of the toggle\n * @cssproperty --mdc-statictoggle-height - Height of the toggle\n * @cssproperty --mdc-statictoggle-width-compact - Width of the toggle when it's size is compact\n * @cssproperty --mdc-statictoggle-height-compact - Height of the toggle when it's size is compact\n * @cssproperty --mdc-statictoggle-border-radius - Border radius of the toggle\n * @cssproperty --mdc-statictoggle-border-radius-compact - Border radius of the toggle when it's size is compact\n * @cssproperty --mdc-statictoggle-border - Border of the toggle\n * @cssproperty --mdc-statictoggle-inactive-rest-color - Background color of the inactive toggle in rest state\n * @cssproperty --mdc-statictoggle-inactive-disabled-color - Background color of the inactive toggle in disabled state\n * @cssproperty --mdc-statictoggle-active-rest-color - Background color of the active toggle in rest state\n * @cssproperty --mdc-statictoggle-active-disabled-color - Background color of the active toggle in disabled state\n * @cssproperty --mdc-statictoggle-icon-color-normal - Color of the icon in normal state\n * @cssproperty --mdc-statictoggle-icon-color-disabled - Color of the icon in disabled state\n * @cssproperty --mdc-statictoggle-icon-background-color-normal - Background color of the icon in normal state\n * @cssproperty --mdc-statictoggle-icon-background-color-disabled - Background color of the icon in disabled state\n */",
|
17024
17858
|
"customElement": true
|
17025
17859
|
}
|
17026
17860
|
],
|
@@ -17029,8 +17863,8 @@
|
|
17029
17863
|
"kind": "js",
|
17030
17864
|
"name": "default",
|
17031
17865
|
"declaration": {
|
17032
|
-
"name": "
|
17033
|
-
"module": "components/
|
17866
|
+
"name": "StaticToggle",
|
17867
|
+
"module": "components/statictoggle/statictoggle.component.js"
|
17034
17868
|
}
|
17035
17869
|
}
|
17036
17870
|
]
|
@@ -18989,72 +19823,56 @@
|
|
18989
19823
|
"name": "Toggle",
|
18990
19824
|
"cssProperties": [
|
18991
19825
|
{
|
18992
|
-
"description": "
|
19826
|
+
"description": "Width of the toggle",
|
18993
19827
|
"name": "--mdc-toggle-width"
|
18994
19828
|
},
|
18995
19829
|
{
|
18996
|
-
"description": "
|
19830
|
+
"description": "Height of the toggle",
|
18997
19831
|
"name": "--mdc-toggle-height"
|
18998
19832
|
},
|
18999
19833
|
{
|
19000
|
-
"description": "
|
19834
|
+
"description": "Width of the toggle when it's size is compact",
|
19001
19835
|
"name": "--mdc-toggle-width-compact"
|
19002
19836
|
},
|
19003
19837
|
{
|
19004
|
-
"description": "
|
19838
|
+
"description": "Height of the toggle when it's size is compact",
|
19005
19839
|
"name": "--mdc-toggle-height-compact"
|
19006
19840
|
},
|
19007
19841
|
{
|
19008
|
-
"description": "
|
19009
|
-
"name": "--mdc-toggle-
|
19010
|
-
},
|
19011
|
-
{
|
19012
|
-
"description": "border radius of the toggle when it's size is compact",
|
19013
|
-
"name": "--mdc-toggle-border-radius-compact"
|
19842
|
+
"description": "Line height of the toggle label",
|
19843
|
+
"name": "--mdc-toggle-label-lineheight"
|
19014
19844
|
},
|
19015
19845
|
{
|
19016
|
-
"description": "
|
19017
|
-
"name": "--mdc-toggle-
|
19846
|
+
"description": "Font size of the toggle label",
|
19847
|
+
"name": "--mdc-toggle-label-fontsize"
|
19018
19848
|
},
|
19019
19849
|
{
|
19020
|
-
"description": "
|
19021
|
-
"name": "--mdc-toggle-
|
19850
|
+
"description": "Font weight of the toggle label",
|
19851
|
+
"name": "--mdc-toggle-label-fontweight"
|
19022
19852
|
},
|
19023
19853
|
{
|
19024
|
-
"description": "
|
19025
|
-
"name": "--mdc-toggle-
|
19026
|
-
},
|
19027
|
-
{
|
19028
|
-
"description": "background color of the inactive toggle in pressed state",
|
19029
|
-
"name": "--mdc-toggle-inactive-pressed-color"
|
19030
|
-
},
|
19031
|
-
{
|
19032
|
-
"description": "background color of the inactive toggle in disabled state",
|
19033
|
-
"name": "--mdc-toggle-inactive-disabled-color"
|
19854
|
+
"description": "Color of the toggle label and help text in disabled state",
|
19855
|
+
"name": "--mdc-toggle-label-color-disabled"
|
19034
19856
|
},
|
19035
19857
|
{
|
19036
|
-
"description": "
|
19037
|
-
"name": "--mdc-toggle-
|
19858
|
+
"description": "Color of the help text label",
|
19859
|
+
"name": "--mdc-toggle-help-text-color"
|
19038
19860
|
},
|
19039
19861
|
{
|
19040
|
-
"description": "
|
19862
|
+
"description": "Background color of the active toggle in hover state",
|
19041
19863
|
"name": "--mdc-toggle-active-hover-color"
|
19042
19864
|
},
|
19043
19865
|
{
|
19044
|
-
"description": "
|
19866
|
+
"description": "Background color of the active toggle in pressed state",
|
19045
19867
|
"name": "--mdc-toggle-active-pressed-color"
|
19046
19868
|
},
|
19047
19869
|
{
|
19048
|
-
"description": "
|
19049
|
-
"name": "--mdc-toggle-
|
19050
|
-
},
|
19051
|
-
{
|
19052
|
-
"description": " color of the help text label",
|
19053
|
-
"name": "--mdc-toggle-help-text-color"
|
19870
|
+
"description": "Background color of the inactive toggle in hover state",
|
19871
|
+
"name": "--mdc-toggle-inactive-hover-color"
|
19054
19872
|
},
|
19055
19873
|
{
|
19056
|
-
"description": "color of the toggle
|
19057
|
-
"name": "--mdc-toggle-
|
19874
|
+
"description": "Background color of the inactive toggle in pressed state",
|
19875
|
+
"name": "--mdc-toggle-inactive-pressed-color"
|
19058
19876
|
}
|
19059
19877
|
],
|
19060
19878
|
"members": [
|
@@ -19634,7 +20452,7 @@
|
|
19634
20452
|
"module": "/src/components/formfieldwrapper"
|
19635
20453
|
},
|
19636
20454
|
"tagName": "mdc-toggle",
|
19637
|
-
"jsDoc": "/**\n * Toggle Component is an interactive control used to switch between two mutually exclusive options,\n * such as On/Off, Active/Inactive. These are commonly used in settings panels, forms, and preference selections\n * where users need to enable or disable a feature.\n * It contains an optional label and an optional helper text.\n *\n * To create a group of toggles, use the FormFieldGroup component.\n *\n * Note: It internally renders a checkbox styled as a toggle switch.\n *\n * @dependency mdc-icon\n *\n * @tagname mdc-toggle\n *\n * @event change - (React: onChange) Event that gets dispatched when the toggle state changes.\n * @event focus - (React: onFocus) Event that gets dispatched when the toggle receives focus.\n *\n * @cssproperty --mdc-toggle-width -
|
20455
|
+
"jsDoc": "/**\n * Toggle Component is an interactive control used to switch between two mutually exclusive options,\n * such as On/Off, Active/Inactive. These are commonly used in settings panels, forms, and preference selections\n * where users need to enable or disable a feature.\n * It contains an optional label and an optional helper text.\n *\n * To create a group of toggles, use the FormFieldGroup component.\n *\n * Note: It internally renders a checkbox styled as a toggle switch.\n *\n * @dependency mdc-icon\n * @dependency mdc-statictoggle\n *\n * @tagname mdc-toggle\n *\n * @event change - (React: onChange) Event that gets dispatched when the toggle state changes.\n * @event focus - (React: onFocus) Event that gets dispatched when the toggle receives focus.\n *\n * @cssproperty --mdc-toggle-width - Width of the toggle\n * @cssproperty --mdc-toggle-height - Height of the toggle\n * @cssproperty --mdc-toggle-width-compact - Width of the toggle when it's size is compact\n * @cssproperty --mdc-toggle-height-compact - Height of the toggle when it's size is compact\n * @cssproperty --mdc-toggle-label-lineheight - Line height of the toggle label\n * @cssproperty --mdc-toggle-label-fontsize - Font size of the toggle label\n * @cssproperty --mdc-toggle-label-fontweight - Font weight of the toggle label\n * @cssproperty --mdc-toggle-label-color-disabled - Color of the toggle label and help text in disabled state\n * @cssproperty --mdc-toggle-help-text-color - Color of the help text label\n * @cssproperty --mdc-toggle-active-hover-color - Background color of the active toggle in hover state\n * @cssproperty --mdc-toggle-active-pressed-color - Background color of the active toggle in pressed state\n * @cssproperty --mdc-toggle-inactive-hover-color - Background color of the inactive toggle in hover state\n * @cssproperty --mdc-toggle-inactive-pressed-color - Background color of the inactive toggle in pressed state\n */",
|
19638
20456
|
"customElement": true,
|
19639
20457
|
"slots": [
|
19640
20458
|
{
|
@@ -23326,6 +24144,166 @@
|
|
23326
24144
|
}
|
23327
24145
|
]
|
23328
24146
|
},
|
24147
|
+
{
|
24148
|
+
"kind": "javascript-module",
|
24149
|
+
"path": "utils/mixins/ButtonComponentMixin.js",
|
24150
|
+
"declarations": [
|
24151
|
+
{
|
24152
|
+
"kind": "mixin",
|
24153
|
+
"description": "",
|
24154
|
+
"name": "ButtonComponentMixin",
|
24155
|
+
"members": [
|
24156
|
+
{
|
24157
|
+
"kind": "field",
|
24158
|
+
"name": "prefixIcon",
|
24159
|
+
"type": {
|
24160
|
+
"text": "IconNames | undefined"
|
24161
|
+
},
|
24162
|
+
"description": "The name of the icon to display as a prefix.\nThe icon is displayed on the left side of the button.",
|
24163
|
+
"attribute": "prefix-icon",
|
24164
|
+
"reflects": true
|
24165
|
+
},
|
24166
|
+
{
|
24167
|
+
"kind": "field",
|
24168
|
+
"name": "postfixIcon",
|
24169
|
+
"type": {
|
24170
|
+
"text": "IconNames | undefined"
|
24171
|
+
},
|
24172
|
+
"description": "The name of the icon to display as a postfix.\nThe icon is displayed on the right side of the button.",
|
24173
|
+
"attribute": "postfix-icon",
|
24174
|
+
"reflects": true
|
24175
|
+
},
|
24176
|
+
{
|
24177
|
+
"kind": "field",
|
24178
|
+
"name": "variant",
|
24179
|
+
"type": {
|
24180
|
+
"text": "ButtonVariant"
|
24181
|
+
},
|
24182
|
+
"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.",
|
24183
|
+
"default": "primary",
|
24184
|
+
"attribute": "variant"
|
24185
|
+
},
|
24186
|
+
{
|
24187
|
+
"kind": "field",
|
24188
|
+
"name": "color",
|
24189
|
+
"type": {
|
24190
|
+
"text": "ButtonColor"
|
24191
|
+
},
|
24192
|
+
"description": "There are 5 colors for button: positive, negative, accent, promotional, default.",
|
24193
|
+
"default": "default",
|
24194
|
+
"attribute": "color"
|
24195
|
+
},
|
24196
|
+
{
|
24197
|
+
"kind": "method",
|
24198
|
+
"name": "setVariant",
|
24199
|
+
"parameters": [
|
24200
|
+
{
|
24201
|
+
"name": "variant",
|
24202
|
+
"type": {
|
24203
|
+
"text": "ButtonVariant"
|
24204
|
+
},
|
24205
|
+
"description": "The variant to set."
|
24206
|
+
}
|
24207
|
+
],
|
24208
|
+
"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."
|
24209
|
+
},
|
24210
|
+
{
|
24211
|
+
"kind": "method",
|
24212
|
+
"name": "setColor",
|
24213
|
+
"parameters": [
|
24214
|
+
{
|
24215
|
+
"name": "color",
|
24216
|
+
"type": {
|
24217
|
+
"text": "ButtonColor"
|
24218
|
+
},
|
24219
|
+
"description": "The color to set."
|
24220
|
+
}
|
24221
|
+
],
|
24222
|
+
"description": "Sets the color attribute for the button.\nDefaults to DEFAULTS.COLOR if invalid or for tertiary button."
|
24223
|
+
},
|
24224
|
+
{
|
24225
|
+
"kind": "method",
|
24226
|
+
"name": "setSize",
|
24227
|
+
"parameters": [
|
24228
|
+
{
|
24229
|
+
"name": "size",
|
24230
|
+
"type": {
|
24231
|
+
"text": "PillButtonSize | IconButtonSize"
|
24232
|
+
},
|
24233
|
+
"description": "The size to set."
|
24234
|
+
}
|
24235
|
+
],
|
24236
|
+
"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."
|
24237
|
+
},
|
24238
|
+
{
|
24239
|
+
"kind": "method",
|
24240
|
+
"name": "inferButtonType",
|
24241
|
+
"description": "Infers the type of button based on the presence of slot and/or prefix and postfix icons.",
|
24242
|
+
"parameters": [
|
24243
|
+
{
|
24244
|
+
"description": "default slot of button",
|
24245
|
+
"name": "slot"
|
24246
|
+
}
|
24247
|
+
]
|
24248
|
+
}
|
24249
|
+
],
|
24250
|
+
"attributes": [
|
24251
|
+
{
|
24252
|
+
"name": "prefix-icon",
|
24253
|
+
"type": {
|
24254
|
+
"text": "IconNames | undefined"
|
24255
|
+
},
|
24256
|
+
"description": "The name of the icon to display as a prefix.\nThe icon is displayed on the left side of the button.",
|
24257
|
+
"fieldName": "prefixIcon"
|
24258
|
+
},
|
24259
|
+
{
|
24260
|
+
"name": "postfix-icon",
|
24261
|
+
"type": {
|
24262
|
+
"text": "IconNames | undefined"
|
24263
|
+
},
|
24264
|
+
"description": "The name of the icon to display as a postfix.\nThe icon is displayed on the right side of the button.",
|
24265
|
+
"fieldName": "postfixIcon"
|
24266
|
+
},
|
24267
|
+
{
|
24268
|
+
"name": "variant",
|
24269
|
+
"type": {
|
24270
|
+
"text": "ButtonVariant"
|
24271
|
+
},
|
24272
|
+
"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.",
|
24273
|
+
"default": "primary",
|
24274
|
+
"fieldName": "variant"
|
24275
|
+
},
|
24276
|
+
{
|
24277
|
+
"name": "color",
|
24278
|
+
"type": {
|
24279
|
+
"text": "ButtonColor"
|
24280
|
+
},
|
24281
|
+
"description": "There are 5 colors for button: positive, negative, accent, promotional, default.",
|
24282
|
+
"default": "default",
|
24283
|
+
"fieldName": "color"
|
24284
|
+
}
|
24285
|
+
],
|
24286
|
+
"parameters": [
|
24287
|
+
{
|
24288
|
+
"name": "superClass",
|
24289
|
+
"type": {
|
24290
|
+
"text": "T"
|
24291
|
+
}
|
24292
|
+
}
|
24293
|
+
]
|
24294
|
+
}
|
24295
|
+
],
|
24296
|
+
"exports": [
|
24297
|
+
{
|
24298
|
+
"kind": "js",
|
24299
|
+
"name": "ButtonComponentMixin",
|
24300
|
+
"declaration": {
|
24301
|
+
"name": "ButtonComponentMixin",
|
24302
|
+
"module": "utils/mixins/ButtonComponentMixin.js"
|
24303
|
+
}
|
24304
|
+
}
|
24305
|
+
]
|
24306
|
+
},
|
23329
24307
|
{
|
23330
24308
|
"kind": "javascript-module",
|
23331
24309
|
"path": "utils/mixins/DataAriaLabelMixin.js",
|