@momentum-design/components 0.76.1 → 0.76.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/browser/index.js +117 -117
- package/dist/browser/index.js.map +2 -2
- package/dist/components/checkbox/checkbox.component.d.ts +1 -1
- package/dist/components/checkbox/checkbox.component.js +3 -3
- package/dist/components/formfieldwrapper/formfieldwrapper.component.d.ts +4 -5
- package/dist/components/formfieldwrapper/formfieldwrapper.component.js +11 -15
- package/dist/components/formfieldwrapper/formfieldwrapper.styles.js +4 -0
- package/dist/components/input/input.component.js +2 -2
- package/dist/components/progressspinner/progressspinner.component.js +1 -1
- package/dist/components/radio/radio.component.js +3 -3
- package/dist/components/radio/radio.styles.js +1 -1
- package/dist/components/radiogroup/radiogroup.component.js +2 -2
- package/dist/components/searchfield/searchfield.component.js +1 -1
- package/dist/components/select/select.component.d.ts +5 -2
- package/dist/components/select/select.component.js +7 -4
- package/dist/components/textarea/textarea.component.d.ts +1 -1
- package/dist/components/textarea/textarea.component.js +3 -3
- package/dist/components/toggle/toggle.component.d.ts +3 -1
- package/dist/components/toggle/toggle.component.js +5 -3
- package/dist/custom-elements.json +1429 -1515
- package/dist/react/index.d.ts +3 -3
- package/dist/react/index.js +3 -3
- package/dist/react/textarea/index.d.ts +1 -1
- package/dist/react/textarea/index.js +1 -1
- package/package.json +1 -1
@@ -2147,138 +2147,6 @@
|
|
2147
2147
|
}
|
2148
2148
|
]
|
2149
2149
|
},
|
2150
|
-
{
|
2151
|
-
"kind": "javascript-module",
|
2152
|
-
"path": "components/buttongroup/buttongroup.component.js",
|
2153
|
-
"declarations": [
|
2154
|
-
{
|
2155
|
-
"kind": "class",
|
2156
|
-
"description": "buttongroup component, is a styled wrapper for multiple buttons.\nIt can support icon buttons, combination of icon and pill buttons, and text buttons.\nThey are available in horizontal and vertical orientation.",
|
2157
|
-
"name": "ButtonGroup",
|
2158
|
-
"cssProperties": [
|
2159
|
-
{
|
2160
|
-
"description": "The border radius of the buttongroup",
|
2161
|
-
"name": "--mdc-buttongroup-border-radius"
|
2162
|
-
},
|
2163
|
-
{
|
2164
|
-
"description": "The border color of the buttongroup",
|
2165
|
-
"name": "--mdc-buttongroup-border-color"
|
2166
|
-
},
|
2167
|
-
{
|
2168
|
-
"description": "The color of the divider between buttons within the buttongroup",
|
2169
|
-
"name": "--mdc-buttongroup-divider-color"
|
2170
|
-
}
|
2171
|
-
],
|
2172
|
-
"slots": [
|
2173
|
-
{
|
2174
|
-
"description": "This is a default/unnamed slot, which contains the buttons",
|
2175
|
-
"name": "default"
|
2176
|
-
}
|
2177
|
-
],
|
2178
|
-
"members": [
|
2179
|
-
{
|
2180
|
-
"kind": "field",
|
2181
|
-
"name": "orientation",
|
2182
|
-
"type": {
|
2183
|
-
"text": "ButtonGroupOrientation"
|
2184
|
-
},
|
2185
|
-
"description": "Orientation of the buttongroup.",
|
2186
|
-
"default": "'horizontal'",
|
2187
|
-
"attribute": "orientation",
|
2188
|
-
"reflects": true
|
2189
|
-
},
|
2190
|
-
{
|
2191
|
-
"kind": "field",
|
2192
|
-
"name": "variant",
|
2193
|
-
"type": {
|
2194
|
-
"text": "ButtonGroupVariant"
|
2195
|
-
},
|
2196
|
-
"description": "Variant of the buttons within the buttongroup.",
|
2197
|
-
"default": "'primary'",
|
2198
|
-
"attribute": "variant",
|
2199
|
-
"reflects": true
|
2200
|
-
},
|
2201
|
-
{
|
2202
|
-
"kind": "field",
|
2203
|
-
"name": "size",
|
2204
|
-
"type": {
|
2205
|
-
"text": "ButtonGroupSize"
|
2206
|
-
},
|
2207
|
-
"description": "Size of the buttons within the buttongroup.",
|
2208
|
-
"default": "'28'",
|
2209
|
-
"attribute": "size",
|
2210
|
-
"reflects": true
|
2211
|
-
},
|
2212
|
-
{
|
2213
|
-
"kind": "field",
|
2214
|
-
"name": "compact",
|
2215
|
-
"type": {
|
2216
|
-
"text": "boolean"
|
2217
|
-
},
|
2218
|
-
"default": "false",
|
2219
|
-
"description": "When this is true, the buttons within the buttongroup will be compact.\ni.e. Irrespective of the size of the buttons, they will have a height of 24px.",
|
2220
|
-
"attribute": "compact",
|
2221
|
-
"reflects": true
|
2222
|
-
}
|
2223
|
-
],
|
2224
|
-
"attributes": [
|
2225
|
-
{
|
2226
|
-
"name": "orientation",
|
2227
|
-
"type": {
|
2228
|
-
"text": "ButtonGroupOrientation"
|
2229
|
-
},
|
2230
|
-
"description": "Orientation of the buttongroup.",
|
2231
|
-
"default": "'horizontal'",
|
2232
|
-
"fieldName": "orientation"
|
2233
|
-
},
|
2234
|
-
{
|
2235
|
-
"name": "variant",
|
2236
|
-
"type": {
|
2237
|
-
"text": "ButtonGroupVariant"
|
2238
|
-
},
|
2239
|
-
"description": "Variant of the buttons within the buttongroup.",
|
2240
|
-
"default": "'primary'",
|
2241
|
-
"fieldName": "variant"
|
2242
|
-
},
|
2243
|
-
{
|
2244
|
-
"name": "size",
|
2245
|
-
"type": {
|
2246
|
-
"text": "ButtonGroupSize"
|
2247
|
-
},
|
2248
|
-
"description": "Size of the buttons within the buttongroup.",
|
2249
|
-
"default": "'28'",
|
2250
|
-
"fieldName": "size"
|
2251
|
-
},
|
2252
|
-
{
|
2253
|
-
"name": "compact",
|
2254
|
-
"type": {
|
2255
|
-
"text": "boolean"
|
2256
|
-
},
|
2257
|
-
"default": "false",
|
2258
|
-
"description": "When this is true, the buttons within the buttongroup will be compact.\ni.e. Irrespective of the size of the buttons, they will have a height of 24px.",
|
2259
|
-
"fieldName": "compact"
|
2260
|
-
}
|
2261
|
-
],
|
2262
|
-
"superclass": {
|
2263
|
-
"name": "Component",
|
2264
|
-
"module": "/src/models"
|
2265
|
-
},
|
2266
|
-
"tagName": "mdc-buttongroup",
|
2267
|
-
"jsDoc": "/**\n * buttongroup component, is a styled wrapper for multiple buttons.\n * It can support icon buttons, combination of icon and pill buttons, and text buttons.\n * They are available in horizontal and vertical orientation.\n *\n * @tagname mdc-buttongroup\n *\n * @slot default - This is a default/unnamed slot, which contains the buttons\n *\n * @cssproperty --mdc-buttongroup-border-radius - The border radius of the buttongroup\n * @cssproperty --mdc-buttongroup-border-color - The border color of the buttongroup\n * @cssproperty --mdc-buttongroup-divider-color - The color of the divider between buttons within the buttongroup\n */",
|
2268
|
-
"customElement": true
|
2269
|
-
}
|
2270
|
-
],
|
2271
|
-
"exports": [
|
2272
|
-
{
|
2273
|
-
"kind": "js",
|
2274
|
-
"name": "default",
|
2275
|
-
"declaration": {
|
2276
|
-
"name": "ButtonGroup",
|
2277
|
-
"module": "components/buttongroup/buttongroup.component.js"
|
2278
|
-
}
|
2279
|
-
}
|
2280
|
-
]
|
2281
|
-
},
|
2282
2150
|
{
|
2283
2151
|
"kind": "javascript-module",
|
2284
2152
|
"path": "components/button/button.component.js",
|
@@ -2948,107 +2816,239 @@
|
|
2948
2816
|
},
|
2949
2817
|
{
|
2950
2818
|
"kind": "javascript-module",
|
2951
|
-
"path": "components/
|
2819
|
+
"path": "components/buttongroup/buttongroup.component.js",
|
2952
2820
|
"declarations": [
|
2953
2821
|
{
|
2954
2822
|
"kind": "class",
|
2955
|
-
"description": "
|
2956
|
-
"name": "
|
2823
|
+
"description": "buttongroup component, is a styled wrapper for multiple buttons.\nIt can support icon buttons, combination of icon and pill buttons, and text buttons.\nThey are available in horizontal and vertical orientation.",
|
2824
|
+
"name": "ButtonGroup",
|
2825
|
+
"cssProperties": [
|
2826
|
+
{
|
2827
|
+
"description": "The border radius of the buttongroup",
|
2828
|
+
"name": "--mdc-buttongroup-border-radius"
|
2829
|
+
},
|
2830
|
+
{
|
2831
|
+
"description": "The border color of the buttongroup",
|
2832
|
+
"name": "--mdc-buttongroup-border-color"
|
2833
|
+
},
|
2834
|
+
{
|
2835
|
+
"description": "The color of the divider between buttons within the buttongroup",
|
2836
|
+
"name": "--mdc-buttongroup-divider-color"
|
2837
|
+
}
|
2838
|
+
],
|
2839
|
+
"slots": [
|
2840
|
+
{
|
2841
|
+
"description": "This is a default/unnamed slot, which contains the buttons",
|
2842
|
+
"name": "default"
|
2843
|
+
}
|
2844
|
+
],
|
2957
2845
|
"members": [
|
2958
2846
|
{
|
2959
2847
|
"kind": "field",
|
2960
|
-
"name": "
|
2848
|
+
"name": "orientation",
|
2961
2849
|
"type": {
|
2962
|
-
"text": "
|
2850
|
+
"text": "ButtonGroupOrientation"
|
2963
2851
|
},
|
2964
|
-
"description": "
|
2965
|
-
"default": "
|
2966
|
-
"attribute": "
|
2852
|
+
"description": "Orientation of the buttongroup.",
|
2853
|
+
"default": "'horizontal'",
|
2854
|
+
"attribute": "orientation",
|
2967
2855
|
"reflects": true
|
2968
2856
|
},
|
2969
2857
|
{
|
2970
2858
|
"kind": "field",
|
2971
|
-
"name": "
|
2859
|
+
"name": "variant",
|
2972
2860
|
"type": {
|
2973
|
-
"text": "
|
2861
|
+
"text": "ButtonGroupVariant"
|
2974
2862
|
},
|
2975
|
-
"description": "
|
2976
|
-
"default": "
|
2977
|
-
"attribute": "
|
2863
|
+
"description": "Variant of the buttons within the buttongroup.",
|
2864
|
+
"default": "'primary'",
|
2865
|
+
"attribute": "variant",
|
2978
2866
|
"reflects": true
|
2979
2867
|
},
|
2980
|
-
{
|
2981
|
-
"kind": "method",
|
2982
|
-
"name": "setSoftDisabled",
|
2983
|
-
"privacy": "private",
|
2984
|
-
"parameters": [
|
2985
|
-
{
|
2986
|
-
"name": "element",
|
2987
|
-
"type": {
|
2988
|
-
"text": "HTMLElement"
|
2989
|
-
},
|
2990
|
-
"description": "The buttonlink element."
|
2991
|
-
},
|
2992
|
-
{
|
2993
|
-
"name": "softDisabled",
|
2994
|
-
"optional": true,
|
2995
|
-
"type": {
|
2996
|
-
"text": "boolean"
|
2997
|
-
},
|
2998
|
-
"description": "The soft-disabled state."
|
2999
|
-
}
|
3000
|
-
],
|
3001
|
-
"description": "Sets the soft-disabled attribute for the buttonlink.\nWhen soft-disabled, the buttonlink looks to be disabled but remains focusable and clickable.\nAlso sets/removes aria-disabled attribute."
|
3002
|
-
},
|
3003
2868
|
{
|
3004
2869
|
"kind": "field",
|
3005
|
-
"name": "
|
2870
|
+
"name": "size",
|
3006
2871
|
"type": {
|
3007
|
-
"text": "
|
2872
|
+
"text": "ButtonGroupSize"
|
3008
2873
|
},
|
3009
|
-
"description": "
|
3010
|
-
"
|
3011
|
-
"
|
3012
|
-
"
|
3013
|
-
"name": "ButtonComponentMixin",
|
3014
|
-
"module": "utils/mixins/ButtonComponentMixin.js"
|
3015
|
-
}
|
2874
|
+
"description": "Size of the buttons within the buttongroup.",
|
2875
|
+
"default": "'28'",
|
2876
|
+
"attribute": "size",
|
2877
|
+
"reflects": true
|
3016
2878
|
},
|
3017
2879
|
{
|
3018
2880
|
"kind": "field",
|
3019
|
-
"name": "
|
2881
|
+
"name": "compact",
|
3020
2882
|
"type": {
|
3021
|
-
"text": "
|
2883
|
+
"text": "boolean"
|
3022
2884
|
},
|
3023
|
-
"
|
3024
|
-
"
|
3025
|
-
"
|
3026
|
-
"
|
3027
|
-
|
3028
|
-
|
3029
|
-
|
3030
|
-
},
|
2885
|
+
"default": "false",
|
2886
|
+
"description": "When this is true, the buttons within the buttongroup will be compact.\ni.e. Irrespective of the size of the buttons, they will have a height of 24px.",
|
2887
|
+
"attribute": "compact",
|
2888
|
+
"reflects": true
|
2889
|
+
}
|
2890
|
+
],
|
2891
|
+
"attributes": [
|
3031
2892
|
{
|
3032
|
-
"
|
3033
|
-
"name": "variant",
|
2893
|
+
"name": "orientation",
|
3034
2894
|
"type": {
|
3035
|
-
"text": "
|
2895
|
+
"text": "ButtonGroupOrientation"
|
3036
2896
|
},
|
3037
|
-
"description": "
|
3038
|
-
"default": "
|
3039
|
-
"
|
3040
|
-
"inheritedFrom": {
|
3041
|
-
"name": "ButtonComponentMixin",
|
3042
|
-
"module": "utils/mixins/ButtonComponentMixin.js"
|
3043
|
-
}
|
2897
|
+
"description": "Orientation of the buttongroup.",
|
2898
|
+
"default": "'horizontal'",
|
2899
|
+
"fieldName": "orientation"
|
3044
2900
|
},
|
3045
2901
|
{
|
3046
|
-
"
|
3047
|
-
"name": "color",
|
2902
|
+
"name": "variant",
|
3048
2903
|
"type": {
|
3049
|
-
"text": "
|
2904
|
+
"text": "ButtonGroupVariant"
|
3050
2905
|
},
|
3051
|
-
"description": "
|
2906
|
+
"description": "Variant of the buttons within the buttongroup.",
|
2907
|
+
"default": "'primary'",
|
2908
|
+
"fieldName": "variant"
|
2909
|
+
},
|
2910
|
+
{
|
2911
|
+
"name": "size",
|
2912
|
+
"type": {
|
2913
|
+
"text": "ButtonGroupSize"
|
2914
|
+
},
|
2915
|
+
"description": "Size of the buttons within the buttongroup.",
|
2916
|
+
"default": "'28'",
|
2917
|
+
"fieldName": "size"
|
2918
|
+
},
|
2919
|
+
{
|
2920
|
+
"name": "compact",
|
2921
|
+
"type": {
|
2922
|
+
"text": "boolean"
|
2923
|
+
},
|
2924
|
+
"default": "false",
|
2925
|
+
"description": "When this is true, the buttons within the buttongroup will be compact.\ni.e. Irrespective of the size of the buttons, they will have a height of 24px.",
|
2926
|
+
"fieldName": "compact"
|
2927
|
+
}
|
2928
|
+
],
|
2929
|
+
"superclass": {
|
2930
|
+
"name": "Component",
|
2931
|
+
"module": "/src/models"
|
2932
|
+
},
|
2933
|
+
"tagName": "mdc-buttongroup",
|
2934
|
+
"jsDoc": "/**\n * buttongroup component, is a styled wrapper for multiple buttons.\n * It can support icon buttons, combination of icon and pill buttons, and text buttons.\n * They are available in horizontal and vertical orientation.\n *\n * @tagname mdc-buttongroup\n *\n * @slot default - This is a default/unnamed slot, which contains the buttons\n *\n * @cssproperty --mdc-buttongroup-border-radius - The border radius of the buttongroup\n * @cssproperty --mdc-buttongroup-border-color - The border color of the buttongroup\n * @cssproperty --mdc-buttongroup-divider-color - The color of the divider between buttons within the buttongroup\n */",
|
2935
|
+
"customElement": true
|
2936
|
+
}
|
2937
|
+
],
|
2938
|
+
"exports": [
|
2939
|
+
{
|
2940
|
+
"kind": "js",
|
2941
|
+
"name": "default",
|
2942
|
+
"declaration": {
|
2943
|
+
"name": "ButtonGroup",
|
2944
|
+
"module": "components/buttongroup/buttongroup.component.js"
|
2945
|
+
}
|
2946
|
+
}
|
2947
|
+
]
|
2948
|
+
},
|
2949
|
+
{
|
2950
|
+
"kind": "javascript-module",
|
2951
|
+
"path": "components/buttonlink/buttonlink.component.js",
|
2952
|
+
"declarations": [
|
2953
|
+
{
|
2954
|
+
"kind": "class",
|
2955
|
+
"description": "`mdc-buttonlink` combines the functional behavior of `mdc-linksimple` with the visual and structural\nfeatures of `mdc-button`. This includes support for variants, sizing, and optional\nprefix and postfix icons via slots.\n\n### Features:\n- Behaves like an link while visually resembling a button.\n- Supports slots for `prefix-icon` and `postfix-icon`.\n- Customizable size, color, and variant through attributes.\n- Inherits accessibility and keyboard interaction support from `mdc-linksimple`.",
|
2956
|
+
"name": "ButtonLink",
|
2957
|
+
"members": [
|
2958
|
+
{
|
2959
|
+
"kind": "field",
|
2960
|
+
"name": "size",
|
2961
|
+
"type": {
|
2962
|
+
"text": "PillButtonSize | IconButtonSize"
|
2963
|
+
},
|
2964
|
+
"description": "ButtonLink sizing is based on the buttonlink type.\n - **Pill buttonlink**: 40, 32, 28, 24.\n - **Icon buttonlink**: 64, 52, 40, 32, 28, 24.\n - Tertiary icon buttonlink can also be 20.",
|
2965
|
+
"default": "32",
|
2966
|
+
"attribute": "size",
|
2967
|
+
"reflects": true
|
2968
|
+
},
|
2969
|
+
{
|
2970
|
+
"kind": "field",
|
2971
|
+
"name": "softDisabled",
|
2972
|
+
"type": {
|
2973
|
+
"text": "boolean | undefined"
|
2974
|
+
},
|
2975
|
+
"description": "Indicates whether the buttonlink is soft disabled.\nWhen set to `true`, the buttonlink appears visually disabled but still allows\nfocus, click, and keyboard actions to be passed through.\n\n**Important:** When using soft disabled, consumers must ensure that\nthe buttonlink behaves like a disabled buttonlink, allowing only focus and\npreventing any interactions (clicks or keyboard actions) from triggering unintended actions.",
|
2976
|
+
"default": "undefined",
|
2977
|
+
"attribute": "soft-disabled",
|
2978
|
+
"reflects": true
|
2979
|
+
},
|
2980
|
+
{
|
2981
|
+
"kind": "method",
|
2982
|
+
"name": "setSoftDisabled",
|
2983
|
+
"privacy": "private",
|
2984
|
+
"parameters": [
|
2985
|
+
{
|
2986
|
+
"name": "element",
|
2987
|
+
"type": {
|
2988
|
+
"text": "HTMLElement"
|
2989
|
+
},
|
2990
|
+
"description": "The buttonlink element."
|
2991
|
+
},
|
2992
|
+
{
|
2993
|
+
"name": "softDisabled",
|
2994
|
+
"optional": true,
|
2995
|
+
"type": {
|
2996
|
+
"text": "boolean"
|
2997
|
+
},
|
2998
|
+
"description": "The soft-disabled state."
|
2999
|
+
}
|
3000
|
+
],
|
3001
|
+
"description": "Sets the soft-disabled attribute for the buttonlink.\nWhen soft-disabled, the buttonlink looks to be disabled but remains focusable and clickable.\nAlso sets/removes aria-disabled attribute."
|
3002
|
+
},
|
3003
|
+
{
|
3004
|
+
"kind": "field",
|
3005
|
+
"name": "prefixIcon",
|
3006
|
+
"type": {
|
3007
|
+
"text": "IconNames | undefined"
|
3008
|
+
},
|
3009
|
+
"description": "The name of the icon to display as a prefix.\nThe icon is displayed on the left side of the button.",
|
3010
|
+
"attribute": "prefix-icon",
|
3011
|
+
"reflects": true,
|
3012
|
+
"inheritedFrom": {
|
3013
|
+
"name": "ButtonComponentMixin",
|
3014
|
+
"module": "utils/mixins/ButtonComponentMixin.js"
|
3015
|
+
}
|
3016
|
+
},
|
3017
|
+
{
|
3018
|
+
"kind": "field",
|
3019
|
+
"name": "postfixIcon",
|
3020
|
+
"type": {
|
3021
|
+
"text": "IconNames | undefined"
|
3022
|
+
},
|
3023
|
+
"description": "The name of the icon to display as a postfix.\nThe icon is displayed on the right side of the button.",
|
3024
|
+
"attribute": "postfix-icon",
|
3025
|
+
"reflects": true,
|
3026
|
+
"inheritedFrom": {
|
3027
|
+
"name": "ButtonComponentMixin",
|
3028
|
+
"module": "utils/mixins/ButtonComponentMixin.js"
|
3029
|
+
}
|
3030
|
+
},
|
3031
|
+
{
|
3032
|
+
"kind": "field",
|
3033
|
+
"name": "variant",
|
3034
|
+
"type": {
|
3035
|
+
"text": "ButtonVariant"
|
3036
|
+
},
|
3037
|
+
"description": "There are 3 variants of button: primary, secondary, tertiary. They are styled differently.\n- **Primary**: Solid background color.\n- **Secondary**: Transparent background with a solid border.\n- **Tertiary**: No background or border, appears as plain text but retains all button functionalities.",
|
3038
|
+
"default": "primary",
|
3039
|
+
"attribute": "variant",
|
3040
|
+
"inheritedFrom": {
|
3041
|
+
"name": "ButtonComponentMixin",
|
3042
|
+
"module": "utils/mixins/ButtonComponentMixin.js"
|
3043
|
+
}
|
3044
|
+
},
|
3045
|
+
{
|
3046
|
+
"kind": "field",
|
3047
|
+
"name": "color",
|
3048
|
+
"type": {
|
3049
|
+
"text": "ButtonColor"
|
3050
|
+
},
|
3051
|
+
"description": "There are 5 colors for button: positive, negative, accent, promotional, default.",
|
3052
3052
|
"default": "default",
|
3053
3053
|
"attribute": "color",
|
3054
3054
|
"inheritedFrom": {
|
@@ -6362,7 +6362,7 @@
|
|
6362
6362
|
"kind": "method",
|
6363
6363
|
"name": "manageRequired",
|
6364
6364
|
"privacy": "private",
|
6365
|
-
"description": "Manages the required state of the checkbox.\nIf the checkbox is not checked and the
|
6365
|
+
"description": "Manages the required state of the checkbox.\nIf the checkbox is not checked and the required property is set, then the checkbox is invalid."
|
6366
6366
|
},
|
6367
6367
|
{
|
6368
6368
|
"kind": "method",
|
@@ -6565,12 +6565,13 @@
|
|
6565
6565
|
},
|
6566
6566
|
{
|
6567
6567
|
"kind": "field",
|
6568
|
-
"name": "
|
6568
|
+
"name": "required",
|
6569
6569
|
"type": {
|
6570
|
-
"text": "
|
6570
|
+
"text": "boolean"
|
6571
6571
|
},
|
6572
|
-
"
|
6573
|
-
"
|
6572
|
+
"default": "false",
|
6573
|
+
"description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
|
6574
|
+
"attribute": "required",
|
6574
6575
|
"reflects": true,
|
6575
6576
|
"inheritedFrom": {
|
6576
6577
|
"name": "FormfieldWrapper",
|
@@ -6634,15 +6635,6 @@
|
|
6634
6635
|
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
6635
6636
|
}
|
6636
6637
|
},
|
6637
|
-
{
|
6638
|
-
"kind": "method",
|
6639
|
-
"name": "renderRequiredLabel",
|
6640
|
-
"privacy": "protected",
|
6641
|
-
"inheritedFrom": {
|
6642
|
-
"name": "FormfieldWrapper",
|
6643
|
-
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
6644
|
-
}
|
6645
|
-
},
|
6646
6638
|
{
|
6647
6639
|
"kind": "method",
|
6648
6640
|
"name": "renderHelpTextIcon",
|
@@ -6826,12 +6818,13 @@
|
|
6826
6818
|
}
|
6827
6819
|
},
|
6828
6820
|
{
|
6829
|
-
"name": "required
|
6821
|
+
"name": "required",
|
6830
6822
|
"type": {
|
6831
|
-
"text": "
|
6823
|
+
"text": "boolean"
|
6832
6824
|
},
|
6833
|
-
"
|
6834
|
-
"
|
6825
|
+
"default": "false",
|
6826
|
+
"description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
|
6827
|
+
"fieldName": "required",
|
6835
6828
|
"inheritedFrom": {
|
6836
6829
|
"name": "FormfieldWrapper",
|
6837
6830
|
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
@@ -10893,12 +10886,13 @@
|
|
10893
10886
|
},
|
10894
10887
|
{
|
10895
10888
|
"kind": "field",
|
10896
|
-
"name": "
|
10889
|
+
"name": "required",
|
10897
10890
|
"type": {
|
10898
|
-
"text": "
|
10891
|
+
"text": "boolean"
|
10899
10892
|
},
|
10900
|
-
"
|
10901
|
-
"
|
10893
|
+
"default": "false",
|
10894
|
+
"description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
|
10895
|
+
"attribute": "required",
|
10902
10896
|
"reflects": true,
|
10903
10897
|
"inheritedFrom": {
|
10904
10898
|
"name": "FormfieldWrapper",
|
@@ -10962,15 +10956,6 @@
|
|
10962
10956
|
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
10963
10957
|
}
|
10964
10958
|
},
|
10965
|
-
{
|
10966
|
-
"kind": "method",
|
10967
|
-
"name": "renderRequiredLabel",
|
10968
|
-
"privacy": "protected",
|
10969
|
-
"inheritedFrom": {
|
10970
|
-
"name": "FormfieldWrapper",
|
10971
|
-
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
10972
|
-
}
|
10973
|
-
},
|
10974
10959
|
{
|
10975
10960
|
"kind": "method",
|
10976
10961
|
"name": "renderHelpTextIcon",
|
@@ -11085,12 +11070,13 @@
|
|
11085
11070
|
}
|
11086
11071
|
},
|
11087
11072
|
{
|
11088
|
-
"name": "required
|
11073
|
+
"name": "required",
|
11089
11074
|
"type": {
|
11090
|
-
"text": "
|
11075
|
+
"text": "boolean"
|
11091
11076
|
},
|
11092
|
-
"
|
11093
|
-
"
|
11077
|
+
"default": "false",
|
11078
|
+
"description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
|
11079
|
+
"fieldName": "required",
|
11094
11080
|
"inheritedFrom": {
|
11095
11081
|
"name": "FormfieldWrapper",
|
11096
11082
|
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
@@ -11174,12 +11160,13 @@
|
|
11174
11160
|
},
|
11175
11161
|
{
|
11176
11162
|
"kind": "field",
|
11177
|
-
"name": "
|
11163
|
+
"name": "required",
|
11178
11164
|
"type": {
|
11179
|
-
"text": "
|
11165
|
+
"text": "boolean"
|
11180
11166
|
},
|
11181
|
-
"
|
11182
|
-
"
|
11167
|
+
"default": "false",
|
11168
|
+
"description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
|
11169
|
+
"attribute": "required",
|
11183
11170
|
"reflects": true
|
11184
11171
|
},
|
11185
11172
|
{
|
@@ -11223,11 +11210,6 @@
|
|
11223
11210
|
}
|
11224
11211
|
}
|
11225
11212
|
},
|
11226
|
-
{
|
11227
|
-
"kind": "method",
|
11228
|
-
"name": "renderRequiredLabel",
|
11229
|
-
"privacy": "protected"
|
11230
|
-
},
|
11231
11213
|
{
|
11232
11214
|
"kind": "method",
|
11233
11215
|
"name": "renderHelpTextIcon",
|
@@ -11298,12 +11280,13 @@
|
|
11298
11280
|
"fieldName": "label"
|
11299
11281
|
},
|
11300
11282
|
{
|
11301
|
-
"name": "required
|
11283
|
+
"name": "required",
|
11302
11284
|
"type": {
|
11303
|
-
"text": "
|
11285
|
+
"text": "boolean"
|
11304
11286
|
},
|
11305
|
-
"
|
11306
|
-
"
|
11287
|
+
"default": "false",
|
11288
|
+
"description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
|
11289
|
+
"fieldName": "required"
|
11307
11290
|
},
|
11308
11291
|
{
|
11309
11292
|
"name": "id",
|
@@ -12296,12 +12279,13 @@
|
|
12296
12279
|
},
|
12297
12280
|
{
|
12298
12281
|
"kind": "field",
|
12299
|
-
"name": "
|
12282
|
+
"name": "required",
|
12300
12283
|
"type": {
|
12301
|
-
"text": "
|
12284
|
+
"text": "boolean"
|
12302
12285
|
},
|
12303
|
-
"
|
12304
|
-
"
|
12286
|
+
"default": "false",
|
12287
|
+
"description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
|
12288
|
+
"attribute": "required",
|
12305
12289
|
"reflects": true,
|
12306
12290
|
"inheritedFrom": {
|
12307
12291
|
"name": "FormfieldWrapper",
|
@@ -12365,15 +12349,6 @@
|
|
12365
12349
|
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
12366
12350
|
}
|
12367
12351
|
},
|
12368
|
-
{
|
12369
|
-
"kind": "method",
|
12370
|
-
"name": "renderRequiredLabel",
|
12371
|
-
"privacy": "protected",
|
12372
|
-
"inheritedFrom": {
|
12373
|
-
"name": "FormfieldWrapper",
|
12374
|
-
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
12375
|
-
}
|
12376
|
-
},
|
12377
12352
|
{
|
12378
12353
|
"kind": "method",
|
12379
12354
|
"name": "renderHelpTextIcon",
|
@@ -12668,12 +12643,13 @@
|
|
12668
12643
|
}
|
12669
12644
|
},
|
12670
12645
|
{
|
12671
|
-
"name": "required
|
12646
|
+
"name": "required",
|
12672
12647
|
"type": {
|
12673
|
-
"text": "
|
12648
|
+
"text": "boolean"
|
12674
12649
|
},
|
12675
|
-
"
|
12676
|
-
"
|
12650
|
+
"default": "false",
|
12651
|
+
"description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
|
12652
|
+
"fieldName": "required",
|
12677
12653
|
"inheritedFrom": {
|
12678
12654
|
"name": "FormfieldWrapper",
|
12679
12655
|
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
@@ -19776,41 +19752,6 @@
|
|
19776
19752
|
}
|
19777
19753
|
]
|
19778
19754
|
},
|
19779
|
-
{
|
19780
|
-
"kind": "javascript-module",
|
19781
|
-
"path": "components/menusection/menusection.component.js",
|
19782
|
-
"declarations": [
|
19783
|
-
{
|
19784
|
-
"kind": "class",
|
19785
|
-
"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.",
|
19786
|
-
"name": "MenuSection",
|
19787
|
-
"slots": [
|
19788
|
-
{
|
19789
|
-
"description": "Default slot for inserting `menuitem`, `menuitemcheckbox`, or `menuitemradio`",
|
19790
|
-
"name": ""
|
19791
|
-
}
|
19792
|
-
],
|
19793
|
-
"members": [],
|
19794
|
-
"superclass": {
|
19795
|
-
"name": "Component",
|
19796
|
-
"module": "/src/models"
|
19797
|
-
},
|
19798
|
-
"tagName": "mdc-menusection",
|
19799
|
-
"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 */",
|
19800
|
-
"customElement": true
|
19801
|
-
}
|
19802
|
-
],
|
19803
|
-
"exports": [
|
19804
|
-
{
|
19805
|
-
"kind": "js",
|
19806
|
-
"name": "default",
|
19807
|
-
"declaration": {
|
19808
|
-
"name": "MenuSection",
|
19809
|
-
"module": "components/menusection/menusection.component.js"
|
19810
|
-
}
|
19811
|
-
}
|
19812
|
-
]
|
19813
|
-
},
|
19814
19755
|
{
|
19815
19756
|
"kind": "javascript-module",
|
19816
19757
|
"path": "components/optgroup/optgroup.component.js",
|
@@ -19951,31 +19892,66 @@
|
|
19951
19892
|
},
|
19952
19893
|
{
|
19953
19894
|
"kind": "javascript-module",
|
19954
|
-
"path": "components/
|
19895
|
+
"path": "components/menusection/menusection.component.js",
|
19955
19896
|
"declarations": [
|
19956
19897
|
{
|
19957
19898
|
"kind": "class",
|
19958
|
-
"description": "
|
19959
|
-
"name": "
|
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",
|
19960
19901
|
"slots": [
|
19961
19902
|
{
|
19962
|
-
"description": "
|
19963
|
-
"name": "
|
19964
|
-
}
|
19965
|
-
|
19966
|
-
|
19967
|
-
|
19968
|
-
|
19969
|
-
|
19970
|
-
|
19971
|
-
|
19972
|
-
|
19973
|
-
|
19974
|
-
|
19975
|
-
|
19976
|
-
|
19977
|
-
|
19978
|
-
|
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
|
+
{
|
19929
|
+
"kind": "javascript-module",
|
19930
|
+
"path": "components/option/option.component.js",
|
19931
|
+
"declarations": [
|
19932
|
+
{
|
19933
|
+
"kind": "class",
|
19934
|
+
"description": "option component, which is used as a list item in a select component.<br/>\nWe can pass an icon which will be displayed in leading position of the option label text.\nWe can pass a tooltip which will be displayed on hover of the option label text.\nThe tooltip will be helpful for a long label text which is truncated with ellipsis.",
|
19935
|
+
"name": "Option",
|
19936
|
+
"slots": [
|
19937
|
+
{
|
19938
|
+
"description": "This is a default/unnamed slot",
|
19939
|
+
"name": "default"
|
19940
|
+
},
|
19941
|
+
{
|
19942
|
+
"description": "slot for list item controls to appear of leading end.",
|
19943
|
+
"name": "leading-controls",
|
19944
|
+
"inheritedFrom": {
|
19945
|
+
"name": "ListItem",
|
19946
|
+
"module": "src/components/listitem/listitem.component.ts"
|
19947
|
+
}
|
19948
|
+
},
|
19949
|
+
{
|
19950
|
+
"description": "slot for list item primary label.",
|
19951
|
+
"name": "leading-text-primary-label",
|
19952
|
+
"inheritedFrom": {
|
19953
|
+
"name": "ListItem",
|
19954
|
+
"module": "src/components/listitem/listitem.component.ts"
|
19979
19955
|
}
|
19980
19956
|
},
|
19981
19957
|
{
|
@@ -22433,12 +22409,13 @@
|
|
22433
22409
|
},
|
22434
22410
|
{
|
22435
22411
|
"kind": "field",
|
22436
|
-
"name": "
|
22412
|
+
"name": "required",
|
22437
22413
|
"type": {
|
22438
|
-
"text": "
|
22414
|
+
"text": "boolean"
|
22439
22415
|
},
|
22440
|
-
"
|
22441
|
-
"
|
22416
|
+
"default": "false",
|
22417
|
+
"description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
|
22418
|
+
"attribute": "required",
|
22442
22419
|
"reflects": true,
|
22443
22420
|
"inheritedFrom": {
|
22444
22421
|
"name": "FormfieldWrapper",
|
@@ -22502,15 +22479,6 @@
|
|
22502
22479
|
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
22503
22480
|
}
|
22504
22481
|
},
|
22505
|
-
{
|
22506
|
-
"kind": "method",
|
22507
|
-
"name": "renderRequiredLabel",
|
22508
|
-
"privacy": "protected",
|
22509
|
-
"inheritedFrom": {
|
22510
|
-
"name": "FormfieldWrapper",
|
22511
|
-
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
22512
|
-
}
|
22513
|
-
},
|
22514
22482
|
{
|
22515
22483
|
"kind": "method",
|
22516
22484
|
"name": "renderHelpTextIcon",
|
@@ -22639,12 +22607,13 @@
|
|
22639
22607
|
}
|
22640
22608
|
},
|
22641
22609
|
{
|
22642
|
-
"name": "required
|
22610
|
+
"name": "required",
|
22643
22611
|
"type": {
|
22644
|
-
"text": "
|
22612
|
+
"text": "boolean"
|
22645
22613
|
},
|
22646
|
-
"
|
22647
|
-
"
|
22614
|
+
"default": "false",
|
22615
|
+
"description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
|
22616
|
+
"fieldName": "required",
|
22648
22617
|
"inheritedFrom": {
|
22649
22618
|
"name": "FormfieldWrapper",
|
22650
22619
|
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
@@ -22975,12 +22944,13 @@
|
|
22975
22944
|
},
|
22976
22945
|
{
|
22977
22946
|
"kind": "field",
|
22978
|
-
"name": "
|
22947
|
+
"name": "required",
|
22979
22948
|
"type": {
|
22980
|
-
"text": "
|
22949
|
+
"text": "boolean"
|
22981
22950
|
},
|
22982
|
-
"
|
22983
|
-
"
|
22951
|
+
"default": "false",
|
22952
|
+
"description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
|
22953
|
+
"attribute": "required",
|
22984
22954
|
"reflects": true,
|
22985
22955
|
"inheritedFrom": {
|
22986
22956
|
"name": "FormfieldWrapper",
|
@@ -23044,15 +23014,6 @@
|
|
23044
23014
|
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
23045
23015
|
}
|
23046
23016
|
},
|
23047
|
-
{
|
23048
|
-
"kind": "method",
|
23049
|
-
"name": "renderRequiredLabel",
|
23050
|
-
"privacy": "protected",
|
23051
|
-
"inheritedFrom": {
|
23052
|
-
"name": "FormfieldWrapper",
|
23053
|
-
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
23054
|
-
}
|
23055
|
-
},
|
23056
23017
|
{
|
23057
23018
|
"kind": "method",
|
23058
23019
|
"name": "renderHelpTextIcon",
|
@@ -23200,12 +23161,13 @@
|
|
23200
23161
|
}
|
23201
23162
|
},
|
23202
23163
|
{
|
23203
|
-
"name": "required
|
23164
|
+
"name": "required",
|
23204
23165
|
"type": {
|
23205
|
-
"text": "
|
23166
|
+
"text": "boolean"
|
23206
23167
|
},
|
23207
|
-
"
|
23208
|
-
"
|
23168
|
+
"default": "false",
|
23169
|
+
"description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
|
23170
|
+
"fieldName": "required",
|
23209
23171
|
"inheritedFrom": {
|
23210
23172
|
"name": "FormfieldWrapper",
|
23211
23173
|
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
@@ -23635,12 +23597,13 @@
|
|
23635
23597
|
},
|
23636
23598
|
{
|
23637
23599
|
"kind": "field",
|
23638
|
-
"name": "
|
23600
|
+
"name": "required",
|
23639
23601
|
"type": {
|
23640
|
-
"text": "
|
23602
|
+
"text": "boolean"
|
23641
23603
|
},
|
23642
|
-
"
|
23643
|
-
"
|
23604
|
+
"default": "false",
|
23605
|
+
"description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
|
23606
|
+
"attribute": "required",
|
23644
23607
|
"reflects": true,
|
23645
23608
|
"inheritedFrom": {
|
23646
23609
|
"name": "FormfieldWrapper",
|
@@ -23704,15 +23667,6 @@
|
|
23704
23667
|
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
23705
23668
|
}
|
23706
23669
|
},
|
23707
|
-
{
|
23708
|
-
"kind": "method",
|
23709
|
-
"name": "renderRequiredLabel",
|
23710
|
-
"privacy": "protected",
|
23711
|
-
"inheritedFrom": {
|
23712
|
-
"name": "FormfieldWrapper",
|
23713
|
-
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
23714
|
-
}
|
23715
|
-
},
|
23716
23670
|
{
|
23717
23671
|
"kind": "method",
|
23718
23672
|
"name": "renderHelpTextIcon",
|
@@ -23896,12 +23850,13 @@
|
|
23896
23850
|
}
|
23897
23851
|
},
|
23898
23852
|
{
|
23899
|
-
"name": "required
|
23853
|
+
"name": "required",
|
23900
23854
|
"type": {
|
23901
|
-
"text": "
|
23855
|
+
"text": "boolean"
|
23902
23856
|
},
|
23903
|
-
"
|
23904
|
-
"
|
23857
|
+
"default": "false",
|
23858
|
+
"description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
|
23859
|
+
"fieldName": "required",
|
23905
23860
|
"inheritedFrom": {
|
23906
23861
|
"name": "FormfieldWrapper",
|
23907
23862
|
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
@@ -23987,1049 +23942,1418 @@
|
|
23987
23942
|
},
|
23988
23943
|
{
|
23989
23944
|
"kind": "javascript-module",
|
23990
|
-
"path": "components/
|
23945
|
+
"path": "components/screenreaderannouncer/screenreaderannouncer.component.js",
|
23991
23946
|
"declarations": [
|
23992
23947
|
{
|
23993
23948
|
"kind": "class",
|
23994
|
-
"description": "`mdc-
|
23995
|
-
"name": "
|
23996
|
-
"cssProperties": [
|
23997
|
-
{
|
23998
|
-
"description": "color of the description text",
|
23999
|
-
"name": "--mdc-radiogroup-description-text-normal"
|
24000
|
-
}
|
24001
|
-
],
|
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",
|
24002
23951
|
"members": [
|
24003
23952
|
{
|
24004
23953
|
"kind": "field",
|
24005
|
-
"name": "
|
23954
|
+
"name": "announcement",
|
24006
23955
|
"type": {
|
24007
23956
|
"text": "string"
|
24008
23957
|
},
|
24009
23958
|
"default": "''",
|
24010
|
-
"description": "
|
24011
|
-
"attribute": "
|
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
|
24012
23962
|
},
|
24013
23963
|
{
|
24014
23964
|
"kind": "field",
|
24015
|
-
"name": "
|
23965
|
+
"name": "identity",
|
24016
23966
|
"type": {
|
24017
|
-
"text": "string
|
23967
|
+
"text": "string"
|
24018
23968
|
},
|
24019
|
-
"default": "
|
24020
|
-
"description": "
|
24021
|
-
"attribute": "
|
24022
|
-
"reflects": true
|
24023
|
-
"inheritedFrom": {
|
24024
|
-
"name": "DataAriaLabelMixin",
|
24025
|
-
"module": "utils/mixins/DataAriaLabelMixin.js"
|
24026
|
-
}
|
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
|
24027
23973
|
},
|
24028
23974
|
{
|
24029
23975
|
"kind": "field",
|
24030
|
-
"name": "
|
23976
|
+
"name": "dataAriaLive",
|
24031
23977
|
"type": {
|
24032
|
-
"text": "
|
23978
|
+
"text": "AriaLive"
|
24033
23979
|
},
|
24034
|
-
"description": "
|
24035
|
-
"default": "
|
24036
|
-
"attribute": "
|
24037
|
-
"reflects": true
|
24038
|
-
"inheritedFrom": {
|
24039
|
-
"name": "FormfieldWrapper",
|
24040
|
-
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
24041
|
-
}
|
23980
|
+
"description": "Aria live value for announcement.",
|
23981
|
+
"default": "'polite'",
|
23982
|
+
"attribute": "data-aria-live",
|
23983
|
+
"reflects": true
|
24042
23984
|
},
|
24043
23985
|
{
|
24044
23986
|
"kind": "field",
|
24045
|
-
"name": "
|
23987
|
+
"name": "delay",
|
24046
23988
|
"type": {
|
24047
|
-
"text": "
|
23989
|
+
"text": "number"
|
24048
23990
|
},
|
24049
|
-
"description": "
|
24050
|
-
"
|
24051
|
-
"
|
24052
|
-
"
|
24053
|
-
"name": "FormfieldWrapper",
|
24054
|
-
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
24055
|
-
}
|
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
|
24056
23995
|
},
|
24057
23996
|
{
|
24058
23997
|
"kind": "field",
|
24059
|
-
"name": "
|
23998
|
+
"name": "timeout",
|
24060
23999
|
"type": {
|
24061
|
-
"text": "
|
24000
|
+
"text": "number"
|
24062
24001
|
},
|
24063
|
-
"description": "
|
24064
|
-
"
|
24065
|
-
"
|
24066
|
-
"
|
24067
|
-
"name": "FormfieldWrapper",
|
24068
|
-
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
24069
|
-
}
|
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
|
24070
24006
|
},
|
24071
24007
|
{
|
24072
|
-
"kind": "
|
24073
|
-
"name": "
|
24008
|
+
"kind": "method",
|
24009
|
+
"name": "announce",
|
24010
|
+
"parameters": [
|
24011
|
+
{
|
24012
|
+
"name": "announcement",
|
24013
|
+
"type": {
|
24014
|
+
"text": "string"
|
24015
|
+
},
|
24016
|
+
"description": "The announcement to be made."
|
24017
|
+
},
|
24018
|
+
{
|
24019
|
+
"name": "delay",
|
24020
|
+
"type": {
|
24021
|
+
"text": "number"
|
24022
|
+
},
|
24023
|
+
"description": "The delay in milliseconds before announcing the message."
|
24024
|
+
},
|
24025
|
+
{
|
24026
|
+
"name": "timeout",
|
24027
|
+
"type": {
|
24028
|
+
"text": "number"
|
24029
|
+
},
|
24030
|
+
"description": "The timeout in milliseconds before removing the announcement."
|
24031
|
+
},
|
24032
|
+
{
|
24033
|
+
"name": "ariaLive",
|
24034
|
+
"type": {
|
24035
|
+
"text": "AriaLive"
|
24036
|
+
},
|
24037
|
+
"description": "The aria live value for the announcement."
|
24038
|
+
}
|
24039
|
+
],
|
24040
|
+
"description": "Announces the given announcement to the screen reader.\n\nA div element with aria-live attribute set to the given ariaLive value is created\nand a p element with the announcement text is appended to it.\n\nThe div element is appended to the element in the DOM identified with id as\nidentity attribute."
|
24041
|
+
},
|
24042
|
+
{
|
24043
|
+
"kind": "method",
|
24044
|
+
"name": "clearTimeOutsAndAnnouncements",
|
24045
|
+
"privacy": "private",
|
24046
|
+
"description": "Clears all timeouts and removes all announcements from the screen reader."
|
24047
|
+
},
|
24048
|
+
{
|
24049
|
+
"kind": "method",
|
24050
|
+
"name": "createAnnouncementAriaLiveRegion",
|
24051
|
+
"privacy": "private",
|
24052
|
+
"description": "Creates a div element with id as identity attribute in the DOM.\n\nIf the identity attribute is not provided, it is set internally to\n`mdc-screenreaderannouncer-identity`."
|
24053
|
+
}
|
24054
|
+
],
|
24055
|
+
"attributes": [
|
24056
|
+
{
|
24057
|
+
"name": "announcement",
|
24074
24058
|
"type": {
|
24075
24059
|
"text": "string"
|
24076
24060
|
},
|
24077
24061
|
"default": "''",
|
24078
|
-
"description": "The
|
24079
|
-
"
|
24080
|
-
"inheritedFrom": {
|
24081
|
-
"name": "FormfieldWrapper",
|
24082
|
-
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
24083
|
-
}
|
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"
|
24084
24064
|
},
|
24085
24065
|
{
|
24086
|
-
"
|
24087
|
-
"name": "helpTextType",
|
24066
|
+
"name": "identity",
|
24088
24067
|
"type": {
|
24089
|
-
"text": "
|
24068
|
+
"text": "string"
|
24090
24069
|
},
|
24091
|
-
"
|
24092
|
-
"
|
24093
|
-
"
|
24094
|
-
"inheritedFrom": {
|
24095
|
-
"name": "FormfieldWrapper",
|
24096
|
-
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
24097
|
-
}
|
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"
|
24098
24073
|
},
|
24099
24074
|
{
|
24100
|
-
"
|
24101
|
-
"name": "helpText",
|
24075
|
+
"name": "data-aria-live",
|
24102
24076
|
"type": {
|
24103
|
-
"text": "
|
24077
|
+
"text": "AriaLive"
|
24104
24078
|
},
|
24105
|
-
"description": "
|
24106
|
-
"
|
24107
|
-
"
|
24108
|
-
|
24079
|
+
"description": "Aria live value for announcement.",
|
24080
|
+
"default": "'polite'",
|
24081
|
+
"fieldName": "dataAriaLive"
|
24082
|
+
},
|
24083
|
+
{
|
24084
|
+
"name": "delay",
|
24085
|
+
"type": {
|
24086
|
+
"text": "number"
|
24087
|
+
},
|
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"
|
24091
|
+
},
|
24092
|
+
{
|
24093
|
+
"name": "timeout",
|
24094
|
+
"type": {
|
24095
|
+
"text": "number"
|
24096
|
+
},
|
24097
|
+
"description": "Milliseconds to wait after which the announcement element will be removed from\nidentity region in DOM, causing the screen reader to not announcing the message.",
|
24098
|
+
"default": "20_000",
|
24099
|
+
"fieldName": "timeout"
|
24100
|
+
}
|
24101
|
+
],
|
24102
|
+
"superclass": {
|
24103
|
+
"name": "Component",
|
24104
|
+
"module": "/src/models"
|
24105
|
+
},
|
24106
|
+
"tagName": "mdc-screenreaderannouncer",
|
24107
|
+
"jsDoc": "/**\n * `mdc-screenreaderannouncer` can be used to announce messages with the screen reader.\n *\n * To make an announcement set `announcement` attribute on the `mdc-screenreaderannouncer` element.\n *\n * **Internal logic**\n *\n * When the screenreader announcer is connected to the DOM, if the `identity` attribute is not\n * provided, it is set to `mdc-screenreaderannouncer-identity` and a `<div>` element with this id is created\n * in the DOM. If the `identity` attribute is provided, the identity element is used and no new element\n * is created in the DOM.\n *\n * When the `announcement` attribute is set, the screenreader announcer will create a `<div>` element with\n * `aria-live` attribute set to the value of `data-aria-live` attribute and append it to the `identity` element.\n * After delay of `delay` milliseconds, a <p> element with the announcement text is appended to the `<div>` element.\n *\n * The announcement `<div>` element is removed from the DOM after `timeout` milliseconds.\n *\n * When the screen announcer component is disconnected from the DOM, all the timeouts are cleared and\n * all the announcement elements added are removed from the DOM and timeouts cleared.\n *\n * **Note**\n * 1. The default delay of 150 miliseconds is used as we dynamically generate the\n * aria-live region in the DOM and add the announcement text to it.\n * 3. If no `identity` is provided, all the screen reader components will create and use only one\n * `<div>` element with id `mdc-screenreaderannouncer-identity` in the DOM.\n *\n * Reference: https://patrickhlauke.github.io/aria/tests/live-regions/\n *\n * @tagname mdc-screenreaderannouncer\n */",
|
24108
|
+
"customElement": true
|
24109
|
+
}
|
24110
|
+
],
|
24111
|
+
"exports": [
|
24112
|
+
{
|
24113
|
+
"kind": "js",
|
24114
|
+
"name": "default",
|
24115
|
+
"declaration": {
|
24116
|
+
"name": "ScreenreaderAnnouncer",
|
24117
|
+
"module": "components/screenreaderannouncer/screenreaderannouncer.component.js"
|
24118
|
+
}
|
24119
|
+
}
|
24120
|
+
]
|
24121
|
+
},
|
24122
|
+
{
|
24123
|
+
"kind": "javascript-module",
|
24124
|
+
"path": "components/searchfield/searchfield.component.js",
|
24125
|
+
"declarations": [
|
24126
|
+
{
|
24127
|
+
"kind": "class",
|
24128
|
+
"description": "searchfield component is used as an input field for search functionality.\n\nIt supports `mdc-inputchip` as filters.\n\nThis component is built by extending the `mdc-input` component.",
|
24129
|
+
"name": "Searchfield",
|
24130
|
+
"slots": [
|
24131
|
+
{
|
24132
|
+
"description": "Slot for input chips",
|
24133
|
+
"name": "filters"
|
24134
|
+
},
|
24135
|
+
{
|
24136
|
+
"description": "slot to add the label info icon",
|
24137
|
+
"name": "label-info",
|
24138
|
+
"inheritedFrom": {
|
24109
24139
|
"name": "FormfieldWrapper",
|
24110
|
-
"module": "components/formfieldwrapper/formfieldwrapper.component.
|
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"
|
24111
24150
|
}
|
24112
24151
|
},
|
24113
24152
|
{
|
24114
24153
|
"kind": "method",
|
24115
|
-
"name": "
|
24154
|
+
"name": "handleKeyDown",
|
24116
24155
|
"privacy": "protected",
|
24117
|
-
"
|
24118
|
-
|
24119
|
-
|
24120
|
-
"
|
24156
|
+
"parameters": [
|
24157
|
+
{
|
24158
|
+
"name": "event",
|
24159
|
+
"type": {
|
24160
|
+
"text": "KeyboardEvent"
|
24161
|
+
},
|
24162
|
+
"description": "Keyboard event"
|
24121
24163
|
}
|
24122
|
-
|
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.",
|
24123
24166
|
"inheritedFrom": {
|
24124
|
-
"name": "
|
24125
|
-
"module": "components/
|
24167
|
+
"name": "Input",
|
24168
|
+
"module": "components/input/input.component.js"
|
24126
24169
|
}
|
24127
24170
|
},
|
24128
24171
|
{
|
24129
24172
|
"kind": "method",
|
24130
|
-
"name": "
|
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."
|
24176
|
+
},
|
24177
|
+
{
|
24178
|
+
"kind": "method",
|
24179
|
+
"name": "clearInputText",
|
24131
24180
|
"privacy": "protected",
|
24181
|
+
"description": "Clears the input field.",
|
24132
24182
|
"inheritedFrom": {
|
24133
|
-
"name": "
|
24134
|
-
"module": "components/
|
24183
|
+
"name": "Input",
|
24184
|
+
"module": "components/input/input.component.js"
|
24135
24185
|
}
|
24136
24186
|
},
|
24137
24187
|
{
|
24138
|
-
"kind": "
|
24139
|
-
"name": "
|
24140
|
-
"
|
24141
|
-
|
24142
|
-
"return": {
|
24143
|
-
"type": {
|
24144
|
-
"text": ""
|
24145
|
-
}
|
24188
|
+
"kind": "field",
|
24189
|
+
"name": "name",
|
24190
|
+
"type": {
|
24191
|
+
"text": "string"
|
24146
24192
|
},
|
24193
|
+
"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,
|
24147
24197
|
"inheritedFrom": {
|
24148
|
-
"name": "
|
24149
|
-
"module": "
|
24198
|
+
"name": "FormInternalsMixin",
|
24199
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
24150
24200
|
}
|
24151
24201
|
},
|
24152
24202
|
{
|
24153
|
-
"kind": "
|
24154
|
-
"name": "
|
24155
|
-
"
|
24156
|
-
|
24157
|
-
"return": {
|
24158
|
-
"type": {
|
24159
|
-
"text": ""
|
24160
|
-
}
|
24203
|
+
"kind": "field",
|
24204
|
+
"name": "value",
|
24205
|
+
"type": {
|
24206
|
+
"text": "string"
|
24161
24207
|
},
|
24208
|
+
"default": "''",
|
24209
|
+
"description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
|
24210
|
+
"attribute": "value",
|
24211
|
+
"reflects": true,
|
24162
24212
|
"inheritedFrom": {
|
24163
|
-
"name": "
|
24164
|
-
"module": "
|
24213
|
+
"name": "FormInternalsMixin",
|
24214
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
24215
|
+
}
|
24216
|
+
},
|
24217
|
+
{
|
24218
|
+
"kind": "field",
|
24219
|
+
"name": "validationMessage",
|
24220
|
+
"type": {
|
24221
|
+
"text": "string | undefined"
|
24222
|
+
},
|
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,
|
24226
|
+
"inheritedFrom": {
|
24227
|
+
"name": "FormInternalsMixin",
|
24228
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
24229
|
+
}
|
24230
|
+
},
|
24231
|
+
{
|
24232
|
+
"kind": "field",
|
24233
|
+
"name": "validity",
|
24234
|
+
"type": {
|
24235
|
+
"text": "ValidityState"
|
24236
|
+
},
|
24237
|
+
"readonly": true,
|
24238
|
+
"inheritedFrom": {
|
24239
|
+
"name": "FormInternalsMixin",
|
24240
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
24241
|
+
}
|
24242
|
+
},
|
24243
|
+
{
|
24244
|
+
"kind": "field",
|
24245
|
+
"name": "willValidate",
|
24246
|
+
"readonly": true,
|
24247
|
+
"inheritedFrom": {
|
24248
|
+
"name": "FormInternalsMixin",
|
24249
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
24165
24250
|
}
|
24166
24251
|
},
|
24167
24252
|
{
|
24168
24253
|
"kind": "method",
|
24169
|
-
"name": "
|
24170
|
-
"
|
24171
|
-
"description": "renders the mdc-label-text container that contains the label and labelInfoToggleTip.",
|
24254
|
+
"name": "setValidity",
|
24255
|
+
"description": "Sets the validity of the input field based on the input field's validity.",
|
24172
24256
|
"return": {
|
24173
24257
|
"type": {
|
24174
24258
|
"text": ""
|
24175
24259
|
}
|
24176
24260
|
},
|
24177
24261
|
"inheritedFrom": {
|
24178
|
-
"name": "
|
24179
|
-
"module": "
|
24262
|
+
"name": "FormInternalsMixin",
|
24263
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
24180
24264
|
}
|
24181
24265
|
},
|
24182
24266
|
{
|
24183
24267
|
"kind": "method",
|
24184
|
-
"name": "
|
24185
|
-
"privacy": "protected",
|
24186
|
-
"description": "renders the mdc-help-text container that contains the helpertext icon and helpertext.",
|
24268
|
+
"name": "checkValidity",
|
24187
24269
|
"return": {
|
24188
24270
|
"type": {
|
24189
|
-
"text": ""
|
24271
|
+
"text": "boolean"
|
24190
24272
|
}
|
24191
24273
|
},
|
24192
24274
|
"inheritedFrom": {
|
24193
|
-
"name": "
|
24194
|
-
"module": "
|
24275
|
+
"name": "FormInternalsMixin",
|
24276
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
24195
24277
|
}
|
24196
|
-
}
|
24197
|
-
],
|
24198
|
-
"attributes": [
|
24278
|
+
},
|
24199
24279
|
{
|
24200
|
-
"
|
24201
|
-
"
|
24202
|
-
|
24203
|
-
|
24204
|
-
|
24205
|
-
|
24206
|
-
"fieldName": "name"
|
24280
|
+
"kind": "method",
|
24281
|
+
"name": "reportValidity",
|
24282
|
+
"inheritedFrom": {
|
24283
|
+
"name": "FormInternalsMixin",
|
24284
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
24285
|
+
}
|
24207
24286
|
},
|
24208
24287
|
{
|
24209
|
-
"
|
24288
|
+
"kind": "field",
|
24289
|
+
"name": "dataAriaLabel",
|
24210
24290
|
"type": {
|
24211
24291
|
"text": "string | null"
|
24212
24292
|
},
|
24213
24293
|
"default": "null",
|
24214
24294
|
"description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
|
24215
|
-
"
|
24295
|
+
"attribute": "data-aria-label",
|
24296
|
+
"reflects": true,
|
24216
24297
|
"inheritedFrom": {
|
24217
24298
|
"name": "DataAriaLabelMixin",
|
24218
|
-
"module": "
|
24299
|
+
"module": "utils/mixins/DataAriaLabelMixin.js"
|
24219
24300
|
}
|
24220
24301
|
},
|
24221
24302
|
{
|
24222
|
-
"
|
24303
|
+
"kind": "field",
|
24304
|
+
"name": "placeholder",
|
24223
24305
|
"type": {
|
24224
|
-
"text": "
|
24306
|
+
"text": "string"
|
24225
24307
|
},
|
24226
|
-
"
|
24227
|
-
"
|
24228
|
-
"
|
24308
|
+
"default": "''",
|
24309
|
+
"description": "The placeholder text that is displayed when the input field is empty.",
|
24310
|
+
"attribute": "placeholder",
|
24229
24311
|
"inheritedFrom": {
|
24230
|
-
"name": "
|
24231
|
-
"module": "
|
24312
|
+
"name": "Input",
|
24313
|
+
"module": "components/input/input.component.js"
|
24232
24314
|
}
|
24233
24315
|
},
|
24234
24316
|
{
|
24235
|
-
"
|
24317
|
+
"kind": "field",
|
24318
|
+
"name": "readonly",
|
24236
24319
|
"type": {
|
24237
|
-
"text": "
|
24320
|
+
"text": "boolean"
|
24238
24321
|
},
|
24239
|
-
"
|
24240
|
-
"
|
24322
|
+
"default": "false",
|
24323
|
+
"description": "readonly attribute of the input field. If true, the input field is read-only.",
|
24324
|
+
"attribute": "readonly",
|
24241
24325
|
"inheritedFrom": {
|
24242
|
-
"name": "
|
24243
|
-
"module": "
|
24326
|
+
"name": "Input",
|
24327
|
+
"module": "components/input/input.component.js"
|
24244
24328
|
}
|
24245
24329
|
},
|
24246
24330
|
{
|
24247
|
-
"
|
24331
|
+
"kind": "field",
|
24332
|
+
"name": "prefixText",
|
24248
24333
|
"type": {
|
24249
24334
|
"text": "string | undefined"
|
24250
24335
|
},
|
24251
|
-
"description": "The
|
24252
|
-
"
|
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",
|
24253
24338
|
"inheritedFrom": {
|
24254
|
-
"name": "
|
24255
|
-
"module": "
|
24339
|
+
"name": "Input",
|
24340
|
+
"module": "components/input/input.component.js"
|
24256
24341
|
}
|
24257
24342
|
},
|
24258
24343
|
{
|
24259
|
-
"
|
24344
|
+
"kind": "field",
|
24345
|
+
"name": "leadingIcon",
|
24260
24346
|
"type": {
|
24261
|
-
"text": "
|
24347
|
+
"text": "IconNames | undefined"
|
24262
24348
|
},
|
24263
|
-
"
|
24264
|
-
"
|
24265
|
-
"fieldName": "id",
|
24349
|
+
"description": "The leading icon that is displayed before the input field.",
|
24350
|
+
"attribute": "leading-icon",
|
24266
24351
|
"inheritedFrom": {
|
24267
|
-
"name": "
|
24268
|
-
"module": "
|
24352
|
+
"name": "Input",
|
24353
|
+
"module": "components/input/input.component.js"
|
24269
24354
|
}
|
24270
24355
|
},
|
24271
24356
|
{
|
24272
|
-
"
|
24357
|
+
"kind": "field",
|
24358
|
+
"name": "trailingButton",
|
24273
24359
|
"type": {
|
24274
|
-
"text": "
|
24360
|
+
"text": "boolean"
|
24275
24361
|
},
|
24276
|
-
"
|
24277
|
-
"
|
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",
|
24278
24365
|
"inheritedFrom": {
|
24279
|
-
"name": "
|
24280
|
-
"module": "
|
24366
|
+
"name": "Input",
|
24367
|
+
"module": "components/input/input.component.js"
|
24281
24368
|
}
|
24282
24369
|
},
|
24283
24370
|
{
|
24284
|
-
"
|
24371
|
+
"kind": "field",
|
24372
|
+
"name": "maxlength",
|
24285
24373
|
"type": {
|
24286
|
-
"text": "
|
24374
|
+
"text": "number | undefined"
|
24287
24375
|
},
|
24288
|
-
"description": "The
|
24289
|
-
"
|
24376
|
+
"description": "The maximum number of characters that the input field can accept.",
|
24377
|
+
"attribute": "maxlength",
|
24290
24378
|
"inheritedFrom": {
|
24291
|
-
"name": "
|
24292
|
-
"module": "
|
24379
|
+
"name": "Input",
|
24380
|
+
"module": "components/input/input.component.js"
|
24293
24381
|
}
|
24294
|
-
}
|
24295
|
-
],
|
24296
|
-
"superclass": {
|
24297
|
-
"name": "FormfieldGroup",
|
24298
|
-
"module": "/src/components/formfieldgroup"
|
24299
|
-
},
|
24300
|
-
"tagName": "mdc-radiogroup",
|
24301
|
-
"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 */",
|
24302
|
-
"customElement": true,
|
24303
|
-
"slots": [
|
24382
|
+
},
|
24304
24383
|
{
|
24305
|
-
"
|
24306
|
-
"name": "
|
24384
|
+
"kind": "field",
|
24385
|
+
"name": "minlength",
|
24386
|
+
"type": {
|
24387
|
+
"text": "number | undefined"
|
24388
|
+
},
|
24389
|
+
"description": "The minimum number of characters that the input field can accept.",
|
24390
|
+
"attribute": "minlength",
|
24307
24391
|
"inheritedFrom": {
|
24308
|
-
"name": "
|
24309
|
-
"module": "
|
24392
|
+
"name": "Input",
|
24393
|
+
"module": "components/input/input.component.js"
|
24310
24394
|
}
|
24311
24395
|
},
|
24312
24396
|
{
|
24313
|
-
"
|
24314
|
-
"name": "
|
24397
|
+
"kind": "field",
|
24398
|
+
"name": "autocapitalize",
|
24399
|
+
"type": {
|
24400
|
+
"text": "AutoCapitalizeType"
|
24401
|
+
},
|
24402
|
+
"description": "The autocapitalize attribute of the input field.",
|
24403
|
+
"default": "'off'",
|
24404
|
+
"attribute": "autocapitalize",
|
24315
24405
|
"inheritedFrom": {
|
24316
|
-
"name": "
|
24317
|
-
"module": "
|
24406
|
+
"name": "Input",
|
24407
|
+
"module": "components/input/input.component.js"
|
24318
24408
|
}
|
24319
|
-
}
|
24320
|
-
]
|
24321
|
-
}
|
24322
|
-
],
|
24323
|
-
"exports": [
|
24324
|
-
{
|
24325
|
-
"kind": "js",
|
24326
|
-
"name": "default",
|
24327
|
-
"declaration": {
|
24328
|
-
"name": "RadioGroup",
|
24329
|
-
"module": "components/radiogroup/radiogroup.component.js"
|
24330
|
-
}
|
24331
|
-
}
|
24332
|
-
]
|
24333
|
-
},
|
24334
|
-
{
|
24335
|
-
"kind": "javascript-module",
|
24336
|
-
"path": "components/screenreaderannouncer/screenreaderannouncer.component.js",
|
24337
|
-
"declarations": [
|
24338
|
-
{
|
24339
|
-
"kind": "class",
|
24340
|
-
"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/",
|
24341
|
-
"name": "ScreenreaderAnnouncer",
|
24342
|
-
"members": [
|
24409
|
+
},
|
24343
24410
|
{
|
24344
24411
|
"kind": "field",
|
24345
|
-
"name": "
|
24412
|
+
"name": "autocomplete",
|
24346
24413
|
"type": {
|
24347
|
-
"text": "
|
24414
|
+
"text": "AutoCompleteType"
|
24348
24415
|
},
|
24349
|
-
"
|
24350
|
-
"
|
24351
|
-
"attribute": "
|
24352
|
-
"
|
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
|
+
}
|
24353
24423
|
},
|
24354
24424
|
{
|
24355
24425
|
"kind": "field",
|
24356
|
-
"name": "
|
24426
|
+
"name": "autofocus",
|
24357
24427
|
"type": {
|
24358
|
-
"text": "
|
24428
|
+
"text": "boolean"
|
24359
24429
|
},
|
24360
|
-
"default": "
|
24361
|
-
"description": "
|
24362
|
-
"attribute": "
|
24363
|
-
"
|
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
|
+
}
|
24364
24437
|
},
|
24365
24438
|
{
|
24366
24439
|
"kind": "field",
|
24367
|
-
"name": "
|
24440
|
+
"name": "dirname",
|
24368
24441
|
"type": {
|
24369
|
-
"text": "
|
24442
|
+
"text": "string | undefined"
|
24370
24443
|
},
|
24371
|
-
"description": "
|
24372
|
-
"
|
24373
|
-
"
|
24374
|
-
|
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
|
+
}
|
24375
24450
|
},
|
24376
24451
|
{
|
24377
24452
|
"kind": "field",
|
24378
|
-
"name": "
|
24453
|
+
"name": "pattern",
|
24379
24454
|
"type": {
|
24380
|
-
"text": "
|
24455
|
+
"text": "string | undefined"
|
24381
24456
|
},
|
24382
|
-
"description": "
|
24383
|
-
"
|
24384
|
-
"
|
24385
|
-
|
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
|
+
}
|
24386
24463
|
},
|
24387
24464
|
{
|
24388
24465
|
"kind": "field",
|
24389
|
-
"name": "
|
24466
|
+
"name": "list",
|
24390
24467
|
"type": {
|
24391
|
-
"text": "
|
24468
|
+
"text": "string | undefined"
|
24392
24469
|
},
|
24393
|
-
"description": "
|
24394
|
-
"
|
24395
|
-
"
|
24396
|
-
|
24397
|
-
|
24398
|
-
|
24399
|
-
"kind": "method",
|
24400
|
-
"name": "announce",
|
24401
|
-
"parameters": [
|
24402
|
-
{
|
24403
|
-
"name": "announcement",
|
24404
|
-
"type": {
|
24405
|
-
"text": "string"
|
24406
|
-
},
|
24407
|
-
"description": "The announcement to be made."
|
24408
|
-
},
|
24409
|
-
{
|
24410
|
-
"name": "delay",
|
24411
|
-
"type": {
|
24412
|
-
"text": "number"
|
24413
|
-
},
|
24414
|
-
"description": "The delay in milliseconds before announcing the message."
|
24415
|
-
},
|
24416
|
-
{
|
24417
|
-
"name": "timeout",
|
24418
|
-
"type": {
|
24419
|
-
"text": "number"
|
24420
|
-
},
|
24421
|
-
"description": "The timeout in milliseconds before removing the announcement."
|
24422
|
-
},
|
24423
|
-
{
|
24424
|
-
"name": "ariaLive",
|
24425
|
-
"type": {
|
24426
|
-
"text": "AriaLive"
|
24427
|
-
},
|
24428
|
-
"description": "The aria live value for the announcement."
|
24429
|
-
}
|
24430
|
-
],
|
24431
|
-
"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."
|
24432
|
-
},
|
24433
|
-
{
|
24434
|
-
"kind": "method",
|
24435
|
-
"name": "clearTimeOutsAndAnnouncements",
|
24436
|
-
"privacy": "private",
|
24437
|
-
"description": "Clears all timeouts and removes all announcements from the screen reader."
|
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
|
+
}
|
24438
24476
|
},
|
24439
24477
|
{
|
24440
|
-
"kind": "
|
24441
|
-
"name": "
|
24442
|
-
"privacy": "private",
|
24443
|
-
"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`."
|
24444
|
-
}
|
24445
|
-
],
|
24446
|
-
"attributes": [
|
24447
|
-
{
|
24448
|
-
"name": "announcement",
|
24478
|
+
"kind": "field",
|
24479
|
+
"name": "size",
|
24449
24480
|
"type": {
|
24450
|
-
"text": "
|
24481
|
+
"text": "number | undefined | undefined"
|
24451
24482
|
},
|
24452
|
-
"
|
24453
|
-
"
|
24454
|
-
"
|
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
|
+
}
|
24455
24490
|
},
|
24456
24491
|
{
|
24457
|
-
"
|
24492
|
+
"kind": "field",
|
24493
|
+
"name": "clearAriaLabel",
|
24458
24494
|
"type": {
|
24459
24495
|
"text": "string"
|
24460
24496
|
},
|
24461
24497
|
"default": "''",
|
24462
|
-
"description": "
|
24463
|
-
"
|
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
|
+
}
|
24464
24504
|
},
|
24465
24505
|
{
|
24466
|
-
"
|
24467
|
-
"
|
24468
|
-
|
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
|
+
}
|
24469
24513
|
},
|
24470
|
-
"
|
24471
|
-
|
24472
|
-
|
24514
|
+
"inheritedFrom": {
|
24515
|
+
"name": "Input",
|
24516
|
+
"module": "components/input/input.component.js"
|
24517
|
+
}
|
24473
24518
|
},
|
24474
24519
|
{
|
24475
|
-
"
|
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",
|
24476
24647
|
"type": {
|
24477
|
-
"text": "
|
24648
|
+
"text": "boolean | undefined"
|
24478
24649
|
},
|
24479
|
-
"description": "
|
24480
|
-
"default": "
|
24481
|
-
"
|
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
|
+
}
|
24482
24658
|
},
|
24483
24659
|
{
|
24484
|
-
"
|
24660
|
+
"kind": "field",
|
24661
|
+
"name": "label",
|
24485
24662
|
"type": {
|
24486
|
-
"text": "
|
24663
|
+
"text": "string | undefined"
|
24487
24664
|
},
|
24488
|
-
"description": "
|
24489
|
-
"
|
24490
|
-
"
|
24491
|
-
|
24492
|
-
|
24493
|
-
|
24494
|
-
|
24495
|
-
|
24496
|
-
},
|
24497
|
-
"tagName": "mdc-screenreaderannouncer",
|
24498
|
-
"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 */",
|
24499
|
-
"customElement": true
|
24500
|
-
}
|
24501
|
-
],
|
24502
|
-
"exports": [
|
24503
|
-
{
|
24504
|
-
"kind": "js",
|
24505
|
-
"name": "default",
|
24506
|
-
"declaration": {
|
24507
|
-
"name": "ScreenreaderAnnouncer",
|
24508
|
-
"module": "components/screenreaderannouncer/screenreaderannouncer.component.js"
|
24509
|
-
}
|
24510
|
-
}
|
24511
|
-
]
|
24512
|
-
},
|
24513
|
-
{
|
24514
|
-
"kind": "javascript-module",
|
24515
|
-
"path": "components/searchfield/searchfield.component.js",
|
24516
|
-
"declarations": [
|
24517
|
-
{
|
24518
|
-
"kind": "class",
|
24519
|
-
"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.",
|
24520
|
-
"name": "Searchfield",
|
24521
|
-
"slots": [
|
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
|
+
},
|
24522
24673
|
{
|
24523
|
-
"
|
24524
|
-
"name": "
|
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
|
+
}
|
24525
24687
|
},
|
24526
24688
|
{
|
24527
|
-
"
|
24528
|
-
"name": "
|
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",
|
24529
24697
|
"inheritedFrom": {
|
24530
24698
|
"name": "FormfieldWrapper",
|
24531
|
-
"module": "
|
24699
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
24532
24700
|
}
|
24533
|
-
}
|
24534
|
-
],
|
24535
|
-
"members": [
|
24701
|
+
},
|
24536
24702
|
{
|
24537
24703
|
"kind": "field",
|
24538
|
-
"name": "
|
24704
|
+
"name": "helpTextType",
|
24539
24705
|
"type": {
|
24540
|
-
"text": "
|
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"
|
24541
24728
|
}
|
24542
24729
|
},
|
24543
24730
|
{
|
24544
24731
|
"kind": "method",
|
24545
|
-
"name": "
|
24732
|
+
"name": "renderLabelElement",
|
24546
24733
|
"privacy": "protected",
|
24547
|
-
"
|
24548
|
-
|
24549
|
-
|
24550
|
-
"
|
24551
|
-
"text": "KeyboardEvent"
|
24552
|
-
},
|
24553
|
-
"description": "Keyboard event"
|
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": ""
|
24554
24738
|
}
|
24555
|
-
|
24556
|
-
"
|
24739
|
+
},
|
24740
|
+
"inheritedFrom": {
|
24741
|
+
"name": "FormfieldWrapper",
|
24742
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
24743
|
+
}
|
24744
|
+
},
|
24745
|
+
{
|
24746
|
+
"kind": "method",
|
24747
|
+
"name": "renderHelpTextIcon",
|
24748
|
+
"privacy": "protected",
|
24749
|
+
"description": "creates the helpertext icon based on the helpTextType for validation.\nIf the helpTextType is not set, it defaults to 'default' and it doesn't display any icon.",
|
24750
|
+
"return": {
|
24751
|
+
"type": {
|
24752
|
+
"text": ""
|
24753
|
+
}
|
24754
|
+
},
|
24755
|
+
"inheritedFrom": {
|
24756
|
+
"name": "FormfieldWrapper",
|
24757
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
24758
|
+
}
|
24759
|
+
},
|
24760
|
+
{
|
24761
|
+
"kind": "method",
|
24762
|
+
"name": "renderHelpText",
|
24763
|
+
"privacy": "protected",
|
24764
|
+
"description": "creates the helper text component when the helpertext value is set.\nIt is also used to display the validation message based on the helpTextType.",
|
24765
|
+
"return": {
|
24766
|
+
"type": {
|
24767
|
+
"text": ""
|
24768
|
+
}
|
24769
|
+
},
|
24770
|
+
"inheritedFrom": {
|
24771
|
+
"name": "FormfieldWrapper",
|
24772
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
24773
|
+
}
|
24774
|
+
},
|
24775
|
+
{
|
24776
|
+
"kind": "method",
|
24777
|
+
"name": "renderLabel",
|
24778
|
+
"privacy": "protected",
|
24779
|
+
"description": "renders the mdc-label-text container that contains the label and labelInfoToggleTip.",
|
24780
|
+
"return": {
|
24781
|
+
"type": {
|
24782
|
+
"text": ""
|
24783
|
+
}
|
24784
|
+
},
|
24785
|
+
"inheritedFrom": {
|
24786
|
+
"name": "FormfieldWrapper",
|
24787
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
24788
|
+
}
|
24789
|
+
},
|
24790
|
+
{
|
24791
|
+
"kind": "method",
|
24792
|
+
"name": "renderHelperText",
|
24793
|
+
"privacy": "protected",
|
24794
|
+
"description": "renders the mdc-help-text container that contains the helpertext icon and helpertext.",
|
24795
|
+
"return": {
|
24796
|
+
"type": {
|
24797
|
+
"text": ""
|
24798
|
+
}
|
24799
|
+
},
|
24800
|
+
"inheritedFrom": {
|
24801
|
+
"name": "FormfieldWrapper",
|
24802
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
24803
|
+
}
|
24804
|
+
}
|
24805
|
+
],
|
24806
|
+
"superclass": {
|
24807
|
+
"name": "Input",
|
24808
|
+
"module": "/src/components/input/input.component"
|
24809
|
+
},
|
24810
|
+
"tagName": "mdc-searchfield",
|
24811
|
+
"jsDoc": "/**\n * searchfield component is used as an input field for search functionality.\n *\n * It supports `mdc-inputchip` as filters.\n *\n * This component is built by extending the `mdc-input` component.\n *\n * @tagname mdc-searchfield\n *\n * @slot filters - Slot for input chips\n *\n */",
|
24812
|
+
"customElement": true,
|
24813
|
+
"attributes": [
|
24814
|
+
{
|
24815
|
+
"name": "name",
|
24816
|
+
"type": {
|
24817
|
+
"text": "string"
|
24818
|
+
},
|
24819
|
+
"default": "''",
|
24820
|
+
"description": "Indicates the name of the component group.\nThey are used to group elements in a form together.",
|
24821
|
+
"fieldName": "name",
|
24822
|
+
"inheritedFrom": {
|
24823
|
+
"name": "FormInternalsMixin",
|
24824
|
+
"module": "src/utils/mixins/FormInternalsMixin.ts"
|
24825
|
+
}
|
24826
|
+
},
|
24827
|
+
{
|
24828
|
+
"name": "value",
|
24829
|
+
"type": {
|
24830
|
+
"text": "string"
|
24831
|
+
},
|
24832
|
+
"default": "''",
|
24833
|
+
"description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
|
24834
|
+
"fieldName": "value",
|
24835
|
+
"inheritedFrom": {
|
24836
|
+
"name": "FormInternalsMixin",
|
24837
|
+
"module": "src/utils/mixins/FormInternalsMixin.ts"
|
24838
|
+
}
|
24839
|
+
},
|
24840
|
+
{
|
24841
|
+
"name": "validation-message",
|
24842
|
+
"type": {
|
24843
|
+
"text": "string | undefined"
|
24844
|
+
},
|
24845
|
+
"description": "Custom validation message that will override the default message and displayed when the input is invalid.",
|
24846
|
+
"fieldName": "validationMessage",
|
24847
|
+
"inheritedFrom": {
|
24848
|
+
"name": "FormInternalsMixin",
|
24849
|
+
"module": "src/utils/mixins/FormInternalsMixin.ts"
|
24850
|
+
}
|
24851
|
+
},
|
24852
|
+
{
|
24853
|
+
"name": "data-aria-label",
|
24854
|
+
"type": {
|
24855
|
+
"text": "string | null"
|
24856
|
+
},
|
24857
|
+
"default": "null",
|
24858
|
+
"description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
|
24859
|
+
"fieldName": "dataAriaLabel",
|
24860
|
+
"inheritedFrom": {
|
24861
|
+
"name": "DataAriaLabelMixin",
|
24862
|
+
"module": "src/utils/mixins/DataAriaLabelMixin.ts"
|
24863
|
+
}
|
24864
|
+
},
|
24865
|
+
{
|
24866
|
+
"name": "placeholder",
|
24867
|
+
"type": {
|
24868
|
+
"text": "string"
|
24869
|
+
},
|
24870
|
+
"default": "''",
|
24871
|
+
"description": "The placeholder text that is displayed when the input field is empty.",
|
24872
|
+
"fieldName": "placeholder",
|
24873
|
+
"inheritedFrom": {
|
24874
|
+
"name": "Input",
|
24875
|
+
"module": "src/components/input/input.component.ts"
|
24876
|
+
}
|
24877
|
+
},
|
24878
|
+
{
|
24879
|
+
"name": "readonly",
|
24880
|
+
"type": {
|
24881
|
+
"text": "boolean"
|
24882
|
+
},
|
24883
|
+
"default": "false",
|
24884
|
+
"description": "readonly attribute of the input field. If true, the input field is read-only.",
|
24885
|
+
"fieldName": "readonly",
|
24886
|
+
"inheritedFrom": {
|
24887
|
+
"name": "Input",
|
24888
|
+
"module": "src/components/input/input.component.ts"
|
24889
|
+
}
|
24890
|
+
},
|
24891
|
+
{
|
24892
|
+
"name": "prefix-text",
|
24893
|
+
"type": {
|
24894
|
+
"text": "string | undefined"
|
24895
|
+
},
|
24896
|
+
"description": "The prefix text that is displayed before the input field. It has a max length of 10 characters.\nWhen the prefix text is set, make sure to set the 'data-aria-label'\nattribute with the appropriate value for accessibility.",
|
24897
|
+
"fieldName": "prefixText",
|
24898
|
+
"inheritedFrom": {
|
24899
|
+
"name": "Input",
|
24900
|
+
"module": "src/components/input/input.component.ts"
|
24901
|
+
}
|
24902
|
+
},
|
24903
|
+
{
|
24904
|
+
"name": "leading-icon",
|
24905
|
+
"type": {
|
24906
|
+
"text": "IconNames | undefined"
|
24907
|
+
},
|
24908
|
+
"description": "The leading icon that is displayed before the input field.",
|
24909
|
+
"fieldName": "leadingIcon",
|
24910
|
+
"inheritedFrom": {
|
24911
|
+
"name": "Input",
|
24912
|
+
"module": "src/components/input/input.component.ts"
|
24913
|
+
}
|
24914
|
+
},
|
24915
|
+
{
|
24916
|
+
"name": "trailing-button",
|
24917
|
+
"type": {
|
24918
|
+
"text": "boolean"
|
24919
|
+
},
|
24920
|
+
"default": "false",
|
24921
|
+
"description": "The trailing button when set to true, shows a clear button that clears the input field.",
|
24922
|
+
"fieldName": "trailingButton",
|
24923
|
+
"inheritedFrom": {
|
24924
|
+
"name": "Input",
|
24925
|
+
"module": "src/components/input/input.component.ts"
|
24926
|
+
}
|
24927
|
+
},
|
24928
|
+
{
|
24929
|
+
"name": "maxlength",
|
24930
|
+
"type": {
|
24931
|
+
"text": "number | undefined"
|
24932
|
+
},
|
24933
|
+
"description": "The maximum number of characters that the input field can accept.",
|
24934
|
+
"fieldName": "maxlength",
|
24935
|
+
"inheritedFrom": {
|
24936
|
+
"name": "Input",
|
24937
|
+
"module": "src/components/input/input.component.ts"
|
24938
|
+
}
|
24939
|
+
},
|
24940
|
+
{
|
24941
|
+
"name": "minlength",
|
24942
|
+
"type": {
|
24943
|
+
"text": "number | undefined"
|
24944
|
+
},
|
24945
|
+
"description": "The minimum number of characters that the input field can accept.",
|
24946
|
+
"fieldName": "minlength",
|
24557
24947
|
"inheritedFrom": {
|
24558
24948
|
"name": "Input",
|
24559
|
-
"module": "components/input/input.component.
|
24949
|
+
"module": "src/components/input/input.component.ts"
|
24560
24950
|
}
|
24561
24951
|
},
|
24562
24952
|
{
|
24563
|
-
"
|
24564
|
-
"
|
24565
|
-
|
24566
|
-
|
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
|
+
}
|
24567
24964
|
},
|
24568
24965
|
{
|
24569
|
-
"
|
24570
|
-
"
|
24571
|
-
|
24572
|
-
|
24966
|
+
"name": "autocomplete",
|
24967
|
+
"type": {
|
24968
|
+
"text": "AutoCompleteType"
|
24969
|
+
},
|
24970
|
+
"description": "The autocomplete attribute of the input field.",
|
24971
|
+
"default": "'off'",
|
24972
|
+
"fieldName": "autocomplete",
|
24573
24973
|
"inheritedFrom": {
|
24574
24974
|
"name": "Input",
|
24575
|
-
"module": "components/input/input.component.
|
24975
|
+
"module": "src/components/input/input.component.ts"
|
24576
24976
|
}
|
24577
24977
|
},
|
24578
24978
|
{
|
24579
|
-
"
|
24580
|
-
"name": "name",
|
24979
|
+
"name": "autofocus",
|
24581
24980
|
"type": {
|
24582
|
-
"text": "
|
24981
|
+
"text": "boolean"
|
24583
24982
|
},
|
24584
|
-
"default": "
|
24585
|
-
"description": "
|
24586
|
-
"
|
24587
|
-
"reflects": true,
|
24983
|
+
"default": "false",
|
24984
|
+
"description": "If true, the input field is focused when the component is rendered.",
|
24985
|
+
"fieldName": "autofocus",
|
24588
24986
|
"inheritedFrom": {
|
24589
|
-
"name": "
|
24590
|
-
"module": "
|
24987
|
+
"name": "Input",
|
24988
|
+
"module": "src/components/input/input.component.ts"
|
24591
24989
|
}
|
24592
24990
|
},
|
24593
24991
|
{
|
24594
|
-
"
|
24595
|
-
"name": "value",
|
24992
|
+
"name": "dirname",
|
24596
24993
|
"type": {
|
24597
|
-
"text": "string"
|
24994
|
+
"text": "string | undefined"
|
24598
24995
|
},
|
24599
|
-
"
|
24600
|
-
"
|
24601
|
-
"attribute": "value",
|
24602
|
-
"reflects": true,
|
24996
|
+
"description": "Specifies the name of the directionality of text for submission purposes (e.g., \"rtl\" for right-to-left).",
|
24997
|
+
"fieldName": "dirname",
|
24603
24998
|
"inheritedFrom": {
|
24604
|
-
"name": "
|
24605
|
-
"module": "
|
24999
|
+
"name": "Input",
|
25000
|
+
"module": "src/components/input/input.component.ts"
|
24606
25001
|
}
|
24607
25002
|
},
|
24608
25003
|
{
|
24609
|
-
"
|
24610
|
-
"name": "validationMessage",
|
25004
|
+
"name": "pattern",
|
24611
25005
|
"type": {
|
24612
25006
|
"text": "string | undefined"
|
24613
25007
|
},
|
24614
|
-
"description": "
|
24615
|
-
"
|
24616
|
-
"reflects": true,
|
25008
|
+
"description": "The pattern attribute of the input field.\nSpecifies a regular expression that the input value must match for validation purposes.",
|
25009
|
+
"fieldName": "pattern",
|
24617
25010
|
"inheritedFrom": {
|
24618
|
-
"name": "
|
24619
|
-
"module": "
|
25011
|
+
"name": "Input",
|
25012
|
+
"module": "src/components/input/input.component.ts"
|
24620
25013
|
}
|
24621
25014
|
},
|
24622
25015
|
{
|
24623
|
-
"
|
24624
|
-
"name": "validity",
|
25016
|
+
"name": "list",
|
24625
25017
|
"type": {
|
24626
|
-
"text": "
|
25018
|
+
"text": "string | undefined"
|
24627
25019
|
},
|
24628
|
-
"
|
25020
|
+
"description": "The list attribute of the input field.\nIdentifies a list of pre-defined options to suggest to the user.",
|
25021
|
+
"fieldName": "list",
|
24629
25022
|
"inheritedFrom": {
|
24630
|
-
"name": "
|
24631
|
-
"module": "
|
25023
|
+
"name": "Input",
|
25024
|
+
"module": "src/components/input/input.component.ts"
|
24632
25025
|
}
|
24633
25026
|
},
|
24634
25027
|
{
|
24635
|
-
"
|
24636
|
-
"
|
24637
|
-
|
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",
|
24638
25035
|
"inheritedFrom": {
|
24639
|
-
"name": "
|
24640
|
-
"module": "
|
25036
|
+
"name": "Input",
|
25037
|
+
"module": "src/components/input/input.component.ts"
|
24641
25038
|
}
|
24642
25039
|
},
|
24643
25040
|
{
|
24644
|
-
"
|
24645
|
-
"
|
24646
|
-
|
24647
|
-
"return": {
|
24648
|
-
"type": {
|
24649
|
-
"text": ""
|
24650
|
-
}
|
25041
|
+
"name": "clear-aria-label",
|
25042
|
+
"type": {
|
25043
|
+
"text": "string"
|
24651
25044
|
},
|
25045
|
+
"default": "''",
|
25046
|
+
"description": "Aria label for the trailing button. If trailing button is set to true, this label is used for the clear button.",
|
25047
|
+
"fieldName": "clearAriaLabel",
|
24652
25048
|
"inheritedFrom": {
|
24653
|
-
"name": "
|
24654
|
-
"module": "
|
25049
|
+
"name": "Input",
|
25050
|
+
"module": "src/components/input/input.component.ts"
|
24655
25051
|
}
|
24656
25052
|
},
|
24657
25053
|
{
|
24658
|
-
"
|
24659
|
-
"
|
24660
|
-
|
24661
|
-
"type": {
|
24662
|
-
"text": "boolean"
|
24663
|
-
}
|
25054
|
+
"name": "disabled",
|
25055
|
+
"type": {
|
25056
|
+
"text": "boolean | undefined"
|
24664
25057
|
},
|
25058
|
+
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
25059
|
+
"default": "undefined",
|
25060
|
+
"fieldName": "disabled",
|
24665
25061
|
"inheritedFrom": {
|
24666
|
-
"name": "
|
24667
|
-
"module": "
|
25062
|
+
"name": "FormfieldWrapper",
|
25063
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
24668
25064
|
}
|
24669
25065
|
},
|
24670
25066
|
{
|
24671
|
-
"
|
24672
|
-
"
|
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",
|
24673
25073
|
"inheritedFrom": {
|
24674
|
-
"name": "
|
24675
|
-
"module": "
|
25074
|
+
"name": "FormfieldWrapper",
|
25075
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
24676
25076
|
}
|
24677
25077
|
},
|
24678
25078
|
{
|
24679
|
-
"
|
24680
|
-
"name": "dataAriaLabel",
|
25079
|
+
"name": "required",
|
24681
25080
|
"type": {
|
24682
|
-
"text": "
|
25081
|
+
"text": "boolean"
|
24683
25082
|
},
|
24684
|
-
"default": "
|
24685
|
-
"description": "
|
24686
|
-
"
|
24687
|
-
"reflects": true,
|
25083
|
+
"default": "false",
|
25084
|
+
"description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
|
25085
|
+
"fieldName": "required",
|
24688
25086
|
"inheritedFrom": {
|
24689
|
-
"name": "
|
24690
|
-
"module": "
|
25087
|
+
"name": "FormfieldWrapper",
|
25088
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
24691
25089
|
}
|
24692
25090
|
},
|
24693
25091
|
{
|
24694
|
-
"
|
24695
|
-
"name": "placeholder",
|
25092
|
+
"name": "id",
|
24696
25093
|
"type": {
|
24697
25094
|
"text": "string"
|
24698
25095
|
},
|
24699
25096
|
"default": "''",
|
24700
|
-
"description": "The
|
24701
|
-
"
|
25097
|
+
"description": "The unique id of the input field. It is used to link the input field with the label.",
|
25098
|
+
"fieldName": "id",
|
24702
25099
|
"inheritedFrom": {
|
24703
|
-
"name": "
|
24704
|
-
"module": "components/
|
25100
|
+
"name": "FormfieldWrapper",
|
25101
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
24705
25102
|
}
|
24706
25103
|
},
|
24707
25104
|
{
|
24708
|
-
"
|
24709
|
-
"name": "readonly",
|
25105
|
+
"name": "help-text-type",
|
24710
25106
|
"type": {
|
24711
|
-
"text": "
|
25107
|
+
"text": "ValidationType"
|
24712
25108
|
},
|
24713
|
-
"
|
24714
|
-
"
|
24715
|
-
"attribute": "readonly",
|
25109
|
+
"description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
|
25110
|
+
"fieldName": "helpTextType",
|
24716
25111
|
"inheritedFrom": {
|
24717
|
-
"name": "
|
24718
|
-
"module": "components/
|
25112
|
+
"name": "FormfieldWrapper",
|
25113
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
24719
25114
|
}
|
24720
25115
|
},
|
24721
25116
|
{
|
24722
|
-
"
|
24723
|
-
"name": "prefixText",
|
25117
|
+
"name": "help-text",
|
24724
25118
|
"type": {
|
24725
25119
|
"text": "string | undefined"
|
24726
25120
|
},
|
24727
|
-
"description": "The
|
24728
|
-
"
|
25121
|
+
"description": "The help text that is displayed below the input field.",
|
25122
|
+
"fieldName": "helpText",
|
24729
25123
|
"inheritedFrom": {
|
24730
|
-
"name": "
|
24731
|
-
"module": "components/
|
25124
|
+
"name": "FormfieldWrapper",
|
25125
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
24732
25126
|
}
|
24733
|
-
}
|
25127
|
+
}
|
25128
|
+
],
|
25129
|
+
"cssProperties": [
|
24734
25130
|
{
|
24735
|
-
"
|
24736
|
-
"name": "
|
24737
|
-
"type": {
|
24738
|
-
"text": "IconNames | undefined"
|
24739
|
-
},
|
24740
|
-
"description": "The leading icon that is displayed before the input field.",
|
24741
|
-
"attribute": "leading-icon",
|
25131
|
+
"description": "Border color for the input container when disabled",
|
25132
|
+
"name": "--mdc-input-disabled-border-color",
|
24742
25133
|
"inheritedFrom": {
|
24743
25134
|
"name": "Input",
|
24744
|
-
"module": "components/input/input.component.
|
25135
|
+
"module": "src/components/input/input.component.ts"
|
24745
25136
|
}
|
24746
25137
|
},
|
24747
25138
|
{
|
24748
|
-
"
|
24749
|
-
"name": "
|
24750
|
-
"type": {
|
24751
|
-
"text": "boolean"
|
24752
|
-
},
|
24753
|
-
"default": "false",
|
24754
|
-
"description": "The trailing button when set to true, shows a clear button that clears the input field.",
|
24755
|
-
"attribute": "trailing-button",
|
25139
|
+
"description": "Text color for the input field when disabled",
|
25140
|
+
"name": "--mdc-input-disabled-text-color",
|
24756
25141
|
"inheritedFrom": {
|
24757
25142
|
"name": "Input",
|
24758
|
-
"module": "components/input/input.component.
|
25143
|
+
"module": "src/components/input/input.component.ts"
|
24759
25144
|
}
|
24760
25145
|
},
|
24761
25146
|
{
|
24762
|
-
"
|
24763
|
-
"name": "
|
24764
|
-
"type": {
|
24765
|
-
"text": "number | undefined"
|
24766
|
-
},
|
24767
|
-
"description": "The maximum number of characters that the input field can accept.",
|
24768
|
-
"attribute": "maxlength",
|
25147
|
+
"description": "Background color for the input field when disabled",
|
25148
|
+
"name": "--mdc-input-disabled-background-color",
|
24769
25149
|
"inheritedFrom": {
|
24770
25150
|
"name": "Input",
|
24771
|
-
"module": "components/input/input.component.
|
25151
|
+
"module": "src/components/input/input.component.ts"
|
24772
25152
|
}
|
24773
25153
|
},
|
24774
25154
|
{
|
24775
|
-
"
|
24776
|
-
"name": "
|
24777
|
-
"type": {
|
24778
|
-
"text": "number | undefined"
|
24779
|
-
},
|
24780
|
-
"description": "The minimum number of characters that the input field can accept.",
|
24781
|
-
"attribute": "minlength",
|
25155
|
+
"description": "Border color for the input container",
|
25156
|
+
"name": "--mdc-input-border-color",
|
24782
25157
|
"inheritedFrom": {
|
24783
25158
|
"name": "Input",
|
24784
|
-
"module": "components/input/input.component.
|
25159
|
+
"module": "src/components/input/input.component.ts"
|
24785
25160
|
}
|
24786
25161
|
},
|
24787
25162
|
{
|
24788
|
-
"
|
24789
|
-
"name": "
|
24790
|
-
"type": {
|
24791
|
-
"text": "AutoCapitalizeType"
|
24792
|
-
},
|
24793
|
-
"description": "The autocapitalize attribute of the input field.",
|
24794
|
-
"default": "'off'",
|
24795
|
-
"attribute": "autocapitalize",
|
25163
|
+
"description": "Text color for the input field",
|
25164
|
+
"name": "--mdc-input-text-color",
|
24796
25165
|
"inheritedFrom": {
|
24797
25166
|
"name": "Input",
|
24798
|
-
"module": "components/input/input.component.
|
25167
|
+
"module": "src/components/input/input.component.ts"
|
24799
25168
|
}
|
24800
25169
|
},
|
24801
25170
|
{
|
24802
|
-
"
|
24803
|
-
"name": "
|
24804
|
-
"type": {
|
24805
|
-
"text": "AutoCompleteType"
|
24806
|
-
},
|
24807
|
-
"description": "The autocomplete attribute of the input field.",
|
24808
|
-
"default": "'off'",
|
24809
|
-
"attribute": "autocomplete",
|
25171
|
+
"description": "Background color for the input field",
|
25172
|
+
"name": "--mdc-input-background-color",
|
24810
25173
|
"inheritedFrom": {
|
24811
25174
|
"name": "Input",
|
24812
|
-
"module": "components/input/input.component.
|
25175
|
+
"module": "src/components/input/input.component.ts"
|
24813
25176
|
}
|
24814
25177
|
},
|
24815
25178
|
{
|
24816
|
-
"
|
24817
|
-
"name": "
|
24818
|
-
"type": {
|
24819
|
-
"text": "boolean"
|
24820
|
-
},
|
24821
|
-
"default": "false",
|
24822
|
-
"description": "If true, the input field is focused when the component is rendered.",
|
24823
|
-
"attribute": "autofocus",
|
25179
|
+
"description": "Background color for the selected text",
|
25180
|
+
"name": "--mdc-input-selection-background-color",
|
24824
25181
|
"inheritedFrom": {
|
24825
25182
|
"name": "Input",
|
24826
|
-
"module": "components/input/input.component.
|
25183
|
+
"module": "src/components/input/input.component.ts"
|
24827
25184
|
}
|
24828
25185
|
},
|
24829
25186
|
{
|
24830
|
-
"
|
24831
|
-
"name": "
|
24832
|
-
"type": {
|
24833
|
-
"text": "string | undefined"
|
24834
|
-
},
|
24835
|
-
"description": "Specifies the name of the directionality of text for submission purposes (e.g., \"rtl\" for right-to-left).",
|
24836
|
-
"attribute": "dirname",
|
25187
|
+
"description": "Text color for the selected text",
|
25188
|
+
"name": "--mdc-input-selection-text-color",
|
24837
25189
|
"inheritedFrom": {
|
24838
25190
|
"name": "Input",
|
24839
|
-
"module": "components/input/input.component.
|
25191
|
+
"module": "src/components/input/input.component.ts"
|
24840
25192
|
}
|
24841
25193
|
},
|
24842
25194
|
{
|
24843
|
-
"
|
24844
|
-
"name": "
|
24845
|
-
"type": {
|
24846
|
-
"text": "string | undefined"
|
24847
|
-
},
|
24848
|
-
"description": "The pattern attribute of the input field.\nSpecifies a regular expression that the input value must match for validation purposes.",
|
24849
|
-
"attribute": "pattern",
|
25195
|
+
"description": "Text color for the help text",
|
25196
|
+
"name": "--mdc-input-support-text-color",
|
24850
25197
|
"inheritedFrom": {
|
24851
25198
|
"name": "Input",
|
24852
|
-
"module": "components/input/input.component.
|
25199
|
+
"module": "src/components/input/input.component.ts"
|
24853
25200
|
}
|
24854
25201
|
},
|
24855
25202
|
{
|
24856
|
-
"
|
24857
|
-
"name": "
|
24858
|
-
"type": {
|
24859
|
-
"text": "string | undefined"
|
24860
|
-
},
|
24861
|
-
"description": "The list attribute of the input field.\nIdentifies a list of pre-defined options to suggest to the user.",
|
24862
|
-
"attribute": "list",
|
25203
|
+
"description": "Background color for the input field when hovered",
|
25204
|
+
"name": "--mdc-input-hover-background-color",
|
24863
25205
|
"inheritedFrom": {
|
24864
25206
|
"name": "Input",
|
24865
|
-
"module": "components/input/input.component.
|
25207
|
+
"module": "src/components/input/input.component.ts"
|
24866
25208
|
}
|
24867
25209
|
},
|
24868
25210
|
{
|
24869
|
-
"
|
24870
|
-
"name": "
|
24871
|
-
"type": {
|
24872
|
-
"text": "number | undefined | undefined"
|
24873
|
-
},
|
24874
|
-
"description": "The size attribute of the input field.\nSpecifies the width of the input field.",
|
24875
|
-
"default": "undefined",
|
24876
|
-
"attribute": "size",
|
25211
|
+
"description": "Background color for the input field when focused",
|
25212
|
+
"name": "--mdc-input-focused-background-color",
|
24877
25213
|
"inheritedFrom": {
|
24878
25214
|
"name": "Input",
|
24879
|
-
"module": "components/input/input.component.
|
25215
|
+
"module": "src/components/input/input.component.ts"
|
24880
25216
|
}
|
24881
25217
|
},
|
24882
25218
|
{
|
24883
|
-
"
|
24884
|
-
"name": "
|
24885
|
-
"type": {
|
24886
|
-
"text": "string"
|
24887
|
-
},
|
24888
|
-
"default": "''",
|
24889
|
-
"description": "Aria label for the trailing button. If trailing button is set to true, this label is used for the clear button.",
|
24890
|
-
"attribute": "clear-aria-label",
|
25219
|
+
"description": "Border color for the input container when focused",
|
25220
|
+
"name": "--mdc-input-focused-border-color",
|
24891
25221
|
"inheritedFrom": {
|
24892
25222
|
"name": "Input",
|
24893
|
-
"module": "components/input/input.component.
|
25223
|
+
"module": "src/components/input/input.component.ts"
|
24894
25224
|
}
|
24895
25225
|
},
|
24896
25226
|
{
|
24897
|
-
"
|
24898
|
-
"name": "
|
24899
|
-
"description": "Handles the value change of the input field.\nSets the form value and updates the validity of the input field.",
|
24900
|
-
"return": {
|
24901
|
-
"type": {
|
24902
|
-
"text": ""
|
24903
|
-
}
|
24904
|
-
},
|
25227
|
+
"description": "Border color for the input container when error",
|
25228
|
+
"name": "--mdc-input-error-border-color",
|
24905
25229
|
"inheritedFrom": {
|
24906
25230
|
"name": "Input",
|
24907
|
-
"module": "components/input/input.component.
|
25231
|
+
"module": "src/components/input/input.component.ts"
|
24908
25232
|
}
|
24909
25233
|
},
|
24910
25234
|
{
|
24911
|
-
"
|
24912
|
-
"name": "
|
24913
|
-
"privacy": "private",
|
25235
|
+
"description": "Border color for the input container when warning",
|
25236
|
+
"name": "--mdc-input-warning-border-color",
|
24914
25237
|
"inheritedFrom": {
|
24915
25238
|
"name": "Input",
|
24916
|
-
"module": "components/input/input.component.
|
25239
|
+
"module": "src/components/input/input.component.ts"
|
24917
25240
|
}
|
24918
25241
|
},
|
24919
25242
|
{
|
24920
|
-
"
|
24921
|
-
"name": "
|
24922
|
-
"privacy": "private",
|
24923
|
-
"description": "Updates the value of the input field.\nSets the form value.",
|
24924
|
-
"return": {
|
24925
|
-
"type": {
|
24926
|
-
"text": ""
|
24927
|
-
}
|
24928
|
-
},
|
25243
|
+
"description": "Border color for the input container when success",
|
25244
|
+
"name": "--mdc-input-success-border-color",
|
24929
25245
|
"inheritedFrom": {
|
24930
25246
|
"name": "Input",
|
24931
|
-
"module": "components/input/input.component.
|
25247
|
+
"module": "src/components/input/input.component.ts"
|
24932
25248
|
}
|
24933
25249
|
},
|
24934
25250
|
{
|
24935
|
-
"
|
24936
|
-
"name": "
|
24937
|
-
"privacy": "private",
|
24938
|
-
"description": "Handles the input event of the input field.\nUpdates the value and sets the validity of the input field.",
|
25251
|
+
"description": "Border color for the input container when primary",
|
25252
|
+
"name": "--mdc-input-primary-border-color",
|
24939
25253
|
"inheritedFrom": {
|
24940
25254
|
"name": "Input",
|
24941
|
-
"module": "components/input/input.component.
|
25255
|
+
"module": "src/components/input/input.component.ts"
|
25256
|
+
}
|
25257
|
+
}
|
25258
|
+
],
|
25259
|
+
"events": [
|
25260
|
+
{
|
25261
|
+
"type": {
|
25262
|
+
"text": "EventConstructor"
|
25263
|
+
},
|
25264
|
+
"inheritedFrom": {
|
25265
|
+
"name": "Input",
|
25266
|
+
"module": "src/components/input/input.component.ts"
|
24942
25267
|
}
|
24943
25268
|
},
|
24944
25269
|
{
|
24945
|
-
"
|
24946
|
-
"name": "
|
24947
|
-
"
|
24948
|
-
"parameters": [
|
24949
|
-
{
|
24950
|
-
"name": "event",
|
24951
|
-
"type": {
|
24952
|
-
"text": "Event"
|
24953
|
-
},
|
24954
|
-
"description": "Event which contains information about the value change."
|
24955
|
-
}
|
24956
|
-
],
|
24957
|
-
"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",
|
25270
|
+
"description": "(React: onInput) This event is dispatched when the value of the input field changes (every press).",
|
25271
|
+
"name": "input",
|
25272
|
+
"reactName": "onInput",
|
24958
25273
|
"inheritedFrom": {
|
24959
25274
|
"name": "Input",
|
24960
|
-
"module": "components/input/input.component.
|
25275
|
+
"module": "src/components/input/input.component.ts"
|
24961
25276
|
}
|
24962
25277
|
},
|
24963
25278
|
{
|
24964
|
-
"
|
24965
|
-
"name": "
|
24966
|
-
"
|
24967
|
-
"description": "Renders the leading icon before the input field.\nIf the leading icon is not set, it will not be displayed.",
|
24968
|
-
"return": {
|
24969
|
-
"type": {
|
24970
|
-
"text": ""
|
24971
|
-
}
|
24972
|
-
},
|
25279
|
+
"description": "(React: onChange) This event is dispatched when the value of the input field changes (on blur).",
|
25280
|
+
"name": "change",
|
25281
|
+
"reactName": "onChange",
|
24973
25282
|
"inheritedFrom": {
|
24974
25283
|
"name": "Input",
|
24975
|
-
"module": "components/input/input.component.
|
25284
|
+
"module": "src/components/input/input.component.ts"
|
24976
25285
|
}
|
24977
25286
|
},
|
24978
25287
|
{
|
24979
|
-
"
|
24980
|
-
"name": "
|
24981
|
-
"
|
24982
|
-
"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.",
|
24983
|
-
"return": {
|
24984
|
-
"type": {
|
24985
|
-
"text": ""
|
24986
|
-
}
|
24987
|
-
},
|
25288
|
+
"description": "(React: onFocus) This event is dispatched when the input receives focus.",
|
25289
|
+
"name": "focus",
|
25290
|
+
"reactName": "onFocus",
|
24988
25291
|
"inheritedFrom": {
|
24989
25292
|
"name": "Input",
|
24990
|
-
"module": "components/input/input.component.
|
25293
|
+
"module": "src/components/input/input.component.ts"
|
24991
25294
|
}
|
24992
25295
|
},
|
24993
25296
|
{
|
24994
|
-
"
|
24995
|
-
"name": "
|
24996
|
-
"
|
24997
|
-
"parameters": [
|
24998
|
-
{
|
24999
|
-
"name": "show",
|
25000
|
-
"default": "false"
|
25001
|
-
}
|
25002
|
-
],
|
25003
|
-
"description": "Renders the trailing button to clear the input field if the trailingButton is set to true.",
|
25004
|
-
"return": {
|
25005
|
-
"type": {
|
25006
|
-
"text": ""
|
25007
|
-
}
|
25008
|
-
},
|
25297
|
+
"description": "(React: onBlur) This event is dispatched when the input loses focus.",
|
25298
|
+
"name": "blur",
|
25299
|
+
"reactName": "onBlur",
|
25009
25300
|
"inheritedFrom": {
|
25010
25301
|
"name": "Input",
|
25011
|
-
"module": "components/input/input.component.
|
25302
|
+
"module": "src/components/input/input.component.ts"
|
25012
25303
|
}
|
25304
|
+
}
|
25305
|
+
]
|
25306
|
+
}
|
25307
|
+
],
|
25308
|
+
"exports": [
|
25309
|
+
{
|
25310
|
+
"kind": "js",
|
25311
|
+
"name": "default",
|
25312
|
+
"declaration": {
|
25313
|
+
"name": "Searchfield",
|
25314
|
+
"module": "components/searchfield/searchfield.component.js"
|
25315
|
+
}
|
25316
|
+
}
|
25317
|
+
]
|
25318
|
+
},
|
25319
|
+
{
|
25320
|
+
"kind": "javascript-module",
|
25321
|
+
"path": "components/radiogroup/radiogroup.component.js",
|
25322
|
+
"declarations": [
|
25323
|
+
{
|
25324
|
+
"kind": "class",
|
25325
|
+
"description": "`mdc-radiogroup` - This is the wrapper component for radio buttons which are grouped together.\nIt can have a header text and a description. It enables users to select a single option from a set of options.\nIt is often used in forms, settings, and selection in lists. It automatically group the radio buttons inside it.",
|
25326
|
+
"name": "RadioGroup",
|
25327
|
+
"cssProperties": [
|
25328
|
+
{
|
25329
|
+
"description": "color of the description text",
|
25330
|
+
"name": "--mdc-radiogroup-description-text-normal"
|
25331
|
+
}
|
25332
|
+
],
|
25333
|
+
"members": [
|
25334
|
+
{
|
25335
|
+
"kind": "field",
|
25336
|
+
"name": "name",
|
25337
|
+
"type": {
|
25338
|
+
"text": "string"
|
25339
|
+
},
|
25340
|
+
"default": "''",
|
25341
|
+
"description": "Name of the radio group.\nThey are used to group elements in a form together.",
|
25342
|
+
"attribute": "name"
|
25013
25343
|
},
|
25014
25344
|
{
|
25015
|
-
"kind": "
|
25016
|
-
"name": "
|
25017
|
-
"
|
25018
|
-
|
25019
|
-
|
25020
|
-
|
25021
|
-
|
25022
|
-
|
25023
|
-
|
25024
|
-
},
|
25025
|
-
{
|
25026
|
-
"name": "hidePlaceholder",
|
25027
|
-
"default": "false"
|
25028
|
-
}
|
25029
|
-
],
|
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,
|
25030
25354
|
"inheritedFrom": {
|
25031
|
-
"name": "
|
25032
|
-
"module": "
|
25355
|
+
"name": "DataAriaLabelMixin",
|
25356
|
+
"module": "utils/mixins/DataAriaLabelMixin.js"
|
25033
25357
|
}
|
25034
25358
|
},
|
25035
25359
|
{
|
@@ -25063,12 +25387,13 @@
|
|
25063
25387
|
},
|
25064
25388
|
{
|
25065
25389
|
"kind": "field",
|
25066
|
-
"name": "
|
25390
|
+
"name": "required",
|
25067
25391
|
"type": {
|
25068
|
-
"text": "
|
25392
|
+
"text": "boolean"
|
25069
25393
|
},
|
25070
|
-
"
|
25071
|
-
"
|
25394
|
+
"default": "false",
|
25395
|
+
"description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
|
25396
|
+
"attribute": "required",
|
25072
25397
|
"reflects": true,
|
25073
25398
|
"inheritedFrom": {
|
25074
25399
|
"name": "FormfieldWrapper",
|
@@ -25132,15 +25457,6 @@
|
|
25132
25457
|
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
25133
25458
|
}
|
25134
25459
|
},
|
25135
|
-
{
|
25136
|
-
"kind": "method",
|
25137
|
-
"name": "renderRequiredLabel",
|
25138
|
-
"privacy": "protected",
|
25139
|
-
"inheritedFrom": {
|
25140
|
-
"name": "FormfieldWrapper",
|
25141
|
-
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
25142
|
-
}
|
25143
|
-
},
|
25144
25460
|
{
|
25145
25461
|
"kind": "method",
|
25146
25462
|
"name": "renderHelpTextIcon",
|
@@ -25202,251 +25518,27 @@
|
|
25202
25518
|
}
|
25203
25519
|
}
|
25204
25520
|
],
|
25205
|
-
"superclass": {
|
25206
|
-
"name": "Input",
|
25207
|
-
"module": "/src/components/input/input.component"
|
25208
|
-
},
|
25209
|
-
"tagName": "mdc-searchfield",
|
25210
|
-
"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 */",
|
25211
|
-
"customElement": true,
|
25212
25521
|
"attributes": [
|
25213
25522
|
{
|
25214
|
-
"name": "name",
|
25215
|
-
"type": {
|
25216
|
-
"text": "string"
|
25217
|
-
},
|
25218
|
-
"default": "''",
|
25219
|
-
"description": "Indicates the name of the component group.\nThey are used to group elements in a form together.",
|
25220
|
-
"fieldName": "name",
|
25221
|
-
"inheritedFrom": {
|
25222
|
-
"name": "FormInternalsMixin",
|
25223
|
-
"module": "src/utils/mixins/FormInternalsMixin.ts"
|
25224
|
-
}
|
25225
|
-
},
|
25226
|
-
{
|
25227
|
-
"name": "value",
|
25228
|
-
"type": {
|
25229
|
-
"text": "string"
|
25230
|
-
},
|
25231
|
-
"default": "''",
|
25232
|
-
"description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
|
25233
|
-
"fieldName": "value",
|
25234
|
-
"inheritedFrom": {
|
25235
|
-
"name": "FormInternalsMixin",
|
25236
|
-
"module": "src/utils/mixins/FormInternalsMixin.ts"
|
25237
|
-
}
|
25238
|
-
},
|
25239
|
-
{
|
25240
|
-
"name": "validation-message",
|
25241
|
-
"type": {
|
25242
|
-
"text": "string | undefined"
|
25243
|
-
},
|
25244
|
-
"description": "Custom validation message that will override the default message and displayed when the input is invalid.",
|
25245
|
-
"fieldName": "validationMessage",
|
25246
|
-
"inheritedFrom": {
|
25247
|
-
"name": "FormInternalsMixin",
|
25248
|
-
"module": "src/utils/mixins/FormInternalsMixin.ts"
|
25249
|
-
}
|
25250
|
-
},
|
25251
|
-
{
|
25252
|
-
"name": "data-aria-label",
|
25253
|
-
"type": {
|
25254
|
-
"text": "string | null"
|
25255
|
-
},
|
25256
|
-
"default": "null",
|
25257
|
-
"description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
|
25258
|
-
"fieldName": "dataAriaLabel",
|
25259
|
-
"inheritedFrom": {
|
25260
|
-
"name": "DataAriaLabelMixin",
|
25261
|
-
"module": "src/utils/mixins/DataAriaLabelMixin.ts"
|
25262
|
-
}
|
25263
|
-
},
|
25264
|
-
{
|
25265
|
-
"name": "placeholder",
|
25266
|
-
"type": {
|
25267
|
-
"text": "string"
|
25268
|
-
},
|
25269
|
-
"default": "''",
|
25270
|
-
"description": "The placeholder text that is displayed when the input field is empty.",
|
25271
|
-
"fieldName": "placeholder",
|
25272
|
-
"inheritedFrom": {
|
25273
|
-
"name": "Input",
|
25274
|
-
"module": "src/components/input/input.component.ts"
|
25275
|
-
}
|
25276
|
-
},
|
25277
|
-
{
|
25278
|
-
"name": "readonly",
|
25279
|
-
"type": {
|
25280
|
-
"text": "boolean"
|
25281
|
-
},
|
25282
|
-
"default": "false",
|
25283
|
-
"description": "readonly attribute of the input field. If true, the input field is read-only.",
|
25284
|
-
"fieldName": "readonly",
|
25285
|
-
"inheritedFrom": {
|
25286
|
-
"name": "Input",
|
25287
|
-
"module": "src/components/input/input.component.ts"
|
25288
|
-
}
|
25289
|
-
},
|
25290
|
-
{
|
25291
|
-
"name": "prefix-text",
|
25292
|
-
"type": {
|
25293
|
-
"text": "string | undefined"
|
25294
|
-
},
|
25295
|
-
"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.",
|
25296
|
-
"fieldName": "prefixText",
|
25297
|
-
"inheritedFrom": {
|
25298
|
-
"name": "Input",
|
25299
|
-
"module": "src/components/input/input.component.ts"
|
25300
|
-
}
|
25301
|
-
},
|
25302
|
-
{
|
25303
|
-
"name": "leading-icon",
|
25304
|
-
"type": {
|
25305
|
-
"text": "IconNames | undefined"
|
25306
|
-
},
|
25307
|
-
"description": "The leading icon that is displayed before the input field.",
|
25308
|
-
"fieldName": "leadingIcon",
|
25309
|
-
"inheritedFrom": {
|
25310
|
-
"name": "Input",
|
25311
|
-
"module": "src/components/input/input.component.ts"
|
25312
|
-
}
|
25313
|
-
},
|
25314
|
-
{
|
25315
|
-
"name": "trailing-button",
|
25316
|
-
"type": {
|
25317
|
-
"text": "boolean"
|
25318
|
-
},
|
25319
|
-
"default": "false",
|
25320
|
-
"description": "The trailing button when set to true, shows a clear button that clears the input field.",
|
25321
|
-
"fieldName": "trailingButton",
|
25322
|
-
"inheritedFrom": {
|
25323
|
-
"name": "Input",
|
25324
|
-
"module": "src/components/input/input.component.ts"
|
25325
|
-
}
|
25326
|
-
},
|
25327
|
-
{
|
25328
|
-
"name": "maxlength",
|
25329
|
-
"type": {
|
25330
|
-
"text": "number | undefined"
|
25331
|
-
},
|
25332
|
-
"description": "The maximum number of characters that the input field can accept.",
|
25333
|
-
"fieldName": "maxlength",
|
25334
|
-
"inheritedFrom": {
|
25335
|
-
"name": "Input",
|
25336
|
-
"module": "src/components/input/input.component.ts"
|
25337
|
-
}
|
25338
|
-
},
|
25339
|
-
{
|
25340
|
-
"name": "minlength",
|
25341
|
-
"type": {
|
25342
|
-
"text": "number | undefined"
|
25343
|
-
},
|
25344
|
-
"description": "The minimum number of characters that the input field can accept.",
|
25345
|
-
"fieldName": "minlength",
|
25346
|
-
"inheritedFrom": {
|
25347
|
-
"name": "Input",
|
25348
|
-
"module": "src/components/input/input.component.ts"
|
25349
|
-
}
|
25350
|
-
},
|
25351
|
-
{
|
25352
|
-
"name": "autocapitalize",
|
25353
|
-
"type": {
|
25354
|
-
"text": "AutoCapitalizeType"
|
25355
|
-
},
|
25356
|
-
"description": "The autocapitalize attribute of the input field.",
|
25357
|
-
"default": "'off'",
|
25358
|
-
"fieldName": "autocapitalize",
|
25359
|
-
"inheritedFrom": {
|
25360
|
-
"name": "Input",
|
25361
|
-
"module": "src/components/input/input.component.ts"
|
25362
|
-
}
|
25363
|
-
},
|
25364
|
-
{
|
25365
|
-
"name": "autocomplete",
|
25366
|
-
"type": {
|
25367
|
-
"text": "AutoCompleteType"
|
25368
|
-
},
|
25369
|
-
"description": "The autocomplete attribute of the input field.",
|
25370
|
-
"default": "'off'",
|
25371
|
-
"fieldName": "autocomplete",
|
25372
|
-
"inheritedFrom": {
|
25373
|
-
"name": "Input",
|
25374
|
-
"module": "src/components/input/input.component.ts"
|
25375
|
-
}
|
25376
|
-
},
|
25377
|
-
{
|
25378
|
-
"name": "autofocus",
|
25379
|
-
"type": {
|
25380
|
-
"text": "boolean"
|
25381
|
-
},
|
25382
|
-
"default": "false",
|
25383
|
-
"description": "If true, the input field is focused when the component is rendered.",
|
25384
|
-
"fieldName": "autofocus",
|
25385
|
-
"inheritedFrom": {
|
25386
|
-
"name": "Input",
|
25387
|
-
"module": "src/components/input/input.component.ts"
|
25388
|
-
}
|
25389
|
-
},
|
25390
|
-
{
|
25391
|
-
"name": "dirname",
|
25392
|
-
"type": {
|
25393
|
-
"text": "string | undefined"
|
25394
|
-
},
|
25395
|
-
"description": "Specifies the name of the directionality of text for submission purposes (e.g., \"rtl\" for right-to-left).",
|
25396
|
-
"fieldName": "dirname",
|
25397
|
-
"inheritedFrom": {
|
25398
|
-
"name": "Input",
|
25399
|
-
"module": "src/components/input/input.component.ts"
|
25400
|
-
}
|
25401
|
-
},
|
25402
|
-
{
|
25403
|
-
"name": "pattern",
|
25404
|
-
"type": {
|
25405
|
-
"text": "string | undefined"
|
25406
|
-
},
|
25407
|
-
"description": "The pattern attribute of the input field.\nSpecifies a regular expression that the input value must match for validation purposes.",
|
25408
|
-
"fieldName": "pattern",
|
25409
|
-
"inheritedFrom": {
|
25410
|
-
"name": "Input",
|
25411
|
-
"module": "src/components/input/input.component.ts"
|
25412
|
-
}
|
25413
|
-
},
|
25414
|
-
{
|
25415
|
-
"name": "list",
|
25416
|
-
"type": {
|
25417
|
-
"text": "string | undefined"
|
25418
|
-
},
|
25419
|
-
"description": "The list attribute of the input field.\nIdentifies a list of pre-defined options to suggest to the user.",
|
25420
|
-
"fieldName": "list",
|
25421
|
-
"inheritedFrom": {
|
25422
|
-
"name": "Input",
|
25423
|
-
"module": "src/components/input/input.component.ts"
|
25424
|
-
}
|
25425
|
-
},
|
25426
|
-
{
|
25427
|
-
"name": "size",
|
25428
|
-
"type": {
|
25429
|
-
"text": "number | undefined | undefined"
|
25430
|
-
},
|
25431
|
-
"description": "The size attribute of the input field.\nSpecifies the width of the input field.",
|
25432
|
-
"default": "undefined",
|
25433
|
-
"fieldName": "size",
|
25434
|
-
"inheritedFrom": {
|
25435
|
-
"name": "Input",
|
25436
|
-
"module": "src/components/input/input.component.ts"
|
25437
|
-
}
|
25438
|
-
},
|
25439
|
-
{
|
25440
|
-
"name": "clear-aria-label",
|
25523
|
+
"name": "name",
|
25441
25524
|
"type": {
|
25442
25525
|
"text": "string"
|
25443
25526
|
},
|
25444
25527
|
"default": "''",
|
25445
|
-
"description": "
|
25446
|
-
"fieldName": "
|
25528
|
+
"description": "Name of the radio group.\nThey are used to group elements in a form together.",
|
25529
|
+
"fieldName": "name"
|
25530
|
+
},
|
25531
|
+
{
|
25532
|
+
"name": "data-aria-label",
|
25533
|
+
"type": {
|
25534
|
+
"text": "string | null"
|
25535
|
+
},
|
25536
|
+
"default": "null",
|
25537
|
+
"description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
|
25538
|
+
"fieldName": "dataAriaLabel",
|
25447
25539
|
"inheritedFrom": {
|
25448
|
-
"name": "
|
25449
|
-
"module": "src/
|
25540
|
+
"name": "DataAriaLabelMixin",
|
25541
|
+
"module": "src/utils/mixins/DataAriaLabelMixin.ts"
|
25450
25542
|
}
|
25451
25543
|
},
|
25452
25544
|
{
|
@@ -25475,12 +25567,13 @@
|
|
25475
25567
|
}
|
25476
25568
|
},
|
25477
25569
|
{
|
25478
|
-
"name": "required
|
25570
|
+
"name": "required",
|
25479
25571
|
"type": {
|
25480
|
-
"text": "
|
25572
|
+
"text": "boolean"
|
25481
25573
|
},
|
25482
|
-
"
|
25483
|
-
"
|
25574
|
+
"default": "false",
|
25575
|
+
"description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
|
25576
|
+
"fieldName": "required",
|
25484
25577
|
"inheritedFrom": {
|
25485
25578
|
"name": "FormfieldWrapper",
|
25486
25579
|
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
@@ -25524,180 +25617,28 @@
|
|
25524
25617
|
}
|
25525
25618
|
}
|
25526
25619
|
],
|
25527
|
-
"
|
25528
|
-
|
25529
|
-
|
25530
|
-
|
25531
|
-
|
25532
|
-
|
25533
|
-
|
25534
|
-
|
25535
|
-
},
|
25536
|
-
{
|
25537
|
-
"description": "Text color for the input field when disabled",
|
25538
|
-
"name": "--mdc-input-disabled-text-color",
|
25539
|
-
"inheritedFrom": {
|
25540
|
-
"name": "Input",
|
25541
|
-
"module": "src/components/input/input.component.ts"
|
25542
|
-
}
|
25543
|
-
},
|
25544
|
-
{
|
25545
|
-
"description": "Background color for the input field when disabled",
|
25546
|
-
"name": "--mdc-input-disabled-background-color",
|
25547
|
-
"inheritedFrom": {
|
25548
|
-
"name": "Input",
|
25549
|
-
"module": "src/components/input/input.component.ts"
|
25550
|
-
}
|
25551
|
-
},
|
25552
|
-
{
|
25553
|
-
"description": "Border color for the input container",
|
25554
|
-
"name": "--mdc-input-border-color",
|
25555
|
-
"inheritedFrom": {
|
25556
|
-
"name": "Input",
|
25557
|
-
"module": "src/components/input/input.component.ts"
|
25558
|
-
}
|
25559
|
-
},
|
25560
|
-
{
|
25561
|
-
"description": "Text color for the input field",
|
25562
|
-
"name": "--mdc-input-text-color",
|
25563
|
-
"inheritedFrom": {
|
25564
|
-
"name": "Input",
|
25565
|
-
"module": "src/components/input/input.component.ts"
|
25566
|
-
}
|
25567
|
-
},
|
25568
|
-
{
|
25569
|
-
"description": "Background color for the input field",
|
25570
|
-
"name": "--mdc-input-background-color",
|
25571
|
-
"inheritedFrom": {
|
25572
|
-
"name": "Input",
|
25573
|
-
"module": "src/components/input/input.component.ts"
|
25574
|
-
}
|
25575
|
-
},
|
25576
|
-
{
|
25577
|
-
"description": "Background color for the selected text",
|
25578
|
-
"name": "--mdc-input-selection-background-color",
|
25579
|
-
"inheritedFrom": {
|
25580
|
-
"name": "Input",
|
25581
|
-
"module": "src/components/input/input.component.ts"
|
25582
|
-
}
|
25583
|
-
},
|
25584
|
-
{
|
25585
|
-
"description": "Text color for the selected text",
|
25586
|
-
"name": "--mdc-input-selection-text-color",
|
25587
|
-
"inheritedFrom": {
|
25588
|
-
"name": "Input",
|
25589
|
-
"module": "src/components/input/input.component.ts"
|
25590
|
-
}
|
25591
|
-
},
|
25592
|
-
{
|
25593
|
-
"description": "Text color for the help text",
|
25594
|
-
"name": "--mdc-input-support-text-color",
|
25595
|
-
"inheritedFrom": {
|
25596
|
-
"name": "Input",
|
25597
|
-
"module": "src/components/input/input.component.ts"
|
25598
|
-
}
|
25599
|
-
},
|
25600
|
-
{
|
25601
|
-
"description": "Background color for the input field when hovered",
|
25602
|
-
"name": "--mdc-input-hover-background-color",
|
25603
|
-
"inheritedFrom": {
|
25604
|
-
"name": "Input",
|
25605
|
-
"module": "src/components/input/input.component.ts"
|
25606
|
-
}
|
25607
|
-
},
|
25608
|
-
{
|
25609
|
-
"description": "Background color for the input field when focused",
|
25610
|
-
"name": "--mdc-input-focused-background-color",
|
25611
|
-
"inheritedFrom": {
|
25612
|
-
"name": "Input",
|
25613
|
-
"module": "src/components/input/input.component.ts"
|
25614
|
-
}
|
25615
|
-
},
|
25616
|
-
{
|
25617
|
-
"description": "Border color for the input container when focused",
|
25618
|
-
"name": "--mdc-input-focused-border-color",
|
25619
|
-
"inheritedFrom": {
|
25620
|
-
"name": "Input",
|
25621
|
-
"module": "src/components/input/input.component.ts"
|
25622
|
-
}
|
25623
|
-
},
|
25624
|
-
{
|
25625
|
-
"description": "Border color for the input container when error",
|
25626
|
-
"name": "--mdc-input-error-border-color",
|
25627
|
-
"inheritedFrom": {
|
25628
|
-
"name": "Input",
|
25629
|
-
"module": "src/components/input/input.component.ts"
|
25630
|
-
}
|
25631
|
-
},
|
25632
|
-
{
|
25633
|
-
"description": "Border color for the input container when warning",
|
25634
|
-
"name": "--mdc-input-warning-border-color",
|
25635
|
-
"inheritedFrom": {
|
25636
|
-
"name": "Input",
|
25637
|
-
"module": "src/components/input/input.component.ts"
|
25638
|
-
}
|
25639
|
-
},
|
25640
|
-
{
|
25641
|
-
"description": "Border color for the input container when success",
|
25642
|
-
"name": "--mdc-input-success-border-color",
|
25643
|
-
"inheritedFrom": {
|
25644
|
-
"name": "Input",
|
25645
|
-
"module": "src/components/input/input.component.ts"
|
25646
|
-
}
|
25647
|
-
},
|
25648
|
-
{
|
25649
|
-
"description": "Border color for the input container when primary",
|
25650
|
-
"name": "--mdc-input-primary-border-color",
|
25651
|
-
"inheritedFrom": {
|
25652
|
-
"name": "Input",
|
25653
|
-
"module": "src/components/input/input.component.ts"
|
25654
|
-
}
|
25655
|
-
}
|
25656
|
-
],
|
25657
|
-
"events": [
|
25658
|
-
{
|
25659
|
-
"type": {
|
25660
|
-
"text": "EventConstructor"
|
25661
|
-
},
|
25662
|
-
"inheritedFrom": {
|
25663
|
-
"name": "Input",
|
25664
|
-
"module": "src/components/input/input.component.ts"
|
25665
|
-
}
|
25666
|
-
},
|
25667
|
-
{
|
25668
|
-
"description": "(React: onInput) This event is dispatched when the value of the input field changes (every press).",
|
25669
|
-
"name": "input",
|
25670
|
-
"reactName": "onInput",
|
25671
|
-
"inheritedFrom": {
|
25672
|
-
"name": "Input",
|
25673
|
-
"module": "src/components/input/input.component.ts"
|
25674
|
-
}
|
25675
|
-
},
|
25676
|
-
{
|
25677
|
-
"description": "(React: onChange) This event is dispatched when the value of the input field changes (on blur).",
|
25678
|
-
"name": "change",
|
25679
|
-
"reactName": "onChange",
|
25680
|
-
"inheritedFrom": {
|
25681
|
-
"name": "Input",
|
25682
|
-
"module": "src/components/input/input.component.ts"
|
25683
|
-
}
|
25684
|
-
},
|
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": [
|
25685
25628
|
{
|
25686
|
-
"description": "
|
25687
|
-
"name": "
|
25688
|
-
"reactName": "onFocus",
|
25629
|
+
"description": "This is a default slot for checkbox or toggle components.",
|
25630
|
+
"name": "default",
|
25689
25631
|
"inheritedFrom": {
|
25690
|
-
"name": "
|
25691
|
-
"module": "src/components/
|
25632
|
+
"name": "FormfieldGroup",
|
25633
|
+
"module": "src/components/formfieldgroup/formfieldgroup.component.ts"
|
25692
25634
|
}
|
25693
25635
|
},
|
25694
25636
|
{
|
25695
|
-
"description": "
|
25696
|
-
"name": "
|
25697
|
-
"reactName": "onBlur",
|
25637
|
+
"description": "slot to add the label info icon",
|
25638
|
+
"name": "label-info",
|
25698
25639
|
"inheritedFrom": {
|
25699
|
-
"name": "
|
25700
|
-
"module": "src/components/
|
25640
|
+
"name": "FormfieldWrapper",
|
25641
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
25701
25642
|
}
|
25702
25643
|
}
|
25703
25644
|
]
|
@@ -25708,8 +25649,8 @@
|
|
25708
25649
|
"kind": "js",
|
25709
25650
|
"name": "default",
|
25710
25651
|
"declaration": {
|
25711
|
-
"name": "
|
25712
|
-
"module": "components/
|
25652
|
+
"name": "RadioGroup",
|
25653
|
+
"module": "components/radiogroup/radiogroup.component.js"
|
25713
25654
|
}
|
25714
25655
|
}
|
25715
25656
|
]
|
@@ -25853,12 +25794,6 @@
|
|
25853
25794
|
],
|
25854
25795
|
"description": "Sets the selected value based on the provided option element.\nIt retrieves the 'label' attribute of the option, if present,\notherwise it falls back to the option's text content."
|
25855
25796
|
},
|
25856
|
-
{
|
25857
|
-
"kind": "method",
|
25858
|
-
"name": "manageRequired",
|
25859
|
-
"privacy": "private",
|
25860
|
-
"description": "Manages the required state of the select.\nIf the value is not set and the requiredLabel property is set,\nthen the select is invalid."
|
25861
|
-
},
|
25862
25797
|
{
|
25863
25798
|
"kind": "method",
|
25864
25799
|
"name": "dispatchChange",
|
@@ -26236,12 +26171,13 @@
|
|
26236
26171
|
},
|
26237
26172
|
{
|
26238
26173
|
"kind": "field",
|
26239
|
-
"name": "
|
26174
|
+
"name": "required",
|
26240
26175
|
"type": {
|
26241
|
-
"text": "
|
26176
|
+
"text": "boolean"
|
26242
26177
|
},
|
26243
|
-
"
|
26244
|
-
"
|
26178
|
+
"default": "false",
|
26179
|
+
"description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
|
26180
|
+
"attribute": "required",
|
26245
26181
|
"reflects": true,
|
26246
26182
|
"inheritedFrom": {
|
26247
26183
|
"name": "FormfieldWrapper",
|
@@ -26305,15 +26241,6 @@
|
|
26305
26241
|
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
26306
26242
|
}
|
26307
26243
|
},
|
26308
|
-
{
|
26309
|
-
"kind": "method",
|
26310
|
-
"name": "renderRequiredLabel",
|
26311
|
-
"privacy": "protected",
|
26312
|
-
"inheritedFrom": {
|
26313
|
-
"name": "FormfieldWrapper",
|
26314
|
-
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
26315
|
-
}
|
26316
|
-
},
|
26317
26244
|
{
|
26318
26245
|
"kind": "method",
|
26319
26246
|
"name": "renderHelpTextIcon",
|
@@ -26504,12 +26431,13 @@
|
|
26504
26431
|
}
|
26505
26432
|
},
|
26506
26433
|
{
|
26507
|
-
"name": "required
|
26434
|
+
"name": "required",
|
26508
26435
|
"type": {
|
26509
|
-
"text": "
|
26436
|
+
"text": "boolean"
|
26510
26437
|
},
|
26511
|
-
"
|
26512
|
-
"
|
26438
|
+
"default": "false",
|
26439
|
+
"description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
|
26440
|
+
"fieldName": "required",
|
26513
26441
|
"inheritedFrom": {
|
26514
26442
|
"name": "FormfieldWrapper",
|
26515
26443
|
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
@@ -28147,7 +28075,7 @@
|
|
28147
28075
|
"declarations": [
|
28148
28076
|
{
|
28149
28077
|
"kind": "class",
|
28150
|
-
"description": "mdc-textarea component, which is used to get the multi-line text input from the user.\nIt contains:\n- label: It is the title of the textarea field.\n- required
|
28078
|
+
"description": "mdc-textarea component, which is used to get the multi-line text input from the user.\nIt contains:\n- label: It is the title of the textarea field.\n- required: A boolean attribute depicting that the textarea field is required.\n- Textarea: It is the multi-line text input field.\n- helper-text: It is the text that provides additional information about the textarea field.\n- max-character-limit: It is the text that shows the character count of the textarea field.\n- Error, Warning, Success, Priority Help Text type: It is the text that provides additional information\n about the textarea field based on the validation state.\n- limitexceeded: It is the event that is dispatched when the character limit exceeds or restored.\n This event exposes 3 properties:\n - currentCharacterCount - the current number of characters in the textarea field,\n - maxCharacterLimit - the maximum number of characters allowed in the textarea field,\n - value - the current value of the textarea field,\n\n**Note**: Consumers must set the help-text-type with 'error' and\nhelp-text attribute with the error message using limitexceeded event.\nThe same help-text value will be used for the validation message to be displayed.",
|
28151
28079
|
"name": "Textarea",
|
28152
28080
|
"cssProperties": [
|
28153
28081
|
{
|
@@ -28554,12 +28482,13 @@
|
|
28554
28482
|
},
|
28555
28483
|
{
|
28556
28484
|
"kind": "field",
|
28557
|
-
"name": "
|
28485
|
+
"name": "required",
|
28558
28486
|
"type": {
|
28559
|
-
"text": "
|
28487
|
+
"text": "boolean"
|
28560
28488
|
},
|
28561
|
-
"
|
28562
|
-
"
|
28489
|
+
"default": "false",
|
28490
|
+
"description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
|
28491
|
+
"attribute": "required",
|
28563
28492
|
"reflects": true,
|
28564
28493
|
"inheritedFrom": {
|
28565
28494
|
"name": "FormfieldWrapper",
|
@@ -28623,15 +28552,6 @@
|
|
28623
28552
|
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
28624
28553
|
}
|
28625
28554
|
},
|
28626
|
-
{
|
28627
|
-
"kind": "method",
|
28628
|
-
"name": "renderRequiredLabel",
|
28629
|
-
"privacy": "protected",
|
28630
|
-
"inheritedFrom": {
|
28631
|
-
"name": "FormfieldWrapper",
|
28632
|
-
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
28633
|
-
}
|
28634
|
-
},
|
28635
28555
|
{
|
28636
28556
|
"kind": "method",
|
28637
28557
|
"name": "renderHelpTextIcon",
|
@@ -28903,12 +28823,13 @@
|
|
28903
28823
|
}
|
28904
28824
|
},
|
28905
28825
|
{
|
28906
|
-
"name": "required
|
28826
|
+
"name": "required",
|
28907
28827
|
"type": {
|
28908
|
-
"text": "
|
28828
|
+
"text": "boolean"
|
28909
28829
|
},
|
28910
|
-
"
|
28911
|
-
"
|
28830
|
+
"default": "false",
|
28831
|
+
"description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
|
28832
|
+
"fieldName": "required",
|
28912
28833
|
"inheritedFrom": {
|
28913
28834
|
"name": "FormfieldWrapper",
|
28914
28835
|
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
@@ -28967,7 +28888,7 @@
|
|
28967
28888
|
"module": "/src/components/formfieldwrapper"
|
28968
28889
|
},
|
28969
28890
|
"tagName": "mdc-textarea",
|
28970
|
-
"jsDoc": "/**\n * mdc-textarea component, which is used to get the multi-line text input from the user.\n * It contains:\n * - label: It is the title of the textarea field.\n * - required
|
28891
|
+
"jsDoc": "/**\n * mdc-textarea component, which is used to get the multi-line text input from the user.\n * It contains:\n * - label: It is the title of the textarea field.\n * - required: A boolean attribute depicting that the textarea field is required.\n * - Textarea: It is the multi-line text input field.\n * - helper-text: It is the text that provides additional information about the textarea field.\n * - max-character-limit: It is the text that shows the character count of the textarea field.\n * - Error, Warning, Success, Priority Help Text type: It is the text that provides additional information\n * about the textarea field based on the validation state.\n * - limitexceeded: It is the event that is dispatched when the character limit exceeds or restored.\n * This event exposes 3 properties:\n * - currentCharacterCount - the current number of characters in the textarea field,\n * - maxCharacterLimit - the maximum number of characters allowed in the textarea field,\n * - value - the current value of the textarea field,\n *\n * **Note**: Consumers must set the help-text-type with 'error' and\n * help-text attribute with the error message using limitexceeded event.\n * The same help-text value will be used for the validation message to be displayed.\n *\n * @tagname mdc-textarea\n *\n * @event input - (React: onInput) This event is dispatched when the value of the textarea field changes (every press).\n * @event change - (React: onChange) This event is dispatched when the value of the textarea field changes (on blur).\n * @event focus - (React: onFocus) This event is dispatched when the textarea receives focus.\n * @event blur - (React: onBlur) This event is dispatched when the textarea loses focus.\n * @event limitexceeded - (React: onLimitExceeded) This event is dispatched once when the character limit\n * exceeds or restored.\n *\n *\n * @dependency mdc-icon\n * @dependency mdc-text\n * @dependency mdc-button\n *\n * @cssproperty --mdc-textarea-disabled-border-color - Border color for the textarea container when disabled\n * @cssproperty --mdc-textarea-disabled-text-color - Text color for the textarea field when disabled\n * @cssproperty --mdc-textarea-disabled-background-color - Background color for the textarea field when disabled\n * @cssproperty --mdc-textarea-text-color - Text color for the textarea field\n * @cssproperty --mdc-textarea-background-color - Background color for the textarea field\n * @cssproperty --mdc-textarea-border-color - Border color for the textarea field\n * @cssproperty --mdc-textarea-text-secondary-normal - Text color for the character counter\n * @cssproperty --mdc-textarea-error-border-color - Border color for the error related help text\n * @cssproperty --mdc-textarea-warning-border-color - Border color for the warning related help text\n * @cssproperty --mdc-textarea-success-border-color - Border color for the success related help text\n * @cssproperty --mdc-textarea-primary-border-color - Border color for the priority related help text\n * @cssproperty --mdc-textarea-hover-background-color - Background color for the textarea container when hover\n * @cssproperty --mdc-textarea-focused-background-color - Background color for the textarea container when focused\n * @cssproperty --mdc-textarea-focused-border-color - Border color for the textarea container when focused\n */",
|
28971
28892
|
"customElement": true,
|
28972
28893
|
"slots": [
|
28973
28894
|
{
|
@@ -29210,7 +29131,7 @@
|
|
29210
29131
|
"kind": "method",
|
29211
29132
|
"name": "manageRequired",
|
29212
29133
|
"privacy": "private",
|
29213
|
-
"description": "Manages the required state of the checkbox.\nIf the checkbox is not checked and the
|
29134
|
+
"description": "Manages the required state of the checkbox.\nIf the checkbox is not checked and the required property is set, then the checkbox is invalid.\nIf the validationMessage is set, it will be used as the custom validity message.\nIf the validationMessage is not set, it will clear the custom validity message."
|
29214
29135
|
},
|
29215
29136
|
{
|
29216
29137
|
"kind": "method",
|
@@ -29424,12 +29345,13 @@
|
|
29424
29345
|
},
|
29425
29346
|
{
|
29426
29347
|
"kind": "field",
|
29427
|
-
"name": "
|
29348
|
+
"name": "required",
|
29428
29349
|
"type": {
|
29429
|
-
"text": "
|
29350
|
+
"text": "boolean"
|
29430
29351
|
},
|
29431
|
-
"
|
29432
|
-
"
|
29352
|
+
"default": "false",
|
29353
|
+
"description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
|
29354
|
+
"attribute": "required",
|
29433
29355
|
"reflects": true,
|
29434
29356
|
"inheritedFrom": {
|
29435
29357
|
"name": "FormfieldWrapper",
|
@@ -29493,15 +29415,6 @@
|
|
29493
29415
|
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
29494
29416
|
}
|
29495
29417
|
},
|
29496
|
-
{
|
29497
|
-
"kind": "method",
|
29498
|
-
"name": "renderRequiredLabel",
|
29499
|
-
"privacy": "protected",
|
29500
|
-
"inheritedFrom": {
|
29501
|
-
"name": "FormfieldWrapper",
|
29502
|
-
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
29503
|
-
}
|
29504
|
-
},
|
29505
29418
|
{
|
29506
29419
|
"kind": "method",
|
29507
29420
|
"name": "renderHelpTextIcon",
|
@@ -29685,12 +29598,13 @@
|
|
29685
29598
|
}
|
29686
29599
|
},
|
29687
29600
|
{
|
29688
|
-
"name": "required
|
29601
|
+
"name": "required",
|
29689
29602
|
"type": {
|
29690
|
-
"text": "
|
29603
|
+
"text": "boolean"
|
29691
29604
|
},
|
29692
|
-
"
|
29693
|
-
"
|
29605
|
+
"default": "false",
|
29606
|
+
"description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
|
29607
|
+
"fieldName": "required",
|
29694
29608
|
"inheritedFrom": {
|
29695
29609
|
"name": "FormfieldWrapper",
|
29696
29610
|
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|