@momentum-design/components 0.120.9 → 0.120.10
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 +3 -3
- package/dist/browser/index.js.map +3 -3
- package/dist/components/listitem/listitem.component.d.ts +4 -1
- package/dist/components/listitem/listitem.component.js +14 -3
- package/dist/components/menuitem/menuitem.component.js +2 -2
- package/dist/custom-elements.json +1990 -1906
- package/dist/react/index.d.ts +5 -5
- package/dist/react/index.js +5 -5
- package/dist/utils/mixins/ListNavigationMixin.js +10 -2
- package/package.json +1 -1
@@ -1766,6 +1766,333 @@
|
|
1766
1766
|
}
|
1767
1767
|
]
|
1768
1768
|
},
|
1769
|
+
{
|
1770
|
+
"kind": "javascript-module",
|
1771
|
+
"path": "components/appheader/appheader.component.js",
|
1772
|
+
"declarations": [
|
1773
|
+
{
|
1774
|
+
"kind": "class",
|
1775
|
+
"description": "The `mdc-appheader` component provides a structured and accessible app header layout.\nIt consists of three primary sections: leading, center, and trailing.\n\n- The **leading section** typically holds a **brand logo**, **brand name** or **menu icon**.\n- The **center section** can contain a **search bar**, **icons** or action controls.\n- The **trailing section** generally includes a **profile avatar**, **additional icons** or **action controls**.",
|
1776
|
+
"name": "Appheader",
|
1777
|
+
"cssParts": [
|
1778
|
+
{
|
1779
|
+
"description": "The main container for styling the header.",
|
1780
|
+
"name": "container"
|
1781
|
+
},
|
1782
|
+
{
|
1783
|
+
"description": "The leading section of the header.",
|
1784
|
+
"name": "leading-section"
|
1785
|
+
},
|
1786
|
+
{
|
1787
|
+
"description": "The center section of the header.",
|
1788
|
+
"name": "center-section"
|
1789
|
+
},
|
1790
|
+
{
|
1791
|
+
"description": "The trailing section of the header.",
|
1792
|
+
"name": "trailing-section"
|
1793
|
+
}
|
1794
|
+
],
|
1795
|
+
"slots": [
|
1796
|
+
{
|
1797
|
+
"description": "Slot for the leading section (e.g., brand logo, brand name).",
|
1798
|
+
"name": "leading"
|
1799
|
+
},
|
1800
|
+
{
|
1801
|
+
"description": "Slot for the center section (e.g., search bar, icons).",
|
1802
|
+
"name": "center"
|
1803
|
+
},
|
1804
|
+
{
|
1805
|
+
"description": "Slot for the trailing section (e.g., profile avatar, icons).",
|
1806
|
+
"name": "trailing"
|
1807
|
+
}
|
1808
|
+
],
|
1809
|
+
"members": [],
|
1810
|
+
"superclass": {
|
1811
|
+
"name": "Component",
|
1812
|
+
"module": "/src/models"
|
1813
|
+
},
|
1814
|
+
"tagName": "mdc-appheader",
|
1815
|
+
"jsDoc": "/**\n * The `mdc-appheader` component provides a structured and accessible app header layout.\n * It consists of three primary sections: leading, center, and trailing.\n *\n * - The **leading section** typically holds a **brand logo**, **brand name** or **menu icon**.\n * - The **center section** can contain a **search bar**, **icons** or action controls.\n * - The **trailing section** generally includes a **profile avatar**, **additional icons** or **action controls**.\n *\n * @tagname mdc-appheader\n *\n * @slot leading - Slot for the leading section (e.g., brand logo, brand name).\n * @slot center - Slot for the center section (e.g., search bar, icons).\n * @slot trailing - Slot for the trailing section (e.g., profile avatar, icons).\n *\n * @csspart container - The main container for styling the header.\n * @csspart leading-section - The leading section of the header.\n * @csspart center-section - The center section of the header.\n * @csspart trailing-section - The trailing section of the header.\n */",
|
1816
|
+
"customElement": true
|
1817
|
+
}
|
1818
|
+
],
|
1819
|
+
"exports": [
|
1820
|
+
{
|
1821
|
+
"kind": "js",
|
1822
|
+
"name": "default",
|
1823
|
+
"declaration": {
|
1824
|
+
"name": "Appheader",
|
1825
|
+
"module": "components/appheader/appheader.component.js"
|
1826
|
+
}
|
1827
|
+
}
|
1828
|
+
]
|
1829
|
+
},
|
1830
|
+
{
|
1831
|
+
"kind": "javascript-module",
|
1832
|
+
"path": "components/avatar/avatar.component.js",
|
1833
|
+
"declarations": [
|
1834
|
+
{
|
1835
|
+
"kind": "class",
|
1836
|
+
"description": "The `mdc-avatar` component is used to represent a person or a space.\nAn avatar can be an icon, initials, counter and photo.\n\nTo set the photo of an avatar,\nyou need to set \"src\" attribute.\n\nWhile the avatar image is loading, as a placeholder,\nwe will show the initials text.\nIf the initials are not specified then,\nwe will show `user-regular` icon as a placeholder.\n\nBy default, if there are no attributes specified,\nthen the default avatar will be an icon with `user-regular` name.\n\nThe avatar component is non clickable and non interactive/focusable component.\nIf the avatar is typing, then the loading indicator will be displayed.\nIf the counter type avatar is set to a negative number, then we will display 0.\nThe presence indicator will be hidden when the counter property is set.",
|
1837
|
+
"name": "Avatar",
|
1838
|
+
"cssProperties": [
|
1839
|
+
{
|
1840
|
+
"description": "Allows customization of the default background color.",
|
1841
|
+
"name": "--mdc-avatar-default-background-color"
|
1842
|
+
},
|
1843
|
+
{
|
1844
|
+
"description": "Allows customization of the default foreground color.",
|
1845
|
+
"name": "--mdc-avatar-default-foreground-color"
|
1846
|
+
},
|
1847
|
+
{
|
1848
|
+
"description": "Allows customization of the loading indicator background color.",
|
1849
|
+
"name": "--mdc-avatar-loading-indicator-background-color"
|
1850
|
+
},
|
1851
|
+
{
|
1852
|
+
"description": "Allows customization of the loading indicator foreground color.",
|
1853
|
+
"name": "--mdc-avatar-loading-indicator-foreground-color"
|
1854
|
+
},
|
1855
|
+
{
|
1856
|
+
"description": "Allows customization of the loading overlay background color.",
|
1857
|
+
"name": "--mdc-avatar-loading-overlay-background-color"
|
1858
|
+
}
|
1859
|
+
],
|
1860
|
+
"cssParts": [
|
1861
|
+
{
|
1862
|
+
"description": "The main content of the avatar.",
|
1863
|
+
"name": "content"
|
1864
|
+
},
|
1865
|
+
{
|
1866
|
+
"description": "The photo of the avatar.",
|
1867
|
+
"name": "photo"
|
1868
|
+
},
|
1869
|
+
{
|
1870
|
+
"description": "The presence indicator of the avatar.",
|
1871
|
+
"name": "presence"
|
1872
|
+
},
|
1873
|
+
{
|
1874
|
+
"description": "The wrapper for the loading indicator.",
|
1875
|
+
"name": "loading-wrapper"
|
1876
|
+
},
|
1877
|
+
{
|
1878
|
+
"description": "The loading indicator of the avatar.",
|
1879
|
+
"name": "loader"
|
1880
|
+
}
|
1881
|
+
],
|
1882
|
+
"members": [
|
1883
|
+
{
|
1884
|
+
"kind": "field",
|
1885
|
+
"name": "src",
|
1886
|
+
"type": {
|
1887
|
+
"text": "string | undefined"
|
1888
|
+
},
|
1889
|
+
"description": "The src is the url which will be used to display the avatar.\nWhen the src is loading, we will display the initials as a placeholder.",
|
1890
|
+
"attribute": "src",
|
1891
|
+
"inheritedFrom": {
|
1892
|
+
"name": "AvatarComponentMixin",
|
1893
|
+
"module": "utils/mixins/AvatarComponentMixin.js"
|
1894
|
+
}
|
1895
|
+
},
|
1896
|
+
{
|
1897
|
+
"kind": "field",
|
1898
|
+
"name": "initials",
|
1899
|
+
"type": {
|
1900
|
+
"text": "string | undefined"
|
1901
|
+
},
|
1902
|
+
"description": "The initials to be displayed for the avatar.",
|
1903
|
+
"attribute": "initials",
|
1904
|
+
"inheritedFrom": {
|
1905
|
+
"name": "AvatarComponentMixin",
|
1906
|
+
"module": "utils/mixins/AvatarComponentMixin.js"
|
1907
|
+
}
|
1908
|
+
},
|
1909
|
+
{
|
1910
|
+
"kind": "field",
|
1911
|
+
"name": "presence",
|
1912
|
+
"type": {
|
1913
|
+
"text": "PresenceType | undefined"
|
1914
|
+
},
|
1915
|
+
"description": "The presence is the status which can be used to display the\nactivity state of a user or a space within an avatar component.\n\nAcceptable values include:\n- `active`\n- `away`\n- `away-calling`\n- `busy`\n- `dnd`\n- `meeting`\n- `on-call`\n- `on-device`\n- `on-mobile`\n- `pause`\n- `pto`\n- `presenting`\n- `quiet`\n- `scheduled`",
|
1916
|
+
"attribute": "presence",
|
1917
|
+
"inheritedFrom": {
|
1918
|
+
"name": "AvatarComponentMixin",
|
1919
|
+
"module": "utils/mixins/AvatarComponentMixin.js"
|
1920
|
+
}
|
1921
|
+
},
|
1922
|
+
{
|
1923
|
+
"kind": "field",
|
1924
|
+
"name": "size",
|
1925
|
+
"type": {
|
1926
|
+
"text": "AvatarSize"
|
1927
|
+
},
|
1928
|
+
"description": "Acceptable values include (size in px unit):\n- 24\n- 32\n- 48\n- 64\n- 72\n- 88\n- 124",
|
1929
|
+
"default": "32",
|
1930
|
+
"attribute": "size",
|
1931
|
+
"reflects": true,
|
1932
|
+
"inheritedFrom": {
|
1933
|
+
"name": "AvatarComponentMixin",
|
1934
|
+
"module": "utils/mixins/AvatarComponentMixin.js"
|
1935
|
+
}
|
1936
|
+
},
|
1937
|
+
{
|
1938
|
+
"kind": "field",
|
1939
|
+
"name": "counter",
|
1940
|
+
"type": {
|
1941
|
+
"text": "number | undefined"
|
1942
|
+
},
|
1943
|
+
"description": "The counter is the number which can be displayed on the avatar.\nThe maximum number is 99 and if the given number is greater than 99,\nthen the avatar will be displayed as `99+`.\nIf the given number is a negative number,\nthen the avatar will be displayed as `0`.",
|
1944
|
+
"attribute": "counter",
|
1945
|
+
"inheritedFrom": {
|
1946
|
+
"name": "AvatarComponentMixin",
|
1947
|
+
"module": "utils/mixins/AvatarComponentMixin.js"
|
1948
|
+
}
|
1949
|
+
},
|
1950
|
+
{
|
1951
|
+
"kind": "field",
|
1952
|
+
"name": "isTyping",
|
1953
|
+
"type": {
|
1954
|
+
"text": "boolean"
|
1955
|
+
},
|
1956
|
+
"default": "false",
|
1957
|
+
"description": "Represents the typing indicator when the user is typing.",
|
1958
|
+
"attribute": "is-typing",
|
1959
|
+
"inheritedFrom": {
|
1960
|
+
"name": "AvatarComponentMixin",
|
1961
|
+
"module": "utils/mixins/AvatarComponentMixin.js"
|
1962
|
+
}
|
1963
|
+
},
|
1964
|
+
{
|
1965
|
+
"kind": "field",
|
1966
|
+
"name": "iconName",
|
1967
|
+
"type": {
|
1968
|
+
"text": "IconNames | undefined"
|
1969
|
+
},
|
1970
|
+
"description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
|
1971
|
+
"attribute": "icon-name",
|
1972
|
+
"inheritedFrom": {
|
1973
|
+
"name": "IconNameMixin",
|
1974
|
+
"module": "utils/mixins/IconNameMixin.js"
|
1975
|
+
}
|
1976
|
+
}
|
1977
|
+
],
|
1978
|
+
"mixins": [
|
1979
|
+
{
|
1980
|
+
"name": "AvatarComponentMixin",
|
1981
|
+
"module": "/src/utils/mixins/AvatarComponentMixin"
|
1982
|
+
},
|
1983
|
+
{
|
1984
|
+
"name": "IconNameMixin",
|
1985
|
+
"module": "/src/utils/mixins/IconNameMixin"
|
1986
|
+
}
|
1987
|
+
],
|
1988
|
+
"superclass": {
|
1989
|
+
"name": "Component",
|
1990
|
+
"module": "/src/models"
|
1991
|
+
},
|
1992
|
+
"tagName": "mdc-avatar",
|
1993
|
+
"jsDoc": "/**\n * The `mdc-avatar` component is used to represent a person or a space.\n * An avatar can be an icon, initials, counter and photo.\n *\n * To set the photo of an avatar,\n * you need to set \"src\" attribute.\n *\n * While the avatar image is loading, as a placeholder,\n * we will show the initials text.\n * If the initials are not specified then,\n * we will show `user-regular` icon as a placeholder.\n *\n * By default, if there are no attributes specified,\n * then the default avatar will be an icon with `user-regular` name.\n *\n * The avatar component is non clickable and non interactive/focusable component.\n * If the avatar is typing, then the loading indicator will be displayed.\n * If the counter type avatar is set to a negative number, then we will display 0.\n * The presence indicator will be hidden when the counter property is set.\n *\n * @dependency mdc-icon\n * @dependency mdc-presence\n * @dependency mdc-text\n *\n * @tagname mdc-avatar\n *\n * @cssproperty --mdc-avatar-default-background-color - Allows customization of the default background color.\n * @cssproperty --mdc-avatar-default-foreground-color - Allows customization of the default foreground color.\n * @cssproperty --mdc-avatar-loading-indicator-background-color -\n * Allows customization of the loading indicator background color.\n * @cssproperty --mdc-avatar-loading-indicator-foreground-color -\n * Allows customization of the loading indicator foreground color.\n * @cssproperty --mdc-avatar-loading-overlay-background-color -\n * Allows customization of the loading overlay background color.\n *\n * @csspart content - The main content of the avatar.\n * @csspart photo - The photo of the avatar.\n * @csspart presence - The presence indicator of the avatar.\n * @csspart loading-wrapper - The wrapper for the loading indicator.\n * @csspart loader - The loading indicator of the avatar.\n */",
|
1994
|
+
"customElement": true,
|
1995
|
+
"attributes": [
|
1996
|
+
{
|
1997
|
+
"name": "src",
|
1998
|
+
"type": {
|
1999
|
+
"text": "string | undefined"
|
2000
|
+
},
|
2001
|
+
"description": "The src is the url which will be used to display the avatar.\nWhen the src is loading, we will display the initials as a placeholder.",
|
2002
|
+
"fieldName": "src",
|
2003
|
+
"inheritedFrom": {
|
2004
|
+
"name": "AvatarComponentMixin",
|
2005
|
+
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
2006
|
+
}
|
2007
|
+
},
|
2008
|
+
{
|
2009
|
+
"name": "initials",
|
2010
|
+
"type": {
|
2011
|
+
"text": "string | undefined"
|
2012
|
+
},
|
2013
|
+
"description": "The initials to be displayed for the avatar.",
|
2014
|
+
"fieldName": "initials",
|
2015
|
+
"inheritedFrom": {
|
2016
|
+
"name": "AvatarComponentMixin",
|
2017
|
+
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
2018
|
+
}
|
2019
|
+
},
|
2020
|
+
{
|
2021
|
+
"name": "presence",
|
2022
|
+
"type": {
|
2023
|
+
"text": "PresenceType | undefined"
|
2024
|
+
},
|
2025
|
+
"description": "The presence is the status which can be used to display the\nactivity state of a user or a space within an avatar component.\n\nAcceptable values include:\n- `active`\n- `away`\n- `away-calling`\n- `busy`\n- `dnd`\n- `meeting`\n- `on-call`\n- `on-device`\n- `on-mobile`\n- `pause`\n- `pto`\n- `presenting`\n- `quiet`\n- `scheduled`",
|
2026
|
+
"fieldName": "presence",
|
2027
|
+
"inheritedFrom": {
|
2028
|
+
"name": "AvatarComponentMixin",
|
2029
|
+
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
2030
|
+
}
|
2031
|
+
},
|
2032
|
+
{
|
2033
|
+
"name": "size",
|
2034
|
+
"type": {
|
2035
|
+
"text": "AvatarSize"
|
2036
|
+
},
|
2037
|
+
"description": "Acceptable values include (size in px unit):\n- 24\n- 32\n- 48\n- 64\n- 72\n- 88\n- 124",
|
2038
|
+
"default": "32",
|
2039
|
+
"fieldName": "size",
|
2040
|
+
"inheritedFrom": {
|
2041
|
+
"name": "AvatarComponentMixin",
|
2042
|
+
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
2043
|
+
}
|
2044
|
+
},
|
2045
|
+
{
|
2046
|
+
"name": "counter",
|
2047
|
+
"type": {
|
2048
|
+
"text": "number | undefined"
|
2049
|
+
},
|
2050
|
+
"description": "The counter is the number which can be displayed on the avatar.\nThe maximum number is 99 and if the given number is greater than 99,\nthen the avatar will be displayed as `99+`.\nIf the given number is a negative number,\nthen the avatar will be displayed as `0`.",
|
2051
|
+
"fieldName": "counter",
|
2052
|
+
"inheritedFrom": {
|
2053
|
+
"name": "AvatarComponentMixin",
|
2054
|
+
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
2055
|
+
}
|
2056
|
+
},
|
2057
|
+
{
|
2058
|
+
"name": "is-typing",
|
2059
|
+
"type": {
|
2060
|
+
"text": "boolean"
|
2061
|
+
},
|
2062
|
+
"default": "false",
|
2063
|
+
"description": "Represents the typing indicator when the user is typing.",
|
2064
|
+
"fieldName": "isTyping",
|
2065
|
+
"inheritedFrom": {
|
2066
|
+
"name": "AvatarComponentMixin",
|
2067
|
+
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
2068
|
+
}
|
2069
|
+
},
|
2070
|
+
{
|
2071
|
+
"name": "icon-name",
|
2072
|
+
"type": {
|
2073
|
+
"text": "IconNames | undefined"
|
2074
|
+
},
|
2075
|
+
"description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
|
2076
|
+
"fieldName": "iconName",
|
2077
|
+
"inheritedFrom": {
|
2078
|
+
"name": "IconNameMixin",
|
2079
|
+
"module": "src/utils/mixins/IconNameMixin.ts"
|
2080
|
+
}
|
2081
|
+
}
|
2082
|
+
]
|
2083
|
+
}
|
2084
|
+
],
|
2085
|
+
"exports": [
|
2086
|
+
{
|
2087
|
+
"kind": "js",
|
2088
|
+
"name": "default",
|
2089
|
+
"declaration": {
|
2090
|
+
"name": "Avatar",
|
2091
|
+
"module": "components/avatar/avatar.component.js"
|
2092
|
+
}
|
2093
|
+
}
|
2094
|
+
]
|
2095
|
+
},
|
1769
2096
|
{
|
1770
2097
|
"kind": "javascript-module",
|
1771
2098
|
"path": "components/announcementdialog/announcementdialog.component.js",
|
@@ -3129,333 +3456,6 @@
|
|
3129
3456
|
}
|
3130
3457
|
]
|
3131
3458
|
},
|
3132
|
-
{
|
3133
|
-
"kind": "javascript-module",
|
3134
|
-
"path": "components/appheader/appheader.component.js",
|
3135
|
-
"declarations": [
|
3136
|
-
{
|
3137
|
-
"kind": "class",
|
3138
|
-
"description": "The `mdc-appheader` component provides a structured and accessible app header layout.\nIt consists of three primary sections: leading, center, and trailing.\n\n- The **leading section** typically holds a **brand logo**, **brand name** or **menu icon**.\n- The **center section** can contain a **search bar**, **icons** or action controls.\n- The **trailing section** generally includes a **profile avatar**, **additional icons** or **action controls**.",
|
3139
|
-
"name": "Appheader",
|
3140
|
-
"cssParts": [
|
3141
|
-
{
|
3142
|
-
"description": "The main container for styling the header.",
|
3143
|
-
"name": "container"
|
3144
|
-
},
|
3145
|
-
{
|
3146
|
-
"description": "The leading section of the header.",
|
3147
|
-
"name": "leading-section"
|
3148
|
-
},
|
3149
|
-
{
|
3150
|
-
"description": "The center section of the header.",
|
3151
|
-
"name": "center-section"
|
3152
|
-
},
|
3153
|
-
{
|
3154
|
-
"description": "The trailing section of the header.",
|
3155
|
-
"name": "trailing-section"
|
3156
|
-
}
|
3157
|
-
],
|
3158
|
-
"slots": [
|
3159
|
-
{
|
3160
|
-
"description": "Slot for the leading section (e.g., brand logo, brand name).",
|
3161
|
-
"name": "leading"
|
3162
|
-
},
|
3163
|
-
{
|
3164
|
-
"description": "Slot for the center section (e.g., search bar, icons).",
|
3165
|
-
"name": "center"
|
3166
|
-
},
|
3167
|
-
{
|
3168
|
-
"description": "Slot for the trailing section (e.g., profile avatar, icons).",
|
3169
|
-
"name": "trailing"
|
3170
|
-
}
|
3171
|
-
],
|
3172
|
-
"members": [],
|
3173
|
-
"superclass": {
|
3174
|
-
"name": "Component",
|
3175
|
-
"module": "/src/models"
|
3176
|
-
},
|
3177
|
-
"tagName": "mdc-appheader",
|
3178
|
-
"jsDoc": "/**\n * The `mdc-appheader` component provides a structured and accessible app header layout.\n * It consists of three primary sections: leading, center, and trailing.\n *\n * - The **leading section** typically holds a **brand logo**, **brand name** or **menu icon**.\n * - The **center section** can contain a **search bar**, **icons** or action controls.\n * - The **trailing section** generally includes a **profile avatar**, **additional icons** or **action controls**.\n *\n * @tagname mdc-appheader\n *\n * @slot leading - Slot for the leading section (e.g., brand logo, brand name).\n * @slot center - Slot for the center section (e.g., search bar, icons).\n * @slot trailing - Slot for the trailing section (e.g., profile avatar, icons).\n *\n * @csspart container - The main container for styling the header.\n * @csspart leading-section - The leading section of the header.\n * @csspart center-section - The center section of the header.\n * @csspart trailing-section - The trailing section of the header.\n */",
|
3179
|
-
"customElement": true
|
3180
|
-
}
|
3181
|
-
],
|
3182
|
-
"exports": [
|
3183
|
-
{
|
3184
|
-
"kind": "js",
|
3185
|
-
"name": "default",
|
3186
|
-
"declaration": {
|
3187
|
-
"name": "Appheader",
|
3188
|
-
"module": "components/appheader/appheader.component.js"
|
3189
|
-
}
|
3190
|
-
}
|
3191
|
-
]
|
3192
|
-
},
|
3193
|
-
{
|
3194
|
-
"kind": "javascript-module",
|
3195
|
-
"path": "components/avatar/avatar.component.js",
|
3196
|
-
"declarations": [
|
3197
|
-
{
|
3198
|
-
"kind": "class",
|
3199
|
-
"description": "The `mdc-avatar` component is used to represent a person or a space.\nAn avatar can be an icon, initials, counter and photo.\n\nTo set the photo of an avatar,\nyou need to set \"src\" attribute.\n\nWhile the avatar image is loading, as a placeholder,\nwe will show the initials text.\nIf the initials are not specified then,\nwe will show `user-regular` icon as a placeholder.\n\nBy default, if there are no attributes specified,\nthen the default avatar will be an icon with `user-regular` name.\n\nThe avatar component is non clickable and non interactive/focusable component.\nIf the avatar is typing, then the loading indicator will be displayed.\nIf the counter type avatar is set to a negative number, then we will display 0.\nThe presence indicator will be hidden when the counter property is set.",
|
3200
|
-
"name": "Avatar",
|
3201
|
-
"cssProperties": [
|
3202
|
-
{
|
3203
|
-
"description": "Allows customization of the default background color.",
|
3204
|
-
"name": "--mdc-avatar-default-background-color"
|
3205
|
-
},
|
3206
|
-
{
|
3207
|
-
"description": "Allows customization of the default foreground color.",
|
3208
|
-
"name": "--mdc-avatar-default-foreground-color"
|
3209
|
-
},
|
3210
|
-
{
|
3211
|
-
"description": "Allows customization of the loading indicator background color.",
|
3212
|
-
"name": "--mdc-avatar-loading-indicator-background-color"
|
3213
|
-
},
|
3214
|
-
{
|
3215
|
-
"description": "Allows customization of the loading indicator foreground color.",
|
3216
|
-
"name": "--mdc-avatar-loading-indicator-foreground-color"
|
3217
|
-
},
|
3218
|
-
{
|
3219
|
-
"description": "Allows customization of the loading overlay background color.",
|
3220
|
-
"name": "--mdc-avatar-loading-overlay-background-color"
|
3221
|
-
}
|
3222
|
-
],
|
3223
|
-
"cssParts": [
|
3224
|
-
{
|
3225
|
-
"description": "The main content of the avatar.",
|
3226
|
-
"name": "content"
|
3227
|
-
},
|
3228
|
-
{
|
3229
|
-
"description": "The photo of the avatar.",
|
3230
|
-
"name": "photo"
|
3231
|
-
},
|
3232
|
-
{
|
3233
|
-
"description": "The presence indicator of the avatar.",
|
3234
|
-
"name": "presence"
|
3235
|
-
},
|
3236
|
-
{
|
3237
|
-
"description": "The wrapper for the loading indicator.",
|
3238
|
-
"name": "loading-wrapper"
|
3239
|
-
},
|
3240
|
-
{
|
3241
|
-
"description": "The loading indicator of the avatar.",
|
3242
|
-
"name": "loader"
|
3243
|
-
}
|
3244
|
-
],
|
3245
|
-
"members": [
|
3246
|
-
{
|
3247
|
-
"kind": "field",
|
3248
|
-
"name": "src",
|
3249
|
-
"type": {
|
3250
|
-
"text": "string | undefined"
|
3251
|
-
},
|
3252
|
-
"description": "The src is the url which will be used to display the avatar.\nWhen the src is loading, we will display the initials as a placeholder.",
|
3253
|
-
"attribute": "src",
|
3254
|
-
"inheritedFrom": {
|
3255
|
-
"name": "AvatarComponentMixin",
|
3256
|
-
"module": "utils/mixins/AvatarComponentMixin.js"
|
3257
|
-
}
|
3258
|
-
},
|
3259
|
-
{
|
3260
|
-
"kind": "field",
|
3261
|
-
"name": "initials",
|
3262
|
-
"type": {
|
3263
|
-
"text": "string | undefined"
|
3264
|
-
},
|
3265
|
-
"description": "The initials to be displayed for the avatar.",
|
3266
|
-
"attribute": "initials",
|
3267
|
-
"inheritedFrom": {
|
3268
|
-
"name": "AvatarComponentMixin",
|
3269
|
-
"module": "utils/mixins/AvatarComponentMixin.js"
|
3270
|
-
}
|
3271
|
-
},
|
3272
|
-
{
|
3273
|
-
"kind": "field",
|
3274
|
-
"name": "presence",
|
3275
|
-
"type": {
|
3276
|
-
"text": "PresenceType | undefined"
|
3277
|
-
},
|
3278
|
-
"description": "The presence is the status which can be used to display the\nactivity state of a user or a space within an avatar component.\n\nAcceptable values include:\n- `active`\n- `away`\n- `away-calling`\n- `busy`\n- `dnd`\n- `meeting`\n- `on-call`\n- `on-device`\n- `on-mobile`\n- `pause`\n- `pto`\n- `presenting`\n- `quiet`\n- `scheduled`",
|
3279
|
-
"attribute": "presence",
|
3280
|
-
"inheritedFrom": {
|
3281
|
-
"name": "AvatarComponentMixin",
|
3282
|
-
"module": "utils/mixins/AvatarComponentMixin.js"
|
3283
|
-
}
|
3284
|
-
},
|
3285
|
-
{
|
3286
|
-
"kind": "field",
|
3287
|
-
"name": "size",
|
3288
|
-
"type": {
|
3289
|
-
"text": "AvatarSize"
|
3290
|
-
},
|
3291
|
-
"description": "Acceptable values include (size in px unit):\n- 24\n- 32\n- 48\n- 64\n- 72\n- 88\n- 124",
|
3292
|
-
"default": "32",
|
3293
|
-
"attribute": "size",
|
3294
|
-
"reflects": true,
|
3295
|
-
"inheritedFrom": {
|
3296
|
-
"name": "AvatarComponentMixin",
|
3297
|
-
"module": "utils/mixins/AvatarComponentMixin.js"
|
3298
|
-
}
|
3299
|
-
},
|
3300
|
-
{
|
3301
|
-
"kind": "field",
|
3302
|
-
"name": "counter",
|
3303
|
-
"type": {
|
3304
|
-
"text": "number | undefined"
|
3305
|
-
},
|
3306
|
-
"description": "The counter is the number which can be displayed on the avatar.\nThe maximum number is 99 and if the given number is greater than 99,\nthen the avatar will be displayed as `99+`.\nIf the given number is a negative number,\nthen the avatar will be displayed as `0`.",
|
3307
|
-
"attribute": "counter",
|
3308
|
-
"inheritedFrom": {
|
3309
|
-
"name": "AvatarComponentMixin",
|
3310
|
-
"module": "utils/mixins/AvatarComponentMixin.js"
|
3311
|
-
}
|
3312
|
-
},
|
3313
|
-
{
|
3314
|
-
"kind": "field",
|
3315
|
-
"name": "isTyping",
|
3316
|
-
"type": {
|
3317
|
-
"text": "boolean"
|
3318
|
-
},
|
3319
|
-
"default": "false",
|
3320
|
-
"description": "Represents the typing indicator when the user is typing.",
|
3321
|
-
"attribute": "is-typing",
|
3322
|
-
"inheritedFrom": {
|
3323
|
-
"name": "AvatarComponentMixin",
|
3324
|
-
"module": "utils/mixins/AvatarComponentMixin.js"
|
3325
|
-
}
|
3326
|
-
},
|
3327
|
-
{
|
3328
|
-
"kind": "field",
|
3329
|
-
"name": "iconName",
|
3330
|
-
"type": {
|
3331
|
-
"text": "IconNames | undefined"
|
3332
|
-
},
|
3333
|
-
"description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
|
3334
|
-
"attribute": "icon-name",
|
3335
|
-
"inheritedFrom": {
|
3336
|
-
"name": "IconNameMixin",
|
3337
|
-
"module": "utils/mixins/IconNameMixin.js"
|
3338
|
-
}
|
3339
|
-
}
|
3340
|
-
],
|
3341
|
-
"mixins": [
|
3342
|
-
{
|
3343
|
-
"name": "AvatarComponentMixin",
|
3344
|
-
"module": "/src/utils/mixins/AvatarComponentMixin"
|
3345
|
-
},
|
3346
|
-
{
|
3347
|
-
"name": "IconNameMixin",
|
3348
|
-
"module": "/src/utils/mixins/IconNameMixin"
|
3349
|
-
}
|
3350
|
-
],
|
3351
|
-
"superclass": {
|
3352
|
-
"name": "Component",
|
3353
|
-
"module": "/src/models"
|
3354
|
-
},
|
3355
|
-
"tagName": "mdc-avatar",
|
3356
|
-
"jsDoc": "/**\n * The `mdc-avatar` component is used to represent a person or a space.\n * An avatar can be an icon, initials, counter and photo.\n *\n * To set the photo of an avatar,\n * you need to set \"src\" attribute.\n *\n * While the avatar image is loading, as a placeholder,\n * we will show the initials text.\n * If the initials are not specified then,\n * we will show `user-regular` icon as a placeholder.\n *\n * By default, if there are no attributes specified,\n * then the default avatar will be an icon with `user-regular` name.\n *\n * The avatar component is non clickable and non interactive/focusable component.\n * If the avatar is typing, then the loading indicator will be displayed.\n * If the counter type avatar is set to a negative number, then we will display 0.\n * The presence indicator will be hidden when the counter property is set.\n *\n * @dependency mdc-icon\n * @dependency mdc-presence\n * @dependency mdc-text\n *\n * @tagname mdc-avatar\n *\n * @cssproperty --mdc-avatar-default-background-color - Allows customization of the default background color.\n * @cssproperty --mdc-avatar-default-foreground-color - Allows customization of the default foreground color.\n * @cssproperty --mdc-avatar-loading-indicator-background-color -\n * Allows customization of the loading indicator background color.\n * @cssproperty --mdc-avatar-loading-indicator-foreground-color -\n * Allows customization of the loading indicator foreground color.\n * @cssproperty --mdc-avatar-loading-overlay-background-color -\n * Allows customization of the loading overlay background color.\n *\n * @csspart content - The main content of the avatar.\n * @csspart photo - The photo of the avatar.\n * @csspart presence - The presence indicator of the avatar.\n * @csspart loading-wrapper - The wrapper for the loading indicator.\n * @csspart loader - The loading indicator of the avatar.\n */",
|
3357
|
-
"customElement": true,
|
3358
|
-
"attributes": [
|
3359
|
-
{
|
3360
|
-
"name": "src",
|
3361
|
-
"type": {
|
3362
|
-
"text": "string | undefined"
|
3363
|
-
},
|
3364
|
-
"description": "The src is the url which will be used to display the avatar.\nWhen the src is loading, we will display the initials as a placeholder.",
|
3365
|
-
"fieldName": "src",
|
3366
|
-
"inheritedFrom": {
|
3367
|
-
"name": "AvatarComponentMixin",
|
3368
|
-
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
3369
|
-
}
|
3370
|
-
},
|
3371
|
-
{
|
3372
|
-
"name": "initials",
|
3373
|
-
"type": {
|
3374
|
-
"text": "string | undefined"
|
3375
|
-
},
|
3376
|
-
"description": "The initials to be displayed for the avatar.",
|
3377
|
-
"fieldName": "initials",
|
3378
|
-
"inheritedFrom": {
|
3379
|
-
"name": "AvatarComponentMixin",
|
3380
|
-
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
3381
|
-
}
|
3382
|
-
},
|
3383
|
-
{
|
3384
|
-
"name": "presence",
|
3385
|
-
"type": {
|
3386
|
-
"text": "PresenceType | undefined"
|
3387
|
-
},
|
3388
|
-
"description": "The presence is the status which can be used to display the\nactivity state of a user or a space within an avatar component.\n\nAcceptable values include:\n- `active`\n- `away`\n- `away-calling`\n- `busy`\n- `dnd`\n- `meeting`\n- `on-call`\n- `on-device`\n- `on-mobile`\n- `pause`\n- `pto`\n- `presenting`\n- `quiet`\n- `scheduled`",
|
3389
|
-
"fieldName": "presence",
|
3390
|
-
"inheritedFrom": {
|
3391
|
-
"name": "AvatarComponentMixin",
|
3392
|
-
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
3393
|
-
}
|
3394
|
-
},
|
3395
|
-
{
|
3396
|
-
"name": "size",
|
3397
|
-
"type": {
|
3398
|
-
"text": "AvatarSize"
|
3399
|
-
},
|
3400
|
-
"description": "Acceptable values include (size in px unit):\n- 24\n- 32\n- 48\n- 64\n- 72\n- 88\n- 124",
|
3401
|
-
"default": "32",
|
3402
|
-
"fieldName": "size",
|
3403
|
-
"inheritedFrom": {
|
3404
|
-
"name": "AvatarComponentMixin",
|
3405
|
-
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
3406
|
-
}
|
3407
|
-
},
|
3408
|
-
{
|
3409
|
-
"name": "counter",
|
3410
|
-
"type": {
|
3411
|
-
"text": "number | undefined"
|
3412
|
-
},
|
3413
|
-
"description": "The counter is the number which can be displayed on the avatar.\nThe maximum number is 99 and if the given number is greater than 99,\nthen the avatar will be displayed as `99+`.\nIf the given number is a negative number,\nthen the avatar will be displayed as `0`.",
|
3414
|
-
"fieldName": "counter",
|
3415
|
-
"inheritedFrom": {
|
3416
|
-
"name": "AvatarComponentMixin",
|
3417
|
-
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
3418
|
-
}
|
3419
|
-
},
|
3420
|
-
{
|
3421
|
-
"name": "is-typing",
|
3422
|
-
"type": {
|
3423
|
-
"text": "boolean"
|
3424
|
-
},
|
3425
|
-
"default": "false",
|
3426
|
-
"description": "Represents the typing indicator when the user is typing.",
|
3427
|
-
"fieldName": "isTyping",
|
3428
|
-
"inheritedFrom": {
|
3429
|
-
"name": "AvatarComponentMixin",
|
3430
|
-
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
3431
|
-
}
|
3432
|
-
},
|
3433
|
-
{
|
3434
|
-
"name": "icon-name",
|
3435
|
-
"type": {
|
3436
|
-
"text": "IconNames | undefined"
|
3437
|
-
},
|
3438
|
-
"description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
|
3439
|
-
"fieldName": "iconName",
|
3440
|
-
"inheritedFrom": {
|
3441
|
-
"name": "IconNameMixin",
|
3442
|
-
"module": "src/utils/mixins/IconNameMixin.ts"
|
3443
|
-
}
|
3444
|
-
}
|
3445
|
-
]
|
3446
|
-
}
|
3447
|
-
],
|
3448
|
-
"exports": [
|
3449
|
-
{
|
3450
|
-
"kind": "js",
|
3451
|
-
"name": "default",
|
3452
|
-
"declaration": {
|
3453
|
-
"name": "Avatar",
|
3454
|
-
"module": "components/avatar/avatar.component.js"
|
3455
|
-
}
|
3456
|
-
}
|
3457
|
-
]
|
3458
|
-
},
|
3459
3459
|
{
|
3460
3460
|
"kind": "javascript-module",
|
3461
3461
|
"path": "components/avatarbutton/avatarbutton.component.js",
|
@@ -17414,6 +17414,254 @@
|
|
17414
17414
|
}
|
17415
17415
|
]
|
17416
17416
|
},
|
17417
|
+
{
|
17418
|
+
"kind": "javascript-module",
|
17419
|
+
"path": "components/icon/icon.component.js",
|
17420
|
+
"declarations": [
|
17421
|
+
{
|
17422
|
+
"kind": "class",
|
17423
|
+
"description": "Icon component that dynamically displays SVG icons based on a valid name.\n\nThis component must be mounted within an `IconProvider` component.\n\nThe `IconProvider` defines the source URL from which icons are consumed.\nThe `Icon` component accepts a `name` attribute, which corresponds to\nthe file name of the icon to be loaded from the specified URL.\n\nOnce fetched, the icon will be rendered. If the fetching process is unsuccessful,\nno icon will be displayed.\n\nThe `size` attribute allows for dynamic sizing of the icon based on the provided\n`length-unit` attribute. This unit can either come from the `IconProvider`\nor can be overridden for each individual icon. For example:\nif `size = 1` and `length-unit = 'em'`, the dimensions of the icon will be\n`width: 1em; height: 1em`.\n\nRegarding accessibility, there are three types of icons: decorative, informative and informative standalone.\n\n### Decorative Icons\n- Decorative icons do not convey any essential information to the content of a page.\n- They should be hidden from screen readers (SR) to prevent confusion for users.\n- For decorative icons, an `aria-label` is not required, and the `role` will be set to null.\n\n### Informative Icons\n- Informative icons convey important information that is not adequately represented\n by surrounding text or components.\n- They provide valuable context and must be announced by assistive technologies.\n- For informative icons, an `aria-label` is required, and the `role` will be set to \"img\" automatically.\n- If an `aria-label` is provided, the role will be set to 'img'; if it is absent,\n the role will be unset.\n\n### Informative Standalone Icons\n- If an icon is informative (as mentioned above) and does not belong to a button (=standalone), it must\nhave a Tooltip that describes what it means.\n- For informative standalone icons, an `aria-label` & `tabindex=\"0\"` is required,\nand the `role` will be set to \"img\" automatically.\n- **Only use this when a Icon is standalone and is not part of a button or other interactive elements.**",
|
17424
|
+
"name": "Icon",
|
17425
|
+
"cssProperties": [
|
17426
|
+
{
|
17427
|
+
"description": "Allows customization of the default fill color.",
|
17428
|
+
"name": "--mdc-icon-fill-color"
|
17429
|
+
},
|
17430
|
+
{
|
17431
|
+
"description": "Allows customization of the icon size.",
|
17432
|
+
"name": "--mdc-icon-size"
|
17433
|
+
},
|
17434
|
+
{
|
17435
|
+
"description": "Allows customization of the icon border radius.",
|
17436
|
+
"name": "--mdc-icon-border-radius"
|
17437
|
+
}
|
17438
|
+
],
|
17439
|
+
"cssParts": [
|
17440
|
+
{
|
17441
|
+
"description": "The svg inside the icon element.",
|
17442
|
+
"name": "icon"
|
17443
|
+
}
|
17444
|
+
],
|
17445
|
+
"members": [
|
17446
|
+
{
|
17447
|
+
"kind": "field",
|
17448
|
+
"name": "iconData",
|
17449
|
+
"type": {
|
17450
|
+
"text": "HTMLElement | undefined"
|
17451
|
+
},
|
17452
|
+
"privacy": "private"
|
17453
|
+
},
|
17454
|
+
{
|
17455
|
+
"kind": "field",
|
17456
|
+
"name": "lengthUnitFromContext",
|
17457
|
+
"type": {
|
17458
|
+
"text": "string | undefined"
|
17459
|
+
},
|
17460
|
+
"privacy": "private"
|
17461
|
+
},
|
17462
|
+
{
|
17463
|
+
"kind": "field",
|
17464
|
+
"name": "sizeFromContext",
|
17465
|
+
"type": {
|
17466
|
+
"text": "number | undefined"
|
17467
|
+
},
|
17468
|
+
"privacy": "private"
|
17469
|
+
},
|
17470
|
+
{
|
17471
|
+
"kind": "field",
|
17472
|
+
"name": "name",
|
17473
|
+
"type": {
|
17474
|
+
"text": "IconNames | undefined"
|
17475
|
+
},
|
17476
|
+
"description": "Name of the icon (= filename)",
|
17477
|
+
"attribute": "name",
|
17478
|
+
"reflects": true
|
17479
|
+
},
|
17480
|
+
{
|
17481
|
+
"kind": "field",
|
17482
|
+
"name": "size",
|
17483
|
+
"type": {
|
17484
|
+
"text": "number | undefined"
|
17485
|
+
},
|
17486
|
+
"description": "Size of the icon (works in combination with length unit)",
|
17487
|
+
"attribute": "size"
|
17488
|
+
},
|
17489
|
+
{
|
17490
|
+
"kind": "field",
|
17491
|
+
"name": "lengthUnit",
|
17492
|
+
"type": {
|
17493
|
+
"text": "string | undefined"
|
17494
|
+
},
|
17495
|
+
"description": "Length unit attribute for overriding length-unit from `IconProvider`",
|
17496
|
+
"attribute": "length-unit"
|
17497
|
+
},
|
17498
|
+
{
|
17499
|
+
"kind": "field",
|
17500
|
+
"name": "ariaLabel",
|
17501
|
+
"type": {
|
17502
|
+
"text": "string | null"
|
17503
|
+
},
|
17504
|
+
"default": "null",
|
17505
|
+
"description": "Aria-label attribute to be set for accessibility",
|
17506
|
+
"attribute": "aria-label"
|
17507
|
+
},
|
17508
|
+
{
|
17509
|
+
"kind": "field",
|
17510
|
+
"name": "ariaLabelledBy",
|
17511
|
+
"type": {
|
17512
|
+
"text": "string | null"
|
17513
|
+
},
|
17514
|
+
"default": "null",
|
17515
|
+
"description": "Aria-labelledby attribute to be set for accessibility",
|
17516
|
+
"attribute": "aria-labelledby"
|
17517
|
+
},
|
17518
|
+
{
|
17519
|
+
"kind": "field",
|
17520
|
+
"name": "iconProviderContext",
|
17521
|
+
"privacy": "private",
|
17522
|
+
"readonly": true
|
17523
|
+
},
|
17524
|
+
{
|
17525
|
+
"kind": "field",
|
17526
|
+
"name": "abortController",
|
17527
|
+
"type": {
|
17528
|
+
"text": "AbortController | undefined"
|
17529
|
+
},
|
17530
|
+
"privacy": "private",
|
17531
|
+
"default": "new AbortController()"
|
17532
|
+
},
|
17533
|
+
{
|
17534
|
+
"kind": "method",
|
17535
|
+
"name": "prepareIconElement",
|
17536
|
+
"privacy": "private",
|
17537
|
+
"parameters": [
|
17538
|
+
{
|
17539
|
+
"name": "iconData",
|
17540
|
+
"type": {
|
17541
|
+
"text": "string"
|
17542
|
+
},
|
17543
|
+
"description": "The icon string to be parsed"
|
17544
|
+
}
|
17545
|
+
],
|
17546
|
+
"description": "Parse the icon string to an html element, set the attributes and\nreturn the icon element",
|
17547
|
+
"return": {
|
17548
|
+
"type": {
|
17549
|
+
"text": ""
|
17550
|
+
}
|
17551
|
+
}
|
17552
|
+
},
|
17553
|
+
{
|
17554
|
+
"kind": "method",
|
17555
|
+
"name": "getIconData",
|
17556
|
+
"privacy": "private",
|
17557
|
+
"description": "Fetches the icon (currently only svg) and sets state and attributes once fetched successfully\n\nThis method uses abortController.signal to cancel the fetch request when the component is disconnected or updated.\nIf the request is aborted after the fetch() call has been fulfilled but before the response body has been read,\nthen attempting to read the response body will reject with an AbortError exception."
|
17558
|
+
},
|
17559
|
+
{
|
17560
|
+
"kind": "method",
|
17561
|
+
"name": "handleIconLoadedSuccess",
|
17562
|
+
"privacy": "private",
|
17563
|
+
"parameters": [
|
17564
|
+
{
|
17565
|
+
"name": "iconHtml",
|
17566
|
+
"type": {
|
17567
|
+
"text": "HTMLElement"
|
17568
|
+
},
|
17569
|
+
"description": "The icon html element which has been fetched from the icon provider."
|
17570
|
+
}
|
17571
|
+
],
|
17572
|
+
"description": "Sets the iconData state to the fetched icon.\nDispatches a 'load' event on the component once the icon has been successfully loaded."
|
17573
|
+
},
|
17574
|
+
{
|
17575
|
+
"kind": "method",
|
17576
|
+
"name": "handleIconLoadedFailure",
|
17577
|
+
"privacy": "private",
|
17578
|
+
"parameters": [
|
17579
|
+
{
|
17580
|
+
"name": "error",
|
17581
|
+
"type": {
|
17582
|
+
"text": "unknown"
|
17583
|
+
}
|
17584
|
+
}
|
17585
|
+
],
|
17586
|
+
"description": "Dispatches an 'error' event on the component when the icon fetching has failed.\nThis event bubbles and is cancelable.\nThe error detail is set to the error object."
|
17587
|
+
},
|
17588
|
+
{
|
17589
|
+
"kind": "method",
|
17590
|
+
"name": "updateSize",
|
17591
|
+
"privacy": "private",
|
17592
|
+
"description": "Updates the size by setting the width and height"
|
17593
|
+
},
|
17594
|
+
{
|
17595
|
+
"kind": "field",
|
17596
|
+
"name": "computedIconSize",
|
17597
|
+
"privacy": "private",
|
17598
|
+
"readonly": true
|
17599
|
+
}
|
17600
|
+
],
|
17601
|
+
"attributes": [
|
17602
|
+
{
|
17603
|
+
"name": "name",
|
17604
|
+
"type": {
|
17605
|
+
"text": "IconNames | undefined"
|
17606
|
+
},
|
17607
|
+
"description": "Name of the icon (= filename)",
|
17608
|
+
"fieldName": "name"
|
17609
|
+
},
|
17610
|
+
{
|
17611
|
+
"name": "size",
|
17612
|
+
"type": {
|
17613
|
+
"text": "number | undefined"
|
17614
|
+
},
|
17615
|
+
"description": "Size of the icon (works in combination with length unit)",
|
17616
|
+
"fieldName": "size"
|
17617
|
+
},
|
17618
|
+
{
|
17619
|
+
"name": "length-unit",
|
17620
|
+
"type": {
|
17621
|
+
"text": "string | undefined"
|
17622
|
+
},
|
17623
|
+
"description": "Length unit attribute for overriding length-unit from `IconProvider`",
|
17624
|
+
"fieldName": "lengthUnit"
|
17625
|
+
},
|
17626
|
+
{
|
17627
|
+
"name": "aria-label",
|
17628
|
+
"type": {
|
17629
|
+
"text": "string | null"
|
17630
|
+
},
|
17631
|
+
"default": "null",
|
17632
|
+
"description": "Aria-label attribute to be set for accessibility",
|
17633
|
+
"fieldName": "ariaLabel"
|
17634
|
+
},
|
17635
|
+
{
|
17636
|
+
"name": "aria-labelledby",
|
17637
|
+
"type": {
|
17638
|
+
"text": "string | null"
|
17639
|
+
},
|
17640
|
+
"default": "null",
|
17641
|
+
"description": "Aria-labelledby attribute to be set for accessibility",
|
17642
|
+
"fieldName": "ariaLabelledBy"
|
17643
|
+
}
|
17644
|
+
],
|
17645
|
+
"superclass": {
|
17646
|
+
"name": "Component",
|
17647
|
+
"module": "/src/models"
|
17648
|
+
},
|
17649
|
+
"tagName": "mdc-icon",
|
17650
|
+
"jsDoc": "/**\n * Icon component that dynamically displays SVG icons based on a valid name.\n *\n * This component must be mounted within an `IconProvider` component.\n *\n * The `IconProvider` defines the source URL from which icons are consumed.\n * The `Icon` component accepts a `name` attribute, which corresponds to\n * the file name of the icon to be loaded from the specified URL.\n *\n * Once fetched, the icon will be rendered. If the fetching process is unsuccessful,\n * no icon will be displayed.\n *\n * The `size` attribute allows for dynamic sizing of the icon based on the provided\n * `length-unit` attribute. This unit can either come from the `IconProvider`\n * or can be overridden for each individual icon. For example:\n * if `size = 1` and `length-unit = 'em'`, the dimensions of the icon will be\n * `width: 1em; height: 1em`.\n *\n * Regarding accessibility, there are three types of icons: decorative, informative and informative standalone.\n *\n * ### Decorative Icons\n * - Decorative icons do not convey any essential information to the content of a page.\n * - They should be hidden from screen readers (SR) to prevent confusion for users.\n * - For decorative icons, an `aria-label` is not required, and the `role` will be set to null.\n *\n * ### Informative Icons\n * - Informative icons convey important information that is not adequately represented\n * by surrounding text or components.\n * - They provide valuable context and must be announced by assistive technologies.\n * - For informative icons, an `aria-label` is required, and the `role` will be set to \"img\" automatically.\n * - If an `aria-label` is provided, the role will be set to 'img'; if it is absent,\n * the role will be unset.\n *\n * ### Informative Standalone Icons\n * - If an icon is informative (as mentioned above) and does not belong to a button (=standalone), it must\n * have a Tooltip that describes what it means.\n * - For informative standalone icons, an `aria-label` & `tabindex=\"0\"` is required,\n * and the `role` will be set to \"img\" automatically.\n * - **Only use this when a Icon is standalone and is not part of a button or other interactive elements.**\n *\n * @tagname mdc-icon\n *\n * @cssproperty --mdc-icon-fill-color - Allows customization of the default fill color.\n * @cssproperty --mdc-icon-size - Allows customization of the icon size.\n * @cssproperty --mdc-icon-border-radius - Allows customization of the icon border radius.\n *\n * @csspart icon - The svg inside the icon element.\n */",
|
17651
|
+
"customElement": true
|
17652
|
+
}
|
17653
|
+
],
|
17654
|
+
"exports": [
|
17655
|
+
{
|
17656
|
+
"kind": "js",
|
17657
|
+
"name": "default",
|
17658
|
+
"declaration": {
|
17659
|
+
"name": "Icon",
|
17660
|
+
"module": "components/icon/icon.component.js"
|
17661
|
+
}
|
17662
|
+
}
|
17663
|
+
]
|
17664
|
+
},
|
17417
17665
|
{
|
17418
17666
|
"kind": "javascript-module",
|
17419
17667
|
"path": "components/iconprovider/iconprovider.component.js",
|
@@ -17944,254 +18192,6 @@
|
|
17944
18192
|
}
|
17945
18193
|
]
|
17946
18194
|
},
|
17947
|
-
{
|
17948
|
-
"kind": "javascript-module",
|
17949
|
-
"path": "components/icon/icon.component.js",
|
17950
|
-
"declarations": [
|
17951
|
-
{
|
17952
|
-
"kind": "class",
|
17953
|
-
"description": "Icon component that dynamically displays SVG icons based on a valid name.\n\nThis component must be mounted within an `IconProvider` component.\n\nThe `IconProvider` defines the source URL from which icons are consumed.\nThe `Icon` component accepts a `name` attribute, which corresponds to\nthe file name of the icon to be loaded from the specified URL.\n\nOnce fetched, the icon will be rendered. If the fetching process is unsuccessful,\nno icon will be displayed.\n\nThe `size` attribute allows for dynamic sizing of the icon based on the provided\n`length-unit` attribute. This unit can either come from the `IconProvider`\nor can be overridden for each individual icon. For example:\nif `size = 1` and `length-unit = 'em'`, the dimensions of the icon will be\n`width: 1em; height: 1em`.\n\nRegarding accessibility, there are three types of icons: decorative, informative and informative standalone.\n\n### Decorative Icons\n- Decorative icons do not convey any essential information to the content of a page.\n- They should be hidden from screen readers (SR) to prevent confusion for users.\n- For decorative icons, an `aria-label` is not required, and the `role` will be set to null.\n\n### Informative Icons\n- Informative icons convey important information that is not adequately represented\n by surrounding text or components.\n- They provide valuable context and must be announced by assistive technologies.\n- For informative icons, an `aria-label` is required, and the `role` will be set to \"img\" automatically.\n- If an `aria-label` is provided, the role will be set to 'img'; if it is absent,\n the role will be unset.\n\n### Informative Standalone Icons\n- If an icon is informative (as mentioned above) and does not belong to a button (=standalone), it must\nhave a Tooltip that describes what it means.\n- For informative standalone icons, an `aria-label` & `tabindex=\"0\"` is required,\nand the `role` will be set to \"img\" automatically.\n- **Only use this when a Icon is standalone and is not part of a button or other interactive elements.**",
|
17954
|
-
"name": "Icon",
|
17955
|
-
"cssProperties": [
|
17956
|
-
{
|
17957
|
-
"description": "Allows customization of the default fill color.",
|
17958
|
-
"name": "--mdc-icon-fill-color"
|
17959
|
-
},
|
17960
|
-
{
|
17961
|
-
"description": "Allows customization of the icon size.",
|
17962
|
-
"name": "--mdc-icon-size"
|
17963
|
-
},
|
17964
|
-
{
|
17965
|
-
"description": "Allows customization of the icon border radius.",
|
17966
|
-
"name": "--mdc-icon-border-radius"
|
17967
|
-
}
|
17968
|
-
],
|
17969
|
-
"cssParts": [
|
17970
|
-
{
|
17971
|
-
"description": "The svg inside the icon element.",
|
17972
|
-
"name": "icon"
|
17973
|
-
}
|
17974
|
-
],
|
17975
|
-
"members": [
|
17976
|
-
{
|
17977
|
-
"kind": "field",
|
17978
|
-
"name": "iconData",
|
17979
|
-
"type": {
|
17980
|
-
"text": "HTMLElement | undefined"
|
17981
|
-
},
|
17982
|
-
"privacy": "private"
|
17983
|
-
},
|
17984
|
-
{
|
17985
|
-
"kind": "field",
|
17986
|
-
"name": "lengthUnitFromContext",
|
17987
|
-
"type": {
|
17988
|
-
"text": "string | undefined"
|
17989
|
-
},
|
17990
|
-
"privacy": "private"
|
17991
|
-
},
|
17992
|
-
{
|
17993
|
-
"kind": "field",
|
17994
|
-
"name": "sizeFromContext",
|
17995
|
-
"type": {
|
17996
|
-
"text": "number | undefined"
|
17997
|
-
},
|
17998
|
-
"privacy": "private"
|
17999
|
-
},
|
18000
|
-
{
|
18001
|
-
"kind": "field",
|
18002
|
-
"name": "name",
|
18003
|
-
"type": {
|
18004
|
-
"text": "IconNames | undefined"
|
18005
|
-
},
|
18006
|
-
"description": "Name of the icon (= filename)",
|
18007
|
-
"attribute": "name",
|
18008
|
-
"reflects": true
|
18009
|
-
},
|
18010
|
-
{
|
18011
|
-
"kind": "field",
|
18012
|
-
"name": "size",
|
18013
|
-
"type": {
|
18014
|
-
"text": "number | undefined"
|
18015
|
-
},
|
18016
|
-
"description": "Size of the icon (works in combination with length unit)",
|
18017
|
-
"attribute": "size"
|
18018
|
-
},
|
18019
|
-
{
|
18020
|
-
"kind": "field",
|
18021
|
-
"name": "lengthUnit",
|
18022
|
-
"type": {
|
18023
|
-
"text": "string | undefined"
|
18024
|
-
},
|
18025
|
-
"description": "Length unit attribute for overriding length-unit from `IconProvider`",
|
18026
|
-
"attribute": "length-unit"
|
18027
|
-
},
|
18028
|
-
{
|
18029
|
-
"kind": "field",
|
18030
|
-
"name": "ariaLabel",
|
18031
|
-
"type": {
|
18032
|
-
"text": "string | null"
|
18033
|
-
},
|
18034
|
-
"default": "null",
|
18035
|
-
"description": "Aria-label attribute to be set for accessibility",
|
18036
|
-
"attribute": "aria-label"
|
18037
|
-
},
|
18038
|
-
{
|
18039
|
-
"kind": "field",
|
18040
|
-
"name": "ariaLabelledBy",
|
18041
|
-
"type": {
|
18042
|
-
"text": "string | null"
|
18043
|
-
},
|
18044
|
-
"default": "null",
|
18045
|
-
"description": "Aria-labelledby attribute to be set for accessibility",
|
18046
|
-
"attribute": "aria-labelledby"
|
18047
|
-
},
|
18048
|
-
{
|
18049
|
-
"kind": "field",
|
18050
|
-
"name": "iconProviderContext",
|
18051
|
-
"privacy": "private",
|
18052
|
-
"readonly": true
|
18053
|
-
},
|
18054
|
-
{
|
18055
|
-
"kind": "field",
|
18056
|
-
"name": "abortController",
|
18057
|
-
"type": {
|
18058
|
-
"text": "AbortController | undefined"
|
18059
|
-
},
|
18060
|
-
"privacy": "private",
|
18061
|
-
"default": "new AbortController()"
|
18062
|
-
},
|
18063
|
-
{
|
18064
|
-
"kind": "method",
|
18065
|
-
"name": "prepareIconElement",
|
18066
|
-
"privacy": "private",
|
18067
|
-
"parameters": [
|
18068
|
-
{
|
18069
|
-
"name": "iconData",
|
18070
|
-
"type": {
|
18071
|
-
"text": "string"
|
18072
|
-
},
|
18073
|
-
"description": "The icon string to be parsed"
|
18074
|
-
}
|
18075
|
-
],
|
18076
|
-
"description": "Parse the icon string to an html element, set the attributes and\nreturn the icon element",
|
18077
|
-
"return": {
|
18078
|
-
"type": {
|
18079
|
-
"text": ""
|
18080
|
-
}
|
18081
|
-
}
|
18082
|
-
},
|
18083
|
-
{
|
18084
|
-
"kind": "method",
|
18085
|
-
"name": "getIconData",
|
18086
|
-
"privacy": "private",
|
18087
|
-
"description": "Fetches the icon (currently only svg) and sets state and attributes once fetched successfully\n\nThis method uses abortController.signal to cancel the fetch request when the component is disconnected or updated.\nIf the request is aborted after the fetch() call has been fulfilled but before the response body has been read,\nthen attempting to read the response body will reject with an AbortError exception."
|
18088
|
-
},
|
18089
|
-
{
|
18090
|
-
"kind": "method",
|
18091
|
-
"name": "handleIconLoadedSuccess",
|
18092
|
-
"privacy": "private",
|
18093
|
-
"parameters": [
|
18094
|
-
{
|
18095
|
-
"name": "iconHtml",
|
18096
|
-
"type": {
|
18097
|
-
"text": "HTMLElement"
|
18098
|
-
},
|
18099
|
-
"description": "The icon html element which has been fetched from the icon provider."
|
18100
|
-
}
|
18101
|
-
],
|
18102
|
-
"description": "Sets the iconData state to the fetched icon.\nDispatches a 'load' event on the component once the icon has been successfully loaded."
|
18103
|
-
},
|
18104
|
-
{
|
18105
|
-
"kind": "method",
|
18106
|
-
"name": "handleIconLoadedFailure",
|
18107
|
-
"privacy": "private",
|
18108
|
-
"parameters": [
|
18109
|
-
{
|
18110
|
-
"name": "error",
|
18111
|
-
"type": {
|
18112
|
-
"text": "unknown"
|
18113
|
-
}
|
18114
|
-
}
|
18115
|
-
],
|
18116
|
-
"description": "Dispatches an 'error' event on the component when the icon fetching has failed.\nThis event bubbles and is cancelable.\nThe error detail is set to the error object."
|
18117
|
-
},
|
18118
|
-
{
|
18119
|
-
"kind": "method",
|
18120
|
-
"name": "updateSize",
|
18121
|
-
"privacy": "private",
|
18122
|
-
"description": "Updates the size by setting the width and height"
|
18123
|
-
},
|
18124
|
-
{
|
18125
|
-
"kind": "field",
|
18126
|
-
"name": "computedIconSize",
|
18127
|
-
"privacy": "private",
|
18128
|
-
"readonly": true
|
18129
|
-
}
|
18130
|
-
],
|
18131
|
-
"attributes": [
|
18132
|
-
{
|
18133
|
-
"name": "name",
|
18134
|
-
"type": {
|
18135
|
-
"text": "IconNames | undefined"
|
18136
|
-
},
|
18137
|
-
"description": "Name of the icon (= filename)",
|
18138
|
-
"fieldName": "name"
|
18139
|
-
},
|
18140
|
-
{
|
18141
|
-
"name": "size",
|
18142
|
-
"type": {
|
18143
|
-
"text": "number | undefined"
|
18144
|
-
},
|
18145
|
-
"description": "Size of the icon (works in combination with length unit)",
|
18146
|
-
"fieldName": "size"
|
18147
|
-
},
|
18148
|
-
{
|
18149
|
-
"name": "length-unit",
|
18150
|
-
"type": {
|
18151
|
-
"text": "string | undefined"
|
18152
|
-
},
|
18153
|
-
"description": "Length unit attribute for overriding length-unit from `IconProvider`",
|
18154
|
-
"fieldName": "lengthUnit"
|
18155
|
-
},
|
18156
|
-
{
|
18157
|
-
"name": "aria-label",
|
18158
|
-
"type": {
|
18159
|
-
"text": "string | null"
|
18160
|
-
},
|
18161
|
-
"default": "null",
|
18162
|
-
"description": "Aria-label attribute to be set for accessibility",
|
18163
|
-
"fieldName": "ariaLabel"
|
18164
|
-
},
|
18165
|
-
{
|
18166
|
-
"name": "aria-labelledby",
|
18167
|
-
"type": {
|
18168
|
-
"text": "string | null"
|
18169
|
-
},
|
18170
|
-
"default": "null",
|
18171
|
-
"description": "Aria-labelledby attribute to be set for accessibility",
|
18172
|
-
"fieldName": "ariaLabelledBy"
|
18173
|
-
}
|
18174
|
-
],
|
18175
|
-
"superclass": {
|
18176
|
-
"name": "Component",
|
18177
|
-
"module": "/src/models"
|
18178
|
-
},
|
18179
|
-
"tagName": "mdc-icon",
|
18180
|
-
"jsDoc": "/**\n * Icon component that dynamically displays SVG icons based on a valid name.\n *\n * This component must be mounted within an `IconProvider` component.\n *\n * The `IconProvider` defines the source URL from which icons are consumed.\n * The `Icon` component accepts a `name` attribute, which corresponds to\n * the file name of the icon to be loaded from the specified URL.\n *\n * Once fetched, the icon will be rendered. If the fetching process is unsuccessful,\n * no icon will be displayed.\n *\n * The `size` attribute allows for dynamic sizing of the icon based on the provided\n * `length-unit` attribute. This unit can either come from the `IconProvider`\n * or can be overridden for each individual icon. For example:\n * if `size = 1` and `length-unit = 'em'`, the dimensions of the icon will be\n * `width: 1em; height: 1em`.\n *\n * Regarding accessibility, there are three types of icons: decorative, informative and informative standalone.\n *\n * ### Decorative Icons\n * - Decorative icons do not convey any essential information to the content of a page.\n * - They should be hidden from screen readers (SR) to prevent confusion for users.\n * - For decorative icons, an `aria-label` is not required, and the `role` will be set to null.\n *\n * ### Informative Icons\n * - Informative icons convey important information that is not adequately represented\n * by surrounding text or components.\n * - They provide valuable context and must be announced by assistive technologies.\n * - For informative icons, an `aria-label` is required, and the `role` will be set to \"img\" automatically.\n * - If an `aria-label` is provided, the role will be set to 'img'; if it is absent,\n * the role will be unset.\n *\n * ### Informative Standalone Icons\n * - If an icon is informative (as mentioned above) and does not belong to a button (=standalone), it must\n * have a Tooltip that describes what it means.\n * - For informative standalone icons, an `aria-label` & `tabindex=\"0\"` is required,\n * and the `role` will be set to \"img\" automatically.\n * - **Only use this when a Icon is standalone and is not part of a button or other interactive elements.**\n *\n * @tagname mdc-icon\n *\n * @cssproperty --mdc-icon-fill-color - Allows customization of the default fill color.\n * @cssproperty --mdc-icon-size - Allows customization of the icon size.\n * @cssproperty --mdc-icon-border-radius - Allows customization of the icon border radius.\n *\n * @csspart icon - The svg inside the icon element.\n */",
|
18181
|
-
"customElement": true
|
18182
|
-
}
|
18183
|
-
],
|
18184
|
-
"exports": [
|
18185
|
-
{
|
18186
|
-
"kind": "js",
|
18187
|
-
"name": "default",
|
18188
|
-
"declaration": {
|
18189
|
-
"name": "Icon",
|
18190
|
-
"module": "components/icon/icon.component.js"
|
18191
|
-
}
|
18192
|
-
}
|
18193
|
-
]
|
18194
|
-
},
|
18195
18195
|
{
|
18196
18196
|
"kind": "javascript-module",
|
18197
18197
|
"path": "components/input/input.component.js",
|
@@ -21253,7 +21253,7 @@
|
|
21253
21253
|
{
|
21254
21254
|
"name": "target",
|
21255
21255
|
"type": {
|
21256
|
-
"text": "
|
21256
|
+
"text": "HTMLElement | null"
|
21257
21257
|
},
|
21258
21258
|
"description": "The target element that triggered the event."
|
21259
21259
|
}
|
@@ -21536,7 +21536,7 @@
|
|
21536
21536
|
{
|
21537
21537
|
"name": "target",
|
21538
21538
|
"type": {
|
21539
|
-
"text": "
|
21539
|
+
"text": "HTMLElement | null"
|
21540
21540
|
},
|
21541
21541
|
"description": "The target element that triggered the event."
|
21542
21542
|
}
|
@@ -22068,6 +22068,20 @@
|
|
22068
22068
|
"kind": "method",
|
22069
22069
|
"name": "triggerClickEvent",
|
22070
22070
|
"privacy": "protected",
|
22071
|
+
"return": {
|
22072
|
+
"type": {
|
22073
|
+
"text": ""
|
22074
|
+
}
|
22075
|
+
},
|
22076
|
+
"parameters": [
|
22077
|
+
{
|
22078
|
+
"name": "event",
|
22079
|
+
"type": {
|
22080
|
+
"text": "Event"
|
22081
|
+
},
|
22082
|
+
"description": "The event that triggered the click."
|
22083
|
+
}
|
22084
|
+
],
|
22071
22085
|
"description": "Triggers a click event on the list item."
|
22072
22086
|
},
|
22073
22087
|
{
|
@@ -23179,6 +23193,20 @@
|
|
23179
23193
|
"kind": "method",
|
23180
23194
|
"name": "triggerClickEvent",
|
23181
23195
|
"privacy": "protected",
|
23196
|
+
"return": {
|
23197
|
+
"type": {
|
23198
|
+
"text": ""
|
23199
|
+
}
|
23200
|
+
},
|
23201
|
+
"parameters": [
|
23202
|
+
{
|
23203
|
+
"name": "event",
|
23204
|
+
"type": {
|
23205
|
+
"text": "Event"
|
23206
|
+
},
|
23207
|
+
"description": "The event that triggered the click."
|
23208
|
+
}
|
23209
|
+
],
|
23182
23210
|
"description": "Triggers a click event on the list item.",
|
23183
23211
|
"inheritedFrom": {
|
23184
23212
|
"name": "ListItem",
|
@@ -24211,6 +24239,20 @@
|
|
24211
24239
|
"kind": "method",
|
24212
24240
|
"name": "triggerClickEvent",
|
24213
24241
|
"privacy": "protected",
|
24242
|
+
"return": {
|
24243
|
+
"type": {
|
24244
|
+
"text": ""
|
24245
|
+
}
|
24246
|
+
},
|
24247
|
+
"parameters": [
|
24248
|
+
{
|
24249
|
+
"name": "event",
|
24250
|
+
"type": {
|
24251
|
+
"text": "Event"
|
24252
|
+
},
|
24253
|
+
"description": "The event that triggered the click."
|
24254
|
+
}
|
24255
|
+
],
|
24214
24256
|
"description": "Triggers a click event on the list item.",
|
24215
24257
|
"inheritedFrom": {
|
24216
24258
|
"name": "ListItem",
|
@@ -25202,6 +25244,20 @@
|
|
25202
25244
|
"kind": "method",
|
25203
25245
|
"name": "triggerClickEvent",
|
25204
25246
|
"privacy": "protected",
|
25247
|
+
"return": {
|
25248
|
+
"type": {
|
25249
|
+
"text": ""
|
25250
|
+
}
|
25251
|
+
},
|
25252
|
+
"parameters": [
|
25253
|
+
{
|
25254
|
+
"name": "event",
|
25255
|
+
"type": {
|
25256
|
+
"text": "Event"
|
25257
|
+
},
|
25258
|
+
"description": "The event that triggered the click."
|
25259
|
+
}
|
25260
|
+
],
|
25205
25261
|
"description": "Triggers a click event on the list item.",
|
25206
25262
|
"inheritedFrom": {
|
25207
25263
|
"name": "ListItem",
|
@@ -28648,6 +28704,20 @@
|
|
28648
28704
|
"kind": "method",
|
28649
28705
|
"name": "triggerClickEvent",
|
28650
28706
|
"privacy": "protected",
|
28707
|
+
"return": {
|
28708
|
+
"type": {
|
28709
|
+
"text": ""
|
28710
|
+
}
|
28711
|
+
},
|
28712
|
+
"parameters": [
|
28713
|
+
{
|
28714
|
+
"name": "event",
|
28715
|
+
"type": {
|
28716
|
+
"text": "Event"
|
28717
|
+
},
|
28718
|
+
"description": "The event that triggered the click."
|
28719
|
+
}
|
28720
|
+
],
|
28651
28721
|
"description": "Triggers a click event on the list item.",
|
28652
28722
|
"inheritedFrom": {
|
28653
28723
|
"name": "ListItem",
|
@@ -29759,6 +29829,20 @@
|
|
29759
29829
|
"kind": "method",
|
29760
29830
|
"name": "triggerClickEvent",
|
29761
29831
|
"privacy": "protected",
|
29832
|
+
"return": {
|
29833
|
+
"type": {
|
29834
|
+
"text": ""
|
29835
|
+
}
|
29836
|
+
},
|
29837
|
+
"parameters": [
|
29838
|
+
{
|
29839
|
+
"name": "event",
|
29840
|
+
"type": {
|
29841
|
+
"text": "Event"
|
29842
|
+
},
|
29843
|
+
"description": "The event that triggered the click."
|
29844
|
+
}
|
29845
|
+
],
|
29762
29846
|
"description": "Triggers a click event on the list item.",
|
29763
29847
|
"inheritedFrom": {
|
29764
29848
|
"name": "ListItem",
|
@@ -35774,130 +35858,831 @@
|
|
35774
35858
|
},
|
35775
35859
|
{
|
35776
35860
|
"kind": "javascript-module",
|
35777
|
-
"path": "components/
|
35861
|
+
"path": "components/radiogroup/radiogroup.component.js",
|
35778
35862
|
"declarations": [
|
35779
35863
|
{
|
35780
35864
|
"kind": "class",
|
35781
|
-
"description": "`mdc-
|
35782
|
-
"name": "
|
35783
|
-
"
|
35865
|
+
"description": "`mdc-radiogroup` - This is the wrapper component for radio buttons which are grouped together.\nIt can have a header text and a description. It enables users to select a single option from a set of options.\nIt is often used in forms, settings, and selection in lists. It automatically group the radio buttons inside it.",
|
35866
|
+
"name": "RadioGroup",
|
35867
|
+
"cssProperties": [
|
35784
35868
|
{
|
35785
|
-
"description": "
|
35869
|
+
"description": "color of the description text",
|
35870
|
+
"name": "--mdc-radiogroup-description-text-normal"
|
35871
|
+
}
|
35872
|
+
],
|
35873
|
+
"members": [
|
35874
|
+
{
|
35875
|
+
"kind": "field",
|
35876
|
+
"name": "name",
|
35877
|
+
"type": {
|
35878
|
+
"text": "string"
|
35879
|
+
},
|
35880
|
+
"default": "''",
|
35881
|
+
"description": "Name of the radio group.\nThey are used to group elements in a form together.",
|
35882
|
+
"attribute": "name"
|
35883
|
+
},
|
35884
|
+
{
|
35885
|
+
"kind": "field",
|
35886
|
+
"name": "dataAriaLabel",
|
35887
|
+
"type": {
|
35888
|
+
"text": "string | null"
|
35889
|
+
},
|
35890
|
+
"default": "null",
|
35891
|
+
"description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
|
35892
|
+
"attribute": "data-aria-label",
|
35893
|
+
"reflects": true,
|
35894
|
+
"inheritedFrom": {
|
35895
|
+
"name": "DataAriaLabelMixin",
|
35896
|
+
"module": "utils/mixins/DataAriaLabelMixin.js"
|
35897
|
+
}
|
35898
|
+
},
|
35899
|
+
{
|
35900
|
+
"kind": "field",
|
35901
|
+
"name": "disabled",
|
35902
|
+
"type": {
|
35903
|
+
"text": "boolean | undefined"
|
35904
|
+
},
|
35905
|
+
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
35906
|
+
"default": "undefined",
|
35907
|
+
"attribute": "disabled",
|
35908
|
+
"reflects": true,
|
35909
|
+
"inheritedFrom": {
|
35910
|
+
"name": "FormfieldWrapper",
|
35911
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
35912
|
+
}
|
35913
|
+
},
|
35914
|
+
{
|
35915
|
+
"kind": "field",
|
35786
35916
|
"name": "label",
|
35917
|
+
"type": {
|
35918
|
+
"text": "string | undefined"
|
35919
|
+
},
|
35920
|
+
"description": "The label of the input field. It is linked to the input field using the `for` attribute.",
|
35921
|
+
"attribute": "label",
|
35922
|
+
"reflects": true,
|
35787
35923
|
"inheritedFrom": {
|
35788
35924
|
"name": "FormfieldWrapper",
|
35789
|
-
"module": "
|
35925
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
35790
35926
|
}
|
35791
35927
|
},
|
35792
35928
|
{
|
35793
|
-
"
|
35794
|
-
"name": "
|
35929
|
+
"kind": "field",
|
35930
|
+
"name": "required",
|
35931
|
+
"type": {
|
35932
|
+
"text": "boolean"
|
35933
|
+
},
|
35934
|
+
"default": "false",
|
35935
|
+
"description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
|
35936
|
+
"attribute": "required",
|
35937
|
+
"reflects": true,
|
35795
35938
|
"inheritedFrom": {
|
35796
35939
|
"name": "FormfieldWrapper",
|
35797
|
-
"module": "
|
35940
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
35798
35941
|
}
|
35799
35942
|
},
|
35800
35943
|
{
|
35801
|
-
"
|
35802
|
-
"name": "
|
35944
|
+
"kind": "field",
|
35945
|
+
"name": "helpTextType",
|
35946
|
+
"type": {
|
35947
|
+
"text": "ValidationType"
|
35948
|
+
},
|
35949
|
+
"description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
|
35950
|
+
"attribute": "help-text-type",
|
35951
|
+
"reflects": true,
|
35803
35952
|
"inheritedFrom": {
|
35804
|
-
"name": "
|
35805
|
-
"module": "
|
35953
|
+
"name": "FormfieldWrapper",
|
35954
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
35806
35955
|
}
|
35807
35956
|
},
|
35808
35957
|
{
|
35809
|
-
"
|
35810
|
-
"name": "
|
35958
|
+
"kind": "field",
|
35959
|
+
"name": "helpText",
|
35960
|
+
"type": {
|
35961
|
+
"text": "string | undefined"
|
35962
|
+
},
|
35963
|
+
"description": "The help text that is displayed below the input field.",
|
35964
|
+
"attribute": "help-text",
|
35965
|
+
"reflects": true,
|
35811
35966
|
"inheritedFrom": {
|
35812
|
-
"name": "
|
35813
|
-
"module": "
|
35967
|
+
"name": "FormfieldWrapper",
|
35968
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
35814
35969
|
}
|
35815
35970
|
},
|
35816
35971
|
{
|
35817
|
-
"
|
35818
|
-
"name": "
|
35972
|
+
"kind": "field",
|
35973
|
+
"name": "toggletipText",
|
35974
|
+
"type": {
|
35975
|
+
"text": "string | undefined"
|
35976
|
+
},
|
35977
|
+
"description": "The toggletip text that is displayed when the label is hovered.\nIt is used to provide additional information about the label.",
|
35978
|
+
"attribute": "toggletip-text",
|
35979
|
+
"reflects": true,
|
35819
35980
|
"inheritedFrom": {
|
35820
|
-
"name": "
|
35821
|
-
"module": "
|
35981
|
+
"name": "FormfieldWrapper",
|
35982
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
35822
35983
|
}
|
35823
35984
|
},
|
35824
35985
|
{
|
35825
|
-
"
|
35826
|
-
"name": "
|
35986
|
+
"kind": "field",
|
35987
|
+
"name": "toggletipPlacement",
|
35988
|
+
"type": {
|
35989
|
+
"text": "PopoverPlacement"
|
35990
|
+
},
|
35991
|
+
"description": "The placement of the toggletip that is displayed when the info icon is hovered.",
|
35992
|
+
"default": "'top'",
|
35993
|
+
"attribute": "toggletip-placement",
|
35994
|
+
"reflects": true,
|
35827
35995
|
"inheritedFrom": {
|
35828
|
-
"name": "
|
35829
|
-
"module": "
|
35996
|
+
"name": "FormfieldWrapper",
|
35997
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
35830
35998
|
}
|
35831
35999
|
},
|
35832
36000
|
{
|
35833
|
-
"
|
35834
|
-
"name": "
|
36001
|
+
"kind": "field",
|
36002
|
+
"name": "toggletipStrategy",
|
36003
|
+
"type": {
|
36004
|
+
"text": "PopoverStrategy"
|
36005
|
+
},
|
36006
|
+
"attribute": "toggletip-strategy",
|
36007
|
+
"reflects": true,
|
35835
36008
|
"inheritedFrom": {
|
35836
|
-
"name": "
|
35837
|
-
"module": "
|
36009
|
+
"name": "FormfieldWrapper",
|
36010
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
35838
36011
|
}
|
35839
36012
|
},
|
35840
36013
|
{
|
35841
|
-
"
|
35842
|
-
"name": "
|
36014
|
+
"kind": "field",
|
36015
|
+
"name": "infoIconAriaLabel",
|
36016
|
+
"type": {
|
36017
|
+
"text": "string | undefined"
|
36018
|
+
},
|
36019
|
+
"description": "Aria label for the info icon that is displayed next to the label when `toggletipText` is set.\nThis is used for accessibility purposes to provide a description of the icon.",
|
36020
|
+
"attribute": "info-icon-aria-label",
|
36021
|
+
"reflects": true,
|
36022
|
+
"inheritedFrom": {
|
36023
|
+
"name": "FormfieldWrapper",
|
36024
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
36025
|
+
}
|
36026
|
+
},
|
36027
|
+
{
|
36028
|
+
"kind": "method",
|
36029
|
+
"name": "renderLabelElement",
|
36030
|
+
"privacy": "protected",
|
36031
|
+
"description": "creates the label element when the label property is set.\nid is used to link the label with the input field.",
|
36032
|
+
"return": {
|
36033
|
+
"type": {
|
36034
|
+
"text": ""
|
36035
|
+
}
|
36036
|
+
},
|
36037
|
+
"inheritedFrom": {
|
36038
|
+
"name": "FormfieldWrapper",
|
36039
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
36040
|
+
}
|
36041
|
+
},
|
36042
|
+
{
|
36043
|
+
"kind": "method",
|
36044
|
+
"name": "renderHelpTextIcon",
|
36045
|
+
"privacy": "protected",
|
36046
|
+
"description": "creates the helpertext icon based on the helpTextType for validation.\nIf the helpTextType is not set, it defaults to 'default' and it doesn't display any icon.",
|
36047
|
+
"return": {
|
36048
|
+
"type": {
|
36049
|
+
"text": ""
|
36050
|
+
}
|
36051
|
+
},
|
36052
|
+
"inheritedFrom": {
|
36053
|
+
"name": "FormfieldWrapper",
|
36054
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
36055
|
+
}
|
36056
|
+
},
|
36057
|
+
{
|
36058
|
+
"kind": "method",
|
36059
|
+
"name": "renderHelpText",
|
36060
|
+
"privacy": "protected",
|
36061
|
+
"description": "creates the helper text component when the helpertext value is set.\nIt is also used to display the validation message based on the helpTextType.",
|
36062
|
+
"return": {
|
36063
|
+
"type": {
|
36064
|
+
"text": ""
|
36065
|
+
}
|
36066
|
+
},
|
36067
|
+
"inheritedFrom": {
|
36068
|
+
"name": "FormfieldWrapper",
|
36069
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
36070
|
+
}
|
36071
|
+
},
|
36072
|
+
{
|
36073
|
+
"kind": "method",
|
36074
|
+
"name": "renderLabel",
|
36075
|
+
"privacy": "protected",
|
36076
|
+
"description": "renders the label container that contains the label and labelInfoToggleTip.",
|
36077
|
+
"return": {
|
36078
|
+
"type": {
|
36079
|
+
"text": ""
|
36080
|
+
}
|
36081
|
+
},
|
36082
|
+
"inheritedFrom": {
|
36083
|
+
"name": "FormfieldWrapper",
|
36084
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
36085
|
+
}
|
36086
|
+
},
|
36087
|
+
{
|
36088
|
+
"kind": "method",
|
36089
|
+
"name": "renderHelperText",
|
36090
|
+
"privacy": "protected",
|
36091
|
+
"description": "renders the help-text container that contains the helpertext icon and helpertext.",
|
36092
|
+
"return": {
|
36093
|
+
"type": {
|
36094
|
+
"text": ""
|
36095
|
+
}
|
36096
|
+
},
|
36097
|
+
"inheritedFrom": {
|
36098
|
+
"name": "FormfieldWrapper",
|
36099
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
36100
|
+
}
|
36101
|
+
}
|
36102
|
+
],
|
36103
|
+
"attributes": [
|
36104
|
+
{
|
36105
|
+
"name": "name",
|
36106
|
+
"type": {
|
36107
|
+
"text": "string"
|
36108
|
+
},
|
36109
|
+
"default": "''",
|
36110
|
+
"description": "Name of the radio group.\nThey are used to group elements in a form together.",
|
36111
|
+
"fieldName": "name"
|
36112
|
+
},
|
36113
|
+
{
|
36114
|
+
"name": "data-aria-label",
|
36115
|
+
"type": {
|
36116
|
+
"text": "string | null"
|
36117
|
+
},
|
36118
|
+
"default": "null",
|
36119
|
+
"description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
|
36120
|
+
"fieldName": "dataAriaLabel",
|
36121
|
+
"inheritedFrom": {
|
36122
|
+
"name": "DataAriaLabelMixin",
|
36123
|
+
"module": "src/utils/mixins/DataAriaLabelMixin.ts"
|
36124
|
+
}
|
36125
|
+
},
|
36126
|
+
{
|
36127
|
+
"name": "disabled",
|
36128
|
+
"type": {
|
36129
|
+
"text": "boolean | undefined"
|
36130
|
+
},
|
36131
|
+
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
36132
|
+
"default": "undefined",
|
36133
|
+
"fieldName": "disabled",
|
35843
36134
|
"inheritedFrom": {
|
35844
36135
|
"name": "FormfieldWrapper",
|
35845
36136
|
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
35846
36137
|
}
|
35847
36138
|
},
|
35848
36139
|
{
|
35849
|
-
"
|
35850
|
-
"
|
36140
|
+
"name": "label",
|
36141
|
+
"type": {
|
36142
|
+
"text": "string | undefined"
|
36143
|
+
},
|
36144
|
+
"description": "The label of the input field. It is linked to the input field using the `for` attribute.",
|
36145
|
+
"fieldName": "label",
|
35851
36146
|
"inheritedFrom": {
|
35852
36147
|
"name": "FormfieldWrapper",
|
35853
36148
|
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
35854
36149
|
}
|
35855
36150
|
},
|
35856
36151
|
{
|
35857
|
-
"
|
35858
|
-
"
|
36152
|
+
"name": "required",
|
36153
|
+
"type": {
|
36154
|
+
"text": "boolean"
|
36155
|
+
},
|
36156
|
+
"default": "false",
|
36157
|
+
"description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
|
36158
|
+
"fieldName": "required",
|
36159
|
+
"inheritedFrom": {
|
36160
|
+
"name": "FormfieldWrapper",
|
36161
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
36162
|
+
}
|
36163
|
+
},
|
36164
|
+
{
|
36165
|
+
"name": "help-text-type",
|
36166
|
+
"type": {
|
36167
|
+
"text": "ValidationType"
|
36168
|
+
},
|
36169
|
+
"description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
|
36170
|
+
"fieldName": "helpTextType",
|
35859
36171
|
"inheritedFrom": {
|
35860
36172
|
"name": "FormfieldWrapper",
|
35861
36173
|
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
35862
36174
|
}
|
35863
36175
|
},
|
35864
36176
|
{
|
35865
|
-
"description": "The helper/validation text element.",
|
35866
36177
|
"name": "help-text",
|
36178
|
+
"type": {
|
36179
|
+
"text": "string | undefined"
|
36180
|
+
},
|
36181
|
+
"description": "The help text that is displayed below the input field.",
|
36182
|
+
"fieldName": "helpText",
|
35867
36183
|
"inheritedFrom": {
|
35868
36184
|
"name": "FormfieldWrapper",
|
35869
36185
|
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
35870
36186
|
}
|
35871
36187
|
},
|
35872
36188
|
{
|
35873
|
-
"
|
35874
|
-
"
|
36189
|
+
"name": "toggletip-text",
|
36190
|
+
"type": {
|
36191
|
+
"text": "string | undefined"
|
36192
|
+
},
|
36193
|
+
"description": "The toggletip text that is displayed when the label is hovered.\nIt is used to provide additional information about the label.",
|
36194
|
+
"fieldName": "toggletipText",
|
35875
36195
|
"inheritedFrom": {
|
35876
36196
|
"name": "FormfieldWrapper",
|
35877
36197
|
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
35878
36198
|
}
|
35879
36199
|
},
|
35880
36200
|
{
|
35881
|
-
"
|
35882
|
-
"
|
36201
|
+
"name": "toggletip-placement",
|
36202
|
+
"type": {
|
36203
|
+
"text": "PopoverPlacement"
|
36204
|
+
},
|
36205
|
+
"description": "The placement of the toggletip that is displayed when the info icon is hovered.",
|
36206
|
+
"default": "'top'",
|
36207
|
+
"fieldName": "toggletipPlacement",
|
35883
36208
|
"inheritedFrom": {
|
35884
36209
|
"name": "FormfieldWrapper",
|
35885
36210
|
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
35886
36211
|
}
|
35887
36212
|
},
|
35888
36213
|
{
|
35889
|
-
"
|
35890
|
-
"
|
36214
|
+
"name": "toggletip-strategy",
|
36215
|
+
"type": {
|
36216
|
+
"text": "PopoverStrategy"
|
36217
|
+
},
|
36218
|
+
"fieldName": "toggletipStrategy",
|
35891
36219
|
"inheritedFrom": {
|
35892
|
-
"name": "
|
35893
|
-
"module": "src/components/
|
36220
|
+
"name": "FormfieldWrapper",
|
36221
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
36222
|
+
}
|
36223
|
+
},
|
36224
|
+
{
|
36225
|
+
"name": "info-icon-aria-label",
|
36226
|
+
"type": {
|
36227
|
+
"text": "string | undefined"
|
36228
|
+
},
|
36229
|
+
"description": "Aria label for the info icon that is displayed next to the label when `toggletipText` is set.\nThis is used for accessibility purposes to provide a description of the icon.",
|
36230
|
+
"fieldName": "infoIconAriaLabel",
|
36231
|
+
"inheritedFrom": {
|
36232
|
+
"name": "FormfieldWrapper",
|
36233
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
35894
36234
|
}
|
35895
36235
|
}
|
35896
36236
|
],
|
36237
|
+
"superclass": {
|
36238
|
+
"name": "FormfieldGroup",
|
36239
|
+
"module": "/src/components/formfieldgroup"
|
36240
|
+
},
|
36241
|
+
"tagName": "mdc-radiogroup",
|
36242
|
+
"jsDoc": "/**\n * `mdc-radiogroup` - This is the wrapper component for radio buttons which are grouped together.\n * It can have a header text and a description. It enables users to select a single option from a set of options.\n * It is often used in forms, settings, and selection in lists. It automatically group the radio buttons inside it.\n *\n * @tagname mdc-radiogroup\n *\n * @cssproperty --mdc-radiogroup-description-text-normal - color of the description text\n *\n */",
|
36243
|
+
"customElement": true,
|
35897
36244
|
"slots": [
|
35898
36245
|
{
|
35899
|
-
"description": "
|
35900
|
-
"name": "
|
36246
|
+
"description": "This is a default slot for checkbox or toggle components.",
|
36247
|
+
"name": "default",
|
36248
|
+
"inheritedFrom": {
|
36249
|
+
"name": "FormfieldGroup",
|
36250
|
+
"module": "src/components/formfieldgroup/formfieldgroup.component.ts"
|
36251
|
+
}
|
36252
|
+
},
|
36253
|
+
{
|
36254
|
+
"description": "Slot for the label element. If not provided, the `label` property will be used to render the label.",
|
36255
|
+
"name": "label",
|
36256
|
+
"inheritedFrom": {
|
36257
|
+
"name": "FormfieldWrapper",
|
36258
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
36259
|
+
}
|
36260
|
+
},
|
36261
|
+
{
|
36262
|
+
"description": "Slot for the toggletip info icon button. If not provided, the `toggletip-text` property will be used to render the info icon button and toggletip.",
|
36263
|
+
"name": "toggletip",
|
36264
|
+
"inheritedFrom": {
|
36265
|
+
"name": "FormfieldWrapper",
|
36266
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
36267
|
+
}
|
36268
|
+
},
|
36269
|
+
{
|
36270
|
+
"description": "Slot for the helper/validation icon. If not provided, the icon will be rendered based on the `helpTextType` property.",
|
36271
|
+
"name": "help-icon",
|
36272
|
+
"inheritedFrom": {
|
36273
|
+
"name": "FormfieldWrapper",
|
36274
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
36275
|
+
}
|
36276
|
+
},
|
36277
|
+
{
|
36278
|
+
"description": "Slot for the helper/validation text. If not provided, the `helpText` property will be used to render the helper/validation text.",
|
36279
|
+
"name": "help-text",
|
36280
|
+
"inheritedFrom": {
|
36281
|
+
"name": "FormfieldWrapper",
|
36282
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
36283
|
+
}
|
36284
|
+
}
|
36285
|
+
],
|
36286
|
+
"cssParts": [
|
36287
|
+
{
|
36288
|
+
"description": "The label element.",
|
36289
|
+
"name": "label",
|
36290
|
+
"inheritedFrom": {
|
36291
|
+
"name": "FormfieldWrapper",
|
36292
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
36293
|
+
}
|
36294
|
+
},
|
36295
|
+
{
|
36296
|
+
"description": "The container for the label and required indicator elements.",
|
36297
|
+
"name": "label-text",
|
36298
|
+
"inheritedFrom": {
|
36299
|
+
"name": "FormfieldWrapper",
|
36300
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
36301
|
+
}
|
36302
|
+
},
|
36303
|
+
{
|
36304
|
+
"description": "The required indicator element that is displayed next to the label when the `required` property is set to true.",
|
36305
|
+
"name": "required-indicator",
|
36306
|
+
"inheritedFrom": {
|
36307
|
+
"name": "FormfieldWrapper",
|
36308
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
36309
|
+
}
|
36310
|
+
},
|
36311
|
+
{
|
36312
|
+
"description": "The info icon button element that is displayed next to the label when the `toggletip-text` property is set.",
|
36313
|
+
"name": "info-icon-btn",
|
36314
|
+
"inheritedFrom": {
|
36315
|
+
"name": "FormfieldWrapper",
|
36316
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
36317
|
+
}
|
36318
|
+
},
|
36319
|
+
{
|
36320
|
+
"description": "The toggletip element that is displayed when the info icon button is clicked.",
|
36321
|
+
"name": "label-toggletip",
|
36322
|
+
"inheritedFrom": {
|
36323
|
+
"name": "FormfieldWrapper",
|
36324
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
36325
|
+
}
|
36326
|
+
},
|
36327
|
+
{
|
36328
|
+
"description": "The helper/validation text element.",
|
36329
|
+
"name": "help-text",
|
36330
|
+
"inheritedFrom": {
|
36331
|
+
"name": "FormfieldWrapper",
|
36332
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
36333
|
+
}
|
36334
|
+
},
|
36335
|
+
{
|
36336
|
+
"description": "The helper/validation icon element that is displayed next to the helper/validation text.",
|
36337
|
+
"name": "helper-icon",
|
36338
|
+
"inheritedFrom": {
|
36339
|
+
"name": "FormfieldWrapper",
|
36340
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
36341
|
+
}
|
36342
|
+
},
|
36343
|
+
{
|
36344
|
+
"description": "The container for the helper/validation icon and text elements.",
|
36345
|
+
"name": "help-text-container",
|
36346
|
+
"inheritedFrom": {
|
36347
|
+
"name": "FormfieldWrapper",
|
36348
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
36349
|
+
}
|
36350
|
+
},
|
36351
|
+
{
|
36352
|
+
"description": "Formfieldgroup host container",
|
36353
|
+
"name": "container",
|
36354
|
+
"inheritedFrom": {
|
36355
|
+
"name": "FormfieldGroup",
|
36356
|
+
"module": "src/components/formfieldgroup/formfieldgroup.component.ts"
|
36357
|
+
}
|
36358
|
+
},
|
36359
|
+
{
|
36360
|
+
"description": "This contains the label and help text for the group",
|
36361
|
+
"name": "group-header",
|
36362
|
+
"inheritedFrom": {
|
36363
|
+
"name": "FormfieldGroup",
|
36364
|
+
"module": "src/components/formfieldgroup/formfieldgroup.component.ts"
|
36365
|
+
}
|
36366
|
+
}
|
36367
|
+
]
|
36368
|
+
}
|
36369
|
+
],
|
36370
|
+
"exports": [
|
36371
|
+
{
|
36372
|
+
"kind": "js",
|
36373
|
+
"name": "default",
|
36374
|
+
"declaration": {
|
36375
|
+
"name": "RadioGroup",
|
36376
|
+
"module": "components/radiogroup/radiogroup.component.js"
|
36377
|
+
}
|
36378
|
+
}
|
36379
|
+
]
|
36380
|
+
},
|
36381
|
+
{
|
36382
|
+
"kind": "javascript-module",
|
36383
|
+
"path": "components/screenreaderannouncer/screenreaderannouncer.component.js",
|
36384
|
+
"declarations": [
|
36385
|
+
{
|
36386
|
+
"kind": "class",
|
36387
|
+
"description": "`mdc-screenreaderannouncer` can be used to announce messages with the screen reader.\n\nTo make an announcement set `announcement` attribute on the `mdc-screenreaderannouncer` element.\n\n**Internal logic**\n\nWhen the screenreader announcer is connected to the DOM, if the `identity` attribute is not\nprovided, it is set to `mdc-screenreaderannouncer-identity` and a `<div>` element with this id is created\nin the DOM. If the `identity` attribute is provided, the identity element is used and no new element\nis created in the DOM.\n\nWhen the `announcement` attribute is set, the screenreader announcer will create a `<div>` element with\n`aria-live` attribute set to the value of `data-aria-live` attribute and append it to the `identity` element.\nAfter delay of `delay` milliseconds, a <p> element with the announcement text is appended to the `<div>` element.\n\nThe announcement `<div>` element is removed from the DOM after `timeout` milliseconds.\n\nWhen the screen announcer component is disconnected from the DOM, all the timeouts are cleared and\nall the announcement elements added are removed from the DOM and timeouts cleared.\n\n**Note**\n1. The default delay of 150 miliseconds is used as we dynamically generate the\naria-live region in the DOM and add the announcement text to it.\n3. If no `identity` is provided, all the screen reader components will create and use only one\n`<div>` element with id `mdc-screenreaderannouncer-identity` in the DOM.\n\nReference: https://patrickhlauke.github.io/aria/tests/live-regions/",
|
36388
|
+
"name": "ScreenreaderAnnouncer",
|
36389
|
+
"members": [
|
36390
|
+
{
|
36391
|
+
"kind": "field",
|
36392
|
+
"name": "announcement",
|
36393
|
+
"type": {
|
36394
|
+
"text": "string"
|
36395
|
+
},
|
36396
|
+
"default": "''",
|
36397
|
+
"description": "The announcement attribute is a string that is used to announce messages to the screen reader.\nThe announcement is made when the announcement attribute is set to a non-empty string.",
|
36398
|
+
"attribute": "announcement",
|
36399
|
+
"reflects": true
|
36400
|
+
},
|
36401
|
+
{
|
36402
|
+
"kind": "field",
|
36403
|
+
"name": "identity",
|
36404
|
+
"type": {
|
36405
|
+
"text": "string"
|
36406
|
+
},
|
36407
|
+
"default": "''",
|
36408
|
+
"description": "The id of the element in the light dom, to which announcement elements will be appended.\n\nIf id is not provided, it will be set to `mdc-screenreaderannouncer-identity` and\na div element with this id will be created in the light dom.",
|
36409
|
+
"attribute": "identity",
|
36410
|
+
"reflects": true
|
36411
|
+
},
|
36412
|
+
{
|
36413
|
+
"kind": "field",
|
36414
|
+
"name": "dataAriaLive",
|
36415
|
+
"type": {
|
36416
|
+
"text": "AriaLive"
|
36417
|
+
},
|
36418
|
+
"description": "Aria live value for announcement.",
|
36419
|
+
"default": "'polite'",
|
36420
|
+
"attribute": "data-aria-live",
|
36421
|
+
"reflects": true
|
36422
|
+
},
|
36423
|
+
{
|
36424
|
+
"kind": "field",
|
36425
|
+
"name": "delay",
|
36426
|
+
"type": {
|
36427
|
+
"text": "number"
|
36428
|
+
},
|
36429
|
+
"description": "Milliseconds to wait before adding the announcement to the identiy region in\nDOM, which will announce the message to the screen reader.",
|
36430
|
+
"default": "150",
|
36431
|
+
"attribute": "delay",
|
36432
|
+
"reflects": true
|
36433
|
+
},
|
36434
|
+
{
|
36435
|
+
"kind": "field",
|
36436
|
+
"name": "timeout",
|
36437
|
+
"type": {
|
36438
|
+
"text": "number"
|
36439
|
+
},
|
36440
|
+
"description": "Milliseconds to wait after which the announcement element will be removed from\nidentity region in DOM, causing the screen reader to not announcing the message.",
|
36441
|
+
"default": "20_000",
|
36442
|
+
"attribute": "timeout",
|
36443
|
+
"reflects": true
|
36444
|
+
},
|
36445
|
+
{
|
36446
|
+
"kind": "method",
|
36447
|
+
"name": "announce",
|
36448
|
+
"parameters": [
|
36449
|
+
{
|
36450
|
+
"name": "announcement",
|
36451
|
+
"type": {
|
36452
|
+
"text": "string"
|
36453
|
+
},
|
36454
|
+
"description": "The announcement to be made."
|
36455
|
+
},
|
36456
|
+
{
|
36457
|
+
"name": "delay",
|
36458
|
+
"type": {
|
36459
|
+
"text": "number"
|
36460
|
+
},
|
36461
|
+
"description": "The delay in milliseconds before announcing the message."
|
36462
|
+
},
|
36463
|
+
{
|
36464
|
+
"name": "timeout",
|
36465
|
+
"type": {
|
36466
|
+
"text": "number"
|
36467
|
+
},
|
36468
|
+
"description": "The timeout in milliseconds before removing the announcement."
|
36469
|
+
},
|
36470
|
+
{
|
36471
|
+
"name": "ariaLive",
|
36472
|
+
"type": {
|
36473
|
+
"text": "AriaLive"
|
36474
|
+
},
|
36475
|
+
"description": "The aria live value for the announcement."
|
36476
|
+
}
|
36477
|
+
],
|
36478
|
+
"description": "Announces the given announcement to the screen reader.\n\nA div element with aria-live attribute set to the given ariaLive value is created\nand a p element with the announcement text is appended to it.\n\nThe div element is appended to the element in the DOM identified with id as\nidentity attribute."
|
36479
|
+
},
|
36480
|
+
{
|
36481
|
+
"kind": "method",
|
36482
|
+
"name": "clearTimeOutsAndAnnouncements",
|
36483
|
+
"privacy": "private",
|
36484
|
+
"description": "Clears all timeouts and removes all announcements from the screen reader."
|
36485
|
+
},
|
36486
|
+
{
|
36487
|
+
"kind": "method",
|
36488
|
+
"name": "createAnnouncementAriaLiveRegion",
|
36489
|
+
"privacy": "private",
|
36490
|
+
"description": "Creates a div element with id as identity attribute in the DOM.\n\nIf the identity attribute is not provided, it is set internally to\n`mdc-screenreaderannouncer-identity`."
|
36491
|
+
}
|
36492
|
+
],
|
36493
|
+
"attributes": [
|
36494
|
+
{
|
36495
|
+
"name": "announcement",
|
36496
|
+
"type": {
|
36497
|
+
"text": "string"
|
36498
|
+
},
|
36499
|
+
"default": "''",
|
36500
|
+
"description": "The announcement attribute is a string that is used to announce messages to the screen reader.\nThe announcement is made when the announcement attribute is set to a non-empty string.",
|
36501
|
+
"fieldName": "announcement"
|
36502
|
+
},
|
36503
|
+
{
|
36504
|
+
"name": "identity",
|
36505
|
+
"type": {
|
36506
|
+
"text": "string"
|
36507
|
+
},
|
36508
|
+
"default": "''",
|
36509
|
+
"description": "The id of the element in the light dom, to which announcement elements will be appended.\n\nIf id is not provided, it will be set to `mdc-screenreaderannouncer-identity` and\na div element with this id will be created in the light dom.",
|
36510
|
+
"fieldName": "identity"
|
36511
|
+
},
|
36512
|
+
{
|
36513
|
+
"name": "data-aria-live",
|
36514
|
+
"type": {
|
36515
|
+
"text": "AriaLive"
|
36516
|
+
},
|
36517
|
+
"description": "Aria live value for announcement.",
|
36518
|
+
"default": "'polite'",
|
36519
|
+
"fieldName": "dataAriaLive"
|
36520
|
+
},
|
36521
|
+
{
|
36522
|
+
"name": "delay",
|
36523
|
+
"type": {
|
36524
|
+
"text": "number"
|
36525
|
+
},
|
36526
|
+
"description": "Milliseconds to wait before adding the announcement to the identiy region in\nDOM, which will announce the message to the screen reader.",
|
36527
|
+
"default": "150",
|
36528
|
+
"fieldName": "delay"
|
36529
|
+
},
|
36530
|
+
{
|
36531
|
+
"name": "timeout",
|
36532
|
+
"type": {
|
36533
|
+
"text": "number"
|
36534
|
+
},
|
36535
|
+
"description": "Milliseconds to wait after which the announcement element will be removed from\nidentity region in DOM, causing the screen reader to not announcing the message.",
|
36536
|
+
"default": "20_000",
|
36537
|
+
"fieldName": "timeout"
|
36538
|
+
}
|
36539
|
+
],
|
36540
|
+
"superclass": {
|
36541
|
+
"name": "Component",
|
36542
|
+
"module": "/src/models"
|
36543
|
+
},
|
36544
|
+
"tagName": "mdc-screenreaderannouncer",
|
36545
|
+
"jsDoc": "/**\n * `mdc-screenreaderannouncer` can be used to announce messages with the screen reader.\n *\n * To make an announcement set `announcement` attribute on the `mdc-screenreaderannouncer` element.\n *\n * **Internal logic**\n *\n * When the screenreader announcer is connected to the DOM, if the `identity` attribute is not\n * provided, it is set to `mdc-screenreaderannouncer-identity` and a `<div>` element with this id is created\n * in the DOM. If the `identity` attribute is provided, the identity element is used and no new element\n * is created in the DOM.\n *\n * When the `announcement` attribute is set, the screenreader announcer will create a `<div>` element with\n * `aria-live` attribute set to the value of `data-aria-live` attribute and append it to the `identity` element.\n * After delay of `delay` milliseconds, a <p> element with the announcement text is appended to the `<div>` element.\n *\n * The announcement `<div>` element is removed from the DOM after `timeout` milliseconds.\n *\n * When the screen announcer component is disconnected from the DOM, all the timeouts are cleared and\n * all the announcement elements added are removed from the DOM and timeouts cleared.\n *\n * **Note**\n * 1. The default delay of 150 miliseconds is used as we dynamically generate the\n * aria-live region in the DOM and add the announcement text to it.\n * 3. If no `identity` is provided, all the screen reader components will create and use only one\n * `<div>` element with id `mdc-screenreaderannouncer-identity` in the DOM.\n *\n * Reference: https://patrickhlauke.github.io/aria/tests/live-regions/\n *\n * @tagname mdc-screenreaderannouncer\n */",
|
36546
|
+
"customElement": true
|
36547
|
+
}
|
36548
|
+
],
|
36549
|
+
"exports": [
|
36550
|
+
{
|
36551
|
+
"kind": "js",
|
36552
|
+
"name": "default",
|
36553
|
+
"declaration": {
|
36554
|
+
"name": "ScreenreaderAnnouncer",
|
36555
|
+
"module": "components/screenreaderannouncer/screenreaderannouncer.component.js"
|
36556
|
+
}
|
36557
|
+
}
|
36558
|
+
]
|
36559
|
+
},
|
36560
|
+
{
|
36561
|
+
"kind": "javascript-module",
|
36562
|
+
"path": "components/searchfield/searchfield.component.js",
|
36563
|
+
"declarations": [
|
36564
|
+
{
|
36565
|
+
"kind": "class",
|
36566
|
+
"description": "`mdc-searchfield` component is used as an input field for search functionality.\n\nIt supports `mdc-inputchip` as filters.\n\nThis component is built by extending the `mdc-input` component.",
|
36567
|
+
"name": "Searchfield",
|
36568
|
+
"cssParts": [
|
36569
|
+
{
|
36570
|
+
"description": "The label element.",
|
36571
|
+
"name": "label",
|
36572
|
+
"inheritedFrom": {
|
36573
|
+
"name": "FormfieldWrapper",
|
36574
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
36575
|
+
}
|
36576
|
+
},
|
36577
|
+
{
|
36578
|
+
"description": "The container for the label and required indicator elements.",
|
36579
|
+
"name": "label-text",
|
36580
|
+
"inheritedFrom": {
|
36581
|
+
"name": "FormfieldWrapper",
|
36582
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
36583
|
+
}
|
36584
|
+
},
|
36585
|
+
{
|
36586
|
+
"description": "The leading icon element that is displayed before the input field.",
|
36587
|
+
"name": "leading-icon",
|
36588
|
+
"inheritedFrom": {
|
36589
|
+
"name": "Input",
|
36590
|
+
"module": "src/components/input/input.component.ts"
|
36591
|
+
}
|
36592
|
+
},
|
36593
|
+
{
|
36594
|
+
"description": "The container for the input field, leading icon, prefix text, and trailing button elements.",
|
36595
|
+
"name": "input-container",
|
36596
|
+
"inheritedFrom": {
|
36597
|
+
"name": "Input",
|
36598
|
+
"module": "src/components/input/input.component.ts"
|
36599
|
+
}
|
36600
|
+
},
|
36601
|
+
{
|
36602
|
+
"description": "The container for the input field, leading icon, and prefix text elements.",
|
36603
|
+
"name": "input-section",
|
36604
|
+
"inheritedFrom": {
|
36605
|
+
"name": "Input",
|
36606
|
+
"module": "src/components/input/input.component.ts"
|
36607
|
+
}
|
36608
|
+
},
|
36609
|
+
{
|
36610
|
+
"description": "The input field element.",
|
36611
|
+
"name": "input-text",
|
36612
|
+
"inheritedFrom": {
|
36613
|
+
"name": "Input",
|
36614
|
+
"module": "src/components/input/input.component.ts"
|
36615
|
+
}
|
36616
|
+
},
|
36617
|
+
{
|
36618
|
+
"description": "The trailing button element that is displayed to clear the input field when the `trailingButton` property is set to true.",
|
36619
|
+
"name": "trailing-button",
|
36620
|
+
"inheritedFrom": {
|
36621
|
+
"name": "Input",
|
36622
|
+
"module": "src/components/input/input.component.ts"
|
36623
|
+
}
|
36624
|
+
},
|
36625
|
+
{
|
36626
|
+
"description": "The required indicator element that is displayed next to the label when the `required` property is set to true.",
|
36627
|
+
"name": "required-indicator",
|
36628
|
+
"inheritedFrom": {
|
36629
|
+
"name": "FormfieldWrapper",
|
36630
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
36631
|
+
}
|
36632
|
+
},
|
36633
|
+
{
|
36634
|
+
"description": "The info icon button element that is displayed next to the label when the `toggletip-text` property is set.",
|
36635
|
+
"name": "info-icon-btn",
|
36636
|
+
"inheritedFrom": {
|
36637
|
+
"name": "FormfieldWrapper",
|
36638
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
36639
|
+
}
|
36640
|
+
},
|
36641
|
+
{
|
36642
|
+
"description": "The toggletip element that is displayed when the info icon button is clicked.",
|
36643
|
+
"name": "label-toggletip",
|
36644
|
+
"inheritedFrom": {
|
36645
|
+
"name": "FormfieldWrapper",
|
36646
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
36647
|
+
}
|
36648
|
+
},
|
36649
|
+
{
|
36650
|
+
"description": "The helper/validation text element.",
|
36651
|
+
"name": "help-text",
|
36652
|
+
"inheritedFrom": {
|
36653
|
+
"name": "FormfieldWrapper",
|
36654
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
36655
|
+
}
|
36656
|
+
},
|
36657
|
+
{
|
36658
|
+
"description": "The helper/validation icon element that is displayed next to the helper/validation text.",
|
36659
|
+
"name": "helper-icon",
|
36660
|
+
"inheritedFrom": {
|
36661
|
+
"name": "FormfieldWrapper",
|
36662
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
36663
|
+
}
|
36664
|
+
},
|
36665
|
+
{
|
36666
|
+
"description": "The container for the helper/validation icon and text elements.",
|
36667
|
+
"name": "help-text-container",
|
36668
|
+
"inheritedFrom": {
|
36669
|
+
"name": "FormfieldWrapper",
|
36670
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
36671
|
+
}
|
36672
|
+
},
|
36673
|
+
{
|
36674
|
+
"description": "The prefix text element that is displayed before the input field.",
|
36675
|
+
"name": "prefix-text",
|
36676
|
+
"inheritedFrom": {
|
36677
|
+
"name": "Input",
|
36678
|
+
"module": "src/components/input/input.component.ts"
|
36679
|
+
}
|
36680
|
+
}
|
36681
|
+
],
|
36682
|
+
"slots": [
|
36683
|
+
{
|
36684
|
+
"description": "Slot for input chips",
|
36685
|
+
"name": "filters"
|
35901
36686
|
},
|
35902
36687
|
{
|
35903
36688
|
"description": "Slot for the label element. If not provided, the `label` property will be used to render the label.",
|
@@ -36655,998 +37440,123 @@
|
|
36655
37440
|
}
|
36656
37441
|
}
|
36657
37442
|
],
|
36658
|
-
"events": [
|
36659
|
-
{
|
36660
|
-
"description": "(React: onInput) This event is dispatched when the value of the input field changes (every press).",
|
36661
|
-
"name": "input",
|
36662
|
-
"reactName": "onInput",
|
36663
|
-
"inheritedFrom": {
|
36664
|
-
"name": "Input",
|
36665
|
-
"module": "src/components/input/input.component.ts"
|
36666
|
-
}
|
36667
|
-
},
|
36668
|
-
{
|
36669
|
-
"description": "(React: onChange) This event is dispatched when the value of the input field changes (on blur).",
|
36670
|
-
"name": "change",
|
36671
|
-
"reactName": "onChange",
|
36672
|
-
"inheritedFrom": {
|
36673
|
-
"name": "Input",
|
36674
|
-
"module": "src/components/input/input.component.ts"
|
36675
|
-
}
|
36676
|
-
},
|
36677
|
-
{
|
36678
|
-
"description": "(React: onFocus) This event is dispatched when the input receives focus.",
|
36679
|
-
"name": "focus",
|
36680
|
-
"reactName": "onFocus",
|
36681
|
-
"inheritedFrom": {
|
36682
|
-
"name": "Input",
|
36683
|
-
"module": "src/components/input/input.component.ts"
|
36684
|
-
}
|
36685
|
-
},
|
36686
|
-
{
|
36687
|
-
"description": "(React: onBlur) This event is dispatched when the input loses focus.",
|
36688
|
-
"name": "blur",
|
36689
|
-
"reactName": "onBlur",
|
36690
|
-
"inheritedFrom": {
|
36691
|
-
"name": "Input",
|
36692
|
-
"module": "src/components/input/input.component.ts"
|
36693
|
-
}
|
36694
|
-
},
|
36695
|
-
{
|
36696
|
-
"name": "clear",
|
36697
|
-
"type": {
|
36698
|
-
"text": "CustomEvent"
|
36699
|
-
},
|
36700
|
-
"description": "(React: onClear) This event is dispatched when the input text is cleared.",
|
36701
|
-
"reactName": "onClear",
|
36702
|
-
"inheritedFrom": {
|
36703
|
-
"name": "Input",
|
36704
|
-
"module": "src/components/input/input.component.ts"
|
36705
|
-
}
|
36706
|
-
},
|
36707
|
-
{
|
36708
|
-
"type": {
|
36709
|
-
"text": "EventConstructor"
|
36710
|
-
},
|
36711
|
-
"inheritedFrom": {
|
36712
|
-
"name": "Input",
|
36713
|
-
"module": "src/components/input/input.component.ts"
|
36714
|
-
}
|
36715
|
-
}
|
36716
|
-
],
|
36717
|
-
"superclass": {
|
36718
|
-
"name": "Input",
|
36719
|
-
"module": "/src/components/input/input.component"
|
36720
|
-
},
|
36721
|
-
"tagName": "mdc-searchfield",
|
36722
|
-
"jsDoc": "/**\n * `mdc-searchfield` component is used as an input field for search functionality.\n *\n * It supports `mdc-inputchip` as filters.\n *\n * This component is built by extending the `mdc-input` component.\n *\n * @tagname mdc-searchfield\n *\n * @event input - (React: onInput) This event is dispatched when the value of the input field changes (every press).\n * @event change - (React: onChange) This event is dispatched when the value of the input field changes (on blur).\n * @event focus - (React: onFocus) This event is dispatched when the input receives focus.\n * @event blur - (React: onBlur) This event is dispatched when the input loses focus.\n * @event clear - (React: onClear) This event is dispatched when the input text is cleared.\n *\n * @slot filters - Slot for input chips\n *\n * @csspart label - The label element.\n * @csspart label-text - The container for the label and required indicator elements.\n * @csspart leading-icon - The leading icon element that is displayed before the input field.\n * @csspart input-container - The container for the input field, leading icon, prefix text, and trailing button elements.\n * @csspart input-section - The container for the input field, leading icon, and prefix text elements.\n * @csspart input-text - The input field element.\n * @csspart trailing-button - The trailing button element that is displayed to clear the input field when the `trailingButton` property is set to true.\n */",
|
36723
|
-
"customElement": true,
|
36724
|
-
"attributes": [
|
36725
|
-
{
|
36726
|
-
"name": "auto-focus-on-mount",
|
36727
|
-
"type": {
|
36728
|
-
"text": "boolean"
|
36729
|
-
},
|
36730
|
-
"default": "false",
|
36731
|
-
"description": "This property indicates whether the element should receive focus automatically when it is mounted.\n\nIt will not focus if the element is re-attached to the DOM after being removed.",
|
36732
|
-
"fieldName": "autoFocusOnMount",
|
36733
|
-
"inheritedFrom": {
|
36734
|
-
"name": "AutoFocusOnMountMixin",
|
36735
|
-
"module": "src/utils/mixins/AutoFocusOnMountMixin.ts"
|
36736
|
-
}
|
36737
|
-
},
|
36738
|
-
{
|
36739
|
-
"name": "name",
|
36740
|
-
"type": {
|
36741
|
-
"text": "string"
|
36742
|
-
},
|
36743
|
-
"default": "''",
|
36744
|
-
"description": "Indicates the name of the component group.\nThey are used to group elements in a form together.",
|
36745
|
-
"fieldName": "name",
|
36746
|
-
"inheritedFrom": {
|
36747
|
-
"name": "FormInternalsMixin",
|
36748
|
-
"module": "src/utils/mixins/FormInternalsMixin.ts"
|
36749
|
-
}
|
36750
|
-
},
|
36751
|
-
{
|
36752
|
-
"name": "value",
|
36753
|
-
"type": {
|
36754
|
-
"text": "string"
|
36755
|
-
},
|
36756
|
-
"default": "''",
|
36757
|
-
"description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
|
36758
|
-
"fieldName": "value",
|
36759
|
-
"inheritedFrom": {
|
36760
|
-
"name": "FormInternalsMixin",
|
36761
|
-
"module": "src/utils/mixins/FormInternalsMixin.ts"
|
36762
|
-
}
|
36763
|
-
},
|
36764
|
-
{
|
36765
|
-
"name": "validation-message",
|
36766
|
-
"type": {
|
36767
|
-
"text": "string | undefined"
|
36768
|
-
},
|
36769
|
-
"description": "Custom validation message that will override the default message and displayed when the input is invalid.\n\nTo display custom validation messages, you must listen for input events (or other relevant events)\non your component and update the `validationMessage` property with the desired message string.\nUpdating this property will ensure that new validation messages are shown to the user.\n- The `validationMessage` property overrides the default browser validation message when set.\n- Consumers are responsible for updating `validationMessage` in response to input or validation state changes.",
|
36770
|
-
"fieldName": "validationMessage",
|
36771
|
-
"inheritedFrom": {
|
36772
|
-
"name": "FormInternalsMixin",
|
36773
|
-
"module": "src/utils/mixins/FormInternalsMixin.ts"
|
36774
|
-
}
|
36775
|
-
},
|
36776
|
-
{
|
36777
|
-
"name": "data-aria-label",
|
36778
|
-
"type": {
|
36779
|
-
"text": "string | null"
|
36780
|
-
},
|
36781
|
-
"default": "null",
|
36782
|
-
"description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
|
36783
|
-
"fieldName": "dataAriaLabel",
|
36784
|
-
"inheritedFrom": {
|
36785
|
-
"name": "DataAriaLabelMixin",
|
36786
|
-
"module": "src/utils/mixins/DataAriaLabelMixin.ts"
|
36787
|
-
}
|
36788
|
-
},
|
36789
|
-
{
|
36790
|
-
"name": "placeholder",
|
36791
|
-
"type": {
|
36792
|
-
"text": "string"
|
36793
|
-
},
|
36794
|
-
"default": "''",
|
36795
|
-
"description": "The placeholder text that is displayed when the input field is empty.",
|
36796
|
-
"fieldName": "placeholder",
|
36797
|
-
"inheritedFrom": {
|
36798
|
-
"name": "Input",
|
36799
|
-
"module": "src/components/input/input.component.ts"
|
36800
|
-
}
|
36801
|
-
},
|
36802
|
-
{
|
36803
|
-
"name": "readonly",
|
36804
|
-
"type": {
|
36805
|
-
"text": "boolean"
|
36806
|
-
},
|
36807
|
-
"default": "false",
|
36808
|
-
"description": "readonly attribute of the input field. If true, the input field is read-only.",
|
36809
|
-
"fieldName": "readonly",
|
36810
|
-
"inheritedFrom": {
|
36811
|
-
"name": "Input",
|
36812
|
-
"module": "src/components/input/input.component.ts"
|
36813
|
-
}
|
36814
|
-
},
|
36815
|
-
{
|
36816
|
-
"name": "prefix-text",
|
36817
|
-
"type": {
|
36818
|
-
"text": "string | undefined"
|
36819
|
-
},
|
36820
|
-
"description": "The prefix text that is displayed before the input field. It has a max length of 10 characters.\nWhen the prefix text is set, make sure to set the 'data-aria-label'\nattribute with the appropriate value for accessibility.",
|
36821
|
-
"fieldName": "prefixText",
|
36822
|
-
"inheritedFrom": {
|
36823
|
-
"name": "Input",
|
36824
|
-
"module": "src/components/input/input.component.ts"
|
36825
|
-
}
|
36826
|
-
},
|
36827
|
-
{
|
36828
|
-
"name": "leading-icon",
|
36829
|
-
"type": {
|
36830
|
-
"text": "IconNames | undefined"
|
36831
|
-
},
|
36832
|
-
"description": "The leading icon that is displayed before the input field.",
|
36833
|
-
"fieldName": "leadingIcon",
|
36834
|
-
"inheritedFrom": {
|
36835
|
-
"name": "Input",
|
36836
|
-
"module": "src/components/input/input.component.ts"
|
36837
|
-
}
|
36838
|
-
},
|
36839
|
-
{
|
36840
|
-
"name": "trailing-button",
|
36841
|
-
"type": {
|
36842
|
-
"text": "boolean"
|
36843
|
-
},
|
36844
|
-
"default": "false",
|
36845
|
-
"description": "The trailing button when set to true, shows a clear button that clears the input field.",
|
36846
|
-
"fieldName": "trailingButton",
|
36847
|
-
"inheritedFrom": {
|
36848
|
-
"name": "Input",
|
36849
|
-
"module": "src/components/input/input.component.ts"
|
36850
|
-
}
|
36851
|
-
},
|
36852
|
-
{
|
36853
|
-
"name": "maxlength",
|
36854
|
-
"type": {
|
36855
|
-
"text": "number | undefined"
|
36856
|
-
},
|
36857
|
-
"description": "The maximum number of characters that the input field can accept.",
|
36858
|
-
"fieldName": "maxlength",
|
36859
|
-
"inheritedFrom": {
|
36860
|
-
"name": "Input",
|
36861
|
-
"module": "src/components/input/input.component.ts"
|
36862
|
-
}
|
36863
|
-
},
|
36864
|
-
{
|
36865
|
-
"name": "minlength",
|
36866
|
-
"type": {
|
36867
|
-
"text": "number | undefined"
|
36868
|
-
},
|
36869
|
-
"description": "The minimum number of characters that the input field can accept.",
|
36870
|
-
"fieldName": "minlength",
|
36871
|
-
"inheritedFrom": {
|
36872
|
-
"name": "Input",
|
36873
|
-
"module": "src/components/input/input.component.ts"
|
36874
|
-
}
|
36875
|
-
},
|
36876
|
-
{
|
36877
|
-
"name": "autocapitalize",
|
36878
|
-
"type": {
|
36879
|
-
"text": "AutoCapitalizeType"
|
36880
|
-
},
|
36881
|
-
"description": "The autocapitalize attribute of the input field.",
|
36882
|
-
"default": "'off'",
|
36883
|
-
"fieldName": "autocapitalize",
|
36884
|
-
"inheritedFrom": {
|
36885
|
-
"name": "Input",
|
36886
|
-
"module": "src/components/input/input.component.ts"
|
36887
|
-
}
|
36888
|
-
},
|
36889
|
-
{
|
36890
|
-
"name": "autocomplete",
|
36891
|
-
"type": {
|
36892
|
-
"text": "AutoCompleteType"
|
36893
|
-
},
|
36894
|
-
"description": "The autocomplete attribute of the input field.",
|
36895
|
-
"default": "'off'",
|
36896
|
-
"fieldName": "autocomplete",
|
36897
|
-
"inheritedFrom": {
|
36898
|
-
"name": "Input",
|
36899
|
-
"module": "src/components/input/input.component.ts"
|
36900
|
-
}
|
36901
|
-
},
|
36902
|
-
{
|
36903
|
-
"name": "dirname",
|
36904
|
-
"type": {
|
36905
|
-
"text": "string | undefined"
|
36906
|
-
},
|
36907
|
-
"description": "Specifies the name of the directionality of text for submission purposes (e.g., \"rtl\" for right-to-left).",
|
36908
|
-
"fieldName": "dirname",
|
36909
|
-
"inheritedFrom": {
|
36910
|
-
"name": "Input",
|
36911
|
-
"module": "src/components/input/input.component.ts"
|
36912
|
-
}
|
36913
|
-
},
|
36914
|
-
{
|
36915
|
-
"name": "pattern",
|
36916
|
-
"type": {
|
36917
|
-
"text": "string | undefined"
|
36918
|
-
},
|
36919
|
-
"description": "The pattern attribute of the input field.\nSpecifies a regular expression that the input value must match for validation purposes.",
|
36920
|
-
"fieldName": "pattern",
|
36921
|
-
"inheritedFrom": {
|
36922
|
-
"name": "Input",
|
36923
|
-
"module": "src/components/input/input.component.ts"
|
36924
|
-
}
|
36925
|
-
},
|
36926
|
-
{
|
36927
|
-
"name": "list",
|
36928
|
-
"type": {
|
36929
|
-
"text": "string | undefined"
|
36930
|
-
},
|
36931
|
-
"description": "The list attribute of the input field.\nIdentifies a list of pre-defined options to suggest to the user.",
|
36932
|
-
"fieldName": "list",
|
36933
|
-
"inheritedFrom": {
|
36934
|
-
"name": "Input",
|
36935
|
-
"module": "src/components/input/input.component.ts"
|
36936
|
-
}
|
36937
|
-
},
|
36938
|
-
{
|
36939
|
-
"name": "size",
|
36940
|
-
"type": {
|
36941
|
-
"text": "number | undefined | undefined"
|
36942
|
-
},
|
36943
|
-
"description": "The size attribute of the input field.\nSpecifies the width of the input field.",
|
36944
|
-
"default": "undefined",
|
36945
|
-
"fieldName": "size",
|
36946
|
-
"inheritedFrom": {
|
36947
|
-
"name": "Input",
|
36948
|
-
"module": "src/components/input/input.component.ts"
|
36949
|
-
}
|
36950
|
-
},
|
36951
|
-
{
|
36952
|
-
"name": "clear-aria-label",
|
36953
|
-
"type": {
|
36954
|
-
"text": "string"
|
36955
|
-
},
|
36956
|
-
"default": "''",
|
36957
|
-
"description": "Aria label for the trailing button. If trailing button is set to true, this label is used for the clear button.",
|
36958
|
-
"fieldName": "clearAriaLabel",
|
36959
|
-
"inheritedFrom": {
|
36960
|
-
"name": "Input",
|
36961
|
-
"module": "src/components/input/input.component.ts"
|
36962
|
-
}
|
36963
|
-
},
|
36964
|
-
{
|
36965
|
-
"name": "disabled",
|
36966
|
-
"type": {
|
36967
|
-
"text": "boolean | undefined"
|
36968
|
-
},
|
36969
|
-
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
36970
|
-
"default": "undefined",
|
36971
|
-
"fieldName": "disabled",
|
36972
|
-
"inheritedFrom": {
|
36973
|
-
"name": "FormfieldWrapper",
|
36974
|
-
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
36975
|
-
}
|
36976
|
-
},
|
36977
|
-
{
|
36978
|
-
"name": "label",
|
36979
|
-
"type": {
|
36980
|
-
"text": "string | undefined"
|
36981
|
-
},
|
36982
|
-
"description": "The label of the input field. It is linked to the input field using the `for` attribute.",
|
36983
|
-
"fieldName": "label",
|
36984
|
-
"inheritedFrom": {
|
36985
|
-
"name": "FormfieldWrapper",
|
36986
|
-
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
36987
|
-
}
|
36988
|
-
},
|
36989
|
-
{
|
36990
|
-
"name": "required",
|
36991
|
-
"type": {
|
36992
|
-
"text": "boolean"
|
36993
|
-
},
|
36994
|
-
"default": "false",
|
36995
|
-
"description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
|
36996
|
-
"fieldName": "required",
|
36997
|
-
"inheritedFrom": {
|
36998
|
-
"name": "FormfieldWrapper",
|
36999
|
-
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
37000
|
-
}
|
37001
|
-
},
|
37002
|
-
{
|
37003
|
-
"name": "help-text-type",
|
37004
|
-
"type": {
|
37005
|
-
"text": "ValidationType"
|
37006
|
-
},
|
37007
|
-
"description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
|
37008
|
-
"fieldName": "helpTextType",
|
37009
|
-
"inheritedFrom": {
|
37010
|
-
"name": "FormfieldWrapper",
|
37011
|
-
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
37012
|
-
}
|
37013
|
-
},
|
37014
|
-
{
|
37015
|
-
"name": "help-text",
|
37016
|
-
"type": {
|
37017
|
-
"text": "string | undefined"
|
37018
|
-
},
|
37019
|
-
"description": "The help text that is displayed below the input field.",
|
37020
|
-
"fieldName": "helpText",
|
37021
|
-
"inheritedFrom": {
|
37022
|
-
"name": "FormfieldWrapper",
|
37023
|
-
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
37024
|
-
}
|
37025
|
-
},
|
37026
|
-
{
|
37027
|
-
"name": "toggletip-text",
|
37028
|
-
"type": {
|
37029
|
-
"text": "string | undefined"
|
37030
|
-
},
|
37031
|
-
"description": "The toggletip text that is displayed when the label is hovered.\nIt is used to provide additional information about the label.",
|
37032
|
-
"fieldName": "toggletipText",
|
37033
|
-
"inheritedFrom": {
|
37034
|
-
"name": "FormfieldWrapper",
|
37035
|
-
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
37036
|
-
}
|
37037
|
-
},
|
37038
|
-
{
|
37039
|
-
"name": "toggletip-placement",
|
37040
|
-
"type": {
|
37041
|
-
"text": "PopoverPlacement"
|
37042
|
-
},
|
37043
|
-
"description": "The placement of the toggletip that is displayed when the info icon is hovered.",
|
37044
|
-
"default": "'top'",
|
37045
|
-
"fieldName": "toggletipPlacement",
|
37046
|
-
"inheritedFrom": {
|
37047
|
-
"name": "FormfieldWrapper",
|
37048
|
-
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
37049
|
-
}
|
37050
|
-
},
|
37051
|
-
{
|
37052
|
-
"name": "toggletip-strategy",
|
37053
|
-
"type": {
|
37054
|
-
"text": "PopoverStrategy"
|
37055
|
-
},
|
37056
|
-
"fieldName": "toggletipStrategy",
|
37057
|
-
"inheritedFrom": {
|
37058
|
-
"name": "FormfieldWrapper",
|
37059
|
-
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
37060
|
-
}
|
37061
|
-
},
|
37062
|
-
{
|
37063
|
-
"name": "info-icon-aria-label",
|
37064
|
-
"type": {
|
37065
|
-
"text": "string | undefined"
|
37066
|
-
},
|
37067
|
-
"description": "Aria label for the info icon that is displayed next to the label when `toggletipText` is set.\nThis is used for accessibility purposes to provide a description of the icon.",
|
37068
|
-
"fieldName": "infoIconAriaLabel",
|
37069
|
-
"inheritedFrom": {
|
37070
|
-
"name": "FormfieldWrapper",
|
37071
|
-
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
37072
|
-
}
|
37073
|
-
}
|
37074
|
-
],
|
37075
|
-
"cssProperties": [
|
37076
|
-
{
|
37077
|
-
"description": "Border color for the input container when disabled",
|
37078
|
-
"name": "--mdc-input-disabled-border-color",
|
37079
|
-
"inheritedFrom": {
|
37080
|
-
"name": "Input",
|
37081
|
-
"module": "src/components/input/input.component.ts"
|
37082
|
-
}
|
37083
|
-
},
|
37084
|
-
{
|
37085
|
-
"description": "Text color for the input field when disabled",
|
37086
|
-
"name": "--mdc-input-disabled-text-color",
|
37087
|
-
"inheritedFrom": {
|
37088
|
-
"name": "Input",
|
37089
|
-
"module": "src/components/input/input.component.ts"
|
37090
|
-
}
|
37091
|
-
},
|
37092
|
-
{
|
37093
|
-
"description": "Background color for the input field when disabled",
|
37094
|
-
"name": "--mdc-input-disabled-background-color",
|
37095
|
-
"inheritedFrom": {
|
37096
|
-
"name": "Input",
|
37097
|
-
"module": "src/components/input/input.component.ts"
|
37098
|
-
}
|
37099
|
-
},
|
37100
|
-
{
|
37101
|
-
"description": "Border color for the input container",
|
37102
|
-
"name": "--mdc-input-border-color",
|
37103
|
-
"inheritedFrom": {
|
37104
|
-
"name": "Input",
|
37105
|
-
"module": "src/components/input/input.component.ts"
|
37106
|
-
}
|
37107
|
-
},
|
37108
|
-
{
|
37109
|
-
"description": "Text color for the input field",
|
37110
|
-
"name": "--mdc-input-text-color",
|
37111
|
-
"inheritedFrom": {
|
37112
|
-
"name": "Input",
|
37113
|
-
"module": "src/components/input/input.component.ts"
|
37114
|
-
}
|
37115
|
-
},
|
37116
|
-
{
|
37117
|
-
"description": "Background color for the input field",
|
37118
|
-
"name": "--mdc-input-background-color",
|
37119
|
-
"inheritedFrom": {
|
37120
|
-
"name": "Input",
|
37121
|
-
"module": "src/components/input/input.component.ts"
|
37122
|
-
}
|
37123
|
-
},
|
37124
|
-
{
|
37125
|
-
"description": "Background color for the selected text",
|
37126
|
-
"name": "--mdc-input-selection-background-color",
|
37127
|
-
"inheritedFrom": {
|
37128
|
-
"name": "Input",
|
37129
|
-
"module": "src/components/input/input.component.ts"
|
37130
|
-
}
|
37131
|
-
},
|
37132
|
-
{
|
37133
|
-
"description": "Text color for the selected text",
|
37134
|
-
"name": "--mdc-input-selection-text-color",
|
37135
|
-
"inheritedFrom": {
|
37136
|
-
"name": "Input",
|
37137
|
-
"module": "src/components/input/input.component.ts"
|
37138
|
-
}
|
37139
|
-
},
|
37140
|
-
{
|
37141
|
-
"description": "Text color for the help text",
|
37142
|
-
"name": "--mdc-input-support-text-color",
|
37143
|
-
"inheritedFrom": {
|
37144
|
-
"name": "Input",
|
37145
|
-
"module": "src/components/input/input.component.ts"
|
37146
|
-
}
|
37147
|
-
},
|
37148
|
-
{
|
37149
|
-
"description": "Background color for the input field when hovered",
|
37150
|
-
"name": "--mdc-input-hover-background-color",
|
37151
|
-
"inheritedFrom": {
|
37152
|
-
"name": "Input",
|
37153
|
-
"module": "src/components/input/input.component.ts"
|
37154
|
-
}
|
37155
|
-
},
|
37156
|
-
{
|
37157
|
-
"description": "Background color for the input field when focused",
|
37158
|
-
"name": "--mdc-input-focused-background-color",
|
37159
|
-
"inheritedFrom": {
|
37160
|
-
"name": "Input",
|
37161
|
-
"module": "src/components/input/input.component.ts"
|
37162
|
-
}
|
37163
|
-
},
|
37164
|
-
{
|
37165
|
-
"description": "Border color for the input container when focused",
|
37166
|
-
"name": "--mdc-input-focused-border-color",
|
37167
|
-
"inheritedFrom": {
|
37168
|
-
"name": "Input",
|
37169
|
-
"module": "src/components/input/input.component.ts"
|
37170
|
-
}
|
37171
|
-
},
|
37172
|
-
{
|
37173
|
-
"description": "Border color for the input container when error",
|
37174
|
-
"name": "--mdc-input-error-border-color",
|
37175
|
-
"inheritedFrom": {
|
37176
|
-
"name": "Input",
|
37177
|
-
"module": "src/components/input/input.component.ts"
|
37178
|
-
}
|
37179
|
-
},
|
37180
|
-
{
|
37181
|
-
"description": "Border color for the input container when warning",
|
37182
|
-
"name": "--mdc-input-warning-border-color",
|
37183
|
-
"inheritedFrom": {
|
37184
|
-
"name": "Input",
|
37185
|
-
"module": "src/components/input/input.component.ts"
|
37186
|
-
}
|
37187
|
-
},
|
37188
|
-
{
|
37189
|
-
"description": "Border color for the input container when success",
|
37190
|
-
"name": "--mdc-input-success-border-color",
|
37191
|
-
"inheritedFrom": {
|
37192
|
-
"name": "Input",
|
37193
|
-
"module": "src/components/input/input.component.ts"
|
37194
|
-
}
|
37195
|
-
},
|
37196
|
-
{
|
37197
|
-
"description": "Border color for the input container when primary",
|
37198
|
-
"name": "--mdc-input-primary-border-color",
|
37199
|
-
"inheritedFrom": {
|
37200
|
-
"name": "Input",
|
37201
|
-
"module": "src/components/input/input.component.ts"
|
37202
|
-
}
|
37203
|
-
}
|
37204
|
-
]
|
37205
|
-
}
|
37206
|
-
],
|
37207
|
-
"exports": [
|
37208
|
-
{
|
37209
|
-
"kind": "js",
|
37210
|
-
"name": "default",
|
37211
|
-
"declaration": {
|
37212
|
-
"name": "Searchfield",
|
37213
|
-
"module": "components/searchfield/searchfield.component.js"
|
37214
|
-
}
|
37215
|
-
}
|
37216
|
-
]
|
37217
|
-
},
|
37218
|
-
{
|
37219
|
-
"kind": "javascript-module",
|
37220
|
-
"path": "components/screenreaderannouncer/screenreaderannouncer.component.js",
|
37221
|
-
"declarations": [
|
37222
|
-
{
|
37223
|
-
"kind": "class",
|
37224
|
-
"description": "`mdc-screenreaderannouncer` can be used to announce messages with the screen reader.\n\nTo make an announcement set `announcement` attribute on the `mdc-screenreaderannouncer` element.\n\n**Internal logic**\n\nWhen the screenreader announcer is connected to the DOM, if the `identity` attribute is not\nprovided, it is set to `mdc-screenreaderannouncer-identity` and a `<div>` element with this id is created\nin the DOM. If the `identity` attribute is provided, the identity element is used and no new element\nis created in the DOM.\n\nWhen the `announcement` attribute is set, the screenreader announcer will create a `<div>` element with\n`aria-live` attribute set to the value of `data-aria-live` attribute and append it to the `identity` element.\nAfter delay of `delay` milliseconds, a <p> element with the announcement text is appended to the `<div>` element.\n\nThe announcement `<div>` element is removed from the DOM after `timeout` milliseconds.\n\nWhen the screen announcer component is disconnected from the DOM, all the timeouts are cleared and\nall the announcement elements added are removed from the DOM and timeouts cleared.\n\n**Note**\n1. The default delay of 150 miliseconds is used as we dynamically generate the\naria-live region in the DOM and add the announcement text to it.\n3. If no `identity` is provided, all the screen reader components will create and use only one\n`<div>` element with id `mdc-screenreaderannouncer-identity` in the DOM.\n\nReference: https://patrickhlauke.github.io/aria/tests/live-regions/",
|
37225
|
-
"name": "ScreenreaderAnnouncer",
|
37226
|
-
"members": [
|
37227
|
-
{
|
37228
|
-
"kind": "field",
|
37229
|
-
"name": "announcement",
|
37230
|
-
"type": {
|
37231
|
-
"text": "string"
|
37232
|
-
},
|
37233
|
-
"default": "''",
|
37234
|
-
"description": "The announcement attribute is a string that is used to announce messages to the screen reader.\nThe announcement is made when the announcement attribute is set to a non-empty string.",
|
37235
|
-
"attribute": "announcement",
|
37236
|
-
"reflects": true
|
37237
|
-
},
|
37238
|
-
{
|
37239
|
-
"kind": "field",
|
37240
|
-
"name": "identity",
|
37241
|
-
"type": {
|
37242
|
-
"text": "string"
|
37243
|
-
},
|
37244
|
-
"default": "''",
|
37245
|
-
"description": "The id of the element in the light dom, to which announcement elements will be appended.\n\nIf id is not provided, it will be set to `mdc-screenreaderannouncer-identity` and\na div element with this id will be created in the light dom.",
|
37246
|
-
"attribute": "identity",
|
37247
|
-
"reflects": true
|
37248
|
-
},
|
37249
|
-
{
|
37250
|
-
"kind": "field",
|
37251
|
-
"name": "dataAriaLive",
|
37252
|
-
"type": {
|
37253
|
-
"text": "AriaLive"
|
37254
|
-
},
|
37255
|
-
"description": "Aria live value for announcement.",
|
37256
|
-
"default": "'polite'",
|
37257
|
-
"attribute": "data-aria-live",
|
37258
|
-
"reflects": true
|
37259
|
-
},
|
37260
|
-
{
|
37261
|
-
"kind": "field",
|
37262
|
-
"name": "delay",
|
37263
|
-
"type": {
|
37264
|
-
"text": "number"
|
37265
|
-
},
|
37266
|
-
"description": "Milliseconds to wait before adding the announcement to the identiy region in\nDOM, which will announce the message to the screen reader.",
|
37267
|
-
"default": "150",
|
37268
|
-
"attribute": "delay",
|
37269
|
-
"reflects": true
|
37270
|
-
},
|
37271
|
-
{
|
37272
|
-
"kind": "field",
|
37273
|
-
"name": "timeout",
|
37274
|
-
"type": {
|
37275
|
-
"text": "number"
|
37276
|
-
},
|
37277
|
-
"description": "Milliseconds to wait after which the announcement element will be removed from\nidentity region in DOM, causing the screen reader to not announcing the message.",
|
37278
|
-
"default": "20_000",
|
37279
|
-
"attribute": "timeout",
|
37280
|
-
"reflects": true
|
37281
|
-
},
|
37282
|
-
{
|
37283
|
-
"kind": "method",
|
37284
|
-
"name": "announce",
|
37285
|
-
"parameters": [
|
37286
|
-
{
|
37287
|
-
"name": "announcement",
|
37288
|
-
"type": {
|
37289
|
-
"text": "string"
|
37290
|
-
},
|
37291
|
-
"description": "The announcement to be made."
|
37292
|
-
},
|
37293
|
-
{
|
37294
|
-
"name": "delay",
|
37295
|
-
"type": {
|
37296
|
-
"text": "number"
|
37297
|
-
},
|
37298
|
-
"description": "The delay in milliseconds before announcing the message."
|
37299
|
-
},
|
37300
|
-
{
|
37301
|
-
"name": "timeout",
|
37302
|
-
"type": {
|
37303
|
-
"text": "number"
|
37304
|
-
},
|
37305
|
-
"description": "The timeout in milliseconds before removing the announcement."
|
37306
|
-
},
|
37307
|
-
{
|
37308
|
-
"name": "ariaLive",
|
37309
|
-
"type": {
|
37310
|
-
"text": "AriaLive"
|
37311
|
-
},
|
37312
|
-
"description": "The aria live value for the announcement."
|
37313
|
-
}
|
37314
|
-
],
|
37315
|
-
"description": "Announces the given announcement to the screen reader.\n\nA div element with aria-live attribute set to the given ariaLive value is created\nand a p element with the announcement text is appended to it.\n\nThe div element is appended to the element in the DOM identified with id as\nidentity attribute."
|
37316
|
-
},
|
37317
|
-
{
|
37318
|
-
"kind": "method",
|
37319
|
-
"name": "clearTimeOutsAndAnnouncements",
|
37320
|
-
"privacy": "private",
|
37321
|
-
"description": "Clears all timeouts and removes all announcements from the screen reader."
|
37322
|
-
},
|
37323
|
-
{
|
37324
|
-
"kind": "method",
|
37325
|
-
"name": "createAnnouncementAriaLiveRegion",
|
37326
|
-
"privacy": "private",
|
37327
|
-
"description": "Creates a div element with id as identity attribute in the DOM.\n\nIf the identity attribute is not provided, it is set internally to\n`mdc-screenreaderannouncer-identity`."
|
37328
|
-
}
|
37329
|
-
],
|
37330
|
-
"attributes": [
|
37331
|
-
{
|
37332
|
-
"name": "announcement",
|
37333
|
-
"type": {
|
37334
|
-
"text": "string"
|
37335
|
-
},
|
37336
|
-
"default": "''",
|
37337
|
-
"description": "The announcement attribute is a string that is used to announce messages to the screen reader.\nThe announcement is made when the announcement attribute is set to a non-empty string.",
|
37338
|
-
"fieldName": "announcement"
|
37339
|
-
},
|
37340
|
-
{
|
37341
|
-
"name": "identity",
|
37342
|
-
"type": {
|
37343
|
-
"text": "string"
|
37344
|
-
},
|
37345
|
-
"default": "''",
|
37346
|
-
"description": "The id of the element in the light dom, to which announcement elements will be appended.\n\nIf id is not provided, it will be set to `mdc-screenreaderannouncer-identity` and\na div element with this id will be created in the light dom.",
|
37347
|
-
"fieldName": "identity"
|
37348
|
-
},
|
37349
|
-
{
|
37350
|
-
"name": "data-aria-live",
|
37351
|
-
"type": {
|
37352
|
-
"text": "AriaLive"
|
37353
|
-
},
|
37354
|
-
"description": "Aria live value for announcement.",
|
37355
|
-
"default": "'polite'",
|
37356
|
-
"fieldName": "dataAriaLive"
|
37357
|
-
},
|
37358
|
-
{
|
37359
|
-
"name": "delay",
|
37360
|
-
"type": {
|
37361
|
-
"text": "number"
|
37362
|
-
},
|
37363
|
-
"description": "Milliseconds to wait before adding the announcement to the identiy region in\nDOM, which will announce the message to the screen reader.",
|
37364
|
-
"default": "150",
|
37365
|
-
"fieldName": "delay"
|
37366
|
-
},
|
37367
|
-
{
|
37368
|
-
"name": "timeout",
|
37369
|
-
"type": {
|
37370
|
-
"text": "number"
|
37371
|
-
},
|
37372
|
-
"description": "Milliseconds to wait after which the announcement element will be removed from\nidentity region in DOM, causing the screen reader to not announcing the message.",
|
37373
|
-
"default": "20_000",
|
37374
|
-
"fieldName": "timeout"
|
37375
|
-
}
|
37376
|
-
],
|
37377
|
-
"superclass": {
|
37378
|
-
"name": "Component",
|
37379
|
-
"module": "/src/models"
|
37380
|
-
},
|
37381
|
-
"tagName": "mdc-screenreaderannouncer",
|
37382
|
-
"jsDoc": "/**\n * `mdc-screenreaderannouncer` can be used to announce messages with the screen reader.\n *\n * To make an announcement set `announcement` attribute on the `mdc-screenreaderannouncer` element.\n *\n * **Internal logic**\n *\n * When the screenreader announcer is connected to the DOM, if the `identity` attribute is not\n * provided, it is set to `mdc-screenreaderannouncer-identity` and a `<div>` element with this id is created\n * in the DOM. If the `identity` attribute is provided, the identity element is used and no new element\n * is created in the DOM.\n *\n * When the `announcement` attribute is set, the screenreader announcer will create a `<div>` element with\n * `aria-live` attribute set to the value of `data-aria-live` attribute and append it to the `identity` element.\n * After delay of `delay` milliseconds, a <p> element with the announcement text is appended to the `<div>` element.\n *\n * The announcement `<div>` element is removed from the DOM after `timeout` milliseconds.\n *\n * When the screen announcer component is disconnected from the DOM, all the timeouts are cleared and\n * all the announcement elements added are removed from the DOM and timeouts cleared.\n *\n * **Note**\n * 1. The default delay of 150 miliseconds is used as we dynamically generate the\n * aria-live region in the DOM and add the announcement text to it.\n * 3. If no `identity` is provided, all the screen reader components will create and use only one\n * `<div>` element with id `mdc-screenreaderannouncer-identity` in the DOM.\n *\n * Reference: https://patrickhlauke.github.io/aria/tests/live-regions/\n *\n * @tagname mdc-screenreaderannouncer\n */",
|
37383
|
-
"customElement": true
|
37384
|
-
}
|
37385
|
-
],
|
37386
|
-
"exports": [
|
37387
|
-
{
|
37388
|
-
"kind": "js",
|
37389
|
-
"name": "default",
|
37390
|
-
"declaration": {
|
37391
|
-
"name": "ScreenreaderAnnouncer",
|
37392
|
-
"module": "components/screenreaderannouncer/screenreaderannouncer.component.js"
|
37393
|
-
}
|
37394
|
-
}
|
37395
|
-
]
|
37396
|
-
},
|
37397
|
-
{
|
37398
|
-
"kind": "javascript-module",
|
37399
|
-
"path": "components/radiogroup/radiogroup.component.js",
|
37400
|
-
"declarations": [
|
37401
|
-
{
|
37402
|
-
"kind": "class",
|
37403
|
-
"description": "`mdc-radiogroup` - This is the wrapper component for radio buttons which are grouped together.\nIt can have a header text and a description. It enables users to select a single option from a set of options.\nIt is often used in forms, settings, and selection in lists. It automatically group the radio buttons inside it.",
|
37404
|
-
"name": "RadioGroup",
|
37405
|
-
"cssProperties": [
|
37406
|
-
{
|
37407
|
-
"description": "color of the description text",
|
37408
|
-
"name": "--mdc-radiogroup-description-text-normal"
|
37409
|
-
}
|
37410
|
-
],
|
37411
|
-
"members": [
|
37412
|
-
{
|
37413
|
-
"kind": "field",
|
37414
|
-
"name": "name",
|
37415
|
-
"type": {
|
37416
|
-
"text": "string"
|
37417
|
-
},
|
37418
|
-
"default": "''",
|
37419
|
-
"description": "Name of the radio group.\nThey are used to group elements in a form together.",
|
37420
|
-
"attribute": "name"
|
37421
|
-
},
|
37422
|
-
{
|
37423
|
-
"kind": "field",
|
37424
|
-
"name": "dataAriaLabel",
|
37425
|
-
"type": {
|
37426
|
-
"text": "string | null"
|
37427
|
-
},
|
37428
|
-
"default": "null",
|
37429
|
-
"description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
|
37430
|
-
"attribute": "data-aria-label",
|
37431
|
-
"reflects": true,
|
37432
|
-
"inheritedFrom": {
|
37433
|
-
"name": "DataAriaLabelMixin",
|
37434
|
-
"module": "utils/mixins/DataAriaLabelMixin.js"
|
37435
|
-
}
|
37436
|
-
},
|
37437
|
-
{
|
37438
|
-
"kind": "field",
|
37439
|
-
"name": "disabled",
|
37440
|
-
"type": {
|
37441
|
-
"text": "boolean | undefined"
|
37442
|
-
},
|
37443
|
-
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
37444
|
-
"default": "undefined",
|
37445
|
-
"attribute": "disabled",
|
37446
|
-
"reflects": true,
|
37447
|
-
"inheritedFrom": {
|
37448
|
-
"name": "FormfieldWrapper",
|
37449
|
-
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
37450
|
-
}
|
37451
|
-
},
|
37452
|
-
{
|
37453
|
-
"kind": "field",
|
37454
|
-
"name": "label",
|
37455
|
-
"type": {
|
37456
|
-
"text": "string | undefined"
|
37457
|
-
},
|
37458
|
-
"description": "The label of the input field. It is linked to the input field using the `for` attribute.",
|
37459
|
-
"attribute": "label",
|
37460
|
-
"reflects": true,
|
37461
|
-
"inheritedFrom": {
|
37462
|
-
"name": "FormfieldWrapper",
|
37463
|
-
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
37464
|
-
}
|
37465
|
-
},
|
37466
|
-
{
|
37467
|
-
"kind": "field",
|
37468
|
-
"name": "required",
|
37469
|
-
"type": {
|
37470
|
-
"text": "boolean"
|
37471
|
-
},
|
37472
|
-
"default": "false",
|
37473
|
-
"description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
|
37474
|
-
"attribute": "required",
|
37475
|
-
"reflects": true,
|
37476
|
-
"inheritedFrom": {
|
37477
|
-
"name": "FormfieldWrapper",
|
37478
|
-
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
37479
|
-
}
|
37480
|
-
},
|
37481
|
-
{
|
37482
|
-
"kind": "field",
|
37483
|
-
"name": "helpTextType",
|
37484
|
-
"type": {
|
37485
|
-
"text": "ValidationType"
|
37486
|
-
},
|
37487
|
-
"description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
|
37488
|
-
"attribute": "help-text-type",
|
37489
|
-
"reflects": true,
|
37490
|
-
"inheritedFrom": {
|
37491
|
-
"name": "FormfieldWrapper",
|
37492
|
-
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
37493
|
-
}
|
37494
|
-
},
|
37495
|
-
{
|
37496
|
-
"kind": "field",
|
37497
|
-
"name": "helpText",
|
37498
|
-
"type": {
|
37499
|
-
"text": "string | undefined"
|
37500
|
-
},
|
37501
|
-
"description": "The help text that is displayed below the input field.",
|
37502
|
-
"attribute": "help-text",
|
37503
|
-
"reflects": true,
|
37504
|
-
"inheritedFrom": {
|
37505
|
-
"name": "FormfieldWrapper",
|
37506
|
-
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
37507
|
-
}
|
37508
|
-
},
|
37509
|
-
{
|
37510
|
-
"kind": "field",
|
37511
|
-
"name": "toggletipText",
|
37512
|
-
"type": {
|
37513
|
-
"text": "string | undefined"
|
37514
|
-
},
|
37515
|
-
"description": "The toggletip text that is displayed when the label is hovered.\nIt is used to provide additional information about the label.",
|
37516
|
-
"attribute": "toggletip-text",
|
37517
|
-
"reflects": true,
|
37518
|
-
"inheritedFrom": {
|
37519
|
-
"name": "FormfieldWrapper",
|
37520
|
-
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
37521
|
-
}
|
37522
|
-
},
|
37523
|
-
{
|
37524
|
-
"kind": "field",
|
37525
|
-
"name": "toggletipPlacement",
|
37526
|
-
"type": {
|
37527
|
-
"text": "PopoverPlacement"
|
37528
|
-
},
|
37529
|
-
"description": "The placement of the toggletip that is displayed when the info icon is hovered.",
|
37530
|
-
"default": "'top'",
|
37531
|
-
"attribute": "toggletip-placement",
|
37532
|
-
"reflects": true,
|
37533
|
-
"inheritedFrom": {
|
37534
|
-
"name": "FormfieldWrapper",
|
37535
|
-
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
37536
|
-
}
|
37537
|
-
},
|
37538
|
-
{
|
37539
|
-
"kind": "field",
|
37540
|
-
"name": "toggletipStrategy",
|
37541
|
-
"type": {
|
37542
|
-
"text": "PopoverStrategy"
|
37543
|
-
},
|
37544
|
-
"attribute": "toggletip-strategy",
|
37545
|
-
"reflects": true,
|
37546
|
-
"inheritedFrom": {
|
37547
|
-
"name": "FormfieldWrapper",
|
37548
|
-
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
37549
|
-
}
|
37550
|
-
},
|
37551
|
-
{
|
37552
|
-
"kind": "field",
|
37553
|
-
"name": "infoIconAriaLabel",
|
37554
|
-
"type": {
|
37555
|
-
"text": "string | undefined"
|
37556
|
-
},
|
37557
|
-
"description": "Aria label for the info icon that is displayed next to the label when `toggletipText` is set.\nThis is used for accessibility purposes to provide a description of the icon.",
|
37558
|
-
"attribute": "info-icon-aria-label",
|
37559
|
-
"reflects": true,
|
37560
|
-
"inheritedFrom": {
|
37561
|
-
"name": "FormfieldWrapper",
|
37562
|
-
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
37563
|
-
}
|
37564
|
-
},
|
37565
|
-
{
|
37566
|
-
"kind": "method",
|
37567
|
-
"name": "renderLabelElement",
|
37568
|
-
"privacy": "protected",
|
37569
|
-
"description": "creates the label element when the label property is set.\nid is used to link the label with the input field.",
|
37570
|
-
"return": {
|
37571
|
-
"type": {
|
37572
|
-
"text": ""
|
37573
|
-
}
|
37574
|
-
},
|
37575
|
-
"inheritedFrom": {
|
37576
|
-
"name": "FormfieldWrapper",
|
37577
|
-
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
37578
|
-
}
|
37579
|
-
},
|
37580
|
-
{
|
37581
|
-
"kind": "method",
|
37582
|
-
"name": "renderHelpTextIcon",
|
37583
|
-
"privacy": "protected",
|
37584
|
-
"description": "creates the helpertext icon based on the helpTextType for validation.\nIf the helpTextType is not set, it defaults to 'default' and it doesn't display any icon.",
|
37585
|
-
"return": {
|
37586
|
-
"type": {
|
37587
|
-
"text": ""
|
37588
|
-
}
|
37589
|
-
},
|
37590
|
-
"inheritedFrom": {
|
37591
|
-
"name": "FormfieldWrapper",
|
37592
|
-
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
37593
|
-
}
|
37594
|
-
},
|
37595
|
-
{
|
37596
|
-
"kind": "method",
|
37597
|
-
"name": "renderHelpText",
|
37598
|
-
"privacy": "protected",
|
37599
|
-
"description": "creates the helper text component when the helpertext value is set.\nIt is also used to display the validation message based on the helpTextType.",
|
37600
|
-
"return": {
|
37601
|
-
"type": {
|
37602
|
-
"text": ""
|
37603
|
-
}
|
37604
|
-
},
|
37605
|
-
"inheritedFrom": {
|
37606
|
-
"name": "FormfieldWrapper",
|
37607
|
-
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
37608
|
-
}
|
37609
|
-
},
|
37610
|
-
{
|
37611
|
-
"kind": "method",
|
37612
|
-
"name": "renderLabel",
|
37613
|
-
"privacy": "protected",
|
37614
|
-
"description": "renders the label container that contains the label and labelInfoToggleTip.",
|
37615
|
-
"return": {
|
37616
|
-
"type": {
|
37617
|
-
"text": ""
|
37618
|
-
}
|
37619
|
-
},
|
37620
|
-
"inheritedFrom": {
|
37621
|
-
"name": "FormfieldWrapper",
|
37622
|
-
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
37623
|
-
}
|
37624
|
-
},
|
37625
|
-
{
|
37626
|
-
"kind": "method",
|
37627
|
-
"name": "renderHelperText",
|
37628
|
-
"privacy": "protected",
|
37629
|
-
"description": "renders the help-text container that contains the helpertext icon and helpertext.",
|
37630
|
-
"return": {
|
37631
|
-
"type": {
|
37632
|
-
"text": ""
|
37633
|
-
}
|
37634
|
-
},
|
37635
|
-
"inheritedFrom": {
|
37636
|
-
"name": "FormfieldWrapper",
|
37637
|
-
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
37638
|
-
}
|
37639
|
-
}
|
37640
|
-
],
|
37443
|
+
"events": [
|
37444
|
+
{
|
37445
|
+
"description": "(React: onInput) This event is dispatched when the value of the input field changes (every press).",
|
37446
|
+
"name": "input",
|
37447
|
+
"reactName": "onInput",
|
37448
|
+
"inheritedFrom": {
|
37449
|
+
"name": "Input",
|
37450
|
+
"module": "src/components/input/input.component.ts"
|
37451
|
+
}
|
37452
|
+
},
|
37453
|
+
{
|
37454
|
+
"description": "(React: onChange) This event is dispatched when the value of the input field changes (on blur).",
|
37455
|
+
"name": "change",
|
37456
|
+
"reactName": "onChange",
|
37457
|
+
"inheritedFrom": {
|
37458
|
+
"name": "Input",
|
37459
|
+
"module": "src/components/input/input.component.ts"
|
37460
|
+
}
|
37461
|
+
},
|
37462
|
+
{
|
37463
|
+
"description": "(React: onFocus) This event is dispatched when the input receives focus.",
|
37464
|
+
"name": "focus",
|
37465
|
+
"reactName": "onFocus",
|
37466
|
+
"inheritedFrom": {
|
37467
|
+
"name": "Input",
|
37468
|
+
"module": "src/components/input/input.component.ts"
|
37469
|
+
}
|
37470
|
+
},
|
37471
|
+
{
|
37472
|
+
"description": "(React: onBlur) This event is dispatched when the input loses focus.",
|
37473
|
+
"name": "blur",
|
37474
|
+
"reactName": "onBlur",
|
37475
|
+
"inheritedFrom": {
|
37476
|
+
"name": "Input",
|
37477
|
+
"module": "src/components/input/input.component.ts"
|
37478
|
+
}
|
37479
|
+
},
|
37480
|
+
{
|
37481
|
+
"name": "clear",
|
37482
|
+
"type": {
|
37483
|
+
"text": "CustomEvent"
|
37484
|
+
},
|
37485
|
+
"description": "(React: onClear) This event is dispatched when the input text is cleared.",
|
37486
|
+
"reactName": "onClear",
|
37487
|
+
"inheritedFrom": {
|
37488
|
+
"name": "Input",
|
37489
|
+
"module": "src/components/input/input.component.ts"
|
37490
|
+
}
|
37491
|
+
},
|
37492
|
+
{
|
37493
|
+
"type": {
|
37494
|
+
"text": "EventConstructor"
|
37495
|
+
},
|
37496
|
+
"inheritedFrom": {
|
37497
|
+
"name": "Input",
|
37498
|
+
"module": "src/components/input/input.component.ts"
|
37499
|
+
}
|
37500
|
+
}
|
37501
|
+
],
|
37502
|
+
"superclass": {
|
37503
|
+
"name": "Input",
|
37504
|
+
"module": "/src/components/input/input.component"
|
37505
|
+
},
|
37506
|
+
"tagName": "mdc-searchfield",
|
37507
|
+
"jsDoc": "/**\n * `mdc-searchfield` component is used as an input field for search functionality.\n *\n * It supports `mdc-inputchip` as filters.\n *\n * This component is built by extending the `mdc-input` component.\n *\n * @tagname mdc-searchfield\n *\n * @event input - (React: onInput) This event is dispatched when the value of the input field changes (every press).\n * @event change - (React: onChange) This event is dispatched when the value of the input field changes (on blur).\n * @event focus - (React: onFocus) This event is dispatched when the input receives focus.\n * @event blur - (React: onBlur) This event is dispatched when the input loses focus.\n * @event clear - (React: onClear) This event is dispatched when the input text is cleared.\n *\n * @slot filters - Slot for input chips\n *\n * @csspart label - The label element.\n * @csspart label-text - The container for the label and required indicator elements.\n * @csspart leading-icon - The leading icon element that is displayed before the input field.\n * @csspart input-container - The container for the input field, leading icon, prefix text, and trailing button elements.\n * @csspart input-section - The container for the input field, leading icon, and prefix text elements.\n * @csspart input-text - The input field element.\n * @csspart trailing-button - The trailing button element that is displayed to clear the input field when the `trailingButton` property is set to true.\n */",
|
37508
|
+
"customElement": true,
|
37641
37509
|
"attributes": [
|
37510
|
+
{
|
37511
|
+
"name": "auto-focus-on-mount",
|
37512
|
+
"type": {
|
37513
|
+
"text": "boolean"
|
37514
|
+
},
|
37515
|
+
"default": "false",
|
37516
|
+
"description": "This property indicates whether the element should receive focus automatically when it is mounted.\n\nIt will not focus if the element is re-attached to the DOM after being removed.",
|
37517
|
+
"fieldName": "autoFocusOnMount",
|
37518
|
+
"inheritedFrom": {
|
37519
|
+
"name": "AutoFocusOnMountMixin",
|
37520
|
+
"module": "src/utils/mixins/AutoFocusOnMountMixin.ts"
|
37521
|
+
}
|
37522
|
+
},
|
37642
37523
|
{
|
37643
37524
|
"name": "name",
|
37644
37525
|
"type": {
|
37645
37526
|
"text": "string"
|
37646
37527
|
},
|
37647
37528
|
"default": "''",
|
37648
|
-
"description": "
|
37649
|
-
"fieldName": "name"
|
37529
|
+
"description": "Indicates the name of the component group.\nThey are used to group elements in a form together.",
|
37530
|
+
"fieldName": "name",
|
37531
|
+
"inheritedFrom": {
|
37532
|
+
"name": "FormInternalsMixin",
|
37533
|
+
"module": "src/utils/mixins/FormInternalsMixin.ts"
|
37534
|
+
}
|
37535
|
+
},
|
37536
|
+
{
|
37537
|
+
"name": "value",
|
37538
|
+
"type": {
|
37539
|
+
"text": "string"
|
37540
|
+
},
|
37541
|
+
"default": "''",
|
37542
|
+
"description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
|
37543
|
+
"fieldName": "value",
|
37544
|
+
"inheritedFrom": {
|
37545
|
+
"name": "FormInternalsMixin",
|
37546
|
+
"module": "src/utils/mixins/FormInternalsMixin.ts"
|
37547
|
+
}
|
37548
|
+
},
|
37549
|
+
{
|
37550
|
+
"name": "validation-message",
|
37551
|
+
"type": {
|
37552
|
+
"text": "string | undefined"
|
37553
|
+
},
|
37554
|
+
"description": "Custom validation message that will override the default message and displayed when the input is invalid.\n\nTo display custom validation messages, you must listen for input events (or other relevant events)\non your component and update the `validationMessage` property with the desired message string.\nUpdating this property will ensure that new validation messages are shown to the user.\n- The `validationMessage` property overrides the default browser validation message when set.\n- Consumers are responsible for updating `validationMessage` in response to input or validation state changes.",
|
37555
|
+
"fieldName": "validationMessage",
|
37556
|
+
"inheritedFrom": {
|
37557
|
+
"name": "FormInternalsMixin",
|
37558
|
+
"module": "src/utils/mixins/FormInternalsMixin.ts"
|
37559
|
+
}
|
37650
37560
|
},
|
37651
37561
|
{
|
37652
37562
|
"name": "data-aria-label",
|
@@ -37661,6 +37571,181 @@
|
|
37661
37571
|
"module": "src/utils/mixins/DataAriaLabelMixin.ts"
|
37662
37572
|
}
|
37663
37573
|
},
|
37574
|
+
{
|
37575
|
+
"name": "placeholder",
|
37576
|
+
"type": {
|
37577
|
+
"text": "string"
|
37578
|
+
},
|
37579
|
+
"default": "''",
|
37580
|
+
"description": "The placeholder text that is displayed when the input field is empty.",
|
37581
|
+
"fieldName": "placeholder",
|
37582
|
+
"inheritedFrom": {
|
37583
|
+
"name": "Input",
|
37584
|
+
"module": "src/components/input/input.component.ts"
|
37585
|
+
}
|
37586
|
+
},
|
37587
|
+
{
|
37588
|
+
"name": "readonly",
|
37589
|
+
"type": {
|
37590
|
+
"text": "boolean"
|
37591
|
+
},
|
37592
|
+
"default": "false",
|
37593
|
+
"description": "readonly attribute of the input field. If true, the input field is read-only.",
|
37594
|
+
"fieldName": "readonly",
|
37595
|
+
"inheritedFrom": {
|
37596
|
+
"name": "Input",
|
37597
|
+
"module": "src/components/input/input.component.ts"
|
37598
|
+
}
|
37599
|
+
},
|
37600
|
+
{
|
37601
|
+
"name": "prefix-text",
|
37602
|
+
"type": {
|
37603
|
+
"text": "string | undefined"
|
37604
|
+
},
|
37605
|
+
"description": "The prefix text that is displayed before the input field. It has a max length of 10 characters.\nWhen the prefix text is set, make sure to set the 'data-aria-label'\nattribute with the appropriate value for accessibility.",
|
37606
|
+
"fieldName": "prefixText",
|
37607
|
+
"inheritedFrom": {
|
37608
|
+
"name": "Input",
|
37609
|
+
"module": "src/components/input/input.component.ts"
|
37610
|
+
}
|
37611
|
+
},
|
37612
|
+
{
|
37613
|
+
"name": "leading-icon",
|
37614
|
+
"type": {
|
37615
|
+
"text": "IconNames | undefined"
|
37616
|
+
},
|
37617
|
+
"description": "The leading icon that is displayed before the input field.",
|
37618
|
+
"fieldName": "leadingIcon",
|
37619
|
+
"inheritedFrom": {
|
37620
|
+
"name": "Input",
|
37621
|
+
"module": "src/components/input/input.component.ts"
|
37622
|
+
}
|
37623
|
+
},
|
37624
|
+
{
|
37625
|
+
"name": "trailing-button",
|
37626
|
+
"type": {
|
37627
|
+
"text": "boolean"
|
37628
|
+
},
|
37629
|
+
"default": "false",
|
37630
|
+
"description": "The trailing button when set to true, shows a clear button that clears the input field.",
|
37631
|
+
"fieldName": "trailingButton",
|
37632
|
+
"inheritedFrom": {
|
37633
|
+
"name": "Input",
|
37634
|
+
"module": "src/components/input/input.component.ts"
|
37635
|
+
}
|
37636
|
+
},
|
37637
|
+
{
|
37638
|
+
"name": "maxlength",
|
37639
|
+
"type": {
|
37640
|
+
"text": "number | undefined"
|
37641
|
+
},
|
37642
|
+
"description": "The maximum number of characters that the input field can accept.",
|
37643
|
+
"fieldName": "maxlength",
|
37644
|
+
"inheritedFrom": {
|
37645
|
+
"name": "Input",
|
37646
|
+
"module": "src/components/input/input.component.ts"
|
37647
|
+
}
|
37648
|
+
},
|
37649
|
+
{
|
37650
|
+
"name": "minlength",
|
37651
|
+
"type": {
|
37652
|
+
"text": "number | undefined"
|
37653
|
+
},
|
37654
|
+
"description": "The minimum number of characters that the input field can accept.",
|
37655
|
+
"fieldName": "minlength",
|
37656
|
+
"inheritedFrom": {
|
37657
|
+
"name": "Input",
|
37658
|
+
"module": "src/components/input/input.component.ts"
|
37659
|
+
}
|
37660
|
+
},
|
37661
|
+
{
|
37662
|
+
"name": "autocapitalize",
|
37663
|
+
"type": {
|
37664
|
+
"text": "AutoCapitalizeType"
|
37665
|
+
},
|
37666
|
+
"description": "The autocapitalize attribute of the input field.",
|
37667
|
+
"default": "'off'",
|
37668
|
+
"fieldName": "autocapitalize",
|
37669
|
+
"inheritedFrom": {
|
37670
|
+
"name": "Input",
|
37671
|
+
"module": "src/components/input/input.component.ts"
|
37672
|
+
}
|
37673
|
+
},
|
37674
|
+
{
|
37675
|
+
"name": "autocomplete",
|
37676
|
+
"type": {
|
37677
|
+
"text": "AutoCompleteType"
|
37678
|
+
},
|
37679
|
+
"description": "The autocomplete attribute of the input field.",
|
37680
|
+
"default": "'off'",
|
37681
|
+
"fieldName": "autocomplete",
|
37682
|
+
"inheritedFrom": {
|
37683
|
+
"name": "Input",
|
37684
|
+
"module": "src/components/input/input.component.ts"
|
37685
|
+
}
|
37686
|
+
},
|
37687
|
+
{
|
37688
|
+
"name": "dirname",
|
37689
|
+
"type": {
|
37690
|
+
"text": "string | undefined"
|
37691
|
+
},
|
37692
|
+
"description": "Specifies the name of the directionality of text for submission purposes (e.g., \"rtl\" for right-to-left).",
|
37693
|
+
"fieldName": "dirname",
|
37694
|
+
"inheritedFrom": {
|
37695
|
+
"name": "Input",
|
37696
|
+
"module": "src/components/input/input.component.ts"
|
37697
|
+
}
|
37698
|
+
},
|
37699
|
+
{
|
37700
|
+
"name": "pattern",
|
37701
|
+
"type": {
|
37702
|
+
"text": "string | undefined"
|
37703
|
+
},
|
37704
|
+
"description": "The pattern attribute of the input field.\nSpecifies a regular expression that the input value must match for validation purposes.",
|
37705
|
+
"fieldName": "pattern",
|
37706
|
+
"inheritedFrom": {
|
37707
|
+
"name": "Input",
|
37708
|
+
"module": "src/components/input/input.component.ts"
|
37709
|
+
}
|
37710
|
+
},
|
37711
|
+
{
|
37712
|
+
"name": "list",
|
37713
|
+
"type": {
|
37714
|
+
"text": "string | undefined"
|
37715
|
+
},
|
37716
|
+
"description": "The list attribute of the input field.\nIdentifies a list of pre-defined options to suggest to the user.",
|
37717
|
+
"fieldName": "list",
|
37718
|
+
"inheritedFrom": {
|
37719
|
+
"name": "Input",
|
37720
|
+
"module": "src/components/input/input.component.ts"
|
37721
|
+
}
|
37722
|
+
},
|
37723
|
+
{
|
37724
|
+
"name": "size",
|
37725
|
+
"type": {
|
37726
|
+
"text": "number | undefined | undefined"
|
37727
|
+
},
|
37728
|
+
"description": "The size attribute of the input field.\nSpecifies the width of the input field.",
|
37729
|
+
"default": "undefined",
|
37730
|
+
"fieldName": "size",
|
37731
|
+
"inheritedFrom": {
|
37732
|
+
"name": "Input",
|
37733
|
+
"module": "src/components/input/input.component.ts"
|
37734
|
+
}
|
37735
|
+
},
|
37736
|
+
{
|
37737
|
+
"name": "clear-aria-label",
|
37738
|
+
"type": {
|
37739
|
+
"text": "string"
|
37740
|
+
},
|
37741
|
+
"default": "''",
|
37742
|
+
"description": "Aria label for the trailing button. If trailing button is set to true, this label is used for the clear button.",
|
37743
|
+
"fieldName": "clearAriaLabel",
|
37744
|
+
"inheritedFrom": {
|
37745
|
+
"name": "Input",
|
37746
|
+
"module": "src/components/input/input.component.ts"
|
37747
|
+
}
|
37748
|
+
},
|
37664
37749
|
{
|
37665
37750
|
"name": "disabled",
|
37666
37751
|
"type": {
|
@@ -37772,134 +37857,133 @@
|
|
37772
37857
|
}
|
37773
37858
|
}
|
37774
37859
|
],
|
37775
|
-
"
|
37776
|
-
"name": "FormfieldGroup",
|
37777
|
-
"module": "/src/components/formfieldgroup"
|
37778
|
-
},
|
37779
|
-
"tagName": "mdc-radiogroup",
|
37780
|
-
"jsDoc": "/**\n * `mdc-radiogroup` - This is the wrapper component for radio buttons which are grouped together.\n * It can have a header text and a description. It enables users to select a single option from a set of options.\n * It is often used in forms, settings, and selection in lists. It automatically group the radio buttons inside it.\n *\n * @tagname mdc-radiogroup\n *\n * @cssproperty --mdc-radiogroup-description-text-normal - color of the description text\n *\n */",
|
37781
|
-
"customElement": true,
|
37782
|
-
"slots": [
|
37860
|
+
"cssProperties": [
|
37783
37861
|
{
|
37784
|
-
"description": "
|
37785
|
-
"name": "
|
37862
|
+
"description": "Border color for the input container when disabled",
|
37863
|
+
"name": "--mdc-input-disabled-border-color",
|
37786
37864
|
"inheritedFrom": {
|
37787
|
-
"name": "
|
37788
|
-
"module": "src/components/
|
37865
|
+
"name": "Input",
|
37866
|
+
"module": "src/components/input/input.component.ts"
|
37789
37867
|
}
|
37790
37868
|
},
|
37791
37869
|
{
|
37792
|
-
"description": "
|
37793
|
-
"name": "
|
37870
|
+
"description": "Text color for the input field when disabled",
|
37871
|
+
"name": "--mdc-input-disabled-text-color",
|
37794
37872
|
"inheritedFrom": {
|
37795
|
-
"name": "
|
37796
|
-
"module": "src/components/
|
37873
|
+
"name": "Input",
|
37874
|
+
"module": "src/components/input/input.component.ts"
|
37797
37875
|
}
|
37798
37876
|
},
|
37799
37877
|
{
|
37800
|
-
"description": "
|
37801
|
-
"name": "
|
37878
|
+
"description": "Background color for the input field when disabled",
|
37879
|
+
"name": "--mdc-input-disabled-background-color",
|
37802
37880
|
"inheritedFrom": {
|
37803
|
-
"name": "
|
37804
|
-
"module": "src/components/
|
37881
|
+
"name": "Input",
|
37882
|
+
"module": "src/components/input/input.component.ts"
|
37805
37883
|
}
|
37806
37884
|
},
|
37807
37885
|
{
|
37808
|
-
"description": "
|
37809
|
-
"name": "
|
37886
|
+
"description": "Border color for the input container",
|
37887
|
+
"name": "--mdc-input-border-color",
|
37810
37888
|
"inheritedFrom": {
|
37811
|
-
"name": "
|
37812
|
-
"module": "src/components/
|
37889
|
+
"name": "Input",
|
37890
|
+
"module": "src/components/input/input.component.ts"
|
37813
37891
|
}
|
37814
37892
|
},
|
37815
37893
|
{
|
37816
|
-
"description": "
|
37817
|
-
"name": "
|
37894
|
+
"description": "Text color for the input field",
|
37895
|
+
"name": "--mdc-input-text-color",
|
37818
37896
|
"inheritedFrom": {
|
37819
|
-
"name": "
|
37820
|
-
"module": "src/components/
|
37897
|
+
"name": "Input",
|
37898
|
+
"module": "src/components/input/input.component.ts"
|
37821
37899
|
}
|
37822
|
-
}
|
37823
|
-
],
|
37824
|
-
"cssParts": [
|
37900
|
+
},
|
37825
37901
|
{
|
37826
|
-
"description": "
|
37827
|
-
"name": "
|
37902
|
+
"description": "Background color for the input field",
|
37903
|
+
"name": "--mdc-input-background-color",
|
37828
37904
|
"inheritedFrom": {
|
37829
|
-
"name": "
|
37830
|
-
"module": "src/components/
|
37905
|
+
"name": "Input",
|
37906
|
+
"module": "src/components/input/input.component.ts"
|
37831
37907
|
}
|
37832
37908
|
},
|
37833
37909
|
{
|
37834
|
-
"description": "
|
37835
|
-
"name": "
|
37910
|
+
"description": "Background color for the selected text",
|
37911
|
+
"name": "--mdc-input-selection-background-color",
|
37836
37912
|
"inheritedFrom": {
|
37837
|
-
"name": "
|
37838
|
-
"module": "src/components/
|
37913
|
+
"name": "Input",
|
37914
|
+
"module": "src/components/input/input.component.ts"
|
37839
37915
|
}
|
37840
37916
|
},
|
37841
37917
|
{
|
37842
|
-
"description": "
|
37843
|
-
"name": "
|
37918
|
+
"description": "Text color for the selected text",
|
37919
|
+
"name": "--mdc-input-selection-text-color",
|
37844
37920
|
"inheritedFrom": {
|
37845
|
-
"name": "
|
37846
|
-
"module": "src/components/
|
37921
|
+
"name": "Input",
|
37922
|
+
"module": "src/components/input/input.component.ts"
|
37847
37923
|
}
|
37848
37924
|
},
|
37849
37925
|
{
|
37850
|
-
"description": "
|
37851
|
-
"name": "
|
37926
|
+
"description": "Text color for the help text",
|
37927
|
+
"name": "--mdc-input-support-text-color",
|
37852
37928
|
"inheritedFrom": {
|
37853
|
-
"name": "
|
37854
|
-
"module": "src/components/
|
37929
|
+
"name": "Input",
|
37930
|
+
"module": "src/components/input/input.component.ts"
|
37855
37931
|
}
|
37856
37932
|
},
|
37857
37933
|
{
|
37858
|
-
"description": "
|
37859
|
-
"name": "
|
37934
|
+
"description": "Background color for the input field when hovered",
|
37935
|
+
"name": "--mdc-input-hover-background-color",
|
37860
37936
|
"inheritedFrom": {
|
37861
|
-
"name": "
|
37862
|
-
"module": "src/components/
|
37937
|
+
"name": "Input",
|
37938
|
+
"module": "src/components/input/input.component.ts"
|
37863
37939
|
}
|
37864
37940
|
},
|
37865
37941
|
{
|
37866
|
-
"description": "
|
37867
|
-
"name": "
|
37942
|
+
"description": "Background color for the input field when focused",
|
37943
|
+
"name": "--mdc-input-focused-background-color",
|
37868
37944
|
"inheritedFrom": {
|
37869
|
-
"name": "
|
37870
|
-
"module": "src/components/
|
37945
|
+
"name": "Input",
|
37946
|
+
"module": "src/components/input/input.component.ts"
|
37871
37947
|
}
|
37872
37948
|
},
|
37873
37949
|
{
|
37874
|
-
"description": "
|
37875
|
-
"name": "
|
37950
|
+
"description": "Border color for the input container when focused",
|
37951
|
+
"name": "--mdc-input-focused-border-color",
|
37876
37952
|
"inheritedFrom": {
|
37877
|
-
"name": "
|
37878
|
-
"module": "src/components/
|
37953
|
+
"name": "Input",
|
37954
|
+
"module": "src/components/input/input.component.ts"
|
37879
37955
|
}
|
37880
37956
|
},
|
37881
37957
|
{
|
37882
|
-
"description": "
|
37883
|
-
"name": "
|
37958
|
+
"description": "Border color for the input container when error",
|
37959
|
+
"name": "--mdc-input-error-border-color",
|
37884
37960
|
"inheritedFrom": {
|
37885
|
-
"name": "
|
37886
|
-
"module": "src/components/
|
37961
|
+
"name": "Input",
|
37962
|
+
"module": "src/components/input/input.component.ts"
|
37887
37963
|
}
|
37888
37964
|
},
|
37889
37965
|
{
|
37890
|
-
"description": "
|
37891
|
-
"name": "
|
37966
|
+
"description": "Border color for the input container when warning",
|
37967
|
+
"name": "--mdc-input-warning-border-color",
|
37892
37968
|
"inheritedFrom": {
|
37893
|
-
"name": "
|
37894
|
-
"module": "src/components/
|
37969
|
+
"name": "Input",
|
37970
|
+
"module": "src/components/input/input.component.ts"
|
37895
37971
|
}
|
37896
37972
|
},
|
37897
37973
|
{
|
37898
|
-
"description": "
|
37899
|
-
"name": "
|
37974
|
+
"description": "Border color for the input container when success",
|
37975
|
+
"name": "--mdc-input-success-border-color",
|
37900
37976
|
"inheritedFrom": {
|
37901
|
-
"name": "
|
37902
|
-
"module": "src/components/
|
37977
|
+
"name": "Input",
|
37978
|
+
"module": "src/components/input/input.component.ts"
|
37979
|
+
}
|
37980
|
+
},
|
37981
|
+
{
|
37982
|
+
"description": "Border color for the input container when primary",
|
37983
|
+
"name": "--mdc-input-primary-border-color",
|
37984
|
+
"inheritedFrom": {
|
37985
|
+
"name": "Input",
|
37986
|
+
"module": "src/components/input/input.component.ts"
|
37903
37987
|
}
|
37904
37988
|
}
|
37905
37989
|
]
|
@@ -37910,8 +37994,8 @@
|
|
37910
37994
|
"kind": "js",
|
37911
37995
|
"name": "default",
|
37912
37996
|
"declaration": {
|
37913
|
-
"name": "
|
37914
|
-
"module": "components/
|
37997
|
+
"name": "Searchfield",
|
37998
|
+
"module": "components/searchfield/searchfield.component.js"
|
37915
37999
|
}
|
37916
38000
|
}
|
37917
38001
|
]
|
@@ -38359,7 +38443,7 @@
|
|
38359
38443
|
{
|
38360
38444
|
"name": "target",
|
38361
38445
|
"type": {
|
38362
|
-
"text": "
|
38446
|
+
"text": "HTMLElement | null"
|
38363
38447
|
},
|
38364
38448
|
"description": "The target element that triggered the event."
|
38365
38449
|
}
|
@@ -39156,6 +39240,229 @@
|
|
39156
39240
|
}
|
39157
39241
|
]
|
39158
39242
|
},
|
39243
|
+
{
|
39244
|
+
"kind": "javascript-module",
|
39245
|
+
"path": "components/sidenavigation/sidenavigation.component.js",
|
39246
|
+
"declarations": [
|
39247
|
+
{
|
39248
|
+
"kind": "class",
|
39249
|
+
"description": "The `mdc-sidenavigation` component provides a vertically stacked navigation experience,\ntypically used in layouts with persistent or collapsible sidebars.\n\n## Features:\n- Supports four layout variants: `fixed-collapsed`, `fixed-expanded`, `flexible`, and `hidden`\n- Toggleable expand/collapse behavior\n- Displays brand logo and customer name\n- Serves as a context provider for descendant components - `mdc-menubar` and `mdc-navmenuitem`\n\n### Usage:\nIn a sidenavigation, navmenuitems can be used in the following ways:\n\n1. **Simple navmenuitem** – No submenu or interaction beyond selection.\n\n2. **NavMenuItem with submenu**:\n - Provide an `id` on the `mdc-navmenuitem`\n - Set the `triggerId` on the corresponding `mdc-menupopover` to match the navmenuitem's `id`\n - Set `parent-nav-tooltip-text` with appropriate text that will display when a child menu item\n inside the nested menupopover is active, conveying which submenu item is currently selected\n\n3. **Actionable navmenuitem (no submenu)**:\n - Performs an action such as navigation or alert trigger\n - Set `disable-aria-current=\"true\"` to maintain visual active state without navigation behavior\n\n### Recommendations:\n- Use `mdc-text` for section headers\n- Use `mdc-divider` with the attribute `variant=\"gradient\"` for section dividers\n- For the brand logo, use an informative icon. Refer to `Momentum Informative Icons`\n\n#### Accessibility Notes:\n- Always provide meaningful `aria-label` attributes for both `mdc-navmenuitem` and `mdc-menubar`\nto ensure screen reader support\n- Set `grabber-btn-aria-label` to provide accessible labels for the expand/collapse grabber button",
|
39250
|
+
"name": "SideNavigation",
|
39251
|
+
"cssProperties": [
|
39252
|
+
{
|
39253
|
+
"description": "width of the sideNavigation when expanded",
|
39254
|
+
"name": "--mdc-sidenavigation-expanded-width"
|
39255
|
+
},
|
39256
|
+
{
|
39257
|
+
"description": "width of the sideNavigation when collapsed",
|
39258
|
+
"name": "--mdc-sidenavigation-collapsed-width"
|
39259
|
+
},
|
39260
|
+
{
|
39261
|
+
"description": "z-index of the vertical divider button",
|
39262
|
+
"name": "--mdc-sidenavigation-vertical-divider-button-z-index"
|
39263
|
+
}
|
39264
|
+
],
|
39265
|
+
"cssParts": [
|
39266
|
+
{
|
39267
|
+
"description": "The main container wrapping the entire side navigation.",
|
39268
|
+
"name": "side-navigation-container"
|
39269
|
+
},
|
39270
|
+
{
|
39271
|
+
"description": "The scrollable section of the side navigation.",
|
39272
|
+
"name": "scrollable-section"
|
39273
|
+
},
|
39274
|
+
{
|
39275
|
+
"description": "The fixed section of the side navigation.",
|
39276
|
+
"name": "fixed-section"
|
39277
|
+
},
|
39278
|
+
{
|
39279
|
+
"description": "The divider between the scrollable and fixed sections.",
|
39280
|
+
"name": "separator"
|
39281
|
+
},
|
39282
|
+
{
|
39283
|
+
"description": "The container wrapping the brand logo and footer text.",
|
39284
|
+
"name": "brand-logo-container"
|
39285
|
+
},
|
39286
|
+
{
|
39287
|
+
"description": "The footer text label in the fixed section.",
|
39288
|
+
"name": "footer-text"
|
39289
|
+
},
|
39290
|
+
{
|
39291
|
+
"description": "The vertical divider between the scrollable and fixed sections.",
|
39292
|
+
"name": "vertical-divider"
|
39293
|
+
},
|
39294
|
+
{
|
39295
|
+
"description": "The button inside the vertical divider used to toggle expand/collapse.",
|
39296
|
+
"name": "vertical-divider-button"
|
39297
|
+
}
|
39298
|
+
],
|
39299
|
+
"slots": [
|
39300
|
+
{
|
39301
|
+
"description": "Slot for the scrollable content area of the side navigation.",
|
39302
|
+
"name": "scrollable-section"
|
39303
|
+
},
|
39304
|
+
{
|
39305
|
+
"description": "Slot for the fixed content area of the side navigation.",
|
39306
|
+
"name": "fixed-section"
|
39307
|
+
},
|
39308
|
+
{
|
39309
|
+
"description": "Slot for the brand logo (e.g., icon or img).",
|
39310
|
+
"name": "brand-logo"
|
39311
|
+
}
|
39312
|
+
],
|
39313
|
+
"members": [
|
39314
|
+
{
|
39315
|
+
"kind": "field",
|
39316
|
+
"name": "variant",
|
39317
|
+
"type": {
|
39318
|
+
"text": "SideNavigationVariant"
|
39319
|
+
},
|
39320
|
+
"description": "Four variants of the sideNavigation\n- **fixed-collapsed**: Shows icons without labels and has fixed width, 4.5rem.\n- **fixed-expanded**: Shows icons with labels and has fixed width, 15rem.\n- **flexible**: Toggles between collapsed/expanded states.\n- **hidden**: Removes the sidenavigation from the DOM.",
|
39321
|
+
"default": "flexible",
|
39322
|
+
"attribute": "variant",
|
39323
|
+
"reflects": true
|
39324
|
+
},
|
39325
|
+
{
|
39326
|
+
"kind": "field",
|
39327
|
+
"name": "footerText",
|
39328
|
+
"type": {
|
39329
|
+
"text": "string"
|
39330
|
+
},
|
39331
|
+
"default": "''",
|
39332
|
+
"description": "Displays footer text in the bottom section of the sidenavigation.",
|
39333
|
+
"attribute": "footer-text",
|
39334
|
+
"reflects": true
|
39335
|
+
},
|
39336
|
+
{
|
39337
|
+
"kind": "field",
|
39338
|
+
"name": "grabberBtnAriaLabel",
|
39339
|
+
"type": {
|
39340
|
+
"text": "string | undefined"
|
39341
|
+
},
|
39342
|
+
"description": "Provides an accessible label for the grabber button.\nThis value is used to set the `aria-label` attribute for the button.",
|
39343
|
+
"default": "''",
|
39344
|
+
"attribute": "grabber-btn-aria-label",
|
39345
|
+
"reflects": true
|
39346
|
+
},
|
39347
|
+
{
|
39348
|
+
"kind": "field",
|
39349
|
+
"name": "parentNavTooltipText",
|
39350
|
+
"type": {
|
39351
|
+
"text": "string | undefined"
|
39352
|
+
},
|
39353
|
+
"description": "Tooltip text shown on parent nav items when a child is active.",
|
39354
|
+
"attribute": "parent-nav-tooltip-text",
|
39355
|
+
"reflects": true
|
39356
|
+
},
|
39357
|
+
{
|
39358
|
+
"kind": "field",
|
39359
|
+
"name": "Context",
|
39360
|
+
"privacy": "public",
|
39361
|
+
"static": true,
|
39362
|
+
"readonly": true
|
39363
|
+
},
|
39364
|
+
{
|
39365
|
+
"kind": "method",
|
39366
|
+
"name": "updateContext",
|
39367
|
+
"privacy": "protected",
|
39368
|
+
"return": {
|
39369
|
+
"type": {
|
39370
|
+
"text": "void"
|
39371
|
+
}
|
39372
|
+
},
|
39373
|
+
"description": "Update all observing components of this\nprovider to update the values\n\nIs called on every re-render, see Provider class"
|
39374
|
+
},
|
39375
|
+
{
|
39376
|
+
"kind": "method",
|
39377
|
+
"name": "preventScrollOnSpace",
|
39378
|
+
"privacy": "private",
|
39379
|
+
"return": {
|
39380
|
+
"type": {
|
39381
|
+
"text": "void"
|
39382
|
+
}
|
39383
|
+
},
|
39384
|
+
"parameters": [
|
39385
|
+
{
|
39386
|
+
"name": "event",
|
39387
|
+
"type": {
|
39388
|
+
"text": "KeyboardEvent"
|
39389
|
+
}
|
39390
|
+
}
|
39391
|
+
]
|
39392
|
+
}
|
39393
|
+
],
|
39394
|
+
"events": [
|
39395
|
+
{
|
39396
|
+
"name": "toggle",
|
39397
|
+
"type": {
|
39398
|
+
"text": "CustomEvent"
|
39399
|
+
},
|
39400
|
+
"description": "(React: onToggle) Dispatched when the grabber button is clicked to expand/collapse the sidenavigation.",
|
39401
|
+
"reactName": "onToggle"
|
39402
|
+
},
|
39403
|
+
{
|
39404
|
+
"description": "(React: onActiveChange) Dispatched when the active state of a nested navmenuitem changes.",
|
39405
|
+
"name": "activechange",
|
39406
|
+
"reactName": "onActiveChange"
|
39407
|
+
}
|
39408
|
+
],
|
39409
|
+
"attributes": [
|
39410
|
+
{
|
39411
|
+
"name": "variant",
|
39412
|
+
"type": {
|
39413
|
+
"text": "SideNavigationVariant"
|
39414
|
+
},
|
39415
|
+
"description": "Four variants of the sideNavigation\n- **fixed-collapsed**: Shows icons without labels and has fixed width, 4.5rem.\n- **fixed-expanded**: Shows icons with labels and has fixed width, 15rem.\n- **flexible**: Toggles between collapsed/expanded states.\n- **hidden**: Removes the sidenavigation from the DOM.",
|
39416
|
+
"default": "flexible",
|
39417
|
+
"fieldName": "variant"
|
39418
|
+
},
|
39419
|
+
{
|
39420
|
+
"name": "footer-text",
|
39421
|
+
"type": {
|
39422
|
+
"text": "string"
|
39423
|
+
},
|
39424
|
+
"default": "''",
|
39425
|
+
"description": "Displays footer text in the bottom section of the sidenavigation.",
|
39426
|
+
"fieldName": "footerText"
|
39427
|
+
},
|
39428
|
+
{
|
39429
|
+
"name": "grabber-btn-aria-label",
|
39430
|
+
"type": {
|
39431
|
+
"text": "string | undefined"
|
39432
|
+
},
|
39433
|
+
"description": "Provides an accessible label for the grabber button.\nThis value is used to set the `aria-label` attribute for the button.",
|
39434
|
+
"default": "''",
|
39435
|
+
"fieldName": "grabberBtnAriaLabel"
|
39436
|
+
},
|
39437
|
+
{
|
39438
|
+
"name": "parent-nav-tooltip-text",
|
39439
|
+
"type": {
|
39440
|
+
"text": "string | undefined"
|
39441
|
+
},
|
39442
|
+
"description": "Tooltip text shown on parent nav items when a child is active.",
|
39443
|
+
"fieldName": "parentNavTooltipText"
|
39444
|
+
}
|
39445
|
+
],
|
39446
|
+
"superclass": {
|
39447
|
+
"name": "Provider",
|
39448
|
+
"module": "/src/models"
|
39449
|
+
},
|
39450
|
+
"tagName": "mdc-sidenavigation",
|
39451
|
+
"jsDoc": "/**\n * The `mdc-sidenavigation` component provides a vertically stacked navigation experience,\n * typically used in layouts with persistent or collapsible sidebars.\n *\n * ## Features:\n * - Supports four layout variants: `fixed-collapsed`, `fixed-expanded`, `flexible`, and `hidden`\n * - Toggleable expand/collapse behavior\n * - Displays brand logo and customer name\n * - Serves as a context provider for descendant components - `mdc-menubar` and `mdc-navmenuitem`\n *\n * ### Usage:\n * In a sidenavigation, navmenuitems can be used in the following ways:\n *\n * 1. **Simple navmenuitem** – No submenu or interaction beyond selection.\n *\n * 2. **NavMenuItem with submenu**:\n * - Provide an `id` on the `mdc-navmenuitem`\n * - Set the `triggerId` on the corresponding `mdc-menupopover` to match the navmenuitem's `id`\n * - Set `parent-nav-tooltip-text` with appropriate text that will display when a child menu item\n * inside the nested menupopover is active, conveying which submenu item is currently selected\n *\n * 3. **Actionable navmenuitem (no submenu)**:\n * - Performs an action such as navigation or alert trigger\n * - Set `disable-aria-current=\"true\"` to maintain visual active state without navigation behavior\n *\n * ### Recommendations:\n * - Use `mdc-text` for section headers\n * - Use `mdc-divider` with the attribute `variant=\"gradient\"` for section dividers\n * - For the brand logo, use an informative icon. Refer to `Momentum Informative Icons`\n *\n * #### Accessibility Notes:\n * - Always provide meaningful `aria-label` attributes for both `mdc-navmenuitem` and `mdc-menubar`\n * to ensure screen reader support\n * - Set `grabber-btn-aria-label` to provide accessible labels for the expand/collapse grabber button\n *\n * @dependency mdc-text\n * @dependency mdc-button\n * @dependency mdc-divider\n * @dependency mdc-menubar\n *\n * @event activechange - (React: onActiveChange) Dispatched when the active state of the navmenuitem changes.\n *\n * @tagname mdc-sidenavigation\n *\n * @slot scrollable-section - Slot for the scrollable content area of the side navigation.\n * @slot fixed-section - Slot for the fixed content area of the side navigation.\n * @slot brand-logo - Slot for the brand logo (e.g., icon or img).\n *\n * @csspart side-navigation-container - The main container wrapping the entire side navigation.\n * @csspart scrollable-section - The scrollable section of the side navigation.\n * @csspart fixed-section - The fixed section of the side navigation.\n * @csspart separator - The divider between the scrollable and fixed sections.\n * @csspart brand-logo-container - The container wrapping the brand logo and footer text.\n * @csspart footer-text - The footer text label in the fixed section.\n * @csspart vertical-divider - The vertical divider between the scrollable and fixed sections.\n * @csspart vertical-divider-button - The button inside the vertical divider used to toggle expand/collapse.\n *\n * @event toggle - (React: onToggle) Dispatched when the grabber button is clicked to expand/collapse the sidenavigation.\n * @event activechange - (React: onActiveChange) Dispatched when the active state of a nested navmenuitem changes.\n *\n * @cssproperty --mdc-sidenavigation-expanded-width - width of the sideNavigation when expanded\n * @cssproperty --mdc-sidenavigation-collapsed-width - width of the sideNavigation when collapsed\n * @cssproperty --mdc-sidenavigation-vertical-divider-button-z-index - z-index of the vertical divider button\n */",
|
39452
|
+
"customElement": true
|
39453
|
+
}
|
39454
|
+
],
|
39455
|
+
"exports": [
|
39456
|
+
{
|
39457
|
+
"kind": "js",
|
39458
|
+
"name": "default",
|
39459
|
+
"declaration": {
|
39460
|
+
"name": "SideNavigation",
|
39461
|
+
"module": "components/sidenavigation/sidenavigation.component.js"
|
39462
|
+
}
|
39463
|
+
}
|
39464
|
+
]
|
39465
|
+
},
|
39159
39466
|
{
|
39160
39467
|
"kind": "javascript-module",
|
39161
39468
|
"path": "components/skeleton/skeleton.component.js",
|
@@ -40019,229 +40326,6 @@
|
|
40019
40326
|
}
|
40020
40327
|
]
|
40021
40328
|
},
|
40022
|
-
{
|
40023
|
-
"kind": "javascript-module",
|
40024
|
-
"path": "components/sidenavigation/sidenavigation.component.js",
|
40025
|
-
"declarations": [
|
40026
|
-
{
|
40027
|
-
"kind": "class",
|
40028
|
-
"description": "The `mdc-sidenavigation` component provides a vertically stacked navigation experience,\ntypically used in layouts with persistent or collapsible sidebars.\n\n## Features:\n- Supports four layout variants: `fixed-collapsed`, `fixed-expanded`, `flexible`, and `hidden`\n- Toggleable expand/collapse behavior\n- Displays brand logo and customer name\n- Serves as a context provider for descendant components - `mdc-menubar` and `mdc-navmenuitem`\n\n### Usage:\nIn a sidenavigation, navmenuitems can be used in the following ways:\n\n1. **Simple navmenuitem** – No submenu or interaction beyond selection.\n\n2. **NavMenuItem with submenu**:\n - Provide an `id` on the `mdc-navmenuitem`\n - Set the `triggerId` on the corresponding `mdc-menupopover` to match the navmenuitem's `id`\n - Set `parent-nav-tooltip-text` with appropriate text that will display when a child menu item\n inside the nested menupopover is active, conveying which submenu item is currently selected\n\n3. **Actionable navmenuitem (no submenu)**:\n - Performs an action such as navigation or alert trigger\n - Set `disable-aria-current=\"true\"` to maintain visual active state without navigation behavior\n\n### Recommendations:\n- Use `mdc-text` for section headers\n- Use `mdc-divider` with the attribute `variant=\"gradient\"` for section dividers\n- For the brand logo, use an informative icon. Refer to `Momentum Informative Icons`\n\n#### Accessibility Notes:\n- Always provide meaningful `aria-label` attributes for both `mdc-navmenuitem` and `mdc-menubar`\nto ensure screen reader support\n- Set `grabber-btn-aria-label` to provide accessible labels for the expand/collapse grabber button",
|
40029
|
-
"name": "SideNavigation",
|
40030
|
-
"cssProperties": [
|
40031
|
-
{
|
40032
|
-
"description": "width of the sideNavigation when expanded",
|
40033
|
-
"name": "--mdc-sidenavigation-expanded-width"
|
40034
|
-
},
|
40035
|
-
{
|
40036
|
-
"description": "width of the sideNavigation when collapsed",
|
40037
|
-
"name": "--mdc-sidenavigation-collapsed-width"
|
40038
|
-
},
|
40039
|
-
{
|
40040
|
-
"description": "z-index of the vertical divider button",
|
40041
|
-
"name": "--mdc-sidenavigation-vertical-divider-button-z-index"
|
40042
|
-
}
|
40043
|
-
],
|
40044
|
-
"cssParts": [
|
40045
|
-
{
|
40046
|
-
"description": "The main container wrapping the entire side navigation.",
|
40047
|
-
"name": "side-navigation-container"
|
40048
|
-
},
|
40049
|
-
{
|
40050
|
-
"description": "The scrollable section of the side navigation.",
|
40051
|
-
"name": "scrollable-section"
|
40052
|
-
},
|
40053
|
-
{
|
40054
|
-
"description": "The fixed section of the side navigation.",
|
40055
|
-
"name": "fixed-section"
|
40056
|
-
},
|
40057
|
-
{
|
40058
|
-
"description": "The divider between the scrollable and fixed sections.",
|
40059
|
-
"name": "separator"
|
40060
|
-
},
|
40061
|
-
{
|
40062
|
-
"description": "The container wrapping the brand logo and footer text.",
|
40063
|
-
"name": "brand-logo-container"
|
40064
|
-
},
|
40065
|
-
{
|
40066
|
-
"description": "The footer text label in the fixed section.",
|
40067
|
-
"name": "footer-text"
|
40068
|
-
},
|
40069
|
-
{
|
40070
|
-
"description": "The vertical divider between the scrollable and fixed sections.",
|
40071
|
-
"name": "vertical-divider"
|
40072
|
-
},
|
40073
|
-
{
|
40074
|
-
"description": "The button inside the vertical divider used to toggle expand/collapse.",
|
40075
|
-
"name": "vertical-divider-button"
|
40076
|
-
}
|
40077
|
-
],
|
40078
|
-
"slots": [
|
40079
|
-
{
|
40080
|
-
"description": "Slot for the scrollable content area of the side navigation.",
|
40081
|
-
"name": "scrollable-section"
|
40082
|
-
},
|
40083
|
-
{
|
40084
|
-
"description": "Slot for the fixed content area of the side navigation.",
|
40085
|
-
"name": "fixed-section"
|
40086
|
-
},
|
40087
|
-
{
|
40088
|
-
"description": "Slot for the brand logo (e.g., icon or img).",
|
40089
|
-
"name": "brand-logo"
|
40090
|
-
}
|
40091
|
-
],
|
40092
|
-
"members": [
|
40093
|
-
{
|
40094
|
-
"kind": "field",
|
40095
|
-
"name": "variant",
|
40096
|
-
"type": {
|
40097
|
-
"text": "SideNavigationVariant"
|
40098
|
-
},
|
40099
|
-
"description": "Four variants of the sideNavigation\n- **fixed-collapsed**: Shows icons without labels and has fixed width, 4.5rem.\n- **fixed-expanded**: Shows icons with labels and has fixed width, 15rem.\n- **flexible**: Toggles between collapsed/expanded states.\n- **hidden**: Removes the sidenavigation from the DOM.",
|
40100
|
-
"default": "flexible",
|
40101
|
-
"attribute": "variant",
|
40102
|
-
"reflects": true
|
40103
|
-
},
|
40104
|
-
{
|
40105
|
-
"kind": "field",
|
40106
|
-
"name": "footerText",
|
40107
|
-
"type": {
|
40108
|
-
"text": "string"
|
40109
|
-
},
|
40110
|
-
"default": "''",
|
40111
|
-
"description": "Displays footer text in the bottom section of the sidenavigation.",
|
40112
|
-
"attribute": "footer-text",
|
40113
|
-
"reflects": true
|
40114
|
-
},
|
40115
|
-
{
|
40116
|
-
"kind": "field",
|
40117
|
-
"name": "grabberBtnAriaLabel",
|
40118
|
-
"type": {
|
40119
|
-
"text": "string | undefined"
|
40120
|
-
},
|
40121
|
-
"description": "Provides an accessible label for the grabber button.\nThis value is used to set the `aria-label` attribute for the button.",
|
40122
|
-
"default": "''",
|
40123
|
-
"attribute": "grabber-btn-aria-label",
|
40124
|
-
"reflects": true
|
40125
|
-
},
|
40126
|
-
{
|
40127
|
-
"kind": "field",
|
40128
|
-
"name": "parentNavTooltipText",
|
40129
|
-
"type": {
|
40130
|
-
"text": "string | undefined"
|
40131
|
-
},
|
40132
|
-
"description": "Tooltip text shown on parent nav items when a child is active.",
|
40133
|
-
"attribute": "parent-nav-tooltip-text",
|
40134
|
-
"reflects": true
|
40135
|
-
},
|
40136
|
-
{
|
40137
|
-
"kind": "field",
|
40138
|
-
"name": "Context",
|
40139
|
-
"privacy": "public",
|
40140
|
-
"static": true,
|
40141
|
-
"readonly": true
|
40142
|
-
},
|
40143
|
-
{
|
40144
|
-
"kind": "method",
|
40145
|
-
"name": "updateContext",
|
40146
|
-
"privacy": "protected",
|
40147
|
-
"return": {
|
40148
|
-
"type": {
|
40149
|
-
"text": "void"
|
40150
|
-
}
|
40151
|
-
},
|
40152
|
-
"description": "Update all observing components of this\nprovider to update the values\n\nIs called on every re-render, see Provider class"
|
40153
|
-
},
|
40154
|
-
{
|
40155
|
-
"kind": "method",
|
40156
|
-
"name": "preventScrollOnSpace",
|
40157
|
-
"privacy": "private",
|
40158
|
-
"return": {
|
40159
|
-
"type": {
|
40160
|
-
"text": "void"
|
40161
|
-
}
|
40162
|
-
},
|
40163
|
-
"parameters": [
|
40164
|
-
{
|
40165
|
-
"name": "event",
|
40166
|
-
"type": {
|
40167
|
-
"text": "KeyboardEvent"
|
40168
|
-
}
|
40169
|
-
}
|
40170
|
-
]
|
40171
|
-
}
|
40172
|
-
],
|
40173
|
-
"events": [
|
40174
|
-
{
|
40175
|
-
"name": "toggle",
|
40176
|
-
"type": {
|
40177
|
-
"text": "CustomEvent"
|
40178
|
-
},
|
40179
|
-
"description": "(React: onToggle) Dispatched when the grabber button is clicked to expand/collapse the sidenavigation.",
|
40180
|
-
"reactName": "onToggle"
|
40181
|
-
},
|
40182
|
-
{
|
40183
|
-
"description": "(React: onActiveChange) Dispatched when the active state of a nested navmenuitem changes.",
|
40184
|
-
"name": "activechange",
|
40185
|
-
"reactName": "onActiveChange"
|
40186
|
-
}
|
40187
|
-
],
|
40188
|
-
"attributes": [
|
40189
|
-
{
|
40190
|
-
"name": "variant",
|
40191
|
-
"type": {
|
40192
|
-
"text": "SideNavigationVariant"
|
40193
|
-
},
|
40194
|
-
"description": "Four variants of the sideNavigation\n- **fixed-collapsed**: Shows icons without labels and has fixed width, 4.5rem.\n- **fixed-expanded**: Shows icons with labels and has fixed width, 15rem.\n- **flexible**: Toggles between collapsed/expanded states.\n- **hidden**: Removes the sidenavigation from the DOM.",
|
40195
|
-
"default": "flexible",
|
40196
|
-
"fieldName": "variant"
|
40197
|
-
},
|
40198
|
-
{
|
40199
|
-
"name": "footer-text",
|
40200
|
-
"type": {
|
40201
|
-
"text": "string"
|
40202
|
-
},
|
40203
|
-
"default": "''",
|
40204
|
-
"description": "Displays footer text in the bottom section of the sidenavigation.",
|
40205
|
-
"fieldName": "footerText"
|
40206
|
-
},
|
40207
|
-
{
|
40208
|
-
"name": "grabber-btn-aria-label",
|
40209
|
-
"type": {
|
40210
|
-
"text": "string | undefined"
|
40211
|
-
},
|
40212
|
-
"description": "Provides an accessible label for the grabber button.\nThis value is used to set the `aria-label` attribute for the button.",
|
40213
|
-
"default": "''",
|
40214
|
-
"fieldName": "grabberBtnAriaLabel"
|
40215
|
-
},
|
40216
|
-
{
|
40217
|
-
"name": "parent-nav-tooltip-text",
|
40218
|
-
"type": {
|
40219
|
-
"text": "string | undefined"
|
40220
|
-
},
|
40221
|
-
"description": "Tooltip text shown on parent nav items when a child is active.",
|
40222
|
-
"fieldName": "parentNavTooltipText"
|
40223
|
-
}
|
40224
|
-
],
|
40225
|
-
"superclass": {
|
40226
|
-
"name": "Provider",
|
40227
|
-
"module": "/src/models"
|
40228
|
-
},
|
40229
|
-
"tagName": "mdc-sidenavigation",
|
40230
|
-
"jsDoc": "/**\n * The `mdc-sidenavigation` component provides a vertically stacked navigation experience,\n * typically used in layouts with persistent or collapsible sidebars.\n *\n * ## Features:\n * - Supports four layout variants: `fixed-collapsed`, `fixed-expanded`, `flexible`, and `hidden`\n * - Toggleable expand/collapse behavior\n * - Displays brand logo and customer name\n * - Serves as a context provider for descendant components - `mdc-menubar` and `mdc-navmenuitem`\n *\n * ### Usage:\n * In a sidenavigation, navmenuitems can be used in the following ways:\n *\n * 1. **Simple navmenuitem** – No submenu or interaction beyond selection.\n *\n * 2. **NavMenuItem with submenu**:\n * - Provide an `id` on the `mdc-navmenuitem`\n * - Set the `triggerId` on the corresponding `mdc-menupopover` to match the navmenuitem's `id`\n * - Set `parent-nav-tooltip-text` with appropriate text that will display when a child menu item\n * inside the nested menupopover is active, conveying which submenu item is currently selected\n *\n * 3. **Actionable navmenuitem (no submenu)**:\n * - Performs an action such as navigation or alert trigger\n * - Set `disable-aria-current=\"true\"` to maintain visual active state without navigation behavior\n *\n * ### Recommendations:\n * - Use `mdc-text` for section headers\n * - Use `mdc-divider` with the attribute `variant=\"gradient\"` for section dividers\n * - For the brand logo, use an informative icon. Refer to `Momentum Informative Icons`\n *\n * #### Accessibility Notes:\n * - Always provide meaningful `aria-label` attributes for both `mdc-navmenuitem` and `mdc-menubar`\n * to ensure screen reader support\n * - Set `grabber-btn-aria-label` to provide accessible labels for the expand/collapse grabber button\n *\n * @dependency mdc-text\n * @dependency mdc-button\n * @dependency mdc-divider\n * @dependency mdc-menubar\n *\n * @event activechange - (React: onActiveChange) Dispatched when the active state of the navmenuitem changes.\n *\n * @tagname mdc-sidenavigation\n *\n * @slot scrollable-section - Slot for the scrollable content area of the side navigation.\n * @slot fixed-section - Slot for the fixed content area of the side navigation.\n * @slot brand-logo - Slot for the brand logo (e.g., icon or img).\n *\n * @csspart side-navigation-container - The main container wrapping the entire side navigation.\n * @csspart scrollable-section - The scrollable section of the side navigation.\n * @csspart fixed-section - The fixed section of the side navigation.\n * @csspart separator - The divider between the scrollable and fixed sections.\n * @csspart brand-logo-container - The container wrapping the brand logo and footer text.\n * @csspart footer-text - The footer text label in the fixed section.\n * @csspart vertical-divider - The vertical divider between the scrollable and fixed sections.\n * @csspart vertical-divider-button - The button inside the vertical divider used to toggle expand/collapse.\n *\n * @event toggle - (React: onToggle) Dispatched when the grabber button is clicked to expand/collapse the sidenavigation.\n * @event activechange - (React: onActiveChange) Dispatched when the active state of a nested navmenuitem changes.\n *\n * @cssproperty --mdc-sidenavigation-expanded-width - width of the sideNavigation when expanded\n * @cssproperty --mdc-sidenavigation-collapsed-width - width of the sideNavigation when collapsed\n * @cssproperty --mdc-sidenavigation-vertical-divider-button-z-index - z-index of the vertical divider button\n */",
|
40231
|
-
"customElement": true
|
40232
|
-
}
|
40233
|
-
],
|
40234
|
-
"exports": [
|
40235
|
-
{
|
40236
|
-
"kind": "js",
|
40237
|
-
"name": "default",
|
40238
|
-
"declaration": {
|
40239
|
-
"name": "SideNavigation",
|
40240
|
-
"module": "components/sidenavigation/sidenavigation.component.js"
|
40241
|
-
}
|
40242
|
-
}
|
40243
|
-
]
|
40244
|
-
},
|
40245
40329
|
{
|
40246
40330
|
"kind": "javascript-module",
|
40247
40331
|
"path": "components/spinner/spinner.component.js",
|
@@ -52042,7 +52126,7 @@
|
|
52042
52126
|
{
|
52043
52127
|
"name": "target",
|
52044
52128
|
"type": {
|
52045
|
-
"text": "
|
52129
|
+
"text": "HTMLElement | null"
|
52046
52130
|
},
|
52047
52131
|
"description": "The target element that triggered the event."
|
52048
52132
|
}
|