@momentum-design/components 0.57.0 → 0.58.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1437,6 +1437,327 @@
1437
1437
  }
1438
1438
  ]
1439
1439
  },
1440
+ {
1441
+ "kind": "javascript-module",
1442
+ "path": "components/badge/badge.component.js",
1443
+ "declarations": [
1444
+ {
1445
+ "kind": "class",
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
+ {
1450
+ "description": "The foreground color of the primary badge.",
1451
+ "name": "--mdc-badge-primary-foreground-color"
1452
+ },
1453
+ {
1454
+ "description": "The background color of the primary badge.",
1455
+ "name": "--mdc-badge-primary-background-color"
1456
+ },
1457
+ {
1458
+ "description": "The foreground color of the secondary badge.",
1459
+ "name": "--mdc-badge-secondary-foreground-color"
1460
+ },
1461
+ {
1462
+ "description": "The background color of the secondary badge.",
1463
+ "name": "--mdc-badge-secondary-background-color"
1464
+ },
1465
+ {
1466
+ "description": "The foreground color of the success badge.",
1467
+ "name": "--mdc-badge-success-foreground-color"
1468
+ },
1469
+ {
1470
+ "description": "The background color of the success badge.",
1471
+ "name": "--mdc-badge-success-background-color"
1472
+ },
1473
+ {
1474
+ "description": "The foreground color of the warning badge.",
1475
+ "name": "--mdc-badge-warning-foreground-color"
1476
+ },
1477
+ {
1478
+ "description": "The background color of the warning badge.",
1479
+ "name": "--mdc-badge-warning-background-color"
1480
+ },
1481
+ {
1482
+ "description": "The foreground color of the error badge.",
1483
+ "name": "--mdc-badge-error-foreground-color"
1484
+ },
1485
+ {
1486
+ "description": "The background color of the error badge.",
1487
+ "name": "--mdc-badge-error-background-color"
1488
+ },
1489
+ {
1490
+ "description": "The background color of the badge overlay.",
1491
+ "name": "--mdc-badge-overlay-background-color"
1492
+ }
1493
+ ],
1494
+ "members": [
1495
+ {
1496
+ "kind": "field",
1497
+ "name": "type",
1498
+ "type": {
1499
+ "text": "BadgeType | undefined"
1500
+ },
1501
+ "description": "Type of the badge\nCan be `dot` (notification) , `icon`, `counter`, `success`, `warning` or `error`.",
1502
+ "attribute": "type",
1503
+ "reflects": true
1504
+ },
1505
+ {
1506
+ "kind": "field",
1507
+ "name": "variant",
1508
+ "type": {
1509
+ "text": "IconVariant"
1510
+ },
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",
1514
+ "reflects": true
1515
+ },
1516
+ {
1517
+ "kind": "field",
1518
+ "name": "counter",
1519
+ "type": {
1520
+ "text": "number | undefined"
1521
+ },
1522
+ "description": "Counter is the number which can be provided in the badge.",
1523
+ "attribute": "counter"
1524
+ },
1525
+ {
1526
+ "kind": "field",
1527
+ "name": "maxCounter",
1528
+ "type": {
1529
+ "text": "number"
1530
+ },
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
1535
+ },
1536
+ {
1537
+ "kind": "field",
1538
+ "name": "overlay",
1539
+ "type": {
1540
+ "text": "boolean"
1541
+ },
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"
1545
+ },
1546
+ {
1547
+ "kind": "field",
1548
+ "name": "ariaLabel",
1549
+ "type": {
1550
+ "text": "string | null"
1551
+ },
1552
+ "default": "null",
1553
+ "description": "Aria-label attribute to be set for accessibility",
1554
+ "attribute": "aria-label"
1555
+ },
1556
+ {
1557
+ "kind": "method",
1558
+ "name": "getCounterText",
1559
+ "privacy": "private",
1560
+ "return": {
1561
+ "type": {
1562
+ "text": ""
1563
+ }
1564
+ },
1565
+ "parameters": [
1566
+ {
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",
1575
+ "optional": true,
1576
+ "type": {
1577
+ "text": "number"
1578
+ },
1579
+ "description": "the number to be displayed on the badge"
1580
+ }
1581
+ ],
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."
1583
+ },
1584
+ {
1585
+ "kind": "method",
1586
+ "name": "getBadgeIcon",
1587
+ "privacy": "private",
1588
+ "return": {
1589
+ "type": {
1590
+ "text": ""
1591
+ }
1592
+ },
1593
+ "parameters": [
1594
+ {
1595
+ "name": "iconName",
1596
+ "type": {
1597
+ "text": "string"
1598
+ },
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."
1607
+ }
1608
+ ],
1609
+ "description": "Method to generate the badge icon."
1610
+ },
1611
+ {
1612
+ "kind": "method",
1613
+ "name": "getBadgeDot",
1614
+ "privacy": "private",
1615
+ "return": {
1616
+ "type": {
1617
+ "text": ""
1618
+ }
1619
+ },
1620
+ "description": "Method to generate the badge dot template."
1621
+ },
1622
+ {
1623
+ "kind": "method",
1624
+ "name": "getBadgeCounterText",
1625
+ "privacy": "private",
1626
+ "return": {
1627
+ "type": {
1628
+ "text": ""
1629
+ }
1630
+ },
1631
+ "description": "Method to generate the badge text and counter template."
1632
+ },
1633
+ {
1634
+ "kind": "method",
1635
+ "name": "setRoleByAriaLabel",
1636
+ "privacy": "private",
1637
+ "return": {
1638
+ "type": {
1639
+ "text": "void"
1640
+ }
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."
1643
+ },
1644
+ {
1645
+ "kind": "method",
1646
+ "name": "getBadgeContentBasedOnType",
1647
+ "privacy": "private",
1648
+ "return": {
1649
+ "type": {
1650
+ "text": ""
1651
+ }
1652
+ },
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."
1654
+ },
1655
+ {
1656
+ "kind": "field",
1657
+ "name": "iconName",
1658
+ "type": {
1659
+ "text": "IconNames | undefined"
1660
+ },
1661
+ "description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
1662
+ "attribute": "icon-name",
1663
+ "inheritedFrom": {
1664
+ "name": "IconNameMixin",
1665
+ "module": "utils/mixins/IconNameMixin.js"
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"
1677
+ },
1678
+ {
1679
+ "name": "variant",
1680
+ "type": {
1681
+ "text": "IconVariant"
1682
+ },
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"
1686
+ },
1687
+ {
1688
+ "name": "counter",
1689
+ "type": {
1690
+ "text": "number | undefined"
1691
+ },
1692
+ "description": "Counter is the number which can be provided in the badge.",
1693
+ "fieldName": "counter"
1694
+ },
1695
+ {
1696
+ "name": "max-counter",
1697
+ "type": {
1698
+ "text": "number"
1699
+ },
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"
1703
+ },
1704
+ {
1705
+ "name": "overlay",
1706
+ "type": {
1707
+ "text": "boolean"
1708
+ },
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"
1712
+ },
1713
+ {
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"
1721
+ },
1722
+ {
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",
1729
+ "inheritedFrom": {
1730
+ "name": "IconNameMixin",
1731
+ "module": "src/utils/mixins/IconNameMixin.ts"
1732
+ }
1733
+ }
1734
+ ],
1735
+ "mixins": [
1736
+ {
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
+ },
1440
1761
  {
1441
1762
  "kind": "javascript-module",
1442
1763
  "path": "components/brandvisual/brandvisual.component.js",
@@ -1624,206 +1945,49 @@
1624
1945
  {
1625
1946
  "description": "Text label of the button.",
1626
1947
  "name": ""
1627
- }
1628
- ],
1629
- "members": [
1630
- {
1631
- "kind": "field",
1632
- "name": "prefixIcon",
1633
- "type": {
1634
- "text": "IconNames | undefined"
1635
- },
1636
- "description": "The name of the icon to display as a prefix.\nThe icon is displayed on the left side of the button.",
1637
- "attribute": "prefix-icon",
1638
- "reflects": true
1639
- },
1640
- {
1641
- "kind": "field",
1642
- "name": "postfixIcon",
1643
- "type": {
1644
- "text": "IconNames | undefined"
1645
- },
1646
- "description": "The name of the icon to display as a postfix.\nThe icon is displayed on the right side of the button.",
1647
- "attribute": "postfix-icon",
1648
- "reflects": true
1649
- },
1650
- {
1651
- "kind": "field",
1652
- "name": "variant",
1653
- "type": {
1654
- "text": "ButtonVariant"
1655
- },
1656
- "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.",
1657
- "default": "primary",
1658
- "attribute": "variant"
1659
- },
1660
- {
1661
- "kind": "field",
1662
- "name": "size",
1663
- "type": {
1664
- "text": "ButtonSize"
1665
- },
1666
- "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.",
1667
- "default": "32",
1668
- "attribute": "size",
1669
- "reflects": true,
1670
- "inheritedFrom": {
1671
- "name": "Buttonsimple",
1672
- "module": "components/buttonsimple/buttonsimple.component.js"
1673
- }
1674
- },
1675
- {
1676
- "kind": "field",
1677
- "name": "color",
1678
- "type": {
1679
- "text": "ButtonColor"
1680
- },
1681
- "description": "There are 5 colors for button: positive, negative, accent, promotional, default.",
1682
- "default": "default",
1683
- "attribute": "color"
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
- }
1699
- },
1700
- {
1701
- "kind": "method",
1702
- "name": "inferFilledIconName",
1703
- "privacy": "private",
1704
- "parameters": [
1705
- {
1706
- "name": "active",
1707
- "optional": true,
1708
- "type": {
1709
- "text": "boolean"
1710
- },
1711
- "description": "The active state."
1712
- }
1713
- ],
1714
- "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."
1715
- },
1716
- {
1717
- "kind": "method",
1718
- "name": "setVariant",
1719
- "privacy": "private",
1720
- "parameters": [
1721
- {
1722
- "name": "variant",
1723
- "type": {
1724
- "text": "ButtonVariant"
1725
- },
1726
- "description": "The variant to set."
1727
- }
1728
- ],
1729
- "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."
1730
- },
1731
- {
1732
- "kind": "method",
1733
- "name": "setSize",
1734
- "privacy": "private",
1735
- "parameters": [
1736
- {
1737
- "name": "size",
1738
- "type": {
1739
- "text": "PillButtonSize | IconButtonSize"
1740
- },
1741
- "description": "The size to set."
1742
- }
1743
- ],
1744
- "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."
1745
- },
1746
- {
1747
- "kind": "method",
1748
- "name": "setColor",
1749
- "privacy": "private",
1750
- "parameters": [
1751
- {
1752
- "name": "color",
1753
- "type": {
1754
- "text": "ButtonColor"
1755
- },
1756
- "description": "The color to set."
1757
- }
1758
- ],
1759
- "description": "Sets the color attribute for the button.\nDefaults to DEFAULTS.COLOR if invalid or for tertiary buttons."
1760
- },
1761
- {
1762
- "kind": "method",
1763
- "name": "inferButtonType",
1764
- "privacy": "private",
1765
- "description": "Infers the type of button based on the presence of slot and/or prefix and postfix icons.",
1766
- "parameters": [
1767
- {
1768
- "description": "default slot of button",
1769
- "name": "slot"
1770
- }
1771
- ]
1772
- },
1948
+ }
1949
+ ],
1950
+ "members": [
1773
1951
  {
1774
1952
  "kind": "field",
1775
- "name": "tabIndex",
1953
+ "name": "prefixIcon",
1776
1954
  "type": {
1777
- "text": "number"
1955
+ "text": "IconNames | undefined"
1778
1956
  },
1779
- "default": "0",
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
- }
1957
+ "description": "The name of the icon to display as a prefix.\nThe icon is displayed on the left side of the button.",
1958
+ "attribute": "prefix-icon",
1959
+ "reflects": true
1787
1960
  },
1788
1961
  {
1789
1962
  "kind": "field",
1790
- "name": "disabled",
1963
+ "name": "postfixIcon",
1791
1964
  "type": {
1792
- "text": "boolean | undefined"
1965
+ "text": "IconNames | undefined"
1793
1966
  },
1794
- "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
1795
- "default": "undefined",
1796
- "attribute": "disabled",
1797
- "reflects": true,
1798
- "inheritedFrom": {
1799
- "name": "DisabledMixin",
1800
- "module": "utils/mixins/DisabledMixin.js"
1801
- }
1967
+ "description": "The name of the icon to display as a postfix.\nThe icon is displayed on the right side of the button.",
1968
+ "attribute": "postfix-icon",
1969
+ "reflects": true
1802
1970
  },
1803
1971
  {
1804
1972
  "kind": "field",
1805
- "name": "active",
1973
+ "name": "variant",
1806
1974
  "type": {
1807
- "text": "boolean | undefined"
1975
+ "text": "ButtonVariant"
1808
1976
  },
1809
- "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.",
1810
- "default": "undefined",
1811
- "attribute": "active",
1812
- "reflects": true,
1813
- "inheritedFrom": {
1814
- "name": "Buttonsimple",
1815
- "module": "components/buttonsimple/buttonsimple.component.js"
1816
- }
1977
+ "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.",
1978
+ "default": "primary",
1979
+ "attribute": "variant"
1817
1980
  },
1818
1981
  {
1819
1982
  "kind": "field",
1820
- "name": "softDisabled",
1983
+ "name": "size",
1821
1984
  "type": {
1822
- "text": "boolean | undefined"
1985
+ "text": "ButtonSize"
1823
1986
  },
1824
- "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.",
1825
- "default": "undefined",
1826
- "attribute": "soft-disabled",
1987
+ "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.",
1988
+ "default": "32",
1989
+ "attribute": "size",
1990
+ "reflects": true,
1827
1991
  "inheritedFrom": {
1828
1992
  "name": "Buttonsimple",
1829
1993
  "module": "components/buttonsimple/buttonsimple.component.js"
@@ -1831,65 +1995,24 @@
1831
1995
  },
1832
1996
  {
1833
1997
  "kind": "field",
1834
- "name": "ariaStateKey",
1998
+ "name": "color",
1835
1999
  "type": {
1836
- "text": "string | undefined"
2000
+ "text": "ButtonColor"
1837
2001
  },
1838
- "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`",
1839
- "default": "'aria-pressed' (when)",
1840
- "attribute": "ariaStateKey",
1841
- "reflects": true,
1842
- "inheritedFrom": {
1843
- "name": "Buttonsimple",
1844
- "module": "components/buttonsimple/buttonsimple.component.js"
1845
- }
2002
+ "description": "There are 5 colors for button: positive, negative, accent, promotional, default.",
2003
+ "default": "default",
2004
+ "attribute": "color"
1846
2005
  },
1847
2006
  {
1848
2007
  "kind": "field",
1849
- "name": "type",
2008
+ "name": "role",
2009
+ "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.",
2010
+ "default": "'button'",
2011
+ "attribute": "role",
2012
+ "reflects": true,
1850
2013
  "type": {
1851
- "text": "ButtonType"
2014
+ "text": "string"
1852
2015
  },
1853
- "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.",
1854
- "default": "button",
1855
- "attribute": "type",
1856
- "reflects": true,
1857
- "inheritedFrom": {
1858
- "name": "Buttonsimple",
1859
- "module": "components/buttonsimple/buttonsimple.component.js"
1860
- }
1861
- },
1862
- {
1863
- "kind": "method",
1864
- "name": "executeAction",
1865
- "privacy": "protected",
1866
- "inheritedFrom": {
1867
- "name": "Buttonsimple",
1868
- "module": "components/buttonsimple/buttonsimple.component.js"
1869
- }
1870
- },
1871
- {
1872
- "kind": "method",
1873
- "name": "setActive",
1874
- "privacy": "protected",
1875
- "parameters": [
1876
- {
1877
- "name": "element",
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.",
1893
2016
  "inheritedFrom": {
1894
2017
  "name": "Buttonsimple",
1895
2018
  "module": "components/buttonsimple/buttonsimple.component.js"
@@ -1897,621 +2020,498 @@
1897
2020
  },
1898
2021
  {
1899
2022
  "kind": "method",
1900
- "name": "setSoftDisabled",
2023
+ "name": "inferFilledIconName",
1901
2024
  "privacy": "private",
1902
2025
  "parameters": [
1903
2026
  {
1904
- "name": "element",
1905
- "type": {
1906
- "text": "HTMLElement"
1907
- },
1908
- "description": "The button element."
1909
- },
1910
- {
1911
- "name": "softDisabled",
2027
+ "name": "active",
1912
2028
  "optional": true,
1913
2029
  "type": {
1914
2030
  "text": "boolean"
1915
2031
  },
1916
- "description": "The soft-disabled state."
1917
- }
1918
- ],
1919
- "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
- "inheritedFrom": {
1921
- "name": "Buttonsimple",
1922
- "module": "components/buttonsimple/buttonsimple.component.js"
1923
- }
1924
- },
1925
- {
1926
- "kind": "method",
1927
- "name": "setDisabled",
1928
- "privacy": "private",
1929
- "parameters": [
1930
- {
1931
- "name": "element",
1932
- "type": {
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."
2032
+ "description": "The active state."
1943
2033
  }
1944
2034
  ],
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.",
1946
- "inheritedFrom": {
1947
- "name": "Buttonsimple",
1948
- "module": "components/buttonsimple/buttonsimple.component.js"
1949
- }
1950
- },
1951
- {
1952
- "kind": "method",
1953
- "name": "triggerClickEvent",
1954
- "privacy": "private",
1955
- "inheritedFrom": {
1956
- "name": "Buttonsimple",
1957
- "module": "components/buttonsimple/buttonsimple.component.js"
1958
- }
1959
- },
1960
- {
1961
- "kind": "method",
1962
- "name": "handleBlur",
1963
- "privacy": "private",
1964
- "description": "In case the button is pressed and the focus is lost while pressing,\nthe pressed class is removed.",
1965
- "inheritedFrom": {
1966
- "name": "Buttonsimple",
1967
- "module": "components/buttonsimple/buttonsimple.component.js"
1968
- }
2035
+ "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."
1969
2036
  },
1970
2037
  {
1971
2038
  "kind": "method",
1972
- "name": "handleKeyDown",
2039
+ "name": "setVariant",
1973
2040
  "privacy": "private",
1974
2041
  "parameters": [
1975
2042
  {
1976
- "name": "event",
2043
+ "name": "variant",
1977
2044
  "type": {
1978
- "text": "KeyboardEvent"
2045
+ "text": "ButtonVariant"
1979
2046
  },
1980
- "description": "The keyboard event."
2047
+ "description": "The variant to set."
1981
2048
  }
1982
2049
  ],
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.",
1984
- "inheritedFrom": {
1985
- "name": "Buttonsimple",
1986
- "module": "components/buttonsimple/buttonsimple.component.js"
1987
- }
2050
+ "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."
1988
2051
  },
1989
2052
  {
1990
2053
  "kind": "method",
1991
- "name": "handleKeyUp",
1992
- "privacy": "private",
1993
- "parameters": [
1994
- {
1995
- "name": "event",
1996
- "type": {
1997
- "text": "KeyboardEvent"
1998
- },
1999
- "description": "The keyboard event."
2000
- }
2001
- ],
2002
- "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.",
2003
- "inheritedFrom": {
2004
- "name": "Buttonsimple",
2005
- "module": "components/buttonsimple/buttonsimple.component.js"
2006
- }
2007
- }
2008
- ],
2009
- "attributes": [
2010
- {
2011
- "name": "prefix-icon",
2012
- "type": {
2013
- "text": "IconNames | undefined"
2014
- },
2015
- "description": "The name of the icon to display as a prefix.\nThe icon is displayed on the left side of the button.",
2016
- "fieldName": "prefixIcon"
2017
- },
2018
- {
2019
- "name": "postfix-icon",
2020
- "type": {
2021
- "text": "IconNames | undefined"
2022
- },
2023
- "description": "The name of the icon to display as a postfix.\nThe icon is displayed on the right side of the button.",
2024
- "fieldName": "postfixIcon"
2025
- },
2026
- {
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
- "fieldName": "variant"
2034
- },
2035
- {
2036
- "name": "size",
2037
- "type": {
2038
- "text": "ButtonSize"
2039
- },
2040
- "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.",
2041
- "default": "32",
2042
- "fieldName": "size",
2043
- "inheritedFrom": {
2044
- "name": "Buttonsimple",
2045
- "module": "src/components/buttonsimple/buttonsimple.component.ts"
2046
- }
2054
+ "name": "setSize",
2055
+ "privacy": "private",
2056
+ "parameters": [
2057
+ {
2058
+ "name": "size",
2059
+ "type": {
2060
+ "text": "PillButtonSize | IconButtonSize"
2061
+ },
2062
+ "description": "The size to set."
2063
+ }
2064
+ ],
2065
+ "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."
2047
2066
  },
2048
2067
  {
2049
- "name": "color",
2050
- "type": {
2051
- "text": "ButtonColor"
2052
- },
2053
- "description": "There are 5 colors for button: positive, negative, accent, promotional, default.",
2054
- "default": "default",
2055
- "fieldName": "color"
2068
+ "kind": "method",
2069
+ "name": "setColor",
2070
+ "privacy": "private",
2071
+ "parameters": [
2072
+ {
2073
+ "name": "color",
2074
+ "type": {
2075
+ "text": "ButtonColor"
2076
+ },
2077
+ "description": "The color to set."
2078
+ }
2079
+ ],
2080
+ "description": "Sets the color attribute for the button.\nDefaults to DEFAULTS.COLOR if invalid or for tertiary buttons."
2056
2081
  },
2057
2082
  {
2058
- "name": "role",
2059
- "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.",
2060
- "default": "'button'",
2061
- "fieldName": "role",
2062
- "type": {
2063
- "text": "string"
2064
- },
2065
- "inheritedFrom": {
2066
- "name": "Buttonsimple",
2067
- "module": "src/components/buttonsimple/buttonsimple.component.ts"
2068
- }
2083
+ "kind": "method",
2084
+ "name": "inferButtonType",
2085
+ "privacy": "private",
2086
+ "description": "Infers the type of button based on the presence of slot and/or prefix and postfix icons.",
2087
+ "parameters": [
2088
+ {
2089
+ "description": "default slot of button",
2090
+ "name": "slot"
2091
+ }
2092
+ ]
2069
2093
  },
2070
2094
  {
2095
+ "kind": "field",
2071
2096
  "name": "tabIndex",
2072
2097
  "type": {
2073
2098
  "text": "number"
2074
2099
  },
2075
2100
  "default": "0",
2076
2101
  "description": "This property specifies the tab order of the element.",
2077
- "fieldName": "tabIndex",
2102
+ "attribute": "tabIndex",
2103
+ "reflects": true,
2078
2104
  "inheritedFrom": {
2079
2105
  "name": "TabIndexMixin",
2080
- "module": "src/utils/mixins/TabIndexMixin.ts"
2106
+ "module": "utils/mixins/TabIndexMixin.js"
2081
2107
  }
2082
2108
  },
2083
2109
  {
2110
+ "kind": "field",
2084
2111
  "name": "disabled",
2085
2112
  "type": {
2086
2113
  "text": "boolean | undefined"
2087
2114
  },
2088
2115
  "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
2089
2116
  "default": "undefined",
2090
- "fieldName": "disabled",
2117
+ "attribute": "disabled",
2118
+ "reflects": true,
2091
2119
  "inheritedFrom": {
2092
2120
  "name": "DisabledMixin",
2093
- "module": "src/utils/mixins/DisabledMixin.ts"
2121
+ "module": "utils/mixins/DisabledMixin.js"
2094
2122
  }
2095
2123
  },
2096
2124
  {
2125
+ "kind": "field",
2097
2126
  "name": "active",
2098
2127
  "type": {
2099
2128
  "text": "boolean | undefined"
2100
2129
  },
2101
2130
  "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.",
2102
2131
  "default": "undefined",
2103
- "fieldName": "active",
2132
+ "attribute": "active",
2133
+ "reflects": true,
2104
2134
  "inheritedFrom": {
2105
2135
  "name": "Buttonsimple",
2106
- "module": "src/components/buttonsimple/buttonsimple.component.ts"
2136
+ "module": "components/buttonsimple/buttonsimple.component.js"
2107
2137
  }
2108
2138
  },
2109
2139
  {
2110
- "name": "soft-disabled",
2140
+ "kind": "field",
2141
+ "name": "softDisabled",
2111
2142
  "type": {
2112
2143
  "text": "boolean | undefined"
2113
2144
  },
2114
2145
  "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.",
2115
2146
  "default": "undefined",
2116
- "fieldName": "softDisabled",
2147
+ "attribute": "soft-disabled",
2117
2148
  "inheritedFrom": {
2118
2149
  "name": "Buttonsimple",
2119
- "module": "src/components/buttonsimple/buttonsimple.component.ts"
2150
+ "module": "components/buttonsimple/buttonsimple.component.js"
2120
2151
  }
2121
2152
  },
2122
2153
  {
2154
+ "kind": "field",
2123
2155
  "name": "ariaStateKey",
2124
2156
  "type": {
2125
2157
  "text": "string | undefined"
2126
2158
  },
2127
2159
  "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`",
2128
2160
  "default": "'aria-pressed' (when)",
2129
- "fieldName": "ariaStateKey",
2161
+ "attribute": "ariaStateKey",
2162
+ "reflects": true,
2130
2163
  "inheritedFrom": {
2131
2164
  "name": "Buttonsimple",
2132
- "module": "src/components/buttonsimple/buttonsimple.component.ts"
2165
+ "module": "components/buttonsimple/buttonsimple.component.js"
2133
2166
  }
2134
2167
  },
2135
2168
  {
2169
+ "kind": "field",
2136
2170
  "name": "type",
2137
2171
  "type": {
2138
2172
  "text": "ButtonType"
2139
2173
  },
2140
2174
  "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.",
2141
2175
  "default": "button",
2142
- "fieldName": "type",
2143
- "inheritedFrom": {
2144
- "name": "Buttonsimple",
2145
- "module": "src/components/buttonsimple/buttonsimple.component.ts"
2146
- }
2147
- }
2148
- ],
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
- "events": [
2157
- {
2158
- "description": "(React: onClick) This event is dispatched when the button is clicked.",
2159
- "name": "click",
2160
- "reactName": "onClick",
2161
- "inheritedFrom": {
2162
- "name": "Buttonsimple",
2163
- "module": "src/components/buttonsimple/buttonsimple.component.ts"
2164
- }
2165
- },
2166
- {
2167
- "description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the button.",
2168
- "name": "keydown",
2169
- "reactName": "onKeyDown",
2170
- "inheritedFrom": {
2171
- "name": "Buttonsimple",
2172
- "module": "src/components/buttonsimple/buttonsimple.component.ts"
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"
2182
- }
2183
- },
2184
- {
2185
- "description": "(React: onFocus) This event is dispatched when the button receives focus.",
2186
- "name": "focus",
2187
- "reactName": "onFocus",
2188
- "inheritedFrom": {
2189
- "name": "Buttonsimple",
2190
- "module": "src/components/buttonsimple/buttonsimple.component.ts"
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"
2255
- },
2256
- {
2257
- "description": "The background color of the badge overlay.",
2258
- "name": "--mdc-badge-overlay-background-color"
2259
- }
2260
- ],
2261
- "members": [
2262
- {
2263
- "kind": "field",
2264
- "name": "type",
2265
- "type": {
2266
- "text": "BadgeType | undefined"
2267
- },
2268
- "description": "Type of the badge\nCan be `dot` (notification) , `icon`, `counter`, `success`, `warning` or `error`.",
2269
2176
  "attribute": "type",
2270
- "reflects": true
2271
- },
2272
- {
2273
- "kind": "field",
2274
- "name": "variant",
2275
- "type": {
2276
- "text": "IconVariant"
2277
- },
2278
- "description": "Type of the variant can be `primary` or `secondary`.\nIt defines the background and foreground color of the icon.",
2279
- "default": "primary",
2280
- "attribute": "variant",
2281
- "reflects": true
2282
- },
2283
- {
2284
- "kind": "field",
2285
- "name": "counter",
2286
- "type": {
2287
- "text": "number | undefined"
2288
- },
2289
- "description": "Counter is the number which can be provided in the badge.",
2290
- "attribute": "counter"
2291
- },
2292
- {
2293
- "kind": "field",
2294
- "name": "maxCounter",
2295
- "type": {
2296
- "text": "number"
2297
- },
2298
- "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`.",
2299
- "default": "99",
2300
- "attribute": "max-counter",
2301
- "reflects": true
2302
- },
2303
- {
2304
- "kind": "field",
2305
- "name": "overlay",
2306
- "type": {
2307
- "text": "boolean"
2308
- },
2309
- "default": "false",
2310
- "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.",
2311
- "attribute": "overlay"
2177
+ "reflects": true,
2178
+ "inheritedFrom": {
2179
+ "name": "Buttonsimple",
2180
+ "module": "components/buttonsimple/buttonsimple.component.js"
2181
+ }
2312
2182
  },
2313
2183
  {
2314
- "kind": "field",
2315
- "name": "ariaLabel",
2316
- "type": {
2317
- "text": "string | null"
2318
- },
2319
- "default": "null",
2320
- "description": "Aria-label attribute to be set for accessibility",
2321
- "attribute": "aria-label"
2184
+ "kind": "method",
2185
+ "name": "executeAction",
2186
+ "privacy": "protected",
2187
+ "inheritedFrom": {
2188
+ "name": "Buttonsimple",
2189
+ "module": "components/buttonsimple/buttonsimple.component.js"
2190
+ }
2322
2191
  },
2323
2192
  {
2324
2193
  "kind": "method",
2325
- "name": "getCounterText",
2326
- "privacy": "private",
2327
- "return": {
2328
- "type": {
2329
- "text": ""
2330
- }
2331
- },
2194
+ "name": "setActive",
2195
+ "privacy": "protected",
2332
2196
  "parameters": [
2333
2197
  {
2334
- "name": "maxCounter",
2198
+ "name": "element",
2335
2199
  "type": {
2336
- "text": "number"
2200
+ "text": "HTMLElement"
2337
2201
  },
2338
- "description": "the maximum limit which can be displayed on the badge"
2202
+ "description": "The button element"
2339
2203
  },
2340
2204
  {
2341
- "name": "counter",
2205
+ "name": "active",
2342
2206
  "optional": true,
2343
2207
  "type": {
2344
- "text": "number"
2208
+ "text": "boolean"
2345
2209
  },
2346
- "description": "the number to be displayed on the badge"
2210
+ "description": "The active state of the element"
2347
2211
  }
2348
2212
  ],
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."
2213
+ "description": "Sets the ariaStateKey attributes based on the active state of the button.",
2214
+ "inheritedFrom": {
2215
+ "name": "Buttonsimple",
2216
+ "module": "components/buttonsimple/buttonsimple.component.js"
2217
+ }
2350
2218
  },
2351
2219
  {
2352
2220
  "kind": "method",
2353
- "name": "getBadgeIcon",
2221
+ "name": "setSoftDisabled",
2354
2222
  "privacy": "private",
2355
- "return": {
2356
- "type": {
2357
- "text": ""
2358
- }
2359
- },
2360
2223
  "parameters": [
2361
2224
  {
2362
- "name": "iconName",
2225
+ "name": "element",
2363
2226
  "type": {
2364
- "text": "string"
2227
+ "text": "HTMLElement"
2365
2228
  },
2366
- "description": "the name of the icon from the icon set"
2229
+ "description": "The button element."
2367
2230
  },
2368
2231
  {
2369
- "name": "backgroundClassPostfix",
2232
+ "name": "softDisabled",
2233
+ "optional": true,
2370
2234
  "type": {
2371
- "text": "string"
2235
+ "text": "boolean"
2372
2236
  },
2373
- "description": "postfix for the class to style the badge icon."
2237
+ "description": "The soft-disabled state."
2374
2238
  }
2375
2239
  ],
2376
- "description": "Method to generate the badge icon."
2240
+ "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.",
2241
+ "inheritedFrom": {
2242
+ "name": "Buttonsimple",
2243
+ "module": "components/buttonsimple/buttonsimple.component.js"
2244
+ }
2377
2245
  },
2378
2246
  {
2379
2247
  "kind": "method",
2380
- "name": "getBadgeDot",
2248
+ "name": "setDisabled",
2381
2249
  "privacy": "private",
2382
- "return": {
2383
- "type": {
2384
- "text": ""
2250
+ "parameters": [
2251
+ {
2252
+ "name": "element",
2253
+ "type": {
2254
+ "text": "HTMLElement"
2255
+ },
2256
+ "description": "The button element."
2257
+ },
2258
+ {
2259
+ "name": "disabled",
2260
+ "type": {
2261
+ "text": "boolean"
2262
+ },
2263
+ "description": "The disabled state."
2385
2264
  }
2386
- },
2387
- "description": "Method to generate the badge dot template."
2265
+ ],
2266
+ "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.",
2267
+ "inheritedFrom": {
2268
+ "name": "Buttonsimple",
2269
+ "module": "components/buttonsimple/buttonsimple.component.js"
2270
+ }
2388
2271
  },
2389
2272
  {
2390
2273
  "kind": "method",
2391
- "name": "getBadgeCounterText",
2274
+ "name": "triggerClickEvent",
2392
2275
  "privacy": "private",
2393
- "return": {
2394
- "type": {
2395
- "text": ""
2396
- }
2397
- },
2398
- "description": "Method to generate the badge text and counter template."
2276
+ "inheritedFrom": {
2277
+ "name": "Buttonsimple",
2278
+ "module": "components/buttonsimple/buttonsimple.component.js"
2279
+ }
2399
2280
  },
2400
2281
  {
2401
2282
  "kind": "method",
2402
- "name": "setRoleByAriaLabel",
2283
+ "name": "handleBlur",
2403
2284
  "privacy": "private",
2404
- "return": {
2405
- "type": {
2406
- "text": "void"
2407
- }
2408
- },
2409
- "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."
2285
+ "description": "In case the button is pressed and the focus is lost while pressing,\nthe pressed class is removed.",
2286
+ "inheritedFrom": {
2287
+ "name": "Buttonsimple",
2288
+ "module": "components/buttonsimple/buttonsimple.component.js"
2289
+ }
2410
2290
  },
2411
2291
  {
2412
2292
  "kind": "method",
2413
- "name": "getBadgeContentBasedOnType",
2293
+ "name": "handleKeyDown",
2414
2294
  "privacy": "private",
2415
- "return": {
2416
- "type": {
2417
- "text": ""
2295
+ "parameters": [
2296
+ {
2297
+ "name": "event",
2298
+ "type": {
2299
+ "text": "KeyboardEvent"
2300
+ },
2301
+ "description": "The keyboard event."
2418
2302
  }
2419
- },
2420
- "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."
2303
+ ],
2304
+ "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.",
2305
+ "inheritedFrom": {
2306
+ "name": "Buttonsimple",
2307
+ "module": "components/buttonsimple/buttonsimple.component.js"
2308
+ }
2421
2309
  },
2422
2310
  {
2423
- "kind": "field",
2424
- "name": "iconName",
2425
- "type": {
2426
- "text": "IconNames | undefined"
2427
- },
2428
- "description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
2429
- "attribute": "icon-name",
2311
+ "kind": "method",
2312
+ "name": "handleKeyUp",
2313
+ "privacy": "private",
2314
+ "parameters": [
2315
+ {
2316
+ "name": "event",
2317
+ "type": {
2318
+ "text": "KeyboardEvent"
2319
+ },
2320
+ "description": "The keyboard event."
2321
+ }
2322
+ ],
2323
+ "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.",
2430
2324
  "inheritedFrom": {
2431
- "name": "IconNameMixin",
2432
- "module": "utils/mixins/IconNameMixin.js"
2325
+ "name": "Buttonsimple",
2326
+ "module": "components/buttonsimple/buttonsimple.component.js"
2433
2327
  }
2434
2328
  }
2435
2329
  ],
2436
2330
  "attributes": [
2437
2331
  {
2438
- "name": "type",
2332
+ "name": "prefix-icon",
2439
2333
  "type": {
2440
- "text": "BadgeType | undefined"
2334
+ "text": "IconNames | undefined"
2441
2335
  },
2442
- "description": "Type of the badge\nCan be `dot` (notification) , `icon`, `counter`, `success`, `warning` or `error`.",
2443
- "fieldName": "type"
2336
+ "description": "The name of the icon to display as a prefix.\nThe icon is displayed on the left side of the button.",
2337
+ "fieldName": "prefixIcon"
2338
+ },
2339
+ {
2340
+ "name": "postfix-icon",
2341
+ "type": {
2342
+ "text": "IconNames | undefined"
2343
+ },
2344
+ "description": "The name of the icon to display as a postfix.\nThe icon is displayed on the right side of the button.",
2345
+ "fieldName": "postfixIcon"
2444
2346
  },
2445
2347
  {
2446
2348
  "name": "variant",
2447
2349
  "type": {
2448
- "text": "IconVariant"
2350
+ "text": "ButtonVariant"
2449
2351
  },
2450
- "description": "Type of the variant can be `primary` or `secondary`.\nIt defines the background and foreground color of the icon.",
2352
+ "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.",
2451
2353
  "default": "primary",
2452
2354
  "fieldName": "variant"
2453
2355
  },
2454
2356
  {
2455
- "name": "counter",
2357
+ "name": "size",
2456
2358
  "type": {
2457
- "text": "number | undefined"
2359
+ "text": "ButtonSize"
2458
2360
  },
2459
- "description": "Counter is the number which can be provided in the badge.",
2460
- "fieldName": "counter"
2361
+ "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.",
2362
+ "default": "32",
2363
+ "fieldName": "size",
2364
+ "inheritedFrom": {
2365
+ "name": "Buttonsimple",
2366
+ "module": "src/components/buttonsimple/buttonsimple.component.ts"
2367
+ }
2461
2368
  },
2462
2369
  {
2463
- "name": "max-counter",
2370
+ "name": "color",
2371
+ "type": {
2372
+ "text": "ButtonColor"
2373
+ },
2374
+ "description": "There are 5 colors for button: positive, negative, accent, promotional, default.",
2375
+ "default": "default",
2376
+ "fieldName": "color"
2377
+ },
2378
+ {
2379
+ "name": "role",
2380
+ "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.",
2381
+ "default": "'button'",
2382
+ "fieldName": "role",
2383
+ "type": {
2384
+ "text": "string"
2385
+ },
2386
+ "inheritedFrom": {
2387
+ "name": "Buttonsimple",
2388
+ "module": "src/components/buttonsimple/buttonsimple.component.ts"
2389
+ }
2390
+ },
2391
+ {
2392
+ "name": "tabIndex",
2464
2393
  "type": {
2465
2394
  "text": "number"
2466
2395
  },
2467
- "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`.",
2468
- "default": "99",
2469
- "fieldName": "maxCounter"
2396
+ "default": "0",
2397
+ "description": "This property specifies the tab order of the element.",
2398
+ "fieldName": "tabIndex",
2399
+ "inheritedFrom": {
2400
+ "name": "TabIndexMixin",
2401
+ "module": "src/utils/mixins/TabIndexMixin.ts"
2402
+ }
2403
+ },
2404
+ {
2405
+ "name": "disabled",
2406
+ "type": {
2407
+ "text": "boolean | undefined"
2408
+ },
2409
+ "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
2410
+ "default": "undefined",
2411
+ "fieldName": "disabled",
2412
+ "inheritedFrom": {
2413
+ "name": "DisabledMixin",
2414
+ "module": "src/utils/mixins/DisabledMixin.ts"
2415
+ }
2416
+ },
2417
+ {
2418
+ "name": "active",
2419
+ "type": {
2420
+ "text": "boolean | undefined"
2421
+ },
2422
+ "description": "The button's active state indicates whether it is currently toggled on (active) or off (inactive).\nWhen the active state is true, the button is considered to be in an active state, meaning it is toggled on.\nConversely, when the active state is false, the button is in an inactive state, indicating it is toggled off.\n\nThis attribute is used to set the provided `ariaStateKey` to true or false.",
2423
+ "default": "undefined",
2424
+ "fieldName": "active",
2425
+ "inheritedFrom": {
2426
+ "name": "Buttonsimple",
2427
+ "module": "src/components/buttonsimple/buttonsimple.component.ts"
2428
+ }
2470
2429
  },
2471
2430
  {
2472
- "name": "overlay",
2431
+ "name": "soft-disabled",
2473
2432
  "type": {
2474
- "text": "boolean"
2433
+ "text": "boolean | undefined"
2475
2434
  },
2476
- "default": "false",
2477
- "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.",
2478
- "fieldName": "overlay"
2435
+ "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.",
2436
+ "default": "undefined",
2437
+ "fieldName": "softDisabled",
2438
+ "inheritedFrom": {
2439
+ "name": "Buttonsimple",
2440
+ "module": "src/components/buttonsimple/buttonsimple.component.ts"
2441
+ }
2479
2442
  },
2480
2443
  {
2481
- "name": "aria-label",
2444
+ "name": "ariaStateKey",
2482
2445
  "type": {
2483
- "text": "string | null"
2446
+ "text": "string | undefined"
2484
2447
  },
2485
- "default": "null",
2486
- "description": "Aria-label attribute to be set for accessibility",
2487
- "fieldName": "ariaLabel"
2448
+ "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`",
2449
+ "default": "'aria-pressed' (when)",
2450
+ "fieldName": "ariaStateKey",
2451
+ "inheritedFrom": {
2452
+ "name": "Buttonsimple",
2453
+ "module": "src/components/buttonsimple/buttonsimple.component.ts"
2454
+ }
2488
2455
  },
2489
2456
  {
2490
- "name": "icon-name",
2457
+ "name": "type",
2491
2458
  "type": {
2492
- "text": "IconNames | undefined"
2459
+ "text": "ButtonType"
2493
2460
  },
2494
- "description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
2495
- "fieldName": "iconName",
2461
+ "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.",
2462
+ "default": "button",
2463
+ "fieldName": "type",
2496
2464
  "inheritedFrom": {
2497
- "name": "IconNameMixin",
2498
- "module": "src/utils/mixins/IconNameMixin.ts"
2465
+ "name": "Buttonsimple",
2466
+ "module": "src/components/buttonsimple/buttonsimple.component.ts"
2499
2467
  }
2500
2468
  }
2501
2469
  ],
2502
- "mixins": [
2503
- {
2504
- "name": "IconNameMixin",
2505
- "module": "/src/utils/mixins/IconNameMixin"
2506
- }
2507
- ],
2508
2470
  "superclass": {
2509
- "name": "Component",
2510
- "module": "/src/models"
2471
+ "name": "Buttonsimple",
2472
+ "module": "/src/components/buttonsimple/buttonsimple.component"
2511
2473
  },
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
2474
+ "tagName": "mdc-button",
2475
+ "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 */",
2476
+ "customElement": true,
2477
+ "events": [
2478
+ {
2479
+ "description": "(React: onClick) This event is dispatched when the button is clicked.",
2480
+ "name": "click",
2481
+ "reactName": "onClick",
2482
+ "inheritedFrom": {
2483
+ "name": "Buttonsimple",
2484
+ "module": "src/components/buttonsimple/buttonsimple.component.ts"
2485
+ }
2486
+ },
2487
+ {
2488
+ "description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the button.",
2489
+ "name": "keydown",
2490
+ "reactName": "onKeyDown",
2491
+ "inheritedFrom": {
2492
+ "name": "Buttonsimple",
2493
+ "module": "src/components/buttonsimple/buttonsimple.component.ts"
2494
+ }
2495
+ },
2496
+ {
2497
+ "description": "(React: onKeyUp) This event is dispatched when a key is released on the button.",
2498
+ "name": "keyup",
2499
+ "reactName": "onKeyUp",
2500
+ "inheritedFrom": {
2501
+ "name": "Buttonsimple",
2502
+ "module": "src/components/buttonsimple/buttonsimple.component.ts"
2503
+ }
2504
+ },
2505
+ {
2506
+ "description": "(React: onFocus) This event is dispatched when the button receives focus.",
2507
+ "name": "focus",
2508
+ "reactName": "onFocus",
2509
+ "inheritedFrom": {
2510
+ "name": "Buttonsimple",
2511
+ "module": "src/components/buttonsimple/buttonsimple.component.ts"
2512
+ }
2513
+ }
2514
+ ]
2515
2515
  }
2516
2516
  ],
2517
2517
  "exports": [
@@ -2519,8 +2519,8 @@
2519
2519
  "kind": "js",
2520
2520
  "name": "default",
2521
2521
  "declaration": {
2522
- "name": "Badge",
2523
- "module": "components/badge/badge.component.js"
2522
+ "name": "Button",
2523
+ "module": "components/button/button.component.js"
2524
2524
  }
2525
2525
  }
2526
2526
  ]
@@ -17035,6 +17035,180 @@
17035
17035
  }
17036
17036
  ]
17037
17037
  },
17038
+ {
17039
+ "kind": "javascript-module",
17040
+ "path": "components/statictoggle/statictoggle.component.js",
17041
+ "declarations": [
17042
+ {
17043
+ "kind": "class",
17044
+ "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.",
17045
+ "name": "StaticToggle",
17046
+ "cssProperties": [
17047
+ {
17048
+ "description": "Width of the toggle",
17049
+ "name": "--mdc-statictoggle-width"
17050
+ },
17051
+ {
17052
+ "description": "Height of the toggle",
17053
+ "name": "--mdc-statictoggle-height"
17054
+ },
17055
+ {
17056
+ "description": "Width of the toggle when it's size is compact",
17057
+ "name": "--mdc-statictoggle-width-compact"
17058
+ },
17059
+ {
17060
+ "description": "Height of the toggle when it's size is compact",
17061
+ "name": "--mdc-statictoggle-height-compact"
17062
+ },
17063
+ {
17064
+ "description": "Border radius of the toggle",
17065
+ "name": "--mdc-statictoggle-border-radius"
17066
+ },
17067
+ {
17068
+ "description": "Border radius of the toggle when it's size is compact",
17069
+ "name": "--mdc-statictoggle-border-radius-compact"
17070
+ },
17071
+ {
17072
+ "description": "Border of the toggle",
17073
+ "name": "--mdc-statictoggle-border"
17074
+ },
17075
+ {
17076
+ "description": "Background color of the inactive toggle in rest state",
17077
+ "name": "--mdc-statictoggle-inactive-rest-color"
17078
+ },
17079
+ {
17080
+ "description": "Background color of the inactive toggle in disabled state",
17081
+ "name": "--mdc-statictoggle-inactive-disabled-color"
17082
+ },
17083
+ {
17084
+ "description": "Background color of the active toggle in rest state",
17085
+ "name": "--mdc-statictoggle-active-rest-color"
17086
+ },
17087
+ {
17088
+ "description": "Background color of the active toggle in disabled state",
17089
+ "name": "--mdc-statictoggle-active-disabled-color"
17090
+ },
17091
+ {
17092
+ "description": "Color of the icon in normal state",
17093
+ "name": "--mdc-statictoggle-icon-color-normal"
17094
+ },
17095
+ {
17096
+ "description": "Color of the icon in disabled state",
17097
+ "name": "--mdc-statictoggle-icon-color-disabled"
17098
+ },
17099
+ {
17100
+ "description": "Background color of the icon in normal state",
17101
+ "name": "--mdc-statictoggle-icon-background-color-normal"
17102
+ },
17103
+ {
17104
+ "description": "Background color of the icon in disabled state",
17105
+ "name": "--mdc-statictoggle-icon-background-color-disabled"
17106
+ }
17107
+ ],
17108
+ "slots": [
17109
+ {
17110
+ "description": "This is a default/unnamed slot",
17111
+ "name": "default"
17112
+ }
17113
+ ],
17114
+ "members": [
17115
+ {
17116
+ "kind": "field",
17117
+ "name": "checked",
17118
+ "type": {
17119
+ "text": "boolean"
17120
+ },
17121
+ "default": "false",
17122
+ "description": "Determines whether the toggle is active or inactive.",
17123
+ "attribute": "checked",
17124
+ "reflects": true
17125
+ },
17126
+ {
17127
+ "kind": "field",
17128
+ "name": "size",
17129
+ "type": {
17130
+ "text": "ToggleSize"
17131
+ },
17132
+ "description": "Determines toggle size in rem (height is specified here).\n- **Default**: 1.5\n- **Compact**: 1",
17133
+ "default": "default",
17134
+ "attribute": "size",
17135
+ "reflects": true
17136
+ },
17137
+ {
17138
+ "kind": "field",
17139
+ "name": "disabled",
17140
+ "type": {
17141
+ "text": "boolean | undefined"
17142
+ },
17143
+ "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
17144
+ "default": "undefined",
17145
+ "attribute": "disabled",
17146
+ "reflects": true,
17147
+ "inheritedFrom": {
17148
+ "name": "DisabledMixin",
17149
+ "module": "utils/mixins/DisabledMixin.js"
17150
+ }
17151
+ }
17152
+ ],
17153
+ "attributes": [
17154
+ {
17155
+ "name": "checked",
17156
+ "type": {
17157
+ "text": "boolean"
17158
+ },
17159
+ "default": "false",
17160
+ "description": "Determines whether the toggle is active or inactive.",
17161
+ "fieldName": "checked"
17162
+ },
17163
+ {
17164
+ "name": "size",
17165
+ "type": {
17166
+ "text": "ToggleSize"
17167
+ },
17168
+ "description": "Determines toggle size in rem (height is specified here).\n- **Default**: 1.5\n- **Compact**: 1",
17169
+ "default": "default",
17170
+ "fieldName": "size"
17171
+ },
17172
+ {
17173
+ "name": "disabled",
17174
+ "type": {
17175
+ "text": "boolean | undefined"
17176
+ },
17177
+ "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
17178
+ "default": "undefined",
17179
+ "fieldName": "disabled",
17180
+ "inheritedFrom": {
17181
+ "name": "DisabledMixin",
17182
+ "module": "src/utils/mixins/DisabledMixin.ts"
17183
+ }
17184
+ }
17185
+ ],
17186
+ "mixins": [
17187
+ {
17188
+ "name": "DisabledMixin",
17189
+ "module": "/src/utils/mixins/DisabledMixin"
17190
+ }
17191
+ ],
17192
+ "superclass": {
17193
+ "name": "Component",
17194
+ "module": "/src/models"
17195
+ },
17196
+ "tagName": "mdc-statictoggle",
17197
+ "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 */",
17198
+ "customElement": true
17199
+ }
17200
+ ],
17201
+ "exports": [
17202
+ {
17203
+ "kind": "js",
17204
+ "name": "default",
17205
+ "declaration": {
17206
+ "name": "StaticToggle",
17207
+ "module": "components/statictoggle/statictoggle.component.js"
17208
+ }
17209
+ }
17210
+ ]
17211
+ },
17038
17212
  {
17039
17213
  "kind": "javascript-module",
17040
17214
  "path": "components/tab/tab.component.js",
@@ -18989,72 +19163,56 @@
18989
19163
  "name": "Toggle",
18990
19164
  "cssProperties": [
18991
19165
  {
18992
- "description": "width of the toggle",
19166
+ "description": "Width of the toggle",
18993
19167
  "name": "--mdc-toggle-width"
18994
19168
  },
18995
19169
  {
18996
- "description": "height of the toggle",
19170
+ "description": "Height of the toggle",
18997
19171
  "name": "--mdc-toggle-height"
18998
19172
  },
18999
19173
  {
19000
- "description": "width of the toggle when it's size is compact",
19174
+ "description": "Width of the toggle when it's size is compact",
19001
19175
  "name": "--mdc-toggle-width-compact"
19002
19176
  },
19003
19177
  {
19004
- "description": "height of the toggle when it's size is compact",
19178
+ "description": "Height of the toggle when it's size is compact",
19005
19179
  "name": "--mdc-toggle-height-compact"
19006
19180
  },
19007
19181
  {
19008
- "description": "border radius of the toggle",
19009
- "name": "--mdc-toggle-border-radius"
19182
+ "description": "Line height of the toggle label",
19183
+ "name": "--mdc-toggle-label-lineheight"
19010
19184
  },
19011
19185
  {
19012
- "description": "border radius of the toggle when it's size is compact",
19013
- "name": "--mdc-toggle-border-radius-compact"
19186
+ "description": "Font size of the toggle label",
19187
+ "name": "--mdc-toggle-label-fontsize"
19014
19188
  },
19015
19189
  {
19016
- "description": "border of the toggle",
19017
- "name": "--mdc-toggle-border"
19190
+ "description": "Font weight of the toggle label",
19191
+ "name": "--mdc-toggle-label-fontweight"
19018
19192
  },
19019
19193
  {
19020
- "description": "background color of the inactive toggle in rest state",
19021
- "name": "--mdc-toggle-inactive-rest-color"
19022
- },
19023
- {
19024
- "description": "background color of the inactive toggle in hover state",
19025
- "name": "--mdc-toggle-inactive-hover-color"
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"
19194
+ "description": "Color of the toggle label and help text in disabled state",
19195
+ "name": "--mdc-toggle-label-color-disabled"
19034
19196
  },
19035
19197
  {
19036
- "description": "background color of the active toggle in rest state",
19037
- "name": "--mdc-toggle-active-rest-color"
19198
+ "description": "Color of the help text label",
19199
+ "name": "--mdc-toggle-help-text-color"
19038
19200
  },
19039
19201
  {
19040
- "description": "background color of the active toggle in hover state",
19202
+ "description": "Background color of the active toggle in hover state",
19041
19203
  "name": "--mdc-toggle-active-hover-color"
19042
19204
  },
19043
19205
  {
19044
- "description": "background color of the active toggle in pressed state",
19206
+ "description": "Background color of the active toggle in pressed state",
19045
19207
  "name": "--mdc-toggle-active-pressed-color"
19046
19208
  },
19047
19209
  {
19048
- "description": "background color of the active toggle in disabled state",
19049
- "name": "--mdc-toggle-active-disabled-color"
19050
- },
19051
- {
19052
- "description": " color of the help text label",
19053
- "name": "--mdc-toggle-help-text-color"
19210
+ "description": "Background color of the inactive toggle in hover state",
19211
+ "name": "--mdc-toggle-inactive-hover-color"
19054
19212
  },
19055
19213
  {
19056
- "description": "color of the toggle label and help text in disabled state",
19057
- "name": "--mdc-toggle-label-color-disabled"
19214
+ "description": "Background color of the inactive toggle in pressed state",
19215
+ "name": "--mdc-toggle-inactive-pressed-color"
19058
19216
  }
19059
19217
  ],
19060
19218
  "members": [
@@ -19634,7 +19792,7 @@
19634
19792
  "module": "/src/components/formfieldwrapper"
19635
19793
  },
19636
19794
  "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 - width of the toggle\n * @cssproperty --mdc-toggle-height - height of the toggle\n * @cssproperty --mdc-toggle-width-compact - width of the toggle when it's size is compact\n * @cssproperty --mdc-toggle-height-compact - height of the toggle when it's size is compact\n * @cssproperty --mdc-toggle-border-radius - border radius of the toggle\n * @cssproperty --mdc-toggle-border-radius-compact - border radius of the toggle when it's size is compact\n * @cssproperty --mdc-toggle-border - border of the toggle\n * @cssproperty --mdc-toggle-inactive-rest-color - background color of the inactive toggle in rest state\n * @cssproperty --mdc-toggle-inactive-hover-color - background color of the inactive toggle in hover state\n * @cssproperty --mdc-toggle-inactive-pressed-color - background color of the inactive toggle in pressed state\n * @cssproperty --mdc-toggle-inactive-disabled-color - background color of the inactive toggle in disabled state\n * @cssproperty --mdc-toggle-active-rest-color - background color of the active toggle in rest state\n * @cssproperty --mdc-toggle-active-hover-color - background color of the active toggle in hover state\n * @cssproperty --mdc-toggle-active-pressed-color - background color of the active toggle in pressed state\n * @cssproperty --mdc-toggle-active-disabled-color - background color of the active toggle in disabled state\n * @cssproperty --mdc-toggle-help-text-color - color of the help text label\n * @cssproperty --mdc-toggle-label-color-disabled - color of the toggle label and help text in disabled state\n *\n */",
19795
+ "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
19796
  "customElement": true,
19639
19797
  "slots": [
19640
19798
  {