@momentum-design/components 0.104.7 → 0.104.8
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 +35 -31
- package/dist/browser/index.js.map +2 -2
- package/dist/components/menuitemcheckbox/menuitemcheckbox.component.js +17 -15
- package/dist/components/menuitemradio/menuitemradio.component.js +17 -15
- package/dist/components/menusection/menusection.component.d.ts +1 -0
- package/dist/components/menusection/menusection.component.js +2 -1
- package/dist/components/menusection/menusection.types.d.ts +2 -0
- package/dist/custom-elements.json +1162 -1157
- package/dist/react/index.d.ts +1 -1
- package/dist/react/index.js +1 -1
- package/dist/react/menusection/index.d.ts +2 -0
- package/dist/react/menusection/index.js +2 -0
- package/package.json +1 -1
@@ -23120,6 +23120,11 @@
|
|
23120
23120
|
"description": "(React: onChange) This event is dispatched when a `menuitemcheckbox`, or `menuitemradio` changes.",
|
23121
23121
|
"name": "change",
|
23122
23122
|
"reactName": "onChange"
|
23123
|
+
},
|
23124
|
+
{
|
23125
|
+
"description": "(React: onAction) This event is dispatched when a `menuitem` selected.",
|
23126
|
+
"name": "action",
|
23127
|
+
"reactName": "onAction"
|
23123
23128
|
}
|
23124
23129
|
],
|
23125
23130
|
"attributes": [
|
@@ -23170,7 +23175,7 @@
|
|
23170
23175
|
"module": "/src/models"
|
23171
23176
|
},
|
23172
23177
|
"tagName": "mdc-menusection",
|
23173
|
-
"jsDoc": "/**\n * `mdc-menusection` is a container element used to group a set of menu items.\n *\n * This component supports a mix of `menuitem`, `menuitemcheckbox`, and `menuitemradio` components.\n *\n * - If multiple `menuitemradio` components are slotted into the section, the group enforces a single-selection rule:\n * only one radio item can be selected at a time.\n * - If `menuitemcheckbox` components are included, their checked state can be toggled independently.\n *\n * @tagname mdc-menusection\n *\n * @slot - Default slot for inserting `menuitem`, `menuitemcheckbox`, or `menuitemradio`\n *\n * @event change - (React: onChange) This event is dispatched when a `menuitemcheckbox`, or `menuitemradio` changes.\n */",
|
23178
|
+
"jsDoc": "/**\n * `mdc-menusection` is a container element used to group a set of menu items.\n *\n * This component supports a mix of `menuitem`, `menuitemcheckbox`, and `menuitemradio` components.\n *\n * - If multiple `menuitemradio` components are slotted into the section, the group enforces a single-selection rule:\n * only one radio item can be selected at a time.\n * - If `menuitemcheckbox` components are included, their checked state can be toggled independently.\n *\n * @tagname mdc-menusection\n *\n * @slot - Default slot for inserting `menuitem`, `menuitemcheckbox`, or `menuitemradio`\n *\n * @event change - (React: onChange) This event is dispatched when a `menuitemcheckbox`, or `menuitemradio` changes.\n * @event action - (React: onAction) This event is dispatched when a `menuitem` selected.\n */",
|
23174
23179
|
"customElement": true
|
23175
23180
|
}
|
23176
23181
|
],
|
@@ -36121,486 +36126,916 @@
|
|
36121
36126
|
},
|
36122
36127
|
{
|
36123
36128
|
"kind": "javascript-module",
|
36124
|
-
"path": "components/
|
36125
|
-
"declarations": [
|
36126
|
-
{
|
36127
|
-
"kind": "class",
|
36128
|
-
"description": "ThemeProvider component, which sets the passed in themeclass as class.\nIf the themeclass switches, the existing themeclass will be removed as a class\nand the new themeclass will be added.\n\nCSS variables defined in the themeclass will be used for the styling of child dom nodes.\n\nAvailable Momentum theme classes:\n\n`mds-theme-stable-darkWebex`, `mds-theme-stable-lightWebex`\n\n`mds-theme-stable-darkBronzeWebex`, `mds-theme-stable-lightBronzeWebex`\n\n`mds-theme-stable-darkIndigoWebex`, `mds-theme-stable-lightIndigoWebex`\n\n`mds-theme-stable-darkJadeWebex`, `mds-theme-stable-lightJadeWebex`\n\n`mds-theme-stable-darkLavenderWebex`, `mds-theme-stable-lightLavenderWebex`\n\n`mds-theme-stable-darkRoseWebex`, `mds-theme-stable-lightRoseWebex`\n\nThemeclass context can be be consumed from Lit child components\n(see providerUtils.consume for how to consume)\n\nThemeProvider also includes basic font defaults for text.",
|
36129
|
-
"name": "ThemeProvider",
|
36130
|
-
"cssProperties": [
|
36131
|
-
{
|
36132
|
-
"description": "Option to override the default color, default: color-theme-text-primary-normal",
|
36133
|
-
"name": "--mdc-themeprovider-color-default"
|
36134
|
-
},
|
36135
|
-
{
|
36136
|
-
"description": "Option to override the font family, default: `Momentum` (from momentum-design/fonts)",
|
36137
|
-
"name": "--mdc-themeprovider-font-family"
|
36138
|
-
},
|
36139
|
-
{
|
36140
|
-
"description": "Option to override the font weight, default: `400`",
|
36141
|
-
"name": "--mdc-themeprovider-font-weight"
|
36142
|
-
},
|
36143
|
-
{
|
36144
|
-
"description": "Option to override the default letter-spacing, default: `-0.25px` (this is to match the old CiscoSans)",
|
36145
|
-
"name": "--mdc-themeprovider-letter-spacing-adjustment"
|
36146
|
-
},
|
36147
|
-
{
|
36148
|
-
"description": "Option to override the font feature settings, default: `\"ss02\" on`",
|
36149
|
-
"name": "--mdc-themeprovider-font-feature-settings"
|
36150
|
-
},
|
36151
|
-
{
|
36152
|
-
"description": "Option to override the color of the scrollbar track.",
|
36153
|
-
"name": "--mdc-themeprovider-scrollbar-track-color"
|
36154
|
-
},
|
36155
|
-
{
|
36156
|
-
"description": "Option to override the color of the scrollbar thumb.",
|
36157
|
-
"name": "--mdc-themeprovider-scrollbar-thumb-color"
|
36158
|
-
}
|
36159
|
-
],
|
36160
|
-
"slots": [
|
36161
|
-
{
|
36162
|
-
"description": "children",
|
36163
|
-
"name": ""
|
36164
|
-
}
|
36165
|
-
],
|
36166
|
-
"members": [
|
36167
|
-
{
|
36168
|
-
"kind": "field",
|
36169
|
-
"name": "Context",
|
36170
|
-
"privacy": "public",
|
36171
|
-
"static": true,
|
36172
|
-
"description": "Context object of the ThemeProvider, to be consumed by child components",
|
36173
|
-
"readonly": true
|
36174
|
-
},
|
36175
|
-
{
|
36176
|
-
"kind": "field",
|
36177
|
-
"name": "themeclass",
|
36178
|
-
"type": {
|
36179
|
-
"text": "string"
|
36180
|
-
},
|
36181
|
-
"description": "Current theme class\n\nHas to be fully qualified, such that\nthe theme class matches the class of the respective\ntheme stylesheet\n\nDefault: 'mds-theme-stable-darkWebex'",
|
36182
|
-
"attribute": "themeclass"
|
36183
|
-
},
|
36184
|
-
{
|
36185
|
-
"kind": "method",
|
36186
|
-
"name": "updateContext",
|
36187
|
-
"privacy": "protected",
|
36188
|
-
"return": {
|
36189
|
-
"type": {
|
36190
|
-
"text": "void"
|
36191
|
-
}
|
36192
|
-
},
|
36193
|
-
"description": "Update all observing components of this\nprovider to update the themeclass\n\nIs called on every re-render, see Provider class"
|
36194
|
-
},
|
36195
|
-
{
|
36196
|
-
"kind": "method",
|
36197
|
-
"name": "setThemeInClassList",
|
36198
|
-
"privacy": "private",
|
36199
|
-
"description": "Function to update the active theme classnames to update the theme tokens\nas CSS variables on the web component."
|
36200
|
-
}
|
36201
|
-
],
|
36202
|
-
"attributes": [
|
36203
|
-
{
|
36204
|
-
"name": "themeclass",
|
36205
|
-
"type": {
|
36206
|
-
"text": "string"
|
36207
|
-
},
|
36208
|
-
"description": "Current theme class\n\nHas to be fully qualified, such that\nthe theme class matches the class of the respective\ntheme stylesheet\n\nDefault: 'mds-theme-stable-darkWebex'",
|
36209
|
-
"fieldName": "themeclass"
|
36210
|
-
}
|
36211
|
-
],
|
36212
|
-
"superclass": {
|
36213
|
-
"name": "Provider",
|
36214
|
-
"module": "/src/models"
|
36215
|
-
},
|
36216
|
-
"tagName": "mdc-themeprovider",
|
36217
|
-
"jsDoc": "/**\n * ThemeProvider component, which sets the passed in themeclass as class.\n * If the themeclass switches, the existing themeclass will be removed as a class\n * and the new themeclass will be added.\n *\n * CSS variables defined in the themeclass will be used for the styling of child dom nodes.\n *\n * Available Momentum theme classes:\n *\n * `mds-theme-stable-darkWebex`, `mds-theme-stable-lightWebex`\n *\n * `mds-theme-stable-darkBronzeWebex`, `mds-theme-stable-lightBronzeWebex`\n *\n * `mds-theme-stable-darkIndigoWebex`, `mds-theme-stable-lightIndigoWebex`\n *\n * `mds-theme-stable-darkJadeWebex`, `mds-theme-stable-lightJadeWebex`\n *\n * `mds-theme-stable-darkLavenderWebex`, `mds-theme-stable-lightLavenderWebex`\n *\n * `mds-theme-stable-darkRoseWebex`, `mds-theme-stable-lightRoseWebex`\n *\n * Themeclass context can be be consumed from Lit child components\n * (see providerUtils.consume for how to consume)\n *\n * ThemeProvider also includes basic font defaults for text.\n *\n * @tagname mdc-themeprovider\n *\n * @slot - children\n *\n * @cssproperty --mdc-themeprovider-color-default - Option to override the default color,\n * default: color-theme-text-primary-normal\n * @cssproperty --mdc-themeprovider-font-family - Option to override the font family,\n * default: `Momentum` (from momentum-design/fonts)\n * @cssproperty --mdc-themeprovider-font-weight - Option to override the font weight, default: `400`\n * @cssproperty --mdc-themeprovider-letter-spacing-adjustment - Option to override the default letter-spacing,\n * default: `-0.25px` (this is to match the old CiscoSans)\n * @cssproperty --mdc-themeprovider-font-feature-settings - Option to override the font feature settings,\n * default: `\"ss02\" on`\n * @cssproperty --mdc-themeprovider-scrollbar-track-color - Option to override the color of the scrollbar track.\n * @cssproperty --mdc-themeprovider-scrollbar-thumb-color - Option to override the color of the scrollbar thumb.\n */",
|
36218
|
-
"customElement": true
|
36219
|
-
}
|
36220
|
-
],
|
36221
|
-
"exports": [
|
36222
|
-
{
|
36223
|
-
"kind": "js",
|
36224
|
-
"name": "default",
|
36225
|
-
"declaration": {
|
36226
|
-
"name": "ThemeProvider",
|
36227
|
-
"module": "components/themeprovider/themeprovider.component.js"
|
36228
|
-
}
|
36229
|
-
}
|
36230
|
-
]
|
36231
|
-
},
|
36232
|
-
{
|
36233
|
-
"kind": "javascript-module",
|
36234
|
-
"path": "components/toast/toast.component.js",
|
36129
|
+
"path": "components/textarea/textarea.component.js",
|
36235
36130
|
"declarations": [
|
36236
36131
|
{
|
36237
36132
|
"kind": "class",
|
36238
|
-
"description": "
|
36239
|
-
"name": "
|
36133
|
+
"description": "mdc-textarea component, which is used to get the multi-line text input from the user.\nIt contains:\n- label: It is the title of the textarea field.\n- required: A boolean attribute depicting that the textarea field is required.\n- Textarea: It is the multi-line text input field.\n- helper-text: It is the text that provides additional information about the textarea field.\n- max-character-limit: It is the text that shows the character count of the textarea field.\n- Error, Warning, Success, Priority Help Text type: It is the text that provides additional information\n about the textarea field based on the validation state.\n- limitexceeded: It is the event that is dispatched when the character limit exceeds or restored.\n This event exposes 3 properties:\n - currentCharacterCount - the current number of characters in the textarea field,\n - maxCharacterLimit - the maximum number of characters allowed in the textarea field,\n - value - the current value of the textarea field,\n\n**Note**: Consumers must set the help-text-type with 'error' and\nhelp-text attribute with the error message using limitexceeded event.\nThe same help-text value will be used for the validation message to be displayed.",
|
36134
|
+
"name": "Textarea",
|
36240
36135
|
"cssProperties": [
|
36241
36136
|
{
|
36242
|
-
"description": "
|
36243
|
-
"name": "--mdc-
|
36244
|
-
},
|
36245
|
-
{
|
36246
|
-
"description": "Border color of the toast.",
|
36247
|
-
"name": "--mdc-toast-border-color"
|
36248
|
-
},
|
36249
|
-
{
|
36250
|
-
"description": "Color of the header text in the toast.",
|
36251
|
-
"name": "--mdc-toast-header-text-color"
|
36252
|
-
},
|
36253
|
-
{
|
36254
|
-
"description": "Color of the icon in the toast.",
|
36255
|
-
"name": "--mdc-toast-icon-color"
|
36256
|
-
},
|
36257
|
-
{
|
36258
|
-
"description": "Elevation effect applied to the toast.",
|
36259
|
-
"name": "--mdc-toast-elevation-3"
|
36137
|
+
"description": "Border color for the textarea container when disabled",
|
36138
|
+
"name": "--mdc-textarea-disabled-border-color"
|
36260
36139
|
},
|
36261
36140
|
{
|
36262
|
-
"description": "
|
36263
|
-
"name": "--mdc-
|
36141
|
+
"description": "Text color for the textarea field when disabled",
|
36142
|
+
"name": "--mdc-textarea-disabled-text-color"
|
36264
36143
|
},
|
36265
36144
|
{
|
36266
|
-
"description": "
|
36267
|
-
"name": "--mdc-
|
36268
|
-
}
|
36269
|
-
],
|
36270
|
-
"cssParts": [
|
36271
|
-
{
|
36272
|
-
"description": "The container for the toast's main content, including icon, text, and close button.",
|
36273
|
-
"name": "content-container"
|
36145
|
+
"description": "Background color for the textarea field when disabled",
|
36146
|
+
"name": "--mdc-textarea-disabled-background-color"
|
36274
36147
|
},
|
36275
36148
|
{
|
36276
|
-
"description": "
|
36277
|
-
"name": "
|
36149
|
+
"description": "Text color for the textarea field",
|
36150
|
+
"name": "--mdc-textarea-text-color"
|
36278
36151
|
},
|
36279
36152
|
{
|
36280
|
-
"description": "
|
36281
|
-
"name": "
|
36153
|
+
"description": "Background color for the textarea field",
|
36154
|
+
"name": "--mdc-textarea-background-color"
|
36282
36155
|
},
|
36283
36156
|
{
|
36284
|
-
"description": "
|
36285
|
-
"name": "
|
36157
|
+
"description": "Border color for the textarea field",
|
36158
|
+
"name": "--mdc-textarea-border-color"
|
36286
36159
|
},
|
36287
36160
|
{
|
36288
|
-
"description": "
|
36289
|
-
"name": "
|
36161
|
+
"description": "Text color for the character counter",
|
36162
|
+
"name": "--mdc-textarea-text-secondary-normal"
|
36290
36163
|
},
|
36291
36164
|
{
|
36292
|
-
"description": "
|
36293
|
-
"name": "
|
36165
|
+
"description": "Border color for the error related help text",
|
36166
|
+
"name": "--mdc-textarea-error-border-color"
|
36294
36167
|
},
|
36295
36168
|
{
|
36296
|
-
"description": "
|
36297
|
-
"name": "
|
36298
|
-
}
|
36299
|
-
],
|
36300
|
-
"slots": [
|
36301
|
-
{
|
36302
|
-
"description": "Slot for custom content before the icon (only for custom variant).",
|
36303
|
-
"name": "content-prefix"
|
36169
|
+
"description": "Border color for the warning related help text",
|
36170
|
+
"name": "--mdc-textarea-warning-border-color"
|
36304
36171
|
},
|
36305
36172
|
{
|
36306
|
-
"description": "
|
36307
|
-
"name": "
|
36173
|
+
"description": "Border color for the success related help text",
|
36174
|
+
"name": "--mdc-textarea-success-border-color"
|
36308
36175
|
},
|
36309
36176
|
{
|
36310
|
-
"description": "
|
36311
|
-
"name": "
|
36177
|
+
"description": "Border color for the priority related help text",
|
36178
|
+
"name": "--mdc-textarea-primary-border-color"
|
36312
36179
|
},
|
36313
36180
|
{
|
36314
|
-
"description": "
|
36315
|
-
"name": "
|
36181
|
+
"description": "Background color for the textarea container when hover",
|
36182
|
+
"name": "--mdc-textarea-hover-background-color"
|
36316
36183
|
},
|
36317
36184
|
{
|
36318
|
-
"description": "
|
36319
|
-
"name": "
|
36185
|
+
"description": "Background color for the textarea container when focused",
|
36186
|
+
"name": "--mdc-textarea-focused-background-color"
|
36320
36187
|
},
|
36321
36188
|
{
|
36322
|
-
"description": "
|
36323
|
-
"name": "
|
36189
|
+
"description": "Border color for the textarea container when focused",
|
36190
|
+
"name": "--mdc-textarea-focused-border-color"
|
36324
36191
|
}
|
36325
36192
|
],
|
36326
36193
|
"members": [
|
36327
36194
|
{
|
36328
36195
|
"kind": "field",
|
36329
|
-
"name": "
|
36196
|
+
"name": "placeholder",
|
36330
36197
|
"type": {
|
36331
|
-
"text": "
|
36198
|
+
"text": "string | undefined"
|
36332
36199
|
},
|
36333
|
-
"description": "
|
36334
|
-
"
|
36335
|
-
"attribute": "variant",
|
36336
|
-
"reflects": true
|
36200
|
+
"description": "The placeholder text that is displayed when the textarea field is empty.",
|
36201
|
+
"attribute": "placeholder"
|
36337
36202
|
},
|
36338
36203
|
{
|
36339
36204
|
"kind": "field",
|
36340
|
-
"name": "
|
36205
|
+
"name": "readonly",
|
36341
36206
|
"type": {
|
36342
|
-
"text": "
|
36207
|
+
"text": "boolean"
|
36343
36208
|
},
|
36344
|
-
"
|
36345
|
-
"
|
36209
|
+
"default": "false",
|
36210
|
+
"description": "readonly attribute of the textarea field. If true, the textarea field is read-only.",
|
36211
|
+
"attribute": "readonly"
|
36346
36212
|
},
|
36347
36213
|
{
|
36348
36214
|
"kind": "field",
|
36349
|
-
"name": "
|
36215
|
+
"name": "rows",
|
36350
36216
|
"type": {
|
36351
|
-
"text": "
|
36217
|
+
"text": "number | undefined"
|
36352
36218
|
},
|
36353
|
-
"description": "
|
36354
|
-
"
|
36355
|
-
"
|
36219
|
+
"description": "The rows attribute specifies the visible number of lines in a text area.",
|
36220
|
+
"default": "5",
|
36221
|
+
"attribute": "rows"
|
36356
36222
|
},
|
36357
36223
|
{
|
36358
36224
|
"kind": "field",
|
36359
|
-
"name": "
|
36225
|
+
"name": "cols",
|
36360
36226
|
"type": {
|
36361
|
-
"text": "
|
36227
|
+
"text": "number | undefined"
|
36362
36228
|
},
|
36363
|
-
"description": "The
|
36364
|
-
"default": "
|
36365
|
-
"attribute": "
|
36366
|
-
"reflects": true
|
36229
|
+
"description": "The cols attribute specifies the visible number of lines in a text area.",
|
36230
|
+
"default": "40",
|
36231
|
+
"attribute": "cols"
|
36367
36232
|
},
|
36368
36233
|
{
|
36369
36234
|
"kind": "field",
|
36370
|
-
"name": "
|
36235
|
+
"name": "wrap",
|
36371
36236
|
"type": {
|
36372
|
-
"text": "
|
36237
|
+
"text": "WrapType"
|
36373
36238
|
},
|
36374
|
-
"
|
36375
|
-
"
|
36376
|
-
"attribute": "
|
36377
|
-
"reflects": true
|
36239
|
+
"description": "The wrap attribute specifies how the text in a text area is to be wrapped when submitted in a form.",
|
36240
|
+
"default": "'soft'",
|
36241
|
+
"attribute": "wrap"
|
36378
36242
|
},
|
36379
36243
|
{
|
36380
36244
|
"kind": "field",
|
36381
|
-
"name": "
|
36245
|
+
"name": "autocapitalize",
|
36382
36246
|
"type": {
|
36383
|
-
"text": "
|
36247
|
+
"text": "AutoCapitalizeType"
|
36384
36248
|
},
|
36385
|
-
"description": "
|
36386
|
-
"
|
36387
|
-
"
|
36249
|
+
"description": "The autocapitalize attribute of the textarea field.",
|
36250
|
+
"default": "'off'",
|
36251
|
+
"attribute": "autocapitalize"
|
36388
36252
|
},
|
36389
36253
|
{
|
36390
36254
|
"kind": "field",
|
36391
|
-
"name": "
|
36255
|
+
"name": "autocomplete",
|
36392
36256
|
"type": {
|
36393
|
-
"text": "
|
36257
|
+
"text": "AutoCompleteType"
|
36394
36258
|
},
|
36395
|
-
"description": "
|
36396
|
-
"
|
36397
|
-
"
|
36259
|
+
"description": "The autocomplete attribute of the textarea field.",
|
36260
|
+
"default": "'off'",
|
36261
|
+
"attribute": "autocomplete"
|
36398
36262
|
},
|
36399
36263
|
{
|
36400
36264
|
"kind": "field",
|
36401
|
-
"name": "
|
36265
|
+
"name": "autofocus",
|
36402
36266
|
"type": {
|
36403
36267
|
"text": "boolean"
|
36404
36268
|
},
|
36405
|
-
"
|
36406
|
-
"
|
36269
|
+
"default": "false",
|
36270
|
+
"description": "If true, the textarea field is focused when the component is rendered.",
|
36271
|
+
"attribute": "autofocus"
|
36407
36272
|
},
|
36408
36273
|
{
|
36409
36274
|
"kind": "field",
|
36410
|
-
"name": "
|
36275
|
+
"name": "dirname",
|
36411
36276
|
"type": {
|
36412
|
-
"text": "
|
36277
|
+
"text": "string | undefined"
|
36413
36278
|
},
|
36414
|
-
"
|
36415
|
-
"
|
36279
|
+
"description": "Specifies the name of the directionality of text for submission purposes (e.g., \"rtl\" for right-to-left).",
|
36280
|
+
"attribute": "dirname"
|
36416
36281
|
},
|
36417
36282
|
{
|
36418
36283
|
"kind": "field",
|
36419
|
-
"name": "
|
36284
|
+
"name": "maxlength",
|
36420
36285
|
"type": {
|
36421
|
-
"text": "
|
36286
|
+
"text": "number | undefined"
|
36422
36287
|
},
|
36423
|
-
"
|
36288
|
+
"description": "The maximum number of characters that the textarea field can accept.",
|
36289
|
+
"attribute": "maxlength"
|
36424
36290
|
},
|
36425
36291
|
{
|
36426
36292
|
"kind": "field",
|
36427
|
-
"name": "
|
36293
|
+
"name": "minlength",
|
36428
36294
|
"type": {
|
36429
|
-
"text": "
|
36295
|
+
"text": "number | undefined"
|
36430
36296
|
},
|
36431
|
-
"
|
36432
|
-
"
|
36297
|
+
"description": "The minimum number of characters that the textarea field can accept.",
|
36298
|
+
"attribute": "minlength"
|
36433
36299
|
},
|
36434
36300
|
{
|
36435
|
-
"kind": "
|
36436
|
-
"name": "
|
36437
|
-
"
|
36438
|
-
|
36301
|
+
"kind": "field",
|
36302
|
+
"name": "maxCharacterLimit",
|
36303
|
+
"type": {
|
36304
|
+
"text": "number | undefined"
|
36305
|
+
},
|
36306
|
+
"description": "maximum character limit for the textarea field for character counter.",
|
36307
|
+
"attribute": "max-character-limit"
|
36439
36308
|
},
|
36440
36309
|
{
|
36441
|
-
"kind": "
|
36442
|
-
"name": "
|
36443
|
-
"
|
36310
|
+
"kind": "field",
|
36311
|
+
"name": "characterLimitExceedingFired",
|
36312
|
+
"type": {
|
36313
|
+
"text": "boolean"
|
36314
|
+
},
|
36315
|
+
"privacy": "private",
|
36316
|
+
"default": "false"
|
36444
36317
|
},
|
36445
36318
|
{
|
36446
|
-
"kind": "
|
36447
|
-
"name": "
|
36448
|
-
"
|
36319
|
+
"kind": "field",
|
36320
|
+
"name": "textarea",
|
36321
|
+
"type": {
|
36322
|
+
"text": "HTMLTextAreaElement"
|
36323
|
+
},
|
36324
|
+
"privacy": "protected",
|
36325
|
+
"readonly": true
|
36449
36326
|
},
|
36450
36327
|
{
|
36451
36328
|
"kind": "method",
|
36452
|
-
"name": "
|
36329
|
+
"name": "setTextareaValidity",
|
36453
36330
|
"privacy": "private"
|
36454
36331
|
},
|
36455
36332
|
{
|
36456
36333
|
"kind": "method",
|
36457
|
-
"name": "
|
36458
|
-
"
|
36459
|
-
"
|
36460
|
-
{
|
36461
|
-
"
|
36462
|
-
"type": {
|
36463
|
-
"text": "string"
|
36464
|
-
}
|
36334
|
+
"name": "handleValueChange",
|
36335
|
+
"description": "Handles the value change of the textarea field.\nSets the form value and updates the validity of the textarea field.",
|
36336
|
+
"return": {
|
36337
|
+
"type": {
|
36338
|
+
"text": ""
|
36465
36339
|
}
|
36466
|
-
|
36467
|
-
},
|
36468
|
-
{
|
36469
|
-
"kind": "method",
|
36470
|
-
"name": "shouldRenderToggleButton",
|
36471
|
-
"privacy": "private"
|
36340
|
+
}
|
36472
36341
|
},
|
36473
36342
|
{
|
36474
36343
|
"kind": "method",
|
36475
|
-
"name": "
|
36476
|
-
"privacy": "private"
|
36344
|
+
"name": "dispatchCharacterOverflowStateChangeEvent",
|
36345
|
+
"privacy": "private",
|
36346
|
+
"description": "Dispatches the character overflow state change event.",
|
36347
|
+
"return": {
|
36348
|
+
"type": {
|
36349
|
+
"text": ""
|
36350
|
+
}
|
36351
|
+
}
|
36477
36352
|
},
|
36478
36353
|
{
|
36479
36354
|
"kind": "method",
|
36480
|
-
"name": "
|
36481
|
-
"privacy": "
|
36355
|
+
"name": "handleCharacterOverflowStateChange",
|
36356
|
+
"privacy": "private",
|
36357
|
+
"description": "Handles the character overflow state change.\nDispatches the character overflow state change event if the character limit is exceeded or restored.",
|
36358
|
+
"return": {
|
36359
|
+
"type": {
|
36360
|
+
"text": ""
|
36361
|
+
}
|
36362
|
+
}
|
36482
36363
|
},
|
36483
36364
|
{
|
36484
36365
|
"kind": "method",
|
36485
|
-
"name": "
|
36486
|
-
"privacy": "
|
36366
|
+
"name": "updateValue",
|
36367
|
+
"privacy": "private",
|
36368
|
+
"description": "Updates the value of the textarea field.\nSets the form value.",
|
36487
36369
|
"return": {
|
36488
36370
|
"type": {
|
36489
|
-
"text": "
|
36371
|
+
"text": ""
|
36490
36372
|
}
|
36491
|
-
}
|
36373
|
+
}
|
36374
|
+
},
|
36375
|
+
{
|
36376
|
+
"kind": "method",
|
36377
|
+
"name": "onChange",
|
36378
|
+
"privacy": "private",
|
36492
36379
|
"parameters": [
|
36493
36380
|
{
|
36494
|
-
"name": "
|
36495
|
-
"type": {
|
36496
|
-
"text": "string"
|
36497
|
-
}
|
36498
|
-
},
|
36499
|
-
{
|
36500
|
-
"name": "variant",
|
36501
|
-
"optional": true,
|
36381
|
+
"name": "event",
|
36502
36382
|
"type": {
|
36503
|
-
"text": "
|
36504
|
-
}
|
36383
|
+
"text": "Event"
|
36384
|
+
},
|
36385
|
+
"description": "Event which contains information about the value change."
|
36505
36386
|
}
|
36506
|
-
]
|
36387
|
+
],
|
36388
|
+
"description": "Handles the change event of the textarea field.\nUpdates the value and sets the validity of the textarea field.\n\nThe 'change' event does not bubble up through the shadow DOM as it was not composed.\nTherefore, we need to re-dispatch the same event to ensure it is propagated correctly.\nRead more: https://developer.mozilla.org/en-US/docs/Web/API/Event/composed"
|
36507
36389
|
},
|
36508
36390
|
{
|
36509
36391
|
"kind": "method",
|
36510
|
-
"name": "
|
36511
|
-
"privacy": "protected"
|
36512
|
-
|
36513
|
-
"return": {
|
36514
|
-
"type": {
|
36515
|
-
"text": ""
|
36516
|
-
}
|
36517
|
-
},
|
36518
|
-
"inheritedFrom": {
|
36519
|
-
"name": "FooterMixin",
|
36520
|
-
"module": "utils/mixins/FooterMixin.js"
|
36521
|
-
}
|
36522
|
-
}
|
36523
|
-
],
|
36524
|
-
"events": [
|
36392
|
+
"name": "renderCharacterCounter",
|
36393
|
+
"privacy": "protected"
|
36394
|
+
},
|
36525
36395
|
{
|
36526
|
-
"
|
36527
|
-
"name": "
|
36528
|
-
"
|
36529
|
-
}
|
36530
|
-
],
|
36531
|
-
"attributes": [
|
36396
|
+
"kind": "method",
|
36397
|
+
"name": "renderTextareaFooter",
|
36398
|
+
"privacy": "protected"
|
36399
|
+
},
|
36532
36400
|
{
|
36533
|
-
"
|
36401
|
+
"kind": "field",
|
36402
|
+
"name": "name",
|
36534
36403
|
"type": {
|
36535
|
-
"text": "
|
36404
|
+
"text": "string"
|
36536
36405
|
},
|
36537
|
-
"
|
36538
|
-
"
|
36539
|
-
"
|
36406
|
+
"default": "''",
|
36407
|
+
"description": "Indicates the name of the component group.\nThey are used to group elements in a form together.",
|
36408
|
+
"attribute": "name",
|
36409
|
+
"reflects": true,
|
36410
|
+
"inheritedFrom": {
|
36411
|
+
"name": "FormInternalsMixin",
|
36412
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
36413
|
+
}
|
36540
36414
|
},
|
36541
36415
|
{
|
36542
|
-
"
|
36416
|
+
"kind": "field",
|
36417
|
+
"name": "value",
|
36543
36418
|
"type": {
|
36544
|
-
"text": "string
|
36419
|
+
"text": "string"
|
36545
36420
|
},
|
36546
|
-
"
|
36547
|
-
"
|
36421
|
+
"default": "''",
|
36422
|
+
"description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
|
36423
|
+
"attribute": "value",
|
36424
|
+
"reflects": true,
|
36425
|
+
"inheritedFrom": {
|
36426
|
+
"name": "FormInternalsMixin",
|
36427
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
36428
|
+
}
|
36548
36429
|
},
|
36549
36430
|
{
|
36550
|
-
"
|
36431
|
+
"kind": "field",
|
36432
|
+
"name": "validationMessage",
|
36551
36433
|
"type": {
|
36552
36434
|
"text": "string | undefined"
|
36553
36435
|
},
|
36554
|
-
"description": "
|
36555
|
-
"
|
36436
|
+
"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.",
|
36437
|
+
"attribute": "validation-message",
|
36438
|
+
"reflects": true,
|
36439
|
+
"inheritedFrom": {
|
36440
|
+
"name": "FormInternalsMixin",
|
36441
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
36442
|
+
}
|
36556
36443
|
},
|
36557
36444
|
{
|
36558
|
-
"
|
36445
|
+
"kind": "field",
|
36446
|
+
"name": "validity",
|
36559
36447
|
"type": {
|
36560
|
-
"text": "
|
36448
|
+
"text": "ValidityState"
|
36561
36449
|
},
|
36562
|
-
"
|
36563
|
-
"
|
36564
|
-
|
36450
|
+
"readonly": true,
|
36451
|
+
"inheritedFrom": {
|
36452
|
+
"name": "FormInternalsMixin",
|
36453
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
36454
|
+
}
|
36565
36455
|
},
|
36566
36456
|
{
|
36567
|
-
"
|
36568
|
-
"
|
36569
|
-
|
36570
|
-
|
36571
|
-
|
36572
|
-
|
36573
|
-
|
36457
|
+
"kind": "field",
|
36458
|
+
"name": "willValidate",
|
36459
|
+
"readonly": true,
|
36460
|
+
"inheritedFrom": {
|
36461
|
+
"name": "FormInternalsMixin",
|
36462
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
36463
|
+
}
|
36574
36464
|
},
|
36575
36465
|
{
|
36576
|
-
"
|
36577
|
-
"
|
36578
|
-
|
36579
|
-
|
36580
|
-
|
36581
|
-
|
36466
|
+
"kind": "method",
|
36467
|
+
"name": "setValidity",
|
36468
|
+
"description": "Sets the validity of the input field based on the input field's validity.",
|
36469
|
+
"return": {
|
36470
|
+
"type": {
|
36471
|
+
"text": ""
|
36472
|
+
}
|
36473
|
+
},
|
36474
|
+
"inheritedFrom": {
|
36475
|
+
"name": "FormInternalsMixin",
|
36476
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
36477
|
+
}
|
36478
|
+
},
|
36479
|
+
{
|
36480
|
+
"kind": "method",
|
36481
|
+
"name": "checkValidity",
|
36482
|
+
"return": {
|
36483
|
+
"type": {
|
36484
|
+
"text": "boolean"
|
36485
|
+
}
|
36486
|
+
},
|
36487
|
+
"inheritedFrom": {
|
36488
|
+
"name": "FormInternalsMixin",
|
36489
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
36490
|
+
}
|
36491
|
+
},
|
36492
|
+
{
|
36493
|
+
"kind": "method",
|
36494
|
+
"name": "reportValidity",
|
36495
|
+
"inheritedFrom": {
|
36496
|
+
"name": "FormInternalsMixin",
|
36497
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
36498
|
+
}
|
36499
|
+
},
|
36500
|
+
{
|
36501
|
+
"kind": "field",
|
36502
|
+
"name": "dataAriaLabel",
|
36503
|
+
"type": {
|
36504
|
+
"text": "string | null"
|
36505
|
+
},
|
36506
|
+
"default": "null",
|
36507
|
+
"description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
|
36508
|
+
"attribute": "data-aria-label",
|
36509
|
+
"reflects": true,
|
36510
|
+
"inheritedFrom": {
|
36511
|
+
"name": "DataAriaLabelMixin",
|
36512
|
+
"module": "utils/mixins/DataAriaLabelMixin.js"
|
36513
|
+
}
|
36514
|
+
},
|
36515
|
+
{
|
36516
|
+
"kind": "field",
|
36517
|
+
"name": "disabled",
|
36518
|
+
"type": {
|
36519
|
+
"text": "boolean | undefined"
|
36520
|
+
},
|
36521
|
+
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
36522
|
+
"default": "undefined",
|
36523
|
+
"attribute": "disabled",
|
36524
|
+
"reflects": true,
|
36525
|
+
"inheritedFrom": {
|
36526
|
+
"name": "FormfieldWrapper",
|
36527
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
36528
|
+
}
|
36529
|
+
},
|
36530
|
+
{
|
36531
|
+
"kind": "field",
|
36532
|
+
"name": "label",
|
36533
|
+
"type": {
|
36534
|
+
"text": "string | undefined"
|
36535
|
+
},
|
36536
|
+
"description": "The label of the input field. It is linked to the input field using the `for` attribute.",
|
36537
|
+
"attribute": "label",
|
36538
|
+
"reflects": true,
|
36539
|
+
"inheritedFrom": {
|
36540
|
+
"name": "FormfieldWrapper",
|
36541
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
36542
|
+
}
|
36543
|
+
},
|
36544
|
+
{
|
36545
|
+
"kind": "field",
|
36546
|
+
"name": "required",
|
36547
|
+
"type": {
|
36548
|
+
"text": "boolean"
|
36549
|
+
},
|
36550
|
+
"default": "false",
|
36551
|
+
"description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
|
36552
|
+
"attribute": "required",
|
36553
|
+
"reflects": true,
|
36554
|
+
"inheritedFrom": {
|
36555
|
+
"name": "FormfieldWrapper",
|
36556
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
36557
|
+
}
|
36558
|
+
},
|
36559
|
+
{
|
36560
|
+
"kind": "field",
|
36561
|
+
"name": "id",
|
36562
|
+
"type": {
|
36563
|
+
"text": "string"
|
36564
|
+
},
|
36565
|
+
"default": "''",
|
36566
|
+
"description": "The unique id of the input field. It is used to link the input field with the label.",
|
36567
|
+
"attribute": "id",
|
36568
|
+
"inheritedFrom": {
|
36569
|
+
"name": "FormfieldWrapper",
|
36570
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
36571
|
+
}
|
36572
|
+
},
|
36573
|
+
{
|
36574
|
+
"kind": "field",
|
36575
|
+
"name": "helpTextType",
|
36576
|
+
"type": {
|
36577
|
+
"text": "ValidationType"
|
36578
|
+
},
|
36579
|
+
"description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
|
36580
|
+
"attribute": "help-text-type",
|
36581
|
+
"reflects": true,
|
36582
|
+
"inheritedFrom": {
|
36583
|
+
"name": "FormfieldWrapper",
|
36584
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
36585
|
+
}
|
36586
|
+
},
|
36587
|
+
{
|
36588
|
+
"kind": "field",
|
36589
|
+
"name": "helpText",
|
36590
|
+
"type": {
|
36591
|
+
"text": "string | undefined"
|
36592
|
+
},
|
36593
|
+
"description": "The help text that is displayed below the input field.",
|
36594
|
+
"attribute": "help-text",
|
36595
|
+
"reflects": true,
|
36596
|
+
"inheritedFrom": {
|
36597
|
+
"name": "FormfieldWrapper",
|
36598
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
36599
|
+
}
|
36600
|
+
},
|
36601
|
+
{
|
36602
|
+
"kind": "field",
|
36603
|
+
"name": "toggletipText",
|
36604
|
+
"type": {
|
36605
|
+
"text": "string | undefined"
|
36606
|
+
},
|
36607
|
+
"description": "The toggletip text that is displayed when the label is hovered.\nIt is used to provide additional information about the label.",
|
36608
|
+
"attribute": "toggletip-text",
|
36609
|
+
"reflects": true,
|
36610
|
+
"inheritedFrom": {
|
36611
|
+
"name": "FormfieldWrapper",
|
36612
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
36613
|
+
}
|
36614
|
+
},
|
36615
|
+
{
|
36616
|
+
"kind": "field",
|
36617
|
+
"name": "toggletipPlacement",
|
36618
|
+
"type": {
|
36619
|
+
"text": "PopoverPlacement"
|
36620
|
+
},
|
36621
|
+
"description": "The placement of the toggletip that is displayed when the info icon is hovered.",
|
36622
|
+
"default": "'top'",
|
36623
|
+
"attribute": "toggletip-placement",
|
36624
|
+
"reflects": true,
|
36625
|
+
"inheritedFrom": {
|
36626
|
+
"name": "FormfieldWrapper",
|
36627
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
36628
|
+
}
|
36629
|
+
},
|
36630
|
+
{
|
36631
|
+
"kind": "field",
|
36632
|
+
"name": "infoIconAriaLabel",
|
36633
|
+
"type": {
|
36634
|
+
"text": "string | undefined"
|
36635
|
+
},
|
36636
|
+
"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.",
|
36637
|
+
"attribute": "info-icon-aria-label",
|
36638
|
+
"reflects": true,
|
36639
|
+
"inheritedFrom": {
|
36640
|
+
"name": "FormfieldWrapper",
|
36641
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
36642
|
+
}
|
36643
|
+
},
|
36644
|
+
{
|
36645
|
+
"kind": "method",
|
36646
|
+
"name": "renderLabelElement",
|
36647
|
+
"privacy": "protected",
|
36648
|
+
"description": "creates the label element when the label property is set.\nid is used to link the label with the input field.",
|
36649
|
+
"return": {
|
36650
|
+
"type": {
|
36651
|
+
"text": ""
|
36652
|
+
}
|
36653
|
+
},
|
36654
|
+
"inheritedFrom": {
|
36655
|
+
"name": "FormfieldWrapper",
|
36656
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
36657
|
+
}
|
36658
|
+
},
|
36659
|
+
{
|
36660
|
+
"kind": "method",
|
36661
|
+
"name": "renderHelpTextIcon",
|
36662
|
+
"privacy": "protected",
|
36663
|
+
"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.",
|
36664
|
+
"return": {
|
36665
|
+
"type": {
|
36666
|
+
"text": ""
|
36667
|
+
}
|
36668
|
+
},
|
36669
|
+
"inheritedFrom": {
|
36670
|
+
"name": "FormfieldWrapper",
|
36671
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
36672
|
+
}
|
36673
|
+
},
|
36674
|
+
{
|
36675
|
+
"kind": "method",
|
36676
|
+
"name": "renderHelpText",
|
36677
|
+
"privacy": "protected",
|
36678
|
+
"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.",
|
36679
|
+
"return": {
|
36680
|
+
"type": {
|
36681
|
+
"text": ""
|
36682
|
+
}
|
36683
|
+
},
|
36684
|
+
"inheritedFrom": {
|
36685
|
+
"name": "FormfieldWrapper",
|
36686
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
36687
|
+
}
|
36688
|
+
},
|
36689
|
+
{
|
36690
|
+
"kind": "method",
|
36691
|
+
"name": "renderLabel",
|
36692
|
+
"privacy": "protected",
|
36693
|
+
"description": "renders the mdc-label-text container that contains the label and labelInfoToggleTip.",
|
36694
|
+
"return": {
|
36695
|
+
"type": {
|
36696
|
+
"text": ""
|
36697
|
+
}
|
36698
|
+
},
|
36699
|
+
"inheritedFrom": {
|
36700
|
+
"name": "FormfieldWrapper",
|
36701
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
36702
|
+
}
|
36703
|
+
},
|
36704
|
+
{
|
36705
|
+
"kind": "method",
|
36706
|
+
"name": "renderHelperText",
|
36707
|
+
"privacy": "protected",
|
36708
|
+
"description": "renders the mdc-help-text container that contains the helpertext icon and helpertext.",
|
36709
|
+
"return": {
|
36710
|
+
"type": {
|
36711
|
+
"text": ""
|
36712
|
+
}
|
36713
|
+
},
|
36714
|
+
"inheritedFrom": {
|
36715
|
+
"name": "FormfieldWrapper",
|
36716
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
36717
|
+
}
|
36718
|
+
}
|
36719
|
+
],
|
36720
|
+
"events": [
|
36721
|
+
{
|
36722
|
+
"name": "limitexceeded",
|
36723
|
+
"type": {
|
36724
|
+
"text": "CustomEvent"
|
36725
|
+
},
|
36726
|
+
"description": "(React: onLimitExceeded) This event is dispatched once when the character limit exceeds or restored.",
|
36727
|
+
"reactName": "onLimitExceeded"
|
36728
|
+
},
|
36729
|
+
{
|
36730
|
+
"type": {
|
36731
|
+
"text": "EventConstructor"
|
36732
|
+
}
|
36733
|
+
},
|
36734
|
+
{
|
36735
|
+
"description": "(React: onInput) This event is dispatched when the value of the textarea field changes (every press).",
|
36736
|
+
"name": "input",
|
36737
|
+
"reactName": "onInput"
|
36738
|
+
},
|
36739
|
+
{
|
36740
|
+
"description": "(React: onChange) This event is dispatched when the value of the textarea field changes (on blur).",
|
36741
|
+
"name": "change",
|
36742
|
+
"reactName": "onChange"
|
36743
|
+
},
|
36744
|
+
{
|
36745
|
+
"description": "(React: onFocus) This event is dispatched when the textarea receives focus.",
|
36746
|
+
"name": "focus",
|
36747
|
+
"reactName": "onFocus"
|
36748
|
+
},
|
36749
|
+
{
|
36750
|
+
"description": "(React: onBlur) This event is dispatched when the textarea loses focus.",
|
36751
|
+
"name": "blur",
|
36752
|
+
"reactName": "onBlur"
|
36753
|
+
}
|
36754
|
+
],
|
36755
|
+
"attributes": [
|
36756
|
+
{
|
36757
|
+
"name": "placeholder",
|
36758
|
+
"type": {
|
36759
|
+
"text": "string | undefined"
|
36760
|
+
},
|
36761
|
+
"description": "The placeholder text that is displayed when the textarea field is empty.",
|
36762
|
+
"fieldName": "placeholder"
|
36763
|
+
},
|
36764
|
+
{
|
36765
|
+
"name": "readonly",
|
36766
|
+
"type": {
|
36767
|
+
"text": "boolean"
|
36768
|
+
},
|
36769
|
+
"default": "false",
|
36770
|
+
"description": "readonly attribute of the textarea field. If true, the textarea field is read-only.",
|
36771
|
+
"fieldName": "readonly"
|
36772
|
+
},
|
36773
|
+
{
|
36774
|
+
"name": "rows",
|
36775
|
+
"type": {
|
36776
|
+
"text": "number | undefined"
|
36777
|
+
},
|
36778
|
+
"description": "The rows attribute specifies the visible number of lines in a text area.",
|
36779
|
+
"default": "5",
|
36780
|
+
"fieldName": "rows"
|
36781
|
+
},
|
36782
|
+
{
|
36783
|
+
"name": "cols",
|
36784
|
+
"type": {
|
36785
|
+
"text": "number | undefined"
|
36786
|
+
},
|
36787
|
+
"description": "The cols attribute specifies the visible number of lines in a text area.",
|
36788
|
+
"default": "40",
|
36789
|
+
"fieldName": "cols"
|
36790
|
+
},
|
36791
|
+
{
|
36792
|
+
"name": "wrap",
|
36793
|
+
"type": {
|
36794
|
+
"text": "WrapType"
|
36795
|
+
},
|
36796
|
+
"description": "The wrap attribute specifies how the text in a text area is to be wrapped when submitted in a form.",
|
36797
|
+
"default": "'soft'",
|
36798
|
+
"fieldName": "wrap"
|
36799
|
+
},
|
36800
|
+
{
|
36801
|
+
"name": "autocapitalize",
|
36802
|
+
"type": {
|
36803
|
+
"text": "AutoCapitalizeType"
|
36804
|
+
},
|
36805
|
+
"description": "The autocapitalize attribute of the textarea field.",
|
36806
|
+
"default": "'off'",
|
36807
|
+
"fieldName": "autocapitalize"
|
36808
|
+
},
|
36809
|
+
{
|
36810
|
+
"name": "autocomplete",
|
36811
|
+
"type": {
|
36812
|
+
"text": "AutoCompleteType"
|
36813
|
+
},
|
36814
|
+
"description": "The autocomplete attribute of the textarea field.",
|
36815
|
+
"default": "'off'",
|
36816
|
+
"fieldName": "autocomplete"
|
36817
|
+
},
|
36818
|
+
{
|
36819
|
+
"name": "autofocus",
|
36820
|
+
"type": {
|
36821
|
+
"text": "boolean"
|
36822
|
+
},
|
36823
|
+
"default": "false",
|
36824
|
+
"description": "If true, the textarea field is focused when the component is rendered.",
|
36825
|
+
"fieldName": "autofocus"
|
36826
|
+
},
|
36827
|
+
{
|
36828
|
+
"name": "dirname",
|
36829
|
+
"type": {
|
36830
|
+
"text": "string | undefined"
|
36831
|
+
},
|
36832
|
+
"description": "Specifies the name of the directionality of text for submission purposes (e.g., \"rtl\" for right-to-left).",
|
36833
|
+
"fieldName": "dirname"
|
36834
|
+
},
|
36835
|
+
{
|
36836
|
+
"name": "maxlength",
|
36837
|
+
"type": {
|
36838
|
+
"text": "number | undefined"
|
36839
|
+
},
|
36840
|
+
"description": "The maximum number of characters that the textarea field can accept.",
|
36841
|
+
"fieldName": "maxlength"
|
36842
|
+
},
|
36843
|
+
{
|
36844
|
+
"name": "minlength",
|
36845
|
+
"type": {
|
36846
|
+
"text": "number | undefined"
|
36847
|
+
},
|
36848
|
+
"description": "The minimum number of characters that the textarea field can accept.",
|
36849
|
+
"fieldName": "minlength"
|
36850
|
+
},
|
36851
|
+
{
|
36852
|
+
"name": "max-character-limit",
|
36853
|
+
"type": {
|
36854
|
+
"text": "number | undefined"
|
36855
|
+
},
|
36856
|
+
"description": "maximum character limit for the textarea field for character counter.",
|
36857
|
+
"fieldName": "maxCharacterLimit"
|
36858
|
+
},
|
36859
|
+
{
|
36860
|
+
"name": "name",
|
36861
|
+
"type": {
|
36862
|
+
"text": "string"
|
36863
|
+
},
|
36864
|
+
"default": "''",
|
36865
|
+
"description": "Indicates the name of the component group.\nThey are used to group elements in a form together.",
|
36866
|
+
"fieldName": "name",
|
36867
|
+
"inheritedFrom": {
|
36868
|
+
"name": "FormInternalsMixin",
|
36869
|
+
"module": "src/utils/mixins/FormInternalsMixin.ts"
|
36870
|
+
}
|
36871
|
+
},
|
36872
|
+
{
|
36873
|
+
"name": "value",
|
36874
|
+
"type": {
|
36875
|
+
"text": "string"
|
36876
|
+
},
|
36877
|
+
"default": "''",
|
36878
|
+
"description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
|
36879
|
+
"fieldName": "value",
|
36880
|
+
"inheritedFrom": {
|
36881
|
+
"name": "FormInternalsMixin",
|
36882
|
+
"module": "src/utils/mixins/FormInternalsMixin.ts"
|
36883
|
+
}
|
36884
|
+
},
|
36885
|
+
{
|
36886
|
+
"name": "validation-message",
|
36887
|
+
"type": {
|
36888
|
+
"text": "string | undefined"
|
36889
|
+
},
|
36890
|
+
"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.",
|
36891
|
+
"fieldName": "validationMessage",
|
36892
|
+
"inheritedFrom": {
|
36893
|
+
"name": "FormInternalsMixin",
|
36894
|
+
"module": "src/utils/mixins/FormInternalsMixin.ts"
|
36895
|
+
}
|
36896
|
+
},
|
36897
|
+
{
|
36898
|
+
"name": "data-aria-label",
|
36899
|
+
"type": {
|
36900
|
+
"text": "string | null"
|
36901
|
+
},
|
36902
|
+
"default": "null",
|
36903
|
+
"description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
|
36904
|
+
"fieldName": "dataAriaLabel",
|
36905
|
+
"inheritedFrom": {
|
36906
|
+
"name": "DataAriaLabelMixin",
|
36907
|
+
"module": "src/utils/mixins/DataAriaLabelMixin.ts"
|
36908
|
+
}
|
36909
|
+
},
|
36910
|
+
{
|
36911
|
+
"name": "disabled",
|
36912
|
+
"type": {
|
36913
|
+
"text": "boolean | undefined"
|
36914
|
+
},
|
36915
|
+
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
36916
|
+
"default": "undefined",
|
36917
|
+
"fieldName": "disabled",
|
36918
|
+
"inheritedFrom": {
|
36919
|
+
"name": "FormfieldWrapper",
|
36920
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
36921
|
+
}
|
36922
|
+
},
|
36923
|
+
{
|
36924
|
+
"name": "label",
|
36925
|
+
"type": {
|
36926
|
+
"text": "string | undefined"
|
36927
|
+
},
|
36928
|
+
"description": "The label of the input field. It is linked to the input field using the `for` attribute.",
|
36929
|
+
"fieldName": "label",
|
36930
|
+
"inheritedFrom": {
|
36931
|
+
"name": "FormfieldWrapper",
|
36932
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
36933
|
+
}
|
36934
|
+
},
|
36935
|
+
{
|
36936
|
+
"name": "required",
|
36937
|
+
"type": {
|
36938
|
+
"text": "boolean"
|
36939
|
+
},
|
36940
|
+
"default": "false",
|
36941
|
+
"description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
|
36942
|
+
"fieldName": "required",
|
36943
|
+
"inheritedFrom": {
|
36944
|
+
"name": "FormfieldWrapper",
|
36945
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
36946
|
+
}
|
36947
|
+
},
|
36948
|
+
{
|
36949
|
+
"name": "id",
|
36950
|
+
"type": {
|
36951
|
+
"text": "string"
|
36952
|
+
},
|
36953
|
+
"default": "''",
|
36954
|
+
"description": "The unique id of the input field. It is used to link the input field with the label.",
|
36955
|
+
"fieldName": "id",
|
36956
|
+
"inheritedFrom": {
|
36957
|
+
"name": "FormfieldWrapper",
|
36958
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
36959
|
+
}
|
36960
|
+
},
|
36961
|
+
{
|
36962
|
+
"name": "help-text-type",
|
36963
|
+
"type": {
|
36964
|
+
"text": "ValidationType"
|
36965
|
+
},
|
36966
|
+
"description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
|
36967
|
+
"fieldName": "helpTextType",
|
36968
|
+
"inheritedFrom": {
|
36969
|
+
"name": "FormfieldWrapper",
|
36970
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
36971
|
+
}
|
36972
|
+
},
|
36973
|
+
{
|
36974
|
+
"name": "help-text",
|
36975
|
+
"type": {
|
36976
|
+
"text": "string | undefined"
|
36977
|
+
},
|
36978
|
+
"description": "The help text that is displayed below the input field.",
|
36979
|
+
"fieldName": "helpText",
|
36980
|
+
"inheritedFrom": {
|
36981
|
+
"name": "FormfieldWrapper",
|
36982
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
36983
|
+
}
|
36984
|
+
},
|
36985
|
+
{
|
36986
|
+
"name": "toggletip-text",
|
36987
|
+
"type": {
|
36988
|
+
"text": "string | undefined"
|
36989
|
+
},
|
36990
|
+
"description": "The toggletip text that is displayed when the label is hovered.\nIt is used to provide additional information about the label.",
|
36991
|
+
"fieldName": "toggletipText",
|
36992
|
+
"inheritedFrom": {
|
36993
|
+
"name": "FormfieldWrapper",
|
36994
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
36995
|
+
}
|
36582
36996
|
},
|
36583
36997
|
{
|
36584
|
-
"name": "
|
36998
|
+
"name": "toggletip-placement",
|
36999
|
+
"type": {
|
37000
|
+
"text": "PopoverPlacement"
|
37001
|
+
},
|
37002
|
+
"description": "The placement of the toggletip that is displayed when the info icon is hovered.",
|
37003
|
+
"default": "'top'",
|
37004
|
+
"fieldName": "toggletipPlacement",
|
37005
|
+
"inheritedFrom": {
|
37006
|
+
"name": "FormfieldWrapper",
|
37007
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
37008
|
+
}
|
37009
|
+
},
|
37010
|
+
{
|
37011
|
+
"name": "info-icon-aria-label",
|
36585
37012
|
"type": {
|
36586
37013
|
"text": "string | undefined"
|
36587
37014
|
},
|
36588
|
-
"description": "
|
36589
|
-
"fieldName": "
|
37015
|
+
"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.",
|
37016
|
+
"fieldName": "infoIconAriaLabel",
|
37017
|
+
"inheritedFrom": {
|
37018
|
+
"name": "FormfieldWrapper",
|
37019
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
37020
|
+
}
|
36590
37021
|
}
|
36591
37022
|
],
|
36592
37023
|
"mixins": [
|
36593
37024
|
{
|
36594
|
-
"name": "
|
36595
|
-
"module": "/src/utils/mixins/
|
37025
|
+
"name": "FormInternalsMixin",
|
37026
|
+
"module": "/src/utils/mixins/FormInternalsMixin"
|
37027
|
+
},
|
37028
|
+
{
|
37029
|
+
"name": "DataAriaLabelMixin",
|
37030
|
+
"module": "/src/utils/mixins/DataAriaLabelMixin"
|
36596
37031
|
}
|
36597
37032
|
],
|
36598
37033
|
"superclass": {
|
36599
|
-
"name": "
|
36600
|
-
"module": "/src/
|
37034
|
+
"name": "FormfieldWrapper",
|
37035
|
+
"module": "/src/components/formfieldwrapper"
|
36601
37036
|
},
|
36602
|
-
"tagName": "mdc-
|
36603
|
-
"jsDoc": "/**\n *
|
37037
|
+
"tagName": "mdc-textarea",
|
37038
|
+
"jsDoc": "/**\n * mdc-textarea component, which is used to get the multi-line text input from the user.\n * It contains:\n * - label: It is the title of the textarea field.\n * - required: A boolean attribute depicting that the textarea field is required.\n * - Textarea: It is the multi-line text input field.\n * - helper-text: It is the text that provides additional information about the textarea field.\n * - max-character-limit: It is the text that shows the character count of the textarea field.\n * - Error, Warning, Success, Priority Help Text type: It is the text that provides additional information\n * about the textarea field based on the validation state.\n * - limitexceeded: It is the event that is dispatched when the character limit exceeds or restored.\n * This event exposes 3 properties:\n * - currentCharacterCount - the current number of characters in the textarea field,\n * - maxCharacterLimit - the maximum number of characters allowed in the textarea field,\n * - value - the current value of the textarea field,\n *\n * **Note**: Consumers must set the help-text-type with 'error' and\n * help-text attribute with the error message using limitexceeded event.\n * The same help-text value will be used for the validation message to be displayed.\n *\n * @tagname mdc-textarea\n *\n * @event input - (React: onInput) This event is dispatched when the value of the textarea field changes (every press).\n * @event change - (React: onChange) This event is dispatched when the value of the textarea field changes (on blur).\n * @event focus - (React: onFocus) This event is dispatched when the textarea receives focus.\n * @event blur - (React: onBlur) This event is dispatched when the textarea loses focus.\n * @event limitexceeded - (React: onLimitExceeded) This event is dispatched once when the character limit\n * exceeds or restored.\n *\n * @dependency mdc-button\n * @dependency mdc-icon\n * @dependency mdc-text\n * @dependency mdc-toggletip\n *\n * @cssproperty --mdc-textarea-disabled-border-color - Border color for the textarea container when disabled\n * @cssproperty --mdc-textarea-disabled-text-color - Text color for the textarea field when disabled\n * @cssproperty --mdc-textarea-disabled-background-color - Background color for the textarea field when disabled\n * @cssproperty --mdc-textarea-text-color - Text color for the textarea field\n * @cssproperty --mdc-textarea-background-color - Background color for the textarea field\n * @cssproperty --mdc-textarea-border-color - Border color for the textarea field\n * @cssproperty --mdc-textarea-text-secondary-normal - Text color for the character counter\n * @cssproperty --mdc-textarea-error-border-color - Border color for the error related help text\n * @cssproperty --mdc-textarea-warning-border-color - Border color for the warning related help text\n * @cssproperty --mdc-textarea-success-border-color - Border color for the success related help text\n * @cssproperty --mdc-textarea-primary-border-color - Border color for the priority related help text\n * @cssproperty --mdc-textarea-hover-background-color - Background color for the textarea container when hover\n * @cssproperty --mdc-textarea-focused-background-color - Background color for the textarea container when focused\n * @cssproperty --mdc-textarea-focused-border-color - Border color for the textarea container when focused\n */",
|
36604
37039
|
"customElement": true
|
36605
37040
|
}
|
36606
37041
|
],
|
@@ -36609,725 +37044,494 @@
|
|
36609
37044
|
"kind": "js",
|
36610
37045
|
"name": "default",
|
36611
37046
|
"declaration": {
|
36612
|
-
"name": "
|
36613
|
-
"module": "components/
|
37047
|
+
"name": "Textarea",
|
37048
|
+
"module": "components/textarea/textarea.component.js"
|
36614
37049
|
}
|
36615
37050
|
}
|
36616
37051
|
]
|
36617
37052
|
},
|
36618
37053
|
{
|
36619
37054
|
"kind": "javascript-module",
|
36620
|
-
"path": "components/
|
37055
|
+
"path": "components/themeprovider/themeprovider.component.js",
|
36621
37056
|
"declarations": [
|
36622
37057
|
{
|
36623
37058
|
"kind": "class",
|
36624
|
-
"description": "
|
36625
|
-
"name": "
|
37059
|
+
"description": "ThemeProvider component, which sets the passed in themeclass as class.\nIf the themeclass switches, the existing themeclass will be removed as a class\nand the new themeclass will be added.\n\nCSS variables defined in the themeclass will be used for the styling of child dom nodes.\n\nAvailable Momentum theme classes:\n\n`mds-theme-stable-darkWebex`, `mds-theme-stable-lightWebex`\n\n`mds-theme-stable-darkBronzeWebex`, `mds-theme-stable-lightBronzeWebex`\n\n`mds-theme-stable-darkIndigoWebex`, `mds-theme-stable-lightIndigoWebex`\n\n`mds-theme-stable-darkJadeWebex`, `mds-theme-stable-lightJadeWebex`\n\n`mds-theme-stable-darkLavenderWebex`, `mds-theme-stable-lightLavenderWebex`\n\n`mds-theme-stable-darkRoseWebex`, `mds-theme-stable-lightRoseWebex`\n\nThemeclass context can be be consumed from Lit child components\n(see providerUtils.consume for how to consume)\n\nThemeProvider also includes basic font defaults for text.",
|
37060
|
+
"name": "ThemeProvider",
|
36626
37061
|
"cssProperties": [
|
36627
37062
|
{
|
36628
|
-
"description": "
|
36629
|
-
"name": "--mdc-
|
36630
|
-
},
|
36631
|
-
{
|
36632
|
-
"description": "Height of the toggle",
|
36633
|
-
"name": "--mdc-toggle-height"
|
37063
|
+
"description": "Option to override the default color, default: color-theme-text-primary-normal",
|
37064
|
+
"name": "--mdc-themeprovider-color-default"
|
36634
37065
|
},
|
36635
37066
|
{
|
36636
|
-
"description": "
|
36637
|
-
"name": "--mdc-
|
37067
|
+
"description": "Option to override the font family, default: `Momentum` (from momentum-design/fonts)",
|
37068
|
+
"name": "--mdc-themeprovider-font-family"
|
36638
37069
|
},
|
36639
37070
|
{
|
36640
|
-
"description": "
|
36641
|
-
"name": "--mdc-
|
37071
|
+
"description": "Option to override the font weight, default: `400`",
|
37072
|
+
"name": "--mdc-themeprovider-font-weight"
|
36642
37073
|
},
|
36643
37074
|
{
|
36644
|
-
"description": "
|
36645
|
-
"name": "--mdc-
|
37075
|
+
"description": "Option to override the default letter-spacing, default: `-0.25px` (this is to match the old CiscoSans)",
|
37076
|
+
"name": "--mdc-themeprovider-letter-spacing-adjustment"
|
36646
37077
|
},
|
36647
37078
|
{
|
36648
|
-
"description": "
|
36649
|
-
"name": "--mdc-
|
37079
|
+
"description": "Option to override the font feature settings, default: `\"ss02\" on`",
|
37080
|
+
"name": "--mdc-themeprovider-font-feature-settings"
|
36650
37081
|
},
|
36651
37082
|
{
|
36652
|
-
"description": "
|
36653
|
-
"name": "--mdc-
|
37083
|
+
"description": "Option to override the color of the scrollbar track.",
|
37084
|
+
"name": "--mdc-themeprovider-scrollbar-track-color"
|
36654
37085
|
},
|
36655
37086
|
{
|
36656
|
-
"description": "
|
36657
|
-
"name": "--mdc-
|
36658
|
-
}
|
37087
|
+
"description": "Option to override the color of the scrollbar thumb.",
|
37088
|
+
"name": "--mdc-themeprovider-scrollbar-thumb-color"
|
37089
|
+
}
|
37090
|
+
],
|
37091
|
+
"slots": [
|
36659
37092
|
{
|
36660
|
-
"description": "
|
36661
|
-
"name": "
|
36662
|
-
}
|
37093
|
+
"description": "children",
|
37094
|
+
"name": ""
|
37095
|
+
}
|
37096
|
+
],
|
37097
|
+
"members": [
|
36663
37098
|
{
|
36664
|
-
"
|
36665
|
-
"name": "
|
37099
|
+
"kind": "field",
|
37100
|
+
"name": "Context",
|
37101
|
+
"privacy": "public",
|
37102
|
+
"static": true,
|
37103
|
+
"description": "Context object of the ThemeProvider, to be consumed by child components",
|
37104
|
+
"readonly": true
|
36666
37105
|
},
|
36667
37106
|
{
|
36668
|
-
"
|
36669
|
-
"name": "
|
37107
|
+
"kind": "field",
|
37108
|
+
"name": "themeclass",
|
37109
|
+
"type": {
|
37110
|
+
"text": "string"
|
37111
|
+
},
|
37112
|
+
"description": "Current theme class\n\nHas to be fully qualified, such that\nthe theme class matches the class of the respective\ntheme stylesheet\n\nDefault: 'mds-theme-stable-darkWebex'",
|
37113
|
+
"attribute": "themeclass"
|
36670
37114
|
},
|
36671
37115
|
{
|
36672
|
-
"
|
36673
|
-
"name": "
|
37116
|
+
"kind": "method",
|
37117
|
+
"name": "updateContext",
|
37118
|
+
"privacy": "protected",
|
37119
|
+
"return": {
|
37120
|
+
"type": {
|
37121
|
+
"text": "void"
|
37122
|
+
}
|
37123
|
+
},
|
37124
|
+
"description": "Update all observing components of this\nprovider to update the themeclass\n\nIs called on every re-render, see Provider class"
|
36674
37125
|
},
|
36675
37126
|
{
|
36676
|
-
"
|
36677
|
-
"name": "
|
37127
|
+
"kind": "method",
|
37128
|
+
"name": "setThemeInClassList",
|
37129
|
+
"privacy": "private",
|
37130
|
+
"description": "Function to update the active theme classnames to update the theme tokens\nas CSS variables on the web component."
|
36678
37131
|
}
|
36679
37132
|
],
|
36680
|
-
"
|
37133
|
+
"attributes": [
|
36681
37134
|
{
|
36682
|
-
"
|
36683
|
-
"name": "checked",
|
37135
|
+
"name": "themeclass",
|
36684
37136
|
"type": {
|
36685
|
-
"text": "
|
37137
|
+
"text": "string"
|
36686
37138
|
},
|
36687
|
-
"
|
36688
|
-
"
|
36689
|
-
|
36690
|
-
|
37139
|
+
"description": "Current theme class\n\nHas to be fully qualified, such that\nthe theme class matches the class of the respective\ntheme stylesheet\n\nDefault: 'mds-theme-stable-darkWebex'",
|
37140
|
+
"fieldName": "themeclass"
|
37141
|
+
}
|
37142
|
+
],
|
37143
|
+
"superclass": {
|
37144
|
+
"name": "Provider",
|
37145
|
+
"module": "/src/models"
|
37146
|
+
},
|
37147
|
+
"tagName": "mdc-themeprovider",
|
37148
|
+
"jsDoc": "/**\n * ThemeProvider component, which sets the passed in themeclass as class.\n * If the themeclass switches, the existing themeclass will be removed as a class\n * and the new themeclass will be added.\n *\n * CSS variables defined in the themeclass will be used for the styling of child dom nodes.\n *\n * Available Momentum theme classes:\n *\n * `mds-theme-stable-darkWebex`, `mds-theme-stable-lightWebex`\n *\n * `mds-theme-stable-darkBronzeWebex`, `mds-theme-stable-lightBronzeWebex`\n *\n * `mds-theme-stable-darkIndigoWebex`, `mds-theme-stable-lightIndigoWebex`\n *\n * `mds-theme-stable-darkJadeWebex`, `mds-theme-stable-lightJadeWebex`\n *\n * `mds-theme-stable-darkLavenderWebex`, `mds-theme-stable-lightLavenderWebex`\n *\n * `mds-theme-stable-darkRoseWebex`, `mds-theme-stable-lightRoseWebex`\n *\n * Themeclass context can be be consumed from Lit child components\n * (see providerUtils.consume for how to consume)\n *\n * ThemeProvider also includes basic font defaults for text.\n *\n * @tagname mdc-themeprovider\n *\n * @slot - children\n *\n * @cssproperty --mdc-themeprovider-color-default - Option to override the default color,\n * default: color-theme-text-primary-normal\n * @cssproperty --mdc-themeprovider-font-family - Option to override the font family,\n * default: `Momentum` (from momentum-design/fonts)\n * @cssproperty --mdc-themeprovider-font-weight - Option to override the font weight, default: `400`\n * @cssproperty --mdc-themeprovider-letter-spacing-adjustment - Option to override the default letter-spacing,\n * default: `-0.25px` (this is to match the old CiscoSans)\n * @cssproperty --mdc-themeprovider-font-feature-settings - Option to override the font feature settings,\n * default: `\"ss02\" on`\n * @cssproperty --mdc-themeprovider-scrollbar-track-color - Option to override the color of the scrollbar track.\n * @cssproperty --mdc-themeprovider-scrollbar-thumb-color - Option to override the color of the scrollbar thumb.\n */",
|
37149
|
+
"customElement": true
|
37150
|
+
}
|
37151
|
+
],
|
37152
|
+
"exports": [
|
37153
|
+
{
|
37154
|
+
"kind": "js",
|
37155
|
+
"name": "default",
|
37156
|
+
"declaration": {
|
37157
|
+
"name": "ThemeProvider",
|
37158
|
+
"module": "components/themeprovider/themeprovider.component.js"
|
37159
|
+
}
|
37160
|
+
}
|
37161
|
+
]
|
37162
|
+
},
|
37163
|
+
{
|
37164
|
+
"kind": "javascript-module",
|
37165
|
+
"path": "components/toast/toast.component.js",
|
37166
|
+
"declarations": [
|
37167
|
+
{
|
37168
|
+
"kind": "class",
|
37169
|
+
"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.",
|
37170
|
+
"name": "Toast",
|
37171
|
+
"cssProperties": [
|
37172
|
+
{
|
37173
|
+
"description": "Background color of the toast.",
|
37174
|
+
"name": "--mdc-toast-background-color"
|
36691
37175
|
},
|
36692
37176
|
{
|
36693
|
-
"
|
36694
|
-
"name": "
|
36695
|
-
"type": {
|
36696
|
-
"text": "ToggleSize"
|
36697
|
-
},
|
36698
|
-
"description": "Determines toggle size in rem (height is specified here).\n- **Default**: 1.5\n- **Compact**: 1",
|
36699
|
-
"default": "default",
|
36700
|
-
"attribute": "size",
|
36701
|
-
"reflects": true
|
37177
|
+
"description": "Border color of the toast.",
|
37178
|
+
"name": "--mdc-toast-border-color"
|
36702
37179
|
},
|
36703
37180
|
{
|
36704
|
-
"
|
36705
|
-
"name": "
|
36706
|
-
"type": {
|
36707
|
-
"text": "boolean"
|
36708
|
-
},
|
36709
|
-
"default": "false",
|
36710
|
-
"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)",
|
36711
|
-
"attribute": "autofocus",
|
36712
|
-
"reflects": true
|
37181
|
+
"description": "Color of the header text in the toast.",
|
37182
|
+
"name": "--mdc-toast-header-text-color"
|
36713
37183
|
},
|
36714
37184
|
{
|
36715
|
-
"
|
36716
|
-
"name": "
|
36717
|
-
"privacy": "private",
|
36718
|
-
"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."
|
37185
|
+
"description": "Color of the icon in the toast.",
|
37186
|
+
"name": "--mdc-toast-icon-color"
|
36719
37187
|
},
|
36720
37188
|
{
|
36721
|
-
"
|
36722
|
-
"name": "
|
36723
|
-
"privacy": "private",
|
36724
|
-
"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."
|
37189
|
+
"description": "Elevation effect applied to the toast.",
|
37190
|
+
"name": "--mdc-toast-elevation-3"
|
36725
37191
|
},
|
36726
37192
|
{
|
36727
|
-
"
|
36728
|
-
"name": "
|
36729
|
-
"privacy": "private",
|
36730
|
-
"return": {
|
36731
|
-
"type": {
|
36732
|
-
"text": "void"
|
36733
|
-
}
|
36734
|
-
},
|
36735
|
-
"description": "Toggles the state of the toggle element.\nIf the element is not disabled, then the checked property is toggled."
|
37193
|
+
"description": "Width of the toast.",
|
37194
|
+
"name": "--mdc-toast-width"
|
36736
37195
|
},
|
36737
37196
|
{
|
36738
|
-
"
|
36739
|
-
"name": "
|
36740
|
-
|
36741
|
-
|
36742
|
-
|
36743
|
-
|
36744
|
-
|
36745
|
-
|
36746
|
-
|
36747
|
-
|
36748
|
-
|
36749
|
-
|
36750
|
-
"text": "KeyboardEvent"
|
36751
|
-
},
|
36752
|
-
"description": "The keyboard event."
|
36753
|
-
}
|
36754
|
-
],
|
36755
|
-
"description": "Handles the keydown event on the toggle element.\nWhen the user presses Enter, the form is submitted."
|
37197
|
+
"description": "Padding inside the toast.",
|
37198
|
+
"name": "--mdc-toast-padding"
|
37199
|
+
}
|
37200
|
+
],
|
37201
|
+
"cssParts": [
|
37202
|
+
{
|
37203
|
+
"description": "The container for the toast's main content, including icon, text, and close button.",
|
37204
|
+
"name": "content-container"
|
37205
|
+
},
|
37206
|
+
{
|
37207
|
+
"description": "The icon shown at the start of the toast, styled by variant.",
|
37208
|
+
"name": "toast-prefix-icon"
|
36756
37209
|
},
|
36757
37210
|
{
|
36758
|
-
"
|
36759
|
-
"name": "
|
36760
|
-
"privacy": "private",
|
36761
|
-
"parameters": [
|
36762
|
-
{
|
36763
|
-
"name": "event",
|
36764
|
-
"type": {
|
36765
|
-
"text": "Event"
|
36766
|
-
}
|
36767
|
-
}
|
36768
|
-
],
|
36769
|
-
"description": "Toggles the state of the toggle element.\nand dispatch the new change event."
|
37211
|
+
"description": "The container for the header and body content of the toast.",
|
37212
|
+
"name": "toast-content"
|
36770
37213
|
},
|
36771
37214
|
{
|
36772
|
-
"
|
36773
|
-
"name": "
|
36774
|
-
"privacy": "private",
|
36775
|
-
"parameters": [
|
36776
|
-
{
|
36777
|
-
"name": "size",
|
36778
|
-
"type": {
|
36779
|
-
"text": "ToggleSize"
|
36780
|
-
},
|
36781
|
-
"description": "The size to set."
|
36782
|
-
}
|
36783
|
-
],
|
36784
|
-
"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."
|
37215
|
+
"description": "The header text of the toast.",
|
37216
|
+
"name": "toast-header"
|
36785
37217
|
},
|
36786
37218
|
{
|
36787
|
-
"
|
36788
|
-
"name": "
|
36789
|
-
"type": {
|
36790
|
-
"text": "string"
|
36791
|
-
},
|
36792
|
-
"default": "''",
|
36793
|
-
"description": "Indicates the name of the component group.\nThey are used to group elements in a form together.",
|
36794
|
-
"attribute": "name",
|
36795
|
-
"reflects": true,
|
36796
|
-
"inheritedFrom": {
|
36797
|
-
"name": "FormInternalsMixin",
|
36798
|
-
"module": "utils/mixins/FormInternalsMixin.js"
|
36799
|
-
}
|
37219
|
+
"description": "The container for the toast's footer, including toggle and action buttons.",
|
37220
|
+
"name": "footer"
|
36800
37221
|
},
|
36801
37222
|
{
|
36802
|
-
"
|
36803
|
-
"name": "
|
36804
|
-
"type": {
|
36805
|
-
"text": "string"
|
36806
|
-
},
|
36807
|
-
"default": "''",
|
36808
|
-
"description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
|
36809
|
-
"attribute": "value",
|
36810
|
-
"reflects": true,
|
36811
|
-
"inheritedFrom": {
|
36812
|
-
"name": "FormInternalsMixin",
|
36813
|
-
"module": "utils/mixins/FormInternalsMixin.js"
|
36814
|
-
}
|
37223
|
+
"description": "The toggle button for showing/hiding detailed content.",
|
37224
|
+
"name": "footer-button-toggle"
|
36815
37225
|
},
|
36816
37226
|
{
|
36817
|
-
"
|
36818
|
-
"name": "
|
36819
|
-
|
36820
|
-
|
36821
|
-
|
36822
|
-
"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.",
|
36823
|
-
"attribute": "validation-message",
|
36824
|
-
"reflects": true,
|
36825
|
-
"inheritedFrom": {
|
36826
|
-
"name": "FormInternalsMixin",
|
36827
|
-
"module": "utils/mixins/FormInternalsMixin.js"
|
36828
|
-
}
|
36829
|
-
},
|
37227
|
+
"description": "The close button for the toast.",
|
37228
|
+
"name": "toast-close-btn"
|
37229
|
+
}
|
37230
|
+
],
|
37231
|
+
"slots": [
|
36830
37232
|
{
|
36831
|
-
"
|
36832
|
-
"name": "
|
36833
|
-
"type": {
|
36834
|
-
"text": "ValidityState"
|
36835
|
-
},
|
36836
|
-
"readonly": true,
|
36837
|
-
"inheritedFrom": {
|
36838
|
-
"name": "FormInternalsMixin",
|
36839
|
-
"module": "utils/mixins/FormInternalsMixin.js"
|
36840
|
-
}
|
37233
|
+
"description": "Slot for custom content before the icon (only for custom variant).",
|
37234
|
+
"name": "content-prefix"
|
36841
37235
|
},
|
36842
37236
|
{
|
36843
|
-
"
|
36844
|
-
"name": "
|
36845
|
-
"readonly": true,
|
36846
|
-
"inheritedFrom": {
|
36847
|
-
"name": "FormInternalsMixin",
|
36848
|
-
"module": "utils/mixins/FormInternalsMixin.js"
|
36849
|
-
}
|
37237
|
+
"description": "Slot for the main body content of the toast.",
|
37238
|
+
"name": "toast-body-normal"
|
36850
37239
|
},
|
36851
37240
|
{
|
36852
|
-
"
|
36853
|
-
"name": "
|
36854
|
-
"description": "Sets the validity of the input field based on the input field's validity.",
|
36855
|
-
"return": {
|
36856
|
-
"type": {
|
36857
|
-
"text": ""
|
36858
|
-
}
|
36859
|
-
},
|
36860
|
-
"inheritedFrom": {
|
36861
|
-
"name": "FormInternalsMixin",
|
36862
|
-
"module": "utils/mixins/FormInternalsMixin.js"
|
36863
|
-
}
|
37241
|
+
"description": "Slot for additional detailed content, shown when expanded.",
|
37242
|
+
"name": "toast-body-detailed"
|
36864
37243
|
},
|
36865
37244
|
{
|
36866
|
-
"
|
36867
|
-
"name": "
|
36868
|
-
"return": {
|
36869
|
-
"type": {
|
36870
|
-
"text": "boolean"
|
36871
|
-
}
|
36872
|
-
},
|
36873
|
-
"inheritedFrom": {
|
36874
|
-
"name": "FormInternalsMixin",
|
36875
|
-
"module": "utils/mixins/FormInternalsMixin.js"
|
36876
|
-
}
|
37245
|
+
"description": "Slot for custom footer content. Prefer using footer-button-primary and footer-button-secondary slots.",
|
37246
|
+
"name": "footer"
|
36877
37247
|
},
|
36878
37248
|
{
|
36879
|
-
"
|
36880
|
-
"name": "
|
36881
|
-
"inheritedFrom": {
|
36882
|
-
"name": "FormInternalsMixin",
|
36883
|
-
"module": "utils/mixins/FormInternalsMixin.js"
|
36884
|
-
}
|
37249
|
+
"description": "Slot for passing the primary variant of `mdc-button` in the footer.",
|
37250
|
+
"name": "footer-button-primary"
|
36885
37251
|
},
|
37252
|
+
{
|
37253
|
+
"description": "Slot for passing the secondary variant of `mdc-button` in the footer.",
|
37254
|
+
"name": "footer-button-secondary"
|
37255
|
+
}
|
37256
|
+
],
|
37257
|
+
"members": [
|
36886
37258
|
{
|
36887
37259
|
"kind": "field",
|
36888
|
-
"name": "
|
37260
|
+
"name": "variant",
|
36889
37261
|
"type": {
|
36890
|
-
"text": "
|
37262
|
+
"text": "ToastVariant"
|
36891
37263
|
},
|
36892
|
-
"
|
36893
|
-
"
|
36894
|
-
"attribute": "
|
36895
|
-
"reflects": true
|
36896
|
-
"inheritedFrom": {
|
36897
|
-
"name": "DataAriaLabelMixin",
|
36898
|
-
"module": "utils/mixins/DataAriaLabelMixin.js"
|
36899
|
-
}
|
37264
|
+
"description": "Type of toast\n- Can be `custom`, `success`, `warning` or `error`.",
|
37265
|
+
"default": "'custom'",
|
37266
|
+
"attribute": "variant",
|
37267
|
+
"reflects": true
|
36900
37268
|
},
|
36901
37269
|
{
|
36902
37270
|
"kind": "field",
|
36903
|
-
"name": "
|
37271
|
+
"name": "closeButtonAriaLabel",
|
36904
37272
|
"type": {
|
36905
|
-
"text": "
|
37273
|
+
"text": "string | undefined"
|
36906
37274
|
},
|
36907
|
-
"description": "
|
36908
|
-
"
|
36909
|
-
"attribute": "disabled",
|
36910
|
-
"reflects": true,
|
36911
|
-
"inheritedFrom": {
|
36912
|
-
"name": "FormfieldWrapper",
|
36913
|
-
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
36914
|
-
}
|
37275
|
+
"description": "Defines aria-label attribute for close button accessibility",
|
37276
|
+
"attribute": "close-button-aria-label"
|
36915
37277
|
},
|
36916
37278
|
{
|
36917
37279
|
"kind": "field",
|
36918
|
-
"name": "
|
37280
|
+
"name": "headerText",
|
36919
37281
|
"type": {
|
36920
37282
|
"text": "string | undefined"
|
36921
37283
|
},
|
36922
|
-
"description": "
|
36923
|
-
"attribute": "
|
36924
|
-
"reflects": true
|
36925
|
-
"inheritedFrom": {
|
36926
|
-
"name": "FormfieldWrapper",
|
36927
|
-
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
36928
|
-
}
|
37284
|
+
"description": "Defines a string value to display as the title of the toast",
|
37285
|
+
"attribute": "header-text",
|
37286
|
+
"reflects": true
|
36929
37287
|
},
|
36930
37288
|
{
|
36931
37289
|
"kind": "field",
|
36932
|
-
"name": "
|
37290
|
+
"name": "headerTagName",
|
36933
37291
|
"type": {
|
36934
|
-
"text": "
|
37292
|
+
"text": "TagName"
|
36935
37293
|
},
|
36936
|
-
"
|
36937
|
-
"
|
36938
|
-
"attribute": "
|
36939
|
-
"reflects": true
|
36940
|
-
"inheritedFrom": {
|
36941
|
-
"name": "FormfieldWrapper",
|
36942
|
-
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
36943
|
-
}
|
37294
|
+
"description": "The html tag to be used for the header text",
|
37295
|
+
"default": "'h2'",
|
37296
|
+
"attribute": "header-tag-name",
|
37297
|
+
"reflects": true
|
36944
37298
|
},
|
36945
37299
|
{
|
36946
37300
|
"kind": "field",
|
36947
|
-
"name": "
|
37301
|
+
"name": "ariaLabel",
|
36948
37302
|
"type": {
|
36949
|
-
"text": "string"
|
37303
|
+
"text": "string | null"
|
36950
37304
|
},
|
36951
|
-
"default": "
|
36952
|
-
"description": "
|
36953
|
-
"attribute": "
|
36954
|
-
"
|
36955
|
-
"name": "FormfieldWrapper",
|
36956
|
-
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
36957
|
-
}
|
37305
|
+
"default": "null",
|
37306
|
+
"description": "Defines aria-label attribute when header is not used",
|
37307
|
+
"attribute": "aria-label",
|
37308
|
+
"reflects": true
|
36958
37309
|
},
|
36959
37310
|
{
|
36960
37311
|
"kind": "field",
|
36961
|
-
"name": "
|
37312
|
+
"name": "showMoreText",
|
36962
37313
|
"type": {
|
36963
|
-
"text": "
|
37314
|
+
"text": "string | undefined"
|
36964
37315
|
},
|
36965
|
-
"description": "
|
36966
|
-
"attribute": "
|
36967
|
-
"reflects": true
|
36968
|
-
"inheritedFrom": {
|
36969
|
-
"name": "FormfieldWrapper",
|
36970
|
-
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
36971
|
-
}
|
37316
|
+
"description": "Defines the text shown on the linkbutton when detailed content is hidden.",
|
37317
|
+
"attribute": "show-more-text",
|
37318
|
+
"reflects": true
|
36972
37319
|
},
|
36973
37320
|
{
|
36974
37321
|
"kind": "field",
|
36975
|
-
"name": "
|
37322
|
+
"name": "showLessText",
|
36976
37323
|
"type": {
|
36977
37324
|
"text": "string | undefined"
|
36978
37325
|
},
|
36979
|
-
"description": "
|
36980
|
-
"attribute": "
|
36981
|
-
"reflects": true
|
36982
|
-
"inheritedFrom": {
|
36983
|
-
"name": "FormfieldWrapper",
|
36984
|
-
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
36985
|
-
}
|
37326
|
+
"description": "Defines the text shown on the linkbutton when detailed content is visible.",
|
37327
|
+
"attribute": "show-less-text",
|
37328
|
+
"reflects": true
|
36986
37329
|
},
|
36987
37330
|
{
|
36988
37331
|
"kind": "field",
|
36989
|
-
"name": "
|
37332
|
+
"name": "isDetailVisible",
|
36990
37333
|
"type": {
|
36991
|
-
"text": "
|
37334
|
+
"text": "boolean"
|
36992
37335
|
},
|
36993
|
-
"
|
36994
|
-
"
|
36995
|
-
|
36996
|
-
|
36997
|
-
|
36998
|
-
|
36999
|
-
|
37336
|
+
"privacy": "private",
|
37337
|
+
"default": "false"
|
37338
|
+
},
|
37339
|
+
{
|
37340
|
+
"kind": "field",
|
37341
|
+
"name": "hasDetailedSlot",
|
37342
|
+
"type": {
|
37343
|
+
"text": "boolean"
|
37344
|
+
},
|
37345
|
+
"privacy": "private",
|
37346
|
+
"default": "false"
|
37000
37347
|
},
|
37001
37348
|
{
|
37002
37349
|
"kind": "field",
|
37003
|
-
"name": "
|
37350
|
+
"name": "detailedElements",
|
37004
37351
|
"type": {
|
37005
|
-
"text": "
|
37352
|
+
"text": "HTMLElement[]"
|
37006
37353
|
},
|
37007
|
-
"
|
37008
|
-
"default": "'top'",
|
37009
|
-
"attribute": "toggletip-placement",
|
37010
|
-
"reflects": true,
|
37011
|
-
"inheritedFrom": {
|
37012
|
-
"name": "FormfieldWrapper",
|
37013
|
-
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
37014
|
-
}
|
37354
|
+
"privacy": "private"
|
37015
37355
|
},
|
37016
37356
|
{
|
37017
37357
|
"kind": "field",
|
37018
|
-
"name": "
|
37358
|
+
"name": "hasFooterButtons",
|
37019
37359
|
"type": {
|
37020
|
-
"text": "string
|
37360
|
+
"text": "string"
|
37021
37361
|
},
|
37022
|
-
"
|
37023
|
-
"
|
37024
|
-
"reflects": true,
|
37025
|
-
"inheritedFrom": {
|
37026
|
-
"name": "FormfieldWrapper",
|
37027
|
-
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
37028
|
-
}
|
37362
|
+
"privacy": "private",
|
37363
|
+
"default": "''"
|
37029
37364
|
},
|
37030
37365
|
{
|
37031
37366
|
"kind": "method",
|
37032
|
-
"name": "
|
37033
|
-
"privacy": "
|
37034
|
-
"description": "
|
37035
|
-
"return": {
|
37036
|
-
"type": {
|
37037
|
-
"text": ""
|
37038
|
-
}
|
37039
|
-
},
|
37040
|
-
"inheritedFrom": {
|
37041
|
-
"name": "FormfieldWrapper",
|
37042
|
-
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
37043
|
-
}
|
37367
|
+
"name": "closeToast",
|
37368
|
+
"privacy": "private",
|
37369
|
+
"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."
|
37044
37370
|
},
|
37045
37371
|
{
|
37046
37372
|
"kind": "method",
|
37047
|
-
"name": "
|
37048
|
-
"privacy": "
|
37049
|
-
"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.",
|
37050
|
-
"return": {
|
37051
|
-
"type": {
|
37052
|
-
"text": ""
|
37053
|
-
}
|
37054
|
-
},
|
37055
|
-
"inheritedFrom": {
|
37056
|
-
"name": "FormfieldWrapper",
|
37057
|
-
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
37058
|
-
}
|
37373
|
+
"name": "toggleDetailVisibility",
|
37374
|
+
"privacy": "private"
|
37059
37375
|
},
|
37060
37376
|
{
|
37061
37377
|
"kind": "method",
|
37062
|
-
"name": "
|
37378
|
+
"name": "updateDetailedSlotPresence",
|
37379
|
+
"privacy": "private"
|
37380
|
+
},
|
37381
|
+
{
|
37382
|
+
"kind": "method",
|
37383
|
+
"name": "updateFooterButtonsPresence",
|
37384
|
+
"privacy": "private"
|
37385
|
+
},
|
37386
|
+
{
|
37387
|
+
"kind": "method",
|
37388
|
+
"name": "renderIcon",
|
37063
37389
|
"privacy": "protected",
|
37064
|
-
"
|
37065
|
-
|
37066
|
-
|
37067
|
-
"
|
37390
|
+
"parameters": [
|
37391
|
+
{
|
37392
|
+
"name": "iconName",
|
37393
|
+
"type": {
|
37394
|
+
"text": "string"
|
37395
|
+
}
|
37068
37396
|
}
|
37069
|
-
|
37070
|
-
"inheritedFrom": {
|
37071
|
-
"name": "FormfieldWrapper",
|
37072
|
-
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
37073
|
-
}
|
37397
|
+
]
|
37074
37398
|
},
|
37075
37399
|
{
|
37076
37400
|
"kind": "method",
|
37077
|
-
"name": "
|
37401
|
+
"name": "shouldRenderToggleButton",
|
37402
|
+
"privacy": "private"
|
37403
|
+
},
|
37404
|
+
{
|
37405
|
+
"kind": "method",
|
37406
|
+
"name": "renderToggleDetailButton",
|
37407
|
+
"privacy": "private"
|
37408
|
+
},
|
37409
|
+
{
|
37410
|
+
"kind": "method",
|
37411
|
+
"name": "renderHeader",
|
37412
|
+
"privacy": "protected"
|
37413
|
+
},
|
37414
|
+
{
|
37415
|
+
"kind": "method",
|
37416
|
+
"name": "handleFooterSlot",
|
37078
37417
|
"privacy": "protected",
|
37079
|
-
"description": "renders the mdc-label-text container that contains the label and labelInfoToggleTip.",
|
37080
37418
|
"return": {
|
37081
37419
|
"type": {
|
37082
|
-
"text": ""
|
37420
|
+
"text": "void"
|
37083
37421
|
}
|
37084
37422
|
},
|
37085
|
-
"
|
37086
|
-
|
37087
|
-
|
37088
|
-
|
37423
|
+
"parameters": [
|
37424
|
+
{
|
37425
|
+
"name": "tagname",
|
37426
|
+
"type": {
|
37427
|
+
"text": "string"
|
37428
|
+
}
|
37429
|
+
},
|
37430
|
+
{
|
37431
|
+
"name": "variant",
|
37432
|
+
"optional": true,
|
37433
|
+
"type": {
|
37434
|
+
"text": "string | undefined"
|
37435
|
+
}
|
37436
|
+
}
|
37437
|
+
]
|
37089
37438
|
},
|
37090
37439
|
{
|
37091
37440
|
"kind": "method",
|
37092
|
-
"name": "
|
37441
|
+
"name": "renderFooter",
|
37093
37442
|
"privacy": "protected",
|
37094
|
-
"description": "
|
37443
|
+
"description": "Renders the footer of the card if footer-link,\nfooter-button-primary, or footer-button-secondary slots are provided",
|
37095
37444
|
"return": {
|
37096
37445
|
"type": {
|
37097
37446
|
"text": ""
|
37098
37447
|
}
|
37099
37448
|
},
|
37100
37449
|
"inheritedFrom": {
|
37101
|
-
"name": "
|
37102
|
-
"module": "
|
37450
|
+
"name": "FooterMixin",
|
37451
|
+
"module": "utils/mixins/FooterMixin.js"
|
37103
37452
|
}
|
37104
37453
|
}
|
37105
37454
|
],
|
37106
37455
|
"events": [
|
37107
37456
|
{
|
37108
|
-
"
|
37109
|
-
|
37110
|
-
|
37111
|
-
},
|
37112
|
-
{
|
37113
|
-
"description": "(React: onChange) Event that gets dispatched when the toggle state changes.",
|
37114
|
-
"name": "change",
|
37115
|
-
"reactName": "onChange"
|
37116
|
-
},
|
37117
|
-
{
|
37118
|
-
"description": "(React: onFocus) Event that gets dispatched when the toggle receives focus.",
|
37119
|
-
"name": "focus",
|
37120
|
-
"reactName": "onFocus"
|
37457
|
+
"description": "(React: onClose) Dispatched when the Close Button is clicked using mouse or keyboard.",
|
37458
|
+
"name": "close",
|
37459
|
+
"reactName": "onClose"
|
37121
37460
|
}
|
37122
37461
|
],
|
37123
37462
|
"attributes": [
|
37124
37463
|
{
|
37125
|
-
"name": "
|
37126
|
-
"type": {
|
37127
|
-
"text": "boolean"
|
37128
|
-
},
|
37129
|
-
"default": "false",
|
37130
|
-
"description": "Determines whether the toggle is active or inactive.",
|
37131
|
-
"fieldName": "checked"
|
37132
|
-
},
|
37133
|
-
{
|
37134
|
-
"name": "size",
|
37135
|
-
"type": {
|
37136
|
-
"text": "ToggleSize"
|
37137
|
-
},
|
37138
|
-
"description": "Determines toggle size in rem (height is specified here).\n- **Default**: 1.5\n- **Compact**: 1",
|
37139
|
-
"default": "default",
|
37140
|
-
"fieldName": "size"
|
37141
|
-
},
|
37142
|
-
{
|
37143
|
-
"name": "autofocus",
|
37144
|
-
"type": {
|
37145
|
-
"text": "boolean"
|
37146
|
-
},
|
37147
|
-
"default": "false",
|
37148
|
-
"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)",
|
37149
|
-
"fieldName": "autofocus"
|
37150
|
-
},
|
37151
|
-
{
|
37152
|
-
"name": "name",
|
37153
|
-
"type": {
|
37154
|
-
"text": "string"
|
37155
|
-
},
|
37156
|
-
"default": "''",
|
37157
|
-
"description": "Indicates the name of the component group.\nThey are used to group elements in a form together.",
|
37158
|
-
"fieldName": "name",
|
37159
|
-
"inheritedFrom": {
|
37160
|
-
"name": "FormInternalsMixin",
|
37161
|
-
"module": "src/utils/mixins/FormInternalsMixin.ts"
|
37162
|
-
}
|
37163
|
-
},
|
37164
|
-
{
|
37165
|
-
"name": "value",
|
37166
|
-
"type": {
|
37167
|
-
"text": "string"
|
37168
|
-
},
|
37169
|
-
"default": "''",
|
37170
|
-
"description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
|
37171
|
-
"fieldName": "value",
|
37172
|
-
"inheritedFrom": {
|
37173
|
-
"name": "FormInternalsMixin",
|
37174
|
-
"module": "src/utils/mixins/FormInternalsMixin.ts"
|
37175
|
-
}
|
37176
|
-
},
|
37177
|
-
{
|
37178
|
-
"name": "validation-message",
|
37179
|
-
"type": {
|
37180
|
-
"text": "string | undefined"
|
37181
|
-
},
|
37182
|
-
"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.",
|
37183
|
-
"fieldName": "validationMessage",
|
37184
|
-
"inheritedFrom": {
|
37185
|
-
"name": "FormInternalsMixin",
|
37186
|
-
"module": "src/utils/mixins/FormInternalsMixin.ts"
|
37187
|
-
}
|
37188
|
-
},
|
37189
|
-
{
|
37190
|
-
"name": "data-aria-label",
|
37191
|
-
"type": {
|
37192
|
-
"text": "string | null"
|
37193
|
-
},
|
37194
|
-
"default": "null",
|
37195
|
-
"description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
|
37196
|
-
"fieldName": "dataAriaLabel",
|
37197
|
-
"inheritedFrom": {
|
37198
|
-
"name": "DataAriaLabelMixin",
|
37199
|
-
"module": "src/utils/mixins/DataAriaLabelMixin.ts"
|
37200
|
-
}
|
37201
|
-
},
|
37202
|
-
{
|
37203
|
-
"name": "disabled",
|
37204
|
-
"type": {
|
37205
|
-
"text": "boolean | undefined"
|
37206
|
-
},
|
37207
|
-
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
37208
|
-
"default": "undefined",
|
37209
|
-
"fieldName": "disabled",
|
37210
|
-
"inheritedFrom": {
|
37211
|
-
"name": "FormfieldWrapper",
|
37212
|
-
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
37213
|
-
}
|
37214
|
-
},
|
37215
|
-
{
|
37216
|
-
"name": "label",
|
37217
|
-
"type": {
|
37218
|
-
"text": "string | undefined"
|
37219
|
-
},
|
37220
|
-
"description": "The label of the input field. It is linked to the input field using the `for` attribute.",
|
37221
|
-
"fieldName": "label",
|
37222
|
-
"inheritedFrom": {
|
37223
|
-
"name": "FormfieldWrapper",
|
37224
|
-
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
37225
|
-
}
|
37226
|
-
},
|
37227
|
-
{
|
37228
|
-
"name": "required",
|
37464
|
+
"name": "variant",
|
37229
37465
|
"type": {
|
37230
|
-
"text": "
|
37466
|
+
"text": "ToastVariant"
|
37231
37467
|
},
|
37232
|
-
"
|
37233
|
-
"
|
37234
|
-
"fieldName": "
|
37235
|
-
"inheritedFrom": {
|
37236
|
-
"name": "FormfieldWrapper",
|
37237
|
-
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
37238
|
-
}
|
37468
|
+
"description": "Type of toast\n- Can be `custom`, `success`, `warning` or `error`.",
|
37469
|
+
"default": "'custom'",
|
37470
|
+
"fieldName": "variant"
|
37239
37471
|
},
|
37240
37472
|
{
|
37241
|
-
"name": "
|
37473
|
+
"name": "close-button-aria-label",
|
37242
37474
|
"type": {
|
37243
|
-
"text": "string"
|
37475
|
+
"text": "string | undefined"
|
37244
37476
|
},
|
37245
|
-
"
|
37246
|
-
"
|
37247
|
-
"fieldName": "id",
|
37248
|
-
"inheritedFrom": {
|
37249
|
-
"name": "FormfieldWrapper",
|
37250
|
-
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
37251
|
-
}
|
37477
|
+
"description": "Defines aria-label attribute for close button accessibility",
|
37478
|
+
"fieldName": "closeButtonAriaLabel"
|
37252
37479
|
},
|
37253
37480
|
{
|
37254
|
-
"name": "
|
37481
|
+
"name": "header-text",
|
37255
37482
|
"type": {
|
37256
|
-
"text": "
|
37483
|
+
"text": "string | undefined"
|
37257
37484
|
},
|
37258
|
-
"description": "
|
37259
|
-
"fieldName": "
|
37260
|
-
"inheritedFrom": {
|
37261
|
-
"name": "FormfieldWrapper",
|
37262
|
-
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
37263
|
-
}
|
37485
|
+
"description": "Defines a string value to display as the title of the toast",
|
37486
|
+
"fieldName": "headerText"
|
37264
37487
|
},
|
37265
37488
|
{
|
37266
|
-
"name": "
|
37489
|
+
"name": "header-tag-name",
|
37267
37490
|
"type": {
|
37268
|
-
"text": "
|
37491
|
+
"text": "TagName"
|
37269
37492
|
},
|
37270
|
-
"description": "The
|
37271
|
-
"
|
37272
|
-
"
|
37273
|
-
"name": "FormfieldWrapper",
|
37274
|
-
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
37275
|
-
}
|
37493
|
+
"description": "The html tag to be used for the header text",
|
37494
|
+
"default": "'h2'",
|
37495
|
+
"fieldName": "headerTagName"
|
37276
37496
|
},
|
37277
37497
|
{
|
37278
|
-
"name": "
|
37498
|
+
"name": "aria-label",
|
37279
37499
|
"type": {
|
37280
|
-
"text": "string |
|
37500
|
+
"text": "string | null"
|
37281
37501
|
},
|
37282
|
-
"
|
37283
|
-
"
|
37284
|
-
"
|
37285
|
-
"name": "FormfieldWrapper",
|
37286
|
-
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
37287
|
-
}
|
37502
|
+
"default": "null",
|
37503
|
+
"description": "Defines aria-label attribute when header is not used",
|
37504
|
+
"fieldName": "ariaLabel"
|
37288
37505
|
},
|
37289
37506
|
{
|
37290
|
-
"name": "
|
37507
|
+
"name": "show-more-text",
|
37291
37508
|
"type": {
|
37292
|
-
"text": "
|
37509
|
+
"text": "string | undefined"
|
37293
37510
|
},
|
37294
|
-
"description": "
|
37295
|
-
"
|
37296
|
-
"fieldName": "toggletipPlacement",
|
37297
|
-
"inheritedFrom": {
|
37298
|
-
"name": "FormfieldWrapper",
|
37299
|
-
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
37300
|
-
}
|
37511
|
+
"description": "Defines the text shown on the linkbutton when detailed content is hidden.",
|
37512
|
+
"fieldName": "showMoreText"
|
37301
37513
|
},
|
37302
37514
|
{
|
37303
|
-
"name": "
|
37515
|
+
"name": "show-less-text",
|
37304
37516
|
"type": {
|
37305
37517
|
"text": "string | undefined"
|
37306
37518
|
},
|
37307
|
-
"description": "
|
37308
|
-
"fieldName": "
|
37309
|
-
"inheritedFrom": {
|
37310
|
-
"name": "FormfieldWrapper",
|
37311
|
-
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
37312
|
-
}
|
37519
|
+
"description": "Defines the text shown on the linkbutton when detailed content is visible.",
|
37520
|
+
"fieldName": "showLessText"
|
37313
37521
|
}
|
37314
37522
|
],
|
37315
37523
|
"mixins": [
|
37316
37524
|
{
|
37317
|
-
"name": "
|
37318
|
-
"module": "/src/utils/mixins/
|
37319
|
-
},
|
37320
|
-
{
|
37321
|
-
"name": "DataAriaLabelMixin",
|
37322
|
-
"module": "/src/utils/mixins/DataAriaLabelMixin"
|
37525
|
+
"name": "FooterMixin",
|
37526
|
+
"module": "/src/utils/mixins/FooterMixin"
|
37323
37527
|
}
|
37324
37528
|
],
|
37325
37529
|
"superclass": {
|
37326
|
-
"name": "
|
37327
|
-
"module": "/src/
|
37530
|
+
"name": "Component",
|
37531
|
+
"module": "/src/models"
|
37328
37532
|
},
|
37329
|
-
"tagName": "mdc-
|
37330
|
-
"jsDoc": "/**\n *
|
37533
|
+
"tagName": "mdc-toast",
|
37534
|
+
"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 */",
|
37331
37535
|
"customElement": true
|
37332
37536
|
}
|
37333
37537
|
],
|
@@ -37336,284 +37540,179 @@
|
|
37336
37540
|
"kind": "js",
|
37337
37541
|
"name": "default",
|
37338
37542
|
"declaration": {
|
37339
|
-
"name": "
|
37340
|
-
"module": "components/
|
37543
|
+
"name": "Toast",
|
37544
|
+
"module": "components/toast/toast.component.js"
|
37341
37545
|
}
|
37342
37546
|
}
|
37343
37547
|
]
|
37344
37548
|
},
|
37345
37549
|
{
|
37346
37550
|
"kind": "javascript-module",
|
37347
|
-
"path": "components/
|
37551
|
+
"path": "components/toggle/toggle.component.js",
|
37348
37552
|
"declarations": [
|
37349
37553
|
{
|
37350
37554
|
"kind": "class",
|
37351
|
-
"description": "
|
37352
|
-
"name": "
|
37555
|
+
"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.",
|
37556
|
+
"name": "Toggle",
|
37353
37557
|
"cssProperties": [
|
37354
37558
|
{
|
37355
|
-
"description": "
|
37356
|
-
"name": "--mdc-
|
37357
|
-
},
|
37358
|
-
{
|
37359
|
-
"description": "Text color for the textarea field when disabled",
|
37360
|
-
"name": "--mdc-textarea-disabled-text-color"
|
37361
|
-
},
|
37362
|
-
{
|
37363
|
-
"description": "Background color for the textarea field when disabled",
|
37364
|
-
"name": "--mdc-textarea-disabled-background-color"
|
37365
|
-
},
|
37366
|
-
{
|
37367
|
-
"description": "Text color for the textarea field",
|
37368
|
-
"name": "--mdc-textarea-text-color"
|
37369
|
-
},
|
37370
|
-
{
|
37371
|
-
"description": "Background color for the textarea field",
|
37372
|
-
"name": "--mdc-textarea-background-color"
|
37373
|
-
},
|
37374
|
-
{
|
37375
|
-
"description": "Border color for the textarea field",
|
37376
|
-
"name": "--mdc-textarea-border-color"
|
37377
|
-
},
|
37378
|
-
{
|
37379
|
-
"description": "Text color for the character counter",
|
37380
|
-
"name": "--mdc-textarea-text-secondary-normal"
|
37381
|
-
},
|
37382
|
-
{
|
37383
|
-
"description": "Border color for the error related help text",
|
37384
|
-
"name": "--mdc-textarea-error-border-color"
|
37385
|
-
},
|
37386
|
-
{
|
37387
|
-
"description": "Border color for the warning related help text",
|
37388
|
-
"name": "--mdc-textarea-warning-border-color"
|
37389
|
-
},
|
37390
|
-
{
|
37391
|
-
"description": "Border color for the success related help text",
|
37392
|
-
"name": "--mdc-textarea-success-border-color"
|
37393
|
-
},
|
37394
|
-
{
|
37395
|
-
"description": "Border color for the priority related help text",
|
37396
|
-
"name": "--mdc-textarea-primary-border-color"
|
37397
|
-
},
|
37398
|
-
{
|
37399
|
-
"description": "Background color for the textarea container when hover",
|
37400
|
-
"name": "--mdc-textarea-hover-background-color"
|
37401
|
-
},
|
37402
|
-
{
|
37403
|
-
"description": "Background color for the textarea container when focused",
|
37404
|
-
"name": "--mdc-textarea-focused-background-color"
|
37559
|
+
"description": "Width of the toggle",
|
37560
|
+
"name": "--mdc-toggle-width"
|
37405
37561
|
},
|
37406
37562
|
{
|
37407
|
-
"description": "
|
37408
|
-
"name": "--mdc-
|
37409
|
-
}
|
37410
|
-
],
|
37411
|
-
"members": [
|
37412
|
-
{
|
37413
|
-
"kind": "field",
|
37414
|
-
"name": "placeholder",
|
37415
|
-
"type": {
|
37416
|
-
"text": "string | undefined"
|
37417
|
-
},
|
37418
|
-
"description": "The placeholder text that is displayed when the textarea field is empty.",
|
37419
|
-
"attribute": "placeholder"
|
37563
|
+
"description": "Height of the toggle",
|
37564
|
+
"name": "--mdc-toggle-height"
|
37420
37565
|
},
|
37421
37566
|
{
|
37422
|
-
"
|
37423
|
-
"name": "
|
37424
|
-
"type": {
|
37425
|
-
"text": "boolean"
|
37426
|
-
},
|
37427
|
-
"default": "false",
|
37428
|
-
"description": "readonly attribute of the textarea field. If true, the textarea field is read-only.",
|
37429
|
-
"attribute": "readonly"
|
37567
|
+
"description": "Width of the toggle when it's size is compact",
|
37568
|
+
"name": "--mdc-toggle-width-compact"
|
37430
37569
|
},
|
37431
37570
|
{
|
37432
|
-
"
|
37433
|
-
"name": "
|
37434
|
-
"type": {
|
37435
|
-
"text": "number | undefined"
|
37436
|
-
},
|
37437
|
-
"description": "The rows attribute specifies the visible number of lines in a text area.",
|
37438
|
-
"default": "5",
|
37439
|
-
"attribute": "rows"
|
37571
|
+
"description": "Height of the toggle when it's size is compact",
|
37572
|
+
"name": "--mdc-toggle-height-compact"
|
37440
37573
|
},
|
37441
37574
|
{
|
37442
|
-
"
|
37443
|
-
"name": "
|
37444
|
-
"type": {
|
37445
|
-
"text": "number | undefined"
|
37446
|
-
},
|
37447
|
-
"description": "The cols attribute specifies the visible number of lines in a text area.",
|
37448
|
-
"default": "40",
|
37449
|
-
"attribute": "cols"
|
37575
|
+
"description": "Line height of the toggle label",
|
37576
|
+
"name": "--mdc-toggle-label-lineheight"
|
37450
37577
|
},
|
37451
37578
|
{
|
37452
|
-
"
|
37453
|
-
"name": "
|
37454
|
-
"type": {
|
37455
|
-
"text": "WrapType"
|
37456
|
-
},
|
37457
|
-
"description": "The wrap attribute specifies how the text in a text area is to be wrapped when submitted in a form.",
|
37458
|
-
"default": "'soft'",
|
37459
|
-
"attribute": "wrap"
|
37579
|
+
"description": "Font size of the toggle label",
|
37580
|
+
"name": "--mdc-toggle-label-fontsize"
|
37460
37581
|
},
|
37461
37582
|
{
|
37462
|
-
"
|
37463
|
-
"name": "
|
37464
|
-
"type": {
|
37465
|
-
"text": "AutoCapitalizeType"
|
37466
|
-
},
|
37467
|
-
"description": "The autocapitalize attribute of the textarea field.",
|
37468
|
-
"default": "'off'",
|
37469
|
-
"attribute": "autocapitalize"
|
37583
|
+
"description": "Font weight of the toggle label",
|
37584
|
+
"name": "--mdc-toggle-label-fontweight"
|
37470
37585
|
},
|
37471
37586
|
{
|
37472
|
-
"
|
37473
|
-
"name": "
|
37474
|
-
"type": {
|
37475
|
-
"text": "AutoCompleteType"
|
37476
|
-
},
|
37477
|
-
"description": "The autocomplete attribute of the textarea field.",
|
37478
|
-
"default": "'off'",
|
37479
|
-
"attribute": "autocomplete"
|
37587
|
+
"description": "Color of the toggle label and help text in disabled state",
|
37588
|
+
"name": "--mdc-toggle-label-color-disabled"
|
37480
37589
|
},
|
37481
37590
|
{
|
37482
|
-
"
|
37483
|
-
"name": "
|
37484
|
-
"type": {
|
37485
|
-
"text": "boolean"
|
37486
|
-
},
|
37487
|
-
"default": "false",
|
37488
|
-
"description": "If true, the textarea field is focused when the component is rendered.",
|
37489
|
-
"attribute": "autofocus"
|
37591
|
+
"description": "Color of the help text label",
|
37592
|
+
"name": "--mdc-toggle-help-text-color"
|
37490
37593
|
},
|
37491
|
-
{
|
37492
|
-
"
|
37493
|
-
"name": "
|
37494
|
-
"type": {
|
37495
|
-
"text": "string | undefined"
|
37496
|
-
},
|
37497
|
-
"description": "Specifies the name of the directionality of text for submission purposes (e.g., \"rtl\" for right-to-left).",
|
37498
|
-
"attribute": "dirname"
|
37594
|
+
{
|
37595
|
+
"description": "Background color of the active toggle in hover state",
|
37596
|
+
"name": "--mdc-toggle-active-hover-color"
|
37499
37597
|
},
|
37500
37598
|
{
|
37501
|
-
"
|
37502
|
-
"name": "
|
37503
|
-
"type": {
|
37504
|
-
"text": "number | undefined"
|
37505
|
-
},
|
37506
|
-
"description": "The maximum number of characters that the textarea field can accept.",
|
37507
|
-
"attribute": "maxlength"
|
37599
|
+
"description": "Background color of the active toggle in pressed state",
|
37600
|
+
"name": "--mdc-toggle-active-pressed-color"
|
37508
37601
|
},
|
37509
37602
|
{
|
37510
|
-
"
|
37511
|
-
"name": "
|
37512
|
-
"type": {
|
37513
|
-
"text": "number | undefined"
|
37514
|
-
},
|
37515
|
-
"description": "The minimum number of characters that the textarea field can accept.",
|
37516
|
-
"attribute": "minlength"
|
37603
|
+
"description": "Background color of the inactive toggle in hover state",
|
37604
|
+
"name": "--mdc-toggle-inactive-hover-color"
|
37517
37605
|
},
|
37606
|
+
{
|
37607
|
+
"description": "Background color of the inactive toggle in pressed state",
|
37608
|
+
"name": "--mdc-toggle-inactive-pressed-color"
|
37609
|
+
}
|
37610
|
+
],
|
37611
|
+
"members": [
|
37518
37612
|
{
|
37519
37613
|
"kind": "field",
|
37520
|
-
"name": "
|
37614
|
+
"name": "checked",
|
37521
37615
|
"type": {
|
37522
|
-
"text": "
|
37616
|
+
"text": "boolean"
|
37523
37617
|
},
|
37524
|
-
"
|
37525
|
-
"
|
37618
|
+
"default": "false",
|
37619
|
+
"description": "Determines whether the toggle is active or inactive.",
|
37620
|
+
"attribute": "checked",
|
37621
|
+
"reflects": true
|
37526
37622
|
},
|
37527
37623
|
{
|
37528
37624
|
"kind": "field",
|
37529
|
-
"name": "
|
37625
|
+
"name": "size",
|
37530
37626
|
"type": {
|
37531
|
-
"text": "
|
37627
|
+
"text": "ToggleSize"
|
37532
37628
|
},
|
37533
|
-
"
|
37534
|
-
"default": "
|
37629
|
+
"description": "Determines toggle size in rem (height is specified here).\n- **Default**: 1.5\n- **Compact**: 1",
|
37630
|
+
"default": "default",
|
37631
|
+
"attribute": "size",
|
37632
|
+
"reflects": true
|
37535
37633
|
},
|
37536
37634
|
{
|
37537
37635
|
"kind": "field",
|
37538
|
-
"name": "
|
37636
|
+
"name": "autofocus",
|
37539
37637
|
"type": {
|
37540
|
-
"text": "
|
37638
|
+
"text": "boolean"
|
37541
37639
|
},
|
37542
|
-
"
|
37543
|
-
"
|
37544
|
-
|
37545
|
-
|
37546
|
-
"kind": "method",
|
37547
|
-
"name": "setTextareaValidity",
|
37548
|
-
"privacy": "private"
|
37640
|
+
"default": "false",
|
37641
|
+
"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)",
|
37642
|
+
"attribute": "autofocus",
|
37643
|
+
"reflects": true
|
37549
37644
|
},
|
37550
37645
|
{
|
37551
37646
|
"kind": "method",
|
37552
|
-
"name": "
|
37553
|
-
"
|
37554
|
-
"
|
37555
|
-
"type": {
|
37556
|
-
"text": ""
|
37557
|
-
}
|
37558
|
-
}
|
37647
|
+
"name": "manageRequired",
|
37648
|
+
"privacy": "private",
|
37649
|
+
"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."
|
37559
37650
|
},
|
37560
37651
|
{
|
37561
37652
|
"kind": "method",
|
37562
|
-
"name": "
|
37653
|
+
"name": "setFormValue",
|
37563
37654
|
"privacy": "private",
|
37564
|
-
"description": "
|
37565
|
-
"return": {
|
37566
|
-
"type": {
|
37567
|
-
"text": ""
|
37568
|
-
}
|
37569
|
-
}
|
37655
|
+
"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."
|
37570
37656
|
},
|
37571
37657
|
{
|
37572
37658
|
"kind": "method",
|
37573
|
-
"name": "
|
37659
|
+
"name": "toggleState",
|
37574
37660
|
"privacy": "private",
|
37575
|
-
"description": "Handles the character overflow state change.\nDispatches the character overflow state change event if the character limit is exceeded or restored.",
|
37576
37661
|
"return": {
|
37577
37662
|
"type": {
|
37578
|
-
"text": ""
|
37663
|
+
"text": "void"
|
37579
37664
|
}
|
37580
|
-
}
|
37665
|
+
},
|
37666
|
+
"description": "Toggles the state of the toggle element.\nIf the element is not disabled, then the checked property is toggled."
|
37581
37667
|
},
|
37582
37668
|
{
|
37583
37669
|
"kind": "method",
|
37584
|
-
"name": "
|
37670
|
+
"name": "handleKeyDown",
|
37585
37671
|
"privacy": "private",
|
37586
|
-
"description": "Updates the value of the textarea field.\nSets the form value.",
|
37587
37672
|
"return": {
|
37588
37673
|
"type": {
|
37589
|
-
"text": ""
|
37674
|
+
"text": "void"
|
37590
37675
|
}
|
37591
|
-
}
|
37676
|
+
},
|
37677
|
+
"parameters": [
|
37678
|
+
{
|
37679
|
+
"name": "event",
|
37680
|
+
"type": {
|
37681
|
+
"text": "KeyboardEvent"
|
37682
|
+
},
|
37683
|
+
"description": "The keyboard event."
|
37684
|
+
}
|
37685
|
+
],
|
37686
|
+
"description": "Handles the keydown event on the toggle element.\nWhen the user presses Enter, the form is submitted."
|
37592
37687
|
},
|
37593
37688
|
{
|
37594
37689
|
"kind": "method",
|
37595
|
-
"name": "
|
37690
|
+
"name": "handleChange",
|
37596
37691
|
"privacy": "private",
|
37597
37692
|
"parameters": [
|
37598
37693
|
{
|
37599
37694
|
"name": "event",
|
37600
37695
|
"type": {
|
37601
37696
|
"text": "Event"
|
37602
|
-
}
|
37603
|
-
"description": "Event which contains information about the value change."
|
37697
|
+
}
|
37604
37698
|
}
|
37605
37699
|
],
|
37606
|
-
"description": "
|
37607
|
-
},
|
37608
|
-
{
|
37609
|
-
"kind": "method",
|
37610
|
-
"name": "renderCharacterCounter",
|
37611
|
-
"privacy": "protected"
|
37700
|
+
"description": "Toggles the state of the toggle element.\nand dispatch the new change event."
|
37612
37701
|
},
|
37613
37702
|
{
|
37614
37703
|
"kind": "method",
|
37615
|
-
"name": "
|
37616
|
-
"privacy": "
|
37704
|
+
"name": "setToggleSize",
|
37705
|
+
"privacy": "private",
|
37706
|
+
"parameters": [
|
37707
|
+
{
|
37708
|
+
"name": "size",
|
37709
|
+
"type": {
|
37710
|
+
"text": "ToggleSize"
|
37711
|
+
},
|
37712
|
+
"description": "The size to set."
|
37713
|
+
}
|
37714
|
+
],
|
37715
|
+
"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."
|
37617
37716
|
},
|
37618
37717
|
{
|
37619
37718
|
"kind": "field",
|
@@ -37936,102 +38035,40 @@
|
|
37936
38035
|
}
|
37937
38036
|
],
|
37938
38037
|
"events": [
|
37939
|
-
{
|
37940
|
-
"name": "limitexceeded",
|
37941
|
-
"type": {
|
37942
|
-
"text": "CustomEvent"
|
37943
|
-
},
|
37944
|
-
"description": "(React: onLimitExceeded) This event is dispatched once when the character limit exceeds or restored.",
|
37945
|
-
"reactName": "onLimitExceeded"
|
37946
|
-
},
|
37947
38038
|
{
|
37948
38039
|
"type": {
|
37949
38040
|
"text": "EventConstructor"
|
37950
38041
|
}
|
37951
38042
|
},
|
37952
38043
|
{
|
37953
|
-
"description": "(React:
|
37954
|
-
"name": "input",
|
37955
|
-
"reactName": "onInput"
|
37956
|
-
},
|
37957
|
-
{
|
37958
|
-
"description": "(React: onChange) This event is dispatched when the value of the textarea field changes (on blur).",
|
38044
|
+
"description": "(React: onChange) Event that gets dispatched when the toggle state changes.",
|
37959
38045
|
"name": "change",
|
37960
38046
|
"reactName": "onChange"
|
37961
38047
|
},
|
37962
38048
|
{
|
37963
|
-
"description": "(React: onFocus)
|
38049
|
+
"description": "(React: onFocus) Event that gets dispatched when the toggle receives focus.",
|
37964
38050
|
"name": "focus",
|
37965
38051
|
"reactName": "onFocus"
|
37966
|
-
},
|
37967
|
-
{
|
37968
|
-
"description": "(React: onBlur) This event is dispatched when the textarea loses focus.",
|
37969
|
-
"name": "blur",
|
37970
|
-
"reactName": "onBlur"
|
37971
38052
|
}
|
37972
38053
|
],
|
37973
38054
|
"attributes": [
|
37974
38055
|
{
|
37975
|
-
"name": "
|
37976
|
-
"type": {
|
37977
|
-
"text": "string | undefined"
|
37978
|
-
},
|
37979
|
-
"description": "The placeholder text that is displayed when the textarea field is empty.",
|
37980
|
-
"fieldName": "placeholder"
|
37981
|
-
},
|
37982
|
-
{
|
37983
|
-
"name": "readonly",
|
38056
|
+
"name": "checked",
|
37984
38057
|
"type": {
|
37985
38058
|
"text": "boolean"
|
37986
38059
|
},
|
37987
38060
|
"default": "false",
|
37988
|
-
"description": "
|
37989
|
-
"fieldName": "
|
37990
|
-
},
|
37991
|
-
{
|
37992
|
-
"name": "rows",
|
37993
|
-
"type": {
|
37994
|
-
"text": "number | undefined"
|
37995
|
-
},
|
37996
|
-
"description": "The rows attribute specifies the visible number of lines in a text area.",
|
37997
|
-
"default": "5",
|
37998
|
-
"fieldName": "rows"
|
37999
|
-
},
|
38000
|
-
{
|
38001
|
-
"name": "cols",
|
38002
|
-
"type": {
|
38003
|
-
"text": "number | undefined"
|
38004
|
-
},
|
38005
|
-
"description": "The cols attribute specifies the visible number of lines in a text area.",
|
38006
|
-
"default": "40",
|
38007
|
-
"fieldName": "cols"
|
38008
|
-
},
|
38009
|
-
{
|
38010
|
-
"name": "wrap",
|
38011
|
-
"type": {
|
38012
|
-
"text": "WrapType"
|
38013
|
-
},
|
38014
|
-
"description": "The wrap attribute specifies how the text in a text area is to be wrapped when submitted in a form.",
|
38015
|
-
"default": "'soft'",
|
38016
|
-
"fieldName": "wrap"
|
38017
|
-
},
|
38018
|
-
{
|
38019
|
-
"name": "autocapitalize",
|
38020
|
-
"type": {
|
38021
|
-
"text": "AutoCapitalizeType"
|
38022
|
-
},
|
38023
|
-
"description": "The autocapitalize attribute of the textarea field.",
|
38024
|
-
"default": "'off'",
|
38025
|
-
"fieldName": "autocapitalize"
|
38061
|
+
"description": "Determines whether the toggle is active or inactive.",
|
38062
|
+
"fieldName": "checked"
|
38026
38063
|
},
|
38027
38064
|
{
|
38028
|
-
"name": "
|
38065
|
+
"name": "size",
|
38029
38066
|
"type": {
|
38030
|
-
"text": "
|
38067
|
+
"text": "ToggleSize"
|
38031
38068
|
},
|
38032
|
-
"description": "
|
38033
|
-
"default": "
|
38034
|
-
"fieldName": "
|
38069
|
+
"description": "Determines toggle size in rem (height is specified here).\n- **Default**: 1.5\n- **Compact**: 1",
|
38070
|
+
"default": "default",
|
38071
|
+
"fieldName": "size"
|
38035
38072
|
},
|
38036
38073
|
{
|
38037
38074
|
"name": "autofocus",
|
@@ -38039,41 +38076,9 @@
|
|
38039
38076
|
"text": "boolean"
|
38040
38077
|
},
|
38041
38078
|
"default": "false",
|
38042
|
-
"description": "
|
38079
|
+
"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)",
|
38043
38080
|
"fieldName": "autofocus"
|
38044
38081
|
},
|
38045
|
-
{
|
38046
|
-
"name": "dirname",
|
38047
|
-
"type": {
|
38048
|
-
"text": "string | undefined"
|
38049
|
-
},
|
38050
|
-
"description": "Specifies the name of the directionality of text for submission purposes (e.g., \"rtl\" for right-to-left).",
|
38051
|
-
"fieldName": "dirname"
|
38052
|
-
},
|
38053
|
-
{
|
38054
|
-
"name": "maxlength",
|
38055
|
-
"type": {
|
38056
|
-
"text": "number | undefined"
|
38057
|
-
},
|
38058
|
-
"description": "The maximum number of characters that the textarea field can accept.",
|
38059
|
-
"fieldName": "maxlength"
|
38060
|
-
},
|
38061
|
-
{
|
38062
|
-
"name": "minlength",
|
38063
|
-
"type": {
|
38064
|
-
"text": "number | undefined"
|
38065
|
-
},
|
38066
|
-
"description": "The minimum number of characters that the textarea field can accept.",
|
38067
|
-
"fieldName": "minlength"
|
38068
|
-
},
|
38069
|
-
{
|
38070
|
-
"name": "max-character-limit",
|
38071
|
-
"type": {
|
38072
|
-
"text": "number | undefined"
|
38073
|
-
},
|
38074
|
-
"description": "maximum character limit for the textarea field for character counter.",
|
38075
|
-
"fieldName": "maxCharacterLimit"
|
38076
|
-
},
|
38077
38082
|
{
|
38078
38083
|
"name": "name",
|
38079
38084
|
"type": {
|
@@ -38252,8 +38257,8 @@
|
|
38252
38257
|
"name": "FormfieldWrapper",
|
38253
38258
|
"module": "/src/components/formfieldwrapper"
|
38254
38259
|
},
|
38255
|
-
"tagName": "mdc-
|
38256
|
-
"jsDoc": "/**\n *
|
38260
|
+
"tagName": "mdc-toggle",
|
38261
|
+
"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 */",
|
38257
38262
|
"customElement": true
|
38258
38263
|
}
|
38259
38264
|
],
|
@@ -38262,8 +38267,8 @@
|
|
38262
38267
|
"kind": "js",
|
38263
38268
|
"name": "default",
|
38264
38269
|
"declaration": {
|
38265
|
-
"name": "
|
38266
|
-
"module": "components/
|
38270
|
+
"name": "Toggle",
|
38271
|
+
"module": "components/toggle/toggle.component.js"
|
38267
38272
|
}
|
38268
38273
|
}
|
38269
38274
|
]
|