@momentum-design/components 0.120.8 → 0.120.9

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.
@@ -17414,254 +17414,6 @@
17414
17414
  }
17415
17415
  ]
17416
17416
  },
17417
- {
17418
- "kind": "javascript-module",
17419
- "path": "components/icon/icon.component.js",
17420
- "declarations": [
17421
- {
17422
- "kind": "class",
17423
- "description": "Icon component that dynamically displays SVG icons based on a valid name.\n\nThis component must be mounted within an `IconProvider` component.\n\nThe `IconProvider` defines the source URL from which icons are consumed.\nThe `Icon` component accepts a `name` attribute, which corresponds to\nthe file name of the icon to be loaded from the specified URL.\n\nOnce fetched, the icon will be rendered. If the fetching process is unsuccessful,\nno icon will be displayed.\n\nThe `size` attribute allows for dynamic sizing of the icon based on the provided\n`length-unit` attribute. This unit can either come from the `IconProvider`\nor can be overridden for each individual icon. For example:\nif `size = 1` and `length-unit = 'em'`, the dimensions of the icon will be\n`width: 1em; height: 1em`.\n\nRegarding accessibility, there are three types of icons: decorative, informative and informative standalone.\n\n### Decorative Icons\n- Decorative icons do not convey any essential information to the content of a page.\n- They should be hidden from screen readers (SR) to prevent confusion for users.\n- For decorative icons, an `aria-label` is not required, and the `role` will be set to null.\n\n### Informative Icons\n- Informative icons convey important information that is not adequately represented\n by surrounding text or components.\n- They provide valuable context and must be announced by assistive technologies.\n- For informative icons, an `aria-label` is required, and the `role` will be set to \"img\" automatically.\n- If an `aria-label` is provided, the role will be set to 'img'; if it is absent,\n the role will be unset.\n\n### Informative Standalone Icons\n- If an icon is informative (as mentioned above) and does not belong to a button (=standalone), it must\nhave a Tooltip that describes what it means.\n- For informative standalone icons, an `aria-label` & `tabindex=\"0\"` is required,\nand the `role` will be set to \"img\" automatically.\n- **Only use this when a Icon is standalone and is not part of a button or other interactive elements.**",
17424
- "name": "Icon",
17425
- "cssProperties": [
17426
- {
17427
- "description": "Allows customization of the default fill color.",
17428
- "name": "--mdc-icon-fill-color"
17429
- },
17430
- {
17431
- "description": "Allows customization of the icon size.",
17432
- "name": "--mdc-icon-size"
17433
- },
17434
- {
17435
- "description": "Allows customization of the icon border radius.",
17436
- "name": "--mdc-icon-border-radius"
17437
- }
17438
- ],
17439
- "cssParts": [
17440
- {
17441
- "description": "The svg inside the icon element.",
17442
- "name": "icon"
17443
- }
17444
- ],
17445
- "members": [
17446
- {
17447
- "kind": "field",
17448
- "name": "iconData",
17449
- "type": {
17450
- "text": "HTMLElement | undefined"
17451
- },
17452
- "privacy": "private"
17453
- },
17454
- {
17455
- "kind": "field",
17456
- "name": "lengthUnitFromContext",
17457
- "type": {
17458
- "text": "string | undefined"
17459
- },
17460
- "privacy": "private"
17461
- },
17462
- {
17463
- "kind": "field",
17464
- "name": "sizeFromContext",
17465
- "type": {
17466
- "text": "number | undefined"
17467
- },
17468
- "privacy": "private"
17469
- },
17470
- {
17471
- "kind": "field",
17472
- "name": "name",
17473
- "type": {
17474
- "text": "IconNames | undefined"
17475
- },
17476
- "description": "Name of the icon (= filename)",
17477
- "attribute": "name",
17478
- "reflects": true
17479
- },
17480
- {
17481
- "kind": "field",
17482
- "name": "size",
17483
- "type": {
17484
- "text": "number | undefined"
17485
- },
17486
- "description": "Size of the icon (works in combination with length unit)",
17487
- "attribute": "size"
17488
- },
17489
- {
17490
- "kind": "field",
17491
- "name": "lengthUnit",
17492
- "type": {
17493
- "text": "string | undefined"
17494
- },
17495
- "description": "Length unit attribute for overriding length-unit from `IconProvider`",
17496
- "attribute": "length-unit"
17497
- },
17498
- {
17499
- "kind": "field",
17500
- "name": "ariaLabel",
17501
- "type": {
17502
- "text": "string | null"
17503
- },
17504
- "default": "null",
17505
- "description": "Aria-label attribute to be set for accessibility",
17506
- "attribute": "aria-label"
17507
- },
17508
- {
17509
- "kind": "field",
17510
- "name": "ariaLabelledBy",
17511
- "type": {
17512
- "text": "string | null"
17513
- },
17514
- "default": "null",
17515
- "description": "Aria-labelledby attribute to be set for accessibility",
17516
- "attribute": "aria-labelledby"
17517
- },
17518
- {
17519
- "kind": "field",
17520
- "name": "iconProviderContext",
17521
- "privacy": "private",
17522
- "readonly": true
17523
- },
17524
- {
17525
- "kind": "field",
17526
- "name": "abortController",
17527
- "type": {
17528
- "text": "AbortController | undefined"
17529
- },
17530
- "privacy": "private",
17531
- "default": "new AbortController()"
17532
- },
17533
- {
17534
- "kind": "method",
17535
- "name": "prepareIconElement",
17536
- "privacy": "private",
17537
- "parameters": [
17538
- {
17539
- "name": "iconData",
17540
- "type": {
17541
- "text": "string"
17542
- },
17543
- "description": "The icon string to be parsed"
17544
- }
17545
- ],
17546
- "description": "Parse the icon string to an html element, set the attributes and\nreturn the icon element",
17547
- "return": {
17548
- "type": {
17549
- "text": ""
17550
- }
17551
- }
17552
- },
17553
- {
17554
- "kind": "method",
17555
- "name": "getIconData",
17556
- "privacy": "private",
17557
- "description": "Fetches the icon (currently only svg) and sets state and attributes once fetched successfully\n\nThis method uses abortController.signal to cancel the fetch request when the component is disconnected or updated.\nIf the request is aborted after the fetch() call has been fulfilled but before the response body has been read,\nthen attempting to read the response body will reject with an AbortError exception."
17558
- },
17559
- {
17560
- "kind": "method",
17561
- "name": "handleIconLoadedSuccess",
17562
- "privacy": "private",
17563
- "parameters": [
17564
- {
17565
- "name": "iconHtml",
17566
- "type": {
17567
- "text": "HTMLElement"
17568
- },
17569
- "description": "The icon html element which has been fetched from the icon provider."
17570
- }
17571
- ],
17572
- "description": "Sets the iconData state to the fetched icon.\nDispatches a 'load' event on the component once the icon has been successfully loaded."
17573
- },
17574
- {
17575
- "kind": "method",
17576
- "name": "handleIconLoadedFailure",
17577
- "privacy": "private",
17578
- "parameters": [
17579
- {
17580
- "name": "error",
17581
- "type": {
17582
- "text": "unknown"
17583
- }
17584
- }
17585
- ],
17586
- "description": "Dispatches an 'error' event on the component when the icon fetching has failed.\nThis event bubbles and is cancelable.\nThe error detail is set to the error object."
17587
- },
17588
- {
17589
- "kind": "method",
17590
- "name": "updateSize",
17591
- "privacy": "private",
17592
- "description": "Updates the size by setting the width and height"
17593
- },
17594
- {
17595
- "kind": "field",
17596
- "name": "computedIconSize",
17597
- "privacy": "private",
17598
- "readonly": true
17599
- }
17600
- ],
17601
- "attributes": [
17602
- {
17603
- "name": "name",
17604
- "type": {
17605
- "text": "IconNames | undefined"
17606
- },
17607
- "description": "Name of the icon (= filename)",
17608
- "fieldName": "name"
17609
- },
17610
- {
17611
- "name": "size",
17612
- "type": {
17613
- "text": "number | undefined"
17614
- },
17615
- "description": "Size of the icon (works in combination with length unit)",
17616
- "fieldName": "size"
17617
- },
17618
- {
17619
- "name": "length-unit",
17620
- "type": {
17621
- "text": "string | undefined"
17622
- },
17623
- "description": "Length unit attribute for overriding length-unit from `IconProvider`",
17624
- "fieldName": "lengthUnit"
17625
- },
17626
- {
17627
- "name": "aria-label",
17628
- "type": {
17629
- "text": "string | null"
17630
- },
17631
- "default": "null",
17632
- "description": "Aria-label attribute to be set for accessibility",
17633
- "fieldName": "ariaLabel"
17634
- },
17635
- {
17636
- "name": "aria-labelledby",
17637
- "type": {
17638
- "text": "string | null"
17639
- },
17640
- "default": "null",
17641
- "description": "Aria-labelledby attribute to be set for accessibility",
17642
- "fieldName": "ariaLabelledBy"
17643
- }
17644
- ],
17645
- "superclass": {
17646
- "name": "Component",
17647
- "module": "/src/models"
17648
- },
17649
- "tagName": "mdc-icon",
17650
- "jsDoc": "/**\n * Icon component that dynamically displays SVG icons based on a valid name.\n *\n * This component must be mounted within an `IconProvider` component.\n *\n * The `IconProvider` defines the source URL from which icons are consumed.\n * The `Icon` component accepts a `name` attribute, which corresponds to\n * the file name of the icon to be loaded from the specified URL.\n *\n * Once fetched, the icon will be rendered. If the fetching process is unsuccessful,\n * no icon will be displayed.\n *\n * The `size` attribute allows for dynamic sizing of the icon based on the provided\n * `length-unit` attribute. This unit can either come from the `IconProvider`\n * or can be overridden for each individual icon. For example:\n * if `size = 1` and `length-unit = 'em'`, the dimensions of the icon will be\n * `width: 1em; height: 1em`.\n *\n * Regarding accessibility, there are three types of icons: decorative, informative and informative standalone.\n *\n * ### Decorative Icons\n * - Decorative icons do not convey any essential information to the content of a page.\n * - They should be hidden from screen readers (SR) to prevent confusion for users.\n * - For decorative icons, an `aria-label` is not required, and the `role` will be set to null.\n *\n * ### Informative Icons\n * - Informative icons convey important information that is not adequately represented\n * by surrounding text or components.\n * - They provide valuable context and must be announced by assistive technologies.\n * - For informative icons, an `aria-label` is required, and the `role` will be set to \"img\" automatically.\n * - If an `aria-label` is provided, the role will be set to 'img'; if it is absent,\n * the role will be unset.\n *\n * ### Informative Standalone Icons\n * - If an icon is informative (as mentioned above) and does not belong to a button (=standalone), it must\n * have a Tooltip that describes what it means.\n * - For informative standalone icons, an `aria-label` & `tabindex=\"0\"` is required,\n * and the `role` will be set to \"img\" automatically.\n * - **Only use this when a Icon is standalone and is not part of a button or other interactive elements.**\n *\n * @tagname mdc-icon\n *\n * @cssproperty --mdc-icon-fill-color - Allows customization of the default fill color.\n * @cssproperty --mdc-icon-size - Allows customization of the icon size.\n * @cssproperty --mdc-icon-border-radius - Allows customization of the icon border radius.\n *\n * @csspart icon - The svg inside the icon element.\n */",
17651
- "customElement": true
17652
- }
17653
- ],
17654
- "exports": [
17655
- {
17656
- "kind": "js",
17657
- "name": "default",
17658
- "declaration": {
17659
- "name": "Icon",
17660
- "module": "components/icon/icon.component.js"
17661
- }
17662
- }
17663
- ]
17664
- },
17665
17417
  {
17666
17418
  "kind": "javascript-module",
17667
17419
  "path": "components/iconprovider/iconprovider.component.js",
@@ -18194,16 +17946,264 @@
18194
17946
  },
