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