@momentum-design/components 0.76.2 → 0.76.3

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.
@@ -19752,41 +19752,6 @@
19752
19752
  }
19753
19753
  ]
19754
19754
  },
19755
- {
19756
- "kind": "javascript-module",
19757
- "path": "components/menusection/menusection.component.js",
19758
- "declarations": [
19759
- {
19760
- "kind": "class",
19761
- "description": "`mdc-menusection` is a container element used to group a set of menu items.\n\nThis component supports a mix of `menuitem`, `menuitemcheckbox`, and `menuitemradio` components.\n\n- If multiple `menuitemradio` components are slotted into the section, the group enforces a single-selection rule:\n only one radio item can be selected at a time.\n- If `menuitemcheckbox` components are included, their checked state can be toggled independently.",
19762
- "name": "MenuSection",
19763
- "slots": [
19764
- {
19765
- "description": "Default slot for inserting `menuitem`, `menuitemcheckbox`, or `menuitemradio`",
19766
- "name": ""
19767
- }
19768
- ],
19769
- "members": [],
19770
- "superclass": {
19771
- "name": "Component",
19772
- "module": "/src/models"
19773
- },
19774
- "tagName": "mdc-menusection",
19775
- "jsDoc": "/**\n * `mdc-menusection` is a container element used to group a set of menu items.\n *\n * This component supports a mix of `menuitem`, `menuitemcheckbox`, and `menuitemradio` components.\n *\n * - If multiple `menuitemradio` components are slotted into the section, the group enforces a single-selection rule:\n * only one radio item can be selected at a time.\n * - If `menuitemcheckbox` components are included, their checked state can be toggled independently.\n *\n * @tagname mdc-menusection\n *\n * @slot - Default slot for inserting `menuitem`, `menuitemcheckbox`, or `menuitemradio`\n */",
19776
- "customElement": true
19777
- }
19778
- ],
19779
- "exports": [
19780
- {
19781
- "kind": "js",
19782
- "name": "default",
19783
- "declaration": {
19784
- "name": "MenuSection",
19785
- "module": "components/menusection/menusection.component.js"
19786
- }
19787
- }
19788
- ]
19789
- },
19790
19755
  {
19791
19756
  "kind": "javascript-module",
19792
19757
  "path": "components/optgroup/optgroup.component.js",
@@ -19925,6 +19890,41 @@
19925
19890
  }
19926
19891
  ]
19927
19892
  },
19893
+ {
19894
+ "kind": "javascript-module",
19895
+ "path": "components/menusection/menusection.component.js",
19896
+ "declarations": [
19897
+ {
19898
+ "kind": "class",
19899
+ "description": "`mdc-menusection` is a container element used to group a set of menu items.\n\nThis component supports a mix of `menuitem`, `menuitemcheckbox`, and `menuitemradio` components.\n\n- If multiple `menuitemradio` components are slotted into the section, the group enforces a single-selection rule:\n only one radio item can be selected at a time.\n- If `menuitemcheckbox` components are included, their checked state can be toggled independently.",
19900
+ "name": "MenuSection",
19901
+ "slots": [
19902
+ {
19903
+ "description": "Default slot for inserting `menuitem`, `menuitemcheckbox`, or `menuitemradio`",
19904
+ "name": ""
19905
+ }
19906
+ ],
19907
+ "members": [],
19908
+ "superclass": {
19909
+ "name": "Component",
19910
+ "module": "/src/models"
19911
+ },
19912
+ "tagName": "mdc-menusection",
19913
+ "jsDoc": "/**\n * `mdc-menusection` is a container element used to group a set of menu items.\n *\n * This component supports a mix of `menuitem`, `menuitemcheckbox`, and `menuitemradio` components.\n *\n * - If multiple `menuitemradio` components are slotted into the section, the group enforces a single-selection rule:\n * only one radio item can be selected at a time.\n * - If `menuitemcheckbox` components are included, their checked state can be toggled independently.\n *\n * @tagname mdc-menusection\n *\n * @slot - Default slot for inserting `menuitem`, `menuitemcheckbox`, or `menuitemradio`\n */",
19914
+ "customElement": true
19915
+ }
19916
+ ],
19917
+ "exports": [
19918
+ {
19919
+ "kind": "js",
19920
+ "name": "default",
19921
+ "declaration": {
19922
+ "name": "MenuSection",
19923
+ "module": "components/menusection/menusection.component.js"
19924
+ }
19925
+ }
19926
+ ]
19927
+ },
19928
19928
  {
19929
19929
  "kind": "javascript-module",
19930
19930
  "path": "components/option/option.component.js",
@@ -23942,1042 +23942,1418 @@
23942
23942
  },