18195
17947
  {
18196
17948
  "kind": "javascript-module",
18197
- "path": "components/input/input.component.js",
17949
+ "path": "components/icon/icon.component.js",
18198
17950
  "declarations": [
18199
17951
  {
18200
17952
  "kind": "class",
18201
- "description": "mdc-input is a component that allows users to input text.\n It contains:\n- label field - describe the input field.\n- input field - contains the value\n- help text or validation message - displayed below the input field.\n- trailing button - it displays a clear the input field.\n- prefix text - displayed before the input field.\n- leading icon - displayed before the input field.\n- clear-aria-label - aria label for the trailing button.\n- all the attributes of the input field.",
18202
- "name": "Input",
17953
+ "description": "Icon component that dynamically displays SVG icons based on a valid name.\n\nThis component must be mounted within an `IconProvider` component.\n\nThe `IconProvider` defines the source URL from which icons are consumed.\nThe `Icon` component accepts a `name` attribute, which corresponds to\nthe file name of the icon to be loaded from the specified URL.\n\nOnce fetched, the icon will be rendered. If the fetching process is unsuccessful,\nno icon will be displayed.\n\nThe `size` attribute allows for dynamic sizing of the icon based on the provided\n`length-unit` attribute. This unit can either come from the `IconProvider`\nor can be overridden for each individual icon. For example:\nif `size = 1` and `length-unit = 'em'`, the dimensions of the icon will be\n`width: 1em; height: 1em`.\n\nRegarding accessibility, there are three types of icons: decorative, informative and informative standalone.\n\n### Decorative Icons\n- Decorative icons do not convey any essential information to the content of a page.\n- They should be hidden from screen readers (SR) to prevent confusion for users.\n- For decorative icons, an `aria-label` is not required, and the `role` will be set to null.\n\n### Informative Icons\n- Informative icons convey important information that is not adequately represented\n by surrounding text or components.\n- They provide valuable context and must be announced by assistive technologies.\n- For informative icons, an `aria-label` is required, and the `role` will be set to \"img\" automatically.\n- If an `aria-label` is provided, the role will be set to 'img'; if it is absent,\n the role will be unset.\n\n### Informative Standalone Icons\n- If an icon is informative (as mentioned above) and does not belong to a button (=standalone), it must\nhave a Tooltip that describes what it means.\n- For informative standalone icons, an `aria-label` & `tabindex=\"0\"` is required,\nand the `role` will be set to \"img\" automatically.\n- **Only use this when a Icon is standalone and is not part of a button or other interactive elements.**",
17954
+ "name": "Icon",
18203
17955
  "cssProperties": [
18204
17956
  {
18205
- "description": "Border color for the input container when disabled",
18206
- "name": "--mdc-input-disabled-border-color"
17957
+ "description": "Allows customization of the default fill color.",
17958
+ "name": "--mdc-icon-fill-color"
17959
+ },
17960
+ {
17961
+ "description": "Allows customization of the icon size.",
17962
+ "name": "--mdc-icon-size"
17963
+ },
17964
+ {
17965
+ "description": "Allows customization of the icon border radius.",
17966
+ "name": "--mdc-icon-border-radius"
17967
+ }
17968
+ ],
17969
+ "cssParts": [
17970
+ {
17971
+ "description": "The svg inside the icon element.",
17972
+ "name": "icon"
17973
+ }
17974
+ ],
17975
+ "members": [
17976
+ {
17977
+ "kind": "field",
17978
+ "name": "iconData",
17979
+ "type": {
17980
+ "text": "HTMLElement | undefined"
17981
+ },
17982
+ "privacy": "private"
17983
+ },
17984
+ {
17985
+ "kind": "field",
17986
+ "name": "lengthUnitFromContext",
17987
+ "type": {
17988
+ "text": "string | undefined"
17989
+ },
17990
+ "privacy": "private"
17991
+ },
17992
+ {
17993
+ "kind": "field",
17994
+ "name": "sizeFromContext",
17995
+ "type": {
17996
+ "text": "number | undefined"
17997
+ },
17998
+ "privacy": "private"
17999
+ },
18000
+ {
18001
+ "kind": "field",
18002
+ "name": "name",
18003
+ "type": {
18004
+ "text": "IconNames | undefined"
18005
+ },
18006
+ "description": "Name of the icon (= filename)",
18007
+ "attribute": "name",
18008
+ "reflects": true
18009
+ },
18010
+ {
18011
+ "kind": "field",
18012
+ "name": "size",
18013
+ "type": {
18014
+ "text": "number | undefined"
18015
+ },
18016
+ "description": "Size of the icon (works in combination with length unit)",
18017
+ "attribute": "size"
18018
+ },
18019
+ {
18020
+ "kind": "field",
18021
+ "name": "lengthUnit",
18022
+ "type": {
18023
+ "text": "string | undefined"
18024
+ },
18025
+ "description": "Length unit attribute for overriding length-unit from `IconProvider`",
18026
+ "attribute": "length-unit"
18027
+ },
18028
+ {
18029
+ "kind": "field",
18030
+ "name": "ariaLabel",
18031
+ "type": {
18032
+ "text": "string | null"
18033
+ },
18034
+ "default": "null",
18035
+ "description": "Aria-label attribute to be set for accessibility",
18036
+ "attribute": "aria-label"
18037
+ },
18038
+ {
18039
+ "kind": "field",
18040
+ "name": "ariaLabelledBy",
18041
+ "type": {
18042
+ "text": "string | null"
18043
+ },
18044
+ "default": "null",
18045
+ "description": "Aria-labelledby attribute to be set for accessibility",
18046
+ "attribute": "aria-labelledby"
18047
+ },
18048
+ {
18049
+ "kind": "field",
18050
+ "name": "iconProviderContext",
18051
+ "privacy": "private",
18052
+ "readonly": true
18053
+ },
18054
+ {
18055
+ "kind": "field",
18056
+ "name": "abortController",
18057
+ "type": {
18058
+ "text": "AbortController | undefined"
18059
+ },
18060
+ "privacy": "private",
18061
+ "default": "new AbortController()"
18062
+ },
18063
+ {
18064
+ "kind": "method",
18065
+ "name": "prepareIconElement",
18066
+ "privacy": "private",
18067
+ "parameters": [
18068
+ {
18069
+ "name": "iconData",
18070
+ "type": {
18071
+ "text": "string"
18072
+ },
18073
+ "description": "The icon string to be parsed"
18074
+ }
18075
+ ],
18076
+ "description": "Parse the icon string to an html element, set the attributes and\nreturn the icon element",
18077
+ "return": {
18078
+ "type": {
18079
+ "text": ""
18080
+ }
18081
+ }
18082
+ },
18083
+ {
18084
+ "kind": "method",
18085
+ "name": "getIconData",
18086
+ "privacy": "private",
18087
+ "description": "Fetches the icon (currently only svg) and sets state and attributes once fetched successfully\n\nThis method uses abortController.signal to cancel the fetch request when the component is disconnected or updated.\nIf the request is aborted after the fetch() call has been fulfilled but before the response body has been read,\nthen attempting to read the response body will reject with an AbortError exception."
18088
+ },
18089
+ {
18090
+ "kind": "method",
18091
+ "name": "handleIconLoadedSuccess",
18092
+ "privacy": "private",
18093
+ "parameters": [
18094
+ {
18095
+ "name": "iconHtml",
18096
+ "type": {
18097
+ "text": "HTMLElement"
18098
+ },
18099
+ "description": "The icon html element which has been fetched from the icon provider."
18100
+ }
18101
+ ],
18102
+ "description": "Sets the iconData state to the fetched icon.\nDispatches a 'load' event on the component once the icon has been successfully loaded."
18103
+ },
18104
+ {
18105
+ "kind": "method",
18106
+ "name": "handleIconLoadedFailure",
18107
+ "privacy": "private",
18108
+ "parameters": [
18109
+ {
18110
+ "name": "error",
18111
+ "type": {
18112
+ "text": "unknown"
18113
+ }
18114
+ }
18115
+ ],
18116
+ "description": "Dispatches an 'error' event on the component when the icon fetching has failed.\nThis event bubbles and is cancelable.\nThe error detail is set to the error object."
18117
+ },
18118
+ {
18119
+ "kind": "method",
18120
+ "name": "updateSize",
18121
+ "privacy": "private",
18122
+ "description": "Updates the size by setting the width and height"
18123
+ },
18124
+ {
18125
+ "kind": "field",
18126
+ "name": "computedIconSize",
18127
+ "privacy": "private",
18128
+ "readonly": true
18129
+ }
18130
+ ],
18131
+ "attributes": [
18132
+ {
18133
+ "name": "name",
18134
+ "type": {
18135
+ "text": "IconNames | undefined"
18136
+ },
18137
+ "description": "Name of the icon (= filename)",
18138
+ "fieldName": "name"
18139
+ },
18140
+ {
18141
+ "name": "size",
18142
+ "type": {
18143
+ "text": "number | undefined"
18144
+ },
18145
+ "description": "Size of the icon (works in combination with length unit)",
18146
+ "fieldName": "size"
18147
+ },
18148
+ {
18149
+ "name": "length-unit",
18150
+ "type": {
18151
+ "text": "string | undefined"
18152
+ },
18153
+ "description": "Length unit attribute for overriding length-unit from `IconProvider`",
18154
+ "fieldName": "lengthUnit"
18155
+ },
18156
+ {
18157
+ "name": "aria-label",
18158
+ "type": {
18159
+ "text": "string | null"
18160
+ },
18161
+ "default": "null",
18162
+ "description": "Aria-label attribute to be set for accessibility",
18163
+ "fieldName": "ariaLabel"
18164
+ },
18165
+ {
18166
+ "name": "aria-labelledby",
18167
+ "type": {
18168
+ "text": "string | null"
18169
+ },
18170
+ "default": "null",
18171
+ "description": "Aria-labelledby attribute to be set for accessibility",
18172
+ "fieldName": "ariaLabelledBy"
18173
+ }
18174
+ ],
18175
+ "superclass": {
18176
+ "name": "Component",
18177
+ "module": "/src/models"
18178
+ },
18179
+ "tagName": "mdc-icon",
18180
+ "jsDoc": "/**\n * Icon component that dynamically displays SVG icons based on a valid name.\n *\n * This component must be mounted within an `IconProvider` component.\n *\n * The `IconProvider` defines the source URL from which icons are consumed.\n * The `Icon` component accepts a `name` attribute, which corresponds to\n * the file name of the icon to be loaded from the specified URL.\n *\n * Once fetched, the icon will be rendered. If the fetching process is unsuccessful,\n * no icon will be displayed.\n *\n * The `size` attribute allows for dynamic sizing of the icon based on the provided\n * `length-unit` attribute. This unit can either come from the `IconProvider`\n * or can be overridden for each individual icon. For example:\n * if `size = 1` and `length-unit = 'em'`, the dimensions of the icon will be\n * `width: 1em; height: 1em`.\n *\n * Regarding accessibility, there are three types of icons: decorative, informative and informative standalone.\n *\n * ### Decorative Icons\n * - Decorative icons do not convey any essential information to the content of a page.\n * - They should be hidden from screen readers (SR) to prevent confusion for users.\n * - For decorative icons, an `aria-label` is not required, and the `role` will be set to null.\n *\n * ### Informative Icons\n * - Informative icons convey important information that is not adequately represented\n * by surrounding text or components.\n * - They provide valuable context and must be announced by assistive technologies.\n * - For informative icons, an `aria-label` is required, and the `role` will be set to \"img\" automatically.\n * - If an `aria-label` is provided, the role will be set to 'img'; if it is absent,\n * the role will be unset.\n *\n * ### Informative Standalone Icons\n * - If an icon is informative (as mentioned above) and does not belong to a button (=standalone), it must\n * have a Tooltip that describes what it means.\n * - For informative standalone icons, an `aria-label` & `tabindex=\"0\"` is required,\n * and the `role` will be set to \"img\" automatically.\n * - **Only use this when a Icon is standalone and is not part of a button or other interactive elements.**\n *\n * @tagname mdc-icon\n *\n * @cssproperty --mdc-icon-fill-color - Allows customization of the default fill color.\n * @cssproperty --mdc-icon-size - Allows customization of the icon size.\n * @cssproperty --mdc-icon-border-radius - Allows customization of the icon border radius.\n *\n * @csspart icon - The svg inside the icon element.\n */",
18181
+ "customElement": true
18182
+ }
18183
+ ],
18184
+ "exports": [
18185
+ {
18186
+ "kind": "js",
18187
+ "name": "default",
18188
+ "declaration": {
18189
+ "name": "Icon",
18190
+ "module": "components/icon/icon.component.js"
18191
+ }
18192
+ }
18193
+ ]
18194
+ },
18195
+ {
18196
+ "kind": "javascript-module",
18197
+ "path": "components/input/input.component.js",
18198
+ "declarations": [
18199
+ {
18200
+ "kind": "class",
18201
+ "description": "mdc-input is a component that allows users to input text.\n It contains:\n- label field - describe the input field.\n- input field - contains the value\n- help text or validation message - displayed below the input field.\n- trailing button - it displays a clear the input field.\n- prefix text - displayed before the input field.\n- leading icon - displayed before the input field.\n- clear-aria-label - aria label for the trailing button.\n- all the attributes of the input field.",
18202
+ "name": "Input",
18203
+ "cssProperties": [
18204
+ {
18205
+ "description": "Border color for the input container when disabled",
18206
+ "name": "--mdc-input-disabled-border-color"
18207
18207
  },
18208
18208
  {
18209
18209
  "description": "Text color for the input field when disabled",
@@ -35774,1892 +35774,1891 @@
35774
35774
  },
35775
35775
  {
35776
35776
  "kind": "javascript-module",
35777
- "path": "components/radiogroup/radiogroup.component.js",
35777
+ "path": "components/searchfield/searchfield.component.js",
35778
35778
  "declarations": [
35779
35779
  {
35780
35780
  "kind": "class",
35781
- "description": "`mdc-radiogroup` - This is the wrapper component for radio buttons which are grouped together.\nIt can have a header text and a description. It enables users to select a single option from a set of options.\nIt is often used in forms, settings, and selection in lists. It automatically group the radio buttons inside it.",
35782
- "name": "RadioGroup",
35783
- "cssProperties": [
35784
- {
35785
- "description": "color of the description text",
35786
- "name": "--mdc-radiogroup-description-text-normal"
35787
- }
35788
- ],
35789
- "members": [
35790
- {
35791
- "kind": "field",
35792
- "name": "name",
35793
- "type": {
35794
- "text": "string"
35795
- },
35796
- "default": "''",
35797
- "description": "Name of the radio group.\nThey are used to group elements in a form together.",
35798
- "attribute": "name"
35799
- },
35800
- {
35801
- "kind": "field",
35802
- "name": "dataAriaLabel",
35803
- "type": {
35804
- "text": "string | null"
35805
- },
35806
- "default": "null",
35807
- "description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
35808
- "attribute": "data-aria-label",
35809
- "reflects": true,
35810
- "inheritedFrom": {
35811
- "name": "DataAriaLabelMixin",
35812
- "module": "utils/mixins/DataAriaLabelMixin.js"
35813
- }
35814
- },
35781
+ "description": "`mdc-searchfield` component is used as an input field for search functionality.\n\nIt supports `mdc-inputchip` as filters.\n\nThis component is built by extending the `mdc-input` component.",
35782
+ "name": "Searchfield",
35783
+ "cssParts": [
35815
35784
  {
35816
- "kind": "field",
35817
- "name": "disabled",
35818
- "type": {
35819
- "text": "boolean | undefined"
35820
- },
35821
- "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
35822
- "default": "undefined",
35823
- "attribute": "disabled",
35824
- "reflects": true,
35785
+ "description": "The label element.",
35786
+ "name": "label",
35825
35787
  "inheritedFrom": {
35826
35788
  "name": "FormfieldWrapper",
35827
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
35789
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
35828
35790
  }
35829
35791
  },
35830
35792
  {
35831
- "kind": "field",
35832
- "name": "label",
35833
- "type": {
35834
- "text": "string | undefined"
35835
- },
35836
- "description": "The label of the input field. It is linked to the input field using the `for` attribute.",
35837
- "attribute": "label",
35838
- "reflects": true,
35793
+ "description": "The container for the label and required indicator elements.",
35794
+ "name": "label-text",
35839
35795
  "inheritedFrom": {
35840
35796
  "name": "FormfieldWrapper",
35841
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
35797
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
35842
35798
  }
35843
35799
  },
35844
35800
  {
35845
- "kind": "field",
35846
- "name": "required",
35847
- "type": {
35848
- "text": "boolean"
35849
- },
35850
- "default": "false",
35851
- "description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
35852
- "attribute": "required",
35853
- "reflects": true,
35801
+ "description": "The leading icon element that is displayed before the input field.",
35802
+ "name": "leading-icon",
35854
35803
  "inheritedFrom": {
35855
- "name": "FormfieldWrapper",
35856
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
35804
+ "name": "Input",
35805
+ "module": "src/components/input/input.component.ts"
35857
35806
  }
35858
35807
  },
35859
35808
  {
35860
- "kind": "field",
35861
- "name": "helpTextType",
35862
- "type": {
35863
- "text": "ValidationType"
35864
- },
35865
- "description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
35866
- "attribute": "help-text-type",
35867
- "reflects": true,
35809
+ "description": "The container for the input field, leading icon, prefix text, and trailing button elements.",
35810
+ "name": "input-container",
35868
35811
  "inheritedFrom": {
35869
- "name": "FormfieldWrapper",
35870
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
35812
+ "name": "Input",
35813
+ "module": "src/components/input/input.component.ts"
35871
35814
  }
35872
35815
  },
35873
35816
  {
35874
- "kind": "field",
35875
- "name": "helpText",
35876
- "type": {
35877
- "text": "string | undefined"
35878
- },
35879
- "description": "The help text that is displayed below the input field.",
35880
- "attribute": "help-text",
35881
- "reflects": true,
35817
+ "description": "The container for the input field, leading icon, and prefix text elements.",
35818
+ "name": "input-section",
35882
35819
  "inheritedFrom": {
35883
- "name": "FormfieldWrapper",
35884
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
35820
+ "name": "Input",
35821
+ "module": "src/components/input/input.component.ts"
35885
35822
  }
35886
35823
  },
35887
35824
  {
35888
- "kind": "field",
35889
- "name": "toggletipText",
35890
- "type": {
35891
- "text": "string | undefined"
35892
- },
35893
- "description": "The toggletip text that is displayed when the label is hovered.\nIt is used to provide additional information about the label.",
35894
- "attribute": "toggletip-text",
35895
- "reflects": true,
35825
+ "description": "The input field element.",
35826
+ "name": "input-text",
35896
35827
  "inheritedFrom": {
35897
- "name": "FormfieldWrapper",
35898
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
35828
+ "name": "Input",
35829
+ "module": "src/components/input/input.component.ts"
35899
35830
  }
35900
35831
  },
35901
35832
  {
35902
- "kind": "field",
35903
- "name": "toggletipPlacement",
35904
- "type": {
35905
- "text": "PopoverPlacement"
35906
- },
35907
- "description": "The placement of the toggletip that is displayed when the info icon is hovered.",
35908
- "default": "'top'",
35909
- "attribute": "toggletip-placement",
35910
- "reflects": true,
35833
+ "description": "The trailing button element that is displayed to clear the input field when the `trailingButton` property is set to true.",
35834
+ "name": "trailing-button",
35911
35835
  "inheritedFrom": {
35912
- "name": "FormfieldWrapper",
35913
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
35836
+ "name": "Input",
35837
+ "module": "src/components/input/input.component.ts"
35914
35838
  }
35915
35839
  },
35916
35840
  {
35917
- "kind": "field",
35918
- "name": "toggletipStrategy",
35919
- "type": {
35920
- "text": "PopoverStrategy"
35921
- },
35922
- "attribute": "toggletip-strategy",
35923
- "reflects": true,
35841
+ "description": "The required indicator element that is displayed next to the label when the `required` property is set to true.",
35842
+ "name": "required-indicator",
35924
35843
  "inheritedFrom": {
35925
35844
  "name": "FormfieldWrapper",
35926
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
35845
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
35927
35846
  }
35928
35847
  },
35929
35848
  {
35930
- "kind": "field",
35931
- "name": "infoIconAriaLabel",
35932
- "type": {
35933
- "text": "string | undefined"
35934
- },
35935
- "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.",
35936
- "attribute": "info-icon-aria-label",
35937
- "reflects": true,
35849
+ "description": "The info icon button element that is displayed next to the label when the `toggletip-text` property is set.",
35850
+ "name": "info-icon-btn",
35938
35851
  "inheritedFrom": {
35939
35852
  "name": "FormfieldWrapper",
35940
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
35853
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
35941
35854
  }
35942
35855
  },
35943
35856
  {
35944
- "kind": "method",
35945
- "name": "renderLabelElement",
35946
- "privacy": "protected",
35947
- "description": "creates the label element when the label property is set.\nid is used to link the label with the input field.",
35948
- "return": {
35949
- "type": {
35950
- "text": ""
35951
- }
35952
- },
35857
+ "description": "The toggletip element that is displayed when the info icon button is clicked.",
35858
+ "name": "label-toggletip",
35953
35859
  "inheritedFrom": {
35954
35860
  "name": "FormfieldWrapper",
35955
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
35861
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
35956
35862
  }
35957
35863
  },
35958
35864
  {
35959
- "kind": "method",
35960
- "name": "renderHelpTextIcon",
35961
- "privacy": "protected",
35962
- "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.",
35963
- "return": {
35964
- "type": {
35965
- "text": ""
35966
- }
35967
- },
35865
+ "description": "The helper/validation text element.",
35866
+ "name": "help-text",
35968
35867
  "inheritedFrom": {
35969
35868
  "name": "FormfieldWrapper",
35970
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
35869
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
35971
35870
  }
35972
35871
  },
35973
35872
  {
35974
- "kind": "method",
35975
- "name": "renderHelpText",
35976
- "privacy": "protected",
35977
- "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.",
35978
- "return": {
35979
- "type": {
35980
- "text": ""
35981
- }
35982
- },
35873
+ "description": "The helper/validation icon element that is displayed next to the helper/validation text.",
35874
+ "name": "helper-icon",
35983
35875
  "inheritedFrom": {
35984
35876
  "name": "FormfieldWrapper",
35985
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
35877
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
35986
35878
  }
35987
35879
  },
35988
35880
  {
35989
- "kind": "method",
35990
- "name": "renderLabel",
35991
- "privacy": "protected",
35992
- "description": "renders the label container that contains the label and labelInfoToggleTip.",
35993
- "return": {
35994
- "type": {
35995
- "text": ""
35996
- }
35997
- },
35881
+ "description": "The container for the helper/validation icon and text elements.",
35882
+ "name": "help-text-container",
35998
35883
  "inheritedFrom": {
35999
35884
  "name": "FormfieldWrapper",
36000
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
35885
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
36001
35886
  }
36002
35887
  },
36003
35888
  {
36004
- "kind": "method",
36005
- "name": "renderHelperText",
36006
- "privacy": "protected",
36007
- "description": "renders the help-text container that contains the helpertext icon and helpertext.",
36008
- "return": {
36009
- "type": {
36010
- "text": ""
36011
- }
36012
- },
35889
+ "description": "The prefix text element that is displayed before the input field.",
35890
+ "name": "prefix-text",
36013
35891
  "inheritedFrom": {
36014
- "name": "FormfieldWrapper",
36015
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
35892
+ "name": "Input",
35893
+ "module": "src/components/input/input.component.ts"
36016
35894
  }
36017
35895
  }
36018
35896
  ],
36019
- "attributes": [
35897
+ "slots": [
36020
35898
  {
36021
- "name": "name",
36022
- "type": {
36023
- "text": "string"
36024
- },
36025
- "default": "''",
36026
- "description": "Name of the radio group.\nThey are used to group elements in a form together.",
36027
- "fieldName": "name"
35899
+ "description": "Slot for input chips",
35900
+ "name": "filters"
36028
35901
  },
36029
35902
  {
36030
- "name": "data-aria-label",
36031
- "type": {
36032
- "text": "string | null"
36033
- },
36034
- "default": "null",
36035
- "description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
36036
- "fieldName": "dataAriaLabel",
35903
+ "description": "Slot for the label element. If not provided, the `label` property will be used to render the label.",
35904
+ "name": "label",
36037
35905
  "inheritedFrom": {
36038
- "name": "DataAriaLabelMixin",
36039
- "module": "src/utils/mixins/DataAriaLabelMixin.ts"
35906
+ "name": "FormfieldWrapper",
35907
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
36040
35908
  }
36041
35909
  },
36042
35910
  {
36043
- "name": "disabled",
36044
- "type": {
36045
- "text": "boolean | undefined"
36046
- },
36047
- "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
36048
- "default": "undefined",
36049
- "fieldName": "disabled",
35911
+ "description": "Slot for the toggletip info icon button. If not provided, the `toggletip-text` property will be used to render the info icon button and toggletip.",
35912
+ "name": "toggletip",
36050
35913
  "inheritedFrom": {
36051
35914
  "name": "FormfieldWrapper",
36052
35915
  "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
36053
35916
  }
36054
35917
  },
36055
35918
  {
36056
- "name": "label",
36057
- "type": {
36058
- "text": "string | undefined"
36059
- },
36060
- "description": "The label of the input field. It is linked to the input field using the `for` attribute.",
36061
- "fieldName": "label",
36062
- "inheritedFrom": {
36063
- "name": "FormfieldWrapper",
36064
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
36065
- }
36066
- },
36067
- {
36068
- "name": "required",
36069
- "type": {
36070
- "text": "boolean"
36071
- },
36072
- "default": "false",
36073
- "description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
36074
- "fieldName": "required",
36075
- "inheritedFrom": {
36076
- "name": "FormfieldWrapper",
36077
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
36078
- }
36079
- },
36080
- {
36081
- "name": "help-text-type",
36082
- "type": {
36083
- "text": "ValidationType"
36084
- },
36085
- "description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
36086
- "fieldName": "helpTextType",
35919
+ "description": "Slot for the helper/validation icon. If not provided, the icon will be rendered based on the `helpTextType` property.",
35920
+ "name": "help-icon",
36087
35921
  "inheritedFrom": {
36088
35922
  "name": "FormfieldWrapper",
36089
35923
  "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
36090
35924
  }
36091
35925
  },
36092
35926
  {
35927
+ "description": "Slot for the helper/validation text. If not provided, the `helpText` property will be used to render the helper/validation text.",
36093
35928
  "name": "help-text",
36094
- "type": {
36095
- "text": "string | undefined"
36096
- },
36097
- "description": "The help text that is displayed below the input field.",
36098
- "fieldName": "helpText",
36099
35929
  "inheritedFrom": {
36100
35930
  "name": "FormfieldWrapper",
36101
35931
  "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
36102
35932
  }
36103
35933
  },
36104
35934
  {
36105
- "name": "toggletip-text",
36106
- "type": {
36107
- "text": "string | undefined"
36108
- },
36109
- "description": "The toggletip text that is displayed when the label is hovered.\nIt is used to provide additional information about the label.",
36110
- "fieldName": "toggletipText",
35935
+ "description": "Slot for the input element. If not provided, the input field will be rendered.",
35936
+ "name": "input",
36111
35937
  "inheritedFrom": {
36112
- "name": "FormfieldWrapper",
36113
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
35938
+ "name": "Input",
35939
+ "module": "src/components/input/input.component.ts"
36114
35940
  }
36115
35941
  },
36116
35942
  {
36117
- "name": "toggletip-placement",
36118
- "type": {
36119
- "text": "PopoverPlacement"
36120
- },
36121
- "description": "The placement of the toggletip that is displayed when the info icon is hovered.",
36122
- "default": "'top'",
36123
- "fieldName": "toggletipPlacement",
35943
+ "description": "Slot for the leading icon before the input field. If not provided, the `leadingIcon` property will be used to render the leading icon.",
35944
+ "name": "input-leading-icon",
36124
35945
  "inheritedFrom": {
36125
- "name": "FormfieldWrapper",
36126
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
35946
+ "name": "Input",
35947
+ "module": "src/components/input/input.component.ts"
36127
35948
  }
36128
35949
  },
36129
35950
  {
36130
- "name": "toggletip-strategy",
36131
- "type": {
36132
- "text": "PopoverStrategy"
36133
- },
36134
- "fieldName": "toggletipStrategy",
35951
+ "description": "Slot for the prefix text before the input field. If not provided, the `prefixText` property will be used to render the prefix text.",
35952
+ "name": "input-prefix-text",
36135
35953
  "inheritedFrom": {
36136
- "name": "FormfieldWrapper",
36137
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
35954
+ "name": "Input",
35955
+ "module": "src/components/input/input.component.ts"
36138
35956
  }
36139
35957
  },
36140
35958
  {
36141
- "name": "info-icon-aria-label",
36142
- "type": {
36143
- "text": "string | undefined"
36144
- },
36145
- "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.",
36146
- "fieldName": "infoIconAriaLabel",
35959
+ "description": "Slot for the trailing button to clear the input field. If not provided, the clear button will be rendered when `trailingButton` property is set to true.",
35960
+ "name": "trailing-button",
36147
35961
  "inheritedFrom": {
36148
- "name": "FormfieldWrapper",
36149
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
35962
+ "name": "Input",
35963
+ "module": "src/components/input/input.component.ts"
36150
35964
  }
36151
35965
  }
36152
35966
  ],
36153
- "superclass": {
36154
- "name": "FormfieldGroup",
36155
- "module": "/src/components/formfieldgroup"
36156
- },
36157
- "tagName": "mdc-radiogroup",
36158
- "jsDoc": "/**\n * `mdc-radiogroup` - This is the wrapper component for radio buttons which are grouped together.\n * It can have a header text and a description. It enables users to select a single option from a set of options.\n * It is often used in forms, settings, and selection in lists. It automatically group the radio buttons inside it.\n *\n * @tagname mdc-radiogroup\n *\n * @cssproperty --mdc-radiogroup-description-text-normal - color of the description text\n *\n */",
36159
- "customElement": true,
36160
- "slots": [
35967
+ "members": [
36161
35968
  {
36162
- "description": "This is a default slot for checkbox or toggle components.",
36163
- "name": "default",
36164
- "inheritedFrom": {
36165
- "name": "FormfieldGroup",
36166
- "module": "src/components/formfieldgroup/formfieldgroup.component.ts"
35969
+ "kind": "field",
35970
+ "name": "inputChips",
35971
+ "type": {
35972
+ "text": "Array<HTMLElement> | undefined"
36167
35973
  }
36168
35974
  },
36169
35975
  {
36170
- "description": "Slot for the label element. If not provided, the `label` property will be used to render the label.",
36171
- "name": "label",
35976
+ "kind": "method",
35977
+ "name": "handleKeyDown",
35978
+ "privacy": "protected",
35979
+ "parameters": [
35980
+ {
35981
+ "name": "event",
35982
+ "type": {
35983
+ "text": "KeyboardEvent"
35984
+ },
35985
+ "description": "Keyboard event"
35986
+ }
35987
+ ],
35988
+ "description": "Handles the keydown event of the search field.\nIf the key pressed is 'Enter', it submits the form.\nIf the key pressed is 'Escape', it clears the input text.",
36172
35989
  "inheritedFrom": {
36173
- "name": "FormfieldWrapper",
36174
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
35990
+ "name": "Input",
35991
+ "module": "components/input/input.component.js"
36175
35992
  }
36176
35993
  },
36177
35994
  {
36178
- "description": "Slot for the toggletip info icon button. If not provided, the `toggletip-text` property will be used to render the info icon button and toggletip.",
36179
- "name": "toggletip",
35995
+ "kind": "method",
35996
+ "name": "renderInputChips",
35997
+ "privacy": "private",
35998
+ "description": "This method is used to render the input chips inside filters slot.\nIt will remove any elements that are not input chips."
35999
+ },
36000
+ {
36001
+ "kind": "method",
36002
+ "name": "clearInputText",
36003
+ "privacy": "protected",
36004
+ "description": "Clears the input field.",
36180
36005
  "inheritedFrom": {
36181
- "name": "FormfieldWrapper",
36182
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
36006
+ "name": "Input",
36007
+ "module": "components/input/input.component.js"
36183
36008
  }
36184
36009
  },
36185
36010
  {
36186
- "description": "Slot for the helper/validation icon. If not provided, the icon will be rendered based on the `helpTextType` property.",
36187
- "name": "help-icon",
36011
+ "kind": "field",
36012
+ "name": "autoFocusOnMount",
36013
+ "type": {
36014
+ "text": "boolean"
36015
+ },
36016
+ "default": "false",
36017
+ "description": "This property indicates whether the element should receive focus automatically when it is mounted.\n\nIt will not focus if the element is re-attached to the DOM after being removed.",
36018
+ "attribute": "auto-focus-on-mount",
36019
+ "reflects": true,
36188
36020
  "inheritedFrom": {
36189
- "name": "FormfieldWrapper",
36190
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
36021
+ "name": "AutoFocusOnMountMixin",
36022
+ "module": "utils/mixins/AutoFocusOnMountMixin.js"
36191
36023
  }
36192
36024
  },
36193
36025
  {
36194
- "description": "Slot for the helper/validation text. If not provided, the `helpText` property will be used to render the helper/validation text.",
36195
- "name": "help-text",
36026
+ "kind": "field",
36027
+ "name": "name",
36028
+ "type": {
36029
+ "text": "string"
36030
+ },
36031
+ "default": "''",
36032
+ "description": "Indicates the name of the component group.\nThey are used to group elements in a form together.",
36033
+ "attribute": "name",
36034
+ "reflects": true,
36196
36035
  "inheritedFrom": {
36197
- "name": "FormfieldWrapper",
36198
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
36036
+ "name": "FormInternalsMixin",
36037
+ "module": "utils/mixins/FormInternalsMixin.js"
36199
36038
  }
36200
- }
36201
- ],
36202
- "cssParts": [
36039
+ },
36203
36040
  {
36204
- "description": "The label element.",
36205
- "name": "label",
36041
+ "kind": "field",
36042
+ "name": "value",
36043
+ "type": {
36044
+ "text": "string"
36045
+ },
36046
+ "default": "''",
36047
+ "description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
36048
+ "attribute": "value",
36049
+ "reflects": true,
36206
36050
  "inheritedFrom": {
36207
- "name": "FormfieldWrapper",
36208
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
36051
+ "name": "FormInternalsMixin",
36052
+ "module": "utils/mixins/FormInternalsMixin.js"
36209
36053
  }
36210
36054
  },
36211
36055
  {
36212
- "description": "The container for the label and required indicator elements.",
36213
- "name": "label-text",
36056
+ "kind": "field",
36057
+ "name": "validationMessage",
36058
+ "type": {
36059
+ "text": "string | undefined"
36060
+ },
36061
+ "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.",
36062
+ "attribute": "validation-message",
36063
+ "reflects": true,
36214
36064
  "inheritedFrom": {
36215
- "name": "FormfieldWrapper",
36216
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
36065
+ "name": "FormInternalsMixin",
36066
+ "module": "utils/mixins/FormInternalsMixin.js"
36217
36067
  }
36218
36068
  },
36219
36069
  {
36220
- "description": "The required indicator element that is displayed next to the label when the `required` property is set to true.",
36221
- "name": "required-indicator",
36070
+ "kind": "field",
36071
+ "name": "validity",
36072
+ "type": {
36073
+ "text": "ValidityState"
36074
+ },
36075
+ "readonly": true,
36222
36076
  "inheritedFrom": {
36223
- "name": "FormfieldWrapper",
36224
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
36077
+ "name": "FormInternalsMixin",
36078
+ "module": "utils/mixins/FormInternalsMixin.js"
36225
36079
  }
36226
36080
  },
36227
36081
  {
36228
- "description": "The info icon button element that is displayed next to the label when the `toggletip-text` property is set.",
36229
- "name": "info-icon-btn",
36082
+ "kind": "field",
36083
+ "name": "willValidate",
36084
+ "readonly": true,
36230
36085
  "inheritedFrom": {
36231
- "name": "FormfieldWrapper",
36232
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
36086
+ "name": "FormInternalsMixin",
36087
+ "module": "utils/mixins/FormInternalsMixin.js"
36233
36088
  }
36234
36089
  },
36235
36090
  {
36236
- "description": "The toggletip element that is displayed when the info icon button is clicked.",
36237
- "name": "label-toggletip",
36091
+ "kind": "method",
36092
+ "name": "setValidity",
36093
+ "description": "Sets the validity of the input field based on the input field's validity.",
36094
+ "return": {
36095
+ "type": {
36096
+ "text": ""
36097
+ }
36098
+ },
36238
36099
  "inheritedFrom": {
36239
- "name": "FormfieldWrapper",
36240
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
36100
+ "name": "FormInternalsMixin",
36101
+ "module": "utils/mixins/FormInternalsMixin.js"
36241
36102
  }
36242
36103
  },
36243
36104
  {
36244
- "description": "The helper/validation text element.",
36245
- "name": "help-text",
36105
+ "kind": "method",
36106
+ "name": "checkValidity",
36107
+ "return": {
36108
+ "type": {
36109
+ "text": "boolean"
36110
+ }
36111
+ },
36246
36112
  "inheritedFrom": {
36247
- "name": "FormfieldWrapper",
36248
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
36113
+ "name": "FormInternalsMixin",
36114
+ "module": "utils/mixins/FormInternalsMixin.js"
36249
36115
  }
36250
36116
  },
36251
36117
  {
36252
- "description": "The helper/validation icon element that is displayed next to the helper/validation text.",
36253
- "name": "helper-icon",
36118
+ "kind": "method",
36119
+ "name": "reportValidity",
36254
36120
  "inheritedFrom": {
36255
- "name": "FormfieldWrapper",
36256
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
36121
+ "name": "FormInternalsMixin",
36122
+ "module": "utils/mixins/FormInternalsMixin.js"
36257
36123
  }
36258
36124
  },
36259
36125
  {
36260
- "description": "The container for the helper/validation icon and text elements.",
36261
- "name": "help-text-container",
36126
+ "kind": "field",
36127
+ "name": "dataAriaLabel",
36128
+ "type": {
36129
+ "text": "string | null"
36130
+ },
36131
+ "default": "null",
36132
+ "description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
36133
+ "attribute": "data-aria-label",
36134
+ "reflects": true,
36262
36135
  "inheritedFrom": {
36263
- "name": "FormfieldWrapper",
36264
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
36136
+ "name": "DataAriaLabelMixin",
36137
+ "module": "utils/mixins/DataAriaLabelMixin.js"
36265
36138
  }
36266
36139
  },
36267
36140
  {
36268
- "description": "Formfieldgroup host container",
36269
- "name": "container",
36141
+ "kind": "field",
36142
+ "name": "placeholder",
36143
+ "type": {
36144
+ "text": "string"
36145
+ },
36146
+ "default": "''",
36147
+ "description": "The placeholder text that is displayed when the input field is empty.",
36148
+ "attribute": "placeholder",
36270
36149
  "inheritedFrom": {
36271
- "name": "FormfieldGroup",
36272
- "module": "src/components/formfieldgroup/formfieldgroup.component.ts"
36150
+ "name": "Input",
36151
+ "module": "components/input/input.component.js"
36273
36152
  }
36274
36153
  },
36275
36154
  {
36276
- "description": "This contains the label and help text for the group",
36277
- "name": "group-header",
36155
+ "kind": "field",
36156
+ "name": "readonly",
36157
+ "type": {
36158
+ "text": "boolean"
36159
+ },
36160
+ "default": "false",
36161
+ "description": "readonly attribute of the input field. If true, the input field is read-only.",
36162
+ "attribute": "readonly",
36278
36163
  "inheritedFrom": {
36279
- "name": "FormfieldGroup",
36280
- "module": "src/components/formfieldgroup/formfieldgroup.component.ts"
36164
+ "name": "Input",
36165
+ "module": "components/input/input.component.js"
36281
36166
  }
36282
- }
36283
- ]
36284
- }
36285
- ],
36286
- "exports": [
36287
- {
36288
- "kind": "js",
36289
- "name": "default",
36290
- "declaration": {
36291
- "name": "RadioGroup",
36292
- "module": "components/radiogroup/radiogroup.component.js"
36293
- }
36294
- }
36295
- ]
36296
- },
36297
- {
36298
- "kind": "javascript-module",
36299
- "path": "components/screenreaderannouncer/screenreaderannouncer.component.js",
36300
- "declarations": [
36301
- {
36302
- "kind": "class",
36303
- "description": "`mdc-screenreaderannouncer` can be used to announce messages with the screen reader.\n\nTo make an announcement set `announcement` attribute on the `mdc-screenreaderannouncer` element.\n\n**Internal logic**\n\nWhen the screenreader announcer is connected to the DOM, if the `identity` attribute is not\nprovided, it is set to `mdc-screenreaderannouncer-identity` and a `<div>` element with this id is created\nin the DOM. If the `identity` attribute is provided, the identity element is used and no new element\nis created in the DOM.\n\nWhen the `announcement` attribute is set, the screenreader announcer will create a `<div>` element with\n`aria-live` attribute set to the value of `data-aria-live` attribute and append it to the `identity` element.\nAfter delay of `delay` milliseconds, a <p> element with the announcement text is appended to the `<div>` element.\n\nThe announcement `<div>` element is removed from the DOM after `timeout` milliseconds.\n\nWhen the screen announcer component is disconnected from the DOM, all the timeouts are cleared and\nall the announcement elements added are removed from the DOM and timeouts cleared.\n\n**Note**\n1. The default delay of 150 miliseconds is used as we dynamically generate the\naria-live region in the DOM and add the announcement text to it.\n3. If no `identity` is provided, all the screen reader components will create and use only one\n`<div>` element with id `mdc-screenreaderannouncer-identity` in the DOM.\n\nReference: https://patrickhlauke.github.io/aria/tests/live-regions/",
36304
- "name": "ScreenreaderAnnouncer",
36305
- "members": [
36167
+ },
36306
36168
  {
36307
36169
  "kind": "field",
36308
- "name": "announcement",
36170
+ "name": "prefixText",
36309
36171
  "type": {
36310
- "text": "string"
36172
+ "text": "string | undefined"
36311
36173
  },
36312
- "default": "''",
36313
- "description": "The announcement attribute is a string that is used to announce messages to the screen reader.\nThe announcement is made when the announcement attribute is set to a non-empty string.",
36314
- "attribute": "announcement",
36315
- "reflects": true
36174
+ "description": "The prefix text that is displayed before the input field. It has a max length of 10 characters.\nWhen the prefix text is set, make sure to set the 'data-aria-label'\nattribute with the appropriate value for accessibility.",
36175
+ "attribute": "prefix-text",
36176
+ "inheritedFrom": {
36177
+ "name": "Input",
36178
+ "module": "components/input/input.component.js"
36179
+ }
36316
36180
  },
36317
36181
  {
36318
36182
  "kind": "field",
36319
- "name": "identity",
36183
+ "name": "leadingIcon",
36320
36184
  "type": {
36321
- "text": "string"
36185
+ "text": "IconNames | undefined"
36322
36186
  },
36323
- "default": "''",
36324
- "description": "The id of the element in the light dom, to which announcement elements will be appended.\n\nIf id is not provided, it will be set to `mdc-screenreaderannouncer-identity` and\na div element with this id will be created in the light dom.",
36325
- "attribute": "identity",
36326
- "reflects": true
36187
+ "description": "The leading icon that is displayed before the input field.",
36188
+ "attribute": "leading-icon",
36189
+ "inheritedFrom": {
36190
+ "name": "Input",
36191
+ "module": "components/input/input.component.js"
36192
+ }
36327
36193
  },
36328
36194
  {
36329
36195
  "kind": "field",
36330
- "name": "dataAriaLive",
36196
+ "name": "trailingButton",
36331
36197
  "type": {
36332
- "text": "AriaLive"
36198
+ "text": "boolean"
36333
36199
  },
36334
- "description": "Aria live value for announcement.",
36335
- "default": "'polite'",
36336
- "attribute": "data-aria-live",
36337
- "reflects": true
36200
+ "default": "false",
36201
+ "description": "The trailing button when set to true, shows a clear button that clears the input field.",
36202
+ "attribute": "trailing-button",
36203
+ "inheritedFrom": {
36204
+ "name": "Input",
36205
+ "module": "components/input/input.component.js"
36206
+ }
36338
36207
  },
36339
36208
  {
36340
36209
  "kind": "field",
36341
- "name": "delay",
36210
+ "name": "maxlength",
36342
36211
  "type": {
36343
- "text": "number"
36212
+ "text": "number | undefined"
36344
36213
  },
36345
- "description": "Milliseconds to wait before adding the announcement to the identiy region in\nDOM, which will announce the message to the screen reader.",
36346
- "default": "150",
36347
- "attribute": "delay",
36348
- "reflects": true
36214
+ "description": "The maximum number of characters that the input field can accept.",
36215
+ "attribute": "maxlength",
36216
+ "inheritedFrom": {
36217
+ "name": "Input",
36218
+ "module": "components/input/input.component.js"
36219
+ }
36349
36220
  },
36350
36221
  {
36351
36222
  "kind": "field",
36352
- "name": "timeout",
36223
+ "name": "minlength",
36353
36224
  "type": {
36354
- "text": "number"
36225
+ "text": "number | undefined"
36355
36226
  },
36356
- "description": "Milliseconds to wait after which the announcement element will be removed from\nidentity region in DOM, causing the screen reader to not announcing the message.",
36357
- "default": "20_000",
36358
- "attribute": "timeout",
36359
- "reflects": true
36360
- },
36361
- {
36362
- "kind": "method",
36363
- "name": "announce",
36364
- "parameters": [
36365
- {
36366
- "name": "announcement",
36367
- "type": {
36368
- "text": "string"
36369
- },
36370
- "description": "The announcement to be made."
36371
- },
36372
- {
36373
- "name": "delay",
36374
- "type": {
36375
- "text": "number"
36376
- },
36377
- "description": "The delay in milliseconds before announcing the message."
36378
- },
36379
- {
36380
- "name": "timeout",
36381
- "type": {
36382
- "text": "number"
36383
- },
36384
- "description": "The timeout in milliseconds before removing the announcement."
36385
- },
36386
- {
36387
- "name": "ariaLive",
36388
- "type": {
36389
- "text": "AriaLive"
36390
- },
36391
- "description": "The aria live value for the announcement."
36392
- }
36393
- ],
36394
- "description": "Announces the given announcement to the screen reader.\n\nA div element with aria-live attribute set to the given ariaLive value is created\nand a p element with the announcement text is appended to it.\n\nThe div element is appended to the element in the DOM identified with id as\nidentity attribute."
36395
- },
36396
- {
36397
- "kind": "method",
36398
- "name": "clearTimeOutsAndAnnouncements",
36399
- "privacy": "private",
36400
- "description": "Clears all timeouts and removes all announcements from the screen reader."
36227
+ "description": "The minimum number of characters that the input field can accept.",
36228
+ "attribute": "minlength",
36229
+ "inheritedFrom": {
36230
+ "name": "Input",
36231
+ "module": "components/input/input.component.js"
36232
+ }
36401
36233
  },
36402
36234
  {
36403
- "kind": "method",
36404
- "name": "createAnnouncementAriaLiveRegion",
36405
- "privacy": "private",
36406
- "description": "Creates a div element with id as identity attribute in the DOM.\n\nIf the identity attribute is not provided, it is set internally to\n`mdc-screenreaderannouncer-identity`."
36407
- }
36408
- ],
36409
- "attributes": [
36410
- {
36411
- "name": "announcement",
36235
+ "kind": "field",
36236
+ "name": "autocapitalize",
36412
36237
  "type": {
36413
- "text": "string"
36238
+ "text": "AutoCapitalizeType"
36414
36239
  },
36415
- "default": "''",
36416
- "description": "The announcement attribute is a string that is used to announce messages to the screen reader.\nThe announcement is made when the announcement attribute is set to a non-empty string.",
36417
- "fieldName": "announcement"
36240
+ "description": "The autocapitalize attribute of the input field.",
36241
+ "default": "'off'",
36242
+ "attribute": "autocapitalize",
36243
+ "inheritedFrom": {
36244
+ "name": "Input",
36245
+ "module": "components/input/input.component.js"
36246
+ }
36418
36247
  },
36419
36248
  {
36420
- "name": "identity",
36249
+ "kind": "field",
36250
+ "name": "autocomplete",
36421
36251
  "type": {
36422
- "text": "string"
36252
+ "text": "AutoCompleteType"
36423
36253
  },
36424
- "default": "''",
36425
- "description": "The id of the element in the light dom, to which announcement elements will be appended.\n\nIf id is not provided, it will be set to `mdc-screenreaderannouncer-identity` and\na div element with this id will be created in the light dom.",
36426
- "fieldName": "identity"
36254
+ "description": "The autocomplete attribute of the input field.",
36255
+ "default": "'off'",
36256
+ "attribute": "autocomplete",
36257
+ "inheritedFrom": {
36258
+ "name": "Input",
36259
+ "module": "components/input/input.component.js"
36260
+ }
36427
36261
  },
36428
36262
  {
36429
- "name": "data-aria-live",
36263
+ "kind": "field",
36264
+ "name": "dirname",
36430
36265
  "type": {
36431
- "text": "AriaLive"
36266
+ "text": "string | undefined"
36432
36267
  },
36433
- "description": "Aria live value for announcement.",
36434
- "default": "'polite'",
36435
- "fieldName": "dataAriaLive"
36268
+ "description": "Specifies the name of the directionality of text for submission purposes (e.g., \"rtl\" for right-to-left).",
36269
+ "attribute": "dirname",
36270
+ "inheritedFrom": {
36271
+ "name": "Input",
36272
+ "module": "components/input/input.component.js"
36273
+ }
36436
36274
  },
36437
36275
  {
36438
- "name": "delay",
36276
+ "kind": "field",
36277
+ "name": "pattern",
36439
36278
  "type": {
36440
- "text": "number"
36279
+ "text": "string | undefined"
36441
36280
  },
36442
- "description": "Milliseconds to wait before adding the announcement to the identiy region in\nDOM, which will announce the message to the screen reader.",
36443
- "default": "150",
36444
- "fieldName": "delay"
36281
+ "description": "The pattern attribute of the input field.\nSpecifies a regular expression that the input value must match for validation purposes.",
36282
+ "attribute": "pattern",
36283
+ "inheritedFrom": {
36284
+ "name": "Input",
36285
+ "module": "components/input/input.component.js"
36286
+ }
36445
36287
  },
36446
36288
  {
36447
- "name": "timeout",
36289
+ "kind": "field",
36290
+ "name": "list",
36448
36291
  "type": {
36449
- "text": "number"
36292
+ "text": "string | undefined"
36450
36293
  },
36451
- "description": "Milliseconds to wait after which the announcement element will be removed from\nidentity region in DOM, causing the screen reader to not announcing the message.",
36452
- "default": "20_000",
36453
- "fieldName": "timeout"
36454
- }
36455
- ],
36456
- "superclass": {
36457
- "name": "Component",
36458
- "module": "/src/models"
36459
- },
36460
- "tagName": "mdc-screenreaderannouncer",
36461
- "jsDoc": "/**\n * `mdc-screenreaderannouncer` can be used to announce messages with the screen reader.\n *\n * To make an announcement set `announcement` attribute on the `mdc-screenreaderannouncer` element.\n *\n * **Internal logic**\n *\n * When the screenreader announcer is connected to the DOM, if the `identity` attribute is not\n * provided, it is set to `mdc-screenreaderannouncer-identity` and a `<div>` element with this id is created\n * in the DOM. If the `identity` attribute is provided, the identity element is used and no new element\n * is created in the DOM.\n *\n * When the `announcement` attribute is set, the screenreader announcer will create a `<div>` element with\n * `aria-live` attribute set to the value of `data-aria-live` attribute and append it to the `identity` element.\n * After delay of `delay` milliseconds, a <p> element with the announcement text is appended to the `<div>` element.\n *\n * The announcement `<div>` element is removed from the DOM after `timeout` milliseconds.\n *\n * When the screen announcer component is disconnected from the DOM, all the timeouts are cleared and\n * all the announcement elements added are removed from the DOM and timeouts cleared.\n *\n * **Note**\n * 1. The default delay of 150 miliseconds is used as we dynamically generate the\n * aria-live region in the DOM and add the announcement text to it.\n * 3. If no `identity` is provided, all the screen reader components will create and use only one\n * `<div>` element with id `mdc-screenreaderannouncer-identity` in the DOM.\n *\n * Reference: https://patrickhlauke.github.io/aria/tests/live-regions/\n *\n * @tagname mdc-screenreaderannouncer\n */",
36462
- "customElement": true
36463
- }
36464
- ],
36465
- "exports": [
36466
- {
36467
- "kind": "js",
36468
- "name": "default",
36469
- "declaration": {
36470
- "name": "ScreenreaderAnnouncer",
36471
- "module": "components/screenreaderannouncer/screenreaderannouncer.component.js"
36472
- }
36473
- }
36474
- ]
36475
- },
36476
- {
36477
- "kind": "javascript-module",
36478
- "path": "components/searchfield/searchfield.component.js",
36479
- "declarations": [
36480
- {
36481
- "kind": "class",
36482
- "description": "`mdc-searchfield` component is used as an input field for search functionality.\n\nIt supports `mdc-inputchip` as filters.\n\nThis component is built by extending the `mdc-input` component.",
36483
- "name": "Searchfield",
36484
- "cssParts": [
36485
- {
36486
- "description": "The label element.",
36487
- "name": "label",
36294
+ "description": "The list attribute of the input field.\nIdentifies a list of pre-defined options to suggest to the user.",
36295
+ "attribute": "list",
36488
36296
  "inheritedFrom": {
36489
- "name": "FormfieldWrapper",
36490
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
36297
+ "name": "Input",
36298
+ "module": "components/input/input.component.js"
36491
36299
  }
36492
36300
  },
36493
36301
  {
36494
- "description": "The container for the label and required indicator elements.",
36495
- "name": "label-text",
36302
+ "kind": "field",
36303
+ "name": "size",
36304
+ "type": {
36305
+ "text": "number | undefined | undefined"
36306
+ },
36307
+ "description": "The size attribute of the input field.\nSpecifies the width of the input field.",
36308
+ "default": "undefined",
36309
+ "attribute": "size",
36496
36310
  "inheritedFrom": {
36497
- "name": "FormfieldWrapper",
36498
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
36311
+ "name": "Input",
36312
+ "module": "components/input/input.component.js"
36499
36313
  }
36500
36314
  },
36501
36315
  {
36502
- "description": "The leading icon element that is displayed before the input field.",
36503
- "name": "leading-icon",
36316
+ "kind": "field",
36317
+ "name": "clearAriaLabel",
36318
+ "type": {
36319
+ "text": "string"
36320
+ },
36321
+ "default": "''",
36322
+ "description": "Aria label for the trailing button. If trailing button is set to true, this label is used for the clear button.",
36323
+ "attribute": "clear-aria-label",
36504
36324
  "inheritedFrom": {
36505
36325
  "name": "Input",
36506
- "module": "src/components/input/input.component.ts"
36326
+ "module": "components/input/input.component.js"
36507
36327
  }
36508
36328
  },
36509
36329
  {
36510
- "description": "The container for the input field, leading icon, prefix text, and trailing button elements.",
36511
- "name": "input-container",
36330
+ "kind": "method",
36331
+ "name": "setInputValidity",
36332
+ "privacy": "private",
36512
36333
  "inheritedFrom": {
36513
36334
  "name": "Input",
36514
- "module": "src/components/input/input.component.ts"
36335
+ "module": "components/input/input.component.js"
36515
36336
  }
36516
36337
  },
36517
36338
  {
36518
- "description": "The container for the input field, leading icon, and prefix text elements.",
36519
- "name": "input-section",
36339
+ "kind": "method",
36340
+ "name": "updateValue",
36341
+ "privacy": "private",
36342
+ "description": "Updates the value of the input field.\nSets the form value.",
36343
+ "return": {
36344
+ "type": {
36345
+ "text": ""
36346
+ }
36347
+ },
36520
36348
  "inheritedFrom": {
36521
36349
  "name": "Input",
36522
- "module": "src/components/input/input.component.ts"
36350
+ "module": "components/input/input.component.js"
36523
36351
  }
36524
36352
  },
36525
36353
  {
36526
- "description": "The input field element.",
36527
- "name": "input-text",
36354
+ "kind": "method",
36355
+ "name": "onInput",
36356
+ "privacy": "private",
36357
+ "description": "Handles the input event of the input field.\nUpdates the value and sets the validity of the input field.",
36528
36358
  "inheritedFrom": {
36529
36359
  "name": "Input",
36530
- "module": "src/components/input/input.component.ts"
36360
+ "module": "components/input/input.component.js"
36531
36361
  }
36532
36362
  },
36533
36363
  {
36534
- "description": "The trailing button element that is displayed to clear the input field when the `trailingButton` property is set to true.",
36535
- "name": "trailing-button",
36364
+ "kind": "method",
36365
+ "name": "onChange",
36366
+ "privacy": "private",
36367
+ "parameters": [
36368
+ {
36369
+ "name": "event",
36370
+ "type": {
36371
+ "text": "Event"
36372
+ },
36373
+ "description": "Event which contains information about the value change."
36374
+ }
36375
+ ],
36376
+ "description": "Handles the change event of the input field.\nUpdates the value and sets the validity of the input 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",
36536
36377
  "inheritedFrom": {
36537
36378
  "name": "Input",
36538
- "module": "src/components/input/input.component.ts"
36379
+ "module": "components/input/input.component.js"
36539
36380
  }
36540
36381
  },
36541
36382
  {
36542
- "description": "The required indicator element that is displayed next to the label when the `required` property is set to true.",
36543
- "name": "required-indicator",
36383
+ "kind": "method",
36384
+ "name": "renderLeadingIcon",
36385
+ "privacy": "protected",
36386
+ "description": "Renders the leading icon before the input field.\nIf the leading icon is not set, it will not be displayed.",
36387
+ "return": {
36388
+ "type": {
36389
+ "text": ""
36390
+ }
36391
+ },
36544
36392
  "inheritedFrom": {
36545
- "name": "FormfieldWrapper",
36546
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
36393
+ "name": "Input",
36394
+ "module": "components/input/input.component.js"
36547
36395
  }
36548
36396
  },
36549
36397
  {
36550
- "description": "The info icon button element that is displayed next to the label when the `toggletip-text` property is set.",
36551
- "name": "info-icon-btn",
36398
+ "kind": "method",
36399
+ "name": "renderPrefixText",
36400
+ "privacy": "protected",
36401
+ "description": "Renders the prefix text before the input field.\nIf the prefix text is more than 10 characters,\n- it will not be displayed.\n- the validation messsage will be displayed.\n\n Note: We are setting aria-hidden so that the screen reader does not read the prefix text.\n The consumers should set the appropriate aria-label for the input field using 'data-aria-label' attribute.",
36402
+ "return": {
36403
+ "type": {
36404
+ "text": ""
36405
+ }
36406
+ },
36552
36407
  "inheritedFrom": {
36553
- "name": "FormfieldWrapper",
36554
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
36408
+ "name": "Input",
36409
+ "module": "components/input/input.component.js"
36555
36410
  }
36556
36411
  },
36557
36412
  {
36558
- "description": "The toggletip element that is displayed when the info icon button is clicked.",
36559
- "name": "label-toggletip",
36413
+ "kind": "method",
36414
+ "name": "renderTrailingButton",
36415
+ "privacy": "protected",
36416
+ "parameters": [
36417
+ {
36418
+ "name": "show",
36419
+ "default": "false"
36420
+ }
36421
+ ],
36422
+ "description": "Renders the trailing button to clear the input field if the trailingButton is set to true.",
36423
+ "return": {
36424
+ "type": {
36425
+ "text": ""
36426
+ }
36427
+ },
36560
36428
  "inheritedFrom": {
36561
- "name": "FormfieldWrapper",
36562
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
36429
+ "name": "Input",
36430
+ "module": "components/input/input.component.js"
36563
36431
  }
36564
36432
  },
36565
36433
  {
36566
- "description": "The helper/validation text element.",
36567
- "name": "help-text",
36434
+ "kind": "method",
36435
+ "name": "renderInputElement",
36436
+ "privacy": "protected",
36437
+ "parameters": [
36438
+ {
36439
+ "name": "type",
36440
+ "type": {
36441
+ "text": "InputType"
36442
+ }
36443
+ },
36444
+ {
36445
+ "name": "hidePlaceholder",
36446
+ "default": "false"
36447
+ }
36448
+ ],
36568
36449
  "inheritedFrom": {
36569
- "name": "FormfieldWrapper",
36570
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
36450
+ "name": "Input",
36451
+ "module": "components/input/input.component.js"
36571
36452
  }
36572
36453
  },
36573
36454
  {
36574
- "description": "The helper/validation icon element that is displayed next to the helper/validation text.",
36575
- "name": "helper-icon",
36455
+ "kind": "field",
36456
+ "name": "disabled",
36457
+ "type": {
36458
+ "text": "boolean | undefined"
36459
+ },
36460
+ "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
36461
+ "default": "undefined",
36462
+ "attribute": "disabled",
36463
+ "reflects": true,
36576
36464
  "inheritedFrom": {
36577
36465
  "name": "FormfieldWrapper",
36578
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
36466
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
36579
36467
  }
36580
36468
  },
36581
36469
  {
36582
- "description": "The container for the helper/validation icon and text elements.",
36583
- "name": "help-text-container",
36470
+ "kind": "field",
36471
+ "name": "label",
36472
+ "type": {
36473
+ "text": "string | undefined"
36474
+ },
36475
+ "description": "The label of the input field. It is linked to the input field using the `for` attribute.",
36476
+ "attribute": "label",
36477
+ "reflects": true,
36584
36478
  "inheritedFrom": {
36585
36479
  "name": "FormfieldWrapper",
36586
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
36480
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
36587
36481
  }
36588
36482
  },
36589
36483
  {
36590
- "description": "The prefix text element that is displayed before the input field.",
36591
- "name": "prefix-text",
36484
+ "kind": "field",
36485
+ "name": "required",
36486
+ "type": {
36487
+ "text": "boolean"
36488
+ },
36489
+ "default": "false",
36490
+ "description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
36491
+ "attribute": "required",
36492
+ "reflects": true,
36592
36493
  "inheritedFrom": {
36593
- "name": "Input",
36594
- "module": "src/components/input/input.component.ts"
36494
+ "name": "FormfieldWrapper",
36495
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
36595
36496
  }
36596
- }
36597
- ],
36598
- "slots": [
36599
- {
36600
- "description": "Slot for input chips",
36601
- "name": "filters"
36602
36497
  },
36603
36498
  {
36604
- "description": "Slot for the label element. If not provided, the `label` property will be used to render the label.",
36605
- "name": "label",
36499
+ "kind": "field",
36500
+ "name": "helpTextType",
36501
+ "type": {
36502
+ "text": "ValidationType"
36503
+ },
36504
+ "description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
36505
+ "attribute": "help-text-type",
36506
+ "reflects": true,
36606
36507
  "inheritedFrom": {
36607
36508
  "name": "FormfieldWrapper",
36608
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
36509
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
36609
36510
  }
36610
36511
  },
36611
36512
  {
36612
- "description": "Slot for the toggletip info icon button. If not provided, the `toggletip-text` property will be used to render the info icon button and toggletip.",
36613
- "name": "toggletip",
36513
+ "kind": "field",
36514
+ "name": "helpText",
36515
+ "type": {
36516
+ "text": "string | undefined"
36517
+ },
36518
+ "description": "The help text that is displayed below the input field.",
36519
+ "attribute": "help-text",
36520
+ "reflects": true,
36614
36521
  "inheritedFrom": {
36615
36522
  "name": "FormfieldWrapper",
36616
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
36523
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
36617
36524
  }
36618
36525
  },
36619
36526
  {
36620
- "description": "Slot for the helper/validation icon. If not provided, the icon will be rendered based on the `helpTextType` property.",
36621
- "name": "help-icon",
36622
- "inheritedFrom": {
36623
- "name": "FormfieldWrapper",
36624
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
36527
+ "kind": "field",
36528
+ "name": "toggletipText",
36529
+ "type": {
36530
+ "text": "string | undefined"
36531
+ },
36532
+ "description": "The toggletip text that is displayed when the label is hovered.\nIt is used to provide additional information about the label.",
36533
+ "attribute": "toggletip-text",
36534
+ "reflects": true,
36535
+ "inheritedFrom": {
36536
+ "name": "FormfieldWrapper",
36537
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
36625
36538
  }
36626
36539
  },
36627
36540
  {
36628
- "description": "Slot for the helper/validation text. If not provided, the `helpText` property will be used to render the helper/validation text.",
36629
- "name": "help-text",
36541
+ "kind": "field",
36542
+ "name": "toggletipPlacement",
36543
+ "type": {
36544
+ "text": "PopoverPlacement"
36545
+ },
36546
+ "description": "The placement of the toggletip that is displayed when the info icon is hovered.",
36547
+ "default": "'top'",
36548
+ "attribute": "toggletip-placement",
36549
+ "reflects": true,
36630
36550
  "inheritedFrom": {
36631
36551
  "name": "FormfieldWrapper",
36632
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
36552
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
36633
36553
  }
36634
36554
  },
36635
36555
  {
36636
- "description": "Slot for the input element. If not provided, the input field will be rendered.",
36556
+ "kind": "field",
36557
+ "name": "toggletipStrategy",
36558
+ "type": {
36559
+ "text": "PopoverStrategy"
36560
+ },
36561
+ "attribute": "toggletip-strategy",
36562
+ "reflects": true,
36563
+ "inheritedFrom": {
36564
+ "name": "FormfieldWrapper",
36565
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
36566
+ }
36567
+ },
36568
+ {
36569
+ "kind": "field",
36570
+ "name": "infoIconAriaLabel",
36571
+ "type": {
36572
+ "text": "string | undefined"
36573
+ },
36574
+ "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.",
36575
+ "attribute": "info-icon-aria-label",
36576
+ "reflects": true,
36577
+ "inheritedFrom": {
36578
+ "name": "FormfieldWrapper",
36579
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
36580
+ }
36581
+ },
36582
+ {
36583
+ "kind": "method",
36584
+ "name": "renderLabelElement",
36585
+ "privacy": "protected",
36586
+ "description": "creates the label element when the label property is set.\nid is used to link the label with the input field.",
36587
+ "return": {
36588
+ "type": {
36589
+ "text": ""
36590
+ }
36591
+ },
36592
+ "inheritedFrom": {
36593
+ "name": "FormfieldWrapper",
36594
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
36595
+ }
36596
+ },
36597
+ {
36598
+ "kind": "method",
36599
+ "name": "renderHelpTextIcon",
36600
+ "privacy": "protected",
36601
+ "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.",
36602
+ "return": {
36603
+ "type": {
36604
+ "text": ""
36605
+ }
36606
+ },
36607
+ "inheritedFrom": {
36608
+ "name": "FormfieldWrapper",
36609
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
36610
+ }
36611
+ },
36612
+ {
36613
+ "kind": "method",
36614
+ "name": "renderHelpText",
36615
+ "privacy": "protected",
36616
+ "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.",
36617
+ "return": {
36618
+ "type": {
36619
+ "text": ""
36620
+ }
36621
+ },
36622
+ "inheritedFrom": {
36623
+ "name": "FormfieldWrapper",
36624
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
36625
+ }
36626
+ },
36627
+ {
36628
+ "kind": "method",
36629
+ "name": "renderLabel",
36630
+ "privacy": "protected",
36631
+ "description": "renders the label container that contains the label and labelInfoToggleTip.",
36632
+ "return": {
36633
+ "type": {
36634
+ "text": ""
36635
+ }
36636
+ },
36637
+ "inheritedFrom": {
36638
+ "name": "FormfieldWrapper",
36639
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
36640
+ }
36641
+ },
36642
+ {
36643
+ "kind": "method",
36644
+ "name": "renderHelperText",
36645
+ "privacy": "protected",
36646
+ "description": "renders the help-text container that contains the helpertext icon and helpertext.",
36647
+ "return": {
36648
+ "type": {
36649
+ "text": ""
36650
+ }
36651
+ },
36652
+ "inheritedFrom": {
36653
+ "name": "FormfieldWrapper",
36654
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
36655
+ }
36656
+ }
36657
+ ],
36658
+ "events": [
36659
+ {
36660
+ "description": "(React: onInput) This event is dispatched when the value of the input field changes (every press).",
36637
36661
  "name": "input",
36662
+ "reactName": "onInput",
36638
36663
  "inheritedFrom": {
36639
36664
  "name": "Input",
36640
36665
  "module": "src/components/input/input.component.ts"
36641
36666
  }
36642
36667
  },
36643
36668
  {
36644
- "description": "Slot for the leading icon before the input field. If not provided, the `leadingIcon` property will be used to render the leading icon.",
36645
- "name": "input-leading-icon",
36669
+ "description": "(React: onChange) This event is dispatched when the value of the input field changes (on blur).",
36670
+ "name": "change",
36671
+ "reactName": "onChange",
36646
36672
  "inheritedFrom": {
36647
36673
  "name": "Input",
36648
36674
  "module": "src/components/input/input.component.ts"
36649
36675
  }
36650
36676
  },
36651
36677
  {
36652
- "description": "Slot for the prefix text before the input field. If not provided, the `prefixText` property will be used to render the prefix text.",
36653
- "name": "input-prefix-text",
36678
+ "description": "(React: onFocus) This event is dispatched when the input receives focus.",
36679
+ "name": "focus",
36680
+ "reactName": "onFocus",
36654
36681
  "inheritedFrom": {
36655
36682
  "name": "Input",
36656
36683
  "module": "src/components/input/input.component.ts"
36657
36684
  }
36658
36685
  },
36659
36686
  {
36660
- "description": "Slot for the trailing button to clear the input field. If not provided, the clear button will be rendered when `trailingButton` property is set to true.",
36661
- "name": "trailing-button",
36687
+ "description": "(React: onBlur) This event is dispatched when the input loses focus.",
36688
+ "name": "blur",
36689
+ "reactName": "onBlur",
36662
36690
  "inheritedFrom": {
36663
36691
  "name": "Input",
36664
36692
  "module": "src/components/input/input.component.ts"
36665
36693
  }
36666
- }
36667
- ],
36668
- "members": [
36669
- {
36670
- "kind": "field",
36671
- "name": "inputChips",
36672
- "type": {
36673
- "text": "Array<HTMLElement> | undefined"
36674
- }
36675
36694
  },
36676
36695
  {
36677
- "kind": "method",
36678
- "name": "handleKeyDown",
36679
- "privacy": "protected",
36680
- "parameters": [
36681
- {
36682
- "name": "event",
36683
- "type": {
36684
- "text": "KeyboardEvent"
36685
- },
36686
- "description": "Keyboard event"
36687
- }
36688
- ],
36689
- "description": "Handles the keydown event of the search field.\nIf the key pressed is 'Enter', it submits the form.\nIf the key pressed is 'Escape', it clears the input text.",
36696
+ "name": "clear",
36697
+ "type": {
36698
+ "text": "CustomEvent"
36699
+ },
36700
+ "description": "(React: onClear) This event is dispatched when the input text is cleared.",
36701
+ "reactName": "onClear",
36690
36702
  "inheritedFrom": {
36691
36703
  "name": "Input",
36692
- "module": "components/input/input.component.js"
36704
+ "module": "src/components/input/input.component.ts"
36693
36705
  }
36694
36706
  },
36695
36707
  {
36696
- "kind": "method",
36697
- "name": "renderInputChips",
36698
- "privacy": "private",
36699
- "description": "This method is used to render the input chips inside filters slot.\nIt will remove any elements that are not input chips."
36700
- },
36701
- {
36702
- "kind": "method",
36703
- "name": "clearInputText",
36704
- "privacy": "protected",
36705
- "description": "Clears the input field.",
36708
+ "type": {
36709
+ "text": "EventConstructor"
36710
+ },
36706
36711
  "inheritedFrom": {
36707
36712
  "name": "Input",
36708
- "module": "components/input/input.component.js"
36713
+ "module": "src/components/input/input.component.ts"
36709
36714
  }
36710
- },
36715
+ }
36716
+ ],
36717
+ "superclass": {
36718
+ "name": "Input",
36719
+ "module": "/src/components/input/input.component"
36720
+ },
36721
+ "tagName": "mdc-searchfield",
36722
+ "jsDoc": "/**\n * `mdc-searchfield` component is used as an input field for search functionality.\n *\n * It supports `mdc-inputchip` as filters.\n *\n * This component is built by extending the `mdc-input` component.\n *\n * @tagname mdc-searchfield\n *\n * @event input - (React: onInput) This event is dispatched when the value of the input field changes (every press).\n * @event change - (React: onChange) This event is dispatched when the value of the input field changes (on blur).\n * @event focus - (React: onFocus) This event is dispatched when the input receives focus.\n * @event blur - (React: onBlur) This event is dispatched when the input loses focus.\n * @event clear - (React: onClear) This event is dispatched when the input text is cleared.\n *\n * @slot filters - Slot for input chips\n *\n * @csspart label - The label element.\n * @csspart label-text - The container for the label and required indicator elements.\n * @csspart leading-icon - The leading icon element that is displayed before the input field.\n * @csspart input-container - The container for the input field, leading icon, prefix text, and trailing button elements.\n * @csspart input-section - The container for the input field, leading icon, and prefix text elements.\n * @csspart input-text - The input field element.\n * @csspart trailing-button - The trailing button element that is displayed to clear the input field when the `trailingButton` property is set to true.\n */",
36723
+ "customElement": true,
36724
+ "attributes": [
36711
36725
  {
36712
- "kind": "field",
36713
- "name": "autoFocusOnMount",
36726
+ "name": "auto-focus-on-mount",
36714
36727
  "type": {
36715
36728
  "text": "boolean"
36716
36729
  },
36717
36730
  "default": "false",
36718
36731
  "description": "This property indicates whether the element should receive focus automatically when it is mounted.\n\nIt will not focus if the element is re-attached to the DOM after being removed.",
36719
- "attribute": "auto-focus-on-mount",
36720
- "reflects": true,
36732
+ "fieldName": "autoFocusOnMount",
36721
36733
  "inheritedFrom": {
36722
36734
  "name": "AutoFocusOnMountMixin",
36723
- "module": "utils/mixins/AutoFocusOnMountMixin.js"
36735
+ "module": "src/utils/mixins/AutoFocusOnMountMixin.ts"
36724
36736
  }
36725
36737
  },
36726
36738
  {
36727
- "kind": "field",
36728
36739
  "name": "name",
36729
36740
  "type": {
36730
36741
  "text": "string"
36731
36742
  },
36732
36743
  "default": "''",
36733
36744
  "description": "Indicates the name of the component group.\nThey are used to group elements in a form together.",
36734
- "attribute": "name",
36735
- "reflects": true,
36745
+ "fieldName": "name",
36736
36746
  "inheritedFrom": {
36737
36747
  "name": "FormInternalsMixin",
36738
- "module": "utils/mixins/FormInternalsMixin.js"
36748
+ "module": "src/utils/mixins/FormInternalsMixin.ts"
36739
36749
  }
36740
36750
  },
36741
36751
  {
36742
- "kind": "field",
36743
36752
  "name": "value",
36744
36753
  "type": {
36745
36754
  "text": "string"
36746
36755
  },
36747
36756
  "default": "''",
36748
36757
  "description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
36749
- "attribute": "value",
36750
- "reflects": true,
36758
+ "fieldName": "value",
36751
36759
  "inheritedFrom": {
36752
36760
  "name": "FormInternalsMixin",
36753
- "module": "utils/mixins/FormInternalsMixin.js"
36761
+ "module": "src/utils/mixins/FormInternalsMixin.ts"
36754
36762
  }
36755
36763
  },
36756
36764
  {
36757
- "kind": "field",
36758
- "name": "validationMessage",
36765
+ "name": "validation-message",
36759
36766
  "type": {
36760
36767
  "text": "string | undefined"
36761
36768
  },
36762
36769
  "description": "Custom validation message that will override the default message and displayed when the input is invalid.\n\nTo display custom validation messages, you must listen for input events (or other relevant events)\non your component and update the `validationMessage` property with the desired message string.\nUpdating this property will ensure that new validation messages are shown to the user.\n- The `validationMessage` property overrides the default browser validation message when set.\n- Consumers are responsible for updating `validationMessage` in response to input or validation state changes.",
36763
- "attribute": "validation-message",
36764
- "reflects": true,
36770
+ "fieldName": "validationMessage",
36765
36771
  "inheritedFrom": {
36766
36772
  "name": "FormInternalsMixin",
36767
- "module": "utils/mixins/FormInternalsMixin.js"
36773
+ "module": "src/utils/mixins/FormInternalsMixin.ts"
36768
36774
  }
36769
36775
  },
36770
36776
  {
36771
- "kind": "field",
36772
- "name": "validity",
36777
+ "name": "data-aria-label",
36773
36778
  "type": {
36774
- "text": "ValidityState"
36779
+ "text": "string | null"
36775
36780
  },
36776
- "readonly": true,
36781
+ "default": "null",
36782
+ "description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
36783
+ "fieldName": "dataAriaLabel",
36777
36784
  "inheritedFrom": {
36778
- "name": "FormInternalsMixin",
36779
- "module": "utils/mixins/FormInternalsMixin.js"
36785
+ "name": "DataAriaLabelMixin",
36786
+ "module": "src/utils/mixins/DataAriaLabelMixin.ts"
36780
36787
  }
36781
36788
  },
36782
36789
  {
36783
- "kind": "field",
36784
- "name": "willValidate",
36785
- "readonly": true,
36786
- "inheritedFrom": {
36787
- "name": "FormInternalsMixin",
36788
- "module": "utils/mixins/FormInternalsMixin.js"
36789
- }
36790
- },
36791
- {
36792
- "kind": "method",
36793
- "name": "setValidity",
36794
- "description": "Sets the validity of the input field based on the input field's validity.",
36795
- "return": {
36796
- "type": {
36797
- "text": ""
36798
- }
36799
- },
36800
- "inheritedFrom": {
36801
- "name": "FormInternalsMixin",
36802
- "module": "utils/mixins/FormInternalsMixin.js"
36803
- }
36804
- },
36805
- {
36806
- "kind": "method",
36807
- "name": "checkValidity",
36808
- "return": {
36809
- "type": {
36810
- "text": "boolean"
36811
- }
36812
- },
36813
- "inheritedFrom": {
36814
- "name": "FormInternalsMixin",
36815
- "module": "utils/mixins/FormInternalsMixin.js"
36816
- }
36817
- },
36818
- {
36819
- "kind": "method",
36820
- "name": "reportValidity",
36821
- "inheritedFrom": {
36822
- "name": "FormInternalsMixin",
36823
- "module": "utils/mixins/FormInternalsMixin.js"
36824
- }
36825
- },
36826
- {
36827
- "kind": "field",
36828
- "name": "dataAriaLabel",
36829
- "type": {
36830
- "text": "string | null"
36831
- },
36832
- "default": "null",
36833
- "description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
36834
- "attribute": "data-aria-label",
36835
- "reflects": true,
36836
- "inheritedFrom": {
36837
- "name": "DataAriaLabelMixin",
36838
- "module": "utils/mixins/DataAriaLabelMixin.js"
36839
- }
36840
- },
36841
- {
36842
- "kind": "field",
36843
- "name": "placeholder",
36844
- "type": {
36845
- "text": "string"
36846
- },
36847
- "default": "''",
36848
- "description": "The placeholder text that is displayed when the input field is empty.",
36849
- "attribute": "placeholder",
36790
+ "name": "placeholder",
36791
+ "type": {
36792
+ "text": "string"
36793
+ },
36794
+ "default": "''",
36795
+ "description": "The placeholder text that is displayed when the input field is empty.",
36796
+ "fieldName": "placeholder",
36850
36797
  "inheritedFrom": {
36851
36798
  "name": "Input",
36852
- "module": "components/input/input.component.js"
36799
+ "module": "src/components/input/input.component.ts"
36853
36800
  }
36854
36801
  },
36855
36802
  {
36856
- "kind": "field",
36857
36803
  "name": "readonly",
36858
36804
  "type": {
36859
36805
  "text": "boolean"
36860
36806
  },
36861
36807
  "default": "false",
36862
36808
  "description": "readonly attribute of the input field. If true, the input field is read-only.",
36863
- "attribute": "readonly",
36809
+ "fieldName": "readonly",
36864
36810
  "inheritedFrom": {
36865
36811
  "name": "Input",
36866
- "module": "components/input/input.component.js"
36812
+ "module": "src/components/input/input.component.ts"
36867
36813
  }
36868
36814
  },
36869
36815
  {
36870
- "kind": "field",
36871
- "name": "prefixText",
36816
+ "name": "prefix-text",
36872
36817
  "type": {
36873
36818
  "text": "string | undefined"
36874
36819
  },
36875
36820
  "description": "The prefix text that is displayed before the input field. It has a max length of 10 characters.\nWhen the prefix text is set, make sure to set the 'data-aria-label'\nattribute with the appropriate value for accessibility.",
36876
- "attribute": "prefix-text",
36821
+ "fieldName": "prefixText",
36877
36822
  "inheritedFrom": {
36878
36823
  "name": "Input",
36879
- "module": "components/input/input.component.js"
36824
+ "module": "src/components/input/input.component.ts"
36880
36825
  }
36881
36826
  },
36882
36827
  {
36883
- "kind": "field",
36884
- "name": "leadingIcon",
36828
+ "name": "leading-icon",
36885
36829
  "type": {
36886
36830
  "text": "IconNames | undefined"
36887
36831
  },
36888
36832
  "description": "The leading icon that is displayed before the input field.",
36889
- "attribute": "leading-icon",
36833
+ "fieldName": "leadingIcon",
36890
36834
  "inheritedFrom": {
36891
36835
  "name": "Input",
36892
- "module": "components/input/input.component.js"
36836
+ "module": "src/components/input/input.component.ts"
36893
36837
  }
36894
36838
  },
36895
36839
  {
36896
- "kind": "field",
36897
- "name": "trailingButton",
36840
+ "name": "trailing-button",
36898
36841
  "type": {
36899
36842
  "text": "boolean"
36900
36843
  },
36901
36844
  "default": "false",
36902
36845
  "description": "The trailing button when set to true, shows a clear button that clears the input field.",
36903
- "attribute": "trailing-button",
36846
+ "fieldName": "trailingButton",
36904
36847
  "inheritedFrom": {
36905
36848
  "name": "Input",
36906
- "module": "components/input/input.component.js"
36849
+ "module": "src/components/input/input.component.ts"
36907
36850
  }
36908
36851
  },
36909
36852
  {
36910
- "kind": "field",
36911
36853
  "name": "maxlength",
36912
36854
  "type": {
36913
36855
  "text": "number | undefined"
36914
36856
  },
36915
36857
  "description": "The maximum number of characters that the input field can accept.",
36916
- "attribute": "maxlength",
36858
+ "fieldName": "maxlength",
36917
36859
  "inheritedFrom": {
36918
36860
  "name": "Input",
36919
- "module": "components/input/input.component.js"
36861
+ "module": "src/components/input/input.component.ts"
36920
36862
  }
36921
36863
  },
36922
36864
  {
36923
- "kind": "field",
36924
36865
  "name": "minlength",
36925
36866
  "type": {
36926
36867
  "text": "number | undefined"
36927
36868
  },
36928
36869
  "description": "The minimum number of characters that the input field can accept.",
36929
- "attribute": "minlength",
36870
+ "fieldName": "minlength",
36930
36871
  "inheritedFrom": {
36931
36872
  "name": "Input",
36932
- "module": "components/input/input.component.js"
36873
+ "module": "src/components/input/input.component.ts"
36933
36874
  }
36934
36875
  },
36935
36876
  {
36936
- "kind": "field",
36937
36877
  "name": "autocapitalize",
36938
36878
  "type": {
36939
36879
  "text": "AutoCapitalizeType"
36940
36880
  },
36941
36881
  "description": "The autocapitalize attribute of the input field.",
36942
36882
  "default": "'off'",
36943
- "attribute": "autocapitalize",
36883
+ "fieldName": "autocapitalize",
36944
36884
  "inheritedFrom": {
36945
36885
  "name": "Input",
36946
- "module": "components/input/input.component.js"
36886
+ "module": "src/components/input/input.component.ts"
36947
36887
  }
36948
36888
  },
36949
36889
  {
36950
- "kind": "field",
36951
36890
  "name": "autocomplete",
36952
36891
  "type": {
36953
36892
  "text": "AutoCompleteType"
36954
36893
  },
36955
36894
  "description": "The autocomplete attribute of the input field.",
36956
36895
  "default": "'off'",
36957
- "attribute": "autocomplete",
36896
+ "fieldName": "autocomplete",
36958
36897
  "inheritedFrom": {
36959
36898
  "name": "Input",
36960
- "module": "components/input/input.component.js"
36899
+ "module": "src/components/input/input.component.ts"
36961
36900
  }
36962
36901
  },
36963
36902
  {
36964
- "kind": "field",
36965
36903
  "name": "dirname",
36966
36904
  "type": {
36967
36905
  "text": "string | undefined"
36968
36906
  },
36969
36907
  "description": "Specifies the name of the directionality of text for submission purposes (e.g., \"rtl\" for right-to-left).",
36970
- "attribute": "dirname",
36908
+ "fieldName": "dirname",
36971
36909
  "inheritedFrom": {
36972
36910
  "name": "Input",
36973
- "module": "components/input/input.component.js"
36911
+ "module": "src/components/input/input.component.ts"
36974
36912
  }
36975
36913
  },
36976
36914
  {
36977
- "kind": "field",
36978
36915
  "name": "pattern",
36979
36916
  "type": {
36980
36917
  "text": "string | undefined"
36981
36918
  },
36982
36919
  "description": "The pattern attribute of the input field.\nSpecifies a regular expression that the input value must match for validation purposes.",
36983
- "attribute": "pattern",
36920
+ "fieldName": "pattern",
36984
36921
  "inheritedFrom": {
36985
36922
  "name": "Input",
36986
- "module": "components/input/input.component.js"
36923
+ "module": "src/components/input/input.component.ts"
36987
36924
  }
36988
36925
  },
36989
36926
  {
36990
- "kind": "field",
36991
36927
  "name": "list",
36992
36928
  "type": {
36993
36929
  "text": "string | undefined"
36994
36930
  },
36995
36931
  "description": "The list attribute of the input field.\nIdentifies a list of pre-defined options to suggest to the user.",
36996
- "attribute": "list",
36932
+ "fieldName": "list",
36997
36933
  "inheritedFrom": {
36998
36934
  "name": "Input",
36999
- "module": "components/input/input.component.js"
36935
+ "module": "src/components/input/input.component.ts"
37000
36936
  }
37001
36937
  },
37002
36938
  {
37003
- "kind": "field",
37004
36939
  "name": "size",
37005
36940
  "type": {
37006
36941
  "text": "number | undefined | undefined"
37007
36942
  },
37008
36943
  "description": "The size attribute of the input field.\nSpecifies the width of the input field.",
37009
36944
  "default": "undefined",
37010
- "attribute": "size",
36945
+ "fieldName": "size",
37011
36946
  "inheritedFrom": {
37012
36947
  "name": "Input",
37013
- "module": "components/input/input.component.js"
36948
+ "module": "src/components/input/input.component.ts"
37014
36949
  }
37015
36950
  },
37016
36951
  {
37017
- "kind": "field",
37018
- "name": "clearAriaLabel",
36952
+ "name": "clear-aria-label",
37019
36953
  "type": {
37020
36954
  "text": "string"
37021
36955
  },
37022
36956
  "default": "''",
37023
36957
  "description": "Aria label for the trailing button. If trailing button is set to true, this label is used for the clear button.",
37024
- "attribute": "clear-aria-label",
36958
+ "fieldName": "clearAriaLabel",
37025
36959
  "inheritedFrom": {
37026
36960
  "name": "Input",
37027
- "module": "components/input/input.component.js"
36961
+ "module": "src/components/input/input.component.ts"
37028
36962
  }
37029
36963
  },
37030
36964
  {
37031
- "kind": "method",
37032
- "name": "setInputValidity",
37033
- "privacy": "private",
36965
+ "name": "disabled",
36966
+ "type": {
36967
+ "text": "boolean | undefined"
36968
+ },
36969
+ "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
36970
+ "default": "undefined",
36971
+ "fieldName": "disabled",
37034
36972
  "inheritedFrom": {
37035
- "name": "Input",
37036
- "module": "components/input/input.component.js"
36973
+ "name": "FormfieldWrapper",
36974
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
37037
36975
  }
37038
36976
  },
37039
36977
  {
37040
- "kind": "method",
37041
- "name": "updateValue",
37042
- "privacy": "private",
37043
- "description": "Updates the value of the input field.\nSets the form value.",
37044
- "return": {
37045
- "type": {
37046
- "text": ""
37047
- }
36978
+ "name": "label",
36979
+ "type": {
36980
+ "text": "string | undefined"
37048
36981
  },
36982
+ "description": "The label of the input field. It is linked to the input field using the `for` attribute.",
36983
+ "fieldName": "label",
37049
36984
  "inheritedFrom": {
37050
- "name": "Input",
37051
- "module": "components/input/input.component.js"
36985
+ "name": "FormfieldWrapper",
36986
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
37052
36987
  }
37053
36988
  },
37054
36989
  {
37055
- "kind": "method",
37056
- "name": "onInput",
37057
- "privacy": "private",
37058
- "description": "Handles the input event of the input field.\nUpdates the value and sets the validity of the input field.",
36990
+ "name": "required",
36991
+ "type": {
36992
+ "text": "boolean"
36993
+ },
36994
+ "default": "false",
36995
+ "description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
36996
+ "fieldName": "required",
37059
36997
  "inheritedFrom": {
37060
- "name": "Input",
37061
- "module": "components/input/input.component.js"
36998
+ "name": "FormfieldWrapper",
36999
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
37062
37000
  }
37063
37001
  },
37064
37002
  {
37065
- "kind": "method",
37066
- "name": "onChange",
37067
- "privacy": "private",
37068
- "parameters": [
37069
- {
37070
- "name": "event",
37071
- "type": {
37072
- "text": "Event"
37073
- },
37074
- "description": "Event which contains information about the value change."
37075
- }
37076
- ],
37077
- "description": "Handles the change event of the input field.\nUpdates the value and sets the validity of the input 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",
37003
+ "name": "help-text-type",
37004
+ "type": {
37005
+ "text": "ValidationType"
37006
+ },
37007
+ "description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
37008
+ "fieldName": "helpTextType",
37078
37009
  "inheritedFrom": {
37079
- "name": "Input",
37080
- "module": "components/input/input.component.js"
37010
+ "name": "FormfieldWrapper",
37011
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
37081
37012
  }
37082
37013
  },
37083
37014
  {
37084
- "kind": "method",
37085
- "name": "renderLeadingIcon",
37086
- "privacy": "protected",
37087
- "description": "Renders the leading icon before the input field.\nIf the leading icon is not set, it will not be displayed.",
37088
- "return": {
37089
- "type": {
37090
- "text": ""
37091
- }
37015
+ "name": "help-text",
37016
+ "type": {
37017
+ "text": "string | undefined"
37092
37018
  },
37019
+ "description": "The help text that is displayed below the input field.",
37020
+ "fieldName": "helpText",
37093
37021
  "inheritedFrom": {
37094
- "name": "Input",
37095
- "module": "components/input/input.component.js"
37022
+ "name": "FormfieldWrapper",
37023
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
37096
37024
  }
37097
37025
  },
37098
37026
  {
37099
- "kind": "method",
37100
- "name": "renderPrefixText",
37101
- "privacy": "protected",
37102
- "description": "Renders the prefix text before the input field.\nIf the prefix text is more than 10 characters,\n- it will not be displayed.\n- the validation messsage will be displayed.\n\n Note: We are setting aria-hidden so that the screen reader does not read the prefix text.\n The consumers should set the appropriate aria-label for the input field using 'data-aria-label' attribute.",
37103
- "return": {
37104
- "type": {
37105
- "text": ""
37106
- }
37027
+ "name": "toggletip-text",
37028
+ "type": {
37029
+ "text": "string | undefined"
37107
37030
  },
37031
+ "description": "The toggletip text that is displayed when the label is hovered.\nIt is used to provide additional information about the label.",
37032
+ "fieldName": "toggletipText",
37108
37033
  "inheritedFrom": {
37109
- "name": "Input",
37110
- "module": "components/input/input.component.js"
37034
+ "name": "FormfieldWrapper",
37035
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
37111
37036
  }
37112
37037
  },
37113
37038
  {
37114
- "kind": "method",
37115
- "name": "renderTrailingButton",
37116
- "privacy": "protected",
37117
- "parameters": [
37118
- {
37119
- "name": "show",
37120
- "default": "false"
37121
- }
37122
- ],
37123
- "description": "Renders the trailing button to clear the input field if the trailingButton is set to true.",
37124
- "return": {
37125
- "type": {
37126
- "text": ""
37127
- }
37039
+ "name": "toggletip-placement",
37040
+ "type": {
37041
+ "text": "PopoverPlacement"
37128
37042
  },
37043
+ "description": "The placement of the toggletip that is displayed when the info icon is hovered.",
37044
+ "default": "'top'",
37045
+ "fieldName": "toggletipPlacement",
37129
37046
  "inheritedFrom": {
37130
- "name": "Input",
37131
- "module": "components/input/input.component.js"
37132
- }
37133
- },
37134
- {
37135
- "kind": "method",
37136
- "name": "renderInputElement",
37137
- "privacy": "protected",
37138
- "parameters": [
37139
- {
37140
- "name": "type",
37141
- "type": {
37142
- "text": "InputType"
37143
- }
37144
- },
37145
- {
37146
- "name": "hidePlaceholder",
37147
- "default": "false"
37148
- }
37149
- ],
37150
- "inheritedFrom": {
37151
- "name": "Input",
37152
- "module": "components/input/input.component.js"
37047
+ "name": "FormfieldWrapper",
37048
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
37153
37049
  }
37154
37050
  },
37155
37051
  {
37156
- "kind": "field",
37157
- "name": "disabled",
37052
+ "name": "toggletip-strategy",
37158
37053
  "type": {
37159
- "text": "boolean | undefined"
37054
+ "text": "PopoverStrategy"
37160
37055
  },
37161
- "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
37162
- "default": "undefined",
37163
- "attribute": "disabled",
37164
- "reflects": true,
37056
+ "fieldName": "toggletipStrategy",
37165
37057
  "inheritedFrom": {
37166
37058
  "name": "FormfieldWrapper",
37167
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
37059
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
37168
37060
  }
37169
37061
  },
37170
37062
  {
37171
- "kind": "field",
37172
- "name": "label",
37063
+ "name": "info-icon-aria-label",
37173
37064
  "type": {
37174
37065
  "text": "string | undefined"
37175
37066
  },
37176
- "description": "The label of the input field. It is linked to the input field using the `for` attribute.",
37177
- "attribute": "label",
37178
- "reflects": true,
37067
+ "description": "Aria label for the info icon that is displayed next to the label when `toggletipText` is set.\nThis is used for accessibility purposes to provide a description of the icon.",
37068
+ "fieldName": "infoIconAriaLabel",
37179
37069
  "inheritedFrom": {
37180
37070
  "name": "FormfieldWrapper",
37181
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
37071
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
37072
+ }
37073
+ }
37074
+ ],
37075
+ "cssProperties": [
37076
+ {
37077
+ "description": "Border color for the input container when disabled",
37078
+ "name": "--mdc-input-disabled-border-color",
37079
+ "inheritedFrom": {
37080
+ "name": "Input",
37081
+ "module": "src/components/input/input.component.ts"
37182
37082
  }
37183
37083
  },
37184
37084
  {
37185
- "kind": "field",
37186
- "name": "required",
37187
- "type": {
37188
- "text": "boolean"
37189
- },
37190
- "default": "false",
37191
- "description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
37192
- "attribute": "required",
37193
- "reflects": true,
37085
+ "description": "Text color for the input field when disabled",
37086
+ "name": "--mdc-input-disabled-text-color",
37194
37087
  "inheritedFrom": {
37195
- "name": "FormfieldWrapper",
37196
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
37088
+ "name": "Input",
37089
+ "module": "src/components/input/input.component.ts"
37197
37090
  }
37198
37091
  },
37199
37092
  {
37200
- "kind": "field",
37201
- "name": "helpTextType",
37202
- "type": {
37203
- "text": "ValidationType"
37204
- },
37205
- "description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
37206
- "attribute": "help-text-type",
37207
- "reflects": true,
37093
+ "description": "Background color for the input field when disabled",
37094
+ "name": "--mdc-input-disabled-background-color",
37208
37095
  "inheritedFrom": {
37209
- "name": "FormfieldWrapper",
37210
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
37096
+ "name": "Input",
37097
+ "module": "src/components/input/input.component.ts"
37211
37098
  }
37212
37099
  },
37213
37100
  {
37214
- "kind": "field",
37215
- "name": "helpText",
37216
- "type": {
37217
- "text": "string | undefined"
37218
- },
37219
- "description": "The help text that is displayed below the input field.",
37220
- "attribute": "help-text",
37221
- "reflects": true,
37101
+ "description": "Border color for the input container",
37102
+ "name": "--mdc-input-border-color",
37222
37103
  "inheritedFrom": {
37223
- "name": "FormfieldWrapper",
37224
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
37104
+ "name": "Input",
37105
+ "module": "src/components/input/input.component.ts"
37225
37106
  }
37226
37107
  },
37227
37108
  {
37228
- "kind": "field",
37229
- "name": "toggletipText",
37230
- "type": {
37231
- "text": "string | undefined"
37232
- },
37233
- "description": "The toggletip text that is displayed when the label is hovered.\nIt is used to provide additional information about the label.",
37234
- "attribute": "toggletip-text",
37235
- "reflects": true,
37109
+ "description": "Text color for the input field",
37110
+ "name": "--mdc-input-text-color",
37236
37111
  "inheritedFrom": {
37237
- "name": "FormfieldWrapper",
37238
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
37112
+ "name": "Input",
37113
+ "module": "src/components/input/input.component.ts"
37239
37114
  }
37240
37115
  },
37241
37116
  {
37242
- "kind": "field",
37243
- "name": "toggletipPlacement",
37244
- "type": {
37245
- "text": "PopoverPlacement"
37246
- },
37247
- "description": "The placement of the toggletip that is displayed when the info icon is hovered.",
37248
- "default": "'top'",
37249
- "attribute": "toggletip-placement",
37250
- "reflects": true,
37117
+ "description": "Background color for the input field",
37118
+ "name": "--mdc-input-background-color",
37251
37119
  "inheritedFrom": {
37252
- "name": "FormfieldWrapper",
37253
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
37120
+ "name": "Input",
37121
+ "module": "src/components/input/input.component.ts"
37254
37122
  }
37255
37123
  },
37256
37124
  {
37257
- "kind": "field",
37258
- "name": "toggletipStrategy",
37259
- "type": {
37260
- "text": "PopoverStrategy"
37261
- },
37262
- "attribute": "toggletip-strategy",
37263
- "reflects": true,
37125
+ "description": "Background color for the selected text",
37126
+ "name": "--mdc-input-selection-background-color",
37264
37127
  "inheritedFrom": {
37265
- "name": "FormfieldWrapper",
37266
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
37128
+ "name": "Input",
37129
+ "module": "src/components/input/input.component.ts"
37267
37130
  }
37268
37131
  },
37269
37132
  {
37270
- "kind": "field",
37271
- "name": "infoIconAriaLabel",
37272
- "type": {
37273
- "text": "string | undefined"
37274
- },
37275
- "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.",
37276
- "attribute": "info-icon-aria-label",
37277
- "reflects": true,
37133
+ "description": "Text color for the selected text",
37134
+ "name": "--mdc-input-selection-text-color",
37278
37135
  "inheritedFrom": {
37279
- "name": "FormfieldWrapper",
37280
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
37136
+ "name": "Input",
37137
+ "module": "src/components/input/input.component.ts"
37281
37138
  }
37282
37139
  },
37283
37140
  {
37284
- "kind": "method",
37285
- "name": "renderLabelElement",
37286
- "privacy": "protected",
37287
- "description": "creates the label element when the label property is set.\nid is used to link the label with the input field.",
37288
- "return": {
37289
- "type": {
37290
- "text": ""
37291
- }
37292
- },
37141
+ "description": "Text color for the help text",
37142
+ "name": "--mdc-input-support-text-color",
37293
37143
  "inheritedFrom": {
37294
- "name": "FormfieldWrapper",
37295
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
37144
+ "name": "Input",
37145
+ "module": "src/components/input/input.component.ts"
37296
37146
  }
37297
37147
  },
37298
37148
  {
37299
- "kind": "method",
37300
- "name": "renderHelpTextIcon",
37301
- "privacy": "protected",
37302
- "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.",
37303
- "return": {
37304
- "type": {
37305
- "text": ""
37306
- }
37307
- },
37149
+ "description": "Background color for the input field when hovered",
37150
+ "name": "--mdc-input-hover-background-color",
37308
37151
  "inheritedFrom": {
37309
- "name": "FormfieldWrapper",
37310
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
37152
+ "name": "Input",
37153
+ "module": "src/components/input/input.component.ts"
37311
37154
  }
37312
37155
  },
37313
37156
  {
37314
- "kind": "method",
37315
- "name": "renderHelpText",
37316
- "privacy": "protected",
37317
- "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.",
37318
- "return": {
37319
- "type": {
37320
- "text": ""
37321
- }
37322
- },
37157
+ "description": "Background color for the input field when focused",
37158
+ "name": "--mdc-input-focused-background-color",
37323
37159
  "inheritedFrom": {
37324
- "name": "FormfieldWrapper",
37325
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
37160
+ "name": "Input",
37161
+ "module": "src/components/input/input.component.ts"
37326
37162
  }
37327
37163
  },
37328
37164
  {
37329
- "kind": "method",
37330
- "name": "renderLabel",
37331
- "privacy": "protected",
37332
- "description": "renders the label container that contains the label and labelInfoToggleTip.",
37333
- "return": {
37334
- "type": {
37335
- "text": ""
37336
- }
37337
- },
37165
+ "description": "Border color for the input container when focused",
37166
+ "name": "--mdc-input-focused-border-color",
37338
37167
  "inheritedFrom": {
37339
- "name": "FormfieldWrapper",
37340
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
37168
+ "name": "Input",
37169
+ "module": "src/components/input/input.component.ts"
37341
37170
  }
37342
37171
  },
37343
37172
  {
37344
- "kind": "method",
37345
- "name": "renderHelperText",
37346
- "privacy": "protected",
37347
- "description": "renders the help-text container that contains the helpertext icon and helpertext.",
37348
- "return": {
37349
- "type": {
37350
- "text": ""
37351
- }
37352
- },
37173
+ "description": "Border color for the input container when error",
37174
+ "name": "--mdc-input-error-border-color",
37353
37175
  "inheritedFrom": {
37354
- "name": "FormfieldWrapper",
37355
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
37176
+ "name": "Input",
37177
+ "module": "src/components/input/input.component.ts"
37356
37178
  }
37357
- }
37358
- ],
37359
- "events": [
37179
+ },
37360
37180
  {
37361
- "description": "(React: onInput) This event is dispatched when the value of the input field changes (every press).",
37362
- "name": "input",
37363
- "reactName": "onInput",
37181
+ "description": "Border color for the input container when warning",
37182
+ "name": "--mdc-input-warning-border-color",
37364
37183
  "inheritedFrom": {
37365
37184
  "name": "Input",
37366
37185
  "module": "src/components/input/input.component.ts"
37367
37186
  }
37368
37187
  },
37369
37188
  {
37370
- "description": "(React: onChange) This event is dispatched when the value of the input field changes (on blur).",
37371
- "name": "change",
37372
- "reactName": "onChange",
37189
+ "description": "Border color for the input container when success",
37190
+ "name": "--mdc-input-success-border-color",
37373
37191
  "inheritedFrom": {
37374
37192
  "name": "Input",
37375
37193
  "module": "src/components/input/input.component.ts"
37376
37194
  }
37377
37195
  },
37378
37196
  {
37379
- "description": "(React: onFocus) This event is dispatched when the input receives focus.",
37380
- "name": "focus",
37381
- "reactName": "onFocus",
37197
+ "description": "Border color for the input container when primary",
37198
+ "name": "--mdc-input-primary-border-color",
37382
37199
  "inheritedFrom": {
37383
37200
  "name": "Input",
37384
37201
  "module": "src/components/input/input.component.ts"
37385
37202
  }
37203
+ }
37204
+ ]
37205
+ }
37206
+ ],
37207
+ "exports": [
37208
+ {
37209
+ "kind": "js",
37210
+ "name": "default",
37211
+ "declaration": {
37212
+ "name": "Searchfield",
37213
+ "module": "components/searchfield/searchfield.component.js"
37214
+ }
37215
+ }
37216
+ ]
37217
+ },
37218
+ {
37219
+ "kind": "javascript-module",
37220
+ "path": "components/screenreaderannouncer/screenreaderannouncer.component.js",
37221
+ "declarations": [
37222
+ {
37223
+ "kind": "class",
37224
+ "description": "`mdc-screenreaderannouncer` can be used to announce messages with the screen reader.\n\nTo make an announcement set `announcement` attribute on the `mdc-screenreaderannouncer` element.\n\n**Internal logic**\n\nWhen the screenreader announcer is connected to the DOM, if the `identity` attribute is not\nprovided, it is set to `mdc-screenreaderannouncer-identity` and a `<div>` element with this id is created\nin the DOM. If the `identity` attribute is provided, the identity element is used and no new element\nis created in the DOM.\n\nWhen the `announcement` attribute is set, the screenreader announcer will create a `<div>` element with\n`aria-live` attribute set to the value of `data-aria-live` attribute and append it to the `identity` element.\nAfter delay of `delay` milliseconds, a <p> element with the announcement text is appended to the `<div>` element.\n\nThe announcement `<div>` element is removed from the DOM after `timeout` milliseconds.\n\nWhen the screen announcer component is disconnected from the DOM, all the timeouts are cleared and\nall the announcement elements added are removed from the DOM and timeouts cleared.\n\n**Note**\n1. The default delay of 150 miliseconds is used as we dynamically generate the\naria-live region in the DOM and add the announcement text to it.\n3. If no `identity` is provided, all the screen reader components will create and use only one\n`<div>` element with id `mdc-screenreaderannouncer-identity` in the DOM.\n\nReference: https://patrickhlauke.github.io/aria/tests/live-regions/",
37225
+ "name": "ScreenreaderAnnouncer",
37226
+ "members": [
37227
+ {
37228
+ "kind": "field",
37229
+ "name": "announcement",
37230
+ "type": {
37231
+ "text": "string"
37232
+ },
37233
+ "default": "''",
37234
+ "description": "The announcement attribute is a string that is used to announce messages to the screen reader.\nThe announcement is made when the announcement attribute is set to a non-empty string.",
37235
+ "attribute": "announcement",
37236
+ "reflects": true
37237
+ },
37238
+ {
37239
+ "kind": "field",
37240
+ "name": "identity",
37241
+ "type": {
37242
+ "text": "string"
37243
+ },
37244
+ "default": "''",
37245
+ "description": "The id of the element in the light dom, to which announcement elements will be appended.\n\nIf id is not provided, it will be set to `mdc-screenreaderannouncer-identity` and\na div element with this id will be created in the light dom.",
37246
+ "attribute": "identity",
37247
+ "reflects": true
37248
+ },
37249
+ {
37250
+ "kind": "field",
37251
+ "name": "dataAriaLive",
37252
+ "type": {
37253
+ "text": "AriaLive"
37254
+ },
37255
+ "description": "Aria live value for announcement.",
37256
+ "default": "'polite'",
37257
+ "attribute": "data-aria-live",
37258
+ "reflects": true
37259
+ },
37260
+ {
37261
+ "kind": "field",
37262
+ "name": "delay",
37263
+ "type": {
37264
+ "text": "number"
37265
+ },
37266
+ "description": "Milliseconds to wait before adding the announcement to the identiy region in\nDOM, which will announce the message to the screen reader.",
37267
+ "default": "150",
37268
+ "attribute": "delay",
37269
+ "reflects": true
37270
+ },
37271
+ {
37272
+ "kind": "field",
37273
+ "name": "timeout",
37274
+ "type": {
37275
+ "text": "number"
37276
+ },
37277
+ "description": "Milliseconds to wait after which the announcement element will be removed from\nidentity region in DOM, causing the screen reader to not announcing the message.",
37278
+ "default": "20_000",
37279
+ "attribute": "timeout",
37280
+ "reflects": true
37281
+ },
37282
+ {
37283
+ "kind": "method",
37284
+ "name": "announce",
37285
+ "parameters": [
37286
+ {
37287
+ "name": "announcement",
37288
+ "type": {
37289
+ "text": "string"
37290
+ },
37291
+ "description": "The announcement to be made."
37292
+ },
37293
+ {
37294
+ "name": "delay",
37295
+ "type": {
37296
+ "text": "number"
37297
+ },
37298
+ "description": "The delay in milliseconds before announcing the message."
37299
+ },
37300
+ {
37301
+ "name": "timeout",
37302
+ "type": {
37303
+ "text": "number"
37304
+ },
37305
+ "description": "The timeout in milliseconds before removing the announcement."
37306
+ },
37307
+ {
37308
+ "name": "ariaLive",
37309
+ "type": {
37310
+ "text": "AriaLive"
37311
+ },
37312
+ "description": "The aria live value for the announcement."
37313
+ }
37314
+ ],
37315
+ "description": "Announces the given announcement to the screen reader.\n\nA div element with aria-live attribute set to the given ariaLive value is created\nand a p element with the announcement text is appended to it.\n\nThe div element is appended to the element in the DOM identified with id as\nidentity attribute."
37316
+ },
37317
+ {
37318
+ "kind": "method",
37319
+ "name": "clearTimeOutsAndAnnouncements",
37320
+ "privacy": "private",
37321
+ "description": "Clears all timeouts and removes all announcements from the screen reader."
37322
+ },
37323
+ {
37324
+ "kind": "method",
37325
+ "name": "createAnnouncementAriaLiveRegion",
37326
+ "privacy": "private",
37327
+ "description": "Creates a div element with id as identity attribute in the DOM.\n\nIf the identity attribute is not provided, it is set internally to\n`mdc-screenreaderannouncer-identity`."
37328
+ }
37329
+ ],
37330
+ "attributes": [
37331
+ {
37332
+ "name": "announcement",
37333
+ "type": {
37334
+ "text": "string"
37335
+ },
37336
+ "default": "''",
37337
+ "description": "The announcement attribute is a string that is used to announce messages to the screen reader.\nThe announcement is made when the announcement attribute is set to a non-empty string.",
37338
+ "fieldName": "announcement"
37339
+ },
37340
+ {
37341
+ "name": "identity",
37342
+ "type": {
37343
+ "text": "string"
37344
+ },
37345
+ "default": "''",
37346
+ "description": "The id of the element in the light dom, to which announcement elements will be appended.\n\nIf id is not provided, it will be set to `mdc-screenreaderannouncer-identity` and\na div element with this id will be created in the light dom.",
37347
+ "fieldName": "identity"
37386
37348
  },
37387
37349
  {
37388
- "description": "(React: onBlur) This event is dispatched when the input loses focus.",
37389
- "name": "blur",
37390
- "reactName": "onBlur",
37391
- "inheritedFrom": {
37392
- "name": "Input",
37393
- "module": "src/components/input/input.component.ts"
37394
- }
37350
+ "name": "data-aria-live",
37351
+ "type": {
37352
+ "text": "AriaLive"
37353
+ },
37354
+ "description": "Aria live value for announcement.",
37355
+ "default": "'polite'",
37356
+ "fieldName": "dataAriaLive"
37395
37357
  },
37396
37358
  {
37397
- "name": "clear",
37359
+ "name": "delay",
37398
37360
  "type": {
37399
- "text": "CustomEvent"
37361
+ "text": "number"
37400
37362
  },
37401
- "description": "(React: onClear) This event is dispatched when the input text is cleared.",
37402
- "reactName": "onClear",
37403
- "inheritedFrom": {
37404
- "name": "Input",
37405
- "module": "src/components/input/input.component.ts"
37406
- }
37363
+ "description": "Milliseconds to wait before adding the announcement to the identiy region in\nDOM, which will announce the message to the screen reader.",
37364
+ "default": "150",
37365
+ "fieldName": "delay"
37407
37366
  },
37408
37367
  {
37368
+ "name": "timeout",
37409
37369
  "type": {
37410
- "text": "EventConstructor"
37370
+ "text": "number"
37411
37371
  },
37412
- "inheritedFrom": {
37413
- "name": "Input",
37414
- "module": "src/components/input/input.component.ts"
37415
- }
37372
+ "description": "Milliseconds to wait after which the announcement element will be removed from\nidentity region in DOM, causing the screen reader to not announcing the message.",
37373
+ "default": "20_000",
37374
+ "fieldName": "timeout"
37416
37375
  }
37417
37376
  ],
37418
37377
  "superclass": {
37419
- "name": "Input",
37420
- "module": "/src/components/input/input.component"
37378
+ "name": "Component",
37379
+ "module": "/src/models"
37421
37380
  },
37422
- "tagName": "mdc-searchfield",
37423
- "jsDoc": "/**\n * `mdc-searchfield` component is used as an input field for search functionality.\n *\n * It supports `mdc-inputchip` as filters.\n *\n * This component is built by extending the `mdc-input` component.\n *\n * @tagname mdc-searchfield\n *\n * @event input - (React: onInput) This event is dispatched when the value of the input field changes (every press).\n * @event change - (React: onChange) This event is dispatched when the value of the input field changes (on blur).\n * @event focus - (React: onFocus) This event is dispatched when the input receives focus.\n * @event blur - (React: onBlur) This event is dispatched when the input loses focus.\n * @event clear - (React: onClear) This event is dispatched when the input text is cleared.\n *\n * @slot filters - Slot for input chips\n *\n * @csspart label - The label element.\n * @csspart label-text - The container for the label and required indicator elements.\n * @csspart leading-icon - The leading icon element that is displayed before the input field.\n * @csspart input-container - The container for the input field, leading icon, prefix text, and trailing button elements.\n * @csspart input-section - The container for the input field, leading icon, and prefix text elements.\n * @csspart input-text - The input field element.\n * @csspart trailing-button - The trailing button element that is displayed to clear the input field when the `trailingButton` property is set to true.\n */",
37424
- "customElement": true,
37425
- "attributes": [
37381
+ "tagName": "mdc-screenreaderannouncer",
37382
+ "jsDoc": "/**\n * `mdc-screenreaderannouncer` can be used to announce messages with the screen reader.\n *\n * To make an announcement set `announcement` attribute on the `mdc-screenreaderannouncer` element.\n *\n * **Internal logic**\n *\n * When the screenreader announcer is connected to the DOM, if the `identity` attribute is not\n * provided, it is set to `mdc-screenreaderannouncer-identity` and a `<div>` element with this id is created\n * in the DOM. If the `identity` attribute is provided, the identity element is used and no new element\n * is created in the DOM.\n *\n * When the `announcement` attribute is set, the screenreader announcer will create a `<div>` element with\n * `aria-live` attribute set to the value of `data-aria-live` attribute and append it to the `identity` element.\n * After delay of `delay` milliseconds, a <p> element with the announcement text is appended to the `<div>` element.\n *\n * The announcement `<div>` element is removed from the DOM after `timeout` milliseconds.\n *\n * When the screen announcer component is disconnected from the DOM, all the timeouts are cleared and\n * all the announcement elements added are removed from the DOM and timeouts cleared.\n *\n * **Note**\n * 1. The default delay of 150 miliseconds is used as we dynamically generate the\n * aria-live region in the DOM and add the announcement text to it.\n * 3. If no `identity` is provided, all the screen reader components will create and use only one\n * `<div>` element with id `mdc-screenreaderannouncer-identity` in the DOM.\n *\n * Reference: https://patrickhlauke.github.io/aria/tests/live-regions/\n *\n * @tagname mdc-screenreaderannouncer\n */",
37383
+ "customElement": true
37384
+ }
37385
+ ],
37386
+ "exports": [
37387
+ {
37388
+ "kind": "js",
37389
+ "name": "default",
37390
+ "declaration": {
37391
+ "name": "ScreenreaderAnnouncer",
37392
+ "module": "components/screenreaderannouncer/screenreaderannouncer.component.js"
37393
+ }
37394
+ }
37395
+ ]
37396
+ },
37397
+ {
37398
+ "kind": "javascript-module",
37399
+ "path": "components/radiogroup/radiogroup.component.js",
37400
+ "declarations": [
37401
+ {
37402
+ "kind": "class",
37403
+ "description": "`mdc-radiogroup` - This is the wrapper component for radio buttons which are grouped together.\nIt can have a header text and a description. It enables users to select a single option from a set of options.\nIt is often used in forms, settings, and selection in lists. It automatically group the radio buttons inside it.",
37404
+ "name": "RadioGroup",
37405
+ "cssProperties": [
37426
37406
  {
37427
- "name": "auto-focus-on-mount",
37428
- "type": {
37429
- "text": "boolean"
37430
- },
37431
- "default": "false",
37432
- "description": "This property indicates whether the element should receive focus automatically when it is mounted.\n\nIt will not focus if the element is re-attached to the DOM after being removed.",
37433
- "fieldName": "autoFocusOnMount",
37434
- "inheritedFrom": {
37435
- "name": "AutoFocusOnMountMixin",
37436
- "module": "src/utils/mixins/AutoFocusOnMountMixin.ts"
37437
- }
37438
- },
37407
+ "description": "color of the description text",
37408
+ "name": "--mdc-radiogroup-description-text-normal"
37409
+ }
37410
+ ],
37411
+ "members": [
37439
37412
  {
37413
+ "kind": "field",
37440
37414
  "name": "name",
37441
37415
  "type": {
37442
37416
  "text": "string"
37443
37417
  },
37444
37418
  "default": "''",
37445
- "description": "Indicates the name of the component group.\nThey are used to group elements in a form together.",
37446
- "fieldName": "name",
37447
- "inheritedFrom": {
37448
- "name": "FormInternalsMixin",
37449
- "module": "src/utils/mixins/FormInternalsMixin.ts"
37450
- }
37451
- },
37452
- {
37453
- "name": "value",
37454
- "type": {
37455
- "text": "string"
37456
- },
37457
- "default": "''",
37458
- "description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
37459
- "fieldName": "value",
37460
- "inheritedFrom": {
37461
- "name": "FormInternalsMixin",
37462
- "module": "src/utils/mixins/FormInternalsMixin.ts"
37463
- }
37419
+ "description": "Name of the radio group.\nThey are used to group elements in a form together.",
37420
+ "attribute": "name"
37464
37421
  },
37465
37422
  {
37466
- "name": "validation-message",
37423
+ "kind": "field",
37424
+ "name": "dataAriaLabel",
37467
37425
  "type": {
37468
- "text": "string | undefined"
37426
+ "text": "string | null"
37469
37427
  },
37470
- "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.",
37471
- "fieldName": "validationMessage",
37428
+ "default": "null",
37429
+ "description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
37430
+ "attribute": "data-aria-label",
37431
+ "reflects": true,
37472
37432
  "inheritedFrom": {
37473
- "name": "FormInternalsMixin",
37474
- "module": "src/utils/mixins/FormInternalsMixin.ts"
37433
+ "name": "DataAriaLabelMixin",
37434
+ "module": "utils/mixins/DataAriaLabelMixin.js"
37475
37435
  }
37476
37436
  },
37477
37437
  {
37478
- "name": "data-aria-label",
37438
+ "kind": "field",
37439
+ "name": "disabled",
37479
37440
  "type": {
37480
- "text": "string | null"
37441
+ "text": "boolean | undefined"
37481
37442
  },
37482
- "default": "null",
37483
- "description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
37484
- "fieldName": "dataAriaLabel",
37443
+ "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
37444
+ "default": "undefined",
37445
+ "attribute": "disabled",
37446
+ "reflects": true,
37485
37447
  "inheritedFrom": {
37486
- "name": "DataAriaLabelMixin",
37487
- "module": "src/utils/mixins/DataAriaLabelMixin.ts"
37448
+ "name": "FormfieldWrapper",
37449
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
37488
37450
  }
37489
37451
  },
37490
37452
  {
37491
- "name": "placeholder",
37453
+ "kind": "field",
37454
+ "name": "label",
37492
37455
  "type": {
37493
- "text": "string"
37456
+ "text": "string | undefined"
37494
37457
  },
37495
- "default": "''",
37496
- "description": "The placeholder text that is displayed when the input field is empty.",
37497
- "fieldName": "placeholder",
37458
+ "description": "The label of the input field. It is linked to the input field using the `for` attribute.",
37459
+ "attribute": "label",
37460
+ "reflects": true,
37498
37461
  "inheritedFrom": {
37499
- "name": "Input",
37500
- "module": "src/components/input/input.component.ts"
37462
+ "name": "FormfieldWrapper",
37463
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
37501
37464
  }
37502
37465
  },
37503
37466
  {
37504
- "name": "readonly",
37467
+ "kind": "field",
37468
+ "name": "required",
37505
37469
  "type": {
37506
37470
  "text": "boolean"
37507
37471
  },
37508
37472
  "default": "false",
37509
- "description": "readonly attribute of the input field. If true, the input field is read-only.",
37510
- "fieldName": "readonly",
37473
+ "description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
37474
+ "attribute": "required",
37475
+ "reflects": true,
37511
37476
  "inheritedFrom": {
37512
- "name": "Input",
37513
- "module": "src/components/input/input.component.ts"
37477
+ "name": "FormfieldWrapper",
37478
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
37514
37479
  }
37515
37480
  },
37516
37481
  {
37517
- "name": "prefix-text",
37482
+ "kind": "field",
37483
+ "name": "helpTextType",
37518
37484
  "type": {
37519
- "text": "string | undefined"
37485
+ "text": "ValidationType"
37520
37486
  },
37521
- "description": "The prefix text that is displayed before the input field. It has a max length of 10 characters.\nWhen the prefix text is set, make sure to set the 'data-aria-label'\nattribute with the appropriate value for accessibility.",
37522
- "fieldName": "prefixText",
37487
+ "description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
37488
+ "attribute": "help-text-type",
37489
+ "reflects": true,
37523
37490
  "inheritedFrom": {
37524
- "name": "Input",
37525
- "module": "src/components/input/input.component.ts"
37491
+ "name": "FormfieldWrapper",
37492
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
37526
37493
  }
37527
37494
  },
37528
37495
  {
37529
- "name": "leading-icon",
37496
+ "kind": "field",
37497
+ "name": "helpText",
37530
37498
  "type": {
37531
- "text": "IconNames | undefined"
37499
+ "text": "string | undefined"
37532
37500
  },
37533
- "description": "The leading icon that is displayed before the input field.",
37534
- "fieldName": "leadingIcon",
37501
+ "description": "The help text that is displayed below the input field.",
37502
+ "attribute": "help-text",
37503
+ "reflects": true,
37535
37504
  "inheritedFrom": {
37536
- "name": "Input",
37537
- "module": "src/components/input/input.component.ts"
37505
+ "name": "FormfieldWrapper",
37506
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
37538
37507
  }
37539
37508
  },
37540
37509
  {
37541
- "name": "trailing-button",
37510
+ "kind": "field",
37511
+ "name": "toggletipText",
37542
37512
  "type": {
37543
- "text": "boolean"
37513
+ "text": "string | undefined"
37544
37514
  },
37545
- "default": "false",
37546
- "description": "The trailing button when set to true, shows a clear button that clears the input field.",
37547
- "fieldName": "trailingButton",
37515
+ "description": "The toggletip text that is displayed when the label is hovered.\nIt is used to provide additional information about the label.",
37516
+ "attribute": "toggletip-text",
37517
+ "reflects": true,
37548
37518
  "inheritedFrom": {
37549
- "name": "Input",
37550
- "module": "src/components/input/input.component.ts"
37519
+ "name": "FormfieldWrapper",
37520
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
37551
37521
  }
37552
37522
  },
37553
37523
  {
37554
- "name": "maxlength",
37524
+ "kind": "field",
37525
+ "name": "toggletipPlacement",
37555
37526
  "type": {
37556
- "text": "number | undefined"
37527
+ "text": "PopoverPlacement"
37557
37528
  },
37558
- "description": "The maximum number of characters that the input field can accept.",
37559
- "fieldName": "maxlength",
37529
+ "description": "The placement of the toggletip that is displayed when the info icon is hovered.",
37530
+ "default": "'top'",
37531
+ "attribute": "toggletip-placement",
37532
+ "reflects": true,
37560
37533
  "inheritedFrom": {
37561
- "name": "Input",
37562
- "module": "src/components/input/input.component.ts"
37534
+ "name": "FormfieldWrapper",
37535
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
37563
37536
  }
37564
37537
  },
37565
37538
  {
37566
- "name": "minlength",
37539
+ "kind": "field",
37540
+ "name": "toggletipStrategy",
37567
37541
  "type": {
37568
- "text": "number | undefined"
37542
+ "text": "PopoverStrategy"
37569
37543
  },
37570
- "description": "The minimum number of characters that the input field can accept.",
37571
- "fieldName": "minlength",
37544
+ "attribute": "toggletip-strategy",
37545
+ "reflects": true,
37572
37546
  "inheritedFrom": {
37573
- "name": "Input",
37574
- "module": "src/components/input/input.component.ts"
37547
+ "name": "FormfieldWrapper",
37548
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
37575
37549
  }
37576
37550
  },
37577
37551
  {
37578
- "name": "autocapitalize",
37552
+ "kind": "field",
37553
+ "name": "infoIconAriaLabel",
37579
37554
  "type": {
37580
- "text": "AutoCapitalizeType"
37555
+ "text": "string | undefined"
37581
37556
  },
37582
- "description": "The autocapitalize attribute of the input field.",
37583
- "default": "'off'",
37584
- "fieldName": "autocapitalize",
37557
+ "description": "Aria label for the info icon that is displayed next to the label when `toggletipText` is set.\nThis is used for accessibility purposes to provide a description of the icon.",
37558
+ "attribute": "info-icon-aria-label",
37559
+ "reflects": true,
37585
37560
  "inheritedFrom": {
37586
- "name": "Input",
37587
- "module": "src/components/input/input.component.ts"
37561
+ "name": "FormfieldWrapper",
37562
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
37588
37563
  }
37589
37564
  },
37590
37565
  {
37591
- "name": "autocomplete",
37592
- "type": {
37593
- "text": "AutoCompleteType"
37566
+ "kind": "method",
37567
+ "name": "renderLabelElement",
37568
+ "privacy": "protected",
37569
+ "description": "creates the label element when the label property is set.\nid is used to link the label with the input field.",
37570
+ "return": {
37571
+ "type": {
37572
+ "text": ""
37573
+ }
37594
37574
  },
37595
- "description": "The autocomplete attribute of the input field.",
37596
- "default": "'off'",
37597
- "fieldName": "autocomplete",
37598
37575
  "inheritedFrom": {
37599
- "name": "Input",
37600
- "module": "src/components/input/input.component.ts"
37576
+ "name": "FormfieldWrapper",
37577
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
37601
37578
  }
37602
37579
  },
37603
37580
  {
37604
- "name": "dirname",
37605
- "type": {
37606
- "text": "string | undefined"
37581
+ "kind": "method",
37582
+ "name": "renderHelpTextIcon",
37583
+ "privacy": "protected",
37584
+ "description": "creates the helpertext icon based on the helpTextType for validation.\nIf the helpTextType is not set, it defaults to 'default' and it doesn't display any icon.",
37585
+ "return": {
37586
+ "type": {
37587
+ "text": ""
37588
+ }
37607
37589
  },
37608
- "description": "Specifies the name of the directionality of text for submission purposes (e.g., \"rtl\" for right-to-left).",
37609
- "fieldName": "dirname",
37610
37590
  "inheritedFrom": {
37611
- "name": "Input",
37612
- "module": "src/components/input/input.component.ts"
37591
+ "name": "FormfieldWrapper",
37592
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
37613
37593
  }
37614
37594
  },
37615
37595
  {
37616
- "name": "pattern",
37617
- "type": {
37618
- "text": "string | undefined"
37596
+ "kind": "method",
37597
+ "name": "renderHelpText",
37598
+ "privacy": "protected",
37599
+ "description": "creates the helper text component when the helpertext value is set.\nIt is also used to display the validation message based on the helpTextType.",
37600
+ "return": {
37601
+ "type": {
37602
+ "text": ""
37603
+ }
37619
37604
  },
37620
- "description": "The pattern attribute of the input field.\nSpecifies a regular expression that the input value must match for validation purposes.",
37621
- "fieldName": "pattern",
37622
37605
  "inheritedFrom": {
37623
- "name": "Input",
37624
- "module": "src/components/input/input.component.ts"
37606
+ "name": "FormfieldWrapper",
37607
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
37625
37608
  }
37626
37609
  },
37627
37610
  {
37628
- "name": "list",
37629
- "type": {
37630
- "text": "string | undefined"
37611
+ "kind": "method",
37612
+ "name": "renderLabel",
37613
+ "privacy": "protected",
37614
+ "description": "renders the label container that contains the label and labelInfoToggleTip.",
37615
+ "return": {
37616
+ "type": {
37617
+ "text": ""
37618
+ }
37631
37619
  },
37632
- "description": "The list attribute of the input field.\nIdentifies a list of pre-defined options to suggest to the user.",
37633
- "fieldName": "list",
37634
37620
  "inheritedFrom": {
37635
- "name": "Input",
37636
- "module": "src/components/input/input.component.ts"
37621
+ "name": "FormfieldWrapper",
37622
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
37637
37623
  }
37638
37624
  },
37639
37625
  {
37640
- "name": "size",
37641
- "type": {
37642
- "text": "number | undefined | undefined"
37626
+ "kind": "method",
37627
+ "name": "renderHelperText",
37628
+ "privacy": "protected",
37629
+ "description": "renders the help-text container that contains the helpertext icon and helpertext.",
37630
+ "return": {
37631
+ "type": {
37632
+ "text": ""
37633
+ }
37643
37634
  },
37644
- "description": "The size attribute of the input field.\nSpecifies the width of the input field.",
37645
- "default": "undefined",
37646
- "fieldName": "size",
37647
37635
  "inheritedFrom": {
37648
- "name": "Input",
37649
- "module": "src/components/input/input.component.ts"
37636
+ "name": "FormfieldWrapper",
37637
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
37650
37638
  }
37651
- },
37639
+ }
37640
+ ],
37641
+ "attributes": [
37652
37642
  {
37653
- "name": "clear-aria-label",
37643
+ "name": "name",
37654
37644
  "type": {
37655
37645
  "text": "string"
37656
37646
  },
37657
37647
  "default": "''",
37658
- "description": "Aria label for the trailing button. If trailing button is set to true, this label is used for the clear button.",
37659
- "fieldName": "clearAriaLabel",
37648
+ "description": "Name of the radio group.\nThey are used to group elements in a form together.",
37649
+ "fieldName": "name"
37650
+ },
37651
+ {
37652
+ "name": "data-aria-label",
37653
+ "type": {
37654
+ "text": "string | null"
37655
+ },
37656
+ "default": "null",
37657
+ "description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
37658
+ "fieldName": "dataAriaLabel",
37660
37659
  "inheritedFrom": {
37661
- "name": "Input",
37662
- "module": "src/components/input/input.component.ts"
37660
+ "name": "DataAriaLabelMixin",
37661
+ "module": "src/utils/mixins/DataAriaLabelMixin.ts"
37663
37662
  }
37664
37663
  },
37665
37664
  {
@@ -37773,133 +37772,134 @@
37773
37772
  }
37774
37773
  }
37775
37774
  ],
37776
- "cssProperties": [
37777
- {
37778
- "description": "Border color for the input container when disabled",
37779
- "name": "--mdc-input-disabled-border-color",
37780
- "inheritedFrom": {
37781
- "name": "Input",
37782
- "module": "src/components/input/input.component.ts"
37783
- }
37784
- },
37775
+ "superclass": {
37776
+ "name": "FormfieldGroup",
37777
+ "module": "/src/components/formfieldgroup"
37778
+ },
37779
+ "tagName": "mdc-radiogroup",
37780
+ "jsDoc": "/**\n * `mdc-radiogroup` - This is the wrapper component for radio buttons which are grouped together.\n * It can have a header text and a description. It enables users to select a single option from a set of options.\n * It is often used in forms, settings, and selection in lists. It automatically group the radio buttons inside it.\n *\n * @tagname mdc-radiogroup\n *\n * @cssproperty --mdc-radiogroup-description-text-normal - color of the description text\n *\n */",
37781
+ "customElement": true,
37782
+ "slots": [
37785
37783
  {
37786
- "description": "Text color for the input field when disabled",
37787
- "name": "--mdc-input-disabled-text-color",
37784
+ "description": "This is a default slot for checkbox or toggle components.",
37785
+ "name": "default",
37788
37786
  "inheritedFrom": {
37789
- "name": "Input",
37790
- "module": "src/components/input/input.component.ts"
37787
+ "name": "FormfieldGroup",
37788
+ "module": "src/components/formfieldgroup/formfieldgroup.component.ts"
37791
37789
  }
37792
37790
  },
37793
37791
  {
37794
- "description": "Background color for the input field when disabled",
37795
- "name": "--mdc-input-disabled-background-color",
37792
+ "description": "Slot for the label element. If not provided, the `label` property will be used to render the label.",
37793
+ "name": "label",
37796
37794
  "inheritedFrom": {
37797
- "name": "Input",
37798
- "module": "src/components/input/input.component.ts"
37795
+ "name": "FormfieldWrapper",
37796
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
37799
37797
  }
37800
37798
  },
37801
37799
  {
37802
- "description": "Border color for the input container",
37803
- "name": "--mdc-input-border-color",
37800
+ "description": "Slot for the toggletip info icon button. If not provided, the `toggletip-text` property will be used to render the info icon button and toggletip.",
37801
+ "name": "toggletip",
37804
37802
  "inheritedFrom": {
37805
- "name": "Input",
37806
- "module": "src/components/input/input.component.ts"
37803
+ "name": "FormfieldWrapper",
37804
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
37807
37805
  }
37808
37806
  },
37809
37807
  {
37810
- "description": "Text color for the input field",
37811
- "name": "--mdc-input-text-color",
37808
+ "description": "Slot for the helper/validation icon. If not provided, the icon will be rendered based on the `helpTextType` property.",
37809
+ "name": "help-icon",
37812
37810
  "inheritedFrom": {
37813
- "name": "Input",
37814
- "module": "src/components/input/input.component.ts"
37811
+ "name": "FormfieldWrapper",
37812
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
37815
37813
  }
37816
37814
  },
37817
37815
  {
37818
- "description": "Background color for the input field",
37819
- "name": "--mdc-input-background-color",
37816
+ "description": "Slot for the helper/validation text. If not provided, the `helpText` property will be used to render the helper/validation text.",
37817
+ "name": "help-text",
37820
37818
  "inheritedFrom": {
37821
- "name": "Input",
37822
- "module": "src/components/input/input.component.ts"
37819
+ "name": "FormfieldWrapper",
37820
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
37823
37821
  }
37824
- },
37822
+ }
37823
+ ],
37824
+ "cssParts": [
37825
37825
  {
37826
- "description": "Background color for the selected text",
37827
- "name": "--mdc-input-selection-background-color",
37826
+ "description": "The label element.",
37827
+ "name": "label",
37828
37828
  "inheritedFrom": {
37829
- "name": "Input",
37830
- "module": "src/components/input/input.component.ts"
37829
+ "name": "FormfieldWrapper",
37830
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
37831
37831
  }
37832
37832
  },
37833
37833
  {
37834
- "description": "Text color for the selected text",
37835
- "name": "--mdc-input-selection-text-color",
37834
+ "description": "The container for the label and required indicator elements.",
37835
+ "name": "label-text",
37836
37836
  "inheritedFrom": {
37837
- "name": "Input",
37838
- "module": "src/components/input/input.component.ts"
37837
+ "name": "FormfieldWrapper",
37838
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
37839
37839
  }
37840
37840
  },
37841
37841
  {
37842
- "description": "Text color for the help text",
37843
- "name": "--mdc-input-support-text-color",
37842
+ "description": "The required indicator element that is displayed next to the label when the `required` property is set to true.",
37843
+ "name": "required-indicator",
37844
37844
  "inheritedFrom": {
37845
- "name": "Input",
37846
- "module": "src/components/input/input.component.ts"
37845
+ "name": "FormfieldWrapper",
37846
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
37847
37847
  }
37848
37848
  },
37849
37849
  {
37850
- "description": "Background color for the input field when hovered",
37851
- "name": "--mdc-input-hover-background-color",
37850
+ "description": "The info icon button element that is displayed next to the label when the `toggletip-text` property is set.",
37851
+ "name": "info-icon-btn",
37852
37852
  "inheritedFrom": {
37853
- "name": "Input",
37854
- "module": "src/components/input/input.component.ts"
37853
+ "name": "FormfieldWrapper",
37854
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
37855
37855
  }
37856
37856
  },
37857
37857
  {
37858
- "description": "Background color for the input field when focused",
37859
- "name": "--mdc-input-focused-background-color",
37858
+ "description": "The toggletip element that is displayed when the info icon button is clicked.",
37859
+ "name": "label-toggletip",
37860
37860
  "inheritedFrom": {
37861
- "name": "Input",
37862
- "module": "src/components/input/input.component.ts"
37861
+ "name": "FormfieldWrapper",
37862
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
37863
37863
  }
37864
37864
  },
37865
37865
  {
37866
- "description": "Border color for the input container when focused",
37867
- "name": "--mdc-input-focused-border-color",
37866
+ "description": "The helper/validation text element.",
37867
+ "name": "help-text",
37868
37868
  "inheritedFrom": {
37869
- "name": "Input",
37870
- "module": "src/components/input/input.component.ts"
37869
+ "name": "FormfieldWrapper",
37870
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
37871
37871
  }
37872
37872
  },
37873
37873
  {
37874
- "description": "Border color for the input container when error",
37875
- "name": "--mdc-input-error-border-color",
37874
+ "description": "The helper/validation icon element that is displayed next to the helper/validation text.",
37875
+ "name": "helper-icon",
37876
37876
  "inheritedFrom": {
37877
- "name": "Input",
37878
- "module": "src/components/input/input.component.ts"
37877
+ "name": "FormfieldWrapper",
37878
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
37879
37879
  }
37880
37880
  },
37881
37881
  {
37882
- "description": "Border color for the input container when warning",
37883
- "name": "--mdc-input-warning-border-color",
37882
+ "description": "The container for the helper/validation icon and text elements.",
37883
+ "name": "help-text-container",
37884
37884
  "inheritedFrom": {
37885
- "name": "Input",
37886
- "module": "src/components/input/input.component.ts"
37885
+ "name": "FormfieldWrapper",
37886
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
37887
37887
  }
37888
37888
  },
37889
37889
  {
37890
- "description": "Border color for the input container when success",
37891
- "name": "--mdc-input-success-border-color",
37890
+ "description": "Formfieldgroup host container",
37891
+ "name": "container",
37892
37892
  "inheritedFrom": {
37893
- "name": "Input",
37894
- "module": "src/components/input/input.component.ts"
37893
+ "name": "FormfieldGroup",
37894
+ "module": "src/components/formfieldgroup/formfieldgroup.component.ts"
37895
37895
  }
37896
37896
  },
37897
37897
  {
37898
- "description": "Border color for the input container when primary",
37899
- "name": "--mdc-input-primary-border-color",
37898
+ "description": "This contains the label and help text for the group",
37899
+ "name": "group-header",
37900
37900
  "inheritedFrom": {
37901
- "name": "Input",
37902
- "module": "src/components/input/input.component.ts"
37901
+ "name": "FormfieldGroup",
37902
+ "module": "src/components/formfieldgroup/formfieldgroup.component.ts"
37903
37903
  }
37904
37904
  }
37905
37905
  ]
@@ -37910,8 +37910,8 @@
37910
37910
  "kind": "js",
37911
37911
  "name": "default",
37912
37912
  "declaration": {
37913
- "name": "Searchfield",
37914
- "module": "components/searchfield/searchfield.component.js"
37913
+ "name": "RadioGroup",
37914
+ "module": "components/radiogroup/radiogroup.component.js"
37915
37915
  }
37916
37916
  }
37917
37917
  ]
@@ -39093,278 +39093,55 @@
39093
39093
  "module": "/src/utils/mixins/AutoFocusOnMountMixin"
39094
39094
  },
39095
39095
  {
39096
- "name": "FormInternalsMixin",
39097
- "module": "/src/utils/mixins/FormInternalsMixin"
39098
- },
39099
- {
39100
- "name": "DataAriaLabelMixin",
39101
- "module": "/src/utils/mixins/DataAriaLabelMixin"
39102
- }
39103
- ],
39104
- "superclass": {
39105
- "name": "FormfieldWrapper",
39106
- "module": "/src/components/formfieldwrapper/formfieldwrapper.component"
39107
- },
39108
- "tagName": "mdc-select",
39109
- "jsDoc": "/**\n * The mdc-select component is a dropdown selection control that allows users to pick an option from a predefined list.\n * It is designed to work with `mdc-option` for individual options and `mdc-optgroup` for grouping related options.\n *\n * Every mdc-option should have a `value` attribute set to ensure proper form submission.\n *\n * To set a default option, use the `selected` attribute on the `mdc-option` element.\n * You can also set the `value` attribute on the `mdc-select` element to match the value of the desired option. The component will select the corresponding option automatically.\n *\n * **Note:** Make sure to add `mdc-selectlistbox` as a child of `mdc-select` and wrap options/optgroup in it to ensure proper accessibility functionality. Read more about it in SelectListBox documentation.\n *\n * If you need to use `mdc-tooltip` with any options, make sure to place the tooltip component outside the `mdc-select` element.\n *\n * @dependency mdc-button\n * @dependency mdc-icon\n * @dependency mdc-popover\n * @dependency mdc-text\n * @dependency mdc-toggletip\n *\n * @tagname mdc-select\n *\n * @slot default - This is a default/unnamed slot for Selectlistbox including options and/or option group.\n *\n * @event click - (React: onClick) This event is dispatched when the select is clicked.\n * @event change - (React: onChange) This event is dispatched when the select is changed.\n * @event input - (React: onInput) This event is dispatched when the select is changed.\n * @event keydown - (React: onKeyDown) This event is dispatched when a key is pressed down on the select.\n * @event focus - (React: onFocus) This event is dispatched when the select receives focus.\n *\n * @cssproperty --mdc-select-background-color - The background color of the combobox of select.\n * @cssproperty --mdc-select-background-color-hover - The background color of the combobox of select when hovered.\n * @cssproperty --mdc-select-background-color-active - The background color of the combobox of select when active.\n * @cssproperty --mdc-select-background-color-disabled - The background color of the combobox of select when disabled.\n * @cssproperty --mdc-select-text-color - The text color of the select.\n * @cssproperty --mdc-select-text-color-selected - The text color of the selected option in the select.\n * @cssproperty --mdc-select-text-color-disabled - The text color of the select when disabled.\n * @cssproperty --mdc-select-border-color - The border color of the select.\n * @cssproperty --mdc-select-border-color-disabled - The border color of the select when disabled.\n * @cssproperty --mdc-select-border-color-success - The border color of the select when in success state.\n * @cssproperty --mdc-select-border-color-warning - The border color of the select when in warning state.\n * @cssproperty --mdc-select-border-color-error - The border color of the select when in error state.\n * @cssproperty --mdc-select-width - The width of the select.\n * @cssproperty --mdc-select-listbox-height - The height of the listbox inside the select.\n * @cssproperty --mdc-select-listbox-width - The width of the listbox inside the select (default: `--mdc-select-width`).\n *\n * @csspart label - The label element.\n * @csspart label-text - The container for the label and required indicator elements.\n * @csspart required-indicator - The required indicator element that is displayed next to the label when the `required` property is set to true.\n * @csspart info-icon-btn - The info icon button element that is displayed next to the label when the `toggletip-text` property is set.\n * @csspart label-toggletip - The toggletip element that is displayed when the info icon button is clicked.\n * @csspart help-text - The helper/validation text element.\n * @csspart helper-icon - The helper/validation icon element that is displayed next to the helper/validation text.\n * @csspart help-text-container - The container for the helper/validation icon and text elements.\n * @csspart container - The container element that wraps the visual combobox and the dropdown icon.\n * @csspart base-container - The container element that wraps the visual combobox, dropdown icon, and the popover.\n * @csspart selected-icon - The icon element that is displayed next to the selected option in the dropdown list.\n * @csspart base-text - The text element that displays the selected option or placeholder in the visual combobox.\n * @csspart icon-container - The container element that wraps the dropdown icon.\n * @csspart native-input - The native hidden input element.\n */",
39110
- "customElement": true
39111
- }
39112
- ],
39113
- "exports": [
39114
- {
39115
- "kind": "js",
39116
- "name": "default",
39117
- "declaration": {
39118
- "name": "Select",
39119
- "module": "components/select/select.component.js"
39120
- }
39121
- }
39122
- ]
39123
- },
39124
- {
39125
- "kind": "javascript-module",
39126
- "path": "components/selectlistbox/selectlistbox.component.js",
39127
- "declarations": [
39128
- {
39129
- "kind": "class",
39130
- "description": "Selectlistbox component as Light DOM component to act as a simple wrapper\nfor mdc-option components to ensure accessibility and proper role assignment.\n\nOnce [ariaOwnsElements](https://developer.mozilla.org/en-US/docs/Web/API/ElementInternals/ariaOwnsElements) is supported in browsers, this component can be removed\nand mdc-option can be used directly in the select component with a listbox in a different\nshadow root and aria-owns attribute to connect them.",
39131
- "name": "Selectlistbox",
39132
- "slots": [
39133
- {
39134
- "description": "This is a default/unnamed slot, which can be used to insert mdc-option components.",
39135
- "name": "default"
39136
- }
39137
- ],
39138
- "members": [],
39139
- "superclass": {
39140
- "name": "Component",
39141
- "module": "/src/models"
39142
- },
39143
- "tagName": "mdc-selectlistbox",
39144
- "jsDoc": "/**\n * Selectlistbox component as Light DOM component to act as a simple wrapper\n * for mdc-option components to ensure accessibility and proper role assignment.\n *\n * Once [ariaOwnsElements](https://developer.mozilla.org/en-US/docs/Web/API/ElementInternals/ariaOwnsElements) is supported in browsers, this component can be removed\n * and mdc-option can be used directly in the select component with a listbox in a different\n * shadow root and aria-owns attribute to connect them.\n *\n * @tagname mdc-selectlistbox\n *\n * @slot default - This is a default/unnamed slot, which can be used to insert mdc-option components.\n */",
39145
- "customElement": true
39146
- }
39147
- ],
39148
- "exports": [
39149
- {
39150
- "kind": "js",
39151
- "name": "default",
39152
- "declaration": {
39153
- "name": "Selectlistbox",
39154
- "module": "components/selectlistbox/selectlistbox.component.js"
39155
- }
39156
- }
39157
- ]
39158
- },
39159
- {
39160
- "kind": "javascript-module",
39161
- "path": "components/sidenavigation/sidenavigation.component.js",
39162
- "declarations": [
39163
- {
39164
- "kind": "class",
39165
- "description": "The `mdc-sidenavigation` component provides a vertically stacked navigation experience,\ntypically used in layouts with persistent or collapsible sidebars.\n\n## Features:\n- Supports four layout variants: `fixed-collapsed`, `fixed-expanded`, `flexible`, and `hidden`\n- Toggleable expand/collapse behavior\n- Displays brand logo and customer name\n- Serves as a context provider for descendant components - `mdc-menubar` and `mdc-navmenuitem`\n\n### Usage:\nIn a sidenavigation, navmenuitems can be used in the following ways:\n\n1. **Simple navmenuitem** – No submenu or interaction beyond selection.\n\n2. **NavMenuItem with submenu**:\n - Provide an `id` on the `mdc-navmenuitem`\n - Set the `triggerId` on the corresponding `mdc-menupopover` to match the navmenuitem's `id`\n - Set `parent-nav-tooltip-text` with appropriate text that will display when a child menu item\n inside the nested menupopover is active, conveying which submenu item is currently selected\n\n3. **Actionable navmenuitem (no submenu)**:\n - Performs an action such as navigation or alert trigger\n - Set `disable-aria-current=\"true\"` to maintain visual active state without navigation behavior\n\n### Recommendations:\n- Use `mdc-text` for section headers\n- Use `mdc-divider` with the attribute `variant=\"gradient\"` for section dividers\n- For the brand logo, use an informative icon. Refer to `Momentum Informative Icons`\n\n#### Accessibility Notes:\n- Always provide meaningful `aria-label` attributes for both `mdc-navmenuitem` and `mdc-menubar`\nto ensure screen reader support\n- Set `grabber-btn-aria-label` to provide accessible labels for the expand/collapse grabber button",
39166
- "name": "SideNavigation",
39167
- "cssProperties": [
39168
- {
39169
- "description": "width of the sideNavigation when expanded",
39170
- "name": "--mdc-sidenavigation-expanded-width"
39171
- },
39172
- {
39173
- "description": "width of the sideNavigation when collapsed",
39174
- "name": "--mdc-sidenavigation-collapsed-width"
39175
- },
39176
- {
39177
- "description": "z-index of the vertical divider button",
39178
- "name": "--mdc-sidenavigation-vertical-divider-button-z-index"
39179
- }
39180
- ],
39181
- "cssParts": [
39182
- {
39183
- "description": "The main container wrapping the entire side navigation.",
39184
- "name": "side-navigation-container"
39185
- },
39186
- {
39187
- "description": "The scrollable section of the side navigation.",
39188
- "name": "scrollable-section"
39189
- },
39190
- {
39191
- "description": "The fixed section of the side navigation.",
39192
- "name": "fixed-section"
39193
- },
39194
- {
39195
- "description": "The divider between the scrollable and fixed sections.",
39196
- "name": "separator"
39197
- },
39198
- {
39199
- "description": "The container wrapping the brand logo and footer text.",
39200
- "name": "brand-logo-container"
39201
- },
39202
- {
39203
- "description": "The footer text label in the fixed section.",
39204
- "name": "footer-text"
39205
- },
39206
- {
39207
- "description": "The vertical divider between the scrollable and fixed sections.",
39208
- "name": "vertical-divider"
39209
- },
39210
- {
39211
- "description": "The button inside the vertical divider used to toggle expand/collapse.",
39212
- "name": "vertical-divider-button"
39213
- }
39214
- ],
39215
- "slots": [
39216
- {
39217
- "description": "Slot for the scrollable content area of the side navigation.",
39218
- "name": "scrollable-section"
39219
- },
39220
- {
39221
- "description": "Slot for the fixed content area of the side navigation.",
39222
- "name": "fixed-section"
39223
- },
39224
- {
39225
- "description": "Slot for the brand logo (e.g., icon or img).",
39226
- "name": "brand-logo"
39227
- }
39228
- ],
39229
- "members": [
39230
- {
39231
- "kind": "field",
39232
- "name": "variant",
39233
- "type": {
39234
- "text": "SideNavigationVariant"
39235
- },
39236
- "description": "Four variants of the sideNavigation\n- **fixed-collapsed**: Shows icons without labels and has fixed width, 4.5rem.\n- **fixed-expanded**: Shows icons with labels and has fixed width, 15rem.\n- **flexible**: Toggles between collapsed/expanded states.\n- **hidden**: Removes the sidenavigation from the DOM.",
39237
- "default": "flexible",
39238
- "attribute": "variant",
39239
- "reflects": true
39240
- },
39241
- {
39242
- "kind": "field",
39243
- "name": "footerText",
39244
- "type": {
39245
- "text": "string"
39246
- },
39247
- "default": "''",
39248
- "description": "Displays footer text in the bottom section of the sidenavigation.",
39249
- "attribute": "footer-text",
39250
- "reflects": true
39251
- },
39252
- {
39253
- "kind": "field",
39254
- "name": "grabberBtnAriaLabel",
39255
- "type": {
39256
- "text": "string | undefined"
39257
- },
39258
- "description": "Provides an accessible label for the grabber button.\nThis value is used to set the `aria-label` attribute for the button.",
39259
- "default": "''",
39260
- "attribute": "grabber-btn-aria-label",
39261
- "reflects": true
39262
- },
39263
- {
39264
- "kind": "field",
39265
- "name": "parentNavTooltipText",
39266
- "type": {
39267
- "text": "string | undefined"
39268
- },
39269
- "description": "Tooltip text shown on parent nav items when a child is active.",
39270
- "attribute": "parent-nav-tooltip-text",
39271
- "reflects": true
39272
- },
39273
- {
39274
- "kind": "field",
39275
- "name": "Context",
39276
- "privacy": "public",
39277
- "static": true,
39278
- "readonly": true
39279
- },
39280
- {
39281
- "kind": "method",
39282
- "name": "updateContext",
39283
- "privacy": "protected",
39284
- "return": {
39285
- "type": {
39286
- "text": "void"
39287
- }
39288
- },
39289
- "description": "Update all observing components of this\nprovider to update the values\n\nIs called on every re-render, see Provider class"
39290
- },
39291
- {
39292
- "kind": "method",
39293
- "name": "preventScrollOnSpace",
39294
- "privacy": "private",
39295
- "return": {
39296
- "type": {
39297
- "text": "void"
39298
- }
39299
- },
39300
- "parameters": [
39301
- {
39302
- "name": "event",
39303
- "type": {
39304
- "text": "KeyboardEvent"
39305
- }
39306
- }
39307
- ]
39308
- }
39309
- ],
39310
- "events": [
39311
- {
39312
- "name": "toggle",
39313
- "type": {
39314
- "text": "CustomEvent"
39315
- },
39316
- "description": "(React: onToggle) Dispatched when the grabber button is clicked to expand/collapse the sidenavigation.",
39317
- "reactName": "onToggle"
39318
- },
39319
- {
39320
- "description": "(React: onActiveChange) Dispatched when the active state of a nested navmenuitem changes.",
39321
- "name": "activechange",
39322
- "reactName": "onActiveChange"
39323
- }
39324
- ],
39325
- "attributes": [
39326
- {
39327
- "name": "variant",
39328
- "type": {
39329
- "text": "SideNavigationVariant"
39330
- },
39331
- "description": "Four variants of the sideNavigation\n- **fixed-collapsed**: Shows icons without labels and has fixed width, 4.5rem.\n- **fixed-expanded**: Shows icons with labels and has fixed width, 15rem.\n- **flexible**: Toggles between collapsed/expanded states.\n- **hidden**: Removes the sidenavigation from the DOM.",
39332
- "default": "flexible",
39333
- "fieldName": "variant"
39334
- },
39335
- {
39336
- "name": "footer-text",
39337
- "type": {
39338
- "text": "string"
39339
- },
39340
- "default": "''",
39341
- "description": "Displays footer text in the bottom section of the sidenavigation.",
39342
- "fieldName": "footerText"
39343
- },
39344
- {
39345
- "name": "grabber-btn-aria-label",
39346
- "type": {
39347
- "text": "string | undefined"
39348
- },
39349
- "description": "Provides an accessible label for the grabber button.\nThis value is used to set the `aria-label` attribute for the button.",
39350
- "default": "''",
39351
- "fieldName": "grabberBtnAriaLabel"
39096
+ "name": "FormInternalsMixin",
39097
+ "module": "/src/utils/mixins/FormInternalsMixin"
39352
39098
  },
39353
39099
  {
39354
- "name": "parent-nav-tooltip-text",
39355
- "type": {
39356
- "text": "string | undefined"
39357
- },
39358
- "description": "Tooltip text shown on parent nav items when a child is active.",
39359
- "fieldName": "parentNavTooltipText"
39100
+ "name": "DataAriaLabelMixin",
39101
+ "module": "/src/utils/mixins/DataAriaLabelMixin"
39360
39102
  }
39361
39103
  ],
39362
39104
  "superclass": {
39363
- "name": "Provider",
39105
+ "name": "FormfieldWrapper",
39106
+ "module": "/src/components/formfieldwrapper/formfieldwrapper.component"
39107
+ },
39108
+ "tagName": "mdc-select",
39109
+ "jsDoc": "/**\n * The mdc-select component is a dropdown selection control that allows users to pick an option from a predefined list.\n * It is designed to work with `mdc-option` for individual options and `mdc-optgroup` for grouping related options.\n *\n * Every mdc-option should have a `value` attribute set to ensure proper form submission.\n *\n * To set a default option, use the `selected` attribute on the `mdc-option` element.\n * You can also set the `value` attribute on the `mdc-select` element to match the value of the desired option. The component will select the corresponding option automatically.\n *\n * **Note:** Make sure to add `mdc-selectlistbox` as a child of `mdc-select` and wrap options/optgroup in it to ensure proper accessibility functionality. Read more about it in SelectListBox documentation.\n *\n * If you need to use `mdc-tooltip` with any options, make sure to place the tooltip component outside the `mdc-select` element.\n *\n * @dependency mdc-button\n * @dependency mdc-icon\n * @dependency mdc-popover\n * @dependency mdc-text\n * @dependency mdc-toggletip\n *\n * @tagname mdc-select\n *\n * @slot default - This is a default/unnamed slot for Selectlistbox including options and/or option group.\n *\n * @event click - (React: onClick) This event is dispatched when the select is clicked.\n * @event change - (React: onChange) This event is dispatched when the select is changed.\n * @event input - (React: onInput) This event is dispatched when the select is changed.\n * @event keydown - (React: onKeyDown) This event is dispatched when a key is pressed down on the select.\n * @event focus - (React: onFocus) This event is dispatched when the select receives focus.\n *\n * @cssproperty --mdc-select-background-color - The background color of the combobox of select.\n * @cssproperty --mdc-select-background-color-hover - The background color of the combobox of select when hovered.\n * @cssproperty --mdc-select-background-color-active - The background color of the combobox of select when active.\n * @cssproperty --mdc-select-background-color-disabled - The background color of the combobox of select when disabled.\n * @cssproperty --mdc-select-text-color - The text color of the select.\n * @cssproperty --mdc-select-text-color-selected - The text color of the selected option in the select.\n * @cssproperty --mdc-select-text-color-disabled - The text color of the select when disabled.\n * @cssproperty --mdc-select-border-color - The border color of the select.\n * @cssproperty --mdc-select-border-color-disabled - The border color of the select when disabled.\n * @cssproperty --mdc-select-border-color-success - The border color of the select when in success state.\n * @cssproperty --mdc-select-border-color-warning - The border color of the select when in warning state.\n * @cssproperty --mdc-select-border-color-error - The border color of the select when in error state.\n * @cssproperty --mdc-select-width - The width of the select.\n * @cssproperty --mdc-select-listbox-height - The height of the listbox inside the select.\n * @cssproperty --mdc-select-listbox-width - The width of the listbox inside the select (default: `--mdc-select-width`).\n *\n * @csspart label - The label element.\n * @csspart label-text - The container for the label and required indicator elements.\n * @csspart required-indicator - The required indicator element that is displayed next to the label when the `required` property is set to true.\n * @csspart info-icon-btn - The info icon button element that is displayed next to the label when the `toggletip-text` property is set.\n * @csspart label-toggletip - The toggletip element that is displayed when the info icon button is clicked.\n * @csspart help-text - The helper/validation text element.\n * @csspart helper-icon - The helper/validation icon element that is displayed next to the helper/validation text.\n * @csspart help-text-container - The container for the helper/validation icon and text elements.\n * @csspart container - The container element that wraps the visual combobox and the dropdown icon.\n * @csspart base-container - The container element that wraps the visual combobox, dropdown icon, and the popover.\n * @csspart selected-icon - The icon element that is displayed next to the selected option in the dropdown list.\n * @csspart base-text - The text element that displays the selected option or placeholder in the visual combobox.\n * @csspart icon-container - The container element that wraps the dropdown icon.\n * @csspart native-input - The native hidden input element.\n */",
39110
+ "customElement": true
39111
+ }
39112
+ ],
39113
+ "exports": [
39114
+ {
39115
+ "kind": "js",
39116
+ "name": "default",
39117
+ "declaration": {
39118
+ "name": "Select",
39119
+ "module": "components/select/select.component.js"
39120
+ }
39121
+ }
39122
+ ]
39123
+ },
39124
+ {
39125
+ "kind": "javascript-module",
39126
+ "path": "components/selectlistbox/selectlistbox.component.js",
39127
+ "declarations": [
39128
+ {
39129
+ "kind": "class",
39130
+ "description": "Selectlistbox component as Light DOM component to act as a simple wrapper\nfor mdc-option components to ensure accessibility and proper role assignment.\n\nOnce [ariaOwnsElements](https://developer.mozilla.org/en-US/docs/Web/API/ElementInternals/ariaOwnsElements) is supported in browsers, this component can be removed\nand mdc-option can be used directly in the select component with a listbox in a different\nshadow root and aria-owns attribute to connect them.",
39131
+ "name": "Selectlistbox",
39132
+ "slots": [
39133
+ {
39134
+ "description": "This is a default/unnamed slot, which can be used to insert mdc-option components.",
39135
+ "name": "default"
39136
+ }
39137
+ ],
39138
+ "members": [],
39139
+ "superclass": {
39140
+ "name": "Component",
39364
39141
  "module": "/src/models"
39365
39142
  },
39366
- "tagName": "mdc-sidenavigation",
39367
- "jsDoc": "/**\n * The `mdc-sidenavigation` component provides a vertically stacked navigation experience,\n * typically used in layouts with persistent or collapsible sidebars.\n *\n * ## Features:\n * - Supports four layout variants: `fixed-collapsed`, `fixed-expanded`, `flexible`, and `hidden`\n * - Toggleable expand/collapse behavior\n * - Displays brand logo and customer name\n * - Serves as a context provider for descendant components - `mdc-menubar` and `mdc-navmenuitem`\n *\n * ### Usage:\n * In a sidenavigation, navmenuitems can be used in the following ways:\n *\n * 1. **Simple navmenuitem** – No submenu or interaction beyond selection.\n *\n * 2. **NavMenuItem with submenu**:\n * - Provide an `id` on the `mdc-navmenuitem`\n * - Set the `triggerId` on the corresponding `mdc-menupopover` to match the navmenuitem's `id`\n * - Set `parent-nav-tooltip-text` with appropriate text that will display when a child menu item\n * inside the nested menupopover is active, conveying which submenu item is currently selected\n *\n * 3. **Actionable navmenuitem (no submenu)**:\n * - Performs an action such as navigation or alert trigger\n * - Set `disable-aria-current=\"true\"` to maintain visual active state without navigation behavior\n *\n * ### Recommendations:\n * - Use `mdc-text` for section headers\n * - Use `mdc-divider` with the attribute `variant=\"gradient\"` for section dividers\n * - For the brand logo, use an informative icon. Refer to `Momentum Informative Icons`\n *\n * #### Accessibility Notes:\n * - Always provide meaningful `aria-label` attributes for both `mdc-navmenuitem` and `mdc-menubar`\n * to ensure screen reader support\n * - Set `grabber-btn-aria-label` to provide accessible labels for the expand/collapse grabber button\n *\n * @dependency mdc-text\n * @dependency mdc-button\n * @dependency mdc-divider\n * @dependency mdc-menubar\n *\n * @event activechange - (React: onActiveChange) Dispatched when the active state of the navmenuitem changes.\n *\n * @tagname mdc-sidenavigation\n *\n * @slot scrollable-section - Slot for the scrollable content area of the side navigation.\n * @slot fixed-section - Slot for the fixed content area of the side navigation.\n * @slot brand-logo - Slot for the brand logo (e.g., icon or img).\n *\n * @csspart side-navigation-container - The main container wrapping the entire side navigation.\n * @csspart scrollable-section - The scrollable section of the side navigation.\n * @csspart fixed-section - The fixed section of the side navigation.\n * @csspart separator - The divider between the scrollable and fixed sections.\n * @csspart brand-logo-container - The container wrapping the brand logo and footer text.\n * @csspart footer-text - The footer text label in the fixed section.\n * @csspart vertical-divider - The vertical divider between the scrollable and fixed sections.\n * @csspart vertical-divider-button - The button inside the vertical divider used to toggle expand/collapse.\n *\n * @event toggle - (React: onToggle) Dispatched when the grabber button is clicked to expand/collapse the sidenavigation.\n * @event activechange - (React: onActiveChange) Dispatched when the active state of a nested navmenuitem changes.\n *\n * @cssproperty --mdc-sidenavigation-expanded-width - width of the sideNavigation when expanded\n * @cssproperty --mdc-sidenavigation-collapsed-width - width of the sideNavigation when collapsed\n * @cssproperty --mdc-sidenavigation-vertical-divider-button-z-index - z-index of the vertical divider button\n */",
39143
+ "tagName": "mdc-selectlistbox",
39144
+ "jsDoc": "/**\n * Selectlistbox component as Light DOM component to act as a simple wrapper\n * for mdc-option components to ensure accessibility and proper role assignment.\n *\n * Once [ariaOwnsElements](https://developer.mozilla.org/en-US/docs/Web/API/ElementInternals/ariaOwnsElements) is supported in browsers, this component can be removed\n * and mdc-option can be used directly in the select component with a listbox in a different\n * shadow root and aria-owns attribute to connect them.\n *\n * @tagname mdc-selectlistbox\n *\n * @slot default - This is a default/unnamed slot, which can be used to insert mdc-option components.\n */",
39368
39145
  "customElement": true
39369
39146
  }
39370
39147
  ],
@@ -39373,8 +39150,8 @@
39373
39150
  "kind": "js",
39374
39151
  "name": "default",
39375
39152
  "declaration": {
39376
- "name": "SideNavigation",
39377
- "module": "components/sidenavigation/sidenavigation.component.js"
39153
+ "name": "Selectlistbox",
39154
+ "module": "components/selectlistbox/selectlistbox.component.js"
39378
39155
  }
39379
39156
  }
39380
39157
  ]
@@ -40174,60 +39951,283 @@
40174
39951
  "fieldName": "nameEnd"
40175
39952
  },
40176
39953
  {
40177
- "name": "data-aria-label",
40178
- "type": {
40179
- "text": "string | undefined"
39954
+ "name": "data-aria-label",
39955
+ "type": {
39956
+ "text": "string | undefined"
39957
+ },
39958
+ "description": "Aria label for the slider's handle displayed when range is false.",
39959
+ "fieldName": "dataAriaLabel"
39960
+ },
39961
+ {
39962
+ "name": "start-aria-label",
39963
+ "type": {
39964
+ "text": "string | undefined"
39965
+ },
39966
+ "description": "Aria label for the slider's start handle displayed when range is true.",
39967
+ "fieldName": "startAriaLabel"
39968
+ },
39969
+ {
39970
+ "name": "end-aria-label",
39971
+ "type": {
39972
+ "text": "string | undefined"
39973
+ },
39974
+ "description": "Aria label for the slider's end handle displayed when range is true.",
39975
+ "fieldName": "endAriaLabel"
39976
+ },
39977
+ {
39978
+ "name": "data-aria-valuetext",
39979
+ "type": {
39980
+ "text": "string | undefined"
39981
+ },
39982
+ "description": "Aria value text for the slider's value displayed when range is false.",
39983
+ "fieldName": "dataAriaValuetext"
39984
+ },
39985
+ {
39986
+ "name": "start-aria-valuetext",
39987
+ "type": {
39988
+ "text": "string | undefined"
39989
+ },
39990
+ "description": "Aria value text for the slider's start value displayed when range is true.",
39991
+ "fieldName": "startAriaValuetext"
39992
+ },
39993
+ {
39994
+ "name": "end-aria-valuetext",
39995
+ "type": {
39996
+ "text": "string | undefined"
39997
+ },
39998
+ "description": "Aria value text for the slider's end value displayed when range is true.",
39999
+ "fieldName": "endAriaValueText"
40000
+ }
40001
+ ],
40002
+ "superclass": {
40003
+ "name": "Component",
40004
+ "module": "/src/models"
40005
+ },
40006
+ "tagName": "mdc-slider",
40007
+ "jsDoc": "/**\n * Slider component is used to select a value or range of values from within a defined range.\n * It provides a visual representation of the current value(s) and allows users to adjust the value(s) by dragging the thumb(s) along the track.\n * It can be used as a single slider or a range slider. This is set by the boolean attribute `range`\n * If the step value is more than 1, tick marks are shown to represent the steps between the min and max values. The slider thumb will snap to the nearest tick mark.\n *\n * @tagname mdc-slider\n *\n * @dependency mdc-icon\n *\n * @csspart slider-tooltip - The tooltip of the slider\n * @csspart slider-track - The track of the slider\n * @csspart slider-wrapper - The wrapper around the slider input(s)\n * @csspart slider-ticks - The container for the tick marks\n * @csspart slider-tick - The individual tick marks\n * @csspart slider-input - The input element of the slider\n * @csspart slider-label - The label of the slider\n *\n * @event input - Fired when the slider value changes\n * @event change - Fired when the slider value is committed\n *\n * @cssproperty --mdc-slider-thumb-color - The color of the slider thumb\n * @cssproperty --mdc-slider-thumb-border-color - The color of the slider thumb border\n * @cssproperty --mdc-slider-thumb-size - The size of the slider thumb\n * @cssproperty --mdc-slider-input-size - The height of the slider input\n * @cssproperty --mdc-slider-tick-size - The size of the slider tick marks\n * @cssproperty --mdc-slider-track-height - The height of the slider track\n * @cssproperty --mdc-slider-tick-color - The color of the slider tick marks\n * @cssproperty --mdc-slider-progress-color - The color of the slider progress\n * @cssproperty --mdc-slider-track-color - The color of the slider track\n * @cssproperty --mdc-slider-tooltip-left - The left position of the slider tooltip\n * @cssproperty --mdc-slider-tick-left - The left position of the slider tick marks\n */",
40008
+ "customElement": true
40009
+ }
40010
+ ],
40011
+ "exports": [
40012
+ {
40013
+ "kind": "js",
40014
+ "name": "default",
40015
+ "declaration": {
40016
+ "name": "Slider",
40017
+ "module": "components/slider/slider.component.js"
40018
+ }
40019
+ }
40020
+ ]
40021
+ },
40022
+ {
40023
+ "kind": "javascript-module",
40024
+ "path": "components/sidenavigation/sidenavigation.component.js",
40025
+ "declarations": [
40026
+ {
40027
+ "kind": "class",
40028
+ "description": "The `mdc-sidenavigation` component provides a vertically stacked navigation experience,\ntypically used in layouts with persistent or collapsible sidebars.\n\n## Features:\n- Supports four layout variants: `fixed-collapsed`, `fixed-expanded`, `flexible`, and `hidden`\n- Toggleable expand/collapse behavior\n- Displays brand logo and customer name\n- Serves as a context provider for descendant components - `mdc-menubar` and `mdc-navmenuitem`\n\n### Usage:\nIn a sidenavigation, navmenuitems can be used in the following ways:\n\n1. **Simple navmenuitem** – No submenu or interaction beyond selection.\n\n2. **NavMenuItem with submenu**:\n - Provide an `id` on the `mdc-navmenuitem`\n - Set the `triggerId` on the corresponding `mdc-menupopover` to match the navmenuitem's `id`\n - Set `parent-nav-tooltip-text` with appropriate text that will display when a child menu item\n inside the nested menupopover is active, conveying which submenu item is currently selected\n\n3. **Actionable navmenuitem (no submenu)**:\n - Performs an action such as navigation or alert trigger\n - Set `disable-aria-current=\"true\"` to maintain visual active state without navigation behavior\n\n### Recommendations:\n- Use `mdc-text` for section headers\n- Use `mdc-divider` with the attribute `variant=\"gradient\"` for section dividers\n- For the brand logo, use an informative icon. Refer to `Momentum Informative Icons`\n\n#### Accessibility Notes:\n- Always provide meaningful `aria-label` attributes for both `mdc-navmenuitem` and `mdc-menubar`\nto ensure screen reader support\n- Set `grabber-btn-aria-label` to provide accessible labels for the expand/collapse grabber button",
40029
+ "name": "SideNavigation",
40030
+ "cssProperties": [
40031
+ {
40032
+ "description": "width of the sideNavigation when expanded",
40033
+ "name": "--mdc-sidenavigation-expanded-width"
40034
+ },
40035
+ {
40036
+ "description": "width of the sideNavigation when collapsed",
40037
+ "name": "--mdc-sidenavigation-collapsed-width"
40038
+ },
40039
+ {
40040
+ "description": "z-index of the vertical divider button",
40041
+ "name": "--mdc-sidenavigation-vertical-divider-button-z-index"
40042
+ }
40043
+ ],
40044
+ "cssParts": [
40045
+ {
40046
+ "description": "The main container wrapping the entire side navigation.",
40047
+ "name": "side-navigation-container"
40048
+ },
40049
+ {
40050
+ "description": "The scrollable section of the side navigation.",
40051
+ "name": "scrollable-section"
40052
+ },
40053
+ {
40054
+ "description": "The fixed section of the side navigation.",
40055
+ "name": "fixed-section"
40056
+ },
40057
+ {
40058
+ "description": "The divider between the scrollable and fixed sections.",
40059
+ "name": "separator"
40060
+ },
40061
+ {
40062
+ "description": "The container wrapping the brand logo and footer text.",
40063
+ "name": "brand-logo-container"
40064
+ },
40065
+ {
40066
+ "description": "The footer text label in the fixed section.",
40067
+ "name": "footer-text"
40068
+ },
40069
+ {
40070
+ "description": "The vertical divider between the scrollable and fixed sections.",
40071
+ "name": "vertical-divider"
40072
+ },
40073
+ {
40074
+ "description": "The button inside the vertical divider used to toggle expand/collapse.",
40075
+ "name": "vertical-divider-button"
40076
+ }
40077
+ ],
40078
+ "slots": [
40079
+ {
40080
+ "description": "Slot for the scrollable content area of the side navigation.",
40081
+ "name": "scrollable-section"
40082
+ },
40083
+ {
40084
+ "description": "Slot for the fixed content area of the side navigation.",
40085
+ "name": "fixed-section"
40086
+ },
40087
+ {
40088
+ "description": "Slot for the brand logo (e.g., icon or img).",
40089
+ "name": "brand-logo"
40090
+ }
40091
+ ],
40092
+ "members": [
40093
+ {
40094
+ "kind": "field",
40095
+ "name": "variant",
40096
+ "type": {
40097
+ "text": "SideNavigationVariant"
40098
+ },
40099
+ "description": "Four variants of the sideNavigation\n- **fixed-collapsed**: Shows icons without labels and has fixed width, 4.5rem.\n- **fixed-expanded**: Shows icons with labels and has fixed width, 15rem.\n- **flexible**: Toggles between collapsed/expanded states.\n- **hidden**: Removes the sidenavigation from the DOM.",
40100
+ "default": "flexible",
40101
+ "attribute": "variant",
40102
+ "reflects": true
40103
+ },
40104
+ {
40105
+ "kind": "field",
40106
+ "name": "footerText",
40107
+ "type": {
40108
+ "text": "string"
40109
+ },
40110
+ "default": "''",
40111
+ "description": "Displays footer text in the bottom section of the sidenavigation.",
40112
+ "attribute": "footer-text",
40113
+ "reflects": true
40114
+ },
40115
+ {
40116
+ "kind": "field",
40117
+ "name": "grabberBtnAriaLabel",
40118
+ "type": {
40119
+ "text": "string | undefined"
40120
+ },
40121
+ "description": "Provides an accessible label for the grabber button.\nThis value is used to set the `aria-label` attribute for the button.",
40122
+ "default": "''",
40123
+ "attribute": "grabber-btn-aria-label",
40124
+ "reflects": true
40125
+ },
40126
+ {
40127
+ "kind": "field",
40128
+ "name": "parentNavTooltipText",
40129
+ "type": {
40130
+ "text": "string | undefined"
40131
+ },
40132
+ "description": "Tooltip text shown on parent nav items when a child is active.",
40133
+ "attribute": "parent-nav-tooltip-text",
40134
+ "reflects": true
40135
+ },
40136
+ {
40137
+ "kind": "field",
40138
+ "name": "Context",
40139
+ "privacy": "public",
40140
+ "static": true,
40141
+ "readonly": true
40142
+ },
40143
+ {
40144
+ "kind": "method",
40145
+ "name": "updateContext",
40146
+ "privacy": "protected",
40147
+ "return": {
40148
+ "type": {
40149
+ "text": "void"
40150
+ }
40151
+ },
40152
+ "description": "Update all observing components of this\nprovider to update the values\n\nIs called on every re-render, see Provider class"
40153
+ },
40154
+ {
40155
+ "kind": "method",
40156
+ "name": "preventScrollOnSpace",
40157
+ "privacy": "private",
40158
+ "return": {
40159
+ "type": {
40160
+ "text": "void"
40161
+ }
40180
40162
  },
40181
- "description": "Aria label for the slider's handle displayed when range is false.",
40182
- "fieldName": "dataAriaLabel"
40183
- },
40163
+ "parameters": [
40164
+ {
40165
+ "name": "event",
40166
+ "type": {
40167
+ "text": "KeyboardEvent"
40168
+ }
40169
+ }
40170
+ ]
40171
+ }
40172
+ ],
40173
+ "events": [
40184
40174
  {
40185
- "name": "start-aria-label",
40175
+ "name": "toggle",
40186
40176
  "type": {
40187
- "text": "string | undefined"
40177
+ "text": "CustomEvent"
40188
40178
  },
40189
- "description": "Aria label for the slider's start handle displayed when range is true.",
40190
- "fieldName": "startAriaLabel"
40179
+ "description": "(React: onToggle) Dispatched when the grabber button is clicked to expand/collapse the sidenavigation.",
40180
+ "reactName": "onToggle"
40191
40181
  },
40192
40182
  {
40193
- "name": "end-aria-label",
40183
+ "description": "(React: onActiveChange) Dispatched when the active state of a nested navmenuitem changes.",
40184
+ "name": "activechange",
40185
+ "reactName": "onActiveChange"
40186
+ }
40187
+ ],
40188
+ "attributes": [
40189
+ {
40190
+ "name": "variant",
40194
40191
  "type": {
40195
- "text": "string | undefined"
40192
+ "text": "SideNavigationVariant"
40196
40193
  },
40197
- "description": "Aria label for the slider's end handle displayed when range is true.",
40198
- "fieldName": "endAriaLabel"
40194
+ "description": "Four variants of the sideNavigation\n- **fixed-collapsed**: Shows icons without labels and has fixed width, 4.5rem.\n- **fixed-expanded**: Shows icons with labels and has fixed width, 15rem.\n- **flexible**: Toggles between collapsed/expanded states.\n- **hidden**: Removes the sidenavigation from the DOM.",
40195
+ "default": "flexible",
40196
+ "fieldName": "variant"
40199
40197
  },
40200
40198
  {
40201
- "name": "data-aria-valuetext",
40199
+ "name": "footer-text",
40202
40200
  "type": {
40203
- "text": "string | undefined"
40201
+ "text": "string"
40204
40202
  },
40205
- "description": "Aria value text for the slider's value displayed when range is false.",
40206
- "fieldName": "dataAriaValuetext"
40203
+ "default": "''",
40204
+ "description": "Displays footer text in the bottom section of the sidenavigation.",
40205
+ "fieldName": "footerText"
40207
40206
  },
40208
40207
  {
40209
- "name": "start-aria-valuetext",
40208
+ "name": "grabber-btn-aria-label",
40210
40209
  "type": {
40211
40210
  "text": "string | undefined"
40212
40211
  },
40213
- "description": "Aria value text for the slider's start value displayed when range is true.",
40214
- "fieldName": "startAriaValuetext"
40212
+ "description": "Provides an accessible label for the grabber button.\nThis value is used to set the `aria-label` attribute for the button.",
40213
+ "default": "''",
40214
+ "fieldName": "grabberBtnAriaLabel"
40215
40215
  },
40216
40216
  {
40217
- "name": "end-aria-valuetext",
40217
+ "name": "parent-nav-tooltip-text",
40218
40218
  "type": {
40219
40219
  "text": "string | undefined"
40220
40220
  },
40221
- "description": "Aria value text for the slider's end value displayed when range is true.",
40222
- "fieldName": "endAriaValueText"
40221
+ "description": "Tooltip text shown on parent nav items when a child is active.",
40222
+ "fieldName": "parentNavTooltipText"
40223
40223
  }
40224
40224
  ],
40225
40225
  "superclass": {
40226
- "name": "Component",
40226
+ "name": "Provider",
40227
40227
  "module": "/src/models"
40228
40228
  },
40229
- "tagName": "mdc-slider",
40230
- "jsDoc": "/**\n * Slider component is used to select a value or range of values from within a defined range.\n * It provides a visual representation of the current value(s) and allows users to adjust the value(s) by dragging the thumb(s) along the track.\n * It can be used as a single slider or a range slider. This is set by the boolean attribute `range`\n * If the step value is more than 1, tick marks are shown to represent the steps between the min and max values. The slider thumb will snap to the nearest tick mark.\n *\n * @tagname mdc-slider\n *\n * @dependency mdc-icon\n *\n * @csspart slider-tooltip - The tooltip of the slider\n * @csspart slider-track - The track of the slider\n * @csspart slider-wrapper - The wrapper around the slider input(s)\n * @csspart slider-ticks - The container for the tick marks\n * @csspart slider-tick - The individual tick marks\n * @csspart slider-input - The input element of the slider\n * @csspart slider-label - The label of the slider\n *\n * @event input - Fired when the slider value changes\n * @event change - Fired when the slider value is committed\n *\n * @cssproperty --mdc-slider-thumb-color - The color of the slider thumb\n * @cssproperty --mdc-slider-thumb-border-color - The color of the slider thumb border\n * @cssproperty --mdc-slider-thumb-size - The size of the slider thumb\n * @cssproperty --mdc-slider-input-size - The height of the slider input\n * @cssproperty --mdc-slider-tick-size - The size of the slider tick marks\n * @cssproperty --mdc-slider-track-height - The height of the slider track\n * @cssproperty --mdc-slider-tick-color - The color of the slider tick marks\n * @cssproperty --mdc-slider-progress-color - The color of the slider progress\n * @cssproperty --mdc-slider-track-color - The color of the slider track\n * @cssproperty --mdc-slider-tooltip-left - The left position of the slider tooltip\n * @cssproperty --mdc-slider-tick-left - The left position of the slider tick marks\n */",
40229
+ "tagName": "mdc-sidenavigation",
40230
+ "jsDoc": "/**\n * The `mdc-sidenavigation` component provides a vertically stacked navigation experience,\n * typically used in layouts with persistent or collapsible sidebars.\n *\n * ## Features:\n * - Supports four layout variants: `fixed-collapsed`, `fixed-expanded`, `flexible`, and `hidden`\n * - Toggleable expand/collapse behavior\n * - Displays brand logo and customer name\n * - Serves as a context provider for descendant components - `mdc-menubar` and `mdc-navmenuitem`\n *\n * ### Usage:\n * In a sidenavigation, navmenuitems can be used in the following ways:\n *\n * 1. **Simple navmenuitem** – No submenu or interaction beyond selection.\n *\n * 2. **NavMenuItem with submenu**:\n * - Provide an `id` on the `mdc-navmenuitem`\n * - Set the `triggerId` on the corresponding `mdc-menupopover` to match the navmenuitem's `id`\n * - Set `parent-nav-tooltip-text` with appropriate text that will display when a child menu item\n * inside the nested menupopover is active, conveying which submenu item is currently selected\n *\n * 3. **Actionable navmenuitem (no submenu)**:\n * - Performs an action such as navigation or alert trigger\n * - Set `disable-aria-current=\"true\"` to maintain visual active state without navigation behavior\n *\n * ### Recommendations:\n * - Use `mdc-text` for section headers\n * - Use `mdc-divider` with the attribute `variant=\"gradient\"` for section dividers\n * - For the brand logo, use an informative icon. Refer to `Momentum Informative Icons`\n *\n * #### Accessibility Notes:\n * - Always provide meaningful `aria-label` attributes for both `mdc-navmenuitem` and `mdc-menubar`\n * to ensure screen reader support\n * - Set `grabber-btn-aria-label` to provide accessible labels for the expand/collapse grabber button\n *\n * @dependency mdc-text\n * @dependency mdc-button\n * @dependency mdc-divider\n * @dependency mdc-menubar\n *\n * @event activechange - (React: onActiveChange) Dispatched when the active state of the navmenuitem changes.\n *\n * @tagname mdc-sidenavigation\n *\n * @slot scrollable-section - Slot for the scrollable content area of the side navigation.\n * @slot fixed-section - Slot for the fixed content area of the side navigation.\n * @slot brand-logo - Slot for the brand logo (e.g., icon or img).\n *\n * @csspart side-navigation-container - The main container wrapping the entire side navigation.\n * @csspart scrollable-section - The scrollable section of the side navigation.\n * @csspart fixed-section - The fixed section of the side navigation.\n * @csspart separator - The divider between the scrollable and fixed sections.\n * @csspart brand-logo-container - The container wrapping the brand logo and footer text.\n * @csspart footer-text - The footer text label in the fixed section.\n * @csspart vertical-divider - The vertical divider between the scrollable and fixed sections.\n * @csspart vertical-divider-button - The button inside the vertical divider used to toggle expand/collapse.\n *\n * @event toggle - (React: onToggle) Dispatched when the grabber button is clicked to expand/collapse the sidenavigation.\n * @event activechange - (React: onActiveChange) Dispatched when the active state of a nested navmenuitem changes.\n *\n * @cssproperty --mdc-sidenavigation-expanded-width - width of the sideNavigation when expanded\n * @cssproperty --mdc-sidenavigation-collapsed-width - width of the sideNavigation when collapsed\n * @cssproperty --mdc-sidenavigation-vertical-divider-button-z-index - z-index of the vertical divider button\n */",
40231
40231
  "customElement": true
40232
40232
  }
40233
40233
  ],
@@ -40236,8 +40236,8 @@
40236
40236
  "kind": "js",
40237
40237
  "name": "default",
40238
40238
  "declaration": {
40239
- "name": "Slider",
40240
- "module": "components/slider/slider.component.js"
40239
+ "name": "SideNavigation",
40240
+ "module": "components/sidenavigation/sidenavigation.component.js"
40241
40241
  }
40242
40242
  }
40243
40243
  ]
@@ -41022,94 +41022,6 @@
41022
41022
  }
