@momentum-design/components 0.76.3 → 0.76.5

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.
@@ -15132,41 +15132,20 @@
15132
15132
  "module": "utils/mixins/MenuMixin.js"
15133
15133
  }
15134
15134
  },
15135
- {
15136
- "kind": "method",
15137
- "name": "setTabIndexOnMouseClick",
15138
- "privacy": "protected",
15139
- "return": {
15140
- "type": {
15141
- "text": "void"
15142
- }
15143
- },
15144
- "parameters": [
15145
- {
15146
- "name": "event",
15147
- "type": {
15148
- "text": "MouseEvent"
15149
- },
15150
- "description": "The mouse click event."
15151
- }
15152
- ],
15153
- "description": "Handles the mouse click event on the menu items.\nResets all the menu items tabindex to -1 and sets the tabindex of the\nelement at the given index to 0, effectively setting the active\nelement. This is used when clicking on the menu items.",
15154
- "inheritedFrom": {
15155
- "name": "MenuMixin",
15156
- "module": "utils/mixins/MenuMixin.js"
15157
- }
15158
- },
15159
15135
  {
15160
15136
  "kind": "method",
15161
15137
  "name": "resetTabIndexAndSetActiveTabIndex",
15162
- "privacy": "protected",
15138
+ "privacy": "private",
15163
15139
  "parameters": [
15164
15140
  {
15165
- "name": "newIndex",
15141
+ "name": "menuItems",
15166
15142
  "type": {
15167
- "text": "number"
15168
- },
15169
- "description": "The index of the new active element in the list."
15143
+ "text": "Array<HTMLElement>"
15144
+ }
15145
+ },
15146
+ {
15147
+ "description": "The index of the new active element in the list.",
15148
+ "name": "newIndex"
15170
15149
  }
15171
15150
  ],
15172
15151
  "description": "Resets all list items tabindex to -1 and sets the tabindex of the\nelement at the given index to 0, effectively setting the active\nelement. This is used when navigating the list via keyboard.",
@@ -18028,41 +18007,20 @@
18028
18007
  "module": "utils/mixins/MenuMixin.js"
18029
18008
  }
18030
18009
  },
18031
- {
18032
- "kind": "method",
18033
- "name": "setTabIndexOnMouseClick",
18034
- "privacy": "protected",
18035
- "return": {
18036
- "type": {
18037
- "text": "void"
18038
- }
18039
- },
18040
- "parameters": [
18041
- {
18042
- "name": "event",
18043
- "type": {
18044
- "text": "MouseEvent"
18045
- },
18046
- "description": "The mouse click event."
18047
- }
18048
- ],
18049
- "description": "Handles the mouse click event on the menu items.\nResets all the menu items tabindex to -1 and sets the tabindex of the\nelement at the given index to 0, effectively setting the active\nelement. This is used when clicking on the menu items.",
18050
- "inheritedFrom": {
18051
- "name": "MenuMixin",
18052
- "module": "utils/mixins/MenuMixin.js"
18053
- }
18054
- },
18055
18010
  {
18056
18011
  "kind": "method",
18057
18012
  "name": "resetTabIndexAndSetActiveTabIndex",
18058
- "privacy": "protected",
18013
+ "privacy": "private",
18059
18014
  "parameters": [
18060
18015
  {
18061
- "name": "newIndex",
18016
+ "name": "menuItems",
18062
18017
  "type": {
18063
- "text": "number"
18064
- },
18065
- "description": "The index of the new active element in the list."
18018
+ "text": "Array<HTMLElement>"
18019
+ }
18020
+ },
18021
+ {
18022
+ "description": "The index of the new active element in the list.",
18023
+ "name": "newIndex"
18066
18024
  }
18067
18025
  ],
18068
18026
  "description": "Resets all list items tabindex to -1 and sets the tabindex of the\nelement at the given index to 0, effectively setting the active\nelement. This is used when navigating the list via keyboard.",
@@ -19752,6 +19710,41 @@
19752
19710
  }
19753
19711
  ]
19754
19712
  },
19713
+ {
19714
+ "kind": "javascript-module",
19715
+ "path": "components/menusection/menusection.component.js",
19716
+ "declarations": [
19717
+ {
19718
+ "kind": "class",
19719
+ "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.",
19720
+ "name": "MenuSection",
19721
+ "slots": [
19722
+ {
19723
+ "description": "Default slot for inserting `menuitem`, `menuitemcheckbox`, or `menuitemradio`",
19724
+ "name": ""
19725
+ }
19726
+ ],
19727
+ "members": [],
19728
+ "superclass": {
19729
+ "name": "Component",
19730
+ "module": "/src/models"
19731
+ },
19732
+ "tagName": "mdc-menusection",
19733
+ "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 */",
19734
+ "customElement": true
19735
+ }
19736
+ ],
19737
+ "exports": [
19738
+ {
19739
+ "kind": "js",
19740
+ "name": "default",
19741
+ "declaration": {
19742
+ "name": "MenuSection",
19743
+ "module": "components/menusection/menusection.component.js"
19744
+ }
19745
+ }
19746
+ ]
19747
+ },
19755
19748
  {
19756
19749
  "kind": "javascript-module",
19757
19750
  "path": "components/optgroup/optgroup.component.js",
@@ -19890,41 +19883,6 @@
19890
19883
  }
19891
19884
  ]
19892
19885
  },
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
19886
  {
19929
19887
  "kind": "javascript-module",
19930
19888
  "path": "components/option/option.component.js",
@@ -23942,1418 +23900,1042 @@
23942
23900
  },
