@momentum-design/components 0.76.5 → 0.76.7
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 +66 -66
- package/dist/browser/index.js.map +3 -3
- package/dist/components/formfieldgroup/formfieldgroup.component.js +0 -1
- package/dist/components/formfieldgroup/index.d.ts +1 -0
- package/dist/components/formfieldgroup/index.js +1 -0
- package/dist/components/listitem/listitem.component.js +4 -0
- package/dist/custom-elements.json +1318 -1318
- package/dist/react/index.d.ts +1 -1
- package/dist/react/index.js +1 -1
- package/package.json +1 -1
@@ -1653,1900 +1653,1900 @@
|
|
1653
1653
|
},
|
1654
1654
|
{
|
1655
1655
|
"kind": "javascript-module",
|
1656
|
-
"path": "components/
|
1656
|
+
"path": "components/brandvisual/brandvisual.component.js",
|
1657
1657
|
"declarations": [
|
1658
1658
|
{
|
1659
1659
|
"kind": "class",
|
1660
|
-
"description": "The `mdc-
|
1661
|
-
"name": "
|
1662
|
-
"
|
1660
|
+
"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.",
|
1661
|
+
"name": "Brandvisual",
|
1662
|
+
"members": [
|
1663
1663
|
{
|
1664
|
-
"
|
1665
|
-
"name": "
|
1664
|
+
"kind": "field",
|
1665
|
+
"name": "brandVisualData",
|
1666
|
+
"type": {
|
1667
|
+
"text": "HTMLElement | undefined"
|
1668
|
+
},
|
1669
|
+
"privacy": "private"
|
1666
1670
|
},
|
1667
1671
|
{
|
1668
|
-
"
|
1669
|
-
"name": "
|
1672
|
+
"kind": "field",
|
1673
|
+
"name": "name",
|
1674
|
+
"type": {
|
1675
|
+
"text": "BrandVisualNames | undefined"
|
1676
|
+
},
|
1677
|
+
"description": "Name of the brandVisual (= filename)",
|
1678
|
+
"attribute": "name",
|
1679
|
+
"reflects": true
|
1670
1680
|
},
|
1671
1681
|
{
|
1672
|
-
"
|
1673
|
-
"name": "
|
1682
|
+
"kind": "method",
|
1683
|
+
"name": "getBrandVisualData",
|
1684
|
+
"privacy": "private"
|
1674
1685
|
},
|
1675
1686
|
{
|
1676
|
-
"
|
1677
|
-
"name": "
|
1687
|
+
"kind": "method",
|
1688
|
+
"name": "handleBrandVisualLoadedSuccess",
|
1689
|
+
"privacy": "private",
|
1690
|
+
"parameters": [
|
1691
|
+
{
|
1692
|
+
"name": "brandVisualHtml",
|
1693
|
+
"type": {
|
1694
|
+
"text": "HTMLElement"
|
1695
|
+
},
|
1696
|
+
"description": "The brandvisual html element which has been fetched from the brandvisual provider."
|
1697
|
+
}
|
1698
|
+
],
|
1699
|
+
"description": "Sets the brandVisualData state to the fetched brandvisual.\nDispatches a 'load' event on the component once the brandvisual has been successfully loaded."
|
1678
1700
|
},
|
1679
1701
|
{
|
1680
|
-
"
|
1681
|
-
"name": "
|
1682
|
-
|
1702
|
+
"kind": "method",
|
1703
|
+
"name": "handleBrandVisualLoadedFailure",
|
1704
|
+
"privacy": "private",
|
1705
|
+
"parameters": [
|
1706
|
+
{
|
1707
|
+
"name": "error",
|
1708
|
+
"type": {
|
1709
|
+
"text": "unknown"
|
1710
|
+
}
|
1711
|
+
}
|
1712
|
+
],
|
1713
|
+
"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."
|
1714
|
+
}
|
1715
|
+
],
|
1716
|
+
"events": [
|
1683
1717
|
{
|
1684
|
-
"description": "
|
1685
|
-
"name": "
|
1718
|
+
"description": "(React: onLoad) This event is dispatched when the brandvisual has been successfully loaded.",
|
1719
|
+
"name": "load",
|
1720
|
+
"reactName": "onLoad"
|
1686
1721
|
},
|
1687
1722
|
{
|
1688
|
-
"description": "
|
1689
|
-
"name": "
|
1690
|
-
|
1723
|
+
"description": "(React: onError) This event is dispatched when the brandvisual fetching has failed.",
|
1724
|
+
"name": "error",
|
1725
|
+
"reactName": "onError"
|
1726
|
+
}
|
1727
|
+
],
|
1728
|
+
"attributes": [
|
1691
1729
|
{
|
1692
|
-
"
|
1693
|
-
"
|
1730
|
+
"name": "name",
|
1731
|
+
"type": {
|
1732
|
+
"text": "BrandVisualNames | undefined"
|
1733
|
+
},
|
1734
|
+
"description": "Name of the brandVisual (= filename)",
|
1735
|
+
"fieldName": "name"
|
1736
|
+
}
|
1737
|
+
],
|
1738
|
+
"superclass": {
|
1739
|
+
"name": "Component",
|
1740
|
+
"module": "/src/models"
|
1741
|
+
},
|
1742
|
+
"tagName": "mdc-brandvisual",
|
1743
|
+
"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 */",
|
1744
|
+
"customElement": true
|
1745
|
+
}
|
1746
|
+
],
|
1747
|
+
"exports": [
|
1748
|
+
{
|
1749
|
+
"kind": "js",
|
1750
|
+
"name": "default",
|
1751
|
+
"declaration": {
|
1752
|
+
"name": "Brandvisual",
|
1753
|
+
"module": "components/brandvisual/brandvisual.component.js"
|
1754
|
+
}
|
1755
|
+
}
|
1756
|
+
]
|
1757
|
+
},
|
1758
|
+
{
|
1759
|
+
"kind": "javascript-module",
|
1760
|
+
"path": "components/bullet/bullet.component.js",
|
1761
|
+
"declarations": [
|
1762
|
+
{
|
1763
|
+
"kind": "class",
|
1764
|
+
"description": "Bullet component, which is a visual marker\nand be used to organize and present items in a list format.",
|
1765
|
+
"name": "Bullet",
|
1766
|
+
"cssProperties": [
|
1767
|
+
{
|
1768
|
+
"description": "background color of the bullet",
|
1769
|
+
"name": "--mdc-bullet-background-color"
|
1694
1770
|
},
|
1695
1771
|
{
|
1696
|
-
"description": "
|
1697
|
-
"name": "--mdc-
|
1772
|
+
"description": "small size value of the bullet",
|
1773
|
+
"name": "--mdc-bullet-size-small"
|
1698
1774
|
},
|
1699
1775
|
{
|
1700
|
-
"description": "
|
1701
|
-
"name": "--mdc-
|
1776
|
+
"description": "medium size value of the bullet",
|
1777
|
+
"name": "--mdc-bullet-size-medium"
|
1702
1778
|
},
|
1703
1779
|
{
|
1704
|
-
"description": "
|
1705
|
-
"name": "--mdc-
|
1780
|
+
"description": "large size value of the bullet",
|
1781
|
+
"name": "--mdc-bullet-size-large"
|
1706
1782
|
}
|
1707
1783
|
],
|
1708
1784
|
"members": [
|
1709
1785
|
{
|
1710
1786
|
"kind": "field",
|
1711
|
-
"name": "
|
1787
|
+
"name": "size",
|
1712
1788
|
"type": {
|
1713
|
-
"text": "
|
1789
|
+
"text": "Size"
|
1714
1790
|
},
|
1715
|
-
"
|
1716
|
-
"
|
1791
|
+
"privacy": "public",
|
1792
|
+
"description": "Size of the bullet\n\nPossible values: 'small', 'medium', 'large'",
|
1793
|
+
"default": "small",
|
1794
|
+
"attribute": "size",
|
1717
1795
|
"reflects": true
|
1718
|
-
}
|
1796
|
+
}
|
1797
|
+
],
|
1798
|
+
"attributes": [
|
1719
1799
|
{
|
1720
|
-
"
|
1721
|
-
"name": "variant",
|
1800
|
+
"name": "size",
|
1722
1801
|
"type": {
|
1723
|
-
"text": "
|
1802
|
+
"text": "Size"
|
1724
1803
|
},
|
1725
|
-
"description": "
|
1726
|
-
"default": "
|
1727
|
-
"
|
1728
|
-
|
1729
|
-
|
1804
|
+
"description": "Size of the bullet\n\nPossible values: 'small', 'medium', 'large'",
|
1805
|
+
"default": "small",
|
1806
|
+
"fieldName": "size"
|
1807
|
+
}
|
1808
|
+
],
|
1809
|
+
"superclass": {
|
1810
|
+
"name": "Component",
|
1811
|
+
"module": "/src/models"
|
1812
|
+
},
|
1813
|
+
"tagName": "mdc-bullet",
|
1814
|
+
"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*/",
|
1815
|
+
"customElement": true
|
1816
|
+
}
|
1817
|
+
],
|
1818
|
+
"exports": [
|
1819
|
+
{
|
1820
|
+
"kind": "js",
|
1821
|
+
"name": "default",
|
1822
|
+
"declaration": {
|
1823
|
+
"name": "Bullet",
|
1824
|
+
"module": "components/bullet/bullet.component.js"
|
1825
|
+
}
|
1826
|
+
}
|
1827
|
+
]
|
1828
|
+
},
|
1829
|
+
{
|
1830
|
+
"kind": "javascript-module",
|
1831
|
+
"path": "components/button/button.component.js",
|
1832
|
+
"declarations": [
|
1833
|
+
{
|
1834
|
+
"kind": "class",
|
1835
|
+
"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.",
|
1836
|
+
"name": "Button",
|
1837
|
+
"slots": [
|
1730
1838
|
{
|
1731
|
-
"
|
1732
|
-
"name": "
|
1733
|
-
|
1734
|
-
|
1735
|
-
|
1736
|
-
"description": "Counter is the number which can be provided in the badge.",
|
1737
|
-
"attribute": "counter"
|
1738
|
-
},
|
1839
|
+
"description": "Text label of the button.",
|
1840
|
+
"name": ""
|
1841
|
+
}
|
1842
|
+
],
|
1843
|
+
"members": [
|
1739
1844
|
{
|
1740
1845
|
"kind": "field",
|
1741
|
-
"name": "
|
1846
|
+
"name": "size",
|
1742
1847
|
"type": {
|
1743
|
-
"text": "
|
1848
|
+
"text": "ButtonSize"
|
1744
1849
|
},
|
1745
|
-
"description": "
|
1746
|
-
"default": "
|
1747
|
-
"attribute": "
|
1748
|
-
"reflects": true
|
1850
|
+
"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.",
|
1851
|
+
"default": "32",
|
1852
|
+
"attribute": "size",
|
1853
|
+
"reflects": true,
|
1854
|
+
"inheritedFrom": {
|
1855
|
+
"name": "Buttonsimple",
|
1856
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
1857
|
+
}
|
1749
1858
|
},
|
1750
1859
|
{
|
1751
1860
|
"kind": "field",
|
1752
|
-
"name": "
|
1861
|
+
"name": "inverted",
|
1753
1862
|
"type": {
|
1754
1863
|
"text": "boolean"
|
1755
1864
|
},
|
1865
|
+
"description": "The button color can be inverted by setting the inverted attribute to true.\n\nOnly applies when variant is set to `primary`, color is set to `default`\nand button is not `active`.",
|
1756
1866
|
"default": "false",
|
1757
|
-
"
|
1758
|
-
"
|
1867
|
+
"attribute": "inverted",
|
1868
|
+
"reflects": true
|
1759
1869
|
},
|
1760
1870
|
{
|
1761
1871
|
"kind": "field",
|
1762
|
-
"name": "
|
1872
|
+
"name": "role",
|
1873
|
+
"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.",
|
1874
|
+
"default": "'button'",
|
1875
|
+
"attribute": "role",
|
1876
|
+
"reflects": true,
|
1763
1877
|
"type": {
|
1764
|
-
"text": "string
|
1878
|
+
"text": "string"
|
1765
1879
|
},
|
1766
|
-
"
|
1767
|
-
|
1768
|
-
|
1880
|
+
"inheritedFrom": {
|
1881
|
+
"name": "Buttonsimple",
|
1882
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
1883
|
+
}
|
1769
1884
|
},
|
1770
1885
|
{
|
1771
1886
|
"kind": "method",
|
1772
|
-
"name": "
|
1887
|
+
"name": "inferFilledIconName",
|
1773
1888
|
"privacy": "private",
|
1774
|
-
"return": {
|
1775
|
-
"type": {
|
1776
|
-
"text": ""
|
1777
|
-
}
|
1778
|
-
},
|
1779
1889
|
"parameters": [
|
1780
1890
|
{
|
1781
|
-
"name": "
|
1891
|
+
"name": "active",
|
1892
|
+
"optional": true,
|
1782
1893
|
"type": {
|
1783
|
-
"text": "
|
1894
|
+
"text": "boolean"
|
1784
1895
|
},
|
1785
|
-
"description": "
|
1786
|
-
},
|
1787
|
-
{
|
1788
|
-
"name": "counter",
|
1789
|
-
"optional": true,
|
1790
|
-
"type": {
|
1791
|
-
"text": "number"
|
1792
|
-
},
|
1793
|
-
"description": "the number to be displayed on the badge"
|
1896
|
+
"description": "The active state."
|
1794
1897
|
}
|
1795
1898
|
],
|
1796
|
-
"description": "
|
1899
|
+
"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."
|
1797
1900
|
},
|
1798
1901
|
{
|
1799
|
-
"kind": "
|
1800
|
-
"name": "
|
1801
|
-
"
|
1802
|
-
|
1803
|
-
|
1804
|
-
|
1805
|
-
|
1902
|
+
"kind": "field",
|
1903
|
+
"name": "prefixIcon",
|
1904
|
+
"type": {
|
1905
|
+
"text": "IconNames | undefined"
|
1906
|
+
},
|
1907
|
+
"description": "The name of the icon to display as a prefix.\nThe icon is displayed on the left side of the button.",
|
1908
|
+
"attribute": "prefix-icon",
|
1909
|
+
"reflects": true,
|
1910
|
+
"inheritedFrom": {
|
1911
|
+
"name": "ButtonComponentMixin",
|
1912
|
+
"module": "utils/mixins/ButtonComponentMixin.js"
|
1913
|
+
}
|
1914
|
+
},
|
1915
|
+
{
|
1916
|
+
"kind": "field",
|
1917
|
+
"name": "postfixIcon",
|
1918
|
+
"type": {
|
1919
|
+
"text": "IconNames | undefined"
|
1920
|
+
},
|
1921
|
+
"description": "The name of the icon to display as a postfix.\nThe icon is displayed on the right side of the button.",
|
1922
|
+
"attribute": "postfix-icon",
|
1923
|
+
"reflects": true,
|
1924
|
+
"inheritedFrom": {
|
1925
|
+
"name": "ButtonComponentMixin",
|
1926
|
+
"module": "utils/mixins/ButtonComponentMixin.js"
|
1927
|
+
}
|
1928
|
+
},
|
1929
|
+
{
|
1930
|
+
"kind": "field",
|
1931
|
+
"name": "variant",
|
1932
|
+
"type": {
|
1933
|
+
"text": "ButtonVariant"
|
1806
1934
|
},
|
1935
|
+
"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.",
|
1936
|
+
"default": "primary",
|
1937
|
+
"attribute": "variant",
|
1938
|
+
"inheritedFrom": {
|
1939
|
+
"name": "ButtonComponentMixin",
|
1940
|
+
"module": "utils/mixins/ButtonComponentMixin.js"
|
1941
|
+
}
|
1942
|
+
},
|
1943
|
+
{
|
1944
|
+
"kind": "field",
|
1945
|
+
"name": "color",
|
1946
|
+
"type": {
|
1947
|
+
"text": "ButtonColor"
|
1948
|
+
},
|
1949
|
+
"description": "There are 5 colors for button: positive, negative, accent, promotional, default.",
|
1950
|
+
"default": "default",
|
1951
|
+
"attribute": "color",
|
1952
|
+
"inheritedFrom": {
|
1953
|
+
"name": "ButtonComponentMixin",
|
1954
|
+
"module": "utils/mixins/ButtonComponentMixin.js"
|
1955
|
+
}
|
1956
|
+
},
|
1957
|
+
{
|
1958
|
+
"kind": "method",
|
1959
|
+
"name": "setVariant",
|
1960
|
+
"privacy": "protected",
|
1807
1961
|
"parameters": [
|
1808
1962
|
{
|
1809
|
-
"name": "
|
1810
|
-
"type": {
|
1811
|
-
"text": "string"
|
1812
|
-
},
|
1813
|
-
"description": "the name of the icon from the icon set"
|
1814
|
-
},
|
1815
|
-
{
|
1816
|
-
"name": "backgroundClassPostfix",
|
1963
|
+
"name": "variant",
|
1817
1964
|
"type": {
|
1818
|
-
"text": "
|
1965
|
+
"text": "ButtonVariant"
|
1819
1966
|
},
|
1820
|
-
"description": "
|
1967
|
+
"description": "The variant to set."
|
1821
1968
|
}
|
1822
1969
|
],
|
1823
|
-
"description": "
|
1970
|
+
"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.",
|
1971
|
+
"inheritedFrom": {
|
1972
|
+
"name": "ButtonComponentMixin",
|
1973
|
+
"module": "utils/mixins/ButtonComponentMixin.js"
|
1974
|
+
}
|
1824
1975
|
},
|
1825
1976
|
{
|
1826
1977
|
"kind": "method",
|
1827
|
-
"name": "
|
1828
|
-
"privacy": "
|
1829
|
-
"
|
1830
|
-
|
1831
|
-
"
|
1978
|
+
"name": "setColor",
|
1979
|
+
"privacy": "protected",
|
1980
|
+
"parameters": [
|
1981
|
+
{
|
1982
|
+
"name": "color",
|
1983
|
+
"type": {
|
1984
|
+
"text": "ButtonColor"
|
1985
|
+
},
|
1986
|
+
"description": "The color to set."
|
1832
1987
|
}
|
1833
|
-
|
1834
|
-
"description": "
|
1988
|
+
],
|
1989
|
+
"description": "Sets the color attribute for the button.\nDefaults to DEFAULTS.COLOR if invalid or for tertiary button.",
|
1990
|
+
"inheritedFrom": {
|
1991
|
+
"name": "ButtonComponentMixin",
|
1992
|
+
"module": "utils/mixins/ButtonComponentMixin.js"
|
1993
|
+
}
|
1835
1994
|
},
|
1836
1995
|
{
|
1837
1996
|
"kind": "method",
|
1838
|
-
"name": "
|
1839
|
-
"privacy": "
|
1840
|
-
"
|
1841
|
-
|
1842
|
-
"
|
1997
|
+
"name": "setSize",
|
1998
|
+
"privacy": "protected",
|
1999
|
+
"parameters": [
|
2000
|
+
{
|
2001
|
+
"name": "size",
|
2002
|
+
"type": {
|
2003
|
+
"text": "PillButtonSize | IconButtonSize"
|
2004
|
+
},
|
2005
|
+
"description": "The size to set."
|
1843
2006
|
}
|
1844
|
-
|
1845
|
-
"description": "
|
2007
|
+
],
|
2008
|
+
"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.",
|
2009
|
+
"inheritedFrom": {
|
2010
|
+
"name": "ButtonComponentMixin",
|
2011
|
+
"module": "utils/mixins/ButtonComponentMixin.js"
|
2012
|
+
}
|
1846
2013
|
},
|
1847
2014
|
{
|
1848
2015
|
"kind": "method",
|
1849
|
-
"name": "
|
1850
|
-
"privacy": "
|
1851
|
-
"
|
1852
|
-
|
1853
|
-
|
2016
|
+
"name": "inferButtonType",
|
2017
|
+
"privacy": "protected",
|
2018
|
+
"description": "Infers the type of button based on the presence of slot and/or prefix and postfix icons.",
|
2019
|
+
"parameters": [
|
2020
|
+
{
|
2021
|
+
"description": "default slot of button",
|
2022
|
+
"name": "slot"
|
1854
2023
|
}
|
1855
|
-
|
1856
|
-
"
|
2024
|
+
],
|
2025
|
+
"inheritedFrom": {
|
2026
|
+
"name": "ButtonComponentMixin",
|
2027
|
+
"module": "utils/mixins/ButtonComponentMixin.js"
|
2028
|
+
}
|
1857
2029
|
},
|
1858
2030
|
{
|
1859
|
-
"kind": "
|
1860
|
-
"name": "
|
1861
|
-
"
|
1862
|
-
|
1863
|
-
"type": {
|
1864
|
-
"text": ""
|
1865
|
-
}
|
2031
|
+
"kind": "field",
|
2032
|
+
"name": "tabIndex",
|
2033
|
+
"type": {
|
2034
|
+
"text": "number"
|
1866
2035
|
},
|
1867
|
-
"
|
2036
|
+
"default": "0",
|
2037
|
+
"description": "This property specifies the tab order of the element.",
|
2038
|
+
"attribute": "tabIndex",
|
2039
|
+
"reflects": true,
|
2040
|
+
"inheritedFrom": {
|
2041
|
+
"name": "TabIndexMixin",
|
2042
|
+
"module": "utils/mixins/TabIndexMixin.js"
|
2043
|
+
}
|
1868
2044
|
},
|
1869
2045
|
{
|
1870
2046
|
"kind": "field",
|
1871
|
-
"name": "
|
2047
|
+
"name": "disabled",
|
1872
2048
|
"type": {
|
1873
|
-
"text": "
|
2049
|
+
"text": "boolean | undefined"
|
1874
2050
|
},
|
1875
|
-
"description": "
|
1876
|
-
"
|
2051
|
+
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
2052
|
+
"default": "undefined",
|
2053
|
+
"attribute": "disabled",
|
2054
|
+
"reflects": true,
|
1877
2055
|
"inheritedFrom": {
|
1878
|
-
"name": "
|
1879
|
-
"module": "utils/mixins/
|
2056
|
+
"name": "DisabledMixin",
|
2057
|
+
"module": "utils/mixins/DisabledMixin.js"
|
1880
2058
|
}
|
1881
|
-
}
|
1882
|
-
],
|
1883
|
-
"attributes": [
|
2059
|
+
},
|
1884
2060
|
{
|
1885
|
-
"
|
2061
|
+
"kind": "field",
|
2062
|
+
"name": "active",
|
1886
2063
|
"type": {
|
1887
|
-
"text": "
|
2064
|
+
"text": "boolean | undefined"
|
1888
2065
|
},
|
1889
|
-
"description": "
|
1890
|
-
"
|
2066
|
+
"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.",
|
2067
|
+
"default": "undefined",
|
2068
|
+
"attribute": "active",
|
2069
|
+
"reflects": true,
|
2070
|
+
"inheritedFrom": {
|
2071
|
+
"name": "Buttonsimple",
|
2072
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
2073
|
+
}
|
1891
2074
|
},
|
1892
2075
|
{
|
1893
|
-
"
|
2076
|
+
"kind": "field",
|
2077
|
+
"name": "softDisabled",
|
1894
2078
|
"type": {
|
1895
|
-
"text": "
|
2079
|
+
"text": "boolean | undefined"
|
1896
2080
|
},
|
1897
|
-
"description": "
|
1898
|
-
"default": "
|
1899
|
-
"
|
2081
|
+
"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.",
|
2082
|
+
"default": "undefined",
|
2083
|
+
"attribute": "soft-disabled",
|
2084
|
+
"reflects": true,
|
2085
|
+
"inheritedFrom": {
|
2086
|
+
"name": "Buttonsimple",
|
2087
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
2088
|
+
}
|
1900
2089
|
},
|
1901
2090
|
{
|
1902
|
-
"
|
2091
|
+
"kind": "field",
|
2092
|
+
"name": "ariaStateKey",
|
1903
2093
|
"type": {
|
1904
|
-
"text": "
|
2094
|
+
"text": "string | undefined"
|
1905
2095
|
},
|
1906
|
-
"description": "
|
1907
|
-
"
|
2096
|
+
"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`",
|
2097
|
+
"default": "'aria-pressed' (when)",
|
2098
|
+
"attribute": "ariaStateKey",
|
2099
|
+
"reflects": true,
|
2100
|
+
"inheritedFrom": {
|
2101
|
+
"name": "Buttonsimple",
|
2102
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
2103
|
+
}
|
1908
2104
|
},
|
1909
2105
|
{
|
1910
|
-
"
|
2106
|
+
"kind": "field",
|
2107
|
+
"name": "type",
|
1911
2108
|
"type": {
|
1912
|
-
"text": "
|
2109
|
+
"text": "ButtonType"
|
1913
2110
|
},
|
1914
|
-
"description": "The
|
1915
|
-
"default": "
|
1916
|
-
"
|
2111
|
+
"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.",
|
2112
|
+
"default": "button",
|
2113
|
+
"attribute": "type",
|
2114
|
+
"reflects": true,
|
2115
|
+
"inheritedFrom": {
|
2116
|
+
"name": "Buttonsimple",
|
2117
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
2118
|
+
}
|
1917
2119
|
},
|
1918
2120
|
{
|
1919
|
-
"
|
1920
|
-
"
|
1921
|
-
|
1922
|
-
|
1923
|
-
|
1924
|
-
|
1925
|
-
|
2121
|
+
"kind": "method",
|
2122
|
+
"name": "executeAction",
|
2123
|
+
"privacy": "protected",
|
2124
|
+
"inheritedFrom": {
|
2125
|
+
"name": "Buttonsimple",
|
2126
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
2127
|
+
}
|
1926
2128
|
},
|
1927
2129
|
{
|
1928
|
-
"
|
1929
|
-
"
|
1930
|
-
|
1931
|
-
|
1932
|
-
|
1933
|
-
|
1934
|
-
|
2130
|
+
"kind": "method",
|
2131
|
+
"name": "setActive",
|
2132
|
+
"privacy": "protected",
|
2133
|
+
"parameters": [
|
2134
|
+
{
|
2135
|
+
"name": "element",
|
2136
|
+
"type": {
|
2137
|
+
"text": "HTMLElement"
|
2138
|
+
},
|
2139
|
+
"description": "The button element"
|
2140
|
+
},
|
2141
|
+
{
|
2142
|
+
"name": "active",
|
2143
|
+
"optional": true,
|
2144
|
+
"type": {
|
2145
|
+
"text": "boolean"
|
2146
|
+
},
|
2147
|
+
"description": "The active state of the element"
|
2148
|
+
}
|
2149
|
+
],
|
2150
|
+
"description": "Sets the ariaStateKey attributes based on the active state of the button.",
|
2151
|
+
"inheritedFrom": {
|
2152
|
+
"name": "Buttonsimple",
|
2153
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
2154
|
+
}
|
1935
2155
|
},
|
1936
2156
|
{
|
1937
|
-
"
|
1938
|
-
"
|
1939
|
-
|
1940
|
-
|
1941
|
-
|
1942
|
-
|
2157
|
+
"kind": "method",
|
2158
|
+
"name": "setSoftDisabled",
|
2159
|
+
"privacy": "private",
|
2160
|
+
"parameters": [
|
2161
|
+
{
|
2162
|
+
"name": "element",
|
2163
|
+
"type": {
|
2164
|
+
"text": "HTMLElement"
|
2165
|
+
},
|
2166
|
+
"description": "The button element."
|
2167
|
+
},
|
2168
|
+
{
|
2169
|
+
"name": "softDisabled",
|
2170
|
+
"optional": true,
|
2171
|
+
"type": {
|
2172
|
+
"text": "boolean"
|
2173
|
+
},
|
2174
|
+
"description": "The soft-disabled state."
|
2175
|
+
}
|
2176
|
+
],
|
2177
|
+
"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.",
|
1943
2178
|
"inheritedFrom": {
|
1944
|
-
"name": "
|
1945
|
-
"module": "
|
2179
|
+
"name": "Buttonsimple",
|
2180
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
1946
2181
|
}
|
1947
|
-
}
|
1948
|
-
],
|
1949
|
-
"mixins": [
|
1950
|
-
{
|
1951
|
-
"name": "IconNameMixin",
|
1952
|
-
"module": "/src/utils/mixins/IconNameMixin"
|
1953
|
-
}
|
1954
|
-
],
|
1955
|
-
"superclass": {
|
1956
|
-
"name": "Component",
|
1957
|
-
"module": "/src/models"
|
1958
|
-
},
|
1959
|
-
"tagName": "mdc-badge",
|
1960
|
-
"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 */",
|
1961
|
-
"customElement": true
|
1962
|
-
}
|
1963
|
-
],
|
1964
|
-
"exports": [
|
1965
|
-
{
|
1966
|
-
"kind": "js",
|
1967
|
-
"name": "default",
|
1968
|
-
"declaration": {
|
1969
|
-
"name": "Badge",
|
1970
|
-
"module": "components/badge/badge.component.js"
|
1971
|
-
}
|
1972
|
-
}
|
1973
|
-
]
|
1974
|
-
},
|
1975
|
-
{
|
1976
|
-
"kind": "javascript-module",
|
1977
|
-
"path": "components/brandvisual/brandvisual.component.js",
|
1978
|
-
"declarations": [
|
1979
|
-
{
|
1980
|
-
"kind": "class",
|
1981
|
-
"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.",
|
1982
|
-
"name": "Brandvisual",
|
1983
|
-
"members": [
|
2182
|
+
},
|
1984
2183
|
{
|
1985
|
-
"kind": "
|
1986
|
-
"name": "
|
1987
|
-
"
|
1988
|
-
|
1989
|
-
|
1990
|
-
|
2184
|
+
"kind": "method",
|
2185
|
+
"name": "setDisabled",
|
2186
|
+
"privacy": "private",
|
2187
|
+
"parameters": [
|
2188
|
+
{
|
2189
|
+
"name": "element",
|
2190
|
+
"type": {
|
2191
|
+
"text": "HTMLElement"
|
2192
|
+
},
|
2193
|
+
"description": "The button element."
|
2194
|
+
},
|
2195
|
+
{
|
2196
|
+
"name": "disabled",
|
2197
|
+
"type": {
|
2198
|
+
"text": "boolean"
|
2199
|
+
},
|
2200
|
+
"description": "The disabled state."
|
2201
|
+
}
|
2202
|
+
],
|
2203
|
+
"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.",
|
2204
|
+
"inheritedFrom": {
|
2205
|
+
"name": "Buttonsimple",
|
2206
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
2207
|
+
}
|
1991
2208
|
},
|
1992
2209
|
{
|
1993
|
-
"kind": "
|
1994
|
-
"name": "
|
1995
|
-
"
|
1996
|
-
|
1997
|
-
|
1998
|
-
|
1999
|
-
|
2000
|
-
"reflects": true
|
2210
|
+
"kind": "method",
|
2211
|
+
"name": "triggerClickEvent",
|
2212
|
+
"privacy": "private",
|
2213
|
+
"inheritedFrom": {
|
2214
|
+
"name": "Buttonsimple",
|
2215
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
2216
|
+
}
|
2001
2217
|
},
|
2002
2218
|
{
|
2003
2219
|
"kind": "method",
|
2004
|
-
"name": "
|
2005
|
-
"privacy": "private"
|
2220
|
+
"name": "handleBlur",
|
2221
|
+
"privacy": "private",
|
2222
|
+
"description": "In case the button is pressed and the focus is lost while pressing,\nthe pressed class is removed.",
|
2223
|
+
"inheritedFrom": {
|
2224
|
+
"name": "Buttonsimple",
|
2225
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
2226
|
+
}
|
2006
2227
|
},
|
2007
2228
|
{
|
2008
2229
|
"kind": "method",
|
2009
|
-
"name": "
|
2230
|
+
"name": "handleKeyDown",
|
2010
2231
|
"privacy": "private",
|
2011
2232
|
"parameters": [
|
2012
2233
|
{
|
2013
|
-
"name": "
|
2234
|
+
"name": "event",
|
2014
2235
|
"type": {
|
2015
|
-
"text": "
|
2236
|
+
"text": "KeyboardEvent"
|
2016
2237
|
},
|
2017
|
-
"description": "The
|
2238
|
+
"description": "The keyboard event."
|
2018
2239
|
}
|
2019
2240
|
],
|
2020
|
-
"description": "
|
2241
|
+
"description": "Handles the keydown event on the button.\nIf the key is 'Enter' or 'Space', the button is pressed.\nIf the key is 'Enter', the button is pressed. The native HTML button works in the same way.\nIf the key is 'Space', the button's default is prevent to avoid scrolling etc in the host application.",
|
2242
|
+
"inheritedFrom": {
|
2243
|
+
"name": "Buttonsimple",
|
2244
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
2245
|
+
}
|
2021
2246
|
},
|
2022
2247
|
{
|
2023
2248
|
"kind": "method",
|
2024
|
-
"name": "
|
2249
|
+
"name": "handleKeyUp",
|
2025
2250
|
"privacy": "private",
|
2026
2251
|
"parameters": [
|
2027
2252
|
{
|
2028
|
-
"name": "
|
2253
|
+
"name": "event",
|
2029
2254
|
"type": {
|
2030
|
-
"text": "
|
2031
|
-
}
|
2255
|
+
"text": "KeyboardEvent"
|
2256
|
+
},
|
2257
|
+
"description": "The keyboard event."
|
2032
2258
|
}
|
2033
2259
|
],
|
2034
|
-
"description": "
|
2260
|
+
"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.",
|
2261
|
+
"inheritedFrom": {
|
2262
|
+
"name": "Buttonsimple",
|
2263
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
2264
|
+
}
|
2035
2265
|
}
|
2036
2266
|
],
|
2037
|
-
"
|
2267
|
+
"attributes": [
|
2038
2268
|
{
|
2039
|
-
"
|
2040
|
-
"
|
2041
|
-
|
2269
|
+
"name": "size",
|
2270
|
+
"type": {
|
2271
|
+
"text": "ButtonSize"
|
2272
|
+
},
|
2273
|
+
"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.",
|
2274
|
+
"default": "32",
|
2275
|
+
"fieldName": "size",
|
2276
|
+
"inheritedFrom": {
|
2277
|
+
"name": "Buttonsimple",
|
2278
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
2279
|
+
}
|
2042
2280
|
},
|
2043
2281
|
{
|
2044
|
-
"
|
2045
|
-
"
|
2046
|
-
|
2047
|
-
|
2048
|
-
|
2049
|
-
|
2282
|
+
"name": "inverted",
|
2283
|
+
"type": {
|
2284
|
+
"text": "boolean"
|
2285
|
+
},
|
2286
|
+
"description": "The button color can be inverted by setting the inverted attribute to true.\n\nOnly applies when variant is set to `primary`, color is set to `default`\nand button is not `active`.",
|
2287
|
+
"default": "false",
|
2288
|
+
"fieldName": "inverted"
|
2289
|
+
},
|
2050
2290
|
{
|
2051
|
-
"name": "
|
2291
|
+
"name": "role",
|
2292
|
+
"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.",
|
2293
|
+
"default": "'button'",
|
2294
|
+
"fieldName": "role",
|
2052
2295
|
"type": {
|
2053
|
-
"text": "
|
2054
|
-
},
|
2055
|
-
"description": "Name of the brandVisual (= filename)",
|
2056
|
-
"fieldName": "name"
|
2057
|
-
}
|
2058
|
-
],
|
2059
|
-
"superclass": {
|
2060
|
-
"name": "Component",
|
2061
|
-
"module": "/src/models"
|
2062
|
-
},
|
2063
|
-
"tagName": "mdc-brandvisual",
|
2064
|
-
"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 */",
|
2065
|
-
"customElement": true
|
2066
|
-
}
|
2067
|
-
],
|
2068
|
-
"exports": [
|
2069
|
-
{
|
2070
|
-
"kind": "js",
|
2071
|
-
"name": "default",
|
2072
|
-
"declaration": {
|
2073
|
-
"name": "Brandvisual",
|
2074
|
-
"module": "components/brandvisual/brandvisual.component.js"
|
2075
|
-
}
|
2076
|
-
}
|
2077
|
-
]
|
2078
|
-
},
|
2079
|
-
{
|
2080
|
-
"kind": "javascript-module",
|
2081
|
-
"path": "components/bullet/bullet.component.js",
|
2082
|
-
"declarations": [
|
2083
|
-
{
|
2084
|
-
"kind": "class",
|
2085
|
-
"description": "Bullet component, which is a visual marker\nand be used to organize and present items in a list format.",
|
2086
|
-
"name": "Bullet",
|
2087
|
-
"cssProperties": [
|
2088
|
-
{
|
2089
|
-
"description": "background color of the bullet",
|
2090
|
-
"name": "--mdc-bullet-background-color"
|
2091
|
-
},
|
2092
|
-
{
|
2093
|
-
"description": "small size value of the bullet",
|
2094
|
-
"name": "--mdc-bullet-size-small"
|
2095
|
-
},
|
2096
|
-
{
|
2097
|
-
"description": "medium size value of the bullet",
|
2098
|
-
"name": "--mdc-bullet-size-medium"
|
2099
|
-
},
|
2100
|
-
{
|
2101
|
-
"description": "large size value of the bullet",
|
2102
|
-
"name": "--mdc-bullet-size-large"
|
2103
|
-
}
|
2104
|
-
],
|
2105
|
-
"members": [
|
2106
|
-
{
|
2107
|
-
"kind": "field",
|
2108
|
-
"name": "size",
|
2109
|
-
"type": {
|
2110
|
-
"text": "Size"
|
2111
|
-
},
|
2112
|
-
"privacy": "public",
|
2113
|
-
"description": "Size of the bullet\n\nPossible values: 'small', 'medium', 'large'",
|
2114
|
-
"default": "small",
|
2115
|
-
"attribute": "size",
|
2116
|
-
"reflects": true
|
2117
|
-
}
|
2118
|
-
],
|
2119
|
-
"attributes": [
|
2120
|
-
{
|
2121
|
-
"name": "size",
|
2122
|
-
"type": {
|
2123
|
-
"text": "Size"
|
2124
|
-
},
|
2125
|
-
"description": "Size of the bullet\n\nPossible values: 'small', 'medium', 'large'",
|
2126
|
-
"default": "small",
|
2127
|
-
"fieldName": "size"
|
2128
|
-
}
|
2129
|
-
],
|
2130
|
-
"superclass": {
|
2131
|
-
"name": "Component",
|
2132
|
-
"module": "/src/models"
|
2133
|
-
},
|
2134
|
-
"tagName": "mdc-bullet",
|
2135
|
-
"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*/",
|
2136
|
-
"customElement": true
|
2137
|
-
}
|
2138
|
-
],
|
2139
|
-
"exports": [
|
2140
|
-
{
|
2141
|
-
"kind": "js",
|
2142
|
-
"name": "default",
|
2143
|
-
"declaration": {
|
2144
|
-
"name": "Bullet",
|
2145
|
-
"module": "components/bullet/bullet.component.js"
|
2146
|
-
}
|
2147
|
-
}
|
2148
|
-
]
|
2149
|
-
},
|
2150
|
-
{
|
2151
|
-
"kind": "javascript-module",
|
2152
|
-
"path": "components/button/button.component.js",
|
2153
|
-
"declarations": [
|
2154
|
-
{
|
2155
|
-
"kind": "class",
|
2156
|
-
"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.",
|
2157
|
-
"name": "Button",
|
2158
|
-
"slots": [
|
2159
|
-
{
|
2160
|
-
"description": "Text label of the button.",
|
2161
|
-
"name": ""
|
2162
|
-
}
|
2163
|
-
],
|
2164
|
-
"members": [
|
2165
|
-
{
|
2166
|
-
"kind": "field",
|
2167
|
-
"name": "size",
|
2168
|
-
"type": {
|
2169
|
-
"text": "ButtonSize"
|
2170
|
-
},
|
2171
|
-
"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.",
|
2172
|
-
"default": "32",
|
2173
|
-
"attribute": "size",
|
2174
|
-
"reflects": true,
|
2175
|
-
"inheritedFrom": {
|
2176
|
-
"name": "Buttonsimple",
|
2177
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
2178
|
-
}
|
2179
|
-
},
|
2180
|
-
{
|
2181
|
-
"kind": "field",
|
2182
|
-
"name": "inverted",
|
2183
|
-
"type": {
|
2184
|
-
"text": "boolean"
|
2185
|
-
},
|
2186
|
-
"description": "The button color can be inverted by setting the inverted attribute to true.\n\nOnly applies when variant is set to `primary`, color is set to `default`\nand button is not `active`.",
|
2187
|
-
"default": "false",
|
2188
|
-
"attribute": "inverted",
|
2189
|
-
"reflects": true
|
2190
|
-
},
|
2191
|
-
{
|
2192
|
-
"kind": "field",
|
2193
|
-
"name": "role",
|
2194
|
-
"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.",
|
2195
|
-
"default": "'button'",
|
2196
|
-
"attribute": "role",
|
2197
|
-
"reflects": true,
|
2198
|
-
"type": {
|
2199
|
-
"text": "string"
|
2296
|
+
"text": "string"
|
2200
2297
|
},
|
2201
2298
|
"inheritedFrom": {
|
2202
2299
|
"name": "Buttonsimple",
|
2203
|
-
"module": "components/buttonsimple/buttonsimple.component.
|
2300
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
2204
2301
|
}
|
2205
2302
|
},
|
2206
2303
|
{
|
2207
|
-
"
|
2208
|
-
"name": "inferFilledIconName",
|
2209
|
-
"privacy": "private",
|
2210
|
-
"parameters": [
|
2211
|
-
{
|
2212
|
-
"name": "active",
|
2213
|
-
"optional": true,
|
2214
|
-
"type": {
|
2215
|
-
"text": "boolean"
|
2216
|
-
},
|
2217
|
-
"description": "The active state."
|
2218
|
-
}
|
2219
|
-
],
|
2220
|
-
"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."
|
2221
|
-
},
|
2222
|
-
{
|
2223
|
-
"kind": "field",
|
2224
|
-
"name": "prefixIcon",
|
2304
|
+
"name": "prefix-icon",
|
2225
2305
|
"type": {
|
2226
2306
|
"text": "IconNames | undefined"
|
2227
2307
|
},
|
2228
2308
|
"description": "The name of the icon to display as a prefix.\nThe icon is displayed on the left side of the button.",
|
2229
|
-
"
|
2230
|
-
"reflects": true,
|
2309
|
+
"fieldName": "prefixIcon",
|
2231
2310
|
"inheritedFrom": {
|
2232
2311
|
"name": "ButtonComponentMixin",
|
2233
|
-
"module": "utils/mixins/ButtonComponentMixin.
|
2312
|
+
"module": "src/utils/mixins/ButtonComponentMixin.ts"
|
2234
2313
|
}
|
2235
2314
|
},
|
2236
2315
|
{
|
2237
|
-
"
|
2238
|
-
"name": "postfixIcon",
|
2316
|
+
"name": "postfix-icon",
|
2239
2317
|
"type": {
|
2240
2318
|
"text": "IconNames | undefined"
|
2241
2319
|
},
|
2242
2320
|
"description": "The name of the icon to display as a postfix.\nThe icon is displayed on the right side of the button.",
|
2243
|
-
"
|
2244
|
-
"reflects": true,
|
2321
|
+
"fieldName": "postfixIcon",
|
2245
2322
|
"inheritedFrom": {
|
2246
2323
|
"name": "ButtonComponentMixin",
|
2247
|
-
"module": "utils/mixins/ButtonComponentMixin.
|
2324
|
+
"module": "src/utils/mixins/ButtonComponentMixin.ts"
|
2248
2325
|
}
|
2249
2326
|
},
|
2250
2327
|
{
|
2251
|
-
"kind": "field",
|
2252
2328
|
"name": "variant",
|
2253
2329
|
"type": {
|
2254
2330
|
"text": "ButtonVariant"
|
2255
2331
|
},
|
2256
2332
|
"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.",
|
2257
2333
|
"default": "primary",
|
2258
|
-
"
|
2334
|
+
"fieldName": "variant",
|
2259
2335
|
"inheritedFrom": {
|
2260
2336
|
"name": "ButtonComponentMixin",
|
2261
|
-
"module": "utils/mixins/ButtonComponentMixin.
|
2337
|
+
"module": "src/utils/mixins/ButtonComponentMixin.ts"
|
2262
2338
|
}
|
2263
2339
|
},
|
2264
2340
|
{
|
2265
|
-
"kind": "field",
|
2266
2341
|
"name": "color",
|
2267
2342
|
"type": {
|
2268
2343
|
"text": "ButtonColor"
|
2269
2344
|
},
|
2270
2345
|
"description": "There are 5 colors for button: positive, negative, accent, promotional, default.",
|
2271
2346
|
"default": "default",
|
2272
|
-
"
|
2273
|
-
"inheritedFrom": {
|
2274
|
-
"name": "ButtonComponentMixin",
|
2275
|
-
"module": "utils/mixins/ButtonComponentMixin.js"
|
2276
|
-
}
|
2277
|
-
},
|
2278
|
-
{
|
2279
|
-
"kind": "method",
|
2280
|
-
"name": "setVariant",
|
2281
|
-
"privacy": "protected",
|
2282
|
-
"parameters": [
|
2283
|
-
{
|
2284
|
-
"name": "variant",
|
2285
|
-
"type": {
|
2286
|
-
"text": "ButtonVariant"
|
2287
|
-
},
|
2288
|
-
"description": "The variant to set."
|
2289
|
-
}
|
2290
|
-
],
|
2291
|
-
"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.",
|
2292
|
-
"inheritedFrom": {
|
2293
|
-
"name": "ButtonComponentMixin",
|
2294
|
-
"module": "utils/mixins/ButtonComponentMixin.js"
|
2295
|
-
}
|
2296
|
-
},
|
2297
|
-
{
|
2298
|
-
"kind": "method",
|
2299
|
-
"name": "setColor",
|
2300
|
-
"privacy": "protected",
|
2301
|
-
"parameters": [
|
2302
|
-
{
|
2303
|
-
"name": "color",
|
2304
|
-
"type": {
|
2305
|
-
"text": "ButtonColor"
|
2306
|
-
},
|
2307
|
-
"description": "The color to set."
|
2308
|
-
}
|
2309
|
-
],
|
2310
|
-
"description": "Sets the color attribute for the button.\nDefaults to DEFAULTS.COLOR if invalid or for tertiary button.",
|
2311
|
-
"inheritedFrom": {
|
2312
|
-
"name": "ButtonComponentMixin",
|
2313
|
-
"module": "utils/mixins/ButtonComponentMixin.js"
|
2314
|
-
}
|
2315
|
-
},
|
2316
|
-
{
|
2317
|
-
"kind": "method",
|
2318
|
-
"name": "setSize",
|
2319
|
-
"privacy": "protected",
|
2320
|
-
"parameters": [
|
2321
|
-
{
|
2322
|
-
"name": "size",
|
2323
|
-
"type": {
|
2324
|
-
"text": "PillButtonSize | IconButtonSize"
|
2325
|
-
},
|
2326
|
-
"description": "The size to set."
|
2327
|
-
}
|
2328
|
-
],
|
2329
|
-
"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.",
|
2330
|
-
"inheritedFrom": {
|
2331
|
-
"name": "ButtonComponentMixin",
|
2332
|
-
"module": "utils/mixins/ButtonComponentMixin.js"
|
2333
|
-
}
|
2334
|
-
},
|
2335
|
-
{
|
2336
|
-
"kind": "method",
|
2337
|
-
"name": "inferButtonType",
|
2338
|
-
"privacy": "protected",
|
2339
|
-
"description": "Infers the type of button based on the presence of slot and/or prefix and postfix icons.",
|
2340
|
-
"parameters": [
|
2341
|
-
{
|
2342
|
-
"description": "default slot of button",
|
2343
|
-
"name": "slot"
|
2344
|
-
}
|
2345
|
-
],
|
2347
|
+
"fieldName": "color",
|
2346
2348
|
"inheritedFrom": {
|
2347
2349
|
"name": "ButtonComponentMixin",
|
2348
|
-
"module": "utils/mixins/ButtonComponentMixin.
|
2350
|
+
"module": "src/utils/mixins/ButtonComponentMixin.ts"
|
2349
2351
|
}
|
2350
2352
|
},
|
2351
2353
|
{
|
2352
|
-
"kind": "field",
|
2353
2354
|
"name": "tabIndex",
|
2354
2355
|
"type": {
|
2355
2356
|
"text": "number"
|
2356
2357
|
},
|
2357
2358
|
"default": "0",
|
2358
2359
|
"description": "This property specifies the tab order of the element.",
|
2359
|
-
"
|
2360
|
-
"reflects": true,
|
2360
|
+
"fieldName": "tabIndex",
|
2361
2361
|
"inheritedFrom": {
|
2362
2362
|
"name": "TabIndexMixin",
|
2363
|
-
"module": "utils/mixins/TabIndexMixin.
|
2363
|
+
"module": "src/utils/mixins/TabIndexMixin.ts"
|
2364
2364
|
}
|
2365
2365
|
},
|
2366
2366
|
{
|
2367
|
-
"kind": "field",
|
2368
2367
|
"name": "disabled",
|
2369
2368
|
"type": {
|
2370
2369
|
"text": "boolean | undefined"
|
2371
2370
|
},
|
2372
2371
|
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
2373
2372
|
"default": "undefined",
|
2374
|
-
"
|
2375
|
-
"reflects": true,
|
2373
|
+
"fieldName": "disabled",
|
2376
2374
|
"inheritedFrom": {
|
2377
2375
|
"name": "DisabledMixin",
|
2378
|
-
"module": "utils/mixins/DisabledMixin.
|
2376
|
+
"module": "src/utils/mixins/DisabledMixin.ts"
|
2379
2377
|
}
|
2380
2378
|
},
|
2381
2379
|
{
|
2382
|
-
"kind": "field",
|
2383
2380
|
"name": "active",
|
2384
2381
|
"type": {
|
2385
2382
|
"text": "boolean | undefined"
|
2386
2383
|
},
|
2387
2384
|
"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.",
|
2388
2385
|
"default": "undefined",
|
2389
|
-
"
|
2390
|
-
"reflects": true,
|
2386
|
+
"fieldName": "active",
|
2391
2387
|
"inheritedFrom": {
|
2392
2388
|
"name": "Buttonsimple",
|
2393
|
-
"module": "components/buttonsimple/buttonsimple.component.
|
2389
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
2394
2390
|
}
|
2395
2391
|
},
|
2396
2392
|
{
|
2397
|
-
"
|
2398
|
-
"name": "softDisabled",
|
2393
|
+
"name": "soft-disabled",
|
2399
2394
|
"type": {
|
2400
2395
|
"text": "boolean | undefined"
|
2401
2396
|
},
|
2402
2397
|
"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.",
|
2403
2398
|
"default": "undefined",
|
2404
|
-
"
|
2405
|
-
"reflects": true,
|
2399
|
+
"fieldName": "softDisabled",
|
2406
2400
|
"inheritedFrom": {
|
2407
2401
|
"name": "Buttonsimple",
|
2408
|
-
"module": "components/buttonsimple/buttonsimple.component.
|
2402
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
2409
2403
|
}
|
2410
2404
|
},
|
2411
2405
|
{
|
2412
|
-
"kind": "field",
|
2413
2406
|
"name": "ariaStateKey",
|
2414
2407
|
"type": {
|
2415
2408
|
"text": "string | undefined"
|
2416
2409
|
},
|
2417
2410
|
"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`",
|
2418
2411
|
"default": "'aria-pressed' (when)",
|
2419
|
-
"
|
2420
|
-
"reflects": true,
|
2412
|
+
"fieldName": "ariaStateKey",
|
2421
2413
|
"inheritedFrom": {
|
2422
2414
|
"name": "Buttonsimple",
|
2423
|
-
"module": "components/buttonsimple/buttonsimple.component.
|
2415
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
2424
2416
|
}
|
2425
2417
|
},
|
2426
2418
|
{
|
2427
|
-
"kind": "field",
|
2428
2419
|
"name": "type",
|
2429
2420
|
"type": {
|
2430
2421
|
"text": "ButtonType"
|
2431
2422
|
},
|
2432
2423
|
"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.",
|
2433
2424
|
"default": "button",
|
2434
|
-
"
|
2435
|
-
"reflects": true,
|
2425
|
+
"fieldName": "type",
|
2436
2426
|
"inheritedFrom": {
|
2437
2427
|
"name": "Buttonsimple",
|
2438
|
-
"module": "components/buttonsimple/buttonsimple.component.
|
2428
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
2439
2429
|
}
|
2440
|
-
}
|
2430
|
+
}
|
2431
|
+
],
|
2432
|
+
"mixins": [
|
2441
2433
|
{
|
2442
|
-
"
|
2443
|
-
"
|
2444
|
-
|
2434
|
+
"name": "ButtonComponentMixin",
|
2435
|
+
"module": "/src/utils/mixins/ButtonComponentMixin"
|
2436
|
+
}
|
2437
|
+
],
|
2438
|
+
"superclass": {
|
2439
|
+
"name": "Buttonsimple",
|
2440
|
+
"module": "/src/components/buttonsimple/buttonsimple.component"
|
2441
|
+
},
|
2442
|
+
"tagName": "mdc-button",
|
2443
|
+
"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 */",
|
2444
|
+
"customElement": true,
|
2445
|
+
"events": [
|
2446
|
+
{
|
2447
|
+
"description": "(React: onClick) This event is dispatched when the button is clicked.",
|
2448
|
+
"name": "click",
|
2449
|
+
"reactName": "onClick",
|
2445
2450
|
"inheritedFrom": {
|
2446
2451
|
"name": "Buttonsimple",
|
2447
|
-
"module": "components/buttonsimple/buttonsimple.component.
|
2452
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
2448
2453
|
}
|
2449
2454
|
},
|
2450
2455
|
{
|
2451
|
-
"
|
2452
|
-
"name": "
|
2453
|
-
"
|
2454
|
-
"parameters": [
|
2455
|
-
{
|
2456
|
-
"name": "element",
|
2457
|
-
"type": {
|
2458
|
-
"text": "HTMLElement"
|
2459
|
-
},
|
2460
|
-
"description": "The button element"
|
2461
|
-
},
|
2462
|
-
{
|
2463
|
-
"name": "active",
|
2464
|
-
"optional": true,
|
2465
|
-
"type": {
|
2466
|
-
"text": "boolean"
|
2467
|
-
},
|
2468
|
-
"description": "The active state of the element"
|
2469
|
-
}
|
2470
|
-
],
|
2471
|
-
"description": "Sets the ariaStateKey attributes based on the active state of the button.",
|
2456
|
+
"description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the button.",
|
2457
|
+
"name": "keydown",
|
2458
|
+
"reactName": "onKeyDown",
|
2472
2459
|
"inheritedFrom": {
|
2473
2460
|
"name": "Buttonsimple",
|
2474
|
-
"module": "components/buttonsimple/buttonsimple.component.
|
2461
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
2475
2462
|
}
|
2476
2463
|
},
|
2477
2464
|
{
|
2478
|
-
"
|
2479
|
-
"name": "
|
2480
|
-
"
|
2481
|
-
"parameters": [
|
2482
|
-
{
|
2483
|
-
"name": "element",
|
2484
|
-
"type": {
|
2485
|
-
"text": "HTMLElement"
|
2486
|
-
},
|
2487
|
-
"description": "The button element."
|
2488
|
-
},
|
2489
|
-
{
|
2490
|
-
"name": "softDisabled",
|
2491
|
-
"optional": true,
|
2492
|
-
"type": {
|
2493
|
-
"text": "boolean"
|
2494
|
-
},
|
2495
|
-
"description": "The soft-disabled state."
|
2496
|
-
}
|
2497
|
-
],
|
2498
|
-
"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.",
|
2465
|
+
"description": "(React: onKeyUp) This event is dispatched when a key is released on the button.",
|
2466
|
+
"name": "keyup",
|
2467
|
+
"reactName": "onKeyUp",
|
2499
2468
|
"inheritedFrom": {
|
2500
2469
|
"name": "Buttonsimple",
|
2501
|
-
"module": "components/buttonsimple/buttonsimple.component.
|
2470
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
2502
2471
|
}
|
2503
2472
|
},
|
2504
2473
|
{
|
2505
|
-
"
|
2506
|
-
"name": "
|
2507
|
-
"
|
2508
|
-
"parameters": [
|
2509
|
-
{
|
2510
|
-
"name": "element",
|
2511
|
-
"type": {
|
2512
|
-
"text": "HTMLElement"
|
2513
|
-
},
|
2514
|
-
"description": "The button element."
|
2515
|
-
},
|
2516
|
-
{
|
2517
|
-
"name": "disabled",
|
2518
|
-
"type": {
|
2519
|
-
"text": "boolean"
|
2520
|
-
},
|
2521
|
-
"description": "The disabled state."
|
2522
|
-
}
|
2523
|
-
],
|
2524
|
-
"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.",
|
2474
|
+
"description": "(React: onFocus) This event is dispatched when the button receives focus.",
|
2475
|
+
"name": "focus",
|
2476
|
+
"reactName": "onFocus",
|
2525
2477
|
"inheritedFrom": {
|
2526
2478
|
"name": "Buttonsimple",
|
2527
|
-
"module": "components/buttonsimple/buttonsimple.component.
|
2479
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
2528
2480
|
}
|
2481
|
+
}
|
2482
|
+
]
|
2483
|
+
}
|
2484
|
+
],
|
2485
|
+
"exports": [
|
2486
|
+
{
|
2487
|
+
"kind": "js",
|
2488
|
+
"name": "default",
|
2489
|
+
"declaration": {
|
2490
|
+
"name": "Button",
|
2491
|
+
"module": "components/button/button.component.js"
|
2492
|
+
}
|
2493
|
+
}
|
2494
|
+
]
|
2495
|
+
},
|
2496
|
+
{
|
2497
|
+
"kind": "javascript-module",
|
2498
|
+
"path": "components/buttongroup/buttongroup.component.js",
|
2499
|
+
"declarations": [
|
2500
|
+
{
|
2501
|
+
"kind": "class",
|
2502
|
+
"description": "buttongroup component, is a styled wrapper for multiple buttons.\nIt can support icon buttons, combination of icon and pill buttons, and text buttons.\nThey are available in horizontal and vertical orientation.",
|
2503
|
+
"name": "ButtonGroup",
|
2504
|
+
"cssProperties": [
|
2505
|
+
{
|
2506
|
+
"description": "The border radius of the buttongroup",
|
2507
|
+
"name": "--mdc-buttongroup-border-radius"
|
2529
2508
|
},
|
2530
2509
|
{
|
2531
|
-
"
|
2532
|
-
"name": "
|
2533
|
-
"privacy": "private",
|
2534
|
-
"inheritedFrom": {
|
2535
|
-
"name": "Buttonsimple",
|
2536
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
2537
|
-
}
|
2510
|
+
"description": "The border color of the buttongroup",
|
2511
|
+
"name": "--mdc-buttongroup-border-color"
|
2538
2512
|
},
|
2539
2513
|
{
|
2540
|
-
"
|
2541
|
-
"name": "
|
2542
|
-
|
2543
|
-
|
2544
|
-
|
2545
|
-
|
2546
|
-
|
2547
|
-
|
2514
|
+
"description": "The color of the divider between buttons within the buttongroup",
|
2515
|
+
"name": "--mdc-buttongroup-divider-color"
|
2516
|
+
}
|
2517
|
+
],
|
2518
|
+
"slots": [
|
2519
|
+
{
|
2520
|
+
"description": "This is a default/unnamed slot, which contains the buttons",
|
2521
|
+
"name": "default"
|
2522
|
+
}
|
2523
|
+
],
|
2524
|
+
"members": [
|
2525
|
+
{
|
2526
|
+
"kind": "field",
|
2527
|
+
"name": "orientation",
|
2528
|
+
"type": {
|
2529
|
+
"text": "ButtonGroupOrientation"
|
2530
|
+
},
|
2531
|
+
"description": "Orientation of the buttongroup.",
|
2532
|
+
"default": "'horizontal'",
|
2533
|
+
"attribute": "orientation",
|
2534
|
+
"reflects": true
|
2548
2535
|
},
|
2549
2536
|
{
|
2550
|
-
"kind": "
|
2551
|
-
"name": "
|
2552
|
-
"
|
2553
|
-
|
2554
|
-
|
2555
|
-
|
2556
|
-
|
2557
|
-
|
2558
|
-
|
2559
|
-
"description": "The keyboard event."
|
2560
|
-
}
|
2561
|
-
],
|
2562
|
-
"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.",
|
2563
|
-
"inheritedFrom": {
|
2564
|
-
"name": "Buttonsimple",
|
2565
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
2566
|
-
}
|
2537
|
+
"kind": "field",
|
2538
|
+
"name": "variant",
|
2539
|
+
"type": {
|
2540
|
+
"text": "ButtonGroupVariant"
|
2541
|
+
},
|
2542
|
+
"description": "Variant of the buttons within the buttongroup.",
|
2543
|
+
"default": "'primary'",
|
2544
|
+
"attribute": "variant",
|
2545
|
+
"reflects": true
|
2567
2546
|
},
|
2568
2547
|
{
|
2569
|
-
"kind": "
|
2570
|
-
"name": "
|
2571
|
-
"
|
2572
|
-
|
2573
|
-
|
2574
|
-
|
2575
|
-
|
2576
|
-
|
2577
|
-
|
2578
|
-
|
2579
|
-
|
2580
|
-
|
2581
|
-
"
|
2582
|
-
"
|
2583
|
-
"
|
2584
|
-
|
2585
|
-
|
2548
|
+
"kind": "field",
|
2549
|
+
"name": "size",
|
2550
|
+
"type": {
|
2551
|
+
"text": "ButtonGroupSize"
|
2552
|
+
},
|
2553
|
+
"description": "Size of the buttons within the buttongroup.",
|
2554
|
+
"default": "'28'",
|
2555
|
+
"attribute": "size",
|
2556
|
+
"reflects": true
|
2557
|
+
},
|
2558
|
+
{
|
2559
|
+
"kind": "field",
|
2560
|
+
"name": "compact",
|
2561
|
+
"type": {
|
2562
|
+
"text": "boolean"
|
2563
|
+
},
|
2564
|
+
"default": "false",
|
2565
|
+
"description": "When this is true, the buttons within the buttongroup will be compact.\ni.e. Irrespective of the size of the buttons, they will have a height of 24px.",
|
2566
|
+
"attribute": "compact",
|
2567
|
+
"reflects": true
|
2586
2568
|
}
|
2587
2569
|
],
|
2588
2570
|
"attributes": [
|
2571
|
+
{
|
2572
|
+
"name": "orientation",
|
2573
|
+
"type": {
|
2574
|
+
"text": "ButtonGroupOrientation"
|
2575
|
+
},
|
2576
|
+
"description": "Orientation of the buttongroup.",
|
2577
|
+
"default": "'horizontal'",
|
2578
|
+
"fieldName": "orientation"
|
2579
|
+
},
|
2580
|
+
{
|
2581
|
+
"name": "variant",
|
2582
|
+
"type": {
|
2583
|
+
"text": "ButtonGroupVariant"
|
2584
|
+
},
|
2585
|
+
"description": "Variant of the buttons within the buttongroup.",
|
2586
|
+
"default": "'primary'",
|
2587
|
+
"fieldName": "variant"
|
2588
|
+
},
|
2589
2589
|
{
|
2590
2590
|
"name": "size",
|
2591
2591
|
"type": {
|
2592
|
-
"text": "
|
2592
|
+
"text": "ButtonGroupSize"
|
2593
2593
|
},
|
2594
|
-
"description": "
|
2594
|
+
"description": "Size of the buttons within the buttongroup.",
|
2595
|
+
"default": "'28'",
|
2596
|
+
"fieldName": "size"
|
2597
|
+
},
|
2598
|
+
{
|
2599
|
+
"name": "compact",
|
2600
|
+
"type": {
|
2601
|
+
"text": "boolean"
|
2602
|
+
},
|
2603
|
+
"default": "false",
|
2604
|
+
"description": "When this is true, the buttons within the buttongroup will be compact.\ni.e. Irrespective of the size of the buttons, they will have a height of 24px.",
|
2605
|
+
"fieldName": "compact"
|
2606
|
+
}
|
2607
|
+
],
|
2608
|
+
"superclass": {
|
2609
|
+
"name": "Component",
|
2610
|
+
"module": "/src/models"
|
2611
|
+
},
|
2612
|
+
"tagName": "mdc-buttongroup",
|
2613
|
+
"jsDoc": "/**\n * buttongroup component, is a styled wrapper for multiple buttons.\n * It can support icon buttons, combination of icon and pill buttons, and text buttons.\n * They are available in horizontal and vertical orientation.\n *\n * @tagname mdc-buttongroup\n *\n * @slot default - This is a default/unnamed slot, which contains the buttons\n *\n * @cssproperty --mdc-buttongroup-border-radius - The border radius of the buttongroup\n * @cssproperty --mdc-buttongroup-border-color - The border color of the buttongroup\n * @cssproperty --mdc-buttongroup-divider-color - The color of the divider between buttons within the buttongroup\n */",
|
2614
|
+
"customElement": true
|
2615
|
+
}
|
2616
|
+
],
|
2617
|
+
"exports": [
|
2618
|
+
{
|
2619
|
+
"kind": "js",
|
2620
|
+
"name": "default",
|
2621
|
+
"declaration": {
|
2622
|
+
"name": "ButtonGroup",
|
2623
|
+
"module": "components/buttongroup/buttongroup.component.js"
|
2624
|
+
}
|
2625
|
+
}
|
2626
|
+
]
|
2627
|
+
},
|
2628
|
+
{
|
2629
|
+
"kind": "javascript-module",
|
2630
|
+
"path": "components/buttonlink/buttonlink.component.js",
|
2631
|
+
"declarations": [
|
2632
|
+
{
|
2633
|
+
"kind": "class",
|
2634
|
+
"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`.",
|
2635
|
+
"name": "ButtonLink",
|
2636
|
+
"members": [
|
2637
|
+
{
|
2638
|
+
"kind": "field",
|
2639
|
+
"name": "size",
|
2640
|
+
"type": {
|
2641
|
+
"text": "PillButtonSize | IconButtonSize"
|
2642
|
+
},
|
2643
|
+
"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.",
|
2595
2644
|
"default": "32",
|
2596
|
-
"
|
2597
|
-
"
|
2598
|
-
"name": "Buttonsimple",
|
2599
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
2600
|
-
}
|
2645
|
+
"attribute": "size",
|
2646
|
+
"reflects": true
|
2601
2647
|
},
|
2602
2648
|
{
|
2603
|
-
"
|
2649
|
+
"kind": "field",
|
2650
|
+
"name": "softDisabled",
|
2604
2651
|
"type": {
|
2605
|
-
"text": "boolean"
|
2652
|
+
"text": "boolean | undefined"
|
2606
2653
|
},
|
2607
|
-
"description": "
|
2608
|
-
"default": "
|
2609
|
-
"
|
2654
|
+
"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.",
|
2655
|
+
"default": "undefined",
|
2656
|
+
"attribute": "soft-disabled",
|
2657
|
+
"reflects": true
|
2610
2658
|
},
|
2611
2659
|
{
|
2612
|
-
"
|
2613
|
-
"
|
2614
|
-
"
|
2615
|
-
"
|
2616
|
-
|
2617
|
-
|
2618
|
-
|
2619
|
-
|
2620
|
-
|
2621
|
-
|
2622
|
-
|
2660
|
+
"kind": "method",
|
2661
|
+
"name": "setSoftDisabled",
|
2662
|
+
"privacy": "private",
|
2663
|
+
"parameters": [
|
2664
|
+
{
|
2665
|
+
"name": "element",
|
2666
|
+
"type": {
|
2667
|
+
"text": "HTMLElement"
|
2668
|
+
},
|
2669
|
+
"description": "The buttonlink element."
|
2670
|
+
},
|
2671
|
+
{
|
2672
|
+
"name": "softDisabled",
|
2673
|
+
"optional": true,
|
2674
|
+
"type": {
|
2675
|
+
"text": "boolean"
|
2676
|
+
},
|
2677
|
+
"description": "The soft-disabled state."
|
2678
|
+
}
|
2679
|
+
],
|
2680
|
+
"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."
|
2623
2681
|
},
|
2624
2682
|
{
|
2625
|
-
"
|
2683
|
+
"kind": "field",
|
2684
|
+
"name": "prefixIcon",
|
2626
2685
|
"type": {
|
2627
2686
|
"text": "IconNames | undefined"
|
2628
2687
|
},
|
2629
2688
|
"description": "The name of the icon to display as a prefix.\nThe icon is displayed on the left side of the button.",
|
2630
|
-
"
|
2689
|
+
"attribute": "prefix-icon",
|
2690
|
+
"reflects": true,
|
2631
2691
|
"inheritedFrom": {
|
2632
2692
|
"name": "ButtonComponentMixin",
|
2633
|
-
"module": "
|
2693
|
+
"module": "utils/mixins/ButtonComponentMixin.js"
|
2634
2694
|
}
|
2635
2695
|
},
|
2636
2696
|
{
|
2637
|
-
"
|
2697
|
+
"kind": "field",
|
2698
|
+
"name": "postfixIcon",
|
2638
2699
|
"type": {
|
2639
2700
|
"text": "IconNames | undefined"
|
2640
2701
|
},
|
2641
2702
|
"description": "The name of the icon to display as a postfix.\nThe icon is displayed on the right side of the button.",
|
2642
|
-
"
|
2703
|
+
"attribute": "postfix-icon",
|
2704
|
+
"reflects": true,
|
2643
2705
|
"inheritedFrom": {
|
2644
2706
|
"name": "ButtonComponentMixin",
|
2645
|
-
"module": "
|
2707
|
+
"module": "utils/mixins/ButtonComponentMixin.js"
|
2646
2708
|
}
|
2647
2709
|
},
|
2648
2710
|
{
|
2711
|
+
"kind": "field",
|
2649
2712
|
"name": "variant",
|
2650
2713
|
"type": {
|
2651
2714
|
"text": "ButtonVariant"
|
2652
2715
|
},
|
2653
2716
|
"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.",
|
2654
2717
|
"default": "primary",
|
2655
|
-
"
|
2718
|
+
"attribute": "variant",
|
2656
2719
|
"inheritedFrom": {
|
2657
2720
|
"name": "ButtonComponentMixin",
|
2658
|
-
"module": "
|
2721
|
+
"module": "utils/mixins/ButtonComponentMixin.js"
|
2659
2722
|
}
|
2660
2723
|
},
|
2661
2724
|
{
|
2725
|
+
"kind": "field",
|
2662
2726
|
"name": "color",
|
2663
2727
|
"type": {
|
2664
2728
|
"text": "ButtonColor"
|
2665
2729
|
},
|
2666
2730
|
"description": "There are 5 colors for button: positive, negative, accent, promotional, default.",
|
2667
2731
|
"default": "default",
|
2668
|
-
"
|
2732
|
+
"attribute": "color",
|
2669
2733
|
"inheritedFrom": {
|
2670
2734
|
"name": "ButtonComponentMixin",
|
2671
|
-
"module": "
|
2735
|
+
"module": "utils/mixins/ButtonComponentMixin.js"
|
2736
|
+
}
|
2737
|
+
},
|
2738
|
+
{
|
2739
|
+
"kind": "method",
|
2740
|
+
"name": "setVariant",
|
2741
|
+
"privacy": "protected",
|
2742
|
+
"parameters": [
|
2743
|
+
{
|
2744
|
+
"name": "variant",
|
2745
|
+
"type": {
|
2746
|
+
"text": "ButtonVariant"
|
2747
|
+
},
|
2748
|
+
"description": "The variant to set."
|
2749
|
+
}
|
2750
|
+
],
|
2751
|
+
"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.",
|
2752
|
+
"inheritedFrom": {
|
2753
|
+
"name": "ButtonComponentMixin",
|
2754
|
+
"module": "utils/mixins/ButtonComponentMixin.js"
|
2755
|
+
}
|
2756
|
+
},
|
2757
|
+
{
|
2758
|
+
"kind": "method",
|
2759
|
+
"name": "setColor",
|
2760
|
+
"privacy": "protected",
|
2761
|
+
"parameters": [
|
2762
|
+
{
|
2763
|
+
"name": "color",
|
2764
|
+
"type": {
|
2765
|
+
"text": "ButtonColor"
|
2766
|
+
},
|
2767
|
+
"description": "The color to set."
|
2768
|
+
}
|
2769
|
+
],
|
2770
|
+
"description": "Sets the color attribute for the button.\nDefaults to DEFAULTS.COLOR if invalid or for tertiary button.",
|
2771
|
+
"inheritedFrom": {
|
2772
|
+
"name": "ButtonComponentMixin",
|
2773
|
+
"module": "utils/mixins/ButtonComponentMixin.js"
|
2774
|
+
}
|
2775
|
+
},
|
2776
|
+
{
|
2777
|
+
"kind": "method",
|
2778
|
+
"name": "setSize",
|
2779
|
+
"privacy": "protected",
|
2780
|
+
"parameters": [
|
2781
|
+
{
|
2782
|
+
"name": "size",
|
2783
|
+
"type": {
|
2784
|
+
"text": "PillButtonSize | IconButtonSize"
|
2785
|
+
},
|
2786
|
+
"description": "The size to set."
|
2787
|
+
}
|
2788
|
+
],
|
2789
|
+
"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.",
|
2790
|
+
"inheritedFrom": {
|
2791
|
+
"name": "ButtonComponentMixin",
|
2792
|
+
"module": "utils/mixins/ButtonComponentMixin.js"
|
2793
|
+
}
|
2794
|
+
},
|
2795
|
+
{
|
2796
|
+
"kind": "method",
|
2797
|
+
"name": "inferButtonType",
|
2798
|
+
"privacy": "protected",
|
2799
|
+
"description": "Infers the type of button based on the presence of slot and/or prefix and postfix icons.",
|
2800
|
+
"parameters": [
|
2801
|
+
{
|
2802
|
+
"description": "default slot of button",
|
2803
|
+
"name": "slot"
|
2804
|
+
}
|
2805
|
+
],
|
2806
|
+
"inheritedFrom": {
|
2807
|
+
"name": "ButtonComponentMixin",
|
2808
|
+
"module": "utils/mixins/ButtonComponentMixin.js"
|
2809
|
+
}
|
2810
|
+
},
|
2811
|
+
{
|
2812
|
+
"kind": "field",
|
2813
|
+
"name": "disabled",
|
2814
|
+
"type": {
|
2815
|
+
"text": "boolean | undefined"
|
2816
|
+
},
|
2817
|
+
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
2818
|
+
"default": "undefined",
|
2819
|
+
"attribute": "disabled",
|
2820
|
+
"reflects": true,
|
2821
|
+
"inheritedFrom": {
|
2822
|
+
"name": "DisabledMixin",
|
2823
|
+
"module": "utils/mixins/DisabledMixin.js"
|
2672
2824
|
}
|
2673
2825
|
},
|
2674
2826
|
{
|
2827
|
+
"kind": "field",
|
2675
2828
|
"name": "tabIndex",
|
2676
2829
|
"type": {
|
2677
2830
|
"text": "number"
|
2678
2831
|
},
|
2679
2832
|
"default": "0",
|
2680
2833
|
"description": "This property specifies the tab order of the element.",
|
2681
|
-
"
|
2834
|
+
"attribute": "tabIndex",
|
2835
|
+
"reflects": true,
|
2682
2836
|
"inheritedFrom": {
|
2683
2837
|
"name": "TabIndexMixin",
|
2684
|
-
"module": "
|
2838
|
+
"module": "utils/mixins/TabIndexMixin.js"
|
2685
2839
|
}
|
2686
2840
|
},
|
2687
2841
|
{
|
2688
|
-
"
|
2842
|
+
"kind": "field",
|
2843
|
+
"name": "inline",
|
2689
2844
|
"type": {
|
2690
|
-
"text": "boolean
|
2845
|
+
"text": "boolean"
|
2691
2846
|
},
|
2692
|
-
"description": "
|
2693
|
-
"default": "
|
2694
|
-
"
|
2847
|
+
"description": "The link can be inline or standalone.",
|
2848
|
+
"default": "false",
|
2849
|
+
"attribute": "inline",
|
2850
|
+
"reflects": true,
|
2695
2851
|
"inheritedFrom": {
|
2696
|
-
"name": "
|
2697
|
-
"module": "
|
2852
|
+
"name": "Linksimple",
|
2853
|
+
"module": "components/linksimple/linksimple.component.js"
|
2698
2854
|
}
|
2699
2855
|
},
|
2700
2856
|
{
|
2701
|
-
"
|
2857
|
+
"kind": "field",
|
2858
|
+
"name": "inverted",
|
2702
2859
|
"type": {
|
2703
|
-
"text": "boolean
|
2860
|
+
"text": "boolean"
|
2704
2861
|
},
|
2705
|
-
"description": "The
|
2706
|
-
"default": "
|
2707
|
-
"
|
2862
|
+
"description": "The link color can be inverted by setting the inverted attribute to true.",
|
2863
|
+
"default": "false",
|
2864
|
+
"attribute": "inverted",
|
2865
|
+
"reflects": true,
|
2708
2866
|
"inheritedFrom": {
|
2709
|
-
"name": "
|
2710
|
-
"module": "
|
2867
|
+
"name": "Linksimple",
|
2868
|
+
"module": "components/linksimple/linksimple.component.js"
|
2711
2869
|
}
|
2712
2870
|
},
|
2713
2871
|
{
|
2714
|
-
"
|
2872
|
+
"kind": "field",
|
2873
|
+
"name": "href",
|
2715
2874
|
"type": {
|
2716
|
-
"text": "
|
2875
|
+
"text": "string"
|
2717
2876
|
},
|
2718
|
-
"
|
2719
|
-
"
|
2720
|
-
"
|
2877
|
+
"default": "'#'",
|
2878
|
+
"description": "Href for navigation. The URL that the hyperlink points to",
|
2879
|
+
"attribute": "href",
|
2880
|
+
"reflects": true,
|
2721
2881
|
"inheritedFrom": {
|
2722
|
-
"name": "
|
2723
|
-
"module": "
|
2882
|
+
"name": "Linksimple",
|
2883
|
+
"module": "components/linksimple/linksimple.component.js"
|
2724
2884
|
}
|
2725
2885
|
},
|
2726
2886
|
{
|
2727
|
-
"
|
2887
|
+
"kind": "field",
|
2888
|
+
"name": "target",
|
2728
2889
|
"type": {
|
2729
|
-
"text": "string
|
2890
|
+
"text": "string"
|
2730
2891
|
},
|
2731
|
-
"
|
2732
|
-
"
|
2733
|
-
"
|
2892
|
+
"default": "'_self'",
|
2893
|
+
"description": "Optional target: _blank, _self, _parent, _top and _unfencedTop",
|
2894
|
+
"attribute": "target",
|
2895
|
+
"reflects": true,
|
2734
2896
|
"inheritedFrom": {
|
2735
|
-
"name": "
|
2736
|
-
"module": "
|
2897
|
+
"name": "Linksimple",
|
2898
|
+
"module": "components/linksimple/linksimple.component.js"
|
2737
2899
|
}
|
2738
2900
|
},
|
2739
2901
|
{
|
2740
|
-
"
|
2902
|
+
"kind": "field",
|
2903
|
+
"name": "rel",
|
2741
2904
|
"type": {
|
2742
|
-
"text": "
|
2905
|
+
"text": "string | undefined"
|
2743
2906
|
},
|
2744
|
-
"description": "
|
2745
|
-
"
|
2746
|
-
"
|
2907
|
+
"description": "Optional rel attribute that defines the relationship of the linked URL as space-separated link types.",
|
2908
|
+
"attribute": "rel",
|
2909
|
+
"reflects": true,
|
2910
|
+
"inheritedFrom": {
|
2911
|
+
"name": "Linksimple",
|
2912
|
+
"module": "components/linksimple/linksimple.component.js"
|
2913
|
+
}
|
2914
|
+
},
|
2915
|
+
{
|
2916
|
+
"kind": "field",
|
2917
|
+
"name": "handleNavigation",
|
2918
|
+
"privacy": "private",
|
2919
|
+
"inheritedFrom": {
|
2920
|
+
"name": "Linksimple",
|
2921
|
+
"module": "components/linksimple/linksimple.component.js"
|
2922
|
+
}
|
2923
|
+
},
|
2924
|
+
{
|
2925
|
+
"kind": "method",
|
2926
|
+
"name": "setDisabled",
|
2927
|
+
"privacy": "private",
|
2928
|
+
"parameters": [
|
2929
|
+
{
|
2930
|
+
"name": "disabled",
|
2931
|
+
"type": {
|
2932
|
+
"text": "boolean"
|
2933
|
+
},
|
2934
|
+
"description": "Whether the element should be disabled"
|
2935
|
+
}
|
2936
|
+
],
|
2937
|
+
"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.",
|
2747
2938
|
"inheritedFrom": {
|
2748
|
-
"name": "
|
2749
|
-
"module": "
|
2939
|
+
"name": "Linksimple",
|
2940
|
+
"module": "components/linksimple/linksimple.component.js"
|
2750
2941
|
}
|
2751
2942
|
}
|
2752
2943
|
],
|
2753
|
-
"mixins": [
|
2754
|
-
{
|
2755
|
-
"name": "ButtonComponentMixin",
|
2756
|
-
"module": "/src/utils/mixins/ButtonComponentMixin"
|
2757
|
-
}
|
2758
|
-
],
|
2759
|
-
"superclass": {
|
2760
|
-
"name": "Buttonsimple",
|
2761
|
-
"module": "/src/components/buttonsimple/buttonsimple.component"
|
2762
|
-
},
|
2763
|
-
"tagName": "mdc-button",
|
2764
|
-
"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 */",
|
2765
|
-
"customElement": true,
|
2766
2944
|
"events": [
|
2767
2945
|
{
|
2768
|
-
"description": "(React: onClick)
|
2946
|
+
"description": "(React: onClick) Fired when the user activates the buttonLink using a mouse or assistive technology.",
|
2769
2947
|
"name": "click",
|
2770
2948
|
"reactName": "onClick",
|
2771
2949
|
"inheritedFrom": {
|
2772
|
-
"name": "
|
2773
|
-
"module": "src/components/
|
2950
|
+
"name": "Linksimple",
|
2951
|
+
"module": "src/components/linksimple/linksimple.component.ts"
|
2774
2952
|
}
|
2775
2953
|
},
|
2776
2954
|
{
|
2777
|
-
"description": "(React: onKeyDown)
|
2955
|
+
"description": "(React: onKeyDown) Fired when the user presses a key while the buttonLink has focus.",
|
2778
2956
|
"name": "keydown",
|
2779
2957
|
"reactName": "onKeyDown",
|
2780
2958
|
"inheritedFrom": {
|
2781
|
-
"name": "
|
2782
|
-
"module": "src/components/
|
2783
|
-
}
|
2784
|
-
},
|
2785
|
-
{
|
2786
|
-
"description": "(React: onKeyUp) This event is dispatched when a key is released on the button.",
|
2787
|
-
"name": "keyup",
|
2788
|
-
"reactName": "onKeyUp",
|
2789
|
-
"inheritedFrom": {
|
2790
|
-
"name": "Buttonsimple",
|
2791
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
2959
|
+
"name": "Linksimple",
|
2960
|
+
"module": "src/components/linksimple/linksimple.component.ts"
|
2792
2961
|
}
|
2793
2962
|
},
|
2794
2963
|
{
|
2795
|
-
"description": "(React: onFocus)
|
2964
|
+
"description": "(React: onFocus) Fired when the buttonLink receives keyboard or mouse focus.",
|
2796
2965
|
"name": "focus",
|
2797
2966
|
"reactName": "onFocus",
|
2798
2967
|
"inheritedFrom": {
|
2799
|
-
"name": "
|
2800
|
-
"module": "src/components/
|
2968
|
+
"name": "Linksimple",
|
2969
|
+
"module": "src/components/linksimple/linksimple.component.ts"
|
2801
2970
|
}
|
2802
|
-
}
|
2803
|
-
]
|
2804
|
-
}
|
2805
|
-
],
|
2806
|
-
"exports": [
|
2807
|
-
{
|
2808
|
-
"kind": "js",
|
2809
|
-
"name": "default",
|
2810
|
-
"declaration": {
|
2811
|
-
"name": "Button",
|
2812
|
-
"module": "components/button/button.component.js"
|
2813
|
-
}
|
2814
|
-
}
|
2815
|
-
]
|
2816
|
-
},
|
2817
|
-
{
|
2818
|
-
"kind": "javascript-module",
|
2819
|
-
"path": "components/buttongroup/buttongroup.component.js",
|
2820
|
-
"declarations": [
|
2821
|
-
{
|
2822
|
-
"kind": "class",
|
2823
|
-
"description": "buttongroup component, is a styled wrapper for multiple buttons.\nIt can support icon buttons, combination of icon and pill buttons, and text buttons.\nThey are available in horizontal and vertical orientation.",
|
2824
|
-
"name": "ButtonGroup",
|
2825
|
-
"cssProperties": [
|
2826
|
-
{
|
2827
|
-
"description": "The border radius of the buttongroup",
|
2828
|
-
"name": "--mdc-buttongroup-border-radius"
|
2829
|
-
},
|
2830
|
-
{
|
2831
|
-
"description": "The border color of the buttongroup",
|
2832
|
-
"name": "--mdc-buttongroup-border-color"
|
2833
2971
|
},
|
2834
2972
|
{
|
2835
|
-
"description": "
|
2836
|
-
"name": "
|
2973
|
+
"description": "(React: onBlur) Fired when the buttonLink loses keyboard or mouse focus.",
|
2974
|
+
"name": "blur",
|
2975
|
+
"reactName": "onBlur",
|
2976
|
+
"inheritedFrom": {
|
2977
|
+
"name": "Linksimple",
|
2978
|
+
"module": "src/components/linksimple/linksimple.component.ts"
|
2979
|
+
}
|
2837
2980
|
}
|
2838
2981
|
],
|
2839
|
-
"
|
2982
|
+
"attributes": [
|
2840
2983
|
{
|
2841
|
-
"
|
2842
|
-
"
|
2843
|
-
|
2844
|
-
|
2845
|
-
|
2984
|
+
"name": "size",
|
2985
|
+
"type": {
|
2986
|
+
"text": "PillButtonSize | IconButtonSize"
|
2987
|
+
},
|
2988
|
+
"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.",
|
2989
|
+
"default": "32",
|
2990
|
+
"fieldName": "size"
|
2991
|
+
},
|
2846
2992
|
{
|
2847
|
-
"
|
2848
|
-
"name": "orientation",
|
2993
|
+
"name": "soft-disabled",
|
2849
2994
|
"type": {
|
2850
|
-
"text": "
|
2995
|
+
"text": "boolean | undefined"
|
2851
2996
|
},
|
2852
|
-
"description": "
|
2853
|
-
"default": "
|
2854
|
-
"
|
2855
|
-
"reflects": true
|
2997
|
+
"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.",
|
2998
|
+
"default": "undefined",
|
2999
|
+
"fieldName": "softDisabled"
|
2856
3000
|
},
|
2857
3001
|
{
|
2858
|
-
"
|
2859
|
-
"name": "variant",
|
3002
|
+
"name": "prefix-icon",
|
2860
3003
|
"type": {
|
2861
|
-
"text": "
|
3004
|
+
"text": "IconNames | undefined"
|
2862
3005
|
},
|
2863
|
-
"description": "
|
2864
|
-
"
|
2865
|
-
"
|
2866
|
-
|
3006
|
+
"description": "The name of the icon to display as a prefix.\nThe icon is displayed on the left side of the button.",
|
3007
|
+
"fieldName": "prefixIcon",
|
3008
|
+
"inheritedFrom": {
|
3009
|
+
"name": "ButtonComponentMixin",
|
3010
|
+
"module": "src/utils/mixins/ButtonComponentMixin.ts"
|
3011
|
+
}
|
2867
3012
|
},
|
2868
3013
|
{
|
2869
|
-
"
|
2870
|
-
"name": "size",
|
3014
|
+
"name": "postfix-icon",
|
2871
3015
|
"type": {
|
2872
|
-
"text": "
|
3016
|
+
"text": "IconNames | undefined"
|
2873
3017
|
},
|
2874
|
-
"description": "
|
2875
|
-
"
|
2876
|
-
"
|
2877
|
-
|
3018
|
+
"description": "The name of the icon to display as a postfix.\nThe icon is displayed on the right side of the button.",
|
3019
|
+
"fieldName": "postfixIcon",
|
3020
|
+
"inheritedFrom": {
|
3021
|
+
"name": "ButtonComponentMixin",
|
3022
|
+
"module": "src/utils/mixins/ButtonComponentMixin.ts"
|
3023
|
+
}
|
2878
3024
|
},
|
2879
3025
|
{
|
2880
|
-
"
|
2881
|
-
"name": "compact",
|
3026
|
+
"name": "variant",
|
2882
3027
|
"type": {
|
2883
|
-
"text": "
|
3028
|
+
"text": "ButtonVariant"
|
2884
3029
|
},
|
2885
|
-
"
|
2886
|
-
"
|
2887
|
-
"
|
2888
|
-
"
|
2889
|
-
|
2890
|
-
|
2891
|
-
|
3030
|
+
"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.",
|
3031
|
+
"default": "primary",
|
3032
|
+
"fieldName": "variant",
|
3033
|
+
"inheritedFrom": {
|
3034
|
+
"name": "ButtonComponentMixin",
|
3035
|
+
"module": "src/utils/mixins/ButtonComponentMixin.ts"
|
3036
|
+
}
|
3037
|
+
},
|
2892
3038
|
{
|
2893
|
-
"name": "
|
3039
|
+
"name": "color",
|
2894
3040
|
"type": {
|
2895
|
-
"text": "
|
3041
|
+
"text": "ButtonColor"
|
2896
3042
|
},
|
2897
|
-
"description": "
|
2898
|
-
"default": "
|
2899
|
-
"fieldName": "
|
3043
|
+
"description": "There are 5 colors for button: positive, negative, accent, promotional, default.",
|
3044
|
+
"default": "default",
|
3045
|
+
"fieldName": "color",
|
3046
|
+
"inheritedFrom": {
|
3047
|
+
"name": "ButtonComponentMixin",
|
3048
|
+
"module": "src/utils/mixins/ButtonComponentMixin.ts"
|
3049
|
+
}
|
2900
3050
|
},
|
2901
3051
|
{
|
2902
|
-
"name": "
|
3052
|
+
"name": "disabled",
|
2903
3053
|
"type": {
|
2904
|
-
"text": "
|
3054
|
+
"text": "boolean | undefined"
|
2905
3055
|
},
|
2906
|
-
"description": "
|
2907
|
-
"default": "
|
2908
|
-
"fieldName": "
|
3056
|
+
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
3057
|
+
"default": "undefined",
|
3058
|
+
"fieldName": "disabled",
|
3059
|
+
"inheritedFrom": {
|
3060
|
+
"name": "DisabledMixin",
|
3061
|
+
"module": "src/utils/mixins/DisabledMixin.ts"
|
3062
|
+
}
|
2909
3063
|
},
|
2910
3064
|
{
|
2911
|
-
"name": "
|
3065
|
+
"name": "tabIndex",
|
2912
3066
|
"type": {
|
2913
|
-
"text": "
|
3067
|
+
"text": "number"
|
2914
3068
|
},
|
2915
|
-
"
|
2916
|
-
"
|
2917
|
-
"fieldName": "
|
3069
|
+
"default": "0",
|
3070
|
+
"description": "This property specifies the tab order of the element.",
|
3071
|
+
"fieldName": "tabIndex",
|
3072
|
+
"inheritedFrom": {
|
3073
|
+
"name": "TabIndexMixin",
|
3074
|
+
"module": "src/utils/mixins/TabIndexMixin.ts"
|
3075
|
+
}
|
2918
3076
|
},
|
2919
3077
|
{
|
2920
|
-
"name": "
|
3078
|
+
"name": "inline",
|
2921
3079
|
"type": {
|
2922
3080
|
"text": "boolean"
|
2923
3081
|
},
|
3082
|
+
"description": "The link can be inline or standalone.",
|
2924
3083
|
"default": "false",
|
2925
|
-
"
|
2926
|
-
"
|
2927
|
-
|
2928
|
-
|
2929
|
-
|
2930
|
-
|
2931
|
-
"module": "/src/models"
|
2932
|
-
},
|
2933
|
-
"tagName": "mdc-buttongroup",
|
2934
|
-
"jsDoc": "/**\n * buttongroup component, is a styled wrapper for multiple buttons.\n * It can support icon buttons, combination of icon and pill buttons, and text buttons.\n * They are available in horizontal and vertical orientation.\n *\n * @tagname mdc-buttongroup\n *\n * @slot default - This is a default/unnamed slot, which contains the buttons\n *\n * @cssproperty --mdc-buttongroup-border-radius - The border radius of the buttongroup\n * @cssproperty --mdc-buttongroup-border-color - The border color of the buttongroup\n * @cssproperty --mdc-buttongroup-divider-color - The color of the divider between buttons within the buttongroup\n */",
|
2935
|
-
"customElement": true
|
2936
|
-
}
|
2937
|
-
],
|
2938
|
-
"exports": [
|
2939
|
-
{
|
2940
|
-
"kind": "js",
|
2941
|
-
"name": "default",
|
2942
|
-
"declaration": {
|
2943
|
-
"name": "ButtonGroup",
|
2944
|
-
"module": "components/buttongroup/buttongroup.component.js"
|
2945
|
-
}
|
2946
|
-
}
|
2947
|
-
]
|
2948
|
-
},
|
2949
|
-
{
|
2950
|
-
"kind": "javascript-module",
|
2951
|
-
"path": "components/buttonlink/buttonlink.component.js",
|
2952
|
-
"declarations": [
|
2953
|
-
{
|
2954
|
-
"kind": "class",
|
2955
|
-
"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`.",
|
2956
|
-
"name": "ButtonLink",
|
2957
|
-
"members": [
|
3084
|
+
"fieldName": "inline",
|
3085
|
+
"inheritedFrom": {
|
3086
|
+
"name": "Linksimple",
|
3087
|
+
"module": "src/components/linksimple/linksimple.component.ts"
|
3088
|
+
}
|
3089
|
+
},
|
2958
3090
|
{
|
2959
|
-
"
|
2960
|
-
"name": "size",
|
3091
|
+
"name": "inverted",
|
2961
3092
|
"type": {
|
2962
|
-
"text": "
|
3093
|
+
"text": "boolean"
|
2963
3094
|
},
|
2964
|
-
"description": "
|
2965
|
-
"default": "
|
2966
|
-
"
|
2967
|
-
"
|
3095
|
+
"description": "The link color can be inverted by setting the inverted attribute to true.",
|
3096
|
+
"default": "false",
|
3097
|
+
"fieldName": "inverted",
|
3098
|
+
"inheritedFrom": {
|
3099
|
+
"name": "Linksimple",
|
3100
|
+
"module": "src/components/linksimple/linksimple.component.ts"
|
3101
|
+
}
|
2968
3102
|
},
|
2969
3103
|
{
|
2970
|
-
"
|
2971
|
-
"name": "softDisabled",
|
3104
|
+
"name": "href",
|
2972
3105
|
"type": {
|
2973
|
-
"text": "
|
3106
|
+
"text": "string"
|
2974
3107
|
},
|
2975
|
-
"
|
2976
|
-
"
|
2977
|
-
"
|
2978
|
-
"
|
2979
|
-
|
2980
|
-
|
2981
|
-
|
2982
|
-
"name": "setSoftDisabled",
|
2983
|
-
"privacy": "private",
|
2984
|
-
"parameters": [
|
2985
|
-
{
|
2986
|
-
"name": "element",
|
2987
|
-
"type": {
|
2988
|
-
"text": "HTMLElement"
|
2989
|
-
},
|
2990
|
-
"description": "The buttonlink element."
|
2991
|
-
},
|
2992
|
-
{
|
2993
|
-
"name": "softDisabled",
|
2994
|
-
"optional": true,
|
2995
|
-
"type": {
|
2996
|
-
"text": "boolean"
|
2997
|
-
},
|
2998
|
-
"description": "The soft-disabled state."
|
2999
|
-
}
|
3000
|
-
],
|
3001
|
-
"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."
|
3108
|
+
"default": "'#'",
|
3109
|
+
"description": "Href for navigation. The URL that the hyperlink points to",
|
3110
|
+
"fieldName": "href",
|
3111
|
+
"inheritedFrom": {
|
3112
|
+
"name": "Linksimple",
|
3113
|
+
"module": "src/components/linksimple/linksimple.component.ts"
|
3114
|
+
}
|
3002
3115
|
},
|
3003
3116
|
{
|
3004
|
-
"
|
3005
|
-
"name": "prefixIcon",
|
3117
|
+
"name": "target",
|
3006
3118
|
"type": {
|
3007
|
-
"text": "
|
3119
|
+
"text": "string"
|
3008
3120
|
},
|
3009
|
-
"
|
3010
|
-
"
|
3011
|
-
"
|
3121
|
+
"default": "'_self'",
|
3122
|
+
"description": "Optional target: _blank, _self, _parent, _top and _unfencedTop",
|
3123
|
+
"fieldName": "target",
|
3012
3124
|
"inheritedFrom": {
|
3013
|
-
"name": "
|
3014
|
-
"module": "
|
3125
|
+
"name": "Linksimple",
|
3126
|
+
"module": "src/components/linksimple/linksimple.component.ts"
|
3015
3127
|
}
|
3016
3128
|
},
|
3017
3129
|
{
|
3018
|
-
"
|
3019
|
-
"name": "postfixIcon",
|
3130
|
+
"name": "rel",
|
3020
3131
|
"type": {
|
3021
|
-
"text": "
|
3132
|
+
"text": "string | undefined"
|
3022
3133
|
},
|
3023
|
-
"description": "
|
3024
|
-
"
|
3025
|
-
"reflects": true,
|
3134
|
+
"description": "Optional rel attribute that defines the relationship of the linked URL as space-separated link types.",
|
3135
|
+
"fieldName": "rel",
|
3026
3136
|
"inheritedFrom": {
|
3027
|
-
"name": "
|
3028
|
-
"module": "
|
3137
|
+
"name": "Linksimple",
|
3138
|
+
"module": "src/components/linksimple/linksimple.component.ts"
|
3139
|
+
}
|
3140
|
+
}
|
3141
|
+
],
|
3142
|
+
"mixins": [
|
3143
|
+
{
|
3144
|
+
"name": "ButtonComponentMixin",
|
3145
|
+
"module": "/src/utils/mixins/ButtonComponentMixin"
|
3146
|
+
}
|
3147
|
+
],
|
3148
|
+
"superclass": {
|
3149
|
+
"name": "Linksimple",
|
3150
|
+
"module": "/src/components/linksimple/linksimple.component"
|
3151
|
+
},
|
3152
|
+
"tagName": "mdc-buttonlink",
|
3153
|
+
"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 */",
|
3154
|
+
"customElement": true,
|
3155
|
+
"cssProperties": [
|
3156
|
+
{
|
3157
|
+
"description": "Border radius of the link.",
|
3158
|
+
"name": "--mdc-link-border-radius",
|
3159
|
+
"inheritedFrom": {
|
3160
|
+
"name": "Linksimple",
|
3161
|
+
"module": "src/components/linksimple/linksimple.component.ts"
|
3029
3162
|
}
|
3030
3163
|
},
|
3031
3164
|
{
|
3032
|
-
"
|
3033
|
-
"name": "
|
3034
|
-
"type": {
|
3035
|
-
"text": "ButtonVariant"
|
3036
|
-
},
|
3037
|
-
"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.",
|
3038
|
-
"default": "primary",
|
3039
|
-
"attribute": "variant",
|
3165
|
+
"description": "Color of the link’s child content in the active state.",
|
3166
|
+
"name": "--mdc-link-color-active",
|
3040
3167
|
"inheritedFrom": {
|
3041
|
-
"name": "
|
3042
|
-
"module": "
|
3168
|
+
"name": "Linksimple",
|
3169
|
+
"module": "src/components/linksimple/linksimple.component.ts"
|
3043
3170
|
}
|
3044
3171
|
},
|
3045
3172
|
{
|
3046
|
-
"
|
3047
|
-
"name": "color",
|
3048
|
-
"type": {
|
3049
|
-
"text": "ButtonColor"
|
3050
|
-
},
|
3051
|
-
"description": "There are 5 colors for button: positive, negative, accent, promotional, default.",
|
3052
|
-
"default": "default",
|
3053
|
-
"attribute": "color",
|
3173
|
+
"description": "Color of the link’s child content in the disabled state.",
|
3174
|
+
"name": "--mdc-link-color-disabled",
|
3054
3175
|
"inheritedFrom": {
|
3055
|
-
"name": "
|
3056
|
-
"module": "
|
3176
|
+
"name": "Linksimple",
|
3177
|
+
"module": "src/components/linksimple/linksimple.component.ts"
|
3057
3178
|
}
|
3058
3179
|
},
|
3059
3180
|
{
|
3060
|
-
"
|
3061
|
-
"name": "
|
3062
|
-
"privacy": "protected",
|
3063
|
-
"parameters": [
|
3064
|
-
{
|
3065
|
-
"name": "variant",
|
3066
|
-
"type": {
|
3067
|
-
"text": "ButtonVariant"
|
3068
|
-
},
|
3069
|
-
"description": "The variant to set."
|
3070
|
-
}
|
3071
|
-
],
|
3072
|
-
"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.",
|
3181
|
+
"description": "Color of the link’s child content in the hover state.",
|
3182
|
+
"name": "--mdc-link-color-hover",
|
3073
3183
|
"inheritedFrom": {
|
3074
|
-
"name": "
|
3075
|
-
"module": "
|
3184
|
+
"name": "Linksimple",
|
3185
|
+
"module": "src/components/linksimple/linksimple.component.ts"
|
3076
3186
|
}
|
3077
3187
|
},
|
3078
3188
|
{
|
3079
|
-
"
|
3080
|
-
"name": "
|
3081
|
-
"privacy": "protected",
|
3082
|
-
"parameters": [
|
3083
|
-
{
|
3084
|
-
"name": "color",
|
3085
|
-
"type": {
|
3086
|
-
"text": "ButtonColor"
|
3087
|
-
},
|
3088
|
-
"description": "The color to set."
|
3089
|
-
}
|
3090
|
-
],
|
3091
|
-
"description": "Sets the color attribute for the button.\nDefaults to DEFAULTS.COLOR if invalid or for tertiary button.",
|
3189
|
+
"description": "Color of the link’s child content in the normal state.",
|
3190
|
+
"name": "--mdc-link-color-normal",
|
3092
3191
|
"inheritedFrom": {
|
3093
|
-
"name": "
|
3094
|
-
"module": "
|
3192
|
+
"name": "Linksimple",
|
3193
|
+
"module": "src/components/linksimple/linksimple.component.ts"
|
3095
3194
|
}
|
3096
3195
|
},
|
3097
3196
|
{
|
3098
|
-
"
|
3099
|
-
"name": "
|
3100
|
-
"privacy": "protected",
|
3101
|
-
"parameters": [
|
3102
|
-
{
|
3103
|
-
"name": "size",
|
3104
|
-
"type": {
|
3105
|
-
"text": "PillButtonSize | IconButtonSize"
|
3106
|
-
},
|
3107
|
-
"description": "The size to set."
|
3108
|
-
}
|
3109
|
-
],
|
3110
|
-
"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.",
|
3197
|
+
"description": "Color of the inverted link’s child content in the active state.",
|
3198
|
+
"name": "--mdc-link-inverted-color-active",
|
3111
3199
|
"inheritedFrom": {
|
3112
|
-
"name": "
|
3113
|
-
"module": "
|
3200
|
+
"name": "Linksimple",
|
3201
|
+
"module": "src/components/linksimple/linksimple.component.ts"
|
3114
3202
|
}
|
3115
3203
|
},
|
3116
3204
|
{
|
3117
|
-
"
|
3118
|
-
"name": "
|
3119
|
-
"
|
3120
|
-
|
3121
|
-
|
3122
|
-
|
3123
|
-
|
3124
|
-
|
3125
|
-
|
3126
|
-
|
3127
|
-
"inheritedFrom": {
|
3128
|
-
"name": "
|
3129
|
-
"module": "
|
3130
|
-
}
|
3205
|
+
"description": "Color of the inverted link’s child content in the disabled state.",
|
3206
|
+
"name": "--mdc-link-inverted-color-disabled",
|
3207
|
+
"inheritedFrom": {
|
3208
|
+
"name": "Linksimple",
|
3209
|
+
"module": "src/components/linksimple/linksimple.component.ts"
|
3210
|
+
}
|
3211
|
+
},
|
3212
|
+
{
|
3213
|
+
"description": "Color of the inverted link’s child content in the hover state.",
|
3214
|
+
"name": "--mdc-link-inverted-color-hover",
|
3215
|
+
"inheritedFrom": {
|
3216
|
+
"name": "Linksimple",
|
3217
|
+
"module": "src/components/linksimple/linksimple.component.ts"
|
3218
|
+
}
|
3219
|
+
},
|
3220
|
+
{
|
3221
|
+
"description": "Color of the inverted link’s child content in the normal state.",
|
3222
|
+
"name": "--mdc-link-inverted-color-normal",
|
3223
|
+
"inheritedFrom": {
|
3224
|
+
"name": "Linksimple",
|
3225
|
+
"module": "src/components/linksimple/linksimple.component.ts"
|
3226
|
+
}
|
3227
|
+
}
|
3228
|
+
]
|
3229
|
+
}
|
3230
|
+
],
|
3231
|
+
"exports": [
|
3232
|
+
{
|
3233
|
+
"kind": "js",
|
3234
|
+
"name": "default",
|
3235
|
+
"declaration": {
|
3236
|
+
"name": "ButtonLink",
|
3237
|
+
"module": "components/buttonlink/buttonlink.component.js"
|
3238
|
+
}
|
3239
|
+
}
|
3240
|
+
]
|
3241
|
+
},
|
3242
|
+
{
|
3243
|
+
"kind": "javascript-module",
|
3244
|
+
"path": "components/badge/badge.component.js",
|
3245
|
+
"declarations": [
|
3246
|
+
{
|
3247
|
+
"kind": "class",
|
3248
|
+
"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.",
|
3249
|
+
"name": "Badge",
|
3250
|
+
"cssProperties": [
|
3251
|
+
{
|
3252
|
+
"description": "The foreground color of the primary badge.",
|
3253
|
+
"name": "--mdc-badge-primary-foreground-color"
|
3254
|
+
},
|
3255
|
+
{
|
3256
|
+
"description": "The background color of the primary badge.",
|
3257
|
+
"name": "--mdc-badge-primary-background-color"
|
3258
|
+
},
|
3259
|
+
{
|
3260
|
+
"description": "The foreground color of the secondary badge.",
|
3261
|
+
"name": "--mdc-badge-secondary-foreground-color"
|
3262
|
+
},
|
3263
|
+
{
|
3264
|
+
"description": "The background color of the secondary badge.",
|
3265
|
+
"name": "--mdc-badge-secondary-background-color"
|
3266
|
+
},
|
3267
|
+
{
|
3268
|
+
"description": "The foreground color of the success badge.",
|
3269
|
+
"name": "--mdc-badge-success-foreground-color"
|
3270
|
+
},
|
3271
|
+
{
|
3272
|
+
"description": "The background color of the success badge.",
|
3273
|
+
"name": "--mdc-badge-success-background-color"
|
3131
3274
|
},
|
3132
3275
|
{
|
3133
|
-
"
|
3134
|
-
"name": "
|
3135
|
-
|
3136
|
-
|
3137
|
-
|
3138
|
-
"
|
3139
|
-
|
3140
|
-
|
3141
|
-
"
|
3142
|
-
"
|
3143
|
-
|
3144
|
-
|
3145
|
-
|
3276
|
+
"description": "The foreground color of the warning badge.",
|
3277
|
+
"name": "--mdc-badge-warning-foreground-color"
|
3278
|
+
},
|
3279
|
+
{
|
3280
|
+
"description": "The background color of the warning badge.",
|
3281
|
+
"name": "--mdc-badge-warning-background-color"
|
3282
|
+
},
|
3283
|
+
{
|
3284
|
+
"description": "The foreground color of the error badge.",
|
3285
|
+
"name": "--mdc-badge-error-foreground-color"
|
3286
|
+
},
|
3287
|
+
{
|
3288
|
+
"description": "The background color of the error badge.",
|
3289
|
+
"name": "--mdc-badge-error-background-color"
|
3146
3290
|
},
|
3291
|
+
{
|
3292
|
+
"description": "The background color of the badge overlay.",
|
3293
|
+
"name": "--mdc-badge-overlay-background-color"
|
3294
|
+
}
|
3295
|
+
],
|
3296
|
+
"members": [
|
3147
3297
|
{
|
3148
3298
|
"kind": "field",
|
3149
|
-
"name": "
|
3299
|
+
"name": "type",
|
3150
3300
|
"type": {
|
3151
|
-
"text": "
|
3301
|
+
"text": "BadgeType | undefined"
|
3152
3302
|
},
|
3153
|
-
"
|
3154
|
-
"
|
3155
|
-
"
|
3156
|
-
"reflects": true,
|
3157
|
-
"inheritedFrom": {
|
3158
|
-
"name": "TabIndexMixin",
|
3159
|
-
"module": "utils/mixins/TabIndexMixin.js"
|
3160
|
-
}
|
3303
|
+
"description": "Type of the badge\nCan be `dot` (notification) , `icon`, `counter`, `success`, `warning` or `error`.",
|
3304
|
+
"attribute": "type",
|
3305
|
+
"reflects": true
|
3161
3306
|
},
|
3162
3307
|
{
|
3163
3308
|
"kind": "field",
|
3164
|
-
"name": "
|
3309
|
+
"name": "variant",
|
3165
3310
|
"type": {
|
3166
|
-
"text": "
|
3311
|
+
"text": "IconVariant"
|
3167
3312
|
},
|
3168
|
-
"description": "
|
3169
|
-
"default": "
|
3170
|
-
"attribute": "
|
3171
|
-
"reflects": true
|
3172
|
-
"inheritedFrom": {
|
3173
|
-
"name": "Linksimple",
|
3174
|
-
"module": "components/linksimple/linksimple.component.js"
|
3175
|
-
}
|
3313
|
+
"description": "Type of the variant can be `primary` or `secondary`.\nIt defines the background and foreground color of the icon.",
|
3314
|
+
"default": "primary",
|
3315
|
+
"attribute": "variant",
|
3316
|
+
"reflects": true
|
3176
3317
|
},
|
3177
3318
|
{
|
3178
3319
|
"kind": "field",
|
3179
|
-
"name": "
|
3320
|
+
"name": "counter",
|
3180
3321
|
"type": {
|
3181
|
-
"text": "
|
3322
|
+
"text": "number | undefined"
|
3182
3323
|
},
|
3183
|
-
"description": "
|
3184
|
-
"
|
3185
|
-
"attribute": "inverted",
|
3186
|
-
"reflects": true,
|
3187
|
-
"inheritedFrom": {
|
3188
|
-
"name": "Linksimple",
|
3189
|
-
"module": "components/linksimple/linksimple.component.js"
|
3190
|
-
}
|
3324
|
+
"description": "Counter is the number which can be provided in the badge.",
|
3325
|
+
"attribute": "counter"
|
3191
3326
|
},
|
3192
3327
|
{
|
3193
3328
|
"kind": "field",
|
3194
|
-
"name": "
|
3329
|
+
"name": "maxCounter",
|
3195
3330
|
"type": {
|
3196
|
-
"text": "
|
3331
|
+
"text": "number"
|
3197
3332
|
},
|
3198
|
-
"
|
3199
|
-
"
|
3200
|
-
"attribute": "
|
3201
|
-
"reflects": true
|
3202
|
-
"inheritedFrom": {
|
3203
|
-
"name": "Linksimple",
|
3204
|
-
"module": "components/linksimple/linksimple.component.js"
|
3205
|
-
}
|
3333
|
+
"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`.",
|
3334
|
+
"default": "99",
|
3335
|
+
"attribute": "max-counter",
|
3336
|
+
"reflects": true
|
3206
3337
|
},
|
3207
3338
|
{
|
3208
3339
|
"kind": "field",
|
3209
|
-
"name": "
|
3340
|
+
"name": "overlay",
|
3210
3341
|
"type": {
|
3211
|
-
"text": "
|
3342
|
+
"text": "boolean"
|
3212
3343
|
},
|
3213
|
-
"default": "
|
3214
|
-
"description": "
|
3215
|
-
"attribute": "
|
3216
|
-
"reflects": true,
|
3217
|
-
"inheritedFrom": {
|
3218
|
-
"name": "Linksimple",
|
3219
|
-
"module": "components/linksimple/linksimple.component.js"
|
3220
|
-
}
|
3344
|
+
"default": "false",
|
3345
|
+
"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.",
|
3346
|
+
"attribute": "overlay"
|
3221
3347
|
},
|
3222
3348
|
{
|
3223
3349
|
"kind": "field",
|
3224
|
-
"name": "
|
3350
|
+
"name": "ariaLabel",
|
3225
3351
|
"type": {
|
3226
|
-
"text": "string |
|
3352
|
+
"text": "string | null"
|
3227
3353
|
},
|
3228
|
-
"
|
3229
|
-
"
|
3230
|
-
"
|
3231
|
-
"inheritedFrom": {
|
3232
|
-
"name": "Linksimple",
|
3233
|
-
"module": "components/linksimple/linksimple.component.js"
|
3234
|
-
}
|
3354
|
+
"default": "null",
|
3355
|
+
"description": "Aria-label attribute to be set for accessibility",
|
3356
|
+
"attribute": "aria-label"
|
3235
3357
|
},
|
3236
3358
|
{
|
3237
|
-
"kind": "
|
3238
|
-
"name": "
|
3359
|
+
"kind": "method",
|
3360
|
+
"name": "getCounterText",
|
3239
3361
|
"privacy": "private",
|
3240
|
-
"
|
3241
|
-
"
|
3242
|
-
|
3243
|
-
|
3362
|
+
"return": {
|
3363
|
+
"type": {
|
3364
|
+
"text": ""
|
3365
|
+
}
|
3366
|
+
},
|
3367
|
+
"parameters": [
|
3368
|
+
{
|
3369
|
+
"name": "maxCounter",
|
3370
|
+
"type": {
|
3371
|
+
"text": "number"
|
3372
|
+
},
|
3373
|
+
"description": "the maximum limit which can be displayed on the badge"
|
3374
|
+
},
|
3375
|
+
{
|
3376
|
+
"name": "counter",
|
3377
|
+
"optional": true,
|
3378
|
+
"type": {
|
3379
|
+
"text": "number"
|
3380
|
+
},
|
3381
|
+
"description": "the number to be displayed on the badge"
|
3382
|
+
}
|
3383
|
+
],
|
3384
|
+
"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."
|
3244
3385
|
},
|
3245
3386
|
{
|
3246
3387
|
"kind": "method",
|
3247
|
-
"name": "
|
3388
|
+
"name": "getBadgeIcon",
|
3248
3389
|
"privacy": "private",
|
3390
|
+
"return": {
|
3391
|
+
"type": {
|
3392
|
+
"text": ""
|
3393
|
+
}
|
3394
|
+
},
|
3249
3395
|
"parameters": [
|
3250
3396
|
{
|
3251
|
-
"name": "
|
3397
|
+
"name": "iconName",
|
3252
3398
|
"type": {
|
3253
|
-
"text": "
|
3399
|
+
"text": "string"
|
3254
3400
|
},
|
3255
|
-
"description": "
|
3401
|
+
"description": "the name of the icon from the icon set"
|
3402
|
+
},
|
3403
|
+
{
|
3404
|
+
"name": "backgroundClassPostfix",
|
3405
|
+
"type": {
|
3406
|
+
"text": "string"
|
3407
|
+
},
|
3408
|
+
"description": "postfix for the class to style the badge icon."
|
3256
3409
|
}
|
3257
3410
|
],
|
3258
|
-
"description": "
|
3259
|
-
"inheritedFrom": {
|
3260
|
-
"name": "Linksimple",
|
3261
|
-
"module": "components/linksimple/linksimple.component.js"
|
3262
|
-
}
|
3263
|
-
}
|
3264
|
-
],
|
3265
|
-
"events": [
|
3266
|
-
{
|
3267
|
-
"description": "(React: onClick) Fired when the user activates the buttonLink using a mouse or assistive technology.",
|
3268
|
-
"name": "click",
|
3269
|
-
"reactName": "onClick",
|
3270
|
-
"inheritedFrom": {
|
3271
|
-
"name": "Linksimple",
|
3272
|
-
"module": "src/components/linksimple/linksimple.component.ts"
|
3273
|
-
}
|
3274
|
-
},
|
3275
|
-
{
|
3276
|
-
"description": "(React: onKeyDown) Fired when the user presses a key while the buttonLink has focus.",
|
3277
|
-
"name": "keydown",
|
3278
|
-
"reactName": "onKeyDown",
|
3279
|
-
"inheritedFrom": {
|
3280
|
-
"name": "Linksimple",
|
3281
|
-
"module": "src/components/linksimple/linksimple.component.ts"
|
3282
|
-
}
|
3411
|
+
"description": "Method to generate the badge icon."
|
3283
3412
|
},
|
3284
3413
|
{
|
3285
|
-
"
|
3286
|
-
"name": "
|
3287
|
-
"
|
3288
|
-
"
|
3289
|
-
"
|
3290
|
-
|
3291
|
-
|
3414
|
+
"kind": "method",
|
3415
|
+
"name": "getBadgeDot",
|
3416
|
+
"privacy": "private",
|
3417
|
+
"return": {
|
3418
|
+
"type": {
|
3419
|
+
"text": ""
|
3420
|
+
}
|
3421
|
+
},
|
3422
|
+
"description": "Method to generate the badge dot template."
|
3292
3423
|
},
|
3293
3424
|
{
|
3294
|
-
"
|
3295
|
-
"name": "
|
3296
|
-
"
|
3297
|
-
"
|
3298
|
-
"
|
3299
|
-
|
3300
|
-
|
3301
|
-
}
|
3302
|
-
],
|
3303
|
-
"attributes": [
|
3304
|
-
{
|
3305
|
-
"name": "size",
|
3306
|
-
"type": {
|
3307
|
-
"text": "PillButtonSize | IconButtonSize"
|
3425
|
+
"kind": "method",
|
3426
|
+
"name": "getBadgeCounterText",
|
3427
|
+
"privacy": "private",
|
3428
|
+
"return": {
|
3429
|
+
"type": {
|
3430
|
+
"text": ""
|
3431
|
+
}
|
3308
3432
|
},
|
3309
|
-
"description": "
|
3310
|
-
"default": "32",
|
3311
|
-
"fieldName": "size"
|
3433
|
+
"description": "Method to generate the badge text and counter template."
|
3312
3434
|
},
|
3313
3435
|
{
|
3314
|
-
"
|
3315
|
-
"
|
3316
|
-
|
3436
|
+
"kind": "method",
|
3437
|
+
"name": "setRoleByAriaLabel",
|
3438
|
+
"privacy": "private",
|
3439
|
+
"return": {
|
3440
|
+
"type": {
|
3441
|
+
"text": "void"
|
3442
|
+
}
|
3317
3443
|
},
|
3318
|
-
"description": "
|
3319
|
-
"default": "undefined",
|
3320
|
-
"fieldName": "softDisabled"
|
3444
|
+
"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."
|
3321
3445
|
},
|
3322
3446
|
{
|
3323
|
-
"
|
3324
|
-
"
|
3325
|
-
|
3447
|
+
"kind": "method",
|
3448
|
+
"name": "getBadgeContentBasedOnType",
|
3449
|
+
"privacy": "private",
|
3450
|
+
"return": {
|
3451
|
+
"type": {
|
3452
|
+
"text": ""
|
3453
|
+
}
|
3326
3454
|
},
|
3327
|
-
"description": "
|
3328
|
-
"fieldName": "prefixIcon",
|
3329
|
-
"inheritedFrom": {
|
3330
|
-
"name": "ButtonComponentMixin",
|
3331
|
-
"module": "src/utils/mixins/ButtonComponentMixin.ts"
|
3332
|
-
}
|
3455
|
+
"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."
|
3333
3456
|
},
|
3334
3457
|
{
|
3335
|
-
"
|
3458
|
+
"kind": "field",
|
3459
|
+
"name": "iconName",
|
3336
3460
|
"type": {
|
3337
3461
|
"text": "IconNames | undefined"
|
3338
3462
|
},
|
3339
|
-
"description": "
|
3340
|
-
"
|
3463
|
+
"description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
|
3464
|
+
"attribute": "icon-name",
|
3341
3465
|
"inheritedFrom": {
|
3342
|
-
"name": "
|
3343
|
-
"module": "
|
3466
|
+
"name": "IconNameMixin",
|
3467
|
+
"module": "utils/mixins/IconNameMixin.js"
|
3344
3468
|
}
|
3345
|
-
}
|
3469
|
+
}
|
3470
|
+
],
|
3471
|
+
"attributes": [
|
3346
3472
|
{
|
3347
|
-
"name": "
|
3473
|
+
"name": "type",
|
3348
3474
|
"type": {
|
3349
|
-
"text": "
|
3475
|
+
"text": "BadgeType | undefined"
|
3350
3476
|
},
|
3351
|
-
"description": "
|
3352
|
-
"
|
3353
|
-
"fieldName": "variant",
|
3354
|
-
"inheritedFrom": {
|
3355
|
-
"name": "ButtonComponentMixin",
|
3356
|
-
"module": "src/utils/mixins/ButtonComponentMixin.ts"
|
3357
|
-
}
|
3477
|
+
"description": "Type of the badge\nCan be `dot` (notification) , `icon`, `counter`, `success`, `warning` or `error`.",
|
3478
|
+
"fieldName": "type"
|
3358
3479
|
},
|
3359
3480
|
{
|
3360
|
-
"name": "
|
3481
|
+
"name": "variant",
|
3361
3482
|
"type": {
|
3362
|
-
"text": "
|
3483
|
+
"text": "IconVariant"
|
3363
3484
|
},
|
3364
|
-
"description": "
|
3365
|
-
"default": "
|
3366
|
-
"fieldName": "
|
3367
|
-
"inheritedFrom": {
|
3368
|
-
"name": "ButtonComponentMixin",
|
3369
|
-
"module": "src/utils/mixins/ButtonComponentMixin.ts"
|
3370
|
-
}
|
3485
|
+
"description": "Type of the variant can be `primary` or `secondary`.\nIt defines the background and foreground color of the icon.",
|
3486
|
+
"default": "primary",
|
3487
|
+
"fieldName": "variant"
|
3371
3488
|
},
|
3372
3489
|
{
|
3373
|
-
"name": "
|
3490
|
+
"name": "counter",
|
3374
3491
|
"type": {
|
3375
|
-
"text": "
|
3492
|
+
"text": "number | undefined"
|
3376
3493
|
},
|
3377
|
-
"description": "
|
3378
|
-
"
|
3379
|
-
"fieldName": "disabled",
|
3380
|
-
"inheritedFrom": {
|
3381
|
-
"name": "DisabledMixin",
|
3382
|
-
"module": "src/utils/mixins/DisabledMixin.ts"
|
3383
|
-
}
|
3494
|
+
"description": "Counter is the number which can be provided in the badge.",
|
3495
|
+
"fieldName": "counter"
|
3384
3496
|
},
|
3385
3497
|
{
|
3386
|
-
"name": "
|
3498
|
+
"name": "max-counter",
|
3387
3499
|
"type": {
|
3388
3500
|
"text": "number"
|
3389
3501
|
},
|
3390
|
-
"
|
3391
|
-
"
|
3392
|
-
"fieldName": "
|
3393
|
-
"inheritedFrom": {
|
3394
|
-
"name": "TabIndexMixin",
|
3395
|
-
"module": "src/utils/mixins/TabIndexMixin.ts"
|
3396
|
-
}
|
3397
|
-
},
|
3398
|
-
{
|
3399
|
-
"name": "inline",
|
3400
|
-
"type": {
|
3401
|
-
"text": "boolean"
|
3402
|
-
},
|
3403
|
-
"description": "The link can be inline or standalone.",
|
3404
|
-
"default": "false",
|
3405
|
-
"fieldName": "inline",
|
3406
|
-
"inheritedFrom": {
|
3407
|
-
"name": "Linksimple",
|
3408
|
-
"module": "src/components/linksimple/linksimple.component.ts"
|
3409
|
-
}
|
3502
|
+
"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`.",
|
3503
|
+
"default": "99",
|
3504
|
+
"fieldName": "maxCounter"
|
3410
3505
|
},
|
3411
3506
|
{
|
3412
|
-
"name": "
|
3507
|
+
"name": "overlay",
|
3413
3508
|
"type": {
|
3414
3509
|
"text": "boolean"
|
3415
3510
|
},
|
3416
|
-
"description": "The link color can be inverted by setting the inverted attribute to true.",
|
3417
3511
|
"default": "false",
|
3418
|
-
"
|
3419
|
-
"
|
3420
|
-
"name": "Linksimple",
|
3421
|
-
"module": "src/components/linksimple/linksimple.component.ts"
|
3422
|
-
}
|
3423
|
-
},
|
3424
|
-
{
|
3425
|
-
"name": "href",
|
3426
|
-
"type": {
|
3427
|
-
"text": "string"
|
3428
|
-
},
|
3429
|
-
"default": "'#'",
|
3430
|
-
"description": "Href for navigation. The URL that the hyperlink points to",
|
3431
|
-
"fieldName": "href",
|
3432
|
-
"inheritedFrom": {
|
3433
|
-
"name": "Linksimple",
|
3434
|
-
"module": "src/components/linksimple/linksimple.component.ts"
|
3435
|
-
}
|
3512
|
+
"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.",
|
3513
|
+
"fieldName": "overlay"
|
3436
3514
|
},
|
3437
3515
|
{
|
3438
|
-
"name": "
|
3516
|
+
"name": "aria-label",
|
3439
3517
|
"type": {
|
3440
|
-
"text": "string"
|
3518
|
+
"text": "string | null"
|
3441
3519
|
},
|
3442
|
-
"default": "
|
3443
|
-
"description": "
|
3444
|
-
"fieldName": "
|
3445
|
-
"inheritedFrom": {
|
3446
|
-
"name": "Linksimple",
|
3447
|
-
"module": "src/components/linksimple/linksimple.component.ts"
|
3448
|
-
}
|
3520
|
+
"default": "null",
|
3521
|
+
"description": "Aria-label attribute to be set for accessibility",
|
3522
|
+
"fieldName": "ariaLabel"
|
3449
3523
|
},
|
3450
3524
|
{
|
3451
|
-
"name": "
|
3525
|
+
"name": "icon-name",
|
3452
3526
|
"type": {
|
3453
|
-
"text": "
|
3527
|
+
"text": "IconNames | undefined"
|
3454
3528
|
},
|
3455
|
-
"description": "
|
3456
|
-
"fieldName": "
|
3529
|
+
"description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
|
3530
|
+
"fieldName": "iconName",
|
3457
3531
|
"inheritedFrom": {
|
3458
|
-
"name": "
|
3459
|
-
"module": "src/
|
3532
|
+
"name": "IconNameMixin",
|
3533
|
+
"module": "src/utils/mixins/IconNameMixin.ts"
|
3460
3534
|
}
|
3461
3535
|
}
|
3462
3536
|
],
|
3463
3537
|
"mixins": [
|
3464
3538
|
{
|
3465
|
-
"name": "
|
3466
|
-
"module": "/src/utils/mixins/
|
3539
|
+
"name": "IconNameMixin",
|
3540
|
+
"module": "/src/utils/mixins/IconNameMixin"
|
3467
3541
|
}
|
3468
3542
|
],
|
3469
3543
|
"superclass": {
|
3470
|
-
"name": "
|
3471
|
-
"module": "/src/
|
3544
|
+
"name": "Component",
|
3545
|
+
"module": "/src/models"
|
3472
3546
|
},
|
3473
|
-
"tagName": "mdc-
|
3474
|
-
"jsDoc": "/**\n * `mdc-
|
3475
|
-
"customElement": true
|
3476
|
-
"cssProperties": [
|
3477
|
-
{
|
3478
|
-
"description": "Border radius of the link.",
|
3479
|
-
"name": "--mdc-link-border-radius",
|
3480
|
-
"inheritedFrom": {
|
3481
|
-
"name": "Linksimple",
|
3482
|
-
"module": "src/components/linksimple/linksimple.component.ts"
|
3483
|
-
}
|
3484
|
-
},
|
3485
|
-
{
|
3486
|
-
"description": "Color of the link’s child content in the active state.",
|
3487
|
-
"name": "--mdc-link-color-active",
|
3488
|
-
"inheritedFrom": {
|
3489
|
-
"name": "Linksimple",
|
3490
|
-
"module": "src/components/linksimple/linksimple.component.ts"
|
3491
|
-
}
|
3492
|
-
},
|
3493
|
-
{
|
3494
|
-
"description": "Color of the link’s child content in the disabled state.",
|
3495
|
-
"name": "--mdc-link-color-disabled",
|
3496
|
-
"inheritedFrom": {
|
3497
|
-
"name": "Linksimple",
|
3498
|
-
"module": "src/components/linksimple/linksimple.component.ts"
|
3499
|
-
}
|
3500
|
-
},
|
3501
|
-
{
|
3502
|
-
"description": "Color of the link’s child content in the hover state.",
|
3503
|
-
"name": "--mdc-link-color-hover",
|
3504
|
-
"inheritedFrom": {
|
3505
|
-
"name": "Linksimple",
|
3506
|
-
"module": "src/components/linksimple/linksimple.component.ts"
|
3507
|
-
}
|
3508
|
-
},
|
3509
|
-
{
|
3510
|
-
"description": "Color of the link’s child content in the normal state.",
|
3511
|
-
"name": "--mdc-link-color-normal",
|
3512
|
-
"inheritedFrom": {
|
3513
|
-
"name": "Linksimple",
|
3514
|
-
"module": "src/components/linksimple/linksimple.component.ts"
|
3515
|
-
}
|
3516
|
-
},
|
3517
|
-
{
|
3518
|
-
"description": "Color of the inverted link’s child content in the active state.",
|
3519
|
-
"name": "--mdc-link-inverted-color-active",
|
3520
|
-
"inheritedFrom": {
|
3521
|
-
"name": "Linksimple",
|
3522
|
-
"module": "src/components/linksimple/linksimple.component.ts"
|
3523
|
-
}
|
3524
|
-
},
|
3525
|
-
{
|
3526
|
-
"description": "Color of the inverted link’s child content in the disabled state.",
|
3527
|
-
"name": "--mdc-link-inverted-color-disabled",
|
3528
|
-
"inheritedFrom": {
|
3529
|
-
"name": "Linksimple",
|
3530
|
-
"module": "src/components/linksimple/linksimple.component.ts"
|
3531
|
-
}
|
3532
|
-
},
|
3533
|
-
{
|
3534
|
-
"description": "Color of the inverted link’s child content in the hover state.",
|
3535
|
-
"name": "--mdc-link-inverted-color-hover",
|
3536
|
-
"inheritedFrom": {
|
3537
|
-
"name": "Linksimple",
|
3538
|
-
"module": "src/components/linksimple/linksimple.component.ts"
|
3539
|
-
}
|
3540
|
-
},
|
3541
|
-
{
|
3542
|
-
"description": "Color of the inverted link’s child content in the normal state.",
|
3543
|
-
"name": "--mdc-link-inverted-color-normal",
|
3544
|
-
"inheritedFrom": {
|
3545
|
-
"name": "Linksimple",
|
3546
|
-
"module": "src/components/linksimple/linksimple.component.ts"
|
3547
|
-
}
|
3548
|
-
}
|
3549
|
-
]
|
3547
|
+
"tagName": "mdc-badge",
|
3548
|
+
"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 */",
|
3549
|
+
"customElement": true
|
3550
3550
|
}
|
3551
3551
|
],
|
3552
3552
|
"exports": [
|
@@ -3554,8 +3554,8 @@
|
|
3554
3554
|
"kind": "js",
|
3555
3555
|
"name": "default",
|
3556
3556
|
"declaration": {
|
3557
|
-
"name": "
|
3558
|
-
"module": "components/
|
3557
|
+
"name": "Badge",
|
3558
|
+
"module": "components/badge/badge.component.js"
|
3559
3559
|
}
|
3560
3560
|
}
|
3561
3561
|
]
|