41023
41023
  ]
41024
41024
  },
41025
- {
41026
- "kind": "javascript-module",
41027
- "path": "components/stepperconnector/stepperconnector.component.js",
41028
- "declarations": [
41029
- {
41030
- "kind": "class",
41031
- "description": "StepperConnector component visually represents the connection between two stepper items.\nIndicates whether the connection is complete or incomplete, and supports vertical or horizontal orientation.\nThey are used between 2 `mdc-stepperitem` components to visually connect them and wrapped in a `mdc-stepper` component.",
41032
- "name": "StepperConnector",
41033
- "cssProperties": [
41034
- {
41035
- "description": "Background color for the complete connector",
41036
- "name": "--mdc-stepperconnector-complete-background"
41037
- },
41038
- {
41039
- "description": "Background color for the incomplete connector",
41040
- "name": "--mdc-stepperconnector-incomplete-background"
41041
- }
41042
- ],
41043
- "cssParts": [
41044
- {
41045
- "description": "The main connector line between steps",
41046
- "name": "connector"
41047
- }
41048
- ],
41049
- "members": [
41050
- {
41051
- "kind": "field",
41052
- "name": "status",
41053
- "type": {
41054
- "text": "StatusType"
41055
- },
41056
- "description": "The status of the connector (complete or incomplete)",
41057
- "default": "\"incomplete\"",
41058
- "attribute": "status",
41059
- "reflects": true
41060
- },
41061
- {
41062
- "kind": "field",
41063
- "name": "orientation",
41064
- "type": {
41065
- "text": "OrientationType"
41066
- },
41067
- "description": "The orientation of the connector (vertical or horizontal)",
41068
- "default": "\"horizontal\"",
41069
- "attribute": "orientation",
41070
- "reflects": true
41071
- }
41072
- ],
41073
- "attributes": [
41074
- {
41075
- "name": "status",
41076
- "type": {
41077
- "text": "StatusType"
41078
- },
41079
- "description": "The status of the connector (complete or incomplete)",
41080
- "default": "\"incomplete\"",
41081
- "fieldName": "status"
41082
- },
41083
- {
41084
- "name": "orientation",
41085
- "type": {
41086
- "text": "OrientationType"
41087
- },
41088
- "description": "The orientation of the connector (vertical or horizontal)",
41089
- "default": "\"horizontal\"",
41090
- "fieldName": "orientation"
41091
- }
41092
- ],
41093
- "superclass": {
41094
- "name": "Component",
41095
- "module": "/src/models"
41096
- },
41097
- "tagName": "mdc-stepperconnector",
41098
- "jsDoc": "/**\n * StepperConnector component visually represents the connection between two stepper items.\n * Indicates whether the connection is complete or incomplete, and supports vertical or horizontal orientation.\n * They are used between 2 `mdc-stepperitem` components to visually connect them and wrapped in a `mdc-stepper` component.\n *\n * @tagname mdc-stepperconnector\n *\n * @csspart connector - The main connector line between steps\n *\n * @cssproperty --mdc-stepperconnector-complete-background - Background color for the complete connector\n * @cssproperty --mdc-stepperconnector-incomplete-background - Background color for the incomplete connector\n */",
41099
- "customElement": true
41100
- }
41101
- ],
41102
- "exports": [
41103
- {
41104
- "kind": "js",
41105
- "name": "default",
41106
- "declaration": {
41107
- "name": "StepperConnector",
41108
- "module": "components/stepperconnector/stepperconnector.component.js"
41109
- }
41110
- }
41111
- ]
41112
- },
41113
41025
  {
41114
41026
  "kind": "javascript-module",
41115
41027
  "path": "components/stepper/stepper.component.js",
@@ -41207,6 +41119,94 @@
41207
41119
  }