23943
23901
  {
23944
23902
  "kind": "javascript-module",
23945
- "path": "components/screenreaderannouncer/screenreaderannouncer.component.js",
23903
+ "path": "components/radiogroup/radiogroup.component.js",
23946
23904
  "declarations": [
23947
23905
  {
23948
23906
  "kind": "class",
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",
23907
+ "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.",
23908
+ "name": "RadioGroup",
23909
+ "cssProperties": [
23910
+ {
23911
+ "description": "color of the description text",
23912
+ "name": "--mdc-radiogroup-description-text-normal"
23913
+ }
23914
+ ],
23951
23915
  "members": [
23952
23916
  {
23953
23917
  "kind": "field",
23954
- "name": "announcement",
23918
+ "name": "name",
23955
23919
  "type": {
23956
23920
  "text": "string"
23957
23921
  },
23958
23922
  "default": "''",
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
23923
+ "description": "Name of the radio group.\nThey are used to group elements in a form together.",
23924
+ "attribute": "name"
23962
23925
  },
23963
23926
  {
23964
23927
  "kind": "field",
23965
- "name": "identity",
23928
+ "name": "dataAriaLabel",
23966
23929
  "type": {
23967
- "text": "string"
23930
+ "text": "string | null"
23968
23931
  },
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
23932
+ "default": "null",
23933
+ "description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
23934
+ "attribute": "data-aria-label",
23935
+ "reflects": true,
23936
+ "inheritedFrom": {
23937
+ "name": "DataAriaLabelMixin",
23938
+ "module": "utils/mixins/DataAriaLabelMixin.js"
23939
+ }
23973
23940
  },
23974
23941
  {
23975
23942
  "kind": "field",
23976
- "name": "dataAriaLive",
23943
+ "name": "disabled",
23977
23944
  "type": {
23978
- "text": "AriaLive"
23945
+ "text": "boolean | undefined"
23979
23946
  },
23980
- "description": "Aria live value for announcement.",
23981
- "default": "'polite'",
23982
- "attribute": "data-aria-live",
23983
- "reflects": true
23947
+ "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
23948
+ "default": "undefined",
23949
+ "attribute": "disabled",
23950
+ "reflects": true,
23951
+ "inheritedFrom": {
23952
+ "name": "FormfieldWrapper",
23953
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
23954
+ }
23984
23955
  },
23985
23956
  {
23986
23957
  "kind": "field",
23987
- "name": "delay",
23958
+ "name": "label",
23988
23959
  "type": {
23989
- "text": "number"
23960
+ "text": "string | undefined"
23990
23961
  },
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
23962
+ "description": "The label of the input field. It is linked to the input field using the `for` attribute.",
23963
+ "attribute": "label",
23964
+ "reflects": true,
23965
+ "inheritedFrom": {
23966
+ "name": "FormfieldWrapper",
23967
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
23968
+ }
23995
23969
  },
23996
23970
  {
23997
23971
  "kind": "field",
23998
- "name": "timeout",
23972
+ "name": "required",
23999
23973
  "type": {
24000
- "text": "number"
23974
+ "text": "boolean"
24001
23975
  },
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
24006
- },
24007
- {
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."
23976
+ "default": "false",
23977
+ "description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
23978
+ "attribute": "required",
23979
+ "reflects": true,
23980
+ "inheritedFrom": {
23981
+ "name": "FormfieldWrapper",
23982
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
23983
+ }
24041
23984
  },
24042
23985
  {
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",
23986
+ "kind": "field",
23987
+ "name": "id",
24058
23988
  "type": {
24059
23989
  "text": "string"
24060
23990
  },
24061
23991
  "default": "''",
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"
23992
+ "description": "The unique id of the input field. It is used to link the input field with the label.",
23993
+ "attribute": "id",
23994
+ "inheritedFrom": {
23995
+ "name": "FormfieldWrapper",
23996
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
23997
+ }
24064
23998
  },
24065
23999
  {
24066
- "name": "identity",
24000
+ "kind": "field",
24001
+ "name": "helpTextType",
24067
24002
  "type": {
24068
- "text": "string"
24003
+ "text": "ValidationType"
24069
24004
  },
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"
24005
+ "description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
24006
+ "attribute": "help-text-type",
24007
+ "reflects": true,
24008
+ "inheritedFrom": {
24009
+ "name": "FormfieldWrapper",
24010
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
24011
+ }
24073
24012
  },
24074
24013
  {
24075
- "name": "data-aria-live",
24014
+ "kind": "field",
24015
+ "name": "helpText",
24076
24016
  "type": {
24077
- "text": "AriaLive"
24017
+ "text": "string | undefined"
24078
24018
  },
24079
- "description": "Aria live value for announcement.",
24080
- "default": "'polite'",
24081
- "fieldName": "dataAriaLive"
24019
+ "description": "The help text that is displayed below the input field.",
24020
+ "attribute": "help-text",
24021
+ "reflects": true,
24022
+ "inheritedFrom": {
24023
+ "name": "FormfieldWrapper",
24024
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
24025
+ }
24082
24026
  },
24083
24027
  {
24084
- "name": "delay",
24085
- "type": {
24086
- "text": "number"
24028
+ "kind": "method",
24029
+ "name": "renderLabelElement",
24030
+ "privacy": "protected",
24031
+ "description": "creates the label element when the label property is set.\nid is used to link the label with the input field.",
24032
+ "return": {
24033
+ "type": {
24034
+ "text": ""
24035
+ }
24087
24036
  },
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"
24037
+ "inheritedFrom": {
24038
+ "name": "FormfieldWrapper",
24039
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
24040
+ }
24091
24041
  },
24092
24042
  {
24093
- "name": "timeout",
24094
- "type": {
24095
- "text": "number"
24043
+ "kind": "method",
24044
+ "name": "renderHelpTextIcon",
24045
+ "privacy": "protected",
24046
+ "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.",
24047
+ "return": {
24048
+ "type": {
24049
+ "text": ""
24050
+ }
24096
24051
  },
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",
24138
24052
  "inheritedFrom": {
24139
24053
  "name": "FormfieldWrapper",
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"
24054
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
24150
24055
  }
24151
24056
  },
24152
24057
  {
24153
24058
  "kind": "method",
24154
- "name": "handleKeyDown",
24059
+ "name": "renderHelpText",
24155
24060
  "privacy": "protected",
24156
- "parameters": [
24157
- {
24158
- "name": "event",
24159
- "type": {
24160
- "text": "KeyboardEvent"
24161
- },
24162
- "description": "Keyboard event"
24061
+ "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.",
24062
+ "return": {
24063
+ "type": {
24064
+ "text": ""
24163
24065
  }
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.",
24066
+ },
24166
24067
  "inheritedFrom": {
24167
- "name": "Input",
24168
- "module": "components/input/input.component.js"
24068
+ "name": "FormfieldWrapper",
24069
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
24169
24070
  }
24170
24071
  },
24171
24072
  {
24172
24073
  "kind": "method",
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."
24074
+ "name": "renderLabel",
24075
+ "privacy": "protected",
24076
+ "description": "renders the mdc-label-text container that contains the label and labelInfoToggleTip.",
24077
+ "return": {
24078
+ "type": {
24079
+ "text": ""
24080
+ }
24081
+ },
24082
+ "inheritedFrom": {
24083
+ "name": "FormfieldWrapper",
24084
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
24085
+ }
24176
24086
  },
24177
24087
  {
24178
24088
  "kind": "method",
24179
- "name": "clearInputText",
24089
+ "name": "renderHelperText",
24180
24090
  "privacy": "protected",
24181
- "description": "Clears the input field.",
24091
+ "description": "renders the mdc-help-text container that contains the helpertext icon and helpertext.",
24092
+ "return": {
24093
+ "type": {
24094
+ "text": ""
24095
+ }
24096
+ },
24182
24097
  "inheritedFrom": {
24183
- "name": "Input",
24184
- "module": "components/input/input.component.js"
24098
+ "name": "FormfieldWrapper",
24099
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
24185
24100
  }
24186
- },
24101
+ }
24102
+ ],
24103
+ "attributes": [
24187
24104
  {
24188
- "kind": "field",
24189
24105
  "name": "name",
24190
24106
  "type": {
24191
24107
  "text": "string"
24192
24108
  },
24193
24109
  "default": "''",
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,
24197
- "inheritedFrom": {
24198
- "name": "FormInternalsMixin",
24199
- "module": "utils/mixins/FormInternalsMixin.js"
24200
- }
24110
+ "description": "Name of the radio group.\nThey are used to group elements in a form together.",
24111
+ "fieldName": "name"
24201
24112
  },
24202
24113
  {
24203
- "kind": "field",
24204
- "name": "value",
24114
+ "name": "data-aria-label",
24205
24115
  "type": {
24206
- "text": "string"
24116
+ "text": "string | null"
24207
24117
  },
24208
- "default": "''",
24209
- "description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
24210
- "attribute": "value",
24211
- "reflects": true,
24118
+ "default": "null",
24119
+ "description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
24120
+ "fieldName": "dataAriaLabel",
24212
24121
  "inheritedFrom": {
24213
- "name": "FormInternalsMixin",
24214
- "module": "utils/mixins/FormInternalsMixin.js"
24122
+ "name": "DataAriaLabelMixin",
24123
+ "module": "src/utils/mixins/DataAriaLabelMixin.ts"
24215
24124
  }
24216
24125
  },
24217
24126
  {
24218
- "kind": "field",
24219
- "name": "validationMessage",
24127
+ "name": "disabled",
24220
24128
  "type": {
24221
- "text": "string | undefined"
24129
+ "text": "boolean | undefined"
24222
24130
  },
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,
24131
+ "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
24132
+ "default": "undefined",
24133
+ "fieldName": "disabled",
24226
24134
  "inheritedFrom": {
24227
- "name": "FormInternalsMixin",
24228
- "module": "utils/mixins/FormInternalsMixin.js"
24135
+ "name": "FormfieldWrapper",
24136
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
24229
24137
  }
24230
24138
  },
24231
24139
  {
24232
- "kind": "field",
24233
- "name": "validity",
24140
+ "name": "label",
24234
24141
  "type": {
24235
- "text": "ValidityState"
24142
+ "text": "string | undefined"
24236
24143
  },
24237
- "readonly": true,
24144
+ "description": "The label of the input field. It is linked to the input field using the `for` attribute.",
24145
+ "fieldName": "label",
24238
24146
  "inheritedFrom": {
24239
- "name": "FormInternalsMixin",
24240
- "module": "utils/mixins/FormInternalsMixin.js"
24147
+ "name": "FormfieldWrapper",
24148
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
24241
24149
  }
24242
24150
  },
24243
24151
  {
24244
- "kind": "field",
24245
- "name": "willValidate",
24246
- "readonly": true,
24152
+ "name": "required",
24153
+ "type": {
24154
+ "text": "boolean"
24155
+ },
24156
+ "default": "false",
24157
+ "description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
24158
+ "fieldName": "required",
24247
24159
  "inheritedFrom": {
24248
- "name": "FormInternalsMixin",
24249
- "module": "utils/mixins/FormInternalsMixin.js"
24160
+ "name": "FormfieldWrapper",
24161
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
24250
24162
  }
24251
24163
  },
24252
24164
  {
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
- }
24165
+ "name": "id",
24166
+ "type": {
24167
+ "text": "string"
24260
24168
  },
24169
+ "default": "''",
24170
+ "description": "The unique id of the input field. It is used to link the input field with the label.",
24171
+ "fieldName": "id",
24261
24172
  "inheritedFrom": {
24262
- "name": "FormInternalsMixin",
24263
- "module": "utils/mixins/FormInternalsMixin.js"
24173
+ "name": "FormfieldWrapper",
24174
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
24264
24175
  }
24265
24176
  },
24266
24177
  {
24267
- "kind": "method",
24268
- "name": "checkValidity",
24269
- "return": {
24270
- "type": {
24271
- "text": "boolean"
24272
- }
24178
+ "name": "help-text-type",
24179
+ "type": {
24180
+ "text": "ValidationType"
24273
24181
  },
24182
+ "description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
24183
+ "fieldName": "helpTextType",
24274
24184
  "inheritedFrom": {
24275
- "name": "FormInternalsMixin",
24276
- "module": "utils/mixins/FormInternalsMixin.js"
24185
+ "name": "FormfieldWrapper",
24186
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
24277
24187
  }
24278
24188
  },
24279
24189
  {
24280
- "kind": "method",
24281
- "name": "reportValidity",
24190
+ "name": "help-text",
24191
+ "type": {
24192
+ "text": "string | undefined"
24193
+ },
24194
+ "description": "The help text that is displayed below the input field.",
24195
+ "fieldName": "helpText",
24282
24196
  "inheritedFrom": {
24283
- "name": "FormInternalsMixin",
24284
- "module": "utils/mixins/FormInternalsMixin.js"
24197
+ "name": "FormfieldWrapper",
24198
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
24285
24199
  }
24286
- },
24200
+ }
24201
+ ],
24202
+ "superclass": {
24203
+ "name": "FormfieldGroup",
24204
+ "module": "/src/components/formfieldgroup"
24205
+ },
24206
+ "tagName": "mdc-radiogroup",
24207
+ "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 */",
24208
+ "customElement": true,
24209
+ "slots": [
24287
24210
  {
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,
24211
+ "description": "This is a default slot for checkbox or toggle components.",
24212
+ "name": "default",
24297
24213
  "inheritedFrom": {
24298
- "name": "DataAriaLabelMixin",
24299
- "module": "utils/mixins/DataAriaLabelMixin.js"
24214
+ "name": "FormfieldGroup",
24215
+ "module": "src/components/formfieldgroup/formfieldgroup.component.ts"
24300
24216
  }
24301
24217
  },
24218
+ {
24219
+ "description": "slot to add the label info icon",
24220
+ "name": "label-info",
24221
+ "inheritedFrom": {
24222
+ "name": "FormfieldWrapper",
24223
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
24224
+ }
24225
+ }
24226
+ ]
24227
+ }
24228
+ ],
24229
+ "exports": [
24230
+ {
24231
+ "kind": "js",
24232
+ "name": "default",
24233
+ "declaration": {
24234
+ "name": "RadioGroup",
24235
+ "module": "components/radiogroup/radiogroup.component.js"
24236
+ }
24237
+ }
24238
+ ]
24239
+ },
24240
+ {
24241
+ "kind": "javascript-module",
24242
+ "path": "components/screenreaderannouncer/screenreaderannouncer.component.js",
24243
+ "declarations": [
24244
+ {
24245
+ "kind": "class",
24246
+ "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/",
24247
+ "name": "ScreenreaderAnnouncer",
24248
+ "members": [
24302
24249
  {
24303
24250
  "kind": "field",
24304
- "name": "placeholder",
24251
+ "name": "announcement",
24305
24252
  "type": {
24306
24253
  "text": "string"
24307
24254
  },
24308
24255
  "default": "''",
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
- }
24256
+ "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.",
24257
+ "attribute": "announcement",
24258
+ "reflects": true
24315
24259
  },
24316
24260
  {
24317
24261
  "kind": "field",
24318
- "name": "readonly",
24262
+ "name": "identity",
24319
24263
  "type": {
24320
- "text": "boolean"
24264
+ "text": "string"
24321
24265
  },
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
- }
24266
+ "default": "''",
24267
+ "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.",
24268
+ "attribute": "identity",
24269
+ "reflects": true
24329
24270
  },
24330
24271
  {
24331
24272
  "kind": "field",
24332
- "name": "prefixText",
24273
+ "name": "dataAriaLive",
24333
24274
  "type": {
24334
- "text": "string | undefined"
24275
+ "text": "AriaLive"
24335
24276
  },
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
- }
24277
+ "description": "Aria live value for announcement.",
24278
+ "default": "'polite'",
24279
+ "attribute": "data-aria-live",
24280
+ "reflects": true
24342
24281
  },
24343
24282
  {
24344
24283
  "kind": "field",
24345
- "name": "leadingIcon",
24284
+ "name": "delay",
24346
24285
  "type": {
24347
- "text": "IconNames | undefined"
24286
+ "text": "number"
24348
24287
  },
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
- }
24288
+ "description": "Milliseconds to wait before adding the announcement to the identiy region in\nDOM, which will announce the message to the screen reader.",
24289
+ "default": "150",
24290
+ "attribute": "delay",
24291
+ "reflects": true
24355
24292
  },
24356
24293
  {
24357
24294
  "kind": "field",
24358
- "name": "trailingButton",
24295
+ "name": "timeout",
24359
24296
  "type": {
24360
- "text": "boolean"
24297
+ "text": "number"
24361
24298
  },
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
- }
24299
+ "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.",
24300
+ "default": "20_000",
24301
+ "attribute": "timeout",
24302
+ "reflects": true
24369
24303
  },
24370
24304
  {
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
- }
24305
+ "kind": "method",
24306
+ "name": "announce",
24307
+ "parameters": [
24308
+ {
24309
+ "name": "announcement",
24310
+ "type": {
24311
+ "text": "string"
24312
+ },
24313
+ "description": "The announcement to be made."
24314
+ },
24315
+ {
24316
+ "name": "delay",
24317
+ "type": {
24318
+ "text": "number"
24319
+ },
24320
+ "description": "The delay in milliseconds before announcing the message."
24321
+ },
24322
+ {
24323
+ "name": "timeout",
24324
+ "type": {
24325
+ "text": "number"
24326
+ },
24327
+ "description": "The timeout in milliseconds before removing the announcement."
24328
+ },
24329
+ {
24330
+ "name": "ariaLive",
24331
+ "type": {
24332
+ "text": "AriaLive"
24333
+ },
24334
+ "description": "The aria live value for the announcement."
24335
+ }
24336
+ ],
24337
+ "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."
24382
24338
  },