23943
23943
  {
23944
23944
  "kind": "javascript-module",
23945
- "path": "components/radiogroup/radiogroup.component.js",
23945
+ "path": "components/screenreaderannouncer/screenreaderannouncer.component.js",
23946
23946
  "declarations": [
23947
23947
  {
23948
23948
  "kind": "class",
23949
- "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.",
23950
- "name": "RadioGroup",
23951
- "cssProperties": [
23952
- {
23953
- "description": "color of the description text",
23954
- "name": "--mdc-radiogroup-description-text-normal"
23955
- }
23956
- ],
23949
+ "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/",
23950
+ "name": "ScreenreaderAnnouncer",
23957
23951
  "members": [
23958
23952
  {
23959
23953
  "kind": "field",
23960
- "name": "name",
23954
+ "name": "announcement",
23961
23955
  "type": {
23962
23956
  "text": "string"
23963
23957
  },
23964
23958
  "default": "''",
23965
- "description": "Name of the radio group.\nThey are used to group elements in a form together.",
23966
- "attribute": "name"
23959
+ "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.",
23960
+ "attribute": "announcement",
23961
+ "reflects": true
23967
23962
  },
23968
23963
  {
23969
23964
  "kind": "field",
23970
- "name": "dataAriaLabel",
23965
+ "name": "identity",
23971
23966
  "type": {
23972
- "text": "string | null"
23967
+ "text": "string"
23973
23968
  },
23974
- "default": "null",
23975
- "description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
23976
- "attribute": "data-aria-label",
23977
- "reflects": true,
23978
- "inheritedFrom": {
23979
- "name": "DataAriaLabelMixin",
23980
- "module": "utils/mixins/DataAriaLabelMixin.js"
23981
- }
23969
+ "default": "''",
23970
+ "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.",
23971
+ "attribute": "identity",
23972
+ "reflects": true
23982
23973
  },
23983
23974
  {
23984
23975
  "kind": "field",
23985
- "name": "disabled",
23976
+ "name": "dataAriaLive",
23986
23977
  "type": {
23987
- "text": "boolean | undefined"
23978
+ "text": "AriaLive"
23988
23979
  },
23989
- "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
23990
- "default": "undefined",
23991
- "attribute": "disabled",
23992
- "reflects": true,
23993
- "inheritedFrom": {
23994
- "name": "FormfieldWrapper",
23995
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
23996
- }
23980
+ "description": "Aria live value for announcement.",
23981
+ "default": "'polite'",
23982
+ "attribute": "data-aria-live",
23983
+ "reflects": true
23997
23984
  },
23998
23985
  {
23999
23986
  "kind": "field",
24000
- "name": "label",
23987
+ "name": "delay",
24001
23988
  "type": {
24002
- "text": "string | undefined"
23989
+ "text": "number"
24003
23990
  },
24004
- "description": "The label of the input field. It is linked to the input field using the `for` attribute.",
24005
- "attribute": "label",
24006
- "reflects": true,
24007
- "inheritedFrom": {
24008
- "name": "FormfieldWrapper",
24009
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
24010
- }
23991
+ "description": "Milliseconds to wait before adding the announcement to the identiy region in\nDOM, which will announce the message to the screen reader.",
23992
+ "default": "150",
23993
+ "attribute": "delay",
23994
+ "reflects": true
24011
23995
  },
24012
23996
  {
24013
23997
  "kind": "field",
24014
- "name": "required",
23998
+ "name": "timeout",
24015
23999
  "type": {
24016
- "text": "boolean"
24000
+ "text": "number"
24017
24001
  },
24018
- "default": "false",
24019
- "description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
24020
- "attribute": "required",
24021
- "reflects": true,
24022
- "inheritedFrom": {
24023
- "name": "FormfieldWrapper",
24024
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
24025
- }
24002
+ "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.",
24003
+ "default": "20_000",
24004
+ "attribute": "timeout",
24005
+ "reflects": true
24026
24006
  },
24027
24007
  {
24028
- "kind": "field",
24029
- "name": "id",
24008
+ "kind": "method",
24009
+ "name": "announce",
24010
+ "parameters": [
24011
+ {
24012
+ "name": "announcement",
24013
+ "type": {
24014
+ "text": "string"
24015
+ },
24016
+ "description": "The announcement to be made."
24017
+ },
24018
+ {
24019
+ "name": "delay",
24020
+ "type": {
24021
+ "text": "number"
24022
+ },
24023
+ "description": "The delay in milliseconds before announcing the message."
24024
+ },
24025
+ {
24026
+ "name": "timeout",
24027
+ "type": {
24028
+ "text": "number"
24029
+ },
24030
+ "description": "The timeout in milliseconds before removing the announcement."
24031
+ },
24032
+ {
24033
+ "name": "ariaLive",
24034
+ "type": {
24035
+ "text": "AriaLive"
24036
+ },
24037
+ "description": "The aria live value for the announcement."
24038
+ }
24039
+ ],
24040
+ "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."
24041
+ },
24042
+ {
24043
+ "kind": "method",
24044
+ "name": "clearTimeOutsAndAnnouncements",
24045
+ "privacy": "private",
24046
+ "description": "Clears all timeouts and removes all announcements from the screen reader."
24047
+ },
24048
+ {
24049
+ "kind": "method",
24050
+ "name": "createAnnouncementAriaLiveRegion",
24051
+ "privacy": "private",
24052
+ "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`."
24053
+ }
24054
+ ],
24055
+ "attributes": [
24056
+ {
24057
+ "name": "announcement",
24030
24058
  "type": {
24031
24059
  "text": "string"
24032
24060
  },
24033
24061
  "default": "''",
24034
- "description": "The unique id of the input field. It is used to link the input field with the label.",
24035
- "attribute": "id",
24036
- "inheritedFrom": {
24037
- "name": "FormfieldWrapper",
24038
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
24039
- }
24062
+ "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.",
24063
+ "fieldName": "announcement"
24040
24064
  },
24041
24065
  {
24042
- "kind": "field",
24043
- "name": "helpTextType",
24066
+ "name": "identity",
24044
24067
  "type": {
24045
- "text": "ValidationType"
24068
+ "text": "string"
24046
24069
  },
24047
- "description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
24048
- "attribute": "help-text-type",
24049
- "reflects": true,
24050
- "inheritedFrom": {
24051
- "name": "FormfieldWrapper",
24052
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
24053
- }
24070
+ "default": "''",
24071
+ "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.",
24072
+ "fieldName": "identity"
24054
24073
  },
24055
24074
  {
24056
- "kind": "field",
24057
- "name": "helpText",
24075
+ "name": "data-aria-live",
24058
24076
  "type": {
24059
- "text": "string | undefined"
24077
+ "text": "AriaLive"
24060
24078
  },
24061
- "description": "The help text that is displayed below the input field.",
24062
- "attribute": "help-text",
24063
- "reflects": true,
24064
- "inheritedFrom": {
24065
- "name": "FormfieldWrapper",
24066
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
24067
- }
24079
+ "description": "Aria live value for announcement.",
24080
+ "default": "'polite'",
24081
+ "fieldName": "dataAriaLive"
24068
24082
  },
24069
24083
  {
24070
- "kind": "method",
24071
- "name": "renderLabelElement",
24072
- "privacy": "protected",
24073
- "description": "creates the label element when the label property is set.\nid is used to link the label with the input field.",
24074
- "return": {
24075
- "type": {
24076
- "text": ""
24077
- }
24084
+ "name": "delay",
24085
+ "type": {
24086
+ "text": "number"
24078
24087
  },
24079
- "inheritedFrom": {
24080
- "name": "FormfieldWrapper",
24081
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
24082
- }
24088
+ "description": "Milliseconds to wait before adding the announcement to the identiy region in\nDOM, which will announce the message to the screen reader.",
24089
+ "default": "150",
24090
+ "fieldName": "delay"
24083
24091
  },
24084
24092
  {
24085
- "kind": "method",
24086
- "name": "renderHelpTextIcon",
24087
- "privacy": "protected",
24088
- "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.",
24089
- "return": {
24090
- "type": {
24091
- "text": ""
24092
- }
24093
+ "name": "timeout",
24094
+ "type": {
24095
+ "text": "number"
24093
24096
  },
24097
+ "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.",
24098
+ "default": "20_000",
24099
+ "fieldName": "timeout"
24100
+ }
24101
+ ],
24102
+ "superclass": {
24103
+ "name": "Component",
24104
+ "module": "/src/models"
24105
+ },
24106
+ "tagName": "mdc-screenreaderannouncer",
24107
+ "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 */",
24108
+ "customElement": true
24109
+ }
24110
+ ],
24111
+ "exports": [
24112
+ {
24113
+ "kind": "js",
24114
+ "name": "default",
24115
+ "declaration": {
24116
+ "name": "ScreenreaderAnnouncer",
24117
+ "module": "components/screenreaderannouncer/screenreaderannouncer.component.js"
24118
+ }
24119
+ }
24120
+ ]
24121
+ },
24122
+ {
24123
+ "kind": "javascript-module",
24124
+ "path": "components/searchfield/searchfield.component.js",
24125
+ "declarations": [
24126
+ {
24127
+ "kind": "class",
24128
+ "description": "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.",
24129
+ "name": "Searchfield",
24130
+ "slots": [
24131
+ {
24132
+ "description": "Slot for input chips",
24133
+ "name": "filters"
24134
+ },
24135
+ {
24136
+ "description": "slot to add the label info icon",
24137
+ "name": "label-info",
24094
24138
  "inheritedFrom": {
24095
24139
  "name": "FormfieldWrapper",
24096
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
24140
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
24141
+ }
24142
+ }
24143
+ ],
24144
+ "members": [
24145
+ {
24146
+ "kind": "field",
24147
+ "name": "inputChips",
24148
+ "type": {
24149
+ "text": "Array<HTMLElement> | undefined"
24097
24150
  }
24098
24151
  },
24099
24152
  {
24100
24153
  "kind": "method",
24101
- "name": "renderHelpText",
24154
+ "name": "handleKeyDown",
24102
24155
  "privacy": "protected",
24103
- "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.",
24104
- "return": {
24105
- "type": {
24106
- "text": ""
24156
+ "parameters": [
24157
+ {
24158
+ "name": "event",
24159
+ "type": {
24160
+ "text": "KeyboardEvent"
24161
+ },
24162
+ "description": "Keyboard event"
24107
24163
  }
24108
- },
24164
+ ],
24165
+ "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.",
24109
24166
  "inheritedFrom": {
24110
- "name": "FormfieldWrapper",
24111
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
24167
+ "name": "Input",
24168
+ "module": "components/input/input.component.js"
24112
24169
  }
24113
24170
  },
24114
24171
  {
24115
24172
  "kind": "method",
24116
- "name": "renderLabel",
24117
- "privacy": "protected",
24118
- "description": "renders the mdc-label-text container that contains the label and labelInfoToggleTip.",
24119
- "return": {
24120
- "type": {
24121
- "text": ""
24122
- }
24123
- },
24124
- "inheritedFrom": {
24125
- "name": "FormfieldWrapper",
24126
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
24127
- }
24173
+ "name": "renderInputChips",
24174
+ "privacy": "private",
24175
+ "description": "This method is used to render the input chips inside filters slot.\nIt will remove any elements that are not input chips."
24128
24176
  },
24129
24177
  {
24130
24178
  "kind": "method",
24131
- "name": "renderHelperText",
24179
+ "name": "clearInputText",
24132
24180
  "privacy": "protected",
24133
- "description": "renders the mdc-help-text container that contains the helpertext icon and helpertext.",
24134
- "return": {
24135
- "type": {
24136
- "text": ""
24137
- }
24138
- },
24181
+ "description": "Clears the input field.",
24139
24182
  "inheritedFrom": {
24140
- "name": "FormfieldWrapper",
24141
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
24183
+ "name": "Input",
24184
+ "module": "components/input/input.component.js"
24142
24185
  }
24143
- }
24144
- ],
24145
- "attributes": [
24186
+ },
24146
24187
  {
24188
+ "kind": "field",
24147
24189
  "name": "name",
24148
24190
  "type": {
24149
24191
  "text": "string"
24150
24192
  },
24151
24193
  "default": "''",
24152
- "description": "Name of the radio group.\nThey are used to group elements in a form together.",
24153
- "fieldName": "name"
24154
- },
24155
- {
24156
- "name": "data-aria-label",
24157
- "type": {
24158
- "text": "string | null"
24159
- },
24160
- "default": "null",
24161
- "description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
24162
- "fieldName": "dataAriaLabel",
24194
+ "description": "Indicates the name of the component group.\nThey are used to group elements in a form together.",
24195
+ "attribute": "name",
24196
+ "reflects": true,
24163
24197
  "inheritedFrom": {
24164
- "name": "DataAriaLabelMixin",
24165
- "module": "src/utils/mixins/DataAriaLabelMixin.ts"
24198
+ "name": "FormInternalsMixin",
24199
+ "module": "utils/mixins/FormInternalsMixin.js"
24166
24200
  }
24167
24201
  },
24168
24202
  {
24169
- "name": "disabled",
24203
+ "kind": "field",
24204
+ "name": "value",
24170
24205
  "type": {
24171
- "text": "boolean | undefined"
24206
+ "text": "string"
24172
24207
  },
24173
- "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
24174
- "default": "undefined",
24175
- "fieldName": "disabled",
24208
+ "default": "''",
24209
+ "description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
24210
+ "attribute": "value",
24211
+ "reflects": true,
24176
24212
  "inheritedFrom": {
24177
- "name": "FormfieldWrapper",
24178
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
24213
+ "name": "FormInternalsMixin",
24214
+ "module": "utils/mixins/FormInternalsMixin.js"
24179
24215
  }
24180
24216
  },
24181
24217
  {
24182
- "name": "label",
24218
+ "kind": "field",
24219
+ "name": "validationMessage",
24183
24220
  "type": {
24184
24221
  "text": "string | undefined"
24185
24222
  },
24186
- "description": "The label of the input field. It is linked to the input field using the `for` attribute.",
24187
- "fieldName": "label",
24223
+ "description": "Custom validation message that will override the default message and displayed when the input is invalid.",
24224
+ "attribute": "validation-message",
24225
+ "reflects": true,
24188
24226
  "inheritedFrom": {
24189
- "name": "FormfieldWrapper",
24190
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
24227
+ "name": "FormInternalsMixin",
24228
+ "module": "utils/mixins/FormInternalsMixin.js"
24191
24229
  }
24192
24230
  },
24193
24231
  {
24194
- "name": "required",
24232
+ "kind": "field",
24233
+ "name": "validity",
24195
24234
  "type": {
24196
- "text": "boolean"
24235
+ "text": "ValidityState"
24197
24236
  },
24198
- "default": "false",
24199
- "description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
24200
- "fieldName": "required",
24237
+ "readonly": true,
24201
24238
  "inheritedFrom": {
24202
- "name": "FormfieldWrapper",
24203
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
24239
+ "name": "FormInternalsMixin",
24240
+ "module": "utils/mixins/FormInternalsMixin.js"
24204
24241
  }
24205
24242
  },
24206
24243
  {
24207
- "name": "id",
24208
- "type": {
24209
- "text": "string"
24210
- },
24211
- "default": "''",
24212
- "description": "The unique id of the input field. It is used to link the input field with the label.",
24213
- "fieldName": "id",
24244
+ "kind": "field",
24245
+ "name": "willValidate",
24246
+ "readonly": true,
24214
24247
  "inheritedFrom": {
24215
- "name": "FormfieldWrapper",
24216
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
24248
+ "name": "FormInternalsMixin",
24249
+ "module": "utils/mixins/FormInternalsMixin.js"
24217
24250
  }
24218
24251
  },
24219
24252
  {
24220
- "name": "help-text-type",
24221
- "type": {
24222
- "text": "ValidationType"
24253
+ "kind": "method",
24254
+ "name": "setValidity",
24255
+ "description": "Sets the validity of the input field based on the input field's validity.",
24256
+ "return": {
24257
+ "type": {
24258
+ "text": ""
24259
+ }
24223
24260
  },
24224
- "description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
24225
- "fieldName": "helpTextType",
24226
24261
  "inheritedFrom": {
24227
- "name": "FormfieldWrapper",
24228
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
24262
+ "name": "FormInternalsMixin",
24263
+ "module": "utils/mixins/FormInternalsMixin.js"
24229
24264
  }
24230
24265
  },
24231
24266
  {
24232
- "name": "help-text",
24233
- "type": {
24234
- "text": "string | undefined"
24267
+ "kind": "method",
24268
+ "name": "checkValidity",
24269
+ "return": {
24270
+ "type": {
24271
+ "text": "boolean"
24272
+ }
24235
24273
  },
24236
- "description": "The help text that is displayed below the input field.",
24237
- "fieldName": "helpText",
24238
24274
  "inheritedFrom": {
24239
- "name": "FormfieldWrapper",
24240
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
24275
+ "name": "FormInternalsMixin",
24276
+ "module": "utils/mixins/FormInternalsMixin.js"
24241
24277
  }
24242
- }
24243
- ],
24244
- "superclass": {
24245
- "name": "FormfieldGroup",
24246
- "module": "/src/components/formfieldgroup"
24247
- },
24248
- "tagName": "mdc-radiogroup",
24249
- "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 */",
24250
- "customElement": true,
24251
- "slots": [
24278
+ },
24252
24279
  {
24253
- "description": "This is a default slot for checkbox or toggle components.",
24254
- "name": "default",
24280
+ "kind": "method",
24281
+ "name": "reportValidity",
24255
24282
  "inheritedFrom": {
24256
- "name": "FormfieldGroup",
24257
- "module": "src/components/formfieldgroup/formfieldgroup.component.ts"
24283
+ "name": "FormInternalsMixin",
24284
+ "module": "utils/mixins/FormInternalsMixin.js"
24258
24285
  }
24259
24286
  },
24260
24287
  {
24261
- "description": "slot to add the label info icon",
24262
- "name": "label-info",
24288
+ "kind": "field",
24289
+ "name": "dataAriaLabel",
24290
+ "type": {
24291
+ "text": "string | null"
24292
+ },
24293
+ "default": "null",
24294
+ "description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
24295
+ "attribute": "data-aria-label",
24296
+ "reflects": true,
24263
24297
  "inheritedFrom": {
24264
- "name": "FormfieldWrapper",
24265
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
24298
+ "name": "DataAriaLabelMixin",
24299
+ "module": "utils/mixins/DataAriaLabelMixin.js"
24266
24300
  }
24267
- }
24268
- ]
24269
- }
24270
- ],
24271
- "exports": [
24272
- {
24273
- "kind": "js",
24274
- "name": "default",
24275
- "declaration": {
24276
- "name": "RadioGroup",
24277
- "module": "components/radiogroup/radiogroup.component.js"
24278
- }
24279
- }
24280
- ]
24281
- },
24282
- {
24283
- "kind": "javascript-module",
24284
- "path": "components/screenreaderannouncer/screenreaderannouncer.component.js",
24285
- "declarations": [
24286
- {
24287
- "kind": "class",
24288
- "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/",
24289
- "name": "ScreenreaderAnnouncer",
24290
- "members": [
24301
+ },
24291
24302
  {
24292
24303
  "kind": "field",
24293
- "name": "announcement",
24304
+ "name": "placeholder",
24294
24305
  "type": {
24295
24306
  "text": "string"
24296
24307
  },
24297
24308
  "default": "''",
24298
- "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.",
24299
- "attribute": "announcement",
24300
- "reflects": true
24309
+ "description": "The placeholder text that is displayed when the input field is empty.",
24310
+ "attribute": "placeholder",
24311
+ "inheritedFrom": {
24312
+ "name": "Input",
24313
+ "module": "components/input/input.component.js"
24314
+ }
24301
24315
  },
24302
24316
  {
24303
24317
  "kind": "field",
24304
- "name": "identity",
24318
+ "name": "readonly",
24305
24319
  "type": {
24306
- "text": "string"
24320
+ "text": "boolean"
24307
24321
  },
24308
- "default": "''",
24309
- "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.",
24310
- "attribute": "identity",
24311
- "reflects": true
24322
+ "default": "false",
24323
+ "description": "readonly attribute of the input field. If true, the input field is read-only.",
24324
+ "attribute": "readonly",
24325
+ "inheritedFrom": {
24326
+ "name": "Input",
24327
+ "module": "components/input/input.component.js"
24328
+ }
24312
24329
  },
24313
24330
  {
24314
24331
  "kind": "field",
24315
- "name": "dataAriaLive",
24332
+ "name": "prefixText",
24316
24333
  "type": {
24317
- "text": "AriaLive"
24334
+ "text": "string | undefined"
24318
24335
  },
24319
- "description": "Aria live value for announcement.",
24320
- "default": "'polite'",
24321
- "attribute": "data-aria-live",
24322
- "reflects": true
24336
+ "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.",
24337
+ "attribute": "prefix-text",
24338
+ "inheritedFrom": {
24339
+ "name": "Input",
24340
+ "module": "components/input/input.component.js"
24341
+ }
24323
24342
  },
24324
24343
  {
24325
24344
  "kind": "field",
24326
- "name": "delay",
24345
+ "name": "leadingIcon",
24327
24346
  "type": {
24328
- "text": "number"
24347
+ "text": "IconNames | undefined"
24329
24348
  },
24330
- "description": "Milliseconds to wait before adding the announcement to the identiy region in\nDOM, which will announce the message to the screen reader.",
24331
- "default": "150",
24332
- "attribute": "delay",
24333
- "reflects": true
24349
+ "description": "The leading icon that is displayed before the input field.",
24350
+ "attribute": "leading-icon",
24351
+ "inheritedFrom": {
24352
+ "name": "Input",
24353
+ "module": "components/input/input.component.js"
24354
+ }
24334
24355
  },
24335
24356
  {
24336
24357
  "kind": "field",
24337
- "name": "timeout",
24358
+ "name": "trailingButton",
24338
24359
  "type": {
24339
- "text": "number"
24360
+ "text": "boolean"
24340
24361
  },
24341
- "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.",
24342
- "default": "20_000",
24343
- "attribute": "timeout",
24344
- "reflects": true
24362
+ "default": "false",
24363
+ "description": "The trailing button when set to true, shows a clear button that clears the input field.",
24364
+ "attribute": "trailing-button",
24365
+ "inheritedFrom": {
24366
+ "name": "Input",
24367
+ "module": "components/input/input.component.js"
24368
+ }
24345
24369
  },
24346
24370
  {
24347
- "kind": "method",
24348
- "name": "announce",
24349
- "parameters": [
24350
- {
24351
- "name": "announcement",
24352
- "type": {
24353
- "text": "string"
24354
- },
24355
- "description": "The announcement to be made."
24356
- },
24357
- {
24358
- "name": "delay",
24359
- "type": {
24360
- "text": "number"
24361
- },
24362
- "description": "The delay in milliseconds before announcing the message."
24363
- },
24364
- {
24365
- "name": "timeout",
24366
- "type": {
24367
- "text": "number"
24368
- },
24369
- "description": "The timeout in milliseconds before removing the announcement."
24370
- },
24371
- {
24372
- "name": "ariaLive",
24373
- "type": {
24374
- "text": "AriaLive"
24375
- },
24376
- "description": "The aria live value for the announcement."
24377
- }
24378
- ],
24379
- "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."
24371
+ "kind": "field",
24372
+ "name": "maxlength",
24373
+ "type": {
24374
+ "text": "number | undefined"
24375
+ },
24376
+ "description": "The maximum number of characters that the input field can accept.",
24377
+ "attribute": "maxlength",
24378
+ "inheritedFrom": {
24379
+ "name": "Input",
24380
+ "module": "components/input/input.component.js"
24381
+ }
24380
24382
  },
24381
24383
  {
24382
- "kind": "method",
24383
- "name": "clearTimeOutsAndAnnouncements",
24384
- "privacy": "private",
24385
- "description": "Clears all timeouts and removes all announcements from the screen reader."
24384
+ "kind": "field",
24385
+ "name": "minlength",
24386
+ "type": {
24387
+ "text": "number | undefined"
24388
+ },
24389
+ "description": "The minimum number of characters that the input field can accept.",
24390
+ "attribute": "minlength",
24391
+ "inheritedFrom": {
24392
+ "name": "Input",
24393
+ "module": "components/input/input.component.js"
24394
+ }
24386
24395
  },
24387
24396
  {
24388
- "kind": "method",
24389
- "name": "createAnnouncementAriaLiveRegion",
24390
- "privacy": "private",
24391
- "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`."
24392
- }
24393
- ],
24394
- "attributes": [
24397
+ "kind": "field",
24398
+ "name": "autocapitalize",
24399
+ "type": {
24400
+ "text": "AutoCapitalizeType"
24401
+ },
24402
+ "description": "The autocapitalize attribute of the input field.",
24403
+ "default": "'off'",
24404
+ "attribute": "autocapitalize",
24405
+ "inheritedFrom": {
24406
+ "name": "Input",
24407
+ "module": "components/input/input.component.js"
24408
+ }
24409
+ },
24395
24410
  {
24396
- "name": "announcement",
24411
+ "kind": "field",
24412
+ "name": "autocomplete",
24397
24413
  "type": {
24398
- "text": "string"
24414
+ "text": "AutoCompleteType"
24399
24415
  },
24400
- "default": "''",
24401
- "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.",
24402
- "fieldName": "announcement"
24416
+ "description": "The autocomplete attribute of the input field.",
24417
+ "default": "'off'",
24418
+ "attribute": "autocomplete",
24419
+ "inheritedFrom": {
24420
+ "name": "Input",
24421
+ "module": "components/input/input.component.js"
24422
+ }
24403
24423
  },
24404
24424
  {
24405
- "name": "identity",
24425
+ "kind": "field",
24426
+ "name": "autofocus",
24406
24427
  "type": {
24407
- "text": "string"
24428
+ "text": "boolean"
24408
24429
  },
24409
- "default": "''",
24410
- "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.",
24411
- "fieldName": "identity"
24430
+ "default": "false",
24431
+ "description": "If true, the input field is focused when the component is rendered.",
24432
+ "attribute": "autofocus",
24433
+ "inheritedFrom": {
24434
+ "name": "Input",
24435
+ "module": "components/input/input.component.js"
24436
+ }
24412
24437
  },
24413
24438
  {
24414
- "name": "data-aria-live",
24439
+ "kind": "field",
24440
+ "name": "dirname",
24415
24441
  "type": {
24416
- "text": "AriaLive"
24442
+ "text": "string | undefined"
24417
24443
  },
24418
- "description": "Aria live value for announcement.",
24419
- "default": "'polite'",
24420
- "fieldName": "dataAriaLive"
24444
+ "description": "Specifies the name of the directionality of text for submission purposes (e.g., \"rtl\" for right-to-left).",
24445
+ "attribute": "dirname",
24446
+ "inheritedFrom": {
24447
+ "name": "Input",
24448
+ "module": "components/input/input.component.js"
24449
+ }
24421
24450
  },
24422
24451
  {
24423
- "name": "delay",
24452
+ "kind": "field",
24453
+ "name": "pattern",
24424
24454
  "type": {
24425
- "text": "number"
24455
+ "text": "string | undefined"
24426
24456
  },
24427
- "description": "Milliseconds to wait before adding the announcement to the identiy region in\nDOM, which will announce the message to the screen reader.",
24428
- "default": "150",
24429
- "fieldName": "delay"
24457
+ "description": "The pattern attribute of the input field.\nSpecifies a regular expression that the input value must match for validation purposes.",
24458
+ "attribute": "pattern",
24459
+ "inheritedFrom": {
24460
+ "name": "Input",
24461
+ "module": "components/input/input.component.js"
24462
+ }
24430
24463
  },
24431
24464
  {
24432
- "name": "timeout",
24465
+ "kind": "field",
24466
+ "name": "list",
24433
24467
  "type": {
24434
- "text": "number"
24468
+ "text": "string | undefined"
24435
24469
  },
24436
- "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.",
24437
- "default": "20_000",
24438
- "fieldName": "timeout"
24439
- }
24440
- ],
24441
- "superclass": {
24442
- "name": "Component",
24443
- "module": "/src/models"
24444
- },
24445
- "tagName": "mdc-screenreaderannouncer",
24446
- "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 */",
24447
- "customElement": true
24448
- }
24449
- ],
24450
- "exports": [
24451
- {
24452
- "kind": "js",
24453
- "name": "default",
24454
- "declaration": {
24455
- "name": "ScreenreaderAnnouncer",
24456
- "module": "components/screenreaderannouncer/screenreaderannouncer.component.js"
24457
- }
24458
- }
24459
- ]
24460
- },
24461
- {
24462
- "kind": "javascript-module",
24463
- "path": "components/searchfield/searchfield.component.js",
24464
- "declarations": [
24465
- {
24466
- "kind": "class",
24467
- "description": "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.",
24468
- "name": "Searchfield",
24469
- "slots": [
24470
- {
24471
- "description": "Slot for input chips",
24472
- "name": "filters"
24470
+ "description": "The list attribute of the input field.\nIdentifies a list of pre-defined options to suggest to the user.",
24471
+ "attribute": "list",
24472
+ "inheritedFrom": {
24473
+ "name": "Input",
24474
+ "module": "components/input/input.component.js"
24475
+ }
24473
24476
  },
24474
24477
  {
24475
- "description": "slot to add the label info icon",
24476
- "name": "label-info",
24478
+ "kind": "field",
24479
+ "name": "size",
24480
+ "type": {
24481
+ "text": "number | undefined | undefined"
24482
+ },
24483
+ "description": "The size attribute of the input field.\nSpecifies the width of the input field.",
24484
+ "default": "undefined",
24485
+ "attribute": "size",
24477
24486
  "inheritedFrom": {
24478
- "name": "FormfieldWrapper",
24479
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
24487
+ "name": "Input",
24488
+ "module": "components/input/input.component.js"
24480
24489
  }
24481
- }
24482
- ],
24483
- "members": [
24490
+ },
24484
24491
  {
24485
24492
  "kind": "field",
24486
- "name": "inputChips",
24493
+ "name": "clearAriaLabel",
24487
24494
  "type": {
24488
- "text": "Array<HTMLElement> | undefined"
24495
+ "text": "string"
24496
+ },
24497
+ "default": "''",
24498
+ "description": "Aria label for the trailing button. If trailing button is set to true, this label is used for the clear button.",
24499
+ "attribute": "clear-aria-label",
24500
+ "inheritedFrom": {
24501
+ "name": "Input",
24502
+ "module": "components/input/input.component.js"
24489
24503
  }
24490
24504
  },
24491
24505
  {
24492
24506
  "kind": "method",
24493
- "name": "handleKeyDown",
24494
- "privacy": "protected",
24507
+ "name": "handleValueChange",
24508
+ "description": "Handles the value change of the input field.\nSets the form value and updates the validity of the input field.",
24509
+ "return": {
24510
+ "type": {
24511
+ "text": ""
24512
+ }
24513
+ },
24514
+ "inheritedFrom": {
24515
+ "name": "Input",
24516
+ "module": "components/input/input.component.js"
24517
+ }
24518
+ },
24519
+ {
24520
+ "kind": "method",
24521
+ "name": "setInputValidity",
24522
+ "privacy": "private",
24523
+ "inheritedFrom": {
24524
+ "name": "Input",
24525
+ "module": "components/input/input.component.js"
24526
+ }
24527
+ },
24528
+ {
24529
+ "kind": "method",
24530
+ "name": "updateValue",
24531
+ "privacy": "private",
24532
+ "description": "Updates the value of the input field.\nSets the form value.",
24533
+ "return": {
24534
+ "type": {
24535
+ "text": ""
24536
+ }
24537
+ },
24538
+ "inheritedFrom": {
24539
+ "name": "Input",
24540
+ "module": "components/input/input.component.js"
24541
+ }
24542
+ },
24543
+ {
24544
+ "kind": "method",
24545
+ "name": "onInput",
24546
+ "privacy": "private",
24547
+ "description": "Handles the input event of the input field.\nUpdates the value and sets the validity of the input field.",
24548
+ "inheritedFrom": {
24549
+ "name": "Input",
24550
+ "module": "components/input/input.component.js"
24551
+ }
24552
+ },
24553
+ {
24554
+ "kind": "method",
24555
+ "name": "onChange",
24556
+ "privacy": "private",
24495
24557
  "parameters": [
24496
24558
  {
24497
24559
  "name": "event",
24498
24560
  "type": {
24499
- "text": "KeyboardEvent"
24561
+ "text": "Event"
24500
24562
  },
24501
- "description": "Keyboard event"
24563
+ "description": "Event which contains information about the value change."
24502
24564
  }
24503
24565
  ],
24504
- "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.",
24566
+ "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",
24567
+ "inheritedFrom": {
24568
+ "name": "Input",
24569
+ "module": "components/input/input.component.js"
24570
+ }
24571
+ },
24572
+ {
24573
+ "kind": "method",
24574
+ "name": "renderLeadingIcon",
24575
+ "privacy": "protected",
24576
+ "description": "Renders the leading icon before the input field.\nIf the leading icon is not set, it will not be displayed.",
24577
+ "return": {
24578
+ "type": {
24579
+ "text": ""
24580
+ }
24581
+ },
24582
+ "inheritedFrom": {
24583
+ "name": "Input",
24584
+ "module": "components/input/input.component.js"
24585
+ }
24586
+ },
24587
+ {
24588
+ "kind": "method",
24589
+ "name": "renderPrefixText",
24590
+ "privacy": "protected",
24591
+ "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.",
24592
+ "return": {
24593
+ "type": {
24594
+ "text": ""
24595
+ }
24596
+ },
24597
+ "inheritedFrom": {
24598
+ "name": "Input",
24599
+ "module": "components/input/input.component.js"
24600
+ }
24601
+ },
24602
+ {
24603
+ "kind": "method",
24604
+ "name": "renderTrailingButton",
24605
+ "privacy": "protected",
24606
+ "parameters": [
24607
+ {
24608
+ "name": "show",
24609
+ "default": "false"
24610
+ }
24611
+ ],
24612
+ "description": "Renders the trailing button to clear the input field if the trailingButton is set to true.",
24613
+ "return": {
24614
+ "type": {
24615
+ "text": ""
24616
+ }
24617
+ },
24618
+ "inheritedFrom": {
24619
+ "name": "Input",
24620
+ "module": "components/input/input.component.js"
24621
+ }
24622
+ },
24623
+ {
24624
+ "kind": "method",
24625
+ "name": "renderInputElement",
24626
+ "privacy": "protected",
24627
+ "parameters": [
24628
+ {
24629
+ "name": "type",
24630
+ "type": {
24631
+ "text": "InputType"
24632
+ }
24633
+ },
24634
+ {
24635
+ "name": "hidePlaceholder",
24636
+ "default": "false"
24637
+ }
24638
+ ],
24639
+ "inheritedFrom": {
24640
+ "name": "Input",
24641
+ "module": "components/input/input.component.js"
24642
+ }
24643
+ },
24644
+ {
24645
+ "kind": "field",
24646
+ "name": "disabled",
24647
+ "type": {
24648
+ "text": "boolean | undefined"
24649
+ },
24650
+ "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
24651
+ "default": "undefined",
24652
+ "attribute": "disabled",
24653
+ "reflects": true,
24654
+ "inheritedFrom": {
24655
+ "name": "FormfieldWrapper",
24656
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
24657
+ }
24658
+ },
24659
+ {
24660
+ "kind": "field",
24661
+ "name": "label",
24662
+ "type": {
24663
+ "text": "string | undefined"
24664
+ },
24665
+ "description": "The label of the input field. It is linked to the input field using the `for` attribute.",
24666
+ "attribute": "label",
24667
+ "reflects": true,
24668
+ "inheritedFrom": {
24669
+ "name": "FormfieldWrapper",
24670
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
24671
+ }
24672
+ },
24673
+ {
24674
+ "kind": "field",
24675
+ "name": "required",
24676
+ "type": {
24677
+ "text": "boolean"
24678
+ },
24679
+ "default": "false",
24680
+ "description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
24681
+ "attribute": "required",
24682
+ "reflects": true,
24683
+ "inheritedFrom": {
24684
+ "name": "FormfieldWrapper",
24685
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
24686
+ }
24687
+ },
24688
+ {
24689
+ "kind": "field",
24690
+ "name": "id",
24691
+ "type": {
24692
+ "text": "string"
24693
+ },
24694
+ "default": "''",
24695
+ "description": "The unique id of the input field. It is used to link the input field with the label.",
24696
+ "attribute": "id",
24697
+ "inheritedFrom": {
24698
+ "name": "FormfieldWrapper",
24699
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
24700
+ }
24701
+ },
24702
+ {
24703
+ "kind": "field",
24704
+ "name": "helpTextType",
24705
+ "type": {
24706
+ "text": "ValidationType"
24707
+ },
24708
+ "description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
24709
+ "attribute": "help-text-type",
24710
+ "reflects": true,
24711
+ "inheritedFrom": {
24712
+ "name": "FormfieldWrapper",
24713
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
24714
+ }
24715
+ },
24716
+ {
24717
+ "kind": "field",
24718
+ "name": "helpText",
24719
+ "type": {
24720
+ "text": "string | undefined"
24721
+ },
24722
+ "description": "The help text that is displayed below the input field.",
24723
+ "attribute": "help-text",
24724
+ "reflects": true,
24725
+ "inheritedFrom": {
24726
+ "name": "FormfieldWrapper",
24727
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
24728
+ }
24729
+ },
24730
+ {
24731
+ "kind": "method",
24732
+ "name": "renderLabelElement",
24733
+ "privacy": "protected",
24734
+ "description": "creates the label element when the label property is set.\nid is used to link the label with the input field.",
24735
+ "return": {
24736
+ "type": {
24737
+ "text": ""
24738
+ }
24739
+ },
24740
+ "inheritedFrom": {
24741
+ "name": "FormfieldWrapper",
24742
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
24743
+ }
24744
+ },
24745
+ {
24746
+ "kind": "method",
24747
+ "name": "renderHelpTextIcon",
24748
+ "privacy": "protected",
24749
+ "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.",
24750
+ "return": {
24751
+ "type": {
24752
+ "text": ""
24753
+ }
24754
+ },
24755
+ "inheritedFrom": {
24756
+ "name": "FormfieldWrapper",
24757
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
24758
+ }
24759
+ },
24760
+ {
24761
+ "kind": "method",
24762
+ "name": "renderHelpText",
24763
+ "privacy": "protected",
24764
+ "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.",
24765
+ "return": {
24766
+ "type": {
24767
+ "text": ""
24768
+ }
24769
+ },
24770
+ "inheritedFrom": {
24771
+ "name": "FormfieldWrapper",
24772
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
24773
+ }
24774
+ },
24775
+ {
24776
+ "kind": "method",
24777
+ "name": "renderLabel",
24778
+ "privacy": "protected",
24779
+ "description": "renders the mdc-label-text container that contains the label and labelInfoToggleTip.",
24780
+ "return": {
24781
+ "type": {
24782
+ "text": ""
24783
+ }
24784
+ },
24785
+ "inheritedFrom": {
24786
+ "name": "FormfieldWrapper",
24787
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
24788
+ }
24789
+ },
24790
+ {
24791
+ "kind": "method",
24792
+ "name": "renderHelperText",
24793
+ "privacy": "protected",
24794
+ "description": "renders the mdc-help-text container that contains the helpertext icon and helpertext.",
24795
+ "return": {
24796
+ "type": {
24797
+ "text": ""
24798
+ }
24799
+ },
24800
+ "inheritedFrom": {
24801
+ "name": "FormfieldWrapper",
24802
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
24803
+ }
24804
+ }
24805
+ ],
24806
+ "superclass": {
24807
+ "name": "Input",
24808
+ "module": "/src/components/input/input.component"
24809
+ },
24810
+ "tagName": "mdc-searchfield",
24811
+ "jsDoc": "/**\n * 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 * @slot filters - Slot for input chips\n *\n */",
24812
+ "customElement": true,
24813
+ "attributes": [
24814
+ {
24815
+ "name": "name",
24816
+ "type": {
24817
+ "text": "string"
24818
+ },
24819
+ "default": "''",
24820
+ "description": "Indicates the name of the component group.\nThey are used to group elements in a form together.",
24821
+ "fieldName": "name",
24822
+ "inheritedFrom": {
24823
+ "name": "FormInternalsMixin",
24824
+ "module": "src/utils/mixins/FormInternalsMixin.ts"
24825
+ }
24826
+ },
24827
+ {
24828
+ "name": "value",
24829
+ "type": {
24830
+ "text": "string"
24831
+ },
24832
+ "default": "''",
24833
+ "description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
24834
+ "fieldName": "value",
24835
+ "inheritedFrom": {
24836
+ "name": "FormInternalsMixin",
24837
+ "module": "src/utils/mixins/FormInternalsMixin.ts"
24838
+ }
24839
+ },
24840
+ {
24841
+ "name": "validation-message",
24842
+ "type": {
24843
+ "text": "string | undefined"
24844
+ },
24845
+ "description": "Custom validation message that will override the default message and displayed when the input is invalid.",
24846
+ "fieldName": "validationMessage",
24847
+ "inheritedFrom": {
24848
+ "name": "FormInternalsMixin",
24849
+ "module": "src/utils/mixins/FormInternalsMixin.ts"
24850
+ }
24851
+ },
24852
+ {
24853
+ "name": "data-aria-label",
24854
+ "type": {
24855
+ "text": "string | null"
24856
+ },
24857
+ "default": "null",
24858
+ "description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
24859
+ "fieldName": "dataAriaLabel",
24860
+ "inheritedFrom": {
24861
+ "name": "DataAriaLabelMixin",
24862
+ "module": "src/utils/mixins/DataAriaLabelMixin.ts"
24863
+ }
24864
+ },
24865
+ {
24866
+ "name": "placeholder",
24867
+ "type": {
24868
+ "text": "string"
24869
+ },
24870
+ "default": "''",
24871
+ "description": "The placeholder text that is displayed when the input field is empty.",
24872
+ "fieldName": "placeholder",
24873
+ "inheritedFrom": {
24874
+ "name": "Input",
24875
+ "module": "src/components/input/input.component.ts"
24876
+ }
24877
+ },
24878
+ {
24879
+ "name": "readonly",
24880
+ "type": {
24881
+ "text": "boolean"
24882
+ },
24883
+ "default": "false",
24884
+ "description": "readonly attribute of the input field. If true, the input field is read-only.",
24885
+ "fieldName": "readonly",
24886
+ "inheritedFrom": {
24887
+ "name": "Input",
24888
+ "module": "src/components/input/input.component.ts"
24889
+ }
24890
+ },
24891
+ {
24892
+ "name": "prefix-text",
24893
+ "type": {
24894
+ "text": "string | undefined"
24895
+ },
24896
+ "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.",
24897
+ "fieldName": "prefixText",
24898
+ "inheritedFrom": {
24899
+ "name": "Input",
24900
+ "module": "src/components/input/input.component.ts"
24901
+ }
24902
+ },
24903
+ {
24904
+ "name": "leading-icon",
24905
+ "type": {
24906
+ "text": "IconNames | undefined"
24907
+ },
24908
+ "description": "The leading icon that is displayed before the input field.",
24909
+ "fieldName": "leadingIcon",
24910
+ "inheritedFrom": {
24911
+ "name": "Input",
24912
+ "module": "src/components/input/input.component.ts"
24913
+ }
24914
+ },
24915
+ {
24916
+ "name": "trailing-button",
24917
+ "type": {
24918
+ "text": "boolean"
24919
+ },
24920
+ "default": "false",
24921
+ "description": "The trailing button when set to true, shows a clear button that clears the input field.",
24922
+ "fieldName": "trailingButton",
24923
+ "inheritedFrom": {
24924
+ "name": "Input",
24925
+ "module": "src/components/input/input.component.ts"
24926
+ }
24927
+ },
24928
+ {
24929
+ "name": "maxlength",
24930
+ "type": {
24931
+ "text": "number | undefined"
24932
+ },
24933
+ "description": "The maximum number of characters that the input field can accept.",
24934
+ "fieldName": "maxlength",
24935
+ "inheritedFrom": {
24936
+ "name": "Input",
24937
+ "module": "src/components/input/input.component.ts"
24938
+ }
24939
+ },
24940
+ {
24941
+ "name": "minlength",
24942
+ "type": {
24943
+ "text": "number | undefined"
24944
+ },
24945
+ "description": "The minimum number of characters that the input field can accept.",
24946
+ "fieldName": "minlength",
24505
24947
  "inheritedFrom": {
24506
24948
  "name": "Input",
24507
- "module": "components/input/input.component.js"
24949
+ "module": "src/components/input/input.component.ts"
24508
24950
  }
24509
24951
  },
24510
24952
  {
24511
- "kind": "method",
24512
- "name": "renderInputChips",
24513
- "privacy": "private",
24514
- "description": "This method is used to render the input chips inside filters slot.\nIt will remove any elements that are not input chips."
24953
+ "name": "autocapitalize",
24954
+ "type": {
24955
+ "text": "AutoCapitalizeType"
24956
+ },
24957
+ "description": "The autocapitalize attribute of the input field.",
24958
+ "default": "'off'",
24959
+ "fieldName": "autocapitalize",
24960
+ "inheritedFrom": {
24961
+ "name": "Input",
24962
+ "module": "src/components/input/input.component.ts"
24963
+ }
24515
24964
  },
24516
24965
  {
24517
- "kind": "method",
24518
- "name": "clearInputText",
24519
- "privacy": "protected",
24520
- "description": "Clears the input field.",
24966
+ "name": "autocomplete",
24967
+ "type": {
24968
+ "text": "AutoCompleteType"
24969
+ },
24970
+ "description": "The autocomplete attribute of the input field.",
24971
+ "default": "'off'",
24972
+ "fieldName": "autocomplete",
24521
24973
  "inheritedFrom": {
24522
24974
  "name": "Input",
24523
- "module": "components/input/input.component.js"
24975
+ "module": "src/components/input/input.component.ts"
24524
24976
  }
24525
24977
  },
24526
24978
  {
24527
- "kind": "field",
24528
- "name": "name",
24979
+ "name": "autofocus",
24529
24980
  "type": {
24530
- "text": "string"
24981
+ "text": "boolean"
24531
24982
  },
24532
- "default": "''",
24533
- "description": "Indicates the name of the component group.\nThey are used to group elements in a form together.",
24534
- "attribute": "name",
24535
- "reflects": true,
24983
+ "default": "false",
24984
+ "description": "If true, the input field is focused when the component is rendered.",
24985
+ "fieldName": "autofocus",
24536
24986
  "inheritedFrom": {
24537
- "name": "FormInternalsMixin",
24538
- "module": "utils/mixins/FormInternalsMixin.js"
24987
+ "name": "Input",
24988
+ "module": "src/components/input/input.component.ts"
24539
24989
  }
24540
24990
  },
24541
24991
  {
24542
- "kind": "field",
24543
- "name": "value",
24992
+ "name": "dirname",
24544
24993
  "type": {
24545
- "text": "string"
24994
+ "text": "string | undefined"
24546
24995
  },
24547
- "default": "''",
24548
- "description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
24549
- "attribute": "value",
24550
- "reflects": true,
24996
+ "description": "Specifies the name of the directionality of text for submission purposes (e.g., \"rtl\" for right-to-left).",
24997
+ "fieldName": "dirname",
24551
24998
  "inheritedFrom": {
24552
- "name": "FormInternalsMixin",
24553
- "module": "utils/mixins/FormInternalsMixin.js"
24999
+ "name": "Input",
25000
+ "module": "src/components/input/input.component.ts"
24554
25001
  }
24555
25002
  },
24556
25003
  {
24557
- "kind": "field",
24558
- "name": "validationMessage",
25004
+ "name": "pattern",
24559
25005
  "type": {
24560
25006
  "text": "string | undefined"
24561
25007
  },
24562
- "description": "Custom validation message that will override the default message and displayed when the input is invalid.",
24563
- "attribute": "validation-message",
24564
- "reflects": true,
25008
+ "description": "The pattern attribute of the input field.\nSpecifies a regular expression that the input value must match for validation purposes.",
25009
+ "fieldName": "pattern",
24565
25010
  "inheritedFrom": {
24566
- "name": "FormInternalsMixin",
24567
- "module": "utils/mixins/FormInternalsMixin.js"
25011
+ "name": "Input",
25012
+ "module": "src/components/input/input.component.ts"
24568
25013
  }
24569
25014
  },
24570
25015
  {
24571
- "kind": "field",
24572
- "name": "validity",
25016
+ "name": "list",
24573
25017
  "type": {
24574
- "text": "ValidityState"
25018
+ "text": "string | undefined"
24575
25019
  },
24576
- "readonly": true,
25020
+ "description": "The list attribute of the input field.\nIdentifies a list of pre-defined options to suggest to the user.",
25021
+ "fieldName": "list",
24577
25022
  "inheritedFrom": {
24578
- "name": "FormInternalsMixin",
24579
- "module": "utils/mixins/FormInternalsMixin.js"
25023
+ "name": "Input",
25024
+ "module": "src/components/input/input.component.ts"
24580
25025
  }
24581
25026
  },
24582
25027
  {
24583
- "kind": "field",
24584
- "name": "willValidate",
24585
- "readonly": true,
25028
+ "name": "size",
25029
+ "type": {
25030
+ "text": "number | undefined | undefined"
25031
+ },
25032
+ "description": "The size attribute of the input field.\nSpecifies the width of the input field.",
25033
+ "default": "undefined",
25034
+ "fieldName": "size",
24586
25035
  "inheritedFrom": {
24587
- "name": "FormInternalsMixin",
24588
- "module": "utils/mixins/FormInternalsMixin.js"
25036
+ "name": "Input",
25037
+ "module": "src/components/input/input.component.ts"
24589
25038
  }
24590
25039
  },
24591
25040
  {
24592
- "kind": "method",
24593
- "name": "setValidity",
24594
- "description": "Sets the validity of the input field based on the input field's validity.",
24595
- "return": {
24596
- "type": {
24597
- "text": ""
24598
- }
25041
+ "name": "clear-aria-label",
25042
+ "type": {
25043
+ "text": "string"
24599
25044
  },
25045
+ "default": "''",
25046
+ "description": "Aria label for the trailing button. If trailing button is set to true, this label is used for the clear button.",
25047
+ "fieldName": "clearAriaLabel",
24600
25048
  "inheritedFrom": {
24601
- "name": "FormInternalsMixin",
24602
- "module": "utils/mixins/FormInternalsMixin.js"
25049
+ "name": "Input",
25050
+ "module": "src/components/input/input.component.ts"
24603
25051
  }
24604
25052
  },
24605
25053
  {
24606
- "kind": "method",
24607
- "name": "checkValidity",
24608
- "return": {
24609
- "type": {
24610
- "text": "boolean"
24611
- }
25054
+ "name": "disabled",
25055
+ "type": {
25056
+ "text": "boolean | undefined"
24612
25057
  },
25058
+ "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
25059
+ "default": "undefined",
25060
+ "fieldName": "disabled",
24613
25061
  "inheritedFrom": {
24614
- "name": "FormInternalsMixin",
24615
- "module": "utils/mixins/FormInternalsMixin.js"
25062
+ "name": "FormfieldWrapper",
25063
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
24616
25064
  }
24617
25065
  },
24618
25066
  {
24619
- "kind": "method",
24620
- "name": "reportValidity",
25067
+ "name": "label",
25068
+ "type": {
25069
+ "text": "string | undefined"
25070
+ },
25071
+ "description": "The label of the input field. It is linked to the input field using the `for` attribute.",
25072
+ "fieldName": "label",
24621
25073
  "inheritedFrom": {
24622
- "name": "FormInternalsMixin",
24623
- "module": "utils/mixins/FormInternalsMixin.js"
25074
+ "name": "FormfieldWrapper",
25075
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
24624
25076
  }
24625
25077
  },
24626
25078
  {
24627
- "kind": "field",
24628
- "name": "dataAriaLabel",
25079
+ "name": "required",
24629
25080
  "type": {
24630
- "text": "string | null"
25081
+ "text": "boolean"
24631
25082
  },
24632
- "default": "null",
24633
- "description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
24634
- "attribute": "data-aria-label",
24635
- "reflects": true,
25083
+ "default": "false",
25084
+ "description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
25085
+ "fieldName": "required",
24636
25086
  "inheritedFrom": {
24637
- "name": "DataAriaLabelMixin",
24638
- "module": "utils/mixins/DataAriaLabelMixin.js"
25087
+ "name": "FormfieldWrapper",
25088
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
24639
25089
  }
24640
25090
  },
24641
25091
  {
24642
- "kind": "field",
24643
- "name": "placeholder",
25092
+ "name": "id",
24644
25093
  "type": {
24645
25094
  "text": "string"
24646
25095
  },
24647
25096
  "default": "''",
24648
- "description": "The placeholder text that is displayed when the input field is empty.",
24649
- "attribute": "placeholder",
25097
+ "description": "The unique id of the input field. It is used to link the input field with the label.",
25098
+ "fieldName": "id",
24650
25099
  "inheritedFrom": {
24651
- "name": "Input",
24652
- "module": "components/input/input.component.js"
25100
+ "name": "FormfieldWrapper",
25101
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
24653
25102
  }
24654
25103
  },
24655
25104
  {
24656
- "kind": "field",
24657
- "name": "readonly",
25105
+ "name": "help-text-type",
24658
25106
  "type": {
24659
- "text": "boolean"
25107
+ "text": "ValidationType"
24660
25108
  },
24661
- "default": "false",
24662
- "description": "readonly attribute of the input field. If true, the input field is read-only.",
24663
- "attribute": "readonly",
25109
+ "description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
25110
+ "fieldName": "helpTextType",
24664
25111
  "inheritedFrom": {
24665
- "name": "Input",
24666
- "module": "components/input/input.component.js"
25112
+ "name": "FormfieldWrapper",
25113
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
24667
25114
  }
24668
25115
  },
24669
25116
  {
24670
- "kind": "field",
24671
- "name": "prefixText",
25117
+ "name": "help-text",
24672
25118
  "type": {
24673
25119
  "text": "string | undefined"
24674
25120
  },
24675
- "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.",
24676
- "attribute": "prefix-text",
25121
+ "description": "The help text that is displayed below the input field.",
25122
+ "fieldName": "helpText",
24677
25123
  "inheritedFrom": {
24678
- "name": "Input",
24679
- "module": "components/input/input.component.js"
25124
+ "name": "FormfieldWrapper",
25125
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
24680
25126
  }
24681
- },
25127
+ }
25128
+ ],
25129
+ "cssProperties": [
24682
25130
  {
24683
- "kind": "field",
24684
- "name": "leadingIcon",
24685
- "type": {
24686
- "text": "IconNames | undefined"
24687
- },
24688
- "description": "The leading icon that is displayed before the input field.",
24689
- "attribute": "leading-icon",
25131
+ "description": "Border color for the input container when disabled",
25132
+ "name": "--mdc-input-disabled-border-color",
24690
25133
  "inheritedFrom": {
24691
25134
  "name": "Input",
24692
- "module": "components/input/input.component.js"
25135
+ "module": "src/components/input/input.component.ts"
24693
25136
  }
24694
25137
  },
24695
25138
  {
24696
- "kind": "field",
24697
- "name": "trailingButton",
24698
- "type": {
24699
- "text": "boolean"
24700
- },
24701
- "default": "false",
24702
- "description": "The trailing button when set to true, shows a clear button that clears the input field.",
24703
- "attribute": "trailing-button",
25139
+ "description": "Text color for the input field when disabled",
25140
+ "name": "--mdc-input-disabled-text-color",
24704
25141
  "inheritedFrom": {
24705
25142
  "name": "Input",
24706
- "module": "components/input/input.component.js"
25143
+ "module": "src/components/input/input.component.ts"
24707
25144
  }
24708
25145
  },
24709
25146
  {
24710
- "kind": "field",
24711
- "name": "maxlength",
24712
- "type": {
24713
- "text": "number | undefined"
24714
- },
24715
- "description": "The maximum number of characters that the input field can accept.",
24716
- "attribute": "maxlength",
25147
+ "description": "Background color for the input field when disabled",
25148
+ "name": "--mdc-input-disabled-background-color",
24717
25149
  "inheritedFrom": {
24718
25150
  "name": "Input",
24719
- "module": "components/input/input.component.js"
25151
+ "module": "src/components/input/input.component.ts"
24720
25152
  }
24721
25153
  },
24722
25154
  {
24723
- "kind": "field",
24724
- "name": "minlength",
24725
- "type": {
24726
- "text": "number | undefined"
24727
- },
24728
- "description": "The minimum number of characters that the input field can accept.",
24729
- "attribute": "minlength",
25155
+ "description": "Border color for the input container",
25156
+ "name": "--mdc-input-border-color",
24730
25157
  "inheritedFrom": {
24731
25158
  "name": "Input",
24732
- "module": "components/input/input.component.js"
25159
+ "module": "src/components/input/input.component.ts"
24733
25160
  }
24734
25161
  },
24735
25162
  {
24736
- "kind": "field",
24737
- "name": "autocapitalize",
24738
- "type": {
24739
- "text": "AutoCapitalizeType"
24740
- },
24741
- "description": "The autocapitalize attribute of the input field.",
24742
- "default": "'off'",
24743
- "attribute": "autocapitalize",
25163
+ "description": "Text color for the input field",
25164
+ "name": "--mdc-input-text-color",
24744
25165
  "inheritedFrom": {
24745
25166
  "name": "Input",
24746
- "module": "components/input/input.component.js"
25167
+ "module": "src/components/input/input.component.ts"
24747
25168
  }
24748
25169
  },
24749
25170
  {
24750
- "kind": "field",
24751
- "name": "autocomplete",
24752
- "type": {
24753
- "text": "AutoCompleteType"
24754
- },
24755
- "description": "The autocomplete attribute of the input field.",
24756
- "default": "'off'",
24757
- "attribute": "autocomplete",
25171
+ "description": "Background color for the input field",
25172
+ "name": "--mdc-input-background-color",
24758
25173
  "inheritedFrom": {
24759
25174
  "name": "Input",
24760
- "module": "components/input/input.component.js"
25175
+ "module": "src/components/input/input.component.ts"
24761
25176
  }
24762
25177
  },
24763
25178
  {
24764
- "kind": "field",
24765
- "name": "autofocus",
24766
- "type": {
24767
- "text": "boolean"
24768
- },
24769
- "default": "false",
24770
- "description": "If true, the input field is focused when the component is rendered.",
24771
- "attribute": "autofocus",
25179
+ "description": "Background color for the selected text",
25180
+ "name": "--mdc-input-selection-background-color",
24772
25181
  "inheritedFrom": {
24773
25182
  "name": "Input",
24774
- "module": "components/input/input.component.js"
25183
+ "module": "src/components/input/input.component.ts"
24775
25184
  }
24776
25185
  },
24777
25186
  {
24778
- "kind": "field",
24779
- "name": "dirname",
24780
- "type": {
24781
- "text": "string | undefined"
24782
- },
24783
- "description": "Specifies the name of the directionality of text for submission purposes (e.g., \"rtl\" for right-to-left).",
24784
- "attribute": "dirname",
25187
+ "description": "Text color for the selected text",
25188
+ "name": "--mdc-input-selection-text-color",
24785
25189
  "inheritedFrom": {
24786
25190
  "name": "Input",
24787
- "module": "components/input/input.component.js"
25191
+ "module": "src/components/input/input.component.ts"
24788
25192
  }
24789
25193
  },
24790
25194
  {
24791
- "kind": "field",
24792
- "name": "pattern",
24793
- "type": {
24794
- "text": "string | undefined"
24795
- },
24796
- "description": "The pattern attribute of the input field.\nSpecifies a regular expression that the input value must match for validation purposes.",
24797
- "attribute": "pattern",
25195
+ "description": "Text color for the help text",
25196
+ "name": "--mdc-input-support-text-color",
24798
25197
  "inheritedFrom": {
24799
25198
  "name": "Input",
24800
- "module": "components/input/input.component.js"
25199
+ "module": "src/components/input/input.component.ts"
24801
25200
  }
24802
25201
  },
24803
25202
  {
24804
- "kind": "field",
24805
- "name": "list",
24806
- "type": {
24807
- "text": "string | undefined"
24808
- },
24809
- "description": "The list attribute of the input field.\nIdentifies a list of pre-defined options to suggest to the user.",
24810
- "attribute": "list",
25203
+ "description": "Background color for the input field when hovered",
25204
+ "name": "--mdc-input-hover-background-color",
24811
25205
  "inheritedFrom": {
24812
25206
  "name": "Input",
24813
- "module": "components/input/input.component.js"
25207
+ "module": "src/components/input/input.component.ts"
24814
25208
  }
24815
25209
  },
24816
25210
  {
24817
- "kind": "field",
24818
- "name": "size",
24819
- "type": {
24820
- "text": "number | undefined | undefined"
24821
- },
24822
- "description": "The size attribute of the input field.\nSpecifies the width of the input field.",
24823
- "default": "undefined",
24824
- "attribute": "size",
25211
+ "description": "Background color for the input field when focused",
25212
+ "name": "--mdc-input-focused-background-color",
24825
25213
  "inheritedFrom": {
24826
25214
  "name": "Input",
24827
- "module": "components/input/input.component.js"
25215
+ "module": "src/components/input/input.component.ts"
24828
25216
  }
24829
25217
  },
24830
25218
  {
24831
- "kind": "field",
24832
- "name": "clearAriaLabel",
24833
- "type": {
24834
- "text": "string"
24835
- },
24836
- "default": "''",
24837
- "description": "Aria label for the trailing button. If trailing button is set to true, this label is used for the clear button.",
24838
- "attribute": "clear-aria-label",
25219
+ "description": "Border color for the input container when focused",
25220
+ "name": "--mdc-input-focused-border-color",
24839
25221
  "inheritedFrom": {
24840
25222
  "name": "Input",
24841
- "module": "components/input/input.component.js"
25223
+ "module": "src/components/input/input.component.ts"
24842
25224
  }
24843
25225
  },
24844
25226
  {
24845
- "kind": "method",
24846
- "name": "handleValueChange",
24847
- "description": "Handles the value change of the input field.\nSets the form value and updates the validity of the input field.",
24848
- "return": {
24849
- "type": {
24850
- "text": ""
24851
- }
24852
- },
25227
+ "description": "Border color for the input container when error",
25228
+ "name": "--mdc-input-error-border-color",
24853
25229
  "inheritedFrom": {
24854
25230
  "name": "Input",
24855
- "module": "components/input/input.component.js"
25231
+ "module": "src/components/input/input.component.ts"
24856
25232
  }
24857
25233
  },
24858
25234
  {
24859
- "kind": "method",
24860
- "name": "setInputValidity",
24861
- "privacy": "private",
25235
+ "description": "Border color for the input container when warning",
25236
+ "name": "--mdc-input-warning-border-color",
24862
25237
  "inheritedFrom": {
24863
25238
  "name": "Input",
24864
- "module": "components/input/input.component.js"
25239
+ "module": "src/components/input/input.component.ts"
24865
25240
  }
24866
25241
  },
24867
25242
  {
24868
- "kind": "method",
24869
- "name": "updateValue",
24870
- "privacy": "private",
24871
- "description": "Updates the value of the input field.\nSets the form value.",
24872
- "return": {
24873
- "type": {
24874
- "text": ""
24875
- }
24876
- },
25243
+ "description": "Border color for the input container when success",
25244
+ "name": "--mdc-input-success-border-color",
24877
25245
  "inheritedFrom": {
24878
25246
  "name": "Input",
24879
- "module": "components/input/input.component.js"
25247
+ "module": "src/components/input/input.component.ts"
24880
25248
  }
24881
25249
  },
24882
25250
  {
24883
- "kind": "method",
24884
- "name": "onInput",
24885
- "privacy": "private",
24886
- "description": "Handles the input event of the input field.\nUpdates the value and sets the validity of the input field.",
25251
+ "description": "Border color for the input container when primary",
25252
+ "name": "--mdc-input-primary-border-color",
24887
25253
  "inheritedFrom": {
24888
25254
  "name": "Input",
24889
- "module": "components/input/input.component.js"
25255
+ "module": "src/components/input/input.component.ts"
24890
25256
  }
24891
- },
25257
+ }
25258
+ ],
25259
+ "events": [
24892
25260
  {
24893
- "kind": "method",
24894
- "name": "onChange",
24895
- "privacy": "private",
24896
- "parameters": [
24897
- {
24898
- "name": "event",
24899
- "type": {
24900
- "text": "Event"
24901
- },
24902
- "description": "Event which contains information about the value change."
24903
- }
24904
- ],
24905
- "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",
25261
+ "type": {
25262
+ "text": "EventConstructor"
25263
+ },
24906
25264
  "inheritedFrom": {
24907
25265
  "name": "Input",
24908
- "module": "components/input/input.component.js"
25266
+ "module": "src/components/input/input.component.ts"
24909
25267
  }
24910
25268
  },
24911
25269
  {
24912
- "kind": "method",
24913
- "name": "renderLeadingIcon",
24914
- "privacy": "protected",
24915
- "description": "Renders the leading icon before the input field.\nIf the leading icon is not set, it will not be displayed.",
24916
- "return": {
24917
- "type": {
24918
- "text": ""
24919
- }
24920
- },
25270
+ "description": "(React: onInput) This event is dispatched when the value of the input field changes (every press).",
25271
+ "name": "input",
25272
+ "reactName": "onInput",
24921
25273
  "inheritedFrom": {
24922
25274
  "name": "Input",
24923
- "module": "components/input/input.component.js"
25275
+ "module": "src/components/input/input.component.ts"
24924
25276
  }
24925
25277
  },
24926
25278
  {
24927
- "kind": "method",
24928
- "name": "renderPrefixText",
24929
- "privacy": "protected",
24930
- "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.",
24931
- "return": {
24932
- "type": {
24933
- "text": ""
24934
- }
24935
- },
25279
+ "description": "(React: onChange) This event is dispatched when the value of the input field changes (on blur).",
25280
+ "name": "change",
25281
+ "reactName": "onChange",
24936
25282
  "inheritedFrom": {
24937
25283
  "name": "Input",
24938
- "module": "components/input/input.component.js"
25284
+ "module": "src/components/input/input.component.ts"
24939
25285
  }
24940
25286
  },
24941
25287
  {
24942
- "kind": "method",
24943
- "name": "renderTrailingButton",
24944
- "privacy": "protected",
24945
- "parameters": [
24946
- {
24947
- "name": "show",
24948
- "default": "false"
24949
- }
24950
- ],
24951
- "description": "Renders the trailing button to clear the input field if the trailingButton is set to true.",
24952
- "return": {
24953
- "type": {
24954
- "text": ""
24955
- }
24956
- },
25288
+ "description": "(React: onFocus) This event is dispatched when the input receives focus.",
25289
+ "name": "focus",
25290
+ "reactName": "onFocus",
24957
25291
  "inheritedFrom": {
24958
25292
  "name": "Input",
24959
- "module": "components/input/input.component.js"
25293
+ "module": "src/components/input/input.component.ts"
24960
25294
  }
24961
25295
  },
24962
25296
  {
24963
- "kind": "method",
24964
- "name": "renderInputElement",
24965
- "privacy": "protected",
24966
- "parameters": [
24967
- {
24968
- "name": "type",
24969
- "type": {
24970
- "text": "InputType"
24971
- }
24972
- },
24973
- {
24974
- "name": "hidePlaceholder",
24975
- "default": "false"
24976
- }
24977
- ],
25297
+ "description": "(React: onBlur) This event is dispatched when the input loses focus.",
25298
+ "name": "blur",
25299
+ "reactName": "onBlur",
25300
+ "inheritedFrom": {
25301
+ "name": "Input",
25302
+ "module": "src/components/input/input.component.ts"
25303
+ }
25304
+ }
25305
+ ]
25306
+ }
25307
+ ],
25308
+ "exports": [
25309
+ {
25310
+ "kind": "js",
25311
+ "name": "default",
25312
+ "declaration": {
25313
+ "name": "Searchfield",
25314
+ "module": "components/searchfield/searchfield.component.js"
25315
+ }
25316
+ }
25317
+ ]
25318
+ },
25319
+ {
25320
+ "kind": "javascript-module",
25321
+ "path": "components/radiogroup/radiogroup.component.js",
25322
+ "declarations": [
25323
+ {
25324
+ "kind": "class",
25325
+ "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.",
25326
+ "name": "RadioGroup",
25327
+ "cssProperties": [
25328
+ {
25329
+ "description": "color of the description text",
25330
+ "name": "--mdc-radiogroup-description-text-normal"
25331
+ }
25332
+ ],
25333
+ "members": [
25334
+ {
25335
+ "kind": "field",
25336
+ "name": "name",
25337
+ "type": {
25338
+ "text": "string"
25339
+ },
25340
+ "default": "''",
25341
+ "description": "Name of the radio group.\nThey are used to group elements in a form together.",
25342
+ "attribute": "name"
25343
+ },
25344
+ {
25345
+ "kind": "field",
25346
+ "name": "dataAriaLabel",
25347
+ "type": {
25348
+ "text": "string | null"
25349
+ },
25350
+ "default": "null",
25351
+ "description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
25352
+ "attribute": "data-aria-label",
25353
+ "reflects": true,
24978
25354
  "inheritedFrom": {
24979
- "name": "Input",
24980
- "module": "components/input/input.component.js"
25355
+ "name": "DataAriaLabelMixin",
25356
+ "module": "utils/mixins/DataAriaLabelMixin.js"
24981
25357
  }
24982
25358
  },
24983
25359
  {
@@ -25101,292 +25477,68 @@
25101
25477
  "name": "renderHelpText",
25102
25478
  "privacy": "protected",
25103
25479
  "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.",
25104
- "return": {
25105
- "type": {
25106
- "text": ""
25107
- }
25108
- },
25109
- "inheritedFrom": {
25110
- "name": "FormfieldWrapper",
25111
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
25112
- }
25113
- },
25114
- {
25115
- "kind": "method",
25116
- "name": "renderLabel",
25117
- "privacy": "protected",
25118
- "description": "renders the mdc-label-text container that contains the label and labelInfoToggleTip.",
25119
- "return": {
25120
- "type": {
25121
- "text": ""
25122
- }
25123
- },
25124
- "inheritedFrom": {
25125
- "name": "FormfieldWrapper",
25126
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
25127
- }
25128
- },
25129
- {
25130
- "kind": "method",
25131
- "name": "renderHelperText",
25132
- "privacy": "protected",
25133
- "description": "renders the mdc-help-text container that contains the helpertext icon and helpertext.",
25134
- "return": {
25135
- "type": {
25136
- "text": ""
25137
- }
25138
- },
25139
- "inheritedFrom": {
25140
- "name": "FormfieldWrapper",
25141
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
25142
- }
25143
- }
25144
- ],
25145
- "superclass": {
25146
- "name": "Input",
25147
- "module": "/src/components/input/input.component"
25148
- },
25149
- "tagName": "mdc-searchfield",
25150
- "jsDoc": "/**\n * 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 * @slot filters - Slot for input chips\n *\n */",
25151
- "customElement": true,
25152
- "attributes": [
25153
- {
25154
- "name": "name",
25155
- "type": {
25156
- "text": "string"
25157
- },
25158
- "default": "''",
25159
- "description": "Indicates the name of the component group.\nThey are used to group elements in a form together.",
25160
- "fieldName": "name",
25161
- "inheritedFrom": {
25162
- "name": "FormInternalsMixin",
25163
- "module": "src/utils/mixins/FormInternalsMixin.ts"
25164
- }
25165
- },
25166
- {
25167
- "name": "value",
25168
- "type": {
25169
- "text": "string"
25170
- },
25171
- "default": "''",
25172
- "description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
25173
- "fieldName": "value",
25174
- "inheritedFrom": {
25175
- "name": "FormInternalsMixin",
25176
- "module": "src/utils/mixins/FormInternalsMixin.ts"
25177
- }
25178
- },
25179
- {
25180
- "name": "validation-message",
25181
- "type": {
25182
- "text": "string | undefined"
25183
- },
25184
- "description": "Custom validation message that will override the default message and displayed when the input is invalid.",
25185
- "fieldName": "validationMessage",
25186
- "inheritedFrom": {
25187
- "name": "FormInternalsMixin",
25188
- "module": "src/utils/mixins/FormInternalsMixin.ts"
25189
- }
25190
- },
25191
- {
25192
- "name": "data-aria-label",
25193
- "type": {
25194
- "text": "string | null"
25195
- },
25196
- "default": "null",
25197
- "description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
25198
- "fieldName": "dataAriaLabel",
25199
- "inheritedFrom": {
25200
- "name": "DataAriaLabelMixin",
25201
- "module": "src/utils/mixins/DataAriaLabelMixin.ts"
25202
- }
25203
- },
25204
- {
25205
- "name": "placeholder",
25206
- "type": {
25207
- "text": "string"
25208
- },
25209
- "default": "''",
25210
- "description": "The placeholder text that is displayed when the input field is empty.",
25211
- "fieldName": "placeholder",
25212
- "inheritedFrom": {
25213
- "name": "Input",
25214
- "module": "src/components/input/input.component.ts"
25215
- }
25216
- },
25217
- {
25218
- "name": "readonly",
25219
- "type": {
25220
- "text": "boolean"
25221
- },
25222
- "default": "false",
25223
- "description": "readonly attribute of the input field. If true, the input field is read-only.",
25224
- "fieldName": "readonly",
25225
- "inheritedFrom": {
25226
- "name": "Input",
25227
- "module": "src/components/input/input.component.ts"
25228
- }
25229
- },
25230
- {
25231
- "name": "prefix-text",
25232
- "type": {
25233
- "text": "string | undefined"
25234
- },
25235
- "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.",
25236
- "fieldName": "prefixText",
25237
- "inheritedFrom": {
25238
- "name": "Input",
25239
- "module": "src/components/input/input.component.ts"
25240
- }
25241
- },
25242
- {
25243
- "name": "leading-icon",
25244
- "type": {
25245
- "text": "IconNames | undefined"
25246
- },
25247
- "description": "The leading icon that is displayed before the input field.",
25248
- "fieldName": "leadingIcon",
25249
- "inheritedFrom": {
25250
- "name": "Input",
25251
- "module": "src/components/input/input.component.ts"
25252
- }
25253
- },
25254
- {
25255
- "name": "trailing-button",
25256
- "type": {
25257
- "text": "boolean"
25258
- },
25259
- "default": "false",
25260
- "description": "The trailing button when set to true, shows a clear button that clears the input field.",
25261
- "fieldName": "trailingButton",
25262
- "inheritedFrom": {
25263
- "name": "Input",
25264
- "module": "src/components/input/input.component.ts"
25265
- }
25266
- },
25267
- {
25268
- "name": "maxlength",
25269
- "type": {
25270
- "text": "number | undefined"
25271
- },
25272
- "description": "The maximum number of characters that the input field can accept.",
25273
- "fieldName": "maxlength",
25274
- "inheritedFrom": {
25275
- "name": "Input",
25276
- "module": "src/components/input/input.component.ts"
25277
- }
25278
- },
25279
- {
25280
- "name": "minlength",
25281
- "type": {
25282
- "text": "number | undefined"
25283
- },
25284
- "description": "The minimum number of characters that the input field can accept.",
25285
- "fieldName": "minlength",
25286
- "inheritedFrom": {
25287
- "name": "Input",
25288
- "module": "src/components/input/input.component.ts"
25289
- }
25290
- },
25291
- {
25292
- "name": "autocapitalize",
25293
- "type": {
25294
- "text": "AutoCapitalizeType"
25295
- },
25296
- "description": "The autocapitalize attribute of the input field.",
25297
- "default": "'off'",
25298
- "fieldName": "autocapitalize",
25299
- "inheritedFrom": {
25300
- "name": "Input",
25301
- "module": "src/components/input/input.component.ts"
25302
- }
25303
- },
25304
- {
25305
- "name": "autocomplete",
25306
- "type": {
25307
- "text": "AutoCompleteType"
25308
- },
25309
- "description": "The autocomplete attribute of the input field.",
25310
- "default": "'off'",
25311
- "fieldName": "autocomplete",
25312
- "inheritedFrom": {
25313
- "name": "Input",
25314
- "module": "src/components/input/input.component.ts"
25315
- }
25316
- },
25317
- {
25318
- "name": "autofocus",
25319
- "type": {
25320
- "text": "boolean"
25321
- },
25322
- "default": "false",
25323
- "description": "If true, the input field is focused when the component is rendered.",
25324
- "fieldName": "autofocus",
25325
- "inheritedFrom": {
25326
- "name": "Input",
25327
- "module": "src/components/input/input.component.ts"
25328
- }
25329
- },
25330
- {
25331
- "name": "dirname",
25332
- "type": {
25333
- "text": "string | undefined"
25334
- },
25335
- "description": "Specifies the name of the directionality of text for submission purposes (e.g., \"rtl\" for right-to-left).",
25336
- "fieldName": "dirname",
25337
- "inheritedFrom": {
25338
- "name": "Input",
25339
- "module": "src/components/input/input.component.ts"
25340
- }
25341
- },
25342
- {
25343
- "name": "pattern",
25344
- "type": {
25345
- "text": "string | undefined"
25480
+ "return": {
25481
+ "type": {
25482
+ "text": ""
25483
+ }
25346
25484
  },
25347
- "description": "The pattern attribute of the input field.\nSpecifies a regular expression that the input value must match for validation purposes.",
25348
- "fieldName": "pattern",
25349
25485
  "inheritedFrom": {
25350
- "name": "Input",
25351
- "module": "src/components/input/input.component.ts"
25486
+ "name": "FormfieldWrapper",
25487
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
25352
25488
  }
25353
25489
  },
25354
25490
  {
25355
- "name": "list",
25356
- "type": {
25357
- "text": "string | undefined"
25491
+ "kind": "method",
25492
+ "name": "renderLabel",
25493
+ "privacy": "protected",
25494
+ "description": "renders the mdc-label-text container that contains the label and labelInfoToggleTip.",
25495
+ "return": {
25496
+ "type": {
25497
+ "text": ""
25498
+ }
25358
25499
  },
25359
- "description": "The list attribute of the input field.\nIdentifies a list of pre-defined options to suggest to the user.",
25360
- "fieldName": "list",
25361
25500
  "inheritedFrom": {
25362
- "name": "Input",
25363
- "module": "src/components/input/input.component.ts"
25501
+ "name": "FormfieldWrapper",
25502
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
25364
25503
  }
25365
25504
  },
25366
25505
  {
25367
- "name": "size",
25368
- "type": {
25369
- "text": "number | undefined | undefined"
25506
+ "kind": "method",
25507
+ "name": "renderHelperText",
25508
+ "privacy": "protected",
25509
+ "description": "renders the mdc-help-text container that contains the helpertext icon and helpertext.",
25510
+ "return": {
25511
+ "type": {
25512
+ "text": ""
25513
+ }
25370
25514
  },
25371
- "description": "The size attribute of the input field.\nSpecifies the width of the input field.",
25372
- "default": "undefined",
25373
- "fieldName": "size",
25374
25515
  "inheritedFrom": {
25375
- "name": "Input",
25376
- "module": "src/components/input/input.component.ts"
25516
+ "name": "FormfieldWrapper",
25517
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
25377
25518
  }
25378
- },
25519
+ }
25520
+ ],
25521
+ "attributes": [
25379
25522
  {
25380
- "name": "clear-aria-label",
25523
+ "name": "name",
25381
25524
  "type": {
25382
25525
  "text": "string"
25383
25526
  },
25384
25527
  "default": "''",
25385
- "description": "Aria label for the trailing button. If trailing button is set to true, this label is used for the clear button.",
25386
- "fieldName": "clearAriaLabel",
25528
+ "description": "Name of the radio group.\nThey are used to group elements in a form together.",
25529
+ "fieldName": "name"
25530
+ },
25531
+ {
25532
+ "name": "data-aria-label",
25533
+ "type": {
25534
+ "text": "string | null"
25535
+ },
25536
+ "default": "null",
25537
+ "description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
25538
+ "fieldName": "dataAriaLabel",
25387
25539
  "inheritedFrom": {
25388
- "name": "Input",
25389
- "module": "src/components/input/input.component.ts"
25540
+ "name": "DataAriaLabelMixin",
25541
+ "module": "src/utils/mixins/DataAriaLabelMixin.ts"
25390
25542
  }
25391
25543
  },
25392
25544
  {
@@ -25465,180 +25617,28 @@
25465
25617
  }
25466
25618
  }
25467
25619
  ],
25468
- "cssProperties": [
25469
- {
25470
- "description": "Border color for the input container when disabled",
25471
- "name": "--mdc-input-disabled-border-color",
25472
- "inheritedFrom": {
25473
- "name": "Input",
25474
- "module": "src/components/input/input.component.ts"
25475
- }
25476
- },
25477
- {
25478
- "description": "Text color for the input field when disabled",
25479
- "name": "--mdc-input-disabled-text-color",
25480
- "inheritedFrom": {
25481
- "name": "Input",
25482
- "module": "src/components/input/input.component.ts"
25483
- }
25484
- },
25485
- {
25486
- "description": "Background color for the input field when disabled",
25487
- "name": "--mdc-input-disabled-background-color",
25488
- "inheritedFrom": {
25489
- "name": "Input",
25490
- "module": "src/components/input/input.component.ts"
25491
- }
25492
- },
25493
- {
25494
- "description": "Border color for the input container",
25495
- "name": "--mdc-input-border-color",
25496
- "inheritedFrom": {
25497
- "name": "Input",
25498
- "module": "src/components/input/input.component.ts"
25499
- }
25500
- },
25501
- {
25502
- "description": "Text color for the input field",
25503
- "name": "--mdc-input-text-color",
25504
- "inheritedFrom": {
25505
- "name": "Input",
25506
- "module": "src/components/input/input.component.ts"
25507
- }
25508
- },
25509
- {
25510
- "description": "Background color for the input field",
25511
- "name": "--mdc-input-background-color",
25512
- "inheritedFrom": {
25513
- "name": "Input",
25514
- "module": "src/components/input/input.component.ts"
25515
- }
25516
- },
25517
- {
25518
- "description": "Background color for the selected text",
25519
- "name": "--mdc-input-selection-background-color",
25520
- "inheritedFrom": {
25521
- "name": "Input",
25522
- "module": "src/components/input/input.component.ts"
25523
- }
25524
- },
25525
- {
25526
- "description": "Text color for the selected text",
25527
- "name": "--mdc-input-selection-text-color",
25528
- "inheritedFrom": {
25529
- "name": "Input",
25530
- "module": "src/components/input/input.component.ts"
25531
- }
25532
- },
25533
- {
25534
- "description": "Text color for the help text",
25535
- "name": "--mdc-input-support-text-color",
25536
- "inheritedFrom": {
25537
- "name": "Input",
25538
- "module": "src/components/input/input.component.ts"
25539
- }
25540
- },
25541
- {
25542
- "description": "Background color for the input field when hovered",
25543
- "name": "--mdc-input-hover-background-color",
25544
- "inheritedFrom": {
25545
- "name": "Input",
25546
- "module": "src/components/input/input.component.ts"
25547
- }
25548
- },
25549
- {
25550
- "description": "Background color for the input field when focused",
25551
- "name": "--mdc-input-focused-background-color",
25552
- "inheritedFrom": {
25553
- "name": "Input",
25554
- "module": "src/components/input/input.component.ts"
25555
- }
25556
- },
25557
- {
25558
- "description": "Border color for the input container when focused",
25559
- "name": "--mdc-input-focused-border-color",
25560
- "inheritedFrom": {
25561
- "name": "Input",
25562
- "module": "src/components/input/input.component.ts"
25563
- }
25564
- },
25565
- {
25566
- "description": "Border color for the input container when error",
25567
- "name": "--mdc-input-error-border-color",
25568
- "inheritedFrom": {
25569
- "name": "Input",
25570
- "module": "src/components/input/input.component.ts"
25571
- }
25572
- },
25573
- {
25574
- "description": "Border color for the input container when warning",
25575
- "name": "--mdc-input-warning-border-color",
25576
- "inheritedFrom": {
25577
- "name": "Input",
25578
- "module": "src/components/input/input.component.ts"
25579
- }
25580
- },
25581
- {
25582
- "description": "Border color for the input container when success",
25583
- "name": "--mdc-input-success-border-color",
25584
- "inheritedFrom": {
25585
- "name": "Input",
25586
- "module": "src/components/input/input.component.ts"
25587
- }
25588
- },
25589
- {
25590
- "description": "Border color for the input container when primary",
25591
- "name": "--mdc-input-primary-border-color",
25592
- "inheritedFrom": {
25593
- "name": "Input",
25594
- "module": "src/components/input/input.component.ts"
25595
- }
25596
- }
25597
- ],
25598
- "events": [
25599
- {
25600
- "type": {
25601
- "text": "EventConstructor"
25602
- },
25603
- "inheritedFrom": {
25604
- "name": "Input",
25605
- "module": "src/components/input/input.component.ts"
25606
- }
25607
- },
25608
- {
25609
- "description": "(React: onInput) This event is dispatched when the value of the input field changes (every press).",
25610
- "name": "input",
25611
- "reactName": "onInput",
25612
- "inheritedFrom": {
25613
- "name": "Input",
25614
- "module": "src/components/input/input.component.ts"
25615
- }
25616
- },
25617
- {
25618
- "description": "(React: onChange) This event is dispatched when the value of the input field changes (on blur).",
25619
- "name": "change",
25620
- "reactName": "onChange",
25621
- "inheritedFrom": {
25622
- "name": "Input",
25623
- "module": "src/components/input/input.component.ts"
25624
- }
25625
- },
25620
+ "superclass": {
25621
+ "name": "FormfieldGroup",
25622
+ "module": "/src/components/formfieldgroup"
25623
+ },
25624
+ "tagName": "mdc-radiogroup",
25625
+ "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 */",
25626
+ "customElement": true,
25627
+ "slots": [
25626
25628
  {
25627
- "description": "(React: onFocus) This event is dispatched when the input receives focus.",
25628
- "name": "focus",
25629
- "reactName": "onFocus",
25629
+ "description": "This is a default slot for checkbox or toggle components.",
25630
+ "name": "default",
25630
25631
  "inheritedFrom": {
25631
- "name": "Input",
25632
- "module": "src/components/input/input.component.ts"
25632
+ "name": "FormfieldGroup",
25633
+ "module": "src/components/formfieldgroup/formfieldgroup.component.ts"
25633
25634
  }
25634
25635
  },
25635
25636
  {
25636
- "description": "(React: onBlur) This event is dispatched when the input loses focus.",
25637
- "name": "blur",
25638
- "reactName": "onBlur",
25637
+ "description": "slot to add the label info icon",
25638
+ "name": "label-info",
25639
25639
  "inheritedFrom": {
25640
- "name": "Input",
25641
- "module": "src/components/input/input.component.ts"
25640
+ "name": "FormfieldWrapper",
25641
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
25642
25642
  }
25643
25643
  }
25644
25644
  ]
@@ -25649,8 +25649,8 @@
25649
25649
  "kind": "js",
25650
25650
  "name": "default",
25651
25651
  "declaration": {
25652
- "name": "Searchfield",
25653
- "module": "components/searchfield/searchfield.component.js"
25652
+ "name": "RadioGroup",
25653
+ "module": "components/radiogroup/radiogroup.component.js"
25654
25654
  }
25655
25655
  }
25656
25656
  ]