41208
41120
  ]
41209
41121
  },
41122
+ {
41123
+ "kind": "javascript-module",
41124
+ "path": "components/stepperconnector/stepperconnector.component.js",
41125
+ "declarations": [
41126
+ {
41127
+ "kind": "class",
41128
+ "description": "StepperConnector component visually represents the connection between two stepper items.\nIndicates whether the connection is complete or incomplete, and supports vertical or horizontal orientation.\nThey are used between 2 `mdc-stepperitem` components to visually connect them and wrapped in a `mdc-stepper` component.",
41129
+ "name": "StepperConnector",
41130
+ "cssProperties": [
41131
+ {
41132
+ "description": "Background color for the complete connector",
41133
+ "name": "--mdc-stepperconnector-complete-background"
41134
+ },
41135
+ {
41136
+ "description": "Background color for the incomplete connector",
41137
+ "name": "--mdc-stepperconnector-incomplete-background"
41138
+ }
41139
+ ],
41140
+ "cssParts": [
41141
+ {
41142
+ "description": "The main connector line between steps",
41143
+ "name": "connector"
41144
+ }
41145
+ ],
41146
+ "members": [
41147
+ {
41148
+ "kind": "field",
41149
+ "name": "status",
41150
+ "type": {
41151
+ "text": "StatusType"
41152
+ },
41153
+ "description": "The status of the connector (complete or incomplete)",
41154
+ "default": "\"incomplete\"",
41155
+ "attribute": "status",
41156
+ "reflects": true
41157
+ },
41158
+ {
41159
+ "kind": "field",
41160
+ "name": "orientation",
41161
+ "type": {
41162
+ "text": "OrientationType"
41163
+ },
41164
+ "description": "The orientation of the connector (vertical or horizontal)",
41165
+ "default": "\"horizontal\"",
41166
+ "attribute": "orientation",
41167
+ "reflects": true
41168
+ }
41169
+ ],
41170
+ "attributes": [
41171
+ {
41172
+ "name": "status",
41173
+ "type": {
41174
+ "text": "StatusType"
41175
+ },
41176
+ "description": "The status of the connector (complete or incomplete)",
41177
+ "default": "\"incomplete\"",
41178
+ "fieldName": "status"
41179
+ },
41180
+ {
41181
+ "name": "orientation",
41182
+ "type": {
41183
+ "text": "OrientationType"
41184
+ },
41185
+ "description": "The orientation of the connector (vertical or horizontal)",
41186
+ "default": "\"horizontal\"",
41187
+ "fieldName": "orientation"
41188
+ }
41189
+ ],
41190
+ "superclass": {
41191
+ "name": "Component",
41192
+ "module": "/src/models"
41193
+ },
41194
+ "tagName": "mdc-stepperconnector",
41195
+ "jsDoc": "/**\n * StepperConnector component visually represents the connection between two stepper items.\n * Indicates whether the connection is complete or incomplete, and supports vertical or horizontal orientation.\n * They are used between 2 `mdc-stepperitem` components to visually connect them and wrapped in a `mdc-stepper` component.\n *\n * @tagname mdc-stepperconnector\n *\n * @csspart connector - The main connector line between steps\n *\n * @cssproperty --mdc-stepperconnector-complete-background - Background color for the complete connector\n * @cssproperty --mdc-stepperconnector-incomplete-background - Background color for the incomplete connector\n */",
41196
+ "customElement": true
41197
+ }
41198
+ ],
41199
+ "exports": [
41200
+ {
41201
+ "kind": "js",
41202
+ "name": "default",
41203
+ "declaration": {
41204
+ "name": "StepperConnector",
41205
+ "module": "components/stepperconnector/stepperconnector.component.js"
41206
+ }
41207
+ }
41208
+ ]
41209
+ },
41210
41210
  {
41211
41211
  "kind": "javascript-module",
41212
41212
  "path": "components/stepperitem/stepperitem.component.js",