24383
24339
  {
24384
- "kind": "field",
24385
- "name": "minlength",
24340
+ "kind": "method",
24341
+ "name": "clearTimeOutsAndAnnouncements",
24342
+ "privacy": "private",
24343
+ "description": "Clears all timeouts and removes all announcements from the screen reader."
24344
+ },
24345
+ {
24346
+ "kind": "method",
24347
+ "name": "createAnnouncementAriaLiveRegion",
24348
+ "privacy": "private",
24349
+ "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`."
24350
+ }
24351
+ ],
24352
+ "attributes": [
24353
+ {
24354
+ "name": "announcement",
24386
24355
  "type": {
24387
- "text": "number | undefined"
24356
+ "text": "string"
24388
24357
  },
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
- }
24358
+ "default": "''",
24359
+ "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.",
24360
+ "fieldName": "announcement"
24395
24361
  },
24396
24362
  {
24397
- "kind": "field",
24398
- "name": "autocapitalize",
24363
+ "name": "identity",
24399
24364
  "type": {
24400
- "text": "AutoCapitalizeType"
24365
+ "text": "string"
24401
24366
  },
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
- }
24367
+ "default": "''",
24368
+ "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.",
24369
+ "fieldName": "identity"
24409
24370
  },
24410
24371
  {
24411
- "kind": "field",
24412
- "name": "autocomplete",
24372
+ "name": "data-aria-live",
24413
24373
  "type": {
24414
- "text": "AutoCompleteType"
24415
- },
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
- }
24423
- },
24424
- {
24425
- "kind": "field",
24426
- "name": "autofocus",
24427
- "type": {
24428
- "text": "boolean"
24429
- },
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
- }
24437
- },
24438
- {
24439
- "kind": "field",
24440
- "name": "dirname",
24441
- "type": {
24442
- "text": "string | undefined"
24443
- },
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
- }
24450
- },
24451
- {
24452
- "kind": "field",
24453
- "name": "pattern",
24454
- "type": {
24455
- "text": "string | undefined"
24456
- },
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
- }
24463
- },
24464
- {
24465
- "kind": "field",
24466
- "name": "list",
24467
- "type": {
24468
- "text": "string | undefined"
24469
- },
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
- }
24476
- },
24477
- {
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",
24486
- "inheritedFrom": {
24487
- "name": "Input",
24488
- "module": "components/input/input.component.js"
24489
- }
24490
- },
24491
- {
24492
- "kind": "field",
24493
- "name": "clearAriaLabel",
24494
- "type": {
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"
24503
- }
24504
- },
24505
- {
24506
- "kind": "method",
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",
24557
- "parameters": [
24558
- {
24559
- "name": "event",
24560
- "type": {
24561
- "text": "Event"
24562
- },
24563
- "description": "Event which contains information about the value change."
24564
- }
24565
- ],
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
- }
24374
+ "text": "AriaLive"
24769
24375
  },
24770
- "inheritedFrom": {
24771
- "name": "FormfieldWrapper",
24772
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
24773
- }
24376
+ "description": "Aria live value for announcement.",
24377
+ "default": "'polite'",
24378
+ "fieldName": "dataAriaLive"
24774
24379
  },
24775
24380
  {
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
- }
24381
+ "name": "delay",
24382
+ "type": {
24383
+ "text": "number"
24784
24384
  },
24785
- "inheritedFrom": {
24786
- "name": "FormfieldWrapper",
24787
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
24788
- }
24385
+ "description": "Milliseconds to wait before adding the announcement to the identiy region in\nDOM, which will announce the message to the screen reader.",
24386
+ "default": "150",
24387
+ "fieldName": "delay"
24789
24388
  },
