@momentum-design/components 0.104.14 → 0.104.15
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 +164 -158
- package/dist/browser/index.js.map +3 -3
- package/dist/components/sidenavigation/sidenavigation.component.d.ts +22 -32
- package/dist/components/sidenavigation/sidenavigation.component.js +40 -55
- package/dist/components/sidenavigation/sidenavigation.styles.js +5 -0
- package/dist/components/sidenavigation/sidenavigation.types.d.ts +9 -4
- package/dist/custom-elements.json +773 -737
- package/dist/react/index.d.ts +1 -1
- package/dist/react/index.js +1 -1
- package/dist/react/sidenavigation/index.d.ts +23 -3
- package/dist/react/sidenavigation/index.js +15 -1
- package/package.json +1 -1
@@ -33010,8 +33010,46 @@
|
|
33010
33010
|
"name": "--mdc-sidenavigation-expanded-width"
|
33011
33011
|
},
|
33012
33012
|
{
|
33013
|
-
"description": "width of the sideNavigation when
|
33013
|
+
"description": "width of the sideNavigation when collapsed",
|
33014
33014
|
"name": "--mdc-sidenavigation-collapsed-width"
|
33015
|
+
},
|
33016
|
+
{
|
33017
|
+
"description": "z-index of the vertical divider button",
|
33018
|
+
"name": "--mdc-sidenavigation-vertical-divider-button-z-index"
|
33019
|
+
}
|
33020
|
+
],
|
33021
|
+
"cssParts": [
|
33022
|
+
{
|
33023
|
+
"description": "The main container wrapping the entire side navigation.",
|
33024
|
+
"name": "side-navigation-container"
|
33025
|
+
},
|
33026
|
+
{
|
33027
|
+
"description": "The scrollable section of the side navigation.",
|
33028
|
+
"name": "scrollable-section"
|
33029
|
+
},
|
33030
|
+
{
|
33031
|
+
"description": "The fixed section of the side navigation.",
|
33032
|
+
"name": "fixed-section"
|
33033
|
+
},
|
33034
|
+
{
|
33035
|
+
"description": "The divider between the scrollable and fixed sections.",
|
33036
|
+
"name": "separator"
|
33037
|
+
},
|
33038
|
+
{
|
33039
|
+
"description": "The container wrapping the brand logo and footer text.",
|
33040
|
+
"name": "brand-logo-container"
|
33041
|
+
},
|
33042
|
+
{
|
33043
|
+
"description": "The footer text label in the fixed section.",
|
33044
|
+
"name": "footer-text"
|
33045
|
+
},
|
33046
|
+
{
|
33047
|
+
"description": "The vertical divider between the scrollable and fixed sections.",
|
33048
|
+
"name": "vertical-divider"
|
33049
|
+
},
|
33050
|
+
{
|
33051
|
+
"description": "The button inside the vertical divider used to toggle expand/collapse.",
|
33052
|
+
"name": "vertical-divider-button"
|
33015
33053
|
}
|
33016
33054
|
],
|
33017
33055
|
"slots": [
|
@@ -33029,13 +33067,6 @@
|
|
33029
33067
|
}
|
33030
33068
|
],
|
33031
33069
|
"members": [
|
33032
|
-
{
|
33033
|
-
"kind": "field",
|
33034
|
-
"name": "Context",
|
33035
|
-
"privacy": "public",
|
33036
|
-
"static": true,
|
33037
|
-
"readonly": true
|
33038
|
-
},
|
33039
33070
|
{
|
33040
33071
|
"kind": "field",
|
33041
33072
|
"name": "variant",
|
@@ -33079,6 +33110,13 @@
|
|
33079
33110
|
"attribute": "parent-nav-tooltip-text",
|
33080
33111
|
"reflects": true
|
33081
33112
|
},
|
33113
|
+
{
|
33114
|
+
"kind": "field",
|
33115
|
+
"name": "Context",
|
33116
|
+
"privacy": "public",
|
33117
|
+
"static": true,
|
33118
|
+
"readonly": true
|
33119
|
+
},
|
33082
33120
|
{
|
33083
33121
|
"kind": "method",
|
33084
33122
|
"name": "updateContext",
|
@@ -33090,16 +33128,6 @@
|
|
33090
33128
|
},
|
33091
33129
|
"description": "Update all observing components of this\nprovider to update the values\n\nIs called on every re-render, see Provider class"
|
33092
33130
|
},
|
33093
|
-
{
|
33094
|
-
"kind": "field",
|
33095
|
-
"name": "navMenuItems",
|
33096
|
-
"type": {
|
33097
|
-
"text": "NavMenuItem[]"
|
33098
|
-
},
|
33099
|
-
"privacy": "private",
|
33100
|
-
"description": "Returns all nested, non-disabled mdc-navmenuitem elements inside this component.",
|
33101
|
-
"readonly": true
|
33102
|
-
},
|
33103
33131
|
{
|
33104
33132
|
"kind": "method",
|
33105
33133
|
"name": "preventScrollOnSpace",
|
@@ -33121,7 +33149,15 @@
|
|
33121
33149
|
],
|
33122
33150
|
"events": [
|
33123
33151
|
{
|
33124
|
-
"
|
33152
|
+
"name": "toggle",
|
33153
|
+
"type": {
|
33154
|
+
"text": "CustomEvent"
|
33155
|
+
},
|
33156
|
+
"description": "(React: onToggle) Dispatched when the grabber button is clicked to expand/collapse the sidenavigation.",
|
33157
|
+
"reactName": "onToggle"
|
33158
|
+
},
|
33159
|
+
{
|
33160
|
+
"description": "(React: onActiveChange) Dispatched when the active state of a nested navmenuitem changes.",
|
33125
33161
|
"name": "activechange",
|
33126
33162
|
"reactName": "onActiveChange"
|
33127
33163
|
}
|
@@ -33168,7 +33204,7 @@
|
|
33168
33204
|
"module": "/src/models"
|
33169
33205
|
},
|
33170
33206
|
"tagName": "mdc-sidenavigation",
|
33171
|
-
"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 * @cssproperty --mdc-sidenavigation-expanded-width - width of the sideNavigation when expanded\n * @cssproperty --mdc-sidenavigation-collapsed-width - width of the sideNavigation when
|
33207
|
+
"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 */",
|
33172
33208
|
"customElement": true
|
33173
33209
|
}
|
33174
33210
|
],
|
@@ -36868,376 +36904,690 @@
|
|
36868
36904
|
},
|
36869
36905
|
{
|
36870
36906
|
"kind": "javascript-module",
|
36871
|
-
"path": "components/
|
36907
|
+
"path": "components/toggle/toggle.component.js",
|
36872
36908
|
"declarations": [
|
36873
36909
|
{
|
36874
36910
|
"kind": "class",
|
36875
|
-
"description": "
|
36876
|
-
"name": "
|
36911
|
+
"description": "Toggle Component is an interactive control used to switch between two mutually exclusive options,\nsuch as On/Off, Active/Inactive. These are commonly used in settings panels, forms, and preference selections\nwhere users need to enable or disable a feature.\nIt contains an optional label and an optional helper text.\n\nTo create a group of toggles, use the FormFieldGroup component.\n\nNote: It internally renders a checkbox styled as a toggle switch.",
|
36912
|
+
"name": "Toggle",
|
36877
36913
|
"cssProperties": [
|
36878
36914
|
{
|
36879
|
-
"description": "
|
36880
|
-
"name": "--mdc-
|
36881
|
-
},
|
36882
|
-
{
|
36883
|
-
"description": "Border color of the toast.",
|
36884
|
-
"name": "--mdc-toast-border-color"
|
36885
|
-
},
|
36886
|
-
{
|
36887
|
-
"description": "Color of the header text in the toast.",
|
36888
|
-
"name": "--mdc-toast-header-text-color"
|
36889
|
-
},
|
36890
|
-
{
|
36891
|
-
"description": "Color of the icon in the toast.",
|
36892
|
-
"name": "--mdc-toast-icon-color"
|
36893
|
-
},
|
36894
|
-
{
|
36895
|
-
"description": "Elevation effect applied to the toast.",
|
36896
|
-
"name": "--mdc-toast-elevation-3"
|
36897
|
-
},
|
36898
|
-
{
|
36899
|
-
"description": "Width of the toast.",
|
36900
|
-
"name": "--mdc-toast-width"
|
36915
|
+
"description": "Width of the toggle",
|
36916
|
+
"name": "--mdc-toggle-width"
|
36901
36917
|
},
|
36902
36918
|
{
|
36903
|
-
"description": "
|
36904
|
-
"name": "--mdc-
|
36905
|
-
}
|
36906
|
-
],
|
36907
|
-
"cssParts": [
|
36908
|
-
{
|
36909
|
-
"description": "The container for the toast's main content, including icon, text, and close button.",
|
36910
|
-
"name": "content-container"
|
36919
|
+
"description": "Height of the toggle",
|
36920
|
+
"name": "--mdc-toggle-height"
|
36911
36921
|
},
|
36912
36922
|
{
|
36913
|
-
"description": "
|
36914
|
-
"name": "
|
36923
|
+
"description": "Width of the toggle when it's size is compact",
|
36924
|
+
"name": "--mdc-toggle-width-compact"
|
36915
36925
|
},
|
36916
36926
|
{
|
36917
|
-
"description": "
|
36918
|
-
"name": "
|
36927
|
+
"description": "Height of the toggle when it's size is compact",
|
36928
|
+
"name": "--mdc-toggle-height-compact"
|
36919
36929
|
},
|
36920
36930
|
{
|
36921
|
-
"description": "
|
36922
|
-
"name": "
|
36931
|
+
"description": "Line height of the toggle label",
|
36932
|
+
"name": "--mdc-toggle-label-lineheight"
|
36923
36933
|
},
|
36924
36934
|
{
|
36925
|
-
"description": "
|
36926
|
-
"name": "
|
36935
|
+
"description": "Font size of the toggle label",
|
36936
|
+
"name": "--mdc-toggle-label-fontsize"
|
36927
36937
|
},
|
36928
36938
|
{
|
36929
|
-
"description": "
|
36930
|
-
"name": "
|
36939
|
+
"description": "Font weight of the toggle label",
|
36940
|
+
"name": "--mdc-toggle-label-fontweight"
|
36931
36941
|
},
|
36932
36942
|
{
|
36933
|
-
"description": "
|
36934
|
-
"name": "
|
36935
|
-
}
|
36936
|
-
],
|
36937
|
-
"slots": [
|
36938
|
-
{
|
36939
|
-
"description": "Slot for custom content before the icon (only for custom variant).",
|
36940
|
-
"name": "content-prefix"
|
36943
|
+
"description": "Color of the toggle label and help text in disabled state",
|
36944
|
+
"name": "--mdc-toggle-label-color-disabled"
|
36941
36945
|
},
|
36942
36946
|
{
|
36943
|
-
"description": "
|
36944
|
-
"name": "
|
36947
|
+
"description": "Color of the help text label",
|
36948
|
+
"name": "--mdc-toggle-help-text-color"
|
36945
36949
|
},
|
36946
36950
|
{
|
36947
|
-
"description": "
|
36948
|
-
"name": "
|
36951
|
+
"description": "Background color of the active toggle in hover state",
|
36952
|
+
"name": "--mdc-toggle-active-hover-color"
|
36949
36953
|
},
|
36950
36954
|
{
|
36951
|
-
"description": "
|
36952
|
-
"name": "
|
36955
|
+
"description": "Background color of the active toggle in pressed state",
|
36956
|
+
"name": "--mdc-toggle-active-pressed-color"
|
36953
36957
|
},
|
36954
36958
|
{
|
36955
|
-
"description": "
|
36956
|
-
"name": "
|
36959
|
+
"description": "Background color of the inactive toggle in hover state",
|
36960
|
+
"name": "--mdc-toggle-inactive-hover-color"
|
36957
36961
|
},
|
36958
36962
|
{
|
36959
|
-
"description": "
|
36960
|
-
"name": "
|
36963
|
+
"description": "Background color of the inactive toggle in pressed state",
|
36964
|
+
"name": "--mdc-toggle-inactive-pressed-color"
|
36961
36965
|
}
|
36962
36966
|
],
|
36963
36967
|
"members": [
|
36964
36968
|
{
|
36965
36969
|
"kind": "field",
|
36966
|
-
"name": "
|
36970
|
+
"name": "checked",
|
36967
36971
|
"type": {
|
36968
|
-
"text": "
|
36972
|
+
"text": "boolean"
|
36969
36973
|
},
|
36970
|
-
"
|
36971
|
-
"
|
36972
|
-
"attribute": "
|
36974
|
+
"default": "false",
|
36975
|
+
"description": "Determines whether the toggle is active or inactive.",
|
36976
|
+
"attribute": "checked",
|
36973
36977
|
"reflects": true
|
36974
36978
|
},
|
36975
36979
|
{
|
36976
36980
|
"kind": "field",
|
36977
|
-
"name": "
|
36981
|
+
"name": "size",
|
36978
36982
|
"type": {
|
36979
|
-
"text": "
|
36983
|
+
"text": "ToggleSize"
|
36980
36984
|
},
|
36981
|
-
"description": "
|
36982
|
-
"
|
36985
|
+
"description": "Determines toggle size in rem (height is specified here).\n- **Default**: 1.5\n- **Compact**: 1",
|
36986
|
+
"default": "default",
|
36987
|
+
"attribute": "size",
|
36988
|
+
"reflects": true
|
36983
36989
|
},
|
36984
36990
|
{
|
36985
36991
|
"kind": "field",
|
36986
|
-
"name": "
|
36992
|
+
"name": "autofocus",
|
36987
36993
|
"type": {
|
36988
|
-
"text": "
|
36994
|
+
"text": "boolean"
|
36989
36995
|
},
|
36990
|
-
"
|
36991
|
-
"
|
36996
|
+
"default": "false",
|
36997
|
+
"description": "Automatically focus on the element when the page loads.\n[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/autofocus)",
|
36998
|
+
"attribute": "autofocus",
|
36992
36999
|
"reflects": true
|
36993
37000
|
},
|
36994
37001
|
{
|
36995
|
-
"kind": "
|
36996
|
-
"name": "
|
36997
|
-
"
|
36998
|
-
|
36999
|
-
},
|
37000
|
-
"description": "The html tag to be used for the header text",
|
37001
|
-
"default": "'h2'",
|
37002
|
-
"attribute": "header-tag-name",
|
37003
|
-
"reflects": true
|
37002
|
+
"kind": "method",
|
37003
|
+
"name": "manageRequired",
|
37004
|
+
"privacy": "private",
|
37005
|
+
"description": "Manages the required state of the checkbox.\nIf the checkbox is not checked and the required property is set, then the checkbox is invalid.\nIf the validationMessage is set, it will be used as the custom validity message.\nIf the validationMessage is not set, it will clear the custom validity message."
|
37004
37006
|
},
|
37005
37007
|
{
|
37006
|
-
"kind": "
|
37007
|
-
"name": "
|
37008
|
-
"
|
37009
|
-
|
37010
|
-
},
|
37011
|
-
"default": "null",
|
37012
|
-
"description": "Defines aria-label attribute when header is not used",
|
37013
|
-
"attribute": "aria-label",
|
37014
|
-
"reflects": true
|
37008
|
+
"kind": "method",
|
37009
|
+
"name": "setFormValue",
|
37010
|
+
"privacy": "private",
|
37011
|
+
"description": "Updates the form value to reflect the current state of the toggle.\nIf toggle is switched on, the value is set to either the user-provided value or 'isActive' if no value is provided.\nIf toggle is switched off, the value is set to null."
|
37015
37012
|
},
|
37016
37013
|
{
|
37017
|
-
"kind": "
|
37018
|
-
"name": "
|
37019
|
-
"
|
37020
|
-
|
37014
|
+
"kind": "method",
|
37015
|
+
"name": "toggleState",
|
37016
|
+
"privacy": "private",
|
37017
|
+
"return": {
|
37018
|
+
"type": {
|
37019
|
+
"text": "void"
|
37020
|
+
}
|
37021
37021
|
},
|
37022
|
-
"description": "
|
37023
|
-
"attribute": "show-more-text",
|
37024
|
-
"reflects": true
|
37022
|
+
"description": "Toggles the state of the toggle element.\nIf the element is not disabled, then the checked property is toggled."
|
37025
37023
|
},
|
37026
37024
|
{
|
37027
|
-
"kind": "
|
37028
|
-
"name": "
|
37029
|
-
"
|
37030
|
-
|
37025
|
+
"kind": "method",
|
37026
|
+
"name": "handleKeyDown",
|
37027
|
+
"privacy": "private",
|
37028
|
+
"return": {
|
37029
|
+
"type": {
|
37030
|
+
"text": "void"
|
37031
|
+
}
|
37031
37032
|
},
|
37032
|
-
"
|
37033
|
-
|
37034
|
-
|
37033
|
+
"parameters": [
|
37034
|
+
{
|
37035
|
+
"name": "event",
|
37036
|
+
"type": {
|
37037
|
+
"text": "KeyboardEvent"
|
37038
|
+
},
|
37039
|
+
"description": "The keyboard event."
|
37040
|
+
}
|
37041
|
+
],
|
37042
|
+
"description": "Handles the keydown event on the toggle element.\nWhen the user presses Enter, the form is submitted."
|
37035
37043
|
},
|
37036
37044
|
{
|
37037
|
-
"kind": "
|
37038
|
-
"name": "
|
37039
|
-
"type": {
|
37040
|
-
"text": "boolean"
|
37041
|
-
},
|
37045
|
+
"kind": "method",
|
37046
|
+
"name": "handleChange",
|
37042
37047
|
"privacy": "private",
|
37043
|
-
"
|
37048
|
+
"parameters": [
|
37049
|
+
{
|
37050
|
+
"name": "event",
|
37051
|
+
"type": {
|
37052
|
+
"text": "Event"
|
37053
|
+
}
|
37054
|
+
}
|
37055
|
+
],
|
37056
|
+
"description": "Toggles the state of the toggle element.\nand dispatch the new change event."
|
37044
37057
|
},
|
37045
37058
|
{
|
37046
|
-
"kind": "
|
37047
|
-
"name": "
|
37048
|
-
"
|
37049
|
-
|
37050
|
-
|
37051
|
-
|
37052
|
-
|
37059
|
+
"kind": "method",
|
37060
|
+
"name": "setToggleSize",
|
37061
|
+
"privacy": "private",
|
37062
|
+
"parameters": [
|
37063
|
+
{
|
37064
|
+
"name": "size",
|
37065
|
+
"type": {
|
37066
|
+
"text": "ToggleSize"
|
37067
|
+
},
|
37068
|
+
"description": "The size to set."
|
37069
|
+
}
|
37070
|
+
],
|
37071
|
+
"description": "Sets the size attribute for the toggle component.\nIf the provided size is not included in the TOGGLE_SIZE,\nit defaults to the value specified in DEFAULTS.SIZE."
|
37053
37072
|
},
|
37054
37073
|
{
|
37055
37074
|
"kind": "field",
|
37056
|
-
"name": "
|
37075
|
+
"name": "name",
|
37057
37076
|
"type": {
|
37058
|
-
"text": "
|
37077
|
+
"text": "string"
|
37059
37078
|
},
|
37060
|
-
"
|
37079
|
+
"default": "''",
|
37080
|
+
"description": "Indicates the name of the component group.\nThey are used to group elements in a form together.",
|
37081
|
+
"attribute": "name",
|
37082
|
+
"reflects": true,
|
37083
|
+
"inheritedFrom": {
|
37084
|
+
"name": "FormInternalsMixin",
|
37085
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
37086
|
+
}
|
37061
37087
|
},
|
37062
37088
|
{
|
37063
37089
|
"kind": "field",
|
37064
|
-
"name": "
|
37090
|
+
"name": "value",
|
37065
37091
|
"type": {
|
37066
37092
|
"text": "string"
|
37067
37093
|
},
|
37068
|
-
"
|
37069
|
-
"
|
37094
|
+
"default": "''",
|
37095
|
+
"description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
|
37096
|
+
"attribute": "value",
|
37097
|
+
"reflects": true,
|
37098
|
+
"inheritedFrom": {
|
37099
|
+
"name": "FormInternalsMixin",
|
37100
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
37101
|
+
}
|
37070
37102
|
},
|
37071
37103
|
{
|
37072
|
-
"kind": "
|
37073
|
-
"name": "
|
37074
|
-
"
|
37075
|
-
|
37104
|
+
"kind": "field",
|
37105
|
+
"name": "validationMessage",
|
37106
|
+
"type": {
|
37107
|
+
"text": "string | undefined"
|
37108
|
+
},
|
37109
|
+
"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.",
|
37110
|
+
"attribute": "validation-message",
|
37111
|
+
"reflects": true,
|
37112
|
+
"inheritedFrom": {
|
37113
|
+
"name": "FormInternalsMixin",
|
37114
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
37115
|
+
}
|
37076
37116
|
},
|
37077
37117
|
{
|
37078
|
-
"kind": "
|
37079
|
-
"name": "
|
37080
|
-
"
|
37118
|
+
"kind": "field",
|
37119
|
+
"name": "validity",
|
37120
|
+
"type": {
|
37121
|
+
"text": "ValidityState"
|
37122
|
+
},
|
37123
|
+
"readonly": true,
|
37124
|
+
"inheritedFrom": {
|
37125
|
+
"name": "FormInternalsMixin",
|
37126
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
37127
|
+
}
|
37081
37128
|
},
|
37082
37129
|
{
|
37083
|
-
"kind": "
|
37084
|
-
"name": "
|
37085
|
-
"
|
37130
|
+
"kind": "field",
|
37131
|
+
"name": "willValidate",
|
37132
|
+
"readonly": true,
|
37133
|
+
"inheritedFrom": {
|
37134
|
+
"name": "FormInternalsMixin",
|
37135
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
37136
|
+
}
|
37086
37137
|
},
|
37087
37138
|
{
|
37088
37139
|
"kind": "method",
|
37089
|
-
"name": "
|
37090
|
-
"
|
37140
|
+
"name": "setValidity",
|
37141
|
+
"description": "Sets the validity of the input field based on the input field's validity.",
|
37142
|
+
"return": {
|
37143
|
+
"type": {
|
37144
|
+
"text": ""
|
37145
|
+
}
|
37146
|
+
},
|
37147
|
+
"inheritedFrom": {
|
37148
|
+
"name": "FormInternalsMixin",
|
37149
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
37150
|
+
}
|
37091
37151
|
},
|
37092
37152
|
{
|
37093
37153
|
"kind": "method",
|
37094
|
-
"name": "
|
37095
|
-
"
|
37096
|
-
|
37097
|
-
|
37098
|
-
"name": "iconName",
|
37099
|
-
"type": {
|
37100
|
-
"text": "string"
|
37101
|
-
}
|
37154
|
+
"name": "checkValidity",
|
37155
|
+
"return": {
|
37156
|
+
"type": {
|
37157
|
+
"text": "boolean"
|
37102
37158
|
}
|
37103
|
-
|
37159
|
+
},
|
37160
|
+
"inheritedFrom": {
|
37161
|
+
"name": "FormInternalsMixin",
|
37162
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
37163
|
+
}
|
37104
37164
|
},
|
37105
37165
|
{
|
37106
37166
|
"kind": "method",
|
37107
|
-
"name": "
|
37108
|
-
"
|
37167
|
+
"name": "reportValidity",
|
37168
|
+
"inheritedFrom": {
|
37169
|
+
"name": "FormInternalsMixin",
|
37170
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
37171
|
+
}
|
37172
|
+
},
|
37173
|
+
{
|
37174
|
+
"kind": "field",
|
37175
|
+
"name": "dataAriaLabel",
|
37176
|
+
"type": {
|
37177
|
+
"text": "string | null"
|
37178
|
+
},
|
37179
|
+
"default": "null",
|
37180
|
+
"description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
|
37181
|
+
"attribute": "data-aria-label",
|
37182
|
+
"reflects": true,
|
37183
|
+
"inheritedFrom": {
|
37184
|
+
"name": "DataAriaLabelMixin",
|
37185
|
+
"module": "utils/mixins/DataAriaLabelMixin.js"
|
37186
|
+
}
|
37187
|
+
},
|
37188
|
+
{
|
37189
|
+
"kind": "field",
|
37190
|
+
"name": "disabled",
|
37191
|
+
"type": {
|
37192
|
+
"text": "boolean | undefined"
|
37193
|
+
},
|
37194
|
+
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
37195
|
+
"default": "undefined",
|
37196
|
+
"attribute": "disabled",
|
37197
|
+
"reflects": true,
|
37198
|
+
"inheritedFrom": {
|
37199
|
+
"name": "FormfieldWrapper",
|
37200
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
37201
|
+
}
|
37202
|
+
},
|
37203
|
+
{
|
37204
|
+
"kind": "field",
|
37205
|
+
"name": "label",
|
37206
|
+
"type": {
|
37207
|
+
"text": "string | undefined"
|
37208
|
+
},
|
37209
|
+
"description": "The label of the input field. It is linked to the input field using the `for` attribute.",
|
37210
|
+
"attribute": "label",
|
37211
|
+
"reflects": true,
|
37212
|
+
"inheritedFrom": {
|
37213
|
+
"name": "FormfieldWrapper",
|
37214
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
37215
|
+
}
|
37216
|
+
},
|
37217
|
+
{
|
37218
|
+
"kind": "field",
|
37219
|
+
"name": "required",
|
37220
|
+
"type": {
|
37221
|
+
"text": "boolean"
|
37222
|
+
},
|
37223
|
+
"default": "false",
|
37224
|
+
"description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
|
37225
|
+
"attribute": "required",
|
37226
|
+
"reflects": true,
|
37227
|
+
"inheritedFrom": {
|
37228
|
+
"name": "FormfieldWrapper",
|
37229
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
37230
|
+
}
|
37231
|
+
},
|
37232
|
+
{
|
37233
|
+
"kind": "field",
|
37234
|
+
"name": "helpTextType",
|
37235
|
+
"type": {
|
37236
|
+
"text": "ValidationType"
|
37237
|
+
},
|
37238
|
+
"description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
|
37239
|
+
"attribute": "help-text-type",
|
37240
|
+
"reflects": true,
|
37241
|
+
"inheritedFrom": {
|
37242
|
+
"name": "FormfieldWrapper",
|
37243
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
37244
|
+
}
|
37245
|
+
},
|
37246
|
+
{
|
37247
|
+
"kind": "field",
|
37248
|
+
"name": "helpText",
|
37249
|
+
"type": {
|
37250
|
+
"text": "string | undefined"
|
37251
|
+
},
|
37252
|
+
"description": "The help text that is displayed below the input field.",
|
37253
|
+
"attribute": "help-text",
|
37254
|
+
"reflects": true,
|
37255
|
+
"inheritedFrom": {
|
37256
|
+
"name": "FormfieldWrapper",
|
37257
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
37258
|
+
}
|
37259
|
+
},
|
37260
|
+
{
|
37261
|
+
"kind": "field",
|
37262
|
+
"name": "toggletipText",
|
37263
|
+
"type": {
|
37264
|
+
"text": "string | undefined"
|
37265
|
+
},
|
37266
|
+
"description": "The toggletip text that is displayed when the label is hovered.\nIt is used to provide additional information about the label.",
|
37267
|
+
"attribute": "toggletip-text",
|
37268
|
+
"reflects": true,
|
37269
|
+
"inheritedFrom": {
|
37270
|
+
"name": "FormfieldWrapper",
|
37271
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
37272
|
+
}
|
37273
|
+
},
|
37274
|
+
{
|
37275
|
+
"kind": "field",
|
37276
|
+
"name": "toggletipPlacement",
|
37277
|
+
"type": {
|
37278
|
+
"text": "PopoverPlacement"
|
37279
|
+
},
|
37280
|
+
"description": "The placement of the toggletip that is displayed when the info icon is hovered.",
|
37281
|
+
"default": "'top'",
|
37282
|
+
"attribute": "toggletip-placement",
|
37283
|
+
"reflects": true,
|
37284
|
+
"inheritedFrom": {
|
37285
|
+
"name": "FormfieldWrapper",
|
37286
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
37287
|
+
}
|
37288
|
+
},
|
37289
|
+
{
|
37290
|
+
"kind": "field",
|
37291
|
+
"name": "infoIconAriaLabel",
|
37292
|
+
"type": {
|
37293
|
+
"text": "string | undefined"
|
37294
|
+
},
|
37295
|
+
"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.",
|
37296
|
+
"attribute": "info-icon-aria-label",
|
37297
|
+
"reflects": true,
|
37298
|
+
"inheritedFrom": {
|
37299
|
+
"name": "FormfieldWrapper",
|
37300
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
37301
|
+
}
|
37109
37302
|
},
|
37110
37303
|
{
|
37111
37304
|
"kind": "method",
|
37112
|
-
"name": "
|
37113
|
-
"privacy": "
|
37305
|
+
"name": "renderLabelElement",
|
37306
|
+
"privacy": "protected",
|
37307
|
+
"description": "creates the label element when the label property is set.\nid is used to link the label with the input field.",
|
37308
|
+
"return": {
|
37309
|
+
"type": {
|
37310
|
+
"text": ""
|
37311
|
+
}
|
37312
|
+
},
|
37313
|
+
"inheritedFrom": {
|
37314
|
+
"name": "FormfieldWrapper",
|
37315
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
37316
|
+
}
|
37114
37317
|
},
|
37115
37318
|
{
|
37116
37319
|
"kind": "method",
|
37117
|
-
"name": "
|
37118
|
-
"privacy": "protected"
|
37320
|
+
"name": "renderHelpTextIcon",
|
37321
|
+
"privacy": "protected",
|
37322
|
+
"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.",
|
37323
|
+
"return": {
|
37324
|
+
"type": {
|
37325
|
+
"text": ""
|
37326
|
+
}
|
37327
|
+
},
|
37328
|
+
"inheritedFrom": {
|
37329
|
+
"name": "FormfieldWrapper",
|
37330
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
37331
|
+
}
|
37119
37332
|
},
|
37120
37333
|
{
|
37121
37334
|
"kind": "method",
|
37122
|
-
"name": "
|
37335
|
+
"name": "renderHelpText",
|
37123
37336
|
"privacy": "protected",
|
37337
|
+
"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.",
|
37124
37338
|
"return": {
|
37125
37339
|
"type": {
|
37126
|
-
"text": "
|
37340
|
+
"text": ""
|
37127
37341
|
}
|
37128
37342
|
},
|
37129
|
-
"
|
37130
|
-
|
37131
|
-
|
37132
|
-
|
37133
|
-
|
37134
|
-
|
37135
|
-
|
37136
|
-
|
37137
|
-
|
37138
|
-
|
37139
|
-
|
37140
|
-
|
37141
|
-
|
37343
|
+
"inheritedFrom": {
|
37344
|
+
"name": "FormfieldWrapper",
|
37345
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
37346
|
+
}
|
37347
|
+
},
|
37348
|
+
{
|
37349
|
+
"kind": "method",
|
37350
|
+
"name": "renderLabel",
|
37351
|
+
"privacy": "protected",
|
37352
|
+
"description": "renders the mdc-label-text container that contains the label and labelInfoToggleTip.",
|
37353
|
+
"return": {
|
37354
|
+
"type": {
|
37355
|
+
"text": ""
|
37142
37356
|
}
|
37143
|
-
|
37357
|
+
},
|
37358
|
+
"inheritedFrom": {
|
37359
|
+
"name": "FormfieldWrapper",
|
37360
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
37361
|
+
}
|
37144
37362
|
},
|
37145
37363
|
{
|
37146
37364
|
"kind": "method",
|
37147
|
-
"name": "
|
37365
|
+
"name": "renderHelperText",
|
37148
37366
|
"privacy": "protected",
|
37149
|
-
"description": "
|
37367
|
+
"description": "renders the mdc-help-text container that contains the helpertext icon and helpertext.",
|
37150
37368
|
"return": {
|
37151
37369
|
"type": {
|
37152
37370
|
"text": ""
|
37153
37371
|
}
|
37154
37372
|
},
|
37155
37373
|
"inheritedFrom": {
|
37156
|
-
"name": "
|
37157
|
-
"module": "
|
37374
|
+
"name": "FormfieldWrapper",
|
37375
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
37158
37376
|
}
|
37159
37377
|
}
|
37160
37378
|
],
|
37161
37379
|
"events": [
|
37162
37380
|
{
|
37163
|
-
"
|
37164
|
-
|
37165
|
-
|
37381
|
+
"type": {
|
37382
|
+
"text": "EventConstructor"
|
37383
|
+
}
|
37384
|
+
},
|
37385
|
+
{
|
37386
|
+
"description": "(React: onChange) Event that gets dispatched when the toggle state changes.",
|
37387
|
+
"name": "change",
|
37388
|
+
"reactName": "onChange"
|
37389
|
+
},
|
37390
|
+
{
|
37391
|
+
"description": "(React: onFocus) Event that gets dispatched when the toggle receives focus.",
|
37392
|
+
"name": "focus",
|
37393
|
+
"reactName": "onFocus"
|
37166
37394
|
}
|
37167
37395
|
],
|
37168
37396
|
"attributes": [
|
37169
37397
|
{
|
37170
|
-
"name": "
|
37398
|
+
"name": "checked",
|
37171
37399
|
"type": {
|
37172
|
-
"text": "
|
37400
|
+
"text": "boolean"
|
37173
37401
|
},
|
37174
|
-
"
|
37175
|
-
"
|
37176
|
-
"fieldName": "
|
37402
|
+
"default": "false",
|
37403
|
+
"description": "Determines whether the toggle is active or inactive.",
|
37404
|
+
"fieldName": "checked"
|
37177
37405
|
},
|
37178
37406
|
{
|
37179
|
-
"name": "
|
37407
|
+
"name": "size",
|
37408
|
+
"type": {
|
37409
|
+
"text": "ToggleSize"
|
37410
|
+
},
|
37411
|
+
"description": "Determines toggle size in rem (height is specified here).\n- **Default**: 1.5\n- **Compact**: 1",
|
37412
|
+
"default": "default",
|
37413
|
+
"fieldName": "size"
|
37414
|
+
},
|
37415
|
+
{
|
37416
|
+
"name": "autofocus",
|
37417
|
+
"type": {
|
37418
|
+
"text": "boolean"
|
37419
|
+
},
|
37420
|
+
"default": "false",
|
37421
|
+
"description": "Automatically focus on the element when the page loads.\n[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/autofocus)",
|
37422
|
+
"fieldName": "autofocus"
|
37423
|
+
},
|
37424
|
+
{
|
37425
|
+
"name": "name",
|
37426
|
+
"type": {
|
37427
|
+
"text": "string"
|
37428
|
+
},
|
37429
|
+
"default": "''",
|
37430
|
+
"description": "Indicates the name of the component group.\nThey are used to group elements in a form together.",
|
37431
|
+
"fieldName": "name",
|
37432
|
+
"inheritedFrom": {
|
37433
|
+
"name": "FormInternalsMixin",
|
37434
|
+
"module": "src/utils/mixins/FormInternalsMixin.ts"
|
37435
|
+
}
|
37436
|
+
},
|
37437
|
+
{
|
37438
|
+
"name": "value",
|
37439
|
+
"type": {
|
37440
|
+
"text": "string"
|
37441
|
+
},
|
37442
|
+
"default": "''",
|
37443
|
+
"description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
|
37444
|
+
"fieldName": "value",
|
37445
|
+
"inheritedFrom": {
|
37446
|
+
"name": "FormInternalsMixin",
|
37447
|
+
"module": "src/utils/mixins/FormInternalsMixin.ts"
|
37448
|
+
}
|
37449
|
+
},
|
37450
|
+
{
|
37451
|
+
"name": "validation-message",
|
37180
37452
|
"type": {
|
37181
37453
|
"text": "string | undefined"
|
37182
37454
|
},
|
37183
|
-
"description": "
|
37184
|
-
"fieldName": "
|
37455
|
+
"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.",
|
37456
|
+
"fieldName": "validationMessage",
|
37457
|
+
"inheritedFrom": {
|
37458
|
+
"name": "FormInternalsMixin",
|
37459
|
+
"module": "src/utils/mixins/FormInternalsMixin.ts"
|
37460
|
+
}
|
37185
37461
|
},
|
37186
37462
|
{
|
37187
|
-
"name": "
|
37463
|
+
"name": "data-aria-label",
|
37464
|
+
"type": {
|
37465
|
+
"text": "string | null"
|
37466
|
+
},
|
37467
|
+
"default": "null",
|
37468
|
+
"description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
|
37469
|
+
"fieldName": "dataAriaLabel",
|
37470
|
+
"inheritedFrom": {
|
37471
|
+
"name": "DataAriaLabelMixin",
|
37472
|
+
"module": "src/utils/mixins/DataAriaLabelMixin.ts"
|
37473
|
+
}
|
37474
|
+
},
|
37475
|
+
{
|
37476
|
+
"name": "disabled",
|
37477
|
+
"type": {
|
37478
|
+
"text": "boolean | undefined"
|
37479
|
+
},
|
37480
|
+
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
37481
|
+
"default": "undefined",
|
37482
|
+
"fieldName": "disabled",
|
37483
|
+
"inheritedFrom": {
|
37484
|
+
"name": "FormfieldWrapper",
|
37485
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
37486
|
+
}
|
37487
|
+
},
|
37488
|
+
{
|
37489
|
+
"name": "label",
|
37188
37490
|
"type": {
|
37189
37491
|
"text": "string | undefined"
|
37190
37492
|
},
|
37191
|
-
"description": "
|
37192
|
-
"fieldName": "
|
37493
|
+
"description": "The label of the input field. It is linked to the input field using the `for` attribute.",
|
37494
|
+
"fieldName": "label",
|
37495
|
+
"inheritedFrom": {
|
37496
|
+
"name": "FormfieldWrapper",
|
37497
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
37498
|
+
}
|
37499
|
+
},
|
37500
|
+
{
|
37501
|
+
"name": "required",
|
37502
|
+
"type": {
|
37503
|
+
"text": "boolean"
|
37504
|
+
},
|
37505
|
+
"default": "false",
|
37506
|
+
"description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
|
37507
|
+
"fieldName": "required",
|
37508
|
+
"inheritedFrom": {
|
37509
|
+
"name": "FormfieldWrapper",
|
37510
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
37511
|
+
}
|
37512
|
+
},
|
37513
|
+
{
|
37514
|
+
"name": "help-text-type",
|
37515
|
+
"type": {
|
37516
|
+
"text": "ValidationType"
|
37517
|
+
},
|
37518
|
+
"description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
|
37519
|
+
"fieldName": "helpTextType",
|
37520
|
+
"inheritedFrom": {
|
37521
|
+
"name": "FormfieldWrapper",
|
37522
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
37523
|
+
}
|
37193
37524
|
},
|
37194
37525
|
{
|
37195
|
-
"name": "
|
37526
|
+
"name": "help-text",
|
37196
37527
|
"type": {
|
37197
|
-
"text": "
|
37528
|
+
"text": "string | undefined"
|
37198
37529
|
},
|
37199
|
-
"description": "The
|
37200
|
-
"
|
37201
|
-
"
|
37530
|
+
"description": "The help text that is displayed below the input field.",
|
37531
|
+
"fieldName": "helpText",
|
37532
|
+
"inheritedFrom": {
|
37533
|
+
"name": "FormfieldWrapper",
|
37534
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
37535
|
+
}
|
37202
37536
|
},
|
37203
37537
|
{
|
37204
|
-
"name": "
|
37538
|
+
"name": "toggletip-text",
|
37205
37539
|
"type": {
|
37206
|
-
"text": "string |
|
37540
|
+
"text": "string | undefined"
|
37207
37541
|
},
|
37208
|
-
"
|
37209
|
-
"
|
37210
|
-
"
|
37542
|
+
"description": "The toggletip text that is displayed when the label is hovered.\nIt is used to provide additional information about the label.",
|
37543
|
+
"fieldName": "toggletipText",
|
37544
|
+
"inheritedFrom": {
|
37545
|
+
"name": "FormfieldWrapper",
|
37546
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
37547
|
+
}
|
37211
37548
|
},
|
37212
37549
|
{
|
37213
|
-
"name": "
|
37550
|
+
"name": "toggletip-placement",
|
37214
37551
|
"type": {
|
37215
|
-
"text": "
|
37552
|
+
"text": "PopoverPlacement"
|
37216
37553
|
},
|
37217
|
-
"description": "
|
37218
|
-
"
|
37554
|
+
"description": "The placement of the toggletip that is displayed when the info icon is hovered.",
|
37555
|
+
"default": "'top'",
|
37556
|
+
"fieldName": "toggletipPlacement",
|
37557
|
+
"inheritedFrom": {
|
37558
|
+
"name": "FormfieldWrapper",
|
37559
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
37560
|
+
}
|
37219
37561
|
},
|
37220
37562
|
{
|
37221
|
-
"name": "
|
37563
|
+
"name": "info-icon-aria-label",
|
37222
37564
|
"type": {
|
37223
37565
|
"text": "string | undefined"
|
37224
37566
|
},
|
37225
|
-
"description": "
|
37226
|
-
"fieldName": "
|
37567
|
+
"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.",
|
37568
|
+
"fieldName": "infoIconAriaLabel",
|
37569
|
+
"inheritedFrom": {
|
37570
|
+
"name": "FormfieldWrapper",
|
37571
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
37572
|
+
}
|
37227
37573
|
}
|
37228
37574
|
],
|
37229
37575
|
"mixins": [
|
37230
37576
|
{
|
37231
|
-
"name": "
|
37232
|
-
"module": "/src/utils/mixins/
|
37577
|
+
"name": "FormInternalsMixin",
|
37578
|
+
"module": "/src/utils/mixins/FormInternalsMixin"
|
37579
|
+
},
|
37580
|
+
{
|
37581
|
+
"name": "DataAriaLabelMixin",
|
37582
|
+
"module": "/src/utils/mixins/DataAriaLabelMixin"
|
37233
37583
|
}
|
37234
37584
|
],
|
37235
37585
|
"superclass": {
|
37236
|
-
"name": "
|
37237
|
-
"module": "/src/
|
37586
|
+
"name": "FormfieldWrapper",
|
37587
|
+
"module": "/src/components/formfieldwrapper"
|
37238
37588
|
},
|
37239
|
-
"tagName": "mdc-
|
37240
|
-
"jsDoc": "/**\n *
|
37589
|
+
"tagName": "mdc-toggle",
|
37590
|
+
"jsDoc": "/**\n * Toggle Component is an interactive control used to switch between two mutually exclusive options,\n * such as On/Off, Active/Inactive. These are commonly used in settings panels, forms, and preference selections\n * where users need to enable or disable a feature.\n * It contains an optional label and an optional helper text.\n *\n * To create a group of toggles, use the FormFieldGroup component.\n *\n * Note: It internally renders a checkbox styled as a toggle switch.\n *\n * @dependency mdc-button\n * @dependency mdc-icon\n * @dependency mdc-statictoggle\n * @dependency mdc-text\n * @dependency mdc-toggletip\n *\n * @tagname mdc-toggle\n *\n * @event change - (React: onChange) Event that gets dispatched when the toggle state changes.\n * @event focus - (React: onFocus) Event that gets dispatched when the toggle receives focus.\n *\n * @cssproperty --mdc-toggle-width - Width of the toggle\n * @cssproperty --mdc-toggle-height - Height of the toggle\n * @cssproperty --mdc-toggle-width-compact - Width of the toggle when it's size is compact\n * @cssproperty --mdc-toggle-height-compact - Height of the toggle when it's size is compact\n * @cssproperty --mdc-toggle-label-lineheight - Line height of the toggle label\n * @cssproperty --mdc-toggle-label-fontsize - Font size of the toggle label\n * @cssproperty --mdc-toggle-label-fontweight - Font weight of the toggle label\n * @cssproperty --mdc-toggle-label-color-disabled - Color of the toggle label and help text in disabled state\n * @cssproperty --mdc-toggle-help-text-color - Color of the help text label\n * @cssproperty --mdc-toggle-active-hover-color - Background color of the active toggle in hover state\n * @cssproperty --mdc-toggle-active-pressed-color - Background color of the active toggle in pressed state\n * @cssproperty --mdc-toggle-inactive-hover-color - Background color of the inactive toggle in hover state\n * @cssproperty --mdc-toggle-inactive-pressed-color - Background color of the inactive toggle in pressed state\n */",
|
37241
37591
|
"customElement": true
|
37242
37592
|
}
|
37243
37593
|
],
|
@@ -37246,698 +37596,384 @@
|
|
37246
37596
|
"kind": "js",
|
37247
37597
|
"name": "default",
|
37248
37598
|
"declaration": {
|
37249
|
-
"name": "
|
37250
|
-
"module": "components/
|
37599
|
+
"name": "Toggle",
|
37600
|
+
"module": "components/toggle/toggle.component.js"
|
37251
37601
|
}
|
37252
37602
|
}
|
37253
37603
|
]
|
37254
37604
|
},
|
37255
37605
|
{
|
37256
37606
|
"kind": "javascript-module",
|
37257
|
-
"path": "components/
|
37607
|
+
"path": "components/toast/toast.component.js",
|
37258
37608
|
"declarations": [
|
37259
37609
|
{
|
37260
37610
|
"kind": "class",
|
37261
|
-
"description": "
|
37262
|
-
"name": "
|
37611
|
+
"description": "`mdc-toast` is a lightweight, non-blocking alert used to inform users about application processes.\nIt supports success, warning, error, and custom messages, and is designed to be controlled externally.\n\n**Note**: When using `slot=\"toast-body-normal\"` and `slot=\"toast-body-detailed\"`, it's strongly recommended to wrap the content with `<mdc-text tagname=\"span\">`.\nIf not used, ensure your custom content is styled appropriately to match the design and alignment expectations of the toast component.",
|
37612
|
+
"name": "Toast",
|
37263
37613
|
"cssProperties": [
|
37264
37614
|
{
|
37265
|
-
"description": "
|
37266
|
-
"name": "--mdc-
|
37615
|
+
"description": "Background color of the toast.",
|
37616
|
+
"name": "--mdc-toast-background-color"
|
37267
37617
|
},
|
37268
37618
|
{
|
37269
|
-
"description": "
|
37270
|
-
"name": "--mdc-
|
37619
|
+
"description": "Border color of the toast.",
|
37620
|
+
"name": "--mdc-toast-border-color"
|
37271
37621
|
},
|
37272
37622
|
{
|
37273
|
-
"description": "
|
37274
|
-
"name": "--mdc-
|
37623
|
+
"description": "Color of the header text in the toast.",
|
37624
|
+
"name": "--mdc-toast-header-text-color"
|
37275
37625
|
},
|
37276
37626
|
{
|
37277
|
-
"description": "
|
37278
|
-
"name": "--mdc-
|
37627
|
+
"description": "Color of the icon in the toast.",
|
37628
|
+
"name": "--mdc-toast-icon-color"
|
37279
37629
|
},
|
37280
37630
|
{
|
37281
|
-
"description": "
|
37282
|
-
"name": "--mdc-
|
37631
|
+
"description": "Elevation effect applied to the toast.",
|
37632
|
+
"name": "--mdc-toast-elevation-3"
|
37283
37633
|
},
|
37284
37634
|
{
|
37285
|
-
"description": "
|
37286
|
-
"name": "--mdc-
|
37635
|
+
"description": "Width of the toast.",
|
37636
|
+
"name": "--mdc-toast-width"
|
37287
37637
|
},
|
37288
37638
|
{
|
37289
|
-
"description": "
|
37290
|
-
"name": "--mdc-
|
37639
|
+
"description": "Padding inside the toast.",
|
37640
|
+
"name": "--mdc-toast-padding"
|
37641
|
+
}
|
37642
|
+
],
|
37643
|
+
"cssParts": [
|
37644
|
+
{
|
37645
|
+
"description": "The container for the toast's main content, including icon, text, and close button.",
|
37646
|
+
"name": "content-container"
|
37291
37647
|
},
|
37292
37648
|
{
|
37293
|
-
"description": "
|
37294
|
-
"name": "
|
37649
|
+
"description": "The icon shown at the start of the toast, styled by variant.",
|
37650
|
+
"name": "toast-prefix-icon"
|
37295
37651
|
},
|
37296
37652
|
{
|
37297
|
-
"description": "
|
37298
|
-
"name": "
|
37653
|
+
"description": "The container for the header and body content of the toast.",
|
37654
|
+
"name": "toast-content"
|
37299
37655
|
},
|
37300
37656
|
{
|
37301
|
-
"description": "
|
37302
|
-
"name": "
|
37657
|
+
"description": "The header text of the toast.",
|
37658
|
+
"name": "toast-header"
|
37303
37659
|
},
|
37304
37660
|
{
|
37305
|
-
"description": "
|
37306
|
-
"name": "
|
37661
|
+
"description": "The container for the toast's footer, including toggle and action buttons.",
|
37662
|
+
"name": "footer"
|
37307
37663
|
},
|
37308
37664
|
{
|
37309
|
-
"description": "
|
37310
|
-
"name": "
|
37665
|
+
"description": "The toggle button for showing/hiding detailed content.",
|
37666
|
+
"name": "footer-button-toggle"
|
37311
37667
|
},
|
37312
37668
|
{
|
37313
|
-
"description": "
|
37314
|
-
"name": "
|
37669
|
+
"description": "The close button for the toast.",
|
37670
|
+
"name": "toast-close-btn"
|
37315
37671
|
}
|
37316
37672
|
],
|
37317
|
-
"
|
37318
|
-
{
|
37319
|
-
"kind": "field",
|
37320
|
-
"name": "checked",
|
37321
|
-
"type": {
|
37322
|
-
"text": "boolean"
|
37323
|
-
},
|
37324
|
-
"default": "false",
|
37325
|
-
"description": "Determines whether the toggle is active or inactive.",
|
37326
|
-
"attribute": "checked",
|
37327
|
-
"reflects": true
|
37328
|
-
},
|
37329
|
-
{
|
37330
|
-
"kind": "field",
|
37331
|
-
"name": "size",
|
37332
|
-
"type": {
|
37333
|
-
"text": "ToggleSize"
|
37334
|
-
},
|
37335
|
-
"description": "Determines toggle size in rem (height is specified here).\n- **Default**: 1.5\n- **Compact**: 1",
|
37336
|
-
"default": "default",
|
37337
|
-
"attribute": "size",
|
37338
|
-
"reflects": true
|
37339
|
-
},
|
37340
|
-
{
|
37341
|
-
"kind": "field",
|
37342
|
-
"name": "autofocus",
|
37343
|
-
"type": {
|
37344
|
-
"text": "boolean"
|
37345
|
-
},
|
37346
|
-
"default": "false",
|
37347
|
-
"description": "Automatically focus on the element when the page loads.\n[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/autofocus)",
|
37348
|
-
"attribute": "autofocus",
|
37349
|
-
"reflects": true
|
37350
|
-
},
|
37351
|
-
{
|
37352
|
-
"kind": "method",
|
37353
|
-
"name": "manageRequired",
|
37354
|
-
"privacy": "private",
|
37355
|
-
"description": "Manages the required state of the checkbox.\nIf the checkbox is not checked and the required property is set, then the checkbox is invalid.\nIf the validationMessage is set, it will be used as the custom validity message.\nIf the validationMessage is not set, it will clear the custom validity message."
|
37356
|
-
},
|
37673
|
+
"slots": [
|
37357
37674
|
{
|
37358
|
-
"
|
37359
|
-
"name": "
|
37360
|
-
"privacy": "private",
|
37361
|
-
"description": "Updates the form value to reflect the current state of the toggle.\nIf toggle is switched on, the value is set to either the user-provided value or 'isActive' if no value is provided.\nIf toggle is switched off, the value is set to null."
|
37675
|
+
"description": "Slot for custom content before the icon (only for custom variant).",
|
37676
|
+
"name": "content-prefix"
|
37362
37677
|
},
|
37363
37678
|
{
|
37364
|
-
"
|
37365
|
-
"name": "
|
37366
|
-
"privacy": "private",
|
37367
|
-
"return": {
|
37368
|
-
"type": {
|
37369
|
-
"text": "void"
|
37370
|
-
}
|
37371
|
-
},
|
37372
|
-
"description": "Toggles the state of the toggle element.\nIf the element is not disabled, then the checked property is toggled."
|
37679
|
+
"description": "Slot for the main body content of the toast.",
|
37680
|
+
"name": "toast-body-normal"
|
37373
37681
|
},
|
37374
37682
|
{
|
37375
|
-
"
|
37376
|
-
"name": "
|
37377
|
-
"privacy": "private",
|
37378
|
-
"return": {
|
37379
|
-
"type": {
|
37380
|
-
"text": "void"
|
37381
|
-
}
|
37382
|
-
},
|
37383
|
-
"parameters": [
|
37384
|
-
{
|
37385
|
-
"name": "event",
|
37386
|
-
"type": {
|
37387
|
-
"text": "KeyboardEvent"
|
37388
|
-
},
|
37389
|
-
"description": "The keyboard event."
|
37390
|
-
}
|
37391
|
-
],
|
37392
|
-
"description": "Handles the keydown event on the toggle element.\nWhen the user presses Enter, the form is submitted."
|
37683
|
+
"description": "Slot for additional detailed content, shown when expanded.",
|
37684
|
+
"name": "toast-body-detailed"
|
37393
37685
|
},
|
37394
37686
|
{
|
37395
|
-
"
|
37396
|
-
"name": "
|
37397
|
-
"privacy": "private",
|
37398
|
-
"parameters": [
|
37399
|
-
{
|
37400
|
-
"name": "event",
|
37401
|
-
"type": {
|
37402
|
-
"text": "Event"
|
37403
|
-
}
|
37404
|
-
}
|
37405
|
-
],
|
37406
|
-
"description": "Toggles the state of the toggle element.\nand dispatch the new change event."
|
37687
|
+
"description": "Slot for custom footer content. Prefer using footer-button-primary and footer-button-secondary slots.",
|
37688
|
+
"name": "footer"
|
37407
37689
|
},
|
37408
37690
|
{
|
37409
|
-
"
|
37410
|
-
"name": "
|
37411
|
-
"privacy": "private",
|
37412
|
-
"parameters": [
|
37413
|
-
{
|
37414
|
-
"name": "size",
|
37415
|
-
"type": {
|
37416
|
-
"text": "ToggleSize"
|
37417
|
-
},
|
37418
|
-
"description": "The size to set."
|
37419
|
-
}
|
37420
|
-
],
|
37421
|
-
"description": "Sets the size attribute for the toggle component.\nIf the provided size is not included in the TOGGLE_SIZE,\nit defaults to the value specified in DEFAULTS.SIZE."
|
37691
|
+
"description": "Slot for passing the primary variant of `mdc-button` in the footer.",
|
37692
|
+
"name": "footer-button-primary"
|
37422
37693
|
},
|
37423
37694
|
{
|
37424
|
-
"
|
37425
|
-
"name": "
|
37426
|
-
|
37427
|
-
|
37428
|
-
|
37429
|
-
"default": "''",
|
37430
|
-
"description": "Indicates the name of the component group.\nThey are used to group elements in a form together.",
|
37431
|
-
"attribute": "name",
|
37432
|
-
"reflects": true,
|
37433
|
-
"inheritedFrom": {
|
37434
|
-
"name": "FormInternalsMixin",
|
37435
|
-
"module": "utils/mixins/FormInternalsMixin.js"
|
37436
|
-
}
|
37437
|
-
},
|
37695
|
+
"description": "Slot for passing the secondary variant of `mdc-button` in the footer.",
|
37696
|
+
"name": "footer-button-secondary"
|
37697
|
+
}
|
37698
|
+
],
|
37699
|
+
"members": [
|
37438
37700
|
{
|
37439
37701
|
"kind": "field",
|
37440
|
-
"name": "
|
37702
|
+
"name": "variant",
|
37441
37703
|
"type": {
|
37442
|
-
"text": "
|
37704
|
+
"text": "ToastVariant"
|
37443
37705
|
},
|
37444
|
-
"
|
37445
|
-
"
|
37446
|
-
"attribute": "
|
37447
|
-
"reflects": true
|
37448
|
-
"inheritedFrom": {
|
37449
|
-
"name": "FormInternalsMixin",
|
37450
|
-
"module": "utils/mixins/FormInternalsMixin.js"
|
37451
|
-
}
|
37706
|
+
"description": "Type of toast\n- Can be `custom`, `success`, `warning` or `error`.",
|
37707
|
+
"default": "'custom'",
|
37708
|
+
"attribute": "variant",
|
37709
|
+
"reflects": true
|
37452
37710
|
},
|
37453
37711
|
{
|
37454
37712
|
"kind": "field",
|
37455
|
-
"name": "
|
37713
|
+
"name": "closeButtonAriaLabel",
|
37456
37714
|
"type": {
|
37457
37715
|
"text": "string | undefined"
|
37458
37716
|
},
|
37459
|
-
"description": "
|
37460
|
-
"attribute": "
|
37461
|
-
"reflects": true,
|
37462
|
-
"inheritedFrom": {
|
37463
|
-
"name": "FormInternalsMixin",
|
37464
|
-
"module": "utils/mixins/FormInternalsMixin.js"
|
37465
|
-
}
|
37717
|
+
"description": "Defines aria-label attribute for close button accessibility",
|
37718
|
+
"attribute": "close-button-aria-label"
|
37466
37719
|
},
|
37467
37720
|
{
|
37468
37721
|
"kind": "field",
|
37469
|
-
"name": "
|
37722
|
+
"name": "headerText",
|
37470
37723
|
"type": {
|
37471
|
-
"text": "
|
37724
|
+
"text": "string | undefined"
|
37472
37725
|
},
|
37473
|
-
"
|
37474
|
-
"
|
37475
|
-
|
37476
|
-
"module": "utils/mixins/FormInternalsMixin.js"
|
37477
|
-
}
|
37726
|
+
"description": "Defines a string value to display as the title of the toast",
|
37727
|
+
"attribute": "header-text",
|
37728
|
+
"reflects": true
|
37478
37729
|
},
|
37479
37730
|
{
|
37480
37731
|
"kind": "field",
|
37481
|
-
"name": "
|
37482
|
-
"
|
37483
|
-
|
37484
|
-
"name": "FormInternalsMixin",
|
37485
|
-
"module": "utils/mixins/FormInternalsMixin.js"
|
37486
|
-
}
|
37487
|
-
},
|
37488
|
-
{
|
37489
|
-
"kind": "method",
|
37490
|
-
"name": "setValidity",
|
37491
|
-
"description": "Sets the validity of the input field based on the input field's validity.",
|
37492
|
-
"return": {
|
37493
|
-
"type": {
|
37494
|
-
"text": ""
|
37495
|
-
}
|
37496
|
-
},
|
37497
|
-
"inheritedFrom": {
|
37498
|
-
"name": "FormInternalsMixin",
|
37499
|
-
"module": "utils/mixins/FormInternalsMixin.js"
|
37500
|
-
}
|
37501
|
-
},
|
37502
|
-
{
|
37503
|
-
"kind": "method",
|
37504
|
-
"name": "checkValidity",
|
37505
|
-
"return": {
|
37506
|
-
"type": {
|
37507
|
-
"text": "boolean"
|
37508
|
-
}
|
37732
|
+
"name": "headerTagName",
|
37733
|
+
"type": {
|
37734
|
+
"text": "TagName"
|
37509
37735
|
},
|
37510
|
-
"
|
37511
|
-
|
37512
|
-
|
37513
|
-
|
37514
|
-
},
|
37515
|
-
{
|
37516
|
-
"kind": "method",
|
37517
|
-
"name": "reportValidity",
|
37518
|
-
"inheritedFrom": {
|
37519
|
-
"name": "FormInternalsMixin",
|
37520
|
-
"module": "utils/mixins/FormInternalsMixin.js"
|
37521
|
-
}
|
37736
|
+
"description": "The html tag to be used for the header text",
|
37737
|
+
"default": "'h2'",
|
37738
|
+
"attribute": "header-tag-name",
|
37739
|
+
"reflects": true
|
37522
37740
|
},
|
37523
37741
|
{
|
37524
37742
|
"kind": "field",
|
37525
|
-
"name": "
|
37743
|
+
"name": "ariaLabel",
|
37526
37744
|
"type": {
|
37527
37745
|
"text": "string | null"
|
37528
37746
|
},
|
37529
37747
|
"default": "null",
|
37530
|
-
"description": "Defines
|
37531
|
-
"attribute": "
|
37532
|
-
"reflects": true
|
37533
|
-
"inheritedFrom": {
|
37534
|
-
"name": "DataAriaLabelMixin",
|
37535
|
-
"module": "utils/mixins/DataAriaLabelMixin.js"
|
37536
|
-
}
|
37748
|
+
"description": "Defines aria-label attribute when header is not used",
|
37749
|
+
"attribute": "aria-label",
|
37750
|
+
"reflects": true
|
37537
37751
|
},
|
37538
37752
|
{
|
37539
37753
|
"kind": "field",
|
37540
|
-
"name": "
|
37754
|
+
"name": "showMoreText",
|
37541
37755
|
"type": {
|
37542
|
-
"text": "
|
37756
|
+
"text": "string | undefined"
|
37543
37757
|
},
|
37544
|
-
"description": "
|
37545
|
-
"
|
37546
|
-
"
|
37547
|
-
"reflects": true,
|
37548
|
-
"inheritedFrom": {
|
37549
|
-
"name": "FormfieldWrapper",
|
37550
|
-
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
37551
|
-
}
|
37758
|
+
"description": "Defines the text shown on the linkbutton when detailed content is hidden.",
|
37759
|
+
"attribute": "show-more-text",
|
37760
|
+
"reflects": true
|
37552
37761
|
},
|
37553
37762
|
{
|
37554
37763
|
"kind": "field",
|
37555
|
-
"name": "
|
37764
|
+
"name": "showLessText",
|
37556
37765
|
"type": {
|
37557
37766
|
"text": "string | undefined"
|
37558
37767
|
},
|
37559
|
-
"description": "
|
37560
|
-
"attribute": "
|
37561
|
-
"reflects": true
|
37562
|
-
"inheritedFrom": {
|
37563
|
-
"name": "FormfieldWrapper",
|
37564
|
-
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
37565
|
-
}
|
37768
|
+
"description": "Defines the text shown on the linkbutton when detailed content is visible.",
|
37769
|
+
"attribute": "show-less-text",
|
37770
|
+
"reflects": true
|
37566
37771
|
},
|
37567
37772
|
{
|
37568
37773
|
"kind": "field",
|
37569
|
-
"name": "
|
37774
|
+
"name": "isDetailVisible",
|
37570
37775
|
"type": {
|
37571
37776
|
"text": "boolean"
|
37572
37777
|
},
|
37573
|
-
"
|
37574
|
-
"
|
37575
|
-
"attribute": "required",
|
37576
|
-
"reflects": true,
|
37577
|
-
"inheritedFrom": {
|
37578
|
-
"name": "FormfieldWrapper",
|
37579
|
-
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
37580
|
-
}
|
37778
|
+
"privacy": "private",
|
37779
|
+
"default": "false"
|
37581
37780
|
},
|
37582
37781
|
{
|
37583
37782
|
"kind": "field",
|
37584
|
-
"name": "
|
37783
|
+
"name": "hasDetailedSlot",
|
37585
37784
|
"type": {
|
37586
|
-
"text": "
|
37785
|
+
"text": "boolean"
|
37587
37786
|
},
|
37588
|
-
"
|
37589
|
-
"
|
37590
|
-
"reflects": true,
|
37591
|
-
"inheritedFrom": {
|
37592
|
-
"name": "FormfieldWrapper",
|
37593
|
-
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
37594
|
-
}
|
37787
|
+
"privacy": "private",
|
37788
|
+
"default": "false"
|
37595
37789
|
},
|
37596
37790
|
{
|
37597
37791
|
"kind": "field",
|
37598
|
-
"name": "
|
37792
|
+
"name": "detailedElements",
|
37599
37793
|
"type": {
|
37600
|
-
"text": "
|
37794
|
+
"text": "HTMLElement[]"
|
37601
37795
|
},
|
37602
|
-
"
|
37603
|
-
"attribute": "help-text",
|
37604
|
-
"reflects": true,
|
37605
|
-
"inheritedFrom": {
|
37606
|
-
"name": "FormfieldWrapper",
|
37607
|
-
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
37608
|
-
}
|
37796
|
+
"privacy": "private"
|
37609
37797
|
},
|
37610
37798
|
{
|
37611
37799
|
"kind": "field",
|
37612
|
-
"name": "
|
37800
|
+
"name": "hasFooterButtons",
|
37613
37801
|
"type": {
|
37614
|
-
"text": "string
|
37802
|
+
"text": "string"
|
37615
37803
|
},
|
37616
|
-
"
|
37617
|
-
"
|
37618
|
-
"reflects": true,
|
37619
|
-
"inheritedFrom": {
|
37620
|
-
"name": "FormfieldWrapper",
|
37621
|
-
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
37622
|
-
}
|
37804
|
+
"privacy": "private",
|
37805
|
+
"default": "''"
|
37623
37806
|
},
|
37624
37807
|
{
|
37625
|
-
"kind": "
|
37626
|
-
"name": "
|
37627
|
-
"
|
37628
|
-
|
37629
|
-
},
|
37630
|
-
"description": "The placement of the toggletip that is displayed when the info icon is hovered.",
|
37631
|
-
"default": "'top'",
|
37632
|
-
"attribute": "toggletip-placement",
|
37633
|
-
"reflects": true,
|
37634
|
-
"inheritedFrom": {
|
37635
|
-
"name": "FormfieldWrapper",
|
37636
|
-
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
37637
|
-
}
|
37808
|
+
"kind": "method",
|
37809
|
+
"name": "closeToast",
|
37810
|
+
"privacy": "private",
|
37811
|
+
"description": "Fired when Close Button is clicked using mouse or keyboard.\nThis method dispatches the close event.\nIt is used to notify that the toast should be closed."
|
37638
37812
|
},
|
37639
37813
|
{
|
37640
|
-
"kind": "
|
37641
|
-
"name": "
|
37642
|
-
"
|
37643
|
-
"text": "string | undefined"
|
37644
|
-
},
|
37645
|
-
"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.",
|
37646
|
-
"attribute": "info-icon-aria-label",
|
37647
|
-
"reflects": true,
|
37648
|
-
"inheritedFrom": {
|
37649
|
-
"name": "FormfieldWrapper",
|
37650
|
-
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
37651
|
-
}
|
37814
|
+
"kind": "method",
|
37815
|
+
"name": "toggleDetailVisibility",
|
37816
|
+
"privacy": "private"
|
37652
37817
|
},
|
37653
37818
|
{
|
37654
37819
|
"kind": "method",
|
37655
|
-
"name": "
|
37656
|
-
"privacy": "
|
37657
|
-
"description": "creates the label element when the label property is set.\nid is used to link the label with the input field.",
|
37658
|
-
"return": {
|
37659
|
-
"type": {
|
37660
|
-
"text": ""
|
37661
|
-
}
|
37662
|
-
},
|
37663
|
-
"inheritedFrom": {
|
37664
|
-
"name": "FormfieldWrapper",
|
37665
|
-
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
37666
|
-
}
|
37820
|
+
"name": "updateDetailedSlotPresence",
|
37821
|
+
"privacy": "private"
|
37667
37822
|
},
|
37668
37823
|
{
|
37669
37824
|
"kind": "method",
|
37670
|
-
"name": "
|
37825
|
+
"name": "updateFooterButtonsPresence",
|
37826
|
+
"privacy": "private"
|
37827
|
+
},
|
37828
|
+
{
|
37829
|
+
"kind": "method",
|
37830
|
+
"name": "renderIcon",
|
37671
37831
|
"privacy": "protected",
|
37672
|
-
"
|
37673
|
-
|
37674
|
-
|
37675
|
-
"
|
37832
|
+
"parameters": [
|
37833
|
+
{
|
37834
|
+
"name": "iconName",
|
37835
|
+
"type": {
|
37836
|
+
"text": "string"
|
37837
|
+
}
|
37676
37838
|
}
|
37677
|
-
|
37678
|
-
|
37679
|
-
|
37680
|
-
|
37681
|
-
|
37839
|
+
]
|
37840
|
+
},
|
37841
|
+
{
|
37842
|
+
"kind": "method",
|
37843
|
+
"name": "shouldRenderToggleButton",
|
37844
|
+
"privacy": "private"
|
37845
|
+
},
|
37846
|
+
{
|
37847
|
+
"kind": "method",
|
37848
|
+
"name": "renderToggleDetailButton",
|
37849
|
+
"privacy": "private"
|
37682
37850
|
},
|
37683
37851
|
{
|
37684
37852
|
"kind": "method",
|
37685
|
-
"name": "
|
37686
|
-
"privacy": "protected"
|
37687
|
-
"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.",
|
37688
|
-
"return": {
|
37689
|
-
"type": {
|
37690
|
-
"text": ""
|
37691
|
-
}
|
37692
|
-
},
|
37693
|
-
"inheritedFrom": {
|
37694
|
-
"name": "FormfieldWrapper",
|
37695
|
-
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
37696
|
-
}
|
37853
|
+
"name": "renderHeader",
|
37854
|
+
"privacy": "protected"
|
37697
37855
|
},
|
37698
37856
|
{
|
37699
37857
|
"kind": "method",
|
37700
|
-
"name": "
|
37858
|
+
"name": "handleFooterSlot",
|
37701
37859
|
"privacy": "protected",
|
37702
|
-
"description": "renders the mdc-label-text container that contains the label and labelInfoToggleTip.",
|
37703
37860
|
"return": {
|
37704
37861
|
"type": {
|
37705
|
-
"text": ""
|
37862
|
+
"text": "void"
|
37706
37863
|
}
|
37707
37864
|
},
|
37708
|
-
"
|
37709
|
-
|
37710
|
-
|
37711
|
-
|
37865
|
+
"parameters": [
|
37866
|
+
{
|
37867
|
+
"name": "tagname",
|
37868
|
+
"type": {
|
37869
|
+
"text": "string"
|
37870
|
+
}
|
37871
|
+
},
|
37872
|
+
{
|
37873
|
+
"name": "variant",
|
37874
|
+
"optional": true,
|
37875
|
+
"type": {
|
37876
|
+
"text": "string | undefined"
|
37877
|
+
}
|
37878
|
+
}
|
37879
|
+
]
|
37712
37880
|
},
|
37713
37881
|
{
|
37714
37882
|
"kind": "method",
|
37715
|
-
"name": "
|
37883
|
+
"name": "renderFooter",
|
37716
37884
|
"privacy": "protected",
|
37717
|
-
"description": "
|
37885
|
+
"description": "Renders the footer of the card if footer-link,\nfooter-button-primary, or footer-button-secondary slots are provided",
|
37718
37886
|
"return": {
|
37719
37887
|
"type": {
|
37720
37888
|
"text": ""
|
37721
37889
|
}
|
37722
37890
|
},
|
37723
37891
|
"inheritedFrom": {
|
37724
|
-
"name": "
|
37725
|
-
"module": "
|
37892
|
+
"name": "FooterMixin",
|
37893
|
+
"module": "utils/mixins/FooterMixin.js"
|
37726
37894
|
}
|
37727
37895
|
}
|
37728
37896
|
],
|
37729
37897
|
"events": [
|
37730
37898
|
{
|
37731
|
-
"
|
37732
|
-
|
37733
|
-
|
37734
|
-
},
|
37735
|
-
{
|
37736
|
-
"description": "(React: onChange) Event that gets dispatched when the toggle state changes.",
|
37737
|
-
"name": "change",
|
37738
|
-
"reactName": "onChange"
|
37739
|
-
},
|
37740
|
-
{
|
37741
|
-
"description": "(React: onFocus) Event that gets dispatched when the toggle receives focus.",
|
37742
|
-
"name": "focus",
|
37743
|
-
"reactName": "onFocus"
|
37899
|
+
"description": "(React: onClose) Dispatched when the Close Button is clicked using mouse or keyboard.",
|
37900
|
+
"name": "close",
|
37901
|
+
"reactName": "onClose"
|
37744
37902
|
}
|
37745
37903
|
],
|
37746
37904
|
"attributes": [
|
37747
37905
|
{
|
37748
|
-
"name": "
|
37749
|
-
"type": {
|
37750
|
-
"text": "boolean"
|
37751
|
-
},
|
37752
|
-
"default": "false",
|
37753
|
-
"description": "Determines whether the toggle is active or inactive.",
|
37754
|
-
"fieldName": "checked"
|
37755
|
-
},
|
37756
|
-
{
|
37757
|
-
"name": "size",
|
37758
|
-
"type": {
|
37759
|
-
"text": "ToggleSize"
|
37760
|
-
},
|
37761
|
-
"description": "Determines toggle size in rem (height is specified here).\n- **Default**: 1.5\n- **Compact**: 1",
|
37762
|
-
"default": "default",
|
37763
|
-
"fieldName": "size"
|
37764
|
-
},
|
37765
|
-
{
|
37766
|
-
"name": "autofocus",
|
37767
|
-
"type": {
|
37768
|
-
"text": "boolean"
|
37769
|
-
},
|
37770
|
-
"default": "false",
|
37771
|
-
"description": "Automatically focus on the element when the page loads.\n[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/autofocus)",
|
37772
|
-
"fieldName": "autofocus"
|
37773
|
-
},
|
37774
|
-
{
|
37775
|
-
"name": "name",
|
37776
|
-
"type": {
|
37777
|
-
"text": "string"
|
37778
|
-
},
|
37779
|
-
"default": "''",
|
37780
|
-
"description": "Indicates the name of the component group.\nThey are used to group elements in a form together.",
|
37781
|
-
"fieldName": "name",
|
37782
|
-
"inheritedFrom": {
|
37783
|
-
"name": "FormInternalsMixin",
|
37784
|
-
"module": "src/utils/mixins/FormInternalsMixin.ts"
|
37785
|
-
}
|
37786
|
-
},
|
37787
|
-
{
|
37788
|
-
"name": "value",
|
37906
|
+
"name": "variant",
|
37789
37907
|
"type": {
|
37790
|
-
"text": "
|
37908
|
+
"text": "ToastVariant"
|
37791
37909
|
},
|
37792
|
-
"
|
37793
|
-
"
|
37794
|
-
"fieldName": "
|
37795
|
-
"inheritedFrom": {
|
37796
|
-
"name": "FormInternalsMixin",
|
37797
|
-
"module": "src/utils/mixins/FormInternalsMixin.ts"
|
37798
|
-
}
|
37910
|
+
"description": "Type of toast\n- Can be `custom`, `success`, `warning` or `error`.",
|
37911
|
+
"default": "'custom'",
|
37912
|
+
"fieldName": "variant"
|
37799
37913
|
},
|
37800
37914
|
{
|
37801
|
-
"name": "
|
37915
|
+
"name": "close-button-aria-label",
|
37802
37916
|
"type": {
|
37803
37917
|
"text": "string | undefined"
|
37804
37918
|
},
|
37805
|
-
"description": "
|
37806
|
-
"fieldName": "
|
37807
|
-
"inheritedFrom": {
|
37808
|
-
"name": "FormInternalsMixin",
|
37809
|
-
"module": "src/utils/mixins/FormInternalsMixin.ts"
|
37810
|
-
}
|
37811
|
-
},
|
37812
|
-
{
|
37813
|
-
"name": "data-aria-label",
|
37814
|
-
"type": {
|
37815
|
-
"text": "string | null"
|
37816
|
-
},
|
37817
|
-
"default": "null",
|
37818
|
-
"description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
|
37819
|
-
"fieldName": "dataAriaLabel",
|
37820
|
-
"inheritedFrom": {
|
37821
|
-
"name": "DataAriaLabelMixin",
|
37822
|
-
"module": "src/utils/mixins/DataAriaLabelMixin.ts"
|
37823
|
-
}
|
37824
|
-
},
|
37825
|
-
{
|
37826
|
-
"name": "disabled",
|
37827
|
-
"type": {
|
37828
|
-
"text": "boolean | undefined"
|
37829
|
-
},
|
37830
|
-
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
37831
|
-
"default": "undefined",
|
37832
|
-
"fieldName": "disabled",
|
37833
|
-
"inheritedFrom": {
|
37834
|
-
"name": "FormfieldWrapper",
|
37835
|
-
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
37836
|
-
}
|
37919
|
+
"description": "Defines aria-label attribute for close button accessibility",
|
37920
|
+
"fieldName": "closeButtonAriaLabel"
|
37837
37921
|
},
|
37838
37922
|
{
|
37839
|
-
"name": "
|
37923
|
+
"name": "header-text",
|
37840
37924
|
"type": {
|
37841
37925
|
"text": "string | undefined"
|
37842
37926
|
},
|
37843
|
-
"description": "
|
37844
|
-
"fieldName": "
|
37845
|
-
"inheritedFrom": {
|
37846
|
-
"name": "FormfieldWrapper",
|
37847
|
-
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
37848
|
-
}
|
37849
|
-
},
|
37850
|
-
{
|
37851
|
-
"name": "required",
|
37852
|
-
"type": {
|
37853
|
-
"text": "boolean"
|
37854
|
-
},
|
37855
|
-
"default": "false",
|
37856
|
-
"description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
|
37857
|
-
"fieldName": "required",
|
37858
|
-
"inheritedFrom": {
|
37859
|
-
"name": "FormfieldWrapper",
|
37860
|
-
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
37861
|
-
}
|
37927
|
+
"description": "Defines a string value to display as the title of the toast",
|
37928
|
+
"fieldName": "headerText"
|
37862
37929
|
},
|
37863
37930
|
{
|
37864
|
-
"name": "
|
37931
|
+
"name": "header-tag-name",
|
37865
37932
|
"type": {
|
37866
|
-
"text": "
|
37933
|
+
"text": "TagName"
|
37867
37934
|
},
|
37868
|
-
"description": "The
|
37869
|
-
"
|
37870
|
-
"
|
37871
|
-
"name": "FormfieldWrapper",
|
37872
|
-
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
37873
|
-
}
|
37935
|
+
"description": "The html tag to be used for the header text",
|
37936
|
+
"default": "'h2'",
|
37937
|
+
"fieldName": "headerTagName"
|
37874
37938
|
},
|
37875
37939
|
{
|
37876
|
-
"name": "
|
37940
|
+
"name": "aria-label",
|
37877
37941
|
"type": {
|
37878
|
-
"text": "string |
|
37942
|
+
"text": "string | null"
|
37879
37943
|
},
|
37880
|
-
"
|
37881
|
-
"
|
37882
|
-
"
|
37883
|
-
"name": "FormfieldWrapper",
|
37884
|
-
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
37885
|
-
}
|
37944
|
+
"default": "null",
|
37945
|
+
"description": "Defines aria-label attribute when header is not used",
|
37946
|
+
"fieldName": "ariaLabel"
|
37886
37947
|
},
|
37887
37948
|
{
|
37888
|
-
"name": "
|
37949
|
+
"name": "show-more-text",
|
37889
37950
|
"type": {
|
37890
37951
|
"text": "string | undefined"
|
37891
37952
|
},
|
37892
|
-
"description": "
|
37893
|
-
"fieldName": "
|
37894
|
-
"inheritedFrom": {
|
37895
|
-
"name": "FormfieldWrapper",
|
37896
|
-
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
37897
|
-
}
|
37898
|
-
},
|
37899
|
-
{
|
37900
|
-
"name": "toggletip-placement",
|
37901
|
-
"type": {
|
37902
|
-
"text": "PopoverPlacement"
|
37903
|
-
},
|
37904
|
-
"description": "The placement of the toggletip that is displayed when the info icon is hovered.",
|
37905
|
-
"default": "'top'",
|
37906
|
-
"fieldName": "toggletipPlacement",
|
37907
|
-
"inheritedFrom": {
|
37908
|
-
"name": "FormfieldWrapper",
|
37909
|
-
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
37910
|
-
}
|
37953
|
+
"description": "Defines the text shown on the linkbutton when detailed content is hidden.",
|
37954
|
+
"fieldName": "showMoreText"
|
37911
37955
|
},
|
37912
37956
|
{
|
37913
|
-
"name": "
|
37957
|
+
"name": "show-less-text",
|
37914
37958
|
"type": {
|
37915
37959
|
"text": "string | undefined"
|
37916
37960
|
},
|
37917
|
-
"description": "
|
37918
|
-
"fieldName": "
|
37919
|
-
"inheritedFrom": {
|
37920
|
-
"name": "FormfieldWrapper",
|
37921
|
-
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
37922
|
-
}
|
37961
|
+
"description": "Defines the text shown on the linkbutton when detailed content is visible.",
|
37962
|
+
"fieldName": "showLessText"
|
37923
37963
|
}
|
37924
37964
|
],
|
37925
37965
|
"mixins": [
|
37926
37966
|
{
|
37927
|
-
"name": "
|
37928
|
-
"module": "/src/utils/mixins/
|
37929
|
-
},
|
37930
|
-
{
|
37931
|
-
"name": "DataAriaLabelMixin",
|
37932
|
-
"module": "/src/utils/mixins/DataAriaLabelMixin"
|
37967
|
+
"name": "FooterMixin",
|
37968
|
+
"module": "/src/utils/mixins/FooterMixin"
|
37933
37969
|
}
|
37934
37970
|
],
|
37935
37971
|
"superclass": {
|
37936
|
-
"name": "
|
37937
|
-
"module": "/src/
|
37972
|
+
"name": "Component",
|
37973
|
+
"module": "/src/models"
|
37938
37974
|
},
|
37939
|
-
"tagName": "mdc-
|
37940
|
-
"jsDoc": "/**\n *
|
37975
|
+
"tagName": "mdc-toast",
|
37976
|
+
"jsDoc": "/**\n * `mdc-toast` is a lightweight, non-blocking alert used to inform users about application processes.\n * It supports success, warning, error, and custom messages, and is designed to be controlled externally.\n * \n * **Note**: When using `slot=\"toast-body-normal\"` and `slot=\"toast-body-detailed\"`, it's strongly recommended to wrap the content with `<mdc-text tagname=\"span\">`.\n * If not used, ensure your custom content is styled appropriately to match the design and alignment expectations of the toast component.\n * \n * @dependency mdc-icon\n * @dependency mdc-text\n * @dependency mdc-button\n * @dependency mdc-linkbutton\n *\n * @slot content-prefix - Slot for custom content before the icon (only for custom variant).\n * @slot toast-body-normal - Slot for the main body content of the toast.\n * @slot toast-body-detailed - Slot for additional detailed content, shown when expanded.\n * @slot footer - Slot for custom footer content. Prefer using footer-button-primary and footer-button-secondary slots.\n * @slot footer-button-primary - Slot for passing the primary variant of `mdc-button` in the footer.\n * @slot footer-button-secondary - Slot for passing the secondary variant of `mdc-button` in the footer.\n *\n * @tagname mdc-toast\n * \n * @event close - (React: onClose) Dispatched when the Close Button is clicked using mouse or keyboard.\n *\n * @csspart content-container - The container for the toast's main content, including icon, text, and close button.\n * @csspart toast-prefix-icon - The icon shown at the start of the toast, styled by variant.\n * @csspart toast-content - The container for the header and body content of the toast.\n * @csspart toast-header - The header text of the toast.\n * @csspart footer - The container for the toast's footer, including toggle and action buttons.\n * @csspart footer-button-toggle - The toggle button for showing/hiding detailed content.\n * @csspart toast-close-btn - The close button for the toast.\n *\n * @cssproperty --mdc-toast-background-color - Background color of the toast.\n * @cssproperty --mdc-toast-border-color - Border color of the toast.\n * @cssproperty --mdc-toast-header-text-color - Color of the header text in the toast.\n * @cssproperty --mdc-toast-icon-color - Color of the icon in the toast.\n * @cssproperty --mdc-toast-elevation-3 - Elevation effect applied to the toast.\n * @cssproperty --mdc-toast-width - Width of the toast.\n * @cssproperty --mdc-toast-padding - Padding inside the toast.\n */",
|
37941
37977
|
"customElement": true
|
37942
37978
|
}
|
37943
37979
|
],
|
@@ -37946,8 +37982,8 @@
|
|
37946
37982
|
"kind": "js",
|
37947
37983
|
"name": "default",
|
37948
37984
|
"declaration": {
|
37949
|
-
"name": "
|
37950
|
-
"module": "components/
|
37985
|
+
"name": "Toast",
|
37986
|
+
"module": "components/toast/toast.component.js"
|
37951
37987
|
}
|
37952
37988
|
}
|
37953
37989
|
]
|