24790
24389
  {
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
- }
24390
+ "name": "timeout",
24391
+ "type": {
24392
+ "text": "number"
24799
24393
  },
24800
- "inheritedFrom": {
24801
- "name": "FormfieldWrapper",
24802
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
24803
- }
24394
+ "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.",
24395
+ "default": "20_000",
24396
+ "fieldName": "timeout"
24804
24397
  }
24805
24398
  ],
24806
24399
  "superclass": {
24807
- "name": "Input",
24808
- "module": "/src/components/input/input.component"
24400
+ "name": "Component",
24401
+ "module": "/src/models"
24809
24402
  },
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
- },
24403
+ "tagName": "mdc-screenreaderannouncer",
24404
+ "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 */",
24405
+ "customElement": true
24406
+ }
24407
+ ],
24408
+ "exports": [
24409
+ {
24410
+ "kind": "js",
24411
+ "name": "default",
24412
+ "declaration": {
24413
+ "name": "ScreenreaderAnnouncer",
24414
+ "module": "components/screenreaderannouncer/screenreaderannouncer.component.js"
24415
+ }
24416
+ }
24417
+ ]
24418
+ },
24419
+ {
24420
+ "kind": "javascript-module",
24421
+ "path": "components/searchfield/searchfield.component.js",
24422
+ "declarations": [
24423
+ {
24424
+ "kind": "class",
24425
+ "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.",
24426
+ "name": "Searchfield",
24427
+ "slots": [
24903
24428
  {
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
- }
24429
+ "description": "Slot for input chips",
24430
+ "name": "filters"
24914
24431
  },
24915
24432
  {
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",
24433
+ "description": "slot to add the label info icon",
24434
+ "name": "label-info",
24923
24435
  "inheritedFrom": {
24924
- "name": "Input",
24925
- "module": "src/components/input/input.component.ts"
24436
+ "name": "FormfieldWrapper",
24437
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
24926
24438
  }
24927
- },
24439
+ }
24440
+ ],
24441
+ "members": [
24928
24442
  {
24929
- "name": "maxlength",
24443
+ "kind": "field",
24444
+ "name": "inputChips",
24930
24445
  "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"
24446
+ "text": "Array<HTMLElement> | undefined"
24938
24447
  }
24939
24448
  },
24940
24449
  {
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",
24450
+ "kind": "method",
24451
+ "name": "handleKeyDown",
24452
+ "privacy": "protected",
24453
+ "parameters": [
24454
+ {
24455
+ "name": "event",
24456
+ "type": {
24457
+ "text": "KeyboardEvent"
24458
+ },
24459
+ "description": "Keyboard event"
24460
+ }
24461
+ ],
24462
+ "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.",
24947
24463
  "inheritedFrom": {
24948
24464
  "name": "Input",
24949
- "module": "src/components/input/input.component.ts"
24465
+ "module": "components/input/input.component.js"
24950
24466
  }
24951
24467
  },
24952
24468
  {
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
- }
24469
+ "kind": "method",
24470
+ "name": "renderInputChips",
24471
+ "privacy": "private",
24472
+ "description": "This method is used to render the input chips inside filters slot.\nIt will remove any elements that are not input chips."
24964
24473
  },
24965
24474
  {
24966
- "name": "autocomplete",
24967
- "type": {
24968
- "text": "AutoCompleteType"
24969
- },
24970
- "description": "The autocomplete attribute of the input field.",
24971
- "default": "'off'",
24972
- "fieldName": "autocomplete",
24475
+ "kind": "method",
24476
+ "name": "clearInputText",
24477
+ "privacy": "protected",
24478
+ "description": "Clears the input field.",
24973
24479
  "inheritedFrom": {
24974
24480
  "name": "Input",
24975
- "module": "src/components/input/input.component.ts"
24481
+ "module": "components/input/input.component.js"
24976
24482
  }
24977
24483
  },
24978
24484
  {
24979
- "name": "autofocus",
24485
+ "kind": "field",
24486
+ "name": "name",
24980
24487
  "type": {
24981
- "text": "boolean"
24488
+ "text": "string"
24982
24489
  },
24983
- "default": "false",
24984
- "description": "If true, the input field is focused when the component is rendered.",
24985
- "fieldName": "autofocus",
24490
+ "default": "''",
24491
+ "description": "Indicates the name of the component group.\nThey are used to group elements in a form together.",
24492
+ "attribute": "name",
24493
+ "reflects": true,
24986
24494
  "inheritedFrom": {
24987
- "name": "Input",
24988
- "module": "src/components/input/input.component.ts"
24495
+ "name": "FormInternalsMixin",
24496
+ "module": "utils/mixins/FormInternalsMixin.js"
24989
24497
  }
24990
24498
  },
24991
24499
  {
24992
- "name": "dirname",
24500
+ "kind": "field",
24501
+ "name": "value",
24993
24502
  "type": {
24994
- "text": "string | undefined"
24503
+ "text": "string"
24995
24504
  },
24996
- "description": "Specifies the name of the directionality of text for submission purposes (e.g., \"rtl\" for right-to-left).",
24997
- "fieldName": "dirname",
24505
+ "default": "''",
24506
+ "description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
24507
+ "attribute": "value",
24508
+ "reflects": true,
24998
24509
  "inheritedFrom": {
24999
- "name": "Input",
25000
- "module": "src/components/input/input.component.ts"
24510
+ "name": "FormInternalsMixin",
24511
+ "module": "utils/mixins/FormInternalsMixin.js"
25001
24512
  }
25002
24513
  },
25003
24514
  {
25004
- "name": "pattern",
24515
+ "kind": "field",
24516
+ "name": "validationMessage",
25005
24517
  "type": {
25006
24518
  "text": "string | undefined"
25007
24519
  },
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",
24520
+ "description": "Custom validation message that will override the default message and displayed when the input is invalid.",
24521
+ "attribute": "validation-message",
24522
+ "reflects": true,
25010
24523
  "inheritedFrom": {
25011
- "name": "Input",
25012
- "module": "src/components/input/input.component.ts"
24524
+ "name": "FormInternalsMixin",
24525
+ "module": "utils/mixins/FormInternalsMixin.js"
25013
24526
  }
25014
24527
  },
25015
24528
  {
25016
- "name": "list",
24529
+ "kind": "field",
24530
+ "name": "validity",
25017
24531
  "type": {
25018
- "text": "string | undefined"
24532
+ "text": "ValidityState"
25019
24533
  },
25020
- "description": "The list attribute of the input field.\nIdentifies a list of pre-defined options to suggest to the user.",
25021
- "fieldName": "list",
24534
+ "readonly": true,
25022
24535
  "inheritedFrom": {
25023
- "name": "Input",
25024
- "module": "src/components/input/input.component.ts"
24536
+ "name": "FormInternalsMixin",
24537
+ "module": "utils/mixins/FormInternalsMixin.js"
25025
24538
  }
25026
24539
  },
25027
24540
  {
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",
24541
+ "kind": "field",
24542
+ "name": "willValidate",
24543
+ "readonly": true,
25035
24544
  "inheritedFrom": {
25036
- "name": "Input",
25037
- "module": "src/components/input/input.component.ts"
24545
+ "name": "FormInternalsMixin",
24546
+ "module": "utils/mixins/FormInternalsMixin.js"
25038
24547
  }
25039
24548
  },
25040
24549
  {
25041
- "name": "clear-aria-label",
25042
- "type": {
25043
- "text": "string"
24550
+ "kind": "method",
24551
+ "name": "setValidity",
24552
+ "description": "Sets the validity of the input field based on the input field's validity.",
24553
+ "return": {
24554
+ "type": {
24555
+ "text": ""
24556
+ }
25044
24557
  },
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",
25048
24558
  "inheritedFrom": {
25049
- "name": "Input",
25050
- "module": "src/components/input/input.component.ts"
24559
+ "name": "FormInternalsMixin",
24560
+ "module": "utils/mixins/FormInternalsMixin.js"
25051
24561
  }
25052
24562
  },
25053
24563
  {
25054
- "name": "disabled",
25055
- "type": {
25056
- "text": "boolean | undefined"
24564
+ "kind": "method",
24565
+ "name": "checkValidity",
24566
+ "return": {
24567
+ "type": {
24568
+ "text": "boolean"
24569
+ }
25057
24570
  },
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",
25061
24571
  "inheritedFrom": {
25062
- "name": "FormfieldWrapper",
25063
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
24572
+ "name": "FormInternalsMixin",
24573
+ "module": "utils/mixins/FormInternalsMixin.js"
25064
24574
  }
25065
24575
  },
25066
24576
  {
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",
24577
+ "kind": "method",
24578
+ "name": "reportValidity",
25073
24579
  "inheritedFrom": {
25074
- "name": "FormfieldWrapper",
25075
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
24580
+ "name": "FormInternalsMixin",
24581
+ "module": "utils/mixins/FormInternalsMixin.js"
25076
24582
  }
25077
24583
  },
25078
24584
  {
25079
- "name": "required",
24585
+ "kind": "field",
24586
+ "name": "dataAriaLabel",
25080
24587
  "type": {
25081
- "text": "boolean"
24588
+ "text": "string | null"
25082
24589
  },
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",
24590
+ "default": "null",
24591
+ "description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
24592
+ "attribute": "data-aria-label",
24593
+ "reflects": true,
25086
24594
  "inheritedFrom": {
25087
- "name": "FormfieldWrapper",
25088
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
24595
+ "name": "DataAriaLabelMixin",
24596
+ "module": "utils/mixins/DataAriaLabelMixin.js"
25089
24597
  }
25090
24598
  },
25091
24599
  {
25092
- "name": "id",
24600
+ "kind": "field",
24601
+ "name": "placeholder",
25093
24602
  "type": {
25094
24603
  "text": "string"
25095
24604
  },
25096
24605
  "default": "''",
25097
- "description": "The unique id of the input field. It is used to link the input field with the label.",
25098
- "fieldName": "id",
24606
+ "description": "The placeholder text that is displayed when the input field is empty.",
24607
+ "attribute": "placeholder",
25099
24608
  "inheritedFrom": {
25100
- "name": "FormfieldWrapper",
25101
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
24609
+ "name": "Input",
24610
+ "module": "components/input/input.component.js"
25102
24611
  }
25103
24612
  },
25104
24613
  {
25105
- "name": "help-text-type",
24614
+ "kind": "field",
24615
+ "name": "readonly",
25106
24616
  "type": {
25107
- "text": "ValidationType"
24617
+ "text": "boolean"
25108
24618
  },
25109
- "description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
25110
- "fieldName": "helpTextType",
24619
+ "default": "false",
24620
+ "description": "readonly attribute of the input field. If true, the input field is read-only.",
24621
+ "attribute": "readonly",
25111
24622
  "inheritedFrom": {
25112
- "name": "FormfieldWrapper",
25113
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
24623
+ "name": "Input",
24624
+ "module": "components/input/input.component.js"
25114
24625
  }
25115
24626
  },
25116
24627
  {
25117
- "name": "help-text",
24628
+ "kind": "field",
24629
+ "name": "prefixText",
25118
24630
  "type": {
25119
24631
  "text": "string | undefined"
25120
24632
  },
25121
- "description": "The help text that is displayed below the input field.",
25122
- "fieldName": "helpText",
25123
- "inheritedFrom": {
25124
- "name": "FormfieldWrapper",
25125
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
25126
- }
25127
- }
25128
- ],
25129
- "cssProperties": [
25130
- {
25131
- "description": "Border color for the input container when disabled",
25132
- "name": "--mdc-input-disabled-border-color",
24633
+ "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.",
24634
+ "attribute": "prefix-text",
25133
24635
  "inheritedFrom": {
25134
24636
  "name": "Input",
25135
- "module": "src/components/input/input.component.ts"
24637
+ "module": "components/input/input.component.js"
25136
24638
  }
25137
24639
  },
25138
24640
  {
25139
- "description": "Text color for the input field when disabled",
25140
- "name": "--mdc-input-disabled-text-color",
24641
+ "kind": "field",
24642
+ "name": "leadingIcon",
24643
+ "type": {
24644
+ "text": "IconNames | undefined"
24645
+ },
24646
+ "description": "The leading icon that is displayed before the input field.",
24647
+ "attribute": "leading-icon",
25141
24648
  "inheritedFrom": {
25142
24649
  "name": "Input",
25143
- "module": "src/components/input/input.component.ts"
24650
+ "module": "components/input/input.component.js"
25144
24651
  }
25145
24652
  },
25146
24653
  {
25147
- "description": "Background color for the input field when disabled",
25148
- "name": "--mdc-input-disabled-background-color",
24654
+ "kind": "field",
24655
+ "name": "trailingButton",
24656
+ "type": {
24657
+ "text": "boolean"
24658
+ },
24659
+ "default": "false",
24660
+ "description": "The trailing button when set to true, shows a clear button that clears the input field.",
24661
+ "attribute": "trailing-button",
25149
24662
  "inheritedFrom": {
25150
24663
  "name": "Input",
25151
- "module": "src/components/input/input.component.ts"
24664
+ "module": "components/input/input.component.js"
25152
24665
  }
25153
24666
  },
25154
24667
  {
25155
- "description": "Border color for the input container",
25156
- "name": "--mdc-input-border-color",
24668
+ "kind": "field",
24669
+ "name": "maxlength",
24670
+ "type": {
24671
+ "text": "number | undefined"
24672
+ },
24673
+ "description": "The maximum number of characters that the input field can accept.",
24674
+ "attribute": "maxlength",
25157
24675
  "inheritedFrom": {
25158
24676
  "name": "Input",
25159
- "module": "src/components/input/input.component.ts"
24677
+ "module": "components/input/input.component.js"
25160
24678
  }
25161
24679
  },
25162
24680
  {
25163
- "description": "Text color for the input field",
25164
- "name": "--mdc-input-text-color",
24681
+ "kind": "field",
24682
+ "name": "minlength",
24683
+ "type": {
24684
+ "text": "number | undefined"
24685
+ },
24686
+ "description": "The minimum number of characters that the input field can accept.",
24687
+ "attribute": "minlength",
25165
24688
  "inheritedFrom": {
25166
24689
  "name": "Input",
25167
- "module": "src/components/input/input.component.ts"
24690
+ "module": "components/input/input.component.js"
25168
24691
  }
25169
24692
  },
25170
24693
  {
25171
- "description": "Background color for the input field",
25172
- "name": "--mdc-input-background-color",
24694
+ "kind": "field",
24695
+ "name": "autocapitalize",
24696
+ "type": {
24697
+ "text": "AutoCapitalizeType"
24698
+ },
24699
+ "description": "The autocapitalize attribute of the input field.",
24700
+ "default": "'off'",
24701
+ "attribute": "autocapitalize",
25173
24702
  "inheritedFrom": {
25174
24703
  "name": "Input",
25175
- "module": "src/components/input/input.component.ts"
24704
+ "module": "components/input/input.component.js"
25176
24705
  }
25177
24706
  },
25178
24707
  {
25179
- "description": "Background color for the selected text",
25180
- "name": "--mdc-input-selection-background-color",
24708
+ "kind": "field",
24709
+ "name": "autocomplete",
24710
+ "type": {
24711
+ "text": "AutoCompleteType"
24712
+ },
24713
+ "description": "The autocomplete attribute of the input field.",
24714
+ "default": "'off'",
24715
+ "attribute": "autocomplete",
25181
24716
  "inheritedFrom": {
25182
24717
  "name": "Input",
25183
- "module": "src/components/input/input.component.ts"
24718
+ "module": "components/input/input.component.js"
25184
24719
  }
25185
24720
  },
25186
24721
  {
25187
- "description": "Text color for the selected text",
25188
- "name": "--mdc-input-selection-text-color",
24722
+ "kind": "field",
24723
+ "name": "autofocus",
24724
+ "type": {
24725
+ "text": "boolean"
24726
+ },
24727
+ "default": "false",
24728
+ "description": "If true, the input field is focused when the component is rendered.",
24729
+ "attribute": "autofocus",
25189
24730
  "inheritedFrom": {
25190
24731
  "name": "Input",
25191
- "module": "src/components/input/input.component.ts"
24732
+ "module": "components/input/input.component.js"
25192
24733
  }
25193
24734
  },
25194
24735
  {
25195
- "description": "Text color for the help text",
25196
- "name": "--mdc-input-support-text-color",
24736
+ "kind": "field",
24737
+ "name": "dirname",
24738
+ "type": {
24739
+ "text": "string | undefined"
24740
+ },
24741
+ "description": "Specifies the name of the directionality of text for submission purposes (e.g., \"rtl\" for right-to-left).",
24742
+ "attribute": "dirname",
25197
24743
  "inheritedFrom": {
25198
24744
  "name": "Input",
25199
- "module": "src/components/input/input.component.ts"
24745
+ "module": "components/input/input.component.js"
25200
24746
  }
25201
24747
  },
25202
24748
  {
25203
- "description": "Background color for the input field when hovered",
25204
- "name": "--mdc-input-hover-background-color",
24749
+ "kind": "field",
24750
+ "name": "pattern",
24751
+ "type": {
24752
+ "text": "string | undefined"
24753
+ },
24754
+ "description": "The pattern attribute of the input field.\nSpecifies a regular expression that the input value must match for validation purposes.",
24755
+ "attribute": "pattern",
25205
24756
  "inheritedFrom": {
25206
24757
  "name": "Input",
25207
- "module": "src/components/input/input.component.ts"
24758
+ "module": "components/input/input.component.js"
25208
24759
  }
25209
24760
  },
25210
24761
  {
25211
- "description": "Background color for the input field when focused",
25212
- "name": "--mdc-input-focused-background-color",
24762
+ "kind": "field",
24763
+ "name": "list",
24764
+ "type": {
24765
+ "text": "string | undefined"
24766
+ },
24767
+ "description": "The list attribute of the input field.\nIdentifies a list of pre-defined options to suggest to the user.",
24768
+ "attribute": "list",
25213
24769
  "inheritedFrom": {
25214
24770
  "name": "Input",
25215
- "module": "src/components/input/input.component.ts"
24771
+ "module": "components/input/input.component.js"
25216
24772
  }
25217
24773
  },
25218
24774
  {
25219
- "description": "Border color for the input container when focused",
25220
- "name": "--mdc-input-focused-border-color",
24775
+ "kind": "field",
24776
+ "name": "size",
24777
+ "type": {
24778
+ "text": "number | undefined | undefined"
24779
+ },
24780
+ "description": "The size attribute of the input field.\nSpecifies the width of the input field.",
24781
+ "default": "undefined",
24782
+ "attribute": "size",
25221
24783
  "inheritedFrom": {
25222
24784
  "name": "Input",
25223
- "module": "src/components/input/input.component.ts"
24785
+ "module": "components/input/input.component.js"
25224
24786
  }
25225
24787
  },
25226
24788
  {
25227
- "description": "Border color for the input container when error",
25228
- "name": "--mdc-input-error-border-color",
24789
+ "kind": "field",
24790
+ "name": "clearAriaLabel",
24791
+ "type": {
24792
+ "text": "string"
24793
+ },
24794
+ "default": "''",
24795
+ "description": "Aria label for the trailing button. If trailing button is set to true, this label is used for the clear button.",
24796
+ "attribute": "clear-aria-label",
25229
24797
  "inheritedFrom": {
25230
24798
  "name": "Input",
25231
- "module": "src/components/input/input.component.ts"
24799
+ "module": "components/input/input.component.js"
25232
24800
  }
25233
24801
  },
25234
24802
  {
25235
- "description": "Border color for the input container when warning",
25236
- "name": "--mdc-input-warning-border-color",
24803
+ "kind": "method",
24804
+ "name": "handleValueChange",
24805
+ "description": "Handles the value change of the input field.\nSets the form value and updates the validity of the input field.",
24806
+ "return": {
24807
+ "type": {
24808
+ "text": ""
24809
+ }
24810
+ },
25237
24811
  "inheritedFrom": {
25238
24812
  "name": "Input",
25239
- "module": "src/components/input/input.component.ts"
24813
+ "module": "components/input/input.component.js"
25240
24814
  }
25241
24815
  },
25242
24816
  {
25243
- "description": "Border color for the input container when success",
25244
- "name": "--mdc-input-success-border-color",
24817
+ "kind": "method",
24818
+ "name": "setInputValidity",
24819
+ "privacy": "private",
25245
24820
  "inheritedFrom": {
25246
24821
  "name": "Input",
25247
- "module": "src/components/input/input.component.ts"
24822
+ "module": "components/input/input.component.js"
25248
24823
  }
25249
24824
  },
25250
24825
  {
25251
- "description": "Border color for the input container when primary",
25252
- "name": "--mdc-input-primary-border-color",
24826
+ "kind": "method",
24827
+ "name": "updateValue",
24828
+ "privacy": "private",
24829
+ "description": "Updates the value of the input field.\nSets the form value.",
24830
+ "return": {
24831
+ "type": {
24832
+ "text": ""
24833
+ }
24834
+ },
25253
24835
  "inheritedFrom": {
25254
24836
  "name": "Input",
25255
- "module": "src/components/input/input.component.ts"
24837
+ "module": "components/input/input.component.js"
25256
24838
  }
25257
- }
25258
- ],
25259
- "events": [
24839
+ },
25260
24840
  {
25261
- "type": {
25262
- "text": "EventConstructor"
25263
- },
24841
+ "kind": "method",
24842
+ "name": "onInput",
24843
+ "privacy": "private",
24844
+ "description": "Handles the input event of the input field.\nUpdates the value and sets the validity of the input field.",
25264
24845
  "inheritedFrom": {
25265
24846
  "name": "Input",
25266
- "module": "src/components/input/input.component.ts"
24847
+ "module": "components/input/input.component.js"
25267
24848
  }
25268
24849
  },
25269
24850
  {
25270
- "description": "(React: onInput) This event is dispatched when the value of the input field changes (every press).",
25271
- "name": "input",
25272
- "reactName": "onInput",
24851
+ "kind": "method",
24852
+ "name": "onChange",
24853
+ "privacy": "private",
24854
+ "parameters": [
24855
+ {
24856
+ "name": "event",
24857
+ "type": {
24858
+ "text": "Event"
24859
+ },
24860
+ "description": "Event which contains information about the value change."
24861
+ }
24862
+ ],
24863
+ "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",
25273
24864
  "inheritedFrom": {
25274
24865
  "name": "Input",
25275
- "module": "src/components/input/input.component.ts"
24866
+ "module": "components/input/input.component.js"
25276
24867
  }
25277
24868
  },
25278
24869
  {
25279
- "description": "(React: onChange) This event is dispatched when the value of the input field changes (on blur).",
25280
- "name": "change",
25281
- "reactName": "onChange",
24870
+ "kind": "method",
24871
+ "name": "renderLeadingIcon",
24872
+ "privacy": "protected",
24873
+ "description": "Renders the leading icon before the input field.\nIf the leading icon is not set, it will not be displayed.",
24874
+ "return": {
24875
+ "type": {
24876
+ "text": ""
24877
+ }
24878
+ },
25282
24879
  "inheritedFrom": {
25283
24880
  "name": "Input",
25284
- "module": "src/components/input/input.component.ts"
24881
+ "module": "components/input/input.component.js"
25285
24882
  }
25286
24883
  },
25287
24884
  {
25288
- "description": "(React: onFocus) This event is dispatched when the input receives focus.",
25289
- "name": "focus",
25290
- "reactName": "onFocus",
24885
+ "kind": "method",
24886
+ "name": "renderPrefixText",
24887
+ "privacy": "protected",
24888
+ "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.",
24889
+ "return": {
24890
+ "type": {
24891
+ "text": ""
24892
+ }
24893
+ },
25291
24894
  "inheritedFrom": {
25292
24895
  "name": "Input",
25293
- "module": "src/components/input/input.component.ts"
24896
+ "module": "components/input/input.component.js"
25294
24897
  }
25295
24898
  },
25296
24899
  {
25297
- "description": "(React: onBlur) This event is dispatched when the input loses focus.",
25298
- "name": "blur",
25299
- "reactName": "onBlur",
24900
+ "kind": "method",
24901
+ "name": "renderTrailingButton",
24902
+ "privacy": "protected",
24903
+ "parameters": [
24904
+ {
24905
+ "name": "show",
24906
+ "default": "false"
24907
+ }
24908
+ ],
24909
+ "description": "Renders the trailing button to clear the input field if the trailingButton is set to true.",
24910
+ "return": {
24911
+ "type": {
24912
+ "text": ""
24913
+ }
24914
+ },
25300
24915
  "inheritedFrom": {
25301
24916
  "name": "Input",
25302
- "module": "src/components/input/input.component.ts"
24917
+ "module": "components/input/input.component.js"
25303
24918
  }
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
24919
  },
25344
24920
  {
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,
24921
+ "kind": "method",
24922
+ "name": "renderInputElement",
24923
+ "privacy": "protected",
24924
+ "parameters": [
24925
+ {
24926
+ "name": "type",
24927
+ "type": {
24928
+ "text": "InputType"
24929
+ }
24930
+ },
24931
+ {
24932
+ "name": "hidePlaceholder",
24933
+ "default": "false"
24934
+ }
24935
+ ],
25354
24936
  "inheritedFrom": {
25355
- "name": "DataAriaLabelMixin",
25356
- "module": "utils/mixins/DataAriaLabelMixin.js"
24937
+ "name": "Input",
24938
+ "module": "components/input/input.component.js"
25357
24939
  }
25358
24940
  },
25359
24941
  {
@@ -25518,6 +25100,13 @@
25518
25100
  }
25519
25101
  }
25520
25102
  ],
25103
+ "superclass": {
25104
+ "name": "Input",
25105
+ "module": "/src/components/input/input.component"
25106
+ },
25107
+ "tagName": "mdc-searchfield",
25108
+ "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 */",
25109
+ "customElement": true,
25521
25110
  "attributes": [
25522
25111
  {
25523
25112
  "name": "name",
@@ -25525,8 +25114,37 @@
25525
25114
  "text": "string"
25526
25115
  },
25527
25116
  "default": "''",
25528
- "description": "Name of the radio group.\nThey are used to group elements in a form together.",
25529
- "fieldName": "name"
25117
+ "description": "Indicates the name of the component group.\nThey are used to group elements in a form together.",
25118
+ "fieldName": "name",
25119
+ "inheritedFrom": {
25120
+ "name": "FormInternalsMixin",
25121
+ "module": "src/utils/mixins/FormInternalsMixin.ts"
25122
+ }
25123
+ },
25124
+ {
25125
+ "name": "value",
25126
+ "type": {
25127
+ "text": "string"
25128
+ },
25129
+ "default": "''",
25130
+ "description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
25131
+ "fieldName": "value",
25132
+ "inheritedFrom": {
25133
+ "name": "FormInternalsMixin",
25134
+ "module": "src/utils/mixins/FormInternalsMixin.ts"
25135
+ }
25136
+ },
25137
+ {
25138
+ "name": "validation-message",
25139
+ "type": {
25140
+ "text": "string | undefined"
25141
+ },
25142
+ "description": "Custom validation message that will override the default message and displayed when the input is invalid.",
25143
+ "fieldName": "validationMessage",
25144
+ "inheritedFrom": {
25145
+ "name": "FormInternalsMixin",
25146
+ "module": "src/utils/mixins/FormInternalsMixin.ts"
25147
+ }
25530
25148
  },
25531
25149
  {
25532
25150
  "name": "data-aria-label",
@@ -25537,8 +25155,196 @@
25537
25155
  "description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
25538
25156
  "fieldName": "dataAriaLabel",
25539
25157
  "inheritedFrom": {
25540
- "name": "DataAriaLabelMixin",
25541
- "module": "src/utils/mixins/DataAriaLabelMixin.ts"
25158
+ "name": "DataAriaLabelMixin",
25159
+ "module": "src/utils/mixins/DataAriaLabelMixin.ts"
25160
+ }
25161
+ },
25162
+ {
25163
+ "name": "placeholder",
25164
+ "type": {
25165
+ "text": "string"
25166
+ },
25167
+ "default": "''",
25168
+ "description": "The placeholder text that is displayed when the input field is empty.",
25169
+ "fieldName": "placeholder",
25170
+ "inheritedFrom": {
25171
+ "name": "Input",
25172
+ "module": "src/components/input/input.component.ts"
25173
+ }
25174
+ },
25175
+ {
25176
+ "name": "readonly",
25177
+ "type": {
25178
+ "text": "boolean"
25179
+ },
25180
+ "default": "false",
25181
+ "description": "readonly attribute of the input field. If true, the input field is read-only.",
25182
+ "fieldName": "readonly",
25183
+ "inheritedFrom": {
25184
+ "name": "Input",
25185
+ "module": "src/components/input/input.component.ts"
25186
+ }
25187
+ },
25188
+ {
25189
+ "name": "prefix-text",
25190
+ "type": {
25191
+ "text": "string | undefined"
25192
+ },
25193
+ "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.",
25194
+ "fieldName": "prefixText",
25195
+ "inheritedFrom": {
25196
+ "name": "Input",
25197
+ "module": "src/components/input/input.component.ts"
25198
+ }
25199
+ },
25200
+ {
25201
+ "name": "leading-icon",
25202
+ "type": {
25203
+ "text": "IconNames | undefined"
25204
+ },
25205
+ "description": "The leading icon that is displayed before the input field.",
25206
+ "fieldName": "leadingIcon",
25207
+ "inheritedFrom": {
25208
+ "name": "Input",
25209
+ "module": "src/components/input/input.component.ts"
25210
+ }
25211
+ },
25212
+ {
25213
+ "name": "trailing-button",
25214
+ "type": {
25215
+ "text": "boolean"
25216
+ },
25217
+ "default": "false",
25218
+ "description": "The trailing button when set to true, shows a clear button that clears the input field.",
25219
+ "fieldName": "trailingButton",
25220
+ "inheritedFrom": {
25221
+ "name": "Input",
25222
+ "module": "src/components/input/input.component.ts"
25223
+ }
25224
+ },
25225
+ {
25226
+ "name": "maxlength",
25227
+ "type": {
25228
+ "text": "number | undefined"
25229
+ },
25230
+ "description": "The maximum number of characters that the input field can accept.",
25231
+ "fieldName": "maxlength",
25232
+ "inheritedFrom": {
25233
+ "name": "Input",
25234
+ "module": "src/components/input/input.component.ts"
25235
+ }
25236
+ },
25237
+ {
25238
+ "name": "minlength",
25239
+ "type": {
25240
+ "text": "number | undefined"
25241
+ },
25242
+ "description": "The minimum number of characters that the input field can accept.",
25243
+ "fieldName": "minlength",
25244
+ "inheritedFrom": {
25245
+ "name": "Input",
25246
+ "module": "src/components/input/input.component.ts"
25247
+ }
25248
+ },
25249
+ {
25250
+ "name": "autocapitalize",
25251
+ "type": {
25252
+ "text": "AutoCapitalizeType"
25253
+ },
25254
+ "description": "The autocapitalize attribute of the input field.",
25255
+ "default": "'off'",
25256
+ "fieldName": "autocapitalize",
25257
+ "inheritedFrom": {
25258
+ "name": "Input",
25259
+ "module": "src/components/input/input.component.ts"
25260
+ }
25261
+ },
25262
+ {
25263
+ "name": "autocomplete",
25264
+ "type": {
25265
+ "text": "AutoCompleteType"
25266
+ },
25267
+ "description": "The autocomplete attribute of the input field.",
25268
+ "default": "'off'",
25269
+ "fieldName": "autocomplete",
25270
+ "inheritedFrom": {
25271
+ "name": "Input",
25272
+ "module": "src/components/input/input.component.ts"
25273
+ }
25274
+ },
25275
+ {
25276
+ "name": "autofocus",
25277
+ "type": {
25278
+ "text": "boolean"
25279
+ },
25280
+ "default": "false",
25281
+ "description": "If true, the input field is focused when the component is rendered.",
25282
+ "fieldName": "autofocus",
25283
+ "inheritedFrom": {
25284
+ "name": "Input",
25285
+ "module": "src/components/input/input.component.ts"
25286
+ }
25287
+ },
25288
+ {
25289
+ "name": "dirname",
25290
+ "type": {
25291
+ "text": "string | undefined"
25292
+ },
25293
+ "description": "Specifies the name of the directionality of text for submission purposes (e.g., \"rtl\" for right-to-left).",
25294
+ "fieldName": "dirname",
25295
+ "inheritedFrom": {
25296
+ "name": "Input",
25297
+ "module": "src/components/input/input.component.ts"
25298
+ }
25299
+ },
25300
+ {
25301
+ "name": "pattern",
25302
+ "type": {
25303
+ "text": "string | undefined"
25304
+ },
25305
+ "description": "The pattern attribute of the input field.\nSpecifies a regular expression that the input value must match for validation purposes.",
25306
+ "fieldName": "pattern",
25307
+ "inheritedFrom": {
25308
+ "name": "Input",
25309
+ "module": "src/components/input/input.component.ts"
25310
+ }
25311
+ },
25312
+ {
25313
+ "name": "list",
25314
+ "type": {
25315
+ "text": "string | undefined"
25316
+ },
25317
+ "description": "The list attribute of the input field.\nIdentifies a list of pre-defined options to suggest to the user.",
25318
+ "fieldName": "list",
25319
+ "inheritedFrom": {
25320
+ "name": "Input",
25321
+ "module": "src/components/input/input.component.ts"
25322
+ }
25323
+ },
25324
+ {
25325
+ "name": "size",
25326
+ "type": {
25327
+ "text": "number | undefined | undefined"
25328
+ },
25329
+ "description": "The size attribute of the input field.\nSpecifies the width of the input field.",
25330
+ "default": "undefined",
25331
+ "fieldName": "size",
25332
+ "inheritedFrom": {
25333
+ "name": "Input",
25334
+ "module": "src/components/input/input.component.ts"
25335
+ }
25336
+ },
25337
+ {
25338
+ "name": "clear-aria-label",
25339
+ "type": {
25340
+ "text": "string"
25341
+ },
25342
+ "default": "''",
25343
+ "description": "Aria label for the trailing button. If trailing button is set to true, this label is used for the clear button.",
25344
+ "fieldName": "clearAriaLabel",
25345
+ "inheritedFrom": {
25346
+ "name": "Input",
25347
+ "module": "src/components/input/input.component.ts"
25542
25348
  }
25543
25349
  },
25544
25350
  {
@@ -25617,28 +25423,180 @@
25617
25423
  }
25618
25424
  }
25619
25425
  ],
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": [
25426
+ "cssProperties": [
25628
25427
  {
25629
- "description": "This is a default slot for checkbox or toggle components.",
25630
- "name": "default",
25428
+ "description": "Border color for the input container when disabled",
25429
+ "name": "--mdc-input-disabled-border-color",
25631
25430
  "inheritedFrom": {
25632
- "name": "FormfieldGroup",
25633
- "module": "src/components/formfieldgroup/formfieldgroup.component.ts"
25431
+ "name": "Input",
25432
+ "module": "src/components/input/input.component.ts"
25634
25433
  }
25635
25434
  },
25636
25435
  {
25637
- "description": "slot to add the label info icon",
25638
- "name": "label-info",
25436
+ "description": "Text color for the input field when disabled",
25437
+ "name": "--mdc-input-disabled-text-color",
25639
25438
  "inheritedFrom": {
25640
- "name": "FormfieldWrapper",
25641
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
25439
+ "name": "Input",
25440
+ "module": "src/components/input/input.component.ts"
25441
+ }
25442
+ },
25443
+ {
25444
+ "description": "Background color for the input field when disabled",
25445
+ "name": "--mdc-input-disabled-background-color",
25446
+ "inheritedFrom": {
25447
+ "name": "Input",
25448
+ "module": "src/components/input/input.component.ts"
25449
+ }
25450
+ },
25451
+ {
25452
+ "description": "Border color for the input container",
25453
+ "name": "--mdc-input-border-color",
25454
+ "inheritedFrom": {
25455
+ "name": "Input",
25456
+ "module": "src/components/input/input.component.ts"
25457
+ }
25458
+ },
25459
+ {
25460
+ "description": "Text color for the input field",
25461
+ "name": "--mdc-input-text-color",
25462
+ "inheritedFrom": {
25463
+ "name": "Input",
25464
+ "module": "src/components/input/input.component.ts"
25465
+ }
25466
+ },
25467
+ {
25468
+ "description": "Background color for the input field",
25469
+ "name": "--mdc-input-background-color",
25470
+ "inheritedFrom": {
25471
+ "name": "Input",
25472
+ "module": "src/components/input/input.component.ts"
25473
+ }
25474
+ },
25475
+ {
25476
+ "description": "Background color for the selected text",
25477
+ "name": "--mdc-input-selection-background-color",
25478
+ "inheritedFrom": {
25479
+ "name": "Input",
25480
+ "module": "src/components/input/input.component.ts"
25481
+ }
25482
+ },
25483
+ {
25484
+ "description": "Text color for the selected text",
25485
+ "name": "--mdc-input-selection-text-color",
25486
+ "inheritedFrom": {
25487
+ "name": "Input",
25488
+ "module": "src/components/input/input.component.ts"
25489
+ }
25490
+ },
25491
+ {
25492
+ "description": "Text color for the help text",
25493
+ "name": "--mdc-input-support-text-color",
25494
+ "inheritedFrom": {
25495
+ "name": "Input",
25496
+ "module": "src/components/input/input.component.ts"
25497
+ }
25498
+ },
25499
+ {
25500
+ "description": "Background color for the input field when hovered",
25501
+ "name": "--mdc-input-hover-background-color",
25502
+ "inheritedFrom": {
25503
+ "name": "Input",
25504
+ "module": "src/components/input/input.component.ts"
25505
+ }
25506
+ },
25507
+ {
25508
+ "description": "Background color for the input field when focused",
25509
+ "name": "--mdc-input-focused-background-color",
25510
+ "inheritedFrom": {
25511
+ "name": "Input",
25512
+ "module": "src/components/input/input.component.ts"
25513
+ }
25514
+ },
25515
+ {
25516
+ "description": "Border color for the input container when focused",
25517
+ "name": "--mdc-input-focused-border-color",
25518
+ "inheritedFrom": {
25519
+ "name": "Input",
25520
+ "module": "src/components/input/input.component.ts"
25521
+ }
25522
+ },
25523
+ {
25524
+ "description": "Border color for the input container when error",
25525
+ "name": "--mdc-input-error-border-color",
25526
+ "inheritedFrom": {
25527
+ "name": "Input",
25528
+ "module": "src/components/input/input.component.ts"
25529
+ }
25530
+ },
25531
+ {
25532
+ "description": "Border color for the input container when warning",
25533
+ "name": "--mdc-input-warning-border-color",
25534
+ "inheritedFrom": {
25535
+ "name": "Input",
25536
+ "module": "src/components/input/input.component.ts"
25537
+ }
25538
+ },
25539
+ {
25540
+ "description": "Border color for the input container when success",
25541
+ "name": "--mdc-input-success-border-color",
25542
+ "inheritedFrom": {
25543
+ "name": "Input",
25544
+ "module": "src/components/input/input.component.ts"
25545
+ }
25546
+ },
25547
+ {
25548
+ "description": "Border color for the input container when primary",
25549
+ "name": "--mdc-input-primary-border-color",
25550
+ "inheritedFrom": {
25551
+ "name": "Input",
25552
+ "module": "src/components/input/input.component.ts"
25553
+ }
25554
+ }
25555
+ ],
25556
+ "events": [
25557
+ {
25558
+ "type": {
25559
+ "text": "EventConstructor"
25560
+ },
25561
+ "inheritedFrom": {
25562
+ "name": "Input",
25563
+ "module": "src/components/input/input.component.ts"
25564
+ }
25565
+ },
25566
+ {
25567
+ "description": "(React: onInput) This event is dispatched when the value of the input field changes (every press).",
25568
+ "name": "input",
25569
+ "reactName": "onInput",
25570
+ "inheritedFrom": {
25571
+ "name": "Input",
25572
+ "module": "src/components/input/input.component.ts"
25573
+ }
25574
+ },
25575
+ {
25576
+ "description": "(React: onChange) This event is dispatched when the value of the input field changes (on blur).",
25577
+ "name": "change",
25578
+ "reactName": "onChange",
25579
+ "inheritedFrom": {
25580
+ "name": "Input",
25581
+ "module": "src/components/input/input.component.ts"
25582
+ }
25583
+ },
25584
+ {
25585
+ "description": "(React: onFocus) This event is dispatched when the input receives focus.",
25586
+ "name": "focus",
25587
+ "reactName": "onFocus",
25588
+ "inheritedFrom": {
25589
+ "name": "Input",
25590
+ "module": "src/components/input/input.component.ts"
25591
+ }
25592
+ },
25593
+ {
25594
+ "description": "(React: onBlur) This event is dispatched when the input loses focus.",
25595
+ "name": "blur",
25596
+ "reactName": "onBlur",
25597
+ "inheritedFrom": {
25598
+ "name": "Input",
25599
+ "module": "src/components/input/input.component.ts"
25642
25600
  }
25643
25601
  }
25644
25602
  ]
@@ -25649,8 +25607,8 @@
25649
25607
  "kind": "js",
25650
25608
  "name": "default",
25651
25609
  "declaration": {
25652
- "name": "RadioGroup",
25653
- "module": "components/radiogroup/radiogroup.component.js"
25610
+ "name": "Searchfield",
25611
+ "module": "components/searchfield/searchfield.component.js"
25654
25612
  }
25655
25613
  }
25656
25614
  ]
@@ -35042,42 +35000,6 @@
35042
35000
  }
35043
35001
  ]
35044
35002
  },
35045
- {
35046
- "kind": "method",
35047
- "name": "resetTabIndexAndSetActiveTabIndex",
35048
- "privacy": "protected",
35049
- "return": {
35050
- "type": {
35051
- "text": "void"
35052
- }
35053
- },
35054
- "parameters": [
35055
- {
35056
- "name": "newIndex",
35057
- "type": {
35058
- "text": "number"
35059
- }
35060
- }
35061
- ]
35062
- },
35063
- {
35064
- "kind": "method",
35065
- "name": "setTabIndexOnMouseClick",
35066
- "privacy": "protected",
35067
- "return": {
35068
- "type": {
35069
- "text": "void"
35070
- }
35071
- },
35072
- "parameters": [
35073
- {
35074
- "name": "event",
35075
- "type": {
35076
- "text": "MouseEvent"
35077
- }
35078
- }
35079
- ]
35080
- },
35081
35003
  {
35082
35004
  "kind": "method",
35083
35005
  "name": "updatePopoverPlacementBasedOnOrientation",
@@ -35517,37 +35439,20 @@
35517
35439
  ],
35518
35440
  "description": "Checks if the given menu item is a valid menu item."
35519
35441
  },
35520
- {
35521
- "kind": "method",
35522
- "name": "setTabIndexOnMouseClick",
35523
- "privacy": "protected",
35524
- "return": {
35525
- "type": {
35526
- "text": "void"
35527
- }
35528
- },
35529
- "parameters": [
35530
- {
35531
- "name": "event",
35532
- "type": {
35533
- "text": "MouseEvent"
35534
- },
35535
- "description": "The mouse click event."
35536
- }
35537
- ],
35538
- "description": "Handles the mouse click event on the menu items.\nResets all the menu items tabindex to -1 and sets the tabindex of the\nelement at the given index to 0, effectively setting the active\nelement. This is used when clicking on the menu items."
35539
- },
35540
35442
  {
35541
35443
  "kind": "method",
35542
35444
  "name": "resetTabIndexAndSetActiveTabIndex",
35543
- "privacy": "protected",
35445
+ "privacy": "private",
35544
35446
  "parameters": [
35545
35447
  {
35546
- "name": "newIndex",
35448
+ "name": "menuItems",
35547
35449
  "type": {
35548
- "text": "number"
35549
- },
35550
- "description": "The index of the new active element in the list."
35450
+ "text": "Array<HTMLElement>"
35451
+ }
35452
+ },
35453
+ {
35454
+ "description": "The index of the new active element in the list.",
35455
+ "name": "newIndex"
35551
35456
  }
35552
35457
  ],
35553
35458
  "description": "Resets all list items tabindex to -1 and sets the tabindex of the\nelement at the given index to 0, effectively setting the active\nelement. This is used when navigating the list via keyboard."