@momentum-design/components 0.83.3 → 0.83.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/browser/index.js +35 -35
- package/dist/browser/index.js.map +3 -3
- package/dist/components/dialog/dialog.component.d.ts +15 -10
- package/dist/components/dialog/dialog.component.js +19 -16
- package/dist/components/dialog/dialog.events.d.ts +9 -1
- package/dist/components/dialog/dialog.events.js +12 -2
- package/dist/components/dialog/dialog.types.d.ts +1 -0
- package/dist/custom-elements.json +986 -975
- package/dist/react/dialog/index.d.ts +8 -0
- package/dist/react/dialog/index.js +8 -0
- package/dist/react/index.d.ts +2 -2
- package/dist/react/index.js +2 -2
- package/package.json +1 -1
@@ -2203,6 +2203,138 @@
|
|
2203
2203
|
}
|
2204
2204
|
]
|
2205
2205
|
},
|
2206
|
+
{
|
2207
|
+
"kind": "javascript-module",
|
2208
|
+
"path": "components/buttongroup/buttongroup.component.js",
|
2209
|
+
"declarations": [
|
2210
|
+
{
|
2211
|
+
"kind": "class",
|
2212
|
+
"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.",
|
2213
|
+
"name": "ButtonGroup",
|
2214
|
+
"cssProperties": [
|
2215
|
+
{
|
2216
|
+
"description": "The border radius of the buttongroup",
|
2217
|
+
"name": "--mdc-buttongroup-border-radius"
|
2218
|
+
},
|
2219
|
+
{
|
2220
|
+
"description": "The border color of the buttongroup",
|
2221
|
+
"name": "--mdc-buttongroup-border-color"
|
2222
|
+
},
|
2223
|
+
{
|
2224
|
+
"description": "The color of the divider between buttons within the buttongroup",
|
2225
|
+
"name": "--mdc-buttongroup-divider-color"
|
2226
|
+
}
|
2227
|
+
],
|
2228
|
+
"slots": [
|
2229
|
+
{
|
2230
|
+
"description": "This is a default/unnamed slot, which contains the buttons",
|
2231
|
+
"name": "default"
|
2232
|
+
}
|
2233
|
+
],
|
2234
|
+
"members": [
|
2235
|
+
{
|
2236
|
+
"kind": "field",
|
2237
|
+
"name": "orientation",
|
2238
|
+
"type": {
|
2239
|
+
"text": "ButtonGroupOrientation"
|
2240
|
+
},
|
2241
|
+
"description": "Orientation of the buttongroup.",
|
2242
|
+
"default": "'horizontal'",
|
2243
|
+
"attribute": "orientation",
|
2244
|
+
"reflects": true
|
2245
|
+
},
|
2246
|
+
{
|
2247
|
+
"kind": "field",
|
2248
|
+
"name": "variant",
|
2249
|
+
"type": {
|
2250
|
+
"text": "ButtonGroupVariant"
|
2251
|
+
},
|
2252
|
+
"description": "Variant of the buttons within the buttongroup.",
|
2253
|
+
"default": "'primary'",
|
2254
|
+
"attribute": "variant",
|
2255
|
+
"reflects": true
|
2256
|
+
},
|
2257
|
+
{
|
2258
|
+
"kind": "field",
|
2259
|
+
"name": "size",
|
2260
|
+
"type": {
|
2261
|
+
"text": "ButtonGroupSize"
|
2262
|
+
},
|
2263
|
+
"description": "Size of the buttons within the buttongroup.",
|
2264
|
+
"default": "'28'",
|
2265
|
+
"attribute": "size",
|
2266
|
+
"reflects": true
|
2267
|
+
},
|
2268
|
+
{
|
2269
|
+
"kind": "field",
|
2270
|
+
"name": "compact",
|
2271
|
+
"type": {
|
2272
|
+
"text": "boolean"
|
2273
|
+
},
|
2274
|
+
"default": "false",
|
2275
|
+
"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.",
|
2276
|
+
"attribute": "compact",
|
2277
|
+
"reflects": true
|
2278
|
+
}
|
2279
|
+
],
|
2280
|
+
"attributes": [
|
2281
|
+
{
|
2282
|
+
"name": "orientation",
|
2283
|
+
"type": {
|
2284
|
+
"text": "ButtonGroupOrientation"
|
2285
|
+
},
|
2286
|
+
"description": "Orientation of the buttongroup.",
|
2287
|
+
"default": "'horizontal'",
|
2288
|
+
"fieldName": "orientation"
|
2289
|
+
},
|
2290
|
+
{
|
2291
|
+
"name": "variant",
|
2292
|
+
"type": {
|
2293
|
+
"text": "ButtonGroupVariant"
|
2294
|
+
},
|
2295
|
+
"description": "Variant of the buttons within the buttongroup.",
|
2296
|
+
"default": "'primary'",
|
2297
|
+
"fieldName": "variant"
|
2298
|
+
},
|
2299
|
+
{
|
2300
|
+
"name": "size",
|
2301
|
+
"type": {
|
2302
|
+
"text": "ButtonGroupSize"
|
2303
|
+
},
|
2304
|
+
"description": "Size of the buttons within the buttongroup.",
|
2305
|
+
"default": "'28'",
|
2306
|
+
"fieldName": "size"
|
2307
|
+
},
|
2308
|
+
{
|
2309
|
+
"name": "compact",
|
2310
|
+
"type": {
|
2311
|
+
"text": "boolean"
|
2312
|
+
},
|
2313
|
+
"default": "false",
|
2314
|
+
"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.",
|
2315
|
+
"fieldName": "compact"
|
2316
|
+
}
|
2317
|
+
],
|
2318
|
+
"superclass": {
|
2319
|
+
"name": "Component",
|
2320
|
+
"module": "/src/models"
|
2321
|
+
},
|
2322
|
+
"tagName": "mdc-buttongroup",
|
2323
|
+
"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 */",
|
2324
|
+
"customElement": true
|
2325
|
+
}
|
2326
|
+
],
|
2327
|
+
"exports": [
|
2328
|
+
{
|
2329
|
+
"kind": "js",
|
2330
|
+
"name": "default",
|
2331
|
+
"declaration": {
|
2332
|
+
"name": "ButtonGroup",
|
2333
|
+
"module": "components/buttongroup/buttongroup.component.js"
|
2334
|
+
}
|
2335
|
+
}
|
2336
|
+
]
|
2337
|
+
},
|
2206
2338
|
{
|
2207
2339
|
"kind": "javascript-module",
|
2208
2340
|
"path": "components/button/button.component.js",
|
@@ -2900,231 +3032,99 @@
|
|
2900
3032
|
},
|
2901
3033
|
{
|
2902
3034
|
"kind": "javascript-module",
|
2903
|
-
"path": "components/
|
3035
|
+
"path": "components/buttonlink/buttonlink.component.js",
|
2904
3036
|
"declarations": [
|
2905
3037
|
{
|
2906
3038
|
"kind": "class",
|
2907
|
-
"description": "
|
2908
|
-
"name": "
|
2909
|
-
"cssProperties": [
|
2910
|
-
{
|
2911
|
-
"description": "The border radius of the buttongroup",
|
2912
|
-
"name": "--mdc-buttongroup-border-radius"
|
2913
|
-
},
|
2914
|
-
{
|
2915
|
-
"description": "The border color of the buttongroup",
|
2916
|
-
"name": "--mdc-buttongroup-border-color"
|
2917
|
-
},
|
2918
|
-
{
|
2919
|
-
"description": "The color of the divider between buttons within the buttongroup",
|
2920
|
-
"name": "--mdc-buttongroup-divider-color"
|
2921
|
-
}
|
2922
|
-
],
|
2923
|
-
"slots": [
|
2924
|
-
{
|
2925
|
-
"description": "This is a default/unnamed slot, which contains the buttons",
|
2926
|
-
"name": "default"
|
2927
|
-
}
|
2928
|
-
],
|
3039
|
+
"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`.",
|
3040
|
+
"name": "ButtonLink",
|
2929
3041
|
"members": [
|
2930
3042
|
{
|
2931
3043
|
"kind": "field",
|
2932
|
-
"name": "
|
3044
|
+
"name": "size",
|
2933
3045
|
"type": {
|
2934
|
-
"text": "
|
3046
|
+
"text": "PillButtonSize | IconButtonSize"
|
2935
3047
|
},
|
2936
|
-
"description": "
|
2937
|
-
"default": "
|
2938
|
-
"attribute": "
|
3048
|
+
"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.",
|
3049
|
+
"default": "32",
|
3050
|
+
"attribute": "size",
|
2939
3051
|
"reflects": true
|
2940
3052
|
},
|
2941
3053
|
{
|
2942
3054
|
"kind": "field",
|
2943
|
-
"name": "
|
3055
|
+
"name": "softDisabled",
|
2944
3056
|
"type": {
|
2945
|
-
"text": "
|
3057
|
+
"text": "boolean | undefined"
|
2946
3058
|
},
|
2947
|
-
"description": "
|
2948
|
-
"default": "
|
2949
|
-
"attribute": "
|
3059
|
+
"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.",
|
3060
|
+
"default": "undefined",
|
3061
|
+
"attribute": "soft-disabled",
|
2950
3062
|
"reflects": true
|
2951
3063
|
},
|
2952
3064
|
{
|
2953
|
-
"kind": "
|
2954
|
-
"name": "
|
2955
|
-
"
|
2956
|
-
|
2957
|
-
|
2958
|
-
|
2959
|
-
|
2960
|
-
|
2961
|
-
|
3065
|
+
"kind": "method",
|
3066
|
+
"name": "setSoftDisabled",
|
3067
|
+
"privacy": "private",
|
3068
|
+
"parameters": [
|
3069
|
+
{
|
3070
|
+
"name": "element",
|
3071
|
+
"type": {
|
3072
|
+
"text": "HTMLElement"
|
3073
|
+
},
|
3074
|
+
"description": "The buttonlink element."
|
3075
|
+
},
|
3076
|
+
{
|
3077
|
+
"name": "softDisabled",
|
3078
|
+
"optional": true,
|
3079
|
+
"type": {
|
3080
|
+
"text": "boolean"
|
3081
|
+
},
|
3082
|
+
"description": "The soft-disabled state."
|
3083
|
+
}
|
3084
|
+
],
|
3085
|
+
"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."
|
2962
3086
|
},
|
2963
3087
|
{
|
2964
3088
|
"kind": "field",
|
2965
|
-
"name": "
|
3089
|
+
"name": "prefixIcon",
|
2966
3090
|
"type": {
|
2967
|
-
"text": "
|
3091
|
+
"text": "IconNames | undefined"
|
2968
3092
|
},
|
2969
|
-
"
|
2970
|
-
"
|
2971
|
-
"
|
2972
|
-
"
|
2973
|
-
|
2974
|
-
|
2975
|
-
|
3093
|
+
"description": "The name of the icon to display as a prefix.\nThe icon is displayed on the left side of the button.",
|
3094
|
+
"attribute": "prefix-icon",
|
3095
|
+
"reflects": true,
|
3096
|
+
"inheritedFrom": {
|
3097
|
+
"name": "ButtonComponentMixin",
|
3098
|
+
"module": "utils/mixins/ButtonComponentMixin.js"
|
3099
|
+
}
|
3100
|
+
},
|
2976
3101
|
{
|
2977
|
-
"
|
3102
|
+
"kind": "field",
|
3103
|
+
"name": "postfixIcon",
|
2978
3104
|
"type": {
|
2979
|
-
"text": "
|
3105
|
+
"text": "IconNames | undefined"
|
2980
3106
|
},
|
2981
|
-
"description": "
|
2982
|
-
"
|
2983
|
-
"
|
3107
|
+
"description": "The name of the icon to display as a postfix.\nThe icon is displayed on the right side of the button.",
|
3108
|
+
"attribute": "postfix-icon",
|
3109
|
+
"reflects": true,
|
3110
|
+
"inheritedFrom": {
|
3111
|
+
"name": "ButtonComponentMixin",
|
3112
|
+
"module": "utils/mixins/ButtonComponentMixin.js"
|
3113
|
+
}
|
2984
3114
|
},
|
2985
3115
|
{
|
3116
|
+
"kind": "field",
|
2986
3117
|
"name": "variant",
|
2987
3118
|
"type": {
|
2988
|
-
"text": "
|
3119
|
+
"text": "ButtonVariant"
|
2989
3120
|
},
|
2990
|
-
"description": "
|
2991
|
-
"default": "
|
2992
|
-
"
|
2993
|
-
|
2994
|
-
|
2995
|
-
|
2996
|
-
|
2997
|
-
"text": "ButtonGroupSize"
|
2998
|
-
},
|
2999
|
-
"description": "Size of the buttons within the buttongroup.",
|
3000
|
-
"default": "'28'",
|
3001
|
-
"fieldName": "size"
|
3002
|
-
},
|
3003
|
-
{
|
3004
|
-
"name": "compact",
|
3005
|
-
"type": {
|
3006
|
-
"text": "boolean"
|
3007
|
-
},
|
3008
|
-
"default": "false",
|
3009
|
-
"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.",
|
3010
|
-
"fieldName": "compact"
|
3011
|
-
}
|
3012
|
-
],
|
3013
|
-
"superclass": {
|
3014
|
-
"name": "Component",
|
3015
|
-
"module": "/src/models"
|
3016
|
-
},
|
3017
|
-
"tagName": "mdc-buttongroup",
|
3018
|
-
"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 */",
|
3019
|
-
"customElement": true
|
3020
|
-
}
|
3021
|
-
],
|
3022
|
-
"exports": [
|
3023
|
-
{
|
3024
|
-
"kind": "js",
|
3025
|
-
"name": "default",
|
3026
|
-
"declaration": {
|
3027
|
-
"name": "ButtonGroup",
|
3028
|
-
"module": "components/buttongroup/buttongroup.component.js"
|
3029
|
-
}
|
3030
|
-
}
|
3031
|
-
]
|
3032
|
-
},
|
3033
|
-
{
|
3034
|
-
"kind": "javascript-module",
|
3035
|
-
"path": "components/buttonlink/buttonlink.component.js",
|
3036
|
-
"declarations": [
|
3037
|
-
{
|
3038
|
-
"kind": "class",
|
3039
|
-
"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`.",
|
3040
|
-
"name": "ButtonLink",
|
3041
|
-
"members": [
|
3042
|
-
{
|
3043
|
-
"kind": "field",
|
3044
|
-
"name": "size",
|
3045
|
-
"type": {
|
3046
|
-
"text": "PillButtonSize | IconButtonSize"
|
3047
|
-
},
|
3048
|
-
"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.",
|
3049
|
-
"default": "32",
|
3050
|
-
"attribute": "size",
|
3051
|
-
"reflects": true
|
3052
|
-
},
|
3053
|
-
{
|
3054
|
-
"kind": "field",
|
3055
|
-
"name": "softDisabled",
|
3056
|
-
"type": {
|
3057
|
-
"text": "boolean | undefined"
|
3058
|
-
},
|
3059
|
-
"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.",
|
3060
|
-
"default": "undefined",
|
3061
|
-
"attribute": "soft-disabled",
|
3062
|
-
"reflects": true
|
3063
|
-
},
|
3064
|
-
{
|
3065
|
-
"kind": "method",
|
3066
|
-
"name": "setSoftDisabled",
|
3067
|
-
"privacy": "private",
|
3068
|
-
"parameters": [
|
3069
|
-
{
|
3070
|
-
"name": "element",
|
3071
|
-
"type": {
|
3072
|
-
"text": "HTMLElement"
|
3073
|
-
},
|
3074
|
-
"description": "The buttonlink element."
|
3075
|
-
},
|
3076
|
-
{
|
3077
|
-
"name": "softDisabled",
|
3078
|
-
"optional": true,
|
3079
|
-
"type": {
|
3080
|
-
"text": "boolean"
|
3081
|
-
},
|
3082
|
-
"description": "The soft-disabled state."
|
3083
|
-
}
|
3084
|
-
],
|
3085
|
-
"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."
|
3086
|
-
},
|
3087
|
-
{
|
3088
|
-
"kind": "field",
|
3089
|
-
"name": "prefixIcon",
|
3090
|
-
"type": {
|
3091
|
-
"text": "IconNames | undefined"
|
3092
|
-
},
|
3093
|
-
"description": "The name of the icon to display as a prefix.\nThe icon is displayed on the left side of the button.",
|
3094
|
-
"attribute": "prefix-icon",
|
3095
|
-
"reflects": true,
|
3096
|
-
"inheritedFrom": {
|
3097
|
-
"name": "ButtonComponentMixin",
|
3098
|
-
"module": "utils/mixins/ButtonComponentMixin.js"
|
3099
|
-
}
|
3100
|
-
},
|
3101
|
-
{
|
3102
|
-
"kind": "field",
|
3103
|
-
"name": "postfixIcon",
|
3104
|
-
"type": {
|
3105
|
-
"text": "IconNames | undefined"
|
3106
|
-
},
|
3107
|
-
"description": "The name of the icon to display as a postfix.\nThe icon is displayed on the right side of the button.",
|
3108
|
-
"attribute": "postfix-icon",
|
3109
|
-
"reflects": true,
|
3110
|
-
"inheritedFrom": {
|
3111
|
-
"name": "ButtonComponentMixin",
|
3112
|
-
"module": "utils/mixins/ButtonComponentMixin.js"
|
3113
|
-
}
|
3114
|
-
},
|
3115
|
-
{
|
3116
|
-
"kind": "field",
|
3117
|
-
"name": "variant",
|
3118
|
-
"type": {
|
3119
|
-
"text": "ButtonVariant"
|
3120
|
-
},
|
3121
|
-
"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.",
|
3122
|
-
"default": "primary",
|
3123
|
-
"attribute": "variant",
|
3124
|
-
"inheritedFrom": {
|
3125
|
-
"name": "ButtonComponentMixin",
|
3126
|
-
"module": "utils/mixins/ButtonComponentMixin.js"
|
3127
|
-
}
|
3121
|
+
"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.",
|
3122
|
+
"default": "primary",
|
3123
|
+
"attribute": "variant",
|
3124
|
+
"inheritedFrom": {
|
3125
|
+
"name": "ButtonComponentMixin",
|
3126
|
+
"module": "utils/mixins/ButtonComponentMixin.js"
|
3127
|
+
}
|
3128
3128
|
},
|
3129
3129
|
{
|
3130
3130
|
"kind": "field",
|
@@ -6454,71 +6454,56 @@
|
|
6454
6454
|
},
|
6455
6455
|
{
|
6456
6456
|
"kind": "javascript-module",
|
6457
|
-
"path": "components/
|
6457
|
+
"path": "components/checkbox/checkbox.component.js",
|
6458
6458
|
"declarations": [
|
6459
6459
|
{
|
6460
6460
|
"kind": "class",
|
6461
|
-
"description": "
|
6462
|
-
"name": "
|
6461
|
+
"description": "Checkboxes allow users to select multiple options from a list or turn an item/feature on or off.\nThese are often used in forms, settings, and selections in lists.\n\nA checkbox component contains an optional label and an optional helper text.\n\nTo create a group of checkboxes, use the FormFieldGroup component.",
|
6462
|
+
"name": "Checkbox",
|
6463
6463
|
"cssProperties": [
|
6464
6464
|
{
|
6465
|
-
"description": "
|
6466
|
-
"name": "--mdc-
|
6465
|
+
"description": "Allows customization of the background color on hover.",
|
6466
|
+
"name": "--mdc-checkbox-background-color-hover"
|
6467
6467
|
},
|
6468
6468
|
{
|
6469
|
-
"description": "
|
6470
|
-
"name": "--mdc-
|
6469
|
+
"description": "Background color for a selected checkbox when hovered.",
|
6470
|
+
"name": "--mdc-checkbox-checked-background-color-hover"
|
6471
6471
|
},
|
6472
6472
|
{
|
6473
|
-
"description": "
|
6474
|
-
"name": "--mdc-
|
6473
|
+
"description": "Background color for a selected checkbox when pressed.",
|
6474
|
+
"name": "--mdc-checkbox-checked-pressed-icon-color"
|
6475
|
+
},
|
6476
|
+
{
|
6477
|
+
"description": "Background color for a selected checkbox when pressed.",
|
6478
|
+
"name": "--mdc-checkbox-pressed-icon-color"
|
6479
|
+
},
|
6480
|
+
{
|
6481
|
+
"description": "Background color for a selected checkbox when disabled.",
|
6482
|
+
"name": "--mdc-checkbox-disabled-checked-icon-color"
|
6475
6483
|
}
|
6476
6484
|
],
|
6477
6485
|
"members": [
|
6478
6486
|
{
|
6479
6487
|
"kind": "field",
|
6480
|
-
"name": "
|
6488
|
+
"name": "checked",
|
6481
6489
|
"type": {
|
6482
|
-
"text": "
|
6490
|
+
"text": "boolean"
|
6483
6491
|
},
|
6484
|
-
"
|
6485
|
-
"
|
6486
|
-
"attribute": "
|
6492
|
+
"default": "false",
|
6493
|
+
"description": "Determines whether the checkbox is selected or unselected.",
|
6494
|
+
"attribute": "checked",
|
6487
6495
|
"reflects": true
|
6488
6496
|
},
|
6489
6497
|
{
|
6490
6498
|
"kind": "field",
|
6491
|
-
"name": "
|
6492
|
-
"type": {
|
6493
|
-
"text": "string"
|
6494
|
-
},
|
6495
|
-
"default": "''",
|
6496
|
-
"description": "The visible label text of the chip.\n\nWe recommend limiting the <b>maximum length of the label text to 20 characters</b>,\nincluding empty spaces to split words.",
|
6497
|
-
"attribute": "label"
|
6498
|
-
},
|
6499
|
-
{
|
6500
|
-
"kind": "method",
|
6501
|
-
"name": "renderIcon",
|
6502
|
-
"privacy": "private",
|
6503
|
-
"description": "Renders the icon element if available.",
|
6504
|
-
"return": {
|
6505
|
-
"type": {
|
6506
|
-
"text": ""
|
6507
|
-
}
|
6508
|
-
}
|
6509
|
-
},
|
6510
|
-
{
|
6511
|
-
"kind": "field",
|
6512
|
-
"name": "iconName",
|
6499
|
+
"name": "indeterminate",
|
6513
6500
|
"type": {
|
6514
|
-
"text": "
|
6501
|
+
"text": "boolean"
|
6515
6502
|
},
|
6516
|
-
"
|
6517
|
-
"
|
6518
|
-
"
|
6519
|
-
|
6520
|
-
"module": "utils/mixins/IconNameMixin.js"
|
6521
|
-
}
|
6503
|
+
"default": "false",
|
6504
|
+
"description": "This property is used to determine the parent checkbox in a nested checkbox group.\nIf any one of the children is unselected, then the parent checkbox will be indeterminate.\nIf all children are either selected or unselected, then the parent checkbox will not be indeterminate.",
|
6505
|
+
"attribute": "indeterminate",
|
6506
|
+
"reflects": true
|
6522
6507
|
},
|
6523
6508
|
{
|
6524
6509
|
"kind": "field",
|
@@ -6527,333 +6512,491 @@
|
|
6527
6512
|
"text": "boolean"
|
6528
6513
|
},
|
6529
6514
|
"default": "false",
|
6530
|
-
"description": "
|
6515
|
+
"description": "Automatically focus on the element when the page loads.\n[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/autofocus)",
|
6531
6516
|
"attribute": "autofocus",
|
6532
|
-
"reflects": true
|
6533
|
-
"inheritedFrom": {
|
6534
|
-
"name": "Buttonsimple",
|
6535
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
6536
|
-
}
|
6517
|
+
"reflects": true
|
6537
6518
|
},
|
6538
6519
|
{
|
6539
|
-
"kind": "
|
6540
|
-
"name": "
|
6541
|
-
"
|
6542
|
-
|
6543
|
-
},
|
6544
|
-
"default": "0",
|
6545
|
-
"description": "This property specifies the tab order of the element.",
|
6546
|
-
"attribute": "tabIndex",
|
6547
|
-
"reflects": true,
|
6548
|
-
"inheritedFrom": {
|
6549
|
-
"name": "Buttonsimple",
|
6550
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
6551
|
-
}
|
6520
|
+
"kind": "method",
|
6521
|
+
"name": "setFormValue",
|
6522
|
+
"privacy": "private",
|
6523
|
+
"description": "Updates the form value to reflect the current state of the checkbox.\nIf checked, the value is set to either the user-provided value or 'on' if no value is provided.\nIf unchecked, the value is set to null."
|
6552
6524
|
},
|
6553
6525
|
{
|
6554
|
-
"kind": "
|
6555
|
-
"name": "
|
6556
|
-
"
|
6557
|
-
|
6526
|
+
"kind": "method",
|
6527
|
+
"name": "manageRequired",
|
6528
|
+
"privacy": "private",
|
6529
|
+
"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."
|
6530
|
+
},
|
6531
|
+
{
|
6532
|
+
"kind": "method",
|
6533
|
+
"name": "toggleState",
|
6534
|
+
"privacy": "private",
|
6535
|
+
"return": {
|
6536
|
+
"type": {
|
6537
|
+
"text": "void"
|
6538
|
+
}
|
6558
6539
|
},
|
6559
|
-
"description": "
|
6560
|
-
|
6561
|
-
|
6562
|
-
"
|
6563
|
-
"
|
6564
|
-
|
6565
|
-
|
6566
|
-
|
6540
|
+
"description": "Toggles the state of the checkbox element.\nIf the element is not disabled, then\nthe checked property is toggled and the indeterminate property is set to false."
|
6541
|
+
},
|
6542
|
+
{
|
6543
|
+
"kind": "method",
|
6544
|
+
"name": "handleKeyDown",
|
6545
|
+
"privacy": "private",
|
6546
|
+
"return": {
|
6547
|
+
"type": {
|
6548
|
+
"text": "void"
|
6549
|
+
}
|
6550
|
+
},
|
6551
|
+
"parameters": [
|
6552
|
+
{
|
6553
|
+
"name": "event",
|
6554
|
+
"type": {
|
6555
|
+
"text": "KeyboardEvent"
|
6556
|
+
},
|
6557
|
+
"description": "The keyboard event."
|
6558
|
+
}
|
6559
|
+
],
|
6560
|
+
"description": "Handles the keydown event on the checkbox.\nWhen the user presses Enter, the form is submitted."
|
6561
|
+
},
|
6562
|
+
{
|
6563
|
+
"kind": "method",
|
6564
|
+
"name": "handleChange",
|
6565
|
+
"privacy": "public",
|
6566
|
+
"return": {
|
6567
|
+
"type": {
|
6568
|
+
"text": "void"
|
6569
|
+
}
|
6570
|
+
},
|
6571
|
+
"parameters": [
|
6572
|
+
{
|
6573
|
+
"name": "event",
|
6574
|
+
"type": {
|
6575
|
+
"text": "Event"
|
6576
|
+
}
|
6577
|
+
}
|
6578
|
+
],
|
6579
|
+
"description": "Toggles the state of the checkbox element.\nand dispatch the new change event."
|
6567
6580
|
},
|
6568
6581
|
{
|
6569
6582
|
"kind": "field",
|
6570
|
-
"name": "
|
6583
|
+
"name": "renderLabelAndHelperText",
|
6584
|
+
"privacy": "private"
|
6585
|
+
},
|
6586
|
+
{
|
6587
|
+
"kind": "field",
|
6588
|
+
"name": "name",
|
6571
6589
|
"type": {
|
6572
|
-
"text": "
|
6590
|
+
"text": "string"
|
6573
6591
|
},
|
6574
|
-
"
|
6575
|
-
"
|
6576
|
-
"attribute": "
|
6592
|
+
"default": "''",
|
6593
|
+
"description": "Indicates the name of the component group.\nThey are used to group elements in a form together.",
|
6594
|
+
"attribute": "name",
|
6577
6595
|
"reflects": true,
|
6578
6596
|
"inheritedFrom": {
|
6579
|
-
"name": "
|
6580
|
-
"module": "
|
6597
|
+
"name": "FormInternalsMixin",
|
6598
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
6581
6599
|
}
|
6582
6600
|
},
|
6583
6601
|
{
|
6584
6602
|
"kind": "field",
|
6585
|
-
"name": "
|
6603
|
+
"name": "value",
|
6604
|
+
"type": {
|
6605
|
+
"text": "string"
|
6606
|
+
},
|
6607
|
+
"default": "''",
|
6608
|
+
"description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
|
6609
|
+
"attribute": "value",
|
6610
|
+
"reflects": true,
|
6611
|
+
"inheritedFrom": {
|
6612
|
+
"name": "FormInternalsMixin",
|
6613
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
6614
|
+
}
|
6615
|
+
},
|
6616
|
+
{
|
6617
|
+
"kind": "field",
|
6618
|
+
"name": "validationMessage",
|
6619
|
+
"type": {
|
6620
|
+
"text": "string | undefined"
|
6621
|
+
},
|
6622
|
+
"description": "Custom validation message that will override the default message and displayed when the input is invalid.",
|
6623
|
+
"attribute": "validation-message",
|
6624
|
+
"reflects": true,
|
6625
|
+
"inheritedFrom": {
|
6626
|
+
"name": "FormInternalsMixin",
|
6627
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
6628
|
+
}
|
6629
|
+
},
|
6630
|
+
{
|
6631
|
+
"kind": "field",
|
6632
|
+
"name": "validity",
|
6633
|
+
"type": {
|
6634
|
+
"text": "ValidityState"
|
6635
|
+
},
|
6636
|
+
"readonly": true,
|
6637
|
+
"inheritedFrom": {
|
6638
|
+
"name": "FormInternalsMixin",
|
6639
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
6640
|
+
}
|
6641
|
+
},
|
6642
|
+
{
|
6643
|
+
"kind": "field",
|
6644
|
+
"name": "willValidate",
|
6645
|
+
"readonly": true,
|
6646
|
+
"inheritedFrom": {
|
6647
|
+
"name": "FormInternalsMixin",
|
6648
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
6649
|
+
}
|
6650
|
+
},
|
6651
|
+
{
|
6652
|
+
"kind": "method",
|
6653
|
+
"name": "setValidity",
|
6654
|
+
"description": "Sets the validity of the input field based on the input field's validity.",
|
6655
|
+
"return": {
|
6656
|
+
"type": {
|
6657
|
+
"text": ""
|
6658
|
+
}
|
6659
|
+
},
|
6660
|
+
"inheritedFrom": {
|
6661
|
+
"name": "FormInternalsMixin",
|
6662
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
6663
|
+
}
|
6664
|
+
},
|
6665
|
+
{
|
6666
|
+
"kind": "method",
|
6667
|
+
"name": "checkValidity",
|
6668
|
+
"return": {
|
6669
|
+
"type": {
|
6670
|
+
"text": "boolean"
|
6671
|
+
}
|
6672
|
+
},
|
6673
|
+
"inheritedFrom": {
|
6674
|
+
"name": "FormInternalsMixin",
|
6675
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
6676
|
+
}
|
6677
|
+
},
|
6678
|
+
{
|
6679
|
+
"kind": "method",
|
6680
|
+
"name": "reportValidity",
|
6681
|
+
"inheritedFrom": {
|
6682
|
+
"name": "FormInternalsMixin",
|
6683
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
6684
|
+
}
|
6685
|
+
},
|
6686
|
+
{
|
6687
|
+
"kind": "field",
|
6688
|
+
"name": "dataAriaLabel",
|
6689
|
+
"type": {
|
6690
|
+
"text": "string | null"
|
6691
|
+
},
|
6692
|
+
"default": "null",
|
6693
|
+
"description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
|
6694
|
+
"attribute": "data-aria-label",
|
6695
|
+
"reflects": true,
|
6696
|
+
"inheritedFrom": {
|
6697
|
+
"name": "DataAriaLabelMixin",
|
6698
|
+
"module": "utils/mixins/DataAriaLabelMixin.js"
|
6699
|
+
}
|
6700
|
+
},
|
6701
|
+
{
|
6702
|
+
"kind": "field",
|
6703
|
+
"name": "disabled",
|
6586
6704
|
"type": {
|
6587
6705
|
"text": "boolean | undefined"
|
6588
6706
|
},
|
6589
|
-
"description": "Indicates whether the
|
6707
|
+
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
6590
6708
|
"default": "undefined",
|
6591
|
-
"attribute": "
|
6709
|
+
"attribute": "disabled",
|
6592
6710
|
"reflects": true,
|
6593
6711
|
"inheritedFrom": {
|
6594
|
-
"name": "
|
6595
|
-
"module": "
|
6712
|
+
"name": "DisabledMixin",
|
6713
|
+
"module": "utils/mixins/DisabledMixin.js"
|
6596
6714
|
}
|
6597
6715
|
},
|
6598
6716
|
{
|
6599
6717
|
"kind": "field",
|
6600
|
-
"name": "
|
6718
|
+
"name": "label",
|
6601
6719
|
"type": {
|
6602
|
-
"text": "
|
6720
|
+
"text": "string | undefined"
|
6603
6721
|
},
|
6604
|
-
"description": "
|
6605
|
-
"
|
6606
|
-
"attribute": "size",
|
6722
|
+
"description": "The label of the input field. It is linked to the input field using the `for` attribute.",
|
6723
|
+
"attribute": "label",
|
6607
6724
|
"reflects": true,
|
6608
6725
|
"inheritedFrom": {
|
6609
|
-
"name": "
|
6610
|
-
"module": "components/
|
6726
|
+
"name": "FormfieldWrapper",
|
6727
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
6611
6728
|
}
|
6612
6729
|
},
|
6613
6730
|
{
|
6614
6731
|
"kind": "field",
|
6615
|
-
"name": "
|
6616
|
-
"
|
6617
|
-
|
6618
|
-
|
6732
|
+
"name": "required",
|
6733
|
+
"type": {
|
6734
|
+
"text": "boolean"
|
6735
|
+
},
|
6736
|
+
"default": "false",
|
6737
|
+
"description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
|
6738
|
+
"attribute": "required",
|
6619
6739
|
"reflects": true,
|
6620
6740
|
"inheritedFrom": {
|
6621
|
-
"name": "
|
6622
|
-
"module": "components/
|
6741
|
+
"name": "FormfieldWrapper",
|
6742
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
6623
6743
|
}
|
6624
6744
|
},
|
6625
6745
|
{
|
6626
6746
|
"kind": "field",
|
6627
|
-
"name": "
|
6747
|
+
"name": "id",
|
6628
6748
|
"type": {
|
6629
|
-
"text": "string
|
6749
|
+
"text": "string"
|
6630
6750
|
},
|
6631
|
-
"
|
6632
|
-
"
|
6633
|
-
"attribute": "
|
6751
|
+
"default": "''",
|
6752
|
+
"description": "The unique id of the input field. It is used to link the input field with the label.",
|
6753
|
+
"attribute": "id",
|
6754
|
+
"inheritedFrom": {
|
6755
|
+
"name": "FormfieldWrapper",
|
6756
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
6757
|
+
}
|
6758
|
+
},
|
6759
|
+
{
|
6760
|
+
"kind": "field",
|
6761
|
+
"name": "helpTextType",
|
6762
|
+
"type": {
|
6763
|
+
"text": "ValidationType"
|
6764
|
+
},
|
6765
|
+
"description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
|
6766
|
+
"attribute": "help-text-type",
|
6634
6767
|
"reflects": true,
|
6635
6768
|
"inheritedFrom": {
|
6636
|
-
"name": "
|
6637
|
-
"module": "components/
|
6769
|
+
"name": "FormfieldWrapper",
|
6770
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
6638
6771
|
}
|
6639
6772
|
},
|
6640
6773
|
{
|
6641
6774
|
"kind": "field",
|
6642
|
-
"name": "
|
6775
|
+
"name": "helpText",
|
6643
6776
|
"type": {
|
6644
|
-
"text": "
|
6777
|
+
"text": "string | undefined"
|
6645
6778
|
},
|
6646
|
-
"description": "
|
6647
|
-
"
|
6648
|
-
"attribute": "type",
|
6779
|
+
"description": "The help text that is displayed below the input field.",
|
6780
|
+
"attribute": "help-text",
|
6649
6781
|
"reflects": true,
|
6650
6782
|
"inheritedFrom": {
|
6651
|
-
"name": "
|
6652
|
-
"module": "components/
|
6783
|
+
"name": "FormfieldWrapper",
|
6784
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
6653
6785
|
}
|
6654
6786
|
},
|
6655
6787
|
{
|
6656
|
-
"kind": "
|
6657
|
-
"name": "
|
6658
|
-
"
|
6788
|
+
"kind": "field",
|
6789
|
+
"name": "toggletipText",
|
6790
|
+
"type": {
|
6791
|
+
"text": "string | undefined"
|
6792
|
+
},
|
6793
|
+
"description": "The toggletip text that is displayed when the label is hovered.\nIt is used to provide additional information about the label.",
|
6794
|
+
"attribute": "toggletip-text",
|
6795
|
+
"reflects": true,
|
6659
6796
|
"inheritedFrom": {
|
6660
|
-
"name": "
|
6661
|
-
"module": "components/
|
6797
|
+
"name": "FormfieldWrapper",
|
6798
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
6662
6799
|
}
|
6663
6800
|
},
|
6664
6801
|
{
|
6665
|
-
"kind": "
|
6666
|
-
"name": "
|
6667
|
-
"
|
6668
|
-
|
6669
|
-
|
6670
|
-
|
6671
|
-
|
6672
|
-
|
6673
|
-
|
6674
|
-
"description": "The button element"
|
6675
|
-
},
|
6676
|
-
{
|
6677
|
-
"name": "active",
|
6678
|
-
"optional": true,
|
6679
|
-
"type": {
|
6680
|
-
"text": "boolean"
|
6681
|
-
},
|
6682
|
-
"description": "The active state of the element"
|
6683
|
-
}
|
6684
|
-
],
|
6685
|
-
"description": "Sets the ariaStateKey attributes based on the active state of the button.",
|
6802
|
+
"kind": "field",
|
6803
|
+
"name": "toggletipPlacement",
|
6804
|
+
"type": {
|
6805
|
+
"text": "PopoverPlacement"
|
6806
|
+
},
|
6807
|
+
"description": "The placement of the toggletip that is displayed when the info icon is hovered.",
|
6808
|
+
"default": "'top'",
|
6809
|
+
"attribute": "toggletip-placement",
|
6810
|
+
"reflects": true,
|
6686
6811
|
"inheritedFrom": {
|
6687
|
-
"name": "
|
6688
|
-
"module": "components/
|
6812
|
+
"name": "FormfieldWrapper",
|
6813
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
6689
6814
|
}
|
6690
6815
|
},
|
6691
6816
|
{
|
6692
|
-
"kind": "
|
6693
|
-
"name": "
|
6694
|
-
"
|
6695
|
-
|
6696
|
-
|
6697
|
-
|
6698
|
-
|
6699
|
-
|
6700
|
-
},
|
6701
|
-
"description": "The button element."
|
6702
|
-
},
|
6703
|
-
{
|
6704
|
-
"name": "softDisabled",
|
6705
|
-
"optional": true,
|
6706
|
-
"type": {
|
6707
|
-
"text": "boolean"
|
6708
|
-
},
|
6709
|
-
"description": "The soft-disabled state."
|
6710
|
-
}
|
6711
|
-
],
|
6712
|
-
"description": "Sets the soft-disabled attribute for the button.\nWhen soft-disabled, the button looks to be disabled but remains focusable and clickable.\nAlso sets/removes aria-disabled attribute.",
|
6817
|
+
"kind": "field",
|
6818
|
+
"name": "infoIconAriaLabel",
|
6819
|
+
"type": {
|
6820
|
+
"text": "string | undefined"
|
6821
|
+
},
|
6822
|
+
"description": "Aria label for the info icon that is displayed next to the label when `toggletipText` is set.\nThis is used for accessibility purposes to provide a description of the icon.",
|
6823
|
+
"attribute": "info-icon-aria-label",
|
6824
|
+
"reflects": true,
|
6713
6825
|
"inheritedFrom": {
|
6714
|
-
"name": "
|
6715
|
-
"module": "components/
|
6826
|
+
"name": "FormfieldWrapper",
|
6827
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
6716
6828
|
}
|
6717
6829
|
},
|
6718
6830
|
{
|
6719
6831
|
"kind": "method",
|
6720
|
-
"name": "
|
6721
|
-
"privacy": "
|
6722
|
-
"
|
6723
|
-
|
6724
|
-
|
6725
|
-
"
|
6726
|
-
"text": "HTMLElement"
|
6727
|
-
},
|
6728
|
-
"description": "The button element."
|
6729
|
-
},
|
6730
|
-
{
|
6731
|
-
"name": "disabled",
|
6732
|
-
"type": {
|
6733
|
-
"text": "boolean"
|
6734
|
-
},
|
6735
|
-
"description": "The disabled state."
|
6832
|
+
"name": "renderLabelElement",
|
6833
|
+
"privacy": "protected",
|
6834
|
+
"description": "creates the label element when the label property is set.\nid is used to link the label with the input field.",
|
6835
|
+
"return": {
|
6836
|
+
"type": {
|
6837
|
+
"text": ""
|
6736
6838
|
}
|
6737
|
-
|
6738
|
-
"description": "Sets the disabled attribute for the button.\nWhen disabled, the button is not focusable or clickable, and tabindex is set to -1.\nThe previous tabindex is stored and restored when enabled.\nAlso sets/removes aria-disabled attribute.",
|
6839
|
+
},
|
6739
6840
|
"inheritedFrom": {
|
6740
|
-
"name": "
|
6741
|
-
"module": "components/
|
6841
|
+
"name": "FormfieldWrapper",
|
6842
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
6742
6843
|
}
|
6743
6844
|
},
|
6744
6845
|
{
|
6745
6846
|
"kind": "method",
|
6746
|
-
"name": "
|
6747
|
-
"privacy": "
|
6847
|
+
"name": "renderHelpTextIcon",
|
6848
|
+
"privacy": "protected",
|
6849
|
+
"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.",
|
6850
|
+
"return": {
|
6851
|
+
"type": {
|
6852
|
+
"text": ""
|
6853
|
+
}
|
6854
|
+
},
|
6748
6855
|
"inheritedFrom": {
|
6749
|
-
"name": "
|
6750
|
-
"module": "components/
|
6856
|
+
"name": "FormfieldWrapper",
|
6857
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
6751
6858
|
}
|
6752
6859
|
},
|
6753
6860
|
{
|
6754
6861
|
"kind": "method",
|
6755
|
-
"name": "
|
6756
|
-
"privacy": "
|
6757
|
-
"description": "
|
6862
|
+
"name": "renderHelpText",
|
6863
|
+
"privacy": "protected",
|
6864
|
+
"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.",
|
6865
|
+
"return": {
|
6866
|
+
"type": {
|
6867
|
+
"text": ""
|
6868
|
+
}
|
6869
|
+
},
|
6758
6870
|
"inheritedFrom": {
|
6759
|
-
"name": "
|
6760
|
-
"module": "components/
|
6871
|
+
"name": "FormfieldWrapper",
|
6872
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
6761
6873
|
}
|
6762
6874
|
},
|
6763
6875
|
{
|
6764
6876
|
"kind": "method",
|
6765
|
-
"name": "
|
6766
|
-
"privacy": "
|
6767
|
-
"
|
6768
|
-
|
6769
|
-
|
6770
|
-
"
|
6771
|
-
"text": "KeyboardEvent"
|
6772
|
-
},
|
6773
|
-
"description": "The keyboard event."
|
6877
|
+
"name": "renderLabel",
|
6878
|
+
"privacy": "protected",
|
6879
|
+
"description": "renders the mdc-label-text container that contains the label and labelInfoToggleTip.",
|
6880
|
+
"return": {
|
6881
|
+
"type": {
|
6882
|
+
"text": ""
|
6774
6883
|
}
|
6775
|
-
|
6776
|
-
"description": "Handles the keydown event on the button.\nIf the key is 'Enter' or 'Space', the button is pressed.\nIf the key is 'Enter', the button is pressed. The native HTML button works in the same way.\nIf the key is 'Space', the button's default is prevent to avoid scrolling etc in the host application.",
|
6884
|
+
},
|
6777
6885
|
"inheritedFrom": {
|
6778
|
-
"name": "
|
6779
|
-
"module": "components/
|
6886
|
+
"name": "FormfieldWrapper",
|
6887
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
6780
6888
|
}
|
6781
6889
|
},
|
6782
6890
|
{
|
6783
6891
|
"kind": "method",
|
6784
|
-
"name": "
|
6785
|
-
"privacy": "
|
6786
|
-
"
|
6787
|
-
|
6788
|
-
|
6789
|
-
"
|
6790
|
-
"text": "KeyboardEvent"
|
6791
|
-
},
|
6792
|
-
"description": "The keyboard event."
|
6892
|
+
"name": "renderHelperText",
|
6893
|
+
"privacy": "protected",
|
6894
|
+
"description": "renders the mdc-help-text container that contains the helpertext icon and helpertext.",
|
6895
|
+
"return": {
|
6896
|
+
"type": {
|
6897
|
+
"text": ""
|
6793
6898
|
}
|
6794
|
-
|
6795
|
-
"description": "Handles the keyup event on the button.\nIf the key is 'Enter' or 'Space', the button is clicked.\nIf the key is 'Space', the button is pressed. The native HTML button works in the same way.",
|
6899
|
+
},
|
6796
6900
|
"inheritedFrom": {
|
6797
|
-
"name": "
|
6798
|
-
"module": "components/
|
6901
|
+
"name": "FormfieldWrapper",
|
6902
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
6799
6903
|
}
|
6800
6904
|
}
|
6801
6905
|
],
|
6906
|
+
"events": [
|
6907
|
+
{
|
6908
|
+
"type": {
|
6909
|
+
"text": "EventConstructor"
|
6910
|
+
}
|
6911
|
+
},
|
6912
|
+
{
|
6913
|
+
"description": "(React: onChange) Event that gets dispatched when the checkbox state changes.",
|
6914
|
+
"name": "change",
|
6915
|
+
"reactName": "onChange"
|
6916
|
+
},
|
6917
|
+
{
|
6918
|
+
"description": "(React: onFocus) Event that gets dispatched when the checkbox receives focus.",
|
6919
|
+
"name": "focus",
|
6920
|
+
"reactName": "onFocus"
|
6921
|
+
}
|
6922
|
+
],
|
6802
6923
|
"attributes": [
|
6803
6924
|
{
|
6804
|
-
"name": "
|
6925
|
+
"name": "checked",
|
6805
6926
|
"type": {
|
6806
|
-
"text": "
|
6927
|
+
"text": "boolean"
|
6807
6928
|
},
|
6808
|
-
"
|
6809
|
-
"
|
6810
|
-
"fieldName": "
|
6929
|
+
"default": "false",
|
6930
|
+
"description": "Determines whether the checkbox is selected or unselected.",
|
6931
|
+
"fieldName": "checked"
|
6811
6932
|
},
|
6812
6933
|
{
|
6813
|
-
"name": "
|
6934
|
+
"name": "indeterminate",
|
6935
|
+
"type": {
|
6936
|
+
"text": "boolean"
|
6937
|
+
},
|
6938
|
+
"default": "false",
|
6939
|
+
"description": "This property is used to determine the parent checkbox in a nested checkbox group.\nIf any one of the children is unselected, then the parent checkbox will be indeterminate.\nIf all children are either selected or unselected, then the parent checkbox will not be indeterminate.",
|
6940
|
+
"fieldName": "indeterminate"
|
6941
|
+
},
|
6942
|
+
{
|
6943
|
+
"name": "autofocus",
|
6944
|
+
"type": {
|
6945
|
+
"text": "boolean"
|
6946
|
+
},
|
6947
|
+
"default": "false",
|
6948
|
+
"description": "Automatically focus on the element when the page loads.\n[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/autofocus)",
|
6949
|
+
"fieldName": "autofocus"
|
6950
|
+
},
|
6951
|
+
{
|
6952
|
+
"name": "name",
|
6814
6953
|
"type": {
|
6815
6954
|
"text": "string"
|
6816
6955
|
},
|
6817
6956
|
"default": "''",
|
6818
|
-
"description": "
|
6819
|
-
"fieldName": "
|
6957
|
+
"description": "Indicates the name of the component group.\nThey are used to group elements in a form together.",
|
6958
|
+
"fieldName": "name",
|
6959
|
+
"inheritedFrom": {
|
6960
|
+
"name": "FormInternalsMixin",
|
6961
|
+
"module": "src/utils/mixins/FormInternalsMixin.ts"
|
6962
|
+
}
|
6820
6963
|
},
|
6821
6964
|
{
|
6822
|
-
"name": "
|
6965
|
+
"name": "value",
|
6823
6966
|
"type": {
|
6824
|
-
"text": "
|
6967
|
+
"text": "string"
|
6825
6968
|
},
|
6826
|
-
"
|
6827
|
-
"
|
6969
|
+
"default": "''",
|
6970
|
+
"description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
|
6971
|
+
"fieldName": "value",
|
6828
6972
|
"inheritedFrom": {
|
6829
|
-
"name": "
|
6830
|
-
"module": "src/utils/mixins/
|
6973
|
+
"name": "FormInternalsMixin",
|
6974
|
+
"module": "src/utils/mixins/FormInternalsMixin.ts"
|
6831
6975
|
}
|
6832
6976
|
},
|
6833
6977
|
{
|
6834
|
-
"name": "
|
6978
|
+
"name": "validation-message",
|
6835
6979
|
"type": {
|
6836
|
-
"text": "
|
6980
|
+
"text": "string | undefined"
|
6837
6981
|
},
|
6838
|
-
"
|
6839
|
-
"
|
6840
|
-
"fieldName": "autofocus",
|
6982
|
+
"description": "Custom validation message that will override the default message and displayed when the input is invalid.",
|
6983
|
+
"fieldName": "validationMessage",
|
6841
6984
|
"inheritedFrom": {
|
6842
|
-
"name": "
|
6843
|
-
"module": "src/
|
6985
|
+
"name": "FormInternalsMixin",
|
6986
|
+
"module": "src/utils/mixins/FormInternalsMixin.ts"
|
6844
6987
|
}
|
6845
6988
|
},
|
6846
6989
|
{
|
6847
|
-
"name": "
|
6990
|
+
"name": "data-aria-label",
|
6848
6991
|
"type": {
|
6849
|
-
"text": "
|
6992
|
+
"text": "string | null"
|
6850
6993
|
},
|
6851
|
-
"default": "
|
6852
|
-
"description": "
|
6853
|
-
"fieldName": "
|
6994
|
+
"default": "null",
|
6995
|
+
"description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
|
6996
|
+
"fieldName": "dataAriaLabel",
|
6854
6997
|
"inheritedFrom": {
|
6855
|
-
"name": "
|
6856
|
-
"module": "src/
|
6998
|
+
"name": "DataAriaLabelMixin",
|
6999
|
+
"module": "src/utils/mixins/DataAriaLabelMixin.ts"
|
6857
7000
|
}
|
6858
7001
|
},
|
6859
7002
|
{
|
@@ -6865,137 +7008,127 @@
|
|
6865
7008
|
"default": "undefined",
|
6866
7009
|
"fieldName": "disabled",
|
6867
7010
|
"inheritedFrom": {
|
6868
|
-
"name": "
|
6869
|
-
"module": "src/
|
7011
|
+
"name": "DisabledMixin",
|
7012
|
+
"module": "src/utils/mixins/DisabledMixin.ts"
|
6870
7013
|
}
|
6871
7014
|
},
|
6872
7015
|
{
|
6873
|
-
"name": "
|
7016
|
+
"name": "label",
|
6874
7017
|
"type": {
|
6875
|
-
"text": "
|
7018
|
+
"text": "string | undefined"
|
6876
7019
|
},
|
6877
|
-
"description": "The
|
6878
|
-
"
|
6879
|
-
"fieldName": "active",
|
7020
|
+
"description": "The label of the input field. It is linked to the input field using the `for` attribute.",
|
7021
|
+
"fieldName": "label",
|
6880
7022
|
"inheritedFrom": {
|
6881
|
-
"name": "
|
6882
|
-
"module": "src/components/
|
7023
|
+
"name": "FormfieldWrapper",
|
7024
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
6883
7025
|
}
|
6884
7026
|
},
|
6885
7027
|
{
|
6886
|
-
"name": "
|
7028
|
+
"name": "required",
|
6887
7029
|
"type": {
|
6888
|
-
"text": "boolean
|
7030
|
+
"text": "boolean"
|
6889
7031
|
},
|
6890
|
-
"
|
6891
|
-
"
|
6892
|
-
"fieldName": "
|
7032
|
+
"default": "false",
|
7033
|
+
"description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
|
7034
|
+
"fieldName": "required",
|
6893
7035
|
"inheritedFrom": {
|
6894
|
-
"name": "
|
6895
|
-
"module": "src/components/
|
7036
|
+
"name": "FormfieldWrapper",
|
7037
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
6896
7038
|
}
|
6897
7039
|
},
|
6898
7040
|
{
|
6899
|
-
"name": "
|
7041
|
+
"name": "id",
|
6900
7042
|
"type": {
|
6901
|
-
"text": "
|
7043
|
+
"text": "string"
|
6902
7044
|
},
|
6903
|
-
"
|
6904
|
-
"
|
6905
|
-
"fieldName": "
|
7045
|
+
"default": "''",
|
7046
|
+
"description": "The unique id of the input field. It is used to link the input field with the label.",
|
7047
|
+
"fieldName": "id",
|
6906
7048
|
"inheritedFrom": {
|
6907
|
-
"name": "
|
6908
|
-
"module": "src/components/
|
7049
|
+
"name": "FormfieldWrapper",
|
7050
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
6909
7051
|
}
|
6910
7052
|
},
|
6911
7053
|
{
|
6912
|
-
"name": "
|
6913
|
-
"
|
6914
|
-
|
6915
|
-
|
7054
|
+
"name": "help-text-type",
|
7055
|
+
"type": {
|
7056
|
+
"text": "ValidationType"
|
7057
|
+
},
|
7058
|
+
"description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
|
7059
|
+
"fieldName": "helpTextType",
|
6916
7060
|
"inheritedFrom": {
|
6917
|
-
"name": "
|
6918
|
-
"module": "src/components/
|
7061
|
+
"name": "FormfieldWrapper",
|
7062
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
6919
7063
|
}
|
6920
7064
|
},
|
6921
7065
|
{
|
6922
|
-
"name": "
|
7066
|
+
"name": "help-text",
|
6923
7067
|
"type": {
|
6924
7068
|
"text": "string | undefined"
|
6925
7069
|
},
|
6926
|
-
"description": "
|
6927
|
-
"
|
6928
|
-
"fieldName": "ariaStateKey",
|
7070
|
+
"description": "The help text that is displayed below the input field.",
|
7071
|
+
"fieldName": "helpText",
|
6929
7072
|
"inheritedFrom": {
|
6930
|
-
"name": "
|
6931
|
-
"module": "src/components/
|
7073
|
+
"name": "FormfieldWrapper",
|
7074
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
6932
7075
|
}
|
6933
7076
|
},
|
6934
7077
|
{
|
6935
|
-
"name": "
|
7078
|
+
"name": "toggletip-text",
|
6936
7079
|
"type": {
|
6937
|
-
"text": "
|
7080
|
+
"text": "string | undefined"
|
6938
7081
|
},
|
6939
|
-
"description": "
|
6940
|
-
"
|
6941
|
-
"fieldName": "type",
|
6942
|
-
"inheritedFrom": {
|
6943
|
-
"name": "Buttonsimple",
|
6944
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
6945
|
-
}
|
6946
|
-
}
|
6947
|
-
],
|
6948
|
-
"mixins": [
|
6949
|
-
{
|
6950
|
-
"name": "IconNameMixin",
|
6951
|
-
"module": "/src/utils/mixins/IconNameMixin"
|
6952
|
-
}
|
6953
|
-
],
|
6954
|
-
"superclass": {
|
6955
|
-
"name": "Buttonsimple",
|
6956
|
-
"module": "/src/components/buttonsimple/buttonsimple.component"
|
6957
|
-
},
|
6958
|
-
"tagName": "mdc-chip",
|
6959
|
-
"jsDoc": "/**\n * mdc-chip is an interactive element that can be used to represent a chip. It supports a leading icon along with label.\n * Consumers can wrap this component around a tooltip to provide additional context.\n *\n * It is recommended to keep the label text for the chip component concise and compact.\n * For best results, we recommend limiting the <b>maximum length of the label text to 20 characters</b>,\n * including empty spaces to split words.\n *\n * This component is built by extending Buttonsimple.\n *\n * @tagname mdc-chip\n *\n * @dependency mdc-icon\n * @dependency mdc-text\n *\n * @cssproperty --mdc-chip-color - The color of the chip.\n * @cssproperty --mdc-chip-border-color - The border color of the chip.\n * @cssproperty --mdc-chip-background-color - The background color of the chip.\n *\n */",
|
6960
|
-
"customElement": true,
|
6961
|
-
"events": [
|
6962
|
-
{
|
6963
|
-
"description": "(React: onClick) This event is dispatched when the button is clicked.",
|
6964
|
-
"name": "click",
|
6965
|
-
"reactName": "onClick",
|
7082
|
+
"description": "The toggletip text that is displayed when the label is hovered.\nIt is used to provide additional information about the label.",
|
7083
|
+
"fieldName": "toggletipText",
|
6966
7084
|
"inheritedFrom": {
|
6967
|
-
"name": "
|
6968
|
-
"module": "src/components/
|
7085
|
+
"name": "FormfieldWrapper",
|
7086
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
6969
7087
|
}
|
6970
7088
|
},
|
6971
7089
|
{
|
6972
|
-
"
|
6973
|
-
"
|
6974
|
-
|
7090
|
+
"name": "toggletip-placement",
|
7091
|
+
"type": {
|
7092
|
+
"text": "PopoverPlacement"
|
7093
|
+
},
|
7094
|
+
"description": "The placement of the toggletip that is displayed when the info icon is hovered.",
|
7095
|
+
"default": "'top'",
|
7096
|
+
"fieldName": "toggletipPlacement",
|
6975
7097
|
"inheritedFrom": {
|
6976
|
-
"name": "
|
6977
|
-
"module": "src/components/
|
7098
|
+
"name": "FormfieldWrapper",
|
7099
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
6978
7100
|
}
|
6979
7101
|
},
|
6980
7102
|
{
|
6981
|
-
"
|
6982
|
-
"
|
6983
|
-
|
7103
|
+
"name": "info-icon-aria-label",
|
7104
|
+
"type": {
|
7105
|
+
"text": "string | undefined"
|
7106
|
+
},
|
7107
|
+
"description": "Aria label for the info icon that is displayed next to the label when `toggletipText` is set.\nThis is used for accessibility purposes to provide a description of the icon.",
|
7108
|
+
"fieldName": "infoIconAriaLabel",
|
6984
7109
|
"inheritedFrom": {
|
6985
|
-
"name": "
|
6986
|
-
"module": "src/components/
|
7110
|
+
"name": "FormfieldWrapper",
|
7111
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
6987
7112
|
}
|
7113
|
+
}
|
7114
|
+
],
|
7115
|
+
"mixins": [
|
7116
|
+
{
|
7117
|
+
"name": "FormInternalsMixin",
|
7118
|
+
"module": "/src/utils/mixins/FormInternalsMixin"
|
6988
7119
|
},
|
6989
7120
|
{
|
6990
|
-
"
|
6991
|
-
"
|
6992
|
-
"reactName": "onFocus",
|
6993
|
-
"inheritedFrom": {
|
6994
|
-
"name": "Buttonsimple",
|
6995
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
6996
|
-
}
|
7121
|
+
"name": "DataAriaLabelMixin",
|
7122
|
+
"module": "/src/utils/mixins/DataAriaLabelMixin"
|
6997
7123
|
}
|
6998
|
-
]
|
7124
|
+
],
|
7125
|
+
"superclass": {
|
7126
|
+
"name": "FormfieldWrapper",
|
7127
|
+
"module": "/src/components/formfieldwrapper/formfieldwrapper.component"
|
7128
|
+
},
|
7129
|
+
"tagName": "mdc-checkbox",
|
7130
|
+
"jsDoc": "/**\n * Checkboxes allow users to select multiple options from a list or turn an item/feature on or off.\n * These are often used in forms, settings, and selections in lists.\n *\n * A checkbox component contains an optional label and an optional helper text.\n *\n * To create a group of checkboxes, use the FormFieldGroup component.\n *\n * @dependency mdc-button\n * @dependency mdc-icon\n * @dependency mdc-staticcheckbox\n * @dependency mdc-text\n * @dependency mdc-toggletip\n *\n * @tagname mdc-checkbox\n *\n * @event change - (React: onChange) Event that gets dispatched when the checkbox state changes.\n * @event focus - (React: onFocus) Event that gets dispatched when the checkbox receives focus.\n *\n * @cssproperty --mdc-checkbox-background-color-hover - Allows customization of the background color on hover.\n * @cssproperty --mdc-checkbox-checked-background-color-hover - Background color for a selected checkbox when hovered.\n * @cssproperty --mdc-checkbox-checked-pressed-icon-color - Background color for a selected checkbox when pressed.\n * @cssproperty --mdc-checkbox-pressed-icon-color - Background color for a selected checkbox when pressed.\n * @cssproperty --mdc-checkbox-disabled-checked-icon-color - Background color for a selected checkbox when disabled.\n */",
|
7131
|
+
"customElement": true
|
6999
7132
|
}
|
7000
7133
|
],
|
7001
7134
|
"exports": [
|
@@ -7003,256 +7136,108 @@
|
|
7003
7136
|
"kind": "js",
|
7004
7137
|
"name": "default",
|
7005
7138
|
"declaration": {
|
7006
|
-
"name": "
|
7007
|
-
"module": "components/
|
7139
|
+
"name": "Checkbox",
|
7140
|
+
"module": "components/checkbox/checkbox.component.js"
|
7008
7141
|
}
|
7009
7142
|
}
|
7010
7143
|
]
|
7011
7144
|
},
|
7012
7145
|
{
|
7013
7146
|
"kind": "javascript-module",
|
7014
|
-
"path": "components/
|
7147
|
+
"path": "components/chip/chip.component.js",
|
7015
7148
|
"declarations": [
|
7016
7149
|
{
|
7017
7150
|
"kind": "class",
|
7018
|
-
"description": "
|
7019
|
-
"name": "
|
7151
|
+
"description": "mdc-chip is an interactive element that can be used to represent a chip. It supports a leading icon along with label.\nConsumers can wrap this component around a tooltip to provide additional context.\n\nIt is recommended to keep the label text for the chip component concise and compact.\nFor best results, we recommend limiting the <b>maximum length of the label text to 20 characters</b>,\nincluding empty spaces to split words.\n\nThis component is built by extending Buttonsimple.",
|
7152
|
+
"name": "Chip",
|
7020
7153
|
"cssProperties": [
|
7021
7154
|
{
|
7022
|
-
"description": "
|
7023
|
-
"name": "--mdc-
|
7024
|
-
},
|
7025
|
-
{
|
7026
|
-
"description": "Background color for a selected checkbox when hovered.",
|
7027
|
-
"name": "--mdc-checkbox-checked-background-color-hover"
|
7028
|
-
},
|
7029
|
-
{
|
7030
|
-
"description": "Background color for a selected checkbox when pressed.",
|
7031
|
-
"name": "--mdc-checkbox-checked-pressed-icon-color"
|
7155
|
+
"description": "The color of the chip.",
|
7156
|
+
"name": "--mdc-chip-color"
|
7032
7157
|
},
|
7033
7158
|
{
|
7034
|
-
"description": "
|
7035
|
-
"name": "--mdc-
|
7159
|
+
"description": "The border color of the chip.",
|
7160
|
+
"name": "--mdc-chip-border-color"
|
7036
7161
|
},
|
7037
7162
|
{
|
7038
|
-
"description": "
|
7039
|
-
"name": "--mdc-
|
7163
|
+
"description": "The background color of the chip.",
|
7164
|
+
"name": "--mdc-chip-background-color"
|
7040
7165
|
}
|
7041
7166
|
],
|
7042
7167
|
"members": [
|
7043
7168
|
{
|
7044
7169
|
"kind": "field",
|
7045
|
-
"name": "
|
7046
|
-
"type": {
|
7047
|
-
"text": "boolean"
|
7048
|
-
},
|
7049
|
-
"default": "false",
|
7050
|
-
"description": "Determines whether the checkbox is selected or unselected.",
|
7051
|
-
"attribute": "checked",
|
7052
|
-
"reflects": true
|
7053
|
-
},
|
7054
|
-
{
|
7055
|
-
"kind": "field",
|
7056
|
-
"name": "indeterminate",
|
7170
|
+
"name": "color",
|
7057
7171
|
"type": {
|
7058
|
-
"text": "
|
7172
|
+
"text": "ColorType"
|
7059
7173
|
},
|
7060
|
-
"
|
7061
|
-
"
|
7062
|
-
"attribute": "
|
7174
|
+
"description": "The color of the chip. It supports the following colors\n- default\n- cobalt\n- gold\n- lime\n- mint\n- orange\n- pink\n- purple\n- slate\n- violet",
|
7175
|
+
"default": "default",
|
7176
|
+
"attribute": "color",
|
7063
7177
|
"reflects": true
|
7064
7178
|
},
|
7065
7179
|
{
|
7066
7180
|
"kind": "field",
|
7067
|
-
"name": "
|
7181
|
+
"name": "label",
|
7068
7182
|
"type": {
|
7069
|
-
"text": "
|
7070
|
-
},
|
7071
|
-
"default": "false",
|
7072
|
-
"description": "Automatically focus on the element when the page loads.\n[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/autofocus)",
|
7073
|
-
"attribute": "autofocus",
|
7074
|
-
"reflects": true
|
7075
|
-
},
|
7076
|
-
{
|
7077
|
-
"kind": "method",
|
7078
|
-
"name": "setFormValue",
|
7079
|
-
"privacy": "private",
|
7080
|
-
"description": "Updates the form value to reflect the current state of the checkbox.\nIf checked, the value is set to either the user-provided value or 'on' if no value is provided.\nIf unchecked, the value is set to null."
|
7081
|
-
},
|
7082
|
-
{
|
7083
|
-
"kind": "method",
|
7084
|
-
"name": "manageRequired",
|
7085
|
-
"privacy": "private",
|
7086
|
-
"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."
|
7087
|
-
},
|
7088
|
-
{
|
7089
|
-
"kind": "method",
|
7090
|
-
"name": "toggleState",
|
7091
|
-
"privacy": "private",
|
7092
|
-
"return": {
|
7093
|
-
"type": {
|
7094
|
-
"text": "void"
|
7095
|
-
}
|
7183
|
+
"text": "string"
|
7096
7184
|
},
|
7097
|
-
"
|
7185
|
+
"default": "''",
|
7186
|
+
"description": "The visible label text of the chip.\n\nWe recommend limiting the <b>maximum length of the label text to 20 characters</b>,\nincluding empty spaces to split words.",
|
7187
|
+
"attribute": "label"
|
7098
7188
|
},
|
7099
7189
|
{
|
7100
7190
|
"kind": "method",
|
7101
|
-
"name": "
|
7191
|
+
"name": "renderIcon",
|
7102
7192
|
"privacy": "private",
|
7193
|
+
"description": "Renders the icon element if available.",
|
7103
7194
|
"return": {
|
7104
7195
|
"type": {
|
7105
|
-
"text": "
|
7106
|
-
}
|
7107
|
-
},
|
7108
|
-
"parameters": [
|
7109
|
-
{
|
7110
|
-
"name": "event",
|
7111
|
-
"type": {
|
7112
|
-
"text": "KeyboardEvent"
|
7113
|
-
},
|
7114
|
-
"description": "The keyboard event."
|
7115
|
-
}
|
7116
|
-
],
|
7117
|
-
"description": "Handles the keydown event on the checkbox.\nWhen the user presses Enter, the form is submitted."
|
7118
|
-
},
|
7119
|
-
{
|
7120
|
-
"kind": "method",
|
7121
|
-
"name": "handleChange",
|
7122
|
-
"privacy": "public",
|
7123
|
-
"return": {
|
7124
|
-
"type": {
|
7125
|
-
"text": "void"
|
7126
|
-
}
|
7127
|
-
},
|
7128
|
-
"parameters": [
|
7129
|
-
{
|
7130
|
-
"name": "event",
|
7131
|
-
"type": {
|
7132
|
-
"text": "Event"
|
7133
|
-
}
|
7196
|
+
"text": ""
|
7134
7197
|
}
|
7135
|
-
],
|
7136
|
-
"description": "Toggles the state of the checkbox element.\nand dispatch the new change event."
|
7137
|
-
},
|
7138
|
-
{
|
7139
|
-
"kind": "field",
|
7140
|
-
"name": "renderLabelAndHelperText",
|
7141
|
-
"privacy": "private"
|
7142
|
-
},
|
7143
|
-
{
|
7144
|
-
"kind": "field",
|
7145
|
-
"name": "name",
|
7146
|
-
"type": {
|
7147
|
-
"text": "string"
|
7148
|
-
},
|
7149
|
-
"default": "''",
|
7150
|
-
"description": "Indicates the name of the component group.\nThey are used to group elements in a form together.",
|
7151
|
-
"attribute": "name",
|
7152
|
-
"reflects": true,
|
7153
|
-
"inheritedFrom": {
|
7154
|
-
"name": "FormInternalsMixin",
|
7155
|
-
"module": "utils/mixins/FormInternalsMixin.js"
|
7156
7198
|
}
|
7157
7199
|
},
|
7158
7200
|
{
|
7159
7201
|
"kind": "field",
|
7160
|
-
"name": "
|
7202
|
+
"name": "iconName",
|
7161
7203
|
"type": {
|
7162
|
-
"text": "
|
7204
|
+
"text": "IconNames | undefined"
|
7163
7205
|
},
|
7164
|
-
"
|
7165
|
-
"
|
7166
|
-
"attribute": "value",
|
7167
|
-
"reflects": true,
|
7206
|
+
"description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
|
7207
|
+
"attribute": "icon-name",
|
7168
7208
|
"inheritedFrom": {
|
7169
|
-
"name": "
|
7170
|
-
"module": "utils/mixins/
|
7209
|
+
"name": "IconNameMixin",
|
7210
|
+
"module": "utils/mixins/IconNameMixin.js"
|
7171
7211
|
}
|
7172
7212
|
},
|
7173
7213
|
{
|
7174
7214
|
"kind": "field",
|
7175
|
-
"name": "
|
7215
|
+
"name": "autofocus",
|
7176
7216
|
"type": {
|
7177
|
-
"text": "
|
7217
|
+
"text": "boolean"
|
7178
7218
|
},
|
7179
|
-
"
|
7180
|
-
"
|
7219
|
+
"default": "false",
|
7220
|
+
"description": "This property indicates whether the element should receive focus automatically when it is rendered.",
|
7221
|
+
"attribute": "autofocus",
|
7181
7222
|
"reflects": true,
|
7182
7223
|
"inheritedFrom": {
|
7183
|
-
"name": "
|
7184
|
-
"module": "
|
7185
|
-
}
|
7186
|
-
},
|
7187
|
-
{
|
7188
|
-
"kind": "field",
|
7189
|
-
"name": "validity",
|
7190
|
-
"type": {
|
7191
|
-
"text": "ValidityState"
|
7192
|
-
},
|
7193
|
-
"readonly": true,
|
7194
|
-
"inheritedFrom": {
|
7195
|
-
"name": "FormInternalsMixin",
|
7196
|
-
"module": "utils/mixins/FormInternalsMixin.js"
|
7197
|
-
}
|
7198
|
-
},
|
7199
|
-
{
|
7200
|
-
"kind": "field",
|
7201
|
-
"name": "willValidate",
|
7202
|
-
"readonly": true,
|
7203
|
-
"inheritedFrom": {
|
7204
|
-
"name": "FormInternalsMixin",
|
7205
|
-
"module": "utils/mixins/FormInternalsMixin.js"
|
7206
|
-
}
|
7207
|
-
},
|
7208
|
-
{
|
7209
|
-
"kind": "method",
|
7210
|
-
"name": "setValidity",
|
7211
|
-
"description": "Sets the validity of the input field based on the input field's validity.",
|
7212
|
-
"return": {
|
7213
|
-
"type": {
|
7214
|
-
"text": ""
|
7215
|
-
}
|
7216
|
-
},
|
7217
|
-
"inheritedFrom": {
|
7218
|
-
"name": "FormInternalsMixin",
|
7219
|
-
"module": "utils/mixins/FormInternalsMixin.js"
|
7220
|
-
}
|
7221
|
-
},
|
7222
|
-
{
|
7223
|
-
"kind": "method",
|
7224
|
-
"name": "checkValidity",
|
7225
|
-
"return": {
|
7226
|
-
"type": {
|
7227
|
-
"text": "boolean"
|
7228
|
-
}
|
7229
|
-
},
|
7230
|
-
"inheritedFrom": {
|
7231
|
-
"name": "FormInternalsMixin",
|
7232
|
-
"module": "utils/mixins/FormInternalsMixin.js"
|
7233
|
-
}
|
7234
|
-
},
|
7235
|
-
{
|
7236
|
-
"kind": "method",
|
7237
|
-
"name": "reportValidity",
|
7238
|
-
"inheritedFrom": {
|
7239
|
-
"name": "FormInternalsMixin",
|
7240
|
-
"module": "utils/mixins/FormInternalsMixin.js"
|
7224
|
+
"name": "Buttonsimple",
|
7225
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
7241
7226
|
}
|
7242
7227
|
},
|
7243
7228
|
{
|
7244
7229
|
"kind": "field",
|
7245
|
-
"name": "
|
7230
|
+
"name": "tabIndex",
|
7246
7231
|
"type": {
|
7247
|
-
"text": "
|
7232
|
+
"text": "number"
|
7248
7233
|
},
|
7249
|
-
"default": "
|
7250
|
-
"description": "
|
7251
|
-
"attribute": "
|
7234
|
+
"default": "0",
|
7235
|
+
"description": "This property specifies the tab order of the element.",
|
7236
|
+
"attribute": "tabIndex",
|
7252
7237
|
"reflects": true,
|
7253
7238
|
"inheritedFrom": {
|
7254
|
-
"name": "
|
7255
|
-
"module": "
|
7239
|
+
"name": "Buttonsimple",
|
7240
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
7256
7241
|
}
|
7257
7242
|
},
|
7258
7243
|
{
|
@@ -7263,297 +7248,302 @@
|
|
7263
7248
|
},
|
7264
7249
|
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
7265
7250
|
"default": "undefined",
|
7266
|
-
"attribute": "disabled",
|
7267
|
-
"reflects": true,
|
7268
|
-
"inheritedFrom": {
|
7269
|
-
"name": "DisabledMixin",
|
7270
|
-
"module": "utils/mixins/DisabledMixin.js"
|
7271
|
-
}
|
7272
|
-
},
|
7273
|
-
{
|
7274
|
-
"kind": "field",
|
7275
|
-
"name": "label",
|
7276
|
-
"type": {
|
7277
|
-
"text": "string | undefined"
|
7278
|
-
},
|
7279
|
-
"description": "The label of the input field. It is linked to the input field using the `for` attribute.",
|
7280
|
-
"attribute": "label",
|
7251
|
+
"attribute": "disabled",
|
7281
7252
|
"reflects": true,
|
7282
7253
|
"inheritedFrom": {
|
7283
|
-
"name": "
|
7284
|
-
"module": "components/
|
7254
|
+
"name": "Buttonsimple",
|
7255
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
7285
7256
|
}
|
7286
7257
|
},
|
7287
7258
|
{
|
7288
7259
|
"kind": "field",
|
7289
|
-
"name": "
|
7260
|
+
"name": "active",
|
7290
7261
|
"type": {
|
7291
|
-
"text": "boolean"
|
7262
|
+
"text": "boolean | undefined"
|
7292
7263
|
},
|
7293
|
-
"
|
7294
|
-
"
|
7295
|
-
"attribute": "
|
7264
|
+
"description": "The button's active state indicates whether it is currently toggled on (active) or off (inactive).\nWhen the active state is true, the button is considered to be in an active state, meaning it is toggled on.\nConversely, when the active state is false, the button is in an inactive state, indicating it is toggled off.\n\nThis attribute is used to set the provided `ariaStateKey` to true or false.",
|
7265
|
+
"default": "undefined",
|
7266
|
+
"attribute": "active",
|
7296
7267
|
"reflects": true,
|
7297
7268
|
"inheritedFrom": {
|
7298
|
-
"name": "
|
7299
|
-
"module": "components/
|
7269
|
+
"name": "Buttonsimple",
|
7270
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
7300
7271
|
}
|
7301
7272
|
},
|
7302
7273
|
{
|
7303
7274
|
"kind": "field",
|
7304
|
-
"name": "
|
7275
|
+
"name": "softDisabled",
|
7305
7276
|
"type": {
|
7306
|
-
"text": "
|
7277
|
+
"text": "boolean | undefined"
|
7307
7278
|
},
|
7308
|
-
"
|
7309
|
-
"
|
7310
|
-
"attribute": "
|
7279
|
+
"description": "Indicates whether the button is soft disabled.\nWhen set to `true`, the button 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 button behaves like a disabled button, allowing only focus and\npreventing any interactions (clicks or keyboard actions) from triggering unintended actions.",
|
7280
|
+
"default": "undefined",
|
7281
|
+
"attribute": "soft-disabled",
|
7282
|
+
"reflects": true,
|
7311
7283
|
"inheritedFrom": {
|
7312
|
-
"name": "
|
7313
|
-
"module": "components/
|
7284
|
+
"name": "Buttonsimple",
|
7285
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
7314
7286
|
}
|
7315
7287
|
},
|
7316
7288
|
{
|
7317
7289
|
"kind": "field",
|
7318
|
-
"name": "
|
7290
|
+
"name": "size",
|
7319
7291
|
"type": {
|
7320
|
-
"text": "
|
7292
|
+
"text": "ButtonSize"
|
7321
7293
|
},
|
7322
|
-
"description": "
|
7323
|
-
"
|
7294
|
+
"description": "Simplebutton size is a super set of all the sizes supported by children components.",
|
7295
|
+
"default": "32",
|
7296
|
+
"attribute": "size",
|
7324
7297
|
"reflects": true,
|
7325
7298
|
"inheritedFrom": {
|
7326
|
-
"name": "
|
7327
|
-
"module": "components/
|
7299
|
+
"name": "Buttonsimple",
|
7300
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
7328
7301
|
}
|
7329
7302
|
},
|
7330
7303
|
{
|
7331
7304
|
"kind": "field",
|
7332
|
-
"name": "
|
7333
|
-
"
|
7334
|
-
|
7335
|
-
|
7336
|
-
"description": "The help text that is displayed below the input field.",
|
7337
|
-
"attribute": "help-text",
|
7305
|
+
"name": "role",
|
7306
|
+
"description": "This property defines the ARIA role for the element. By default, it is set to 'button'.\nConsumers should override this role when:\n- The element is being used in a context where a different role is more appropriate.\n- Custom behaviors are implemented that require a specific ARIA role for accessibility purposes.",
|
7307
|
+
"default": "button",
|
7308
|
+
"attribute": "role",
|
7338
7309
|
"reflects": true,
|
7339
7310
|
"inheritedFrom": {
|
7340
|
-
"name": "
|
7341
|
-
"module": "components/
|
7311
|
+
"name": "Buttonsimple",
|
7312
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
7342
7313
|
}
|
7343
7314
|
},
|
7344
7315
|
{
|
7345
7316
|
"kind": "field",
|
7346
|
-
"name": "
|
7317
|
+
"name": "ariaStateKey",
|
7347
7318
|
"type": {
|
7348
7319
|
"text": "string | undefined"
|
7349
7320
|
},
|
7350
|
-
"description": "
|
7351
|
-
"
|
7321
|
+
"description": "This property defines the ARIA state key, which will be toggled when the\nButton is set to `active`.\nThe default value is 'aria-pressed', which is commonly used for toggle buttons.\n\nConsumers can override this property to use a different ARIA state key if needed.\nIn case multiple aria attributes should be toggled, they can be passed in as\na comma separated string.\nFor example: `aria-pressed,aria-expanded`",
|
7322
|
+
"default": "'aria-pressed' (when)",
|
7323
|
+
"attribute": "ariaStateKey",
|
7352
7324
|
"reflects": true,
|
7353
7325
|
"inheritedFrom": {
|
7354
|
-
"name": "
|
7355
|
-
"module": "components/
|
7326
|
+
"name": "Buttonsimple",
|
7327
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
7356
7328
|
}
|
7357
7329
|
},
|
7358
7330
|
{
|
7359
7331
|
"kind": "field",
|
7360
|
-
"name": "
|
7332
|
+
"name": "type",
|
7361
7333
|
"type": {
|
7362
|
-
"text": "
|
7334
|
+
"text": "ButtonType"
|
7363
7335
|
},
|
7364
|
-
"description": "
|
7365
|
-
"default": "
|
7366
|
-
"attribute": "
|
7336
|
+
"description": "This property defines the type attribute for the button element.\nThe type attribute specifies the behavior of the button when it is clicked.\n- **submit**: The button submits the form data to the server.\n- **reset**: The button resets the form data to its initial state.\n- **button**: The button does nothing when clicked.",
|
7337
|
+
"default": "button",
|
7338
|
+
"attribute": "type",
|
7367
7339
|
"reflects": true,
|
7368
7340
|
"inheritedFrom": {
|
7369
|
-
"name": "
|
7370
|
-
"module": "components/
|
7341
|
+
"name": "Buttonsimple",
|
7342
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
7371
7343
|
}
|
7372
7344
|
},
|
7373
7345
|
{
|
7374
|
-
"kind": "
|
7375
|
-
"name": "
|
7376
|
-
"
|
7377
|
-
"text": "string | undefined"
|
7378
|
-
},
|
7379
|
-
"description": "Aria label for the info icon that is displayed next to the label when `toggletipText` is set.\nThis is used for accessibility purposes to provide a description of the icon.",
|
7380
|
-
"attribute": "info-icon-aria-label",
|
7381
|
-
"reflects": true,
|
7346
|
+
"kind": "method",
|
7347
|
+
"name": "executeAction",
|
7348
|
+
"privacy": "protected",
|
7382
7349
|
"inheritedFrom": {
|
7383
|
-
"name": "
|
7384
|
-
"module": "components/
|
7350
|
+
"name": "Buttonsimple",
|
7351
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
7385
7352
|
}
|
7386
7353
|
},
|
7387
7354
|
{
|
7388
7355
|
"kind": "method",
|
7389
|
-
"name": "
|
7356
|
+
"name": "setActive",
|
7390
7357
|
"privacy": "protected",
|
7391
|
-
"
|
7392
|
-
|
7393
|
-
|
7394
|
-
"
|
7358
|
+
"parameters": [
|
7359
|
+
{
|
7360
|
+
"name": "element",
|
7361
|
+
"type": {
|
7362
|
+
"text": "HTMLElement"
|
7363
|
+
},
|
7364
|
+
"description": "The button element"
|
7365
|
+
},
|
7366
|
+
{
|
7367
|
+
"name": "active",
|
7368
|
+
"optional": true,
|
7369
|
+
"type": {
|
7370
|
+
"text": "boolean"
|
7371
|
+
},
|
7372
|
+
"description": "The active state of the element"
|
7395
7373
|
}
|
7396
|
-
|
7374
|
+
],
|
7375
|
+
"description": "Sets the ariaStateKey attributes based on the active state of the button.",
|
7397
7376
|
"inheritedFrom": {
|
7398
|
-
"name": "
|
7399
|
-
"module": "components/
|
7377
|
+
"name": "Buttonsimple",
|
7378
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
7400
7379
|
}
|
7401
7380
|
},
|
7402
7381
|
{
|
7403
7382
|
"kind": "method",
|
7404
|
-
"name": "
|
7405
|
-
"privacy": "
|
7406
|
-
"
|
7407
|
-
|
7408
|
-
|
7409
|
-
"
|
7383
|
+
"name": "setSoftDisabled",
|
7384
|
+
"privacy": "private",
|
7385
|
+
"parameters": [
|
7386
|
+
{
|
7387
|
+
"name": "element",
|
7388
|
+
"type": {
|
7389
|
+
"text": "HTMLElement"
|
7390
|
+
},
|
7391
|
+
"description": "The button element."
|
7392
|
+
},
|
7393
|
+
{
|
7394
|
+
"name": "softDisabled",
|
7395
|
+
"optional": true,
|
7396
|
+
"type": {
|
7397
|
+
"text": "boolean"
|
7398
|
+
},
|
7399
|
+
"description": "The soft-disabled state."
|
7410
7400
|
}
|
7411
|
-
|
7401
|
+
],
|
7402
|
+
"description": "Sets the soft-disabled attribute for the button.\nWhen soft-disabled, the button looks to be disabled but remains focusable and clickable.\nAlso sets/removes aria-disabled attribute.",
|
7412
7403
|
"inheritedFrom": {
|
7413
|
-
"name": "
|
7414
|
-
"module": "components/
|
7404
|
+
"name": "Buttonsimple",
|
7405
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
7415
7406
|
}
|
7416
7407
|
},
|
7417
7408
|
{
|
7418
7409
|
"kind": "method",
|
7419
|
-
"name": "
|
7420
|
-
"privacy": "
|
7421
|
-
"
|
7422
|
-
|
7423
|
-
|
7424
|
-
"
|
7410
|
+
"name": "setDisabled",
|
7411
|
+
"privacy": "private",
|
7412
|
+
"parameters": [
|
7413
|
+
{
|
7414
|
+
"name": "element",
|
7415
|
+
"type": {
|
7416
|
+
"text": "HTMLElement"
|
7417
|
+
},
|
7418
|
+
"description": "The button element."
|
7419
|
+
},
|
7420
|
+
{
|
7421
|
+
"name": "disabled",
|
7422
|
+
"type": {
|
7423
|
+
"text": "boolean"
|
7424
|
+
},
|
7425
|
+
"description": "The disabled state."
|
7425
7426
|
}
|
7426
|
-
|
7427
|
+
],
|
7428
|
+
"description": "Sets the disabled attribute for the button.\nWhen disabled, the button is not focusable or clickable, and tabindex is set to -1.\nThe previous tabindex is stored and restored when enabled.\nAlso sets/removes aria-disabled attribute.",
|
7427
7429
|
"inheritedFrom": {
|
7428
|
-
"name": "
|
7429
|
-
"module": "components/
|
7430
|
+
"name": "Buttonsimple",
|
7431
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
7430
7432
|
}
|
7431
7433
|
},
|
7432
7434
|
{
|
7433
7435
|
"kind": "method",
|
7434
|
-
"name": "
|
7435
|
-
"privacy": "
|
7436
|
-
"description": "renders the mdc-label-text container that contains the label and labelInfoToggleTip.",
|
7437
|
-
"return": {
|
7438
|
-
"type": {
|
7439
|
-
"text": ""
|
7440
|
-
}
|
7441
|
-
},
|
7436
|
+
"name": "triggerClickEvent",
|
7437
|
+
"privacy": "private",
|
7442
7438
|
"inheritedFrom": {
|
7443
|
-
"name": "
|
7444
|
-
"module": "components/
|
7439
|
+
"name": "Buttonsimple",
|
7440
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
7445
7441
|
}
|
7446
7442
|
},
|
7447
7443
|
{
|
7448
7444
|
"kind": "method",
|
7449
|
-
"name": "
|
7450
|
-
"privacy": "
|
7451
|
-
"description": "
|
7452
|
-
"
|
7453
|
-
"
|
7454
|
-
|
7445
|
+
"name": "handleBlur",
|
7446
|
+
"privacy": "private",
|
7447
|
+
"description": "In case the button is pressed and the focus is lost while pressing,\nthe pressed class is removed.",
|
7448
|
+
"inheritedFrom": {
|
7449
|
+
"name": "Buttonsimple",
|
7450
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
7451
|
+
}
|
7452
|
+
},
|
7453
|
+
{
|
7454
|
+
"kind": "method",
|
7455
|
+
"name": "handleKeyDown",
|
7456
|
+
"privacy": "private",
|
7457
|
+
"parameters": [
|
7458
|
+
{
|
7459
|
+
"name": "event",
|
7460
|
+
"type": {
|
7461
|
+
"text": "KeyboardEvent"
|
7462
|
+
},
|
7463
|
+
"description": "The keyboard event."
|
7455
7464
|
}
|
7456
|
-
|
7465
|
+
],
|
7466
|
+
"description": "Handles the keydown event on the button.\nIf the key is 'Enter' or 'Space', the button is pressed.\nIf the key is 'Enter', the button is pressed. The native HTML button works in the same way.\nIf the key is 'Space', the button's default is prevent to avoid scrolling etc in the host application.",
|
7457
7467
|
"inheritedFrom": {
|
7458
|
-
"name": "
|
7459
|
-
"module": "components/
|
7468
|
+
"name": "Buttonsimple",
|
7469
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
7460
7470
|
}
|
7461
|
-
}
|
7462
|
-
],
|
7463
|
-
"events": [
|
7471
|
+
},
|
7464
7472
|
{
|
7465
|
-
"
|
7466
|
-
|
7473
|
+
"kind": "method",
|
7474
|
+
"name": "handleKeyUp",
|
7475
|
+
"privacy": "private",
|
7476
|
+
"parameters": [
|
7477
|
+
{
|
7478
|
+
"name": "event",
|
7479
|
+
"type": {
|
7480
|
+
"text": "KeyboardEvent"
|
7481
|
+
},
|
7482
|
+
"description": "The keyboard event."
|
7483
|
+
}
|
7484
|
+
],
|
7485
|
+
"description": "Handles the keyup event on the button.\nIf the key is 'Enter' or 'Space', the button is clicked.\nIf the key is 'Space', the button is pressed. The native HTML button works in the same way.",
|
7486
|
+
"inheritedFrom": {
|
7487
|
+
"name": "Buttonsimple",
|
7488
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
7467
7489
|
}
|
7468
|
-
},
|
7469
|
-
{
|
7470
|
-
"description": "(React: onChange) Event that gets dispatched when the checkbox state changes.",
|
7471
|
-
"name": "change",
|
7472
|
-
"reactName": "onChange"
|
7473
|
-
},
|
7474
|
-
{
|
7475
|
-
"description": "(React: onFocus) Event that gets dispatched when the checkbox receives focus.",
|
7476
|
-
"name": "focus",
|
7477
|
-
"reactName": "onFocus"
|
7478
7490
|
}
|
7479
7491
|
],
|
7480
7492
|
"attributes": [
|
7481
7493
|
{
|
7482
|
-
"name": "
|
7483
|
-
"type": {
|
7484
|
-
"text": "boolean"
|
7485
|
-
},
|
7486
|
-
"default": "false",
|
7487
|
-
"description": "Determines whether the checkbox is selected or unselected.",
|
7488
|
-
"fieldName": "checked"
|
7489
|
-
},
|
7490
|
-
{
|
7491
|
-
"name": "indeterminate",
|
7492
|
-
"type": {
|
7493
|
-
"text": "boolean"
|
7494
|
-
},
|
7495
|
-
"default": "false",
|
7496
|
-
"description": "This property is used to determine the parent checkbox in a nested checkbox group.\nIf any one of the children is unselected, then the parent checkbox will be indeterminate.\nIf all children are either selected or unselected, then the parent checkbox will not be indeterminate.",
|
7497
|
-
"fieldName": "indeterminate"
|
7498
|
-
},
|
7499
|
-
{
|
7500
|
-
"name": "autofocus",
|
7494
|
+
"name": "color",
|
7501
7495
|
"type": {
|
7502
|
-
"text": "
|
7496
|
+
"text": "ColorType"
|
7503
7497
|
},
|
7504
|
-
"
|
7505
|
-
"
|
7506
|
-
"fieldName": "
|
7498
|
+
"description": "The color of the chip. It supports the following colors\n- default\n- cobalt\n- gold\n- lime\n- mint\n- orange\n- pink\n- purple\n- slate\n- violet",
|
7499
|
+
"default": "default",
|
7500
|
+
"fieldName": "color"
|
7507
7501
|
},
|
7508
7502
|
{
|
7509
|
-
"name": "
|
7503
|
+
"name": "label",
|
7510
7504
|
"type": {
|
7511
7505
|
"text": "string"
|
7512
7506
|
},
|
7513
7507
|
"default": "''",
|
7514
|
-
"description": "
|
7515
|
-
"fieldName": "
|
7516
|
-
"inheritedFrom": {
|
7517
|
-
"name": "FormInternalsMixin",
|
7518
|
-
"module": "src/utils/mixins/FormInternalsMixin.ts"
|
7519
|
-
}
|
7508
|
+
"description": "The visible label text of the chip.\n\nWe recommend limiting the <b>maximum length of the label text to 20 characters</b>,\nincluding empty spaces to split words.",
|
7509
|
+
"fieldName": "label"
|
7520
7510
|
},
|
7521
7511
|
{
|
7522
|
-
"name": "
|
7512
|
+
"name": "icon-name",
|
7523
7513
|
"type": {
|
7524
|
-
"text": "
|
7514
|
+
"text": "IconNames | undefined"
|
7525
7515
|
},
|
7526
|
-
"
|
7527
|
-
"
|
7528
|
-
"fieldName": "value",
|
7516
|
+
"description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
|
7517
|
+
"fieldName": "iconName",
|
7529
7518
|
"inheritedFrom": {
|
7530
|
-
"name": "
|
7531
|
-
"module": "src/utils/mixins/
|
7519
|
+
"name": "IconNameMixin",
|
7520
|
+
"module": "src/utils/mixins/IconNameMixin.ts"
|
7532
7521
|
}
|
7533
7522
|
},
|
7534
7523
|
{
|
7535
|
-
"name": "
|
7524
|
+
"name": "autofocus",
|
7536
7525
|
"type": {
|
7537
|
-
"text": "
|
7526
|
+
"text": "boolean"
|
7538
7527
|
},
|
7539
|
-
"
|
7540
|
-
"
|
7528
|
+
"default": "false",
|
7529
|
+
"description": "This property indicates whether the element should receive focus automatically when it is rendered.",
|
7530
|
+
"fieldName": "autofocus",
|
7541
7531
|
"inheritedFrom": {
|
7542
|
-
"name": "
|
7543
|
-
"module": "src/
|
7532
|
+
"name": "Buttonsimple",
|
7533
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
7544
7534
|
}
|
7545
7535
|
},
|
7546
7536
|
{
|
7547
|
-
"name": "
|
7537
|
+
"name": "tabIndex",
|
7548
7538
|
"type": {
|
7549
|
-
"text": "
|
7539
|
+
"text": "number"
|
7550
7540
|
},
|
7551
|
-
"default": "
|
7552
|
-
"description": "
|
7553
|
-
"fieldName": "
|
7541
|
+
"default": "0",
|
7542
|
+
"description": "This property specifies the tab order of the element.",
|
7543
|
+
"fieldName": "tabIndex",
|
7554
7544
|
"inheritedFrom": {
|
7555
|
-
"name": "
|
7556
|
-
"module": "src/
|
7545
|
+
"name": "Buttonsimple",
|
7546
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
7557
7547
|
}
|
7558
7548
|
},
|
7559
7549
|
{
|
@@ -7565,127 +7555,137 @@
|
|
7565
7555
|
"default": "undefined",
|
7566
7556
|
"fieldName": "disabled",
|
7567
7557
|
"inheritedFrom": {
|
7568
|
-
"name": "
|
7569
|
-
"module": "src/
|
7558
|
+
"name": "Buttonsimple",
|
7559
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
7570
7560
|
}
|
7571
7561
|
},
|
7572
7562
|
{
|
7573
|
-
"name": "
|
7563
|
+
"name": "active",
|
7574
7564
|
"type": {
|
7575
|
-
"text": "
|
7565
|
+
"text": "boolean | undefined"
|
7576
7566
|
},
|
7577
|
-
"description": "The
|
7578
|
-
"
|
7567
|
+
"description": "The button's active state indicates whether it is currently toggled on (active) or off (inactive).\nWhen the active state is true, the button is considered to be in an active state, meaning it is toggled on.\nConversely, when the active state is false, the button is in an inactive state, indicating it is toggled off.\n\nThis attribute is used to set the provided `ariaStateKey` to true or false.",
|
7568
|
+
"default": "undefined",
|
7569
|
+
"fieldName": "active",
|
7579
7570
|
"inheritedFrom": {
|
7580
|
-
"name": "
|
7581
|
-
"module": "src/components/
|
7571
|
+
"name": "Buttonsimple",
|
7572
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
7582
7573
|
}
|
7583
7574
|
},
|
7584
7575
|
{
|
7585
|
-
"name": "
|
7576
|
+
"name": "soft-disabled",
|
7586
7577
|
"type": {
|
7587
|
-
"text": "boolean"
|
7578
|
+
"text": "boolean | undefined"
|
7588
7579
|
},
|
7589
|
-
"
|
7590
|
-
"
|
7591
|
-
"fieldName": "
|
7580
|
+
"description": "Indicates whether the button is soft disabled.\nWhen set to `true`, the button 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 button behaves like a disabled button, allowing only focus and\npreventing any interactions (clicks or keyboard actions) from triggering unintended actions.",
|
7581
|
+
"default": "undefined",
|
7582
|
+
"fieldName": "softDisabled",
|
7592
7583
|
"inheritedFrom": {
|
7593
|
-
"name": "
|
7594
|
-
"module": "src/components/
|
7584
|
+
"name": "Buttonsimple",
|
7585
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
7595
7586
|
}
|
7596
7587
|
},
|
7597
7588
|
{
|
7598
|
-
"name": "
|
7589
|
+
"name": "size",
|
7599
7590
|
"type": {
|
7600
|
-
"text": "
|
7591
|
+
"text": "ButtonSize"
|
7601
7592
|
},
|
7602
|
-
"
|
7603
|
-
"
|
7604
|
-
"fieldName": "
|
7593
|
+
"description": "Simplebutton size is a super set of all the sizes supported by children components.",
|
7594
|
+
"default": "32",
|
7595
|
+
"fieldName": "size",
|
7605
7596
|
"inheritedFrom": {
|
7606
|
-
"name": "
|
7607
|
-
"module": "src/components/
|
7597
|
+
"name": "Buttonsimple",
|
7598
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
7608
7599
|
}
|
7609
7600
|
},
|
7610
7601
|
{
|
7611
|
-
"name": "
|
7612
|
-
"
|
7613
|
-
|
7614
|
-
|
7615
|
-
"description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
|
7616
|
-
"fieldName": "helpTextType",
|
7602
|
+
"name": "role",
|
7603
|
+
"description": "This property defines the ARIA role for the element. By default, it is set to 'button'.\nConsumers should override this role when:\n- The element is being used in a context where a different role is more appropriate.\n- Custom behaviors are implemented that require a specific ARIA role for accessibility purposes.",
|
7604
|
+
"default": "button",
|
7605
|
+
"fieldName": "role",
|
7617
7606
|
"inheritedFrom": {
|
7618
|
-
"name": "
|
7619
|
-
"module": "src/components/
|
7607
|
+
"name": "Buttonsimple",
|
7608
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
7620
7609
|
}
|
7621
7610
|
},
|
7622
7611
|
{
|
7623
|
-
"name": "
|
7612
|
+
"name": "ariaStateKey",
|
7624
7613
|
"type": {
|
7625
7614
|
"text": "string | undefined"
|
7626
7615
|
},
|
7627
|
-
"description": "
|
7628
|
-
"
|
7616
|
+
"description": "This property defines the ARIA state key, which will be toggled when the\nButton is set to `active`.\nThe default value is 'aria-pressed', which is commonly used for toggle buttons.\n\nConsumers can override this property to use a different ARIA state key if needed.\nIn case multiple aria attributes should be toggled, they can be passed in as\na comma separated string.\nFor example: `aria-pressed,aria-expanded`",
|
7617
|
+
"default": "'aria-pressed' (when)",
|
7618
|
+
"fieldName": "ariaStateKey",
|
7629
7619
|
"inheritedFrom": {
|
7630
|
-
"name": "
|
7631
|
-
"module": "src/components/
|
7620
|
+
"name": "Buttonsimple",
|
7621
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
7632
7622
|
}
|
7633
7623
|
},
|
7634
7624
|
{
|
7635
|
-
"name": "
|
7625
|
+
"name": "type",
|
7636
7626
|
"type": {
|
7637
|
-
"text": "
|
7627
|
+
"text": "ButtonType"
|
7638
7628
|
},
|
7639
|
-
"description": "
|
7640
|
-
"
|
7629
|
+
"description": "This property defines the type attribute for the button element.\nThe type attribute specifies the behavior of the button when it is clicked.\n- **submit**: The button submits the form data to the server.\n- **reset**: The button resets the form data to its initial state.\n- **button**: The button does nothing when clicked.",
|
7630
|
+
"default": "button",
|
7631
|
+
"fieldName": "type",
|
7641
7632
|
"inheritedFrom": {
|
7642
|
-
"name": "
|
7643
|
-
"module": "src/components/
|
7633
|
+
"name": "Buttonsimple",
|
7634
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
7644
7635
|
}
|
7645
|
-
}
|
7636
|
+
}
|
7637
|
+
],
|
7638
|
+
"mixins": [
|
7646
7639
|
{
|
7647
|
-
"name": "
|
7648
|
-
"
|
7649
|
-
|
7650
|
-
|
7651
|
-
|
7652
|
-
|
7653
|
-
|
7640
|
+
"name": "IconNameMixin",
|
7641
|
+
"module": "/src/utils/mixins/IconNameMixin"
|
7642
|
+
}
|
7643
|
+
],
|
7644
|
+
"superclass": {
|
7645
|
+
"name": "Buttonsimple",
|
7646
|
+
"module": "/src/components/buttonsimple/buttonsimple.component"
|
7647
|
+
},
|
7648
|
+
"tagName": "mdc-chip",
|
7649
|
+
"jsDoc": "/**\n * mdc-chip is an interactive element that can be used to represent a chip. It supports a leading icon along with label.\n * Consumers can wrap this component around a tooltip to provide additional context.\n *\n * It is recommended to keep the label text for the chip component concise and compact.\n * For best results, we recommend limiting the <b>maximum length of the label text to 20 characters</b>,\n * including empty spaces to split words.\n *\n * This component is built by extending Buttonsimple.\n *\n * @tagname mdc-chip\n *\n * @dependency mdc-icon\n * @dependency mdc-text\n *\n * @cssproperty --mdc-chip-color - The color of the chip.\n * @cssproperty --mdc-chip-border-color - The border color of the chip.\n * @cssproperty --mdc-chip-background-color - The background color of the chip.\n *\n */",
|
7650
|
+
"customElement": true,
|
7651
|
+
"events": [
|
7652
|
+
{
|
7653
|
+
"description": "(React: onClick) This event is dispatched when the button is clicked.",
|
7654
|
+
"name": "click",
|
7655
|
+
"reactName": "onClick",
|
7654
7656
|
"inheritedFrom": {
|
7655
|
-
"name": "
|
7656
|
-
"module": "src/components/
|
7657
|
+
"name": "Buttonsimple",
|
7658
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
7657
7659
|
}
|
7658
7660
|
},
|
7659
7661
|
{
|
7660
|
-
"
|
7661
|
-
"
|
7662
|
-
|
7663
|
-
},
|
7664
|
-
"description": "Aria label for the info icon that is displayed next to the label when `toggletipText` is set.\nThis is used for accessibility purposes to provide a description of the icon.",
|
7665
|
-
"fieldName": "infoIconAriaLabel",
|
7662
|
+
"description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the button.",
|
7663
|
+
"name": "keydown",
|
7664
|
+
"reactName": "onKeyDown",
|
7666
7665
|
"inheritedFrom": {
|
7667
|
-
"name": "
|
7668
|
-
"module": "src/components/
|
7666
|
+
"name": "Buttonsimple",
|
7667
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
7669
7668
|
}
|
7670
|
-
}
|
7671
|
-
],
|
7672
|
-
"mixins": [
|
7669
|
+
},
|
7673
7670
|
{
|
7674
|
-
"
|
7675
|
-
"
|
7671
|
+
"description": "(React: onKeyUp) This event is dispatched when a key is released on the button.",
|
7672
|
+
"name": "keyup",
|
7673
|
+
"reactName": "onKeyUp",
|
7674
|
+
"inheritedFrom": {
|
7675
|
+
"name": "Buttonsimple",
|
7676
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
7677
|
+
}
|
7676
7678
|
},
|
7677
7679
|
{
|
7678
|
-
"
|
7679
|
-
"
|
7680
|
+
"description": "(React: onFocus) This event is dispatched when the button receives focus.",
|
7681
|
+
"name": "focus",
|
7682
|
+
"reactName": "onFocus",
|
7683
|
+
"inheritedFrom": {
|
7684
|
+
"name": "Buttonsimple",
|
7685
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
7686
|
+
}
|
7680
7687
|
}
|
7681
|
-
]
|
7682
|
-
"superclass": {
|
7683
|
-
"name": "FormfieldWrapper",
|
7684
|
-
"module": "/src/components/formfieldwrapper/formfieldwrapper.component"
|
7685
|
-
},
|
7686
|
-
"tagName": "mdc-checkbox",
|
7687
|
-
"jsDoc": "/**\n * Checkboxes allow users to select multiple options from a list or turn an item/feature on or off.\n * These are often used in forms, settings, and selections in lists.\n *\n * A checkbox component contains an optional label and an optional helper text.\n *\n * To create a group of checkboxes, use the FormFieldGroup component.\n *\n * @dependency mdc-button\n * @dependency mdc-icon\n * @dependency mdc-staticcheckbox\n * @dependency mdc-text\n * @dependency mdc-toggletip\n *\n * @tagname mdc-checkbox\n *\n * @event change - (React: onChange) Event that gets dispatched when the checkbox state changes.\n * @event focus - (React: onFocus) Event that gets dispatched when the checkbox receives focus.\n *\n * @cssproperty --mdc-checkbox-background-color-hover - Allows customization of the background color on hover.\n * @cssproperty --mdc-checkbox-checked-background-color-hover - Background color for a selected checkbox when hovered.\n * @cssproperty --mdc-checkbox-checked-pressed-icon-color - Background color for a selected checkbox when pressed.\n * @cssproperty --mdc-checkbox-pressed-icon-color - Background color for a selected checkbox when pressed.\n * @cssproperty --mdc-checkbox-disabled-checked-icon-color - Background color for a selected checkbox when disabled.\n */",
|
7688
|
-
"customElement": true
|
7688
|
+
]
|
7689
7689
|
}
|
7690
7690
|
],
|
7691
7691
|
"exports": [
|
@@ -7693,8 +7693,8 @@
|
|
7693
7693
|
"kind": "js",
|
7694
7694
|
"name": "default",
|
7695
7695
|
"declaration": {
|
7696
|
-
"name": "
|
7697
|
-
"module": "components/
|
7696
|
+
"name": "Chip",
|
7697
|
+
"module": "components/chip/chip.component.js"
|
7698
7698
|
}
|
7699
7699
|
}
|
7700
7700
|
]
|
@@ -9370,7 +9370,7 @@
|
|
9370
9370
|
"declarations": [
|
9371
9371
|
{
|
9372
9372
|
"kind": "class",
|
9373
|
-
"description": "Dialog component is a modal dialog that can be used to display information or prompt the user for input.\nIt can be used to create custom dialogs where content for the body and footer actions is provided by the consumer.\nThe dialog is available in three sizes: small, medium, and large. It may also receive custom styling/sizing.\nThe dialog interrupts the user and will block interaction with the rest of the application until it is closed.\n\nThe dialog can be controlled solely through the `visible` property, no trigger element is required.\nIf a `triggerId` is provided, the dialog will manage focus with that element, otherwise it will\nremember the previously focused element before the dialog was opened.\n\nDialog component have 2 variants: default and promotional.\n\n**Accessibility notes for consuming (have to be explicitly set when you consume the component)**\n\n- The dialog should have an aria-label or aria-labelledby attribute to provide a label for screen readers.\n- Use aria-labelledby to reference the ID of the element that labels the dialog when there is no visible title.\n\n**Note: Programmatic show/hide requires the ? prefix on the visible attribute**\n- Use `?visible=true/false` as an attribute instead of `visible=true/false`\n- Reference docs for more info: https://lit.dev/docs/templates/expressions/#boolean-attribute-expressions",
|
9373
|
+
"description": "Dialog component is a modal dialog that can be used to display information or prompt the user for input.\nIt can be used to create custom dialogs where content for the body and footer actions is provided by the consumer.\nThe dialog is available in three sizes: small, medium, and large. It may also receive custom styling/sizing.\nThe dialog interrupts the user and will block interaction with the rest of the application until it is closed.\n\nThe dialog can be controlled solely through the `visible` property, no trigger element is required.\nIf a `triggerId` is provided, the dialog will manage focus with that element, otherwise it will\nremember the previously focused element before the dialog was opened.\n\nThe dialog is a controlled component, meaning it does not have its own state management for visibility.\nUse the `visible` property to control the visibility of the dialog.\nUse the `onClose` event to handle the close action of the dialog (fired when Close button is clicked\nor Escape is pressed).\n\nDialog component have 2 variants: default and promotional.\n\n**Accessibility notes for consuming (have to be explicitly set when you consume the component)**\n\n- The dialog should have an aria-label or aria-labelledby attribute to provide a label for screen readers.\n- Use aria-labelledby to reference the ID of the element that labels the dialog when there is no visible title.\n\n**Note: Programmatic show/hide requires the ? prefix on the visible attribute**\n- Use `?visible=true/false` as an attribute instead of `visible=true/false`\n- Reference docs for more info: https://lit.dev/docs/templates/expressions/#boolean-attribute-expressions",
|
9374
9374
|
"name": "Dialog",
|
9375
9375
|
"cssProperties": [
|
9376
9376
|
{
|
@@ -9453,7 +9453,7 @@
|
|
9453
9453
|
"type": {
|
9454
9454
|
"text": "boolean"
|
9455
9455
|
},
|
9456
|
-
"description": "The visibility of the dialog",
|
9456
|
+
"description": "The visibility of the dialog\n\nDialog is a controlled component, visible is the only property that controls the visibility of the dialog.",
|
9457
9457
|
"default": "false",
|
9458
9458
|
"attribute": "visible",
|
9459
9459
|
"reflects": true
|
@@ -9621,6 +9621,12 @@
|
|
9621
9621
|
"module": "utils/mixins/FocusTrapMixin.js"
|
9622
9622
|
}
|
9623
9623
|
},
|
9624
|
+
{
|
9625
|
+
"kind": "method",
|
9626
|
+
"name": "closeDialog",
|
9627
|
+
"privacy": "private",
|
9628
|
+
"description": "Fired when Close Button is clicked or Escape key is pressed.\nThis method dispatches the close event. Setting visible to false\nhas to be done by the consumer of the component."
|
9629
|
+
},
|
9624
9630
|
{
|
9625
9631
|
"kind": "method",
|
9626
9632
|
"name": "isOpenUpdated",
|
@@ -10179,6 +10185,11 @@
|
|
10179
10185
|
"description": "(React: onDestroyed) Dispatched when the dialog is destroyed (removed from the DOM)",
|
10180
10186
|
"name": "destroyed",
|
10181
10187
|
"reactName": "onDestroyed"
|
10188
|
+
},
|
10189
|
+
{
|
10190
|
+
"description": "(React: onClose) Dispatched when the Close Button is clicked or Escape key is pressed (this does not hide the dialog)",
|
10191
|
+
"name": "close",
|
10192
|
+
"reactName": "onClose"
|
10182
10193
|
}
|
10183
10194
|
],
|
10184
10195
|
"attributes": [
|
@@ -10205,7 +10216,7 @@
|
|
10205
10216
|
"type": {
|
10206
10217
|
"text": "boolean"
|
10207
10218
|
},
|
10208
|
-
"description": "The visibility of the dialog",
|
10219
|
+
"description": "The visibility of the dialog\n\nDialog is a controlled component, visible is the only property that controls the visibility of the dialog.",
|
10209
10220
|
"default": "false",
|
10210
10221
|
"fieldName": "visible"
|
10211
10222
|
},
|
@@ -10364,7 +10375,7 @@
|
|
10364
10375
|
"module": "/src/models"
|
10365
10376
|
},
|
10366
10377
|
"tagName": "mdc-dialog",
|
10367
|
-
"jsDoc": "/**\n * Dialog component is a modal dialog that can be used to display information or prompt the user for input.\n * It can be used to create custom dialogs where content for the body and footer actions is provided by the consumer.\n * The dialog is available in three sizes: small, medium, and large. It may also receive custom styling/sizing.\n * The dialog interrupts the user and will block interaction with the rest of the application until it is closed.\n *\n * The dialog can be controlled solely through the `visible` property, no trigger element is required.\n * If a `triggerId` is provided, the dialog will manage focus with that element, otherwise it will\n * remember the previously focused element before the dialog was opened.\n *\n * Dialog component have 2 variants: default and promotional.\n *\n * **Accessibility notes for consuming (have to be explicitly set when you consume the component)**\n *\n * - The dialog should have an aria-label or aria-labelledby attribute to provide a label for screen readers.\n * - Use aria-labelledby to reference the ID of the element that labels the dialog when there is no visible title.\n *\n * **Note: Programmatic show/hide requires the ? prefix on the visible attribute**\n * - Use `?visible=true/false` as an attribute instead of `visible=true/false`\n * - Reference docs for more info: https://lit.dev/docs/templates/expressions/#boolean-attribute-expressions\n *\n * @dependency mdc-button\n * @dependency mdc-text\n *\n * @tagname mdc-dialog\n *\n * @event shown - (React: onShown) Dispatched when the dialog is shown\n * @event hidden - (React: onHidden) Dispatched when the dialog is hidden\n * @event created - (React: onCreated) Dispatched when the dialog is created (added to the DOM)\n * @event destroyed - (React: onDestroyed) Dispatched when the dialog is destroyed (removed from the DOM)\n *\n * @cssproperty --mdc-dialog-primary-background-color - primary background color of the dialog\n * @cssproperty --mdc-dialog-border-color - border color of the dialog\n * @cssproperty --mdc-dialog-header-text-color - text color of the header/title of the dialog\n * @cssproperty --mdc-dialog-description-text-color - text color of the below header description of the dialog\n * @cssproperty --mdc-dialog-elevation-3 - elevation of the dialog\n * @cssproperty --mdc-dialog-width - width of the dialog\n *\n * @slot header-prefix - Slot for the dialog header content. This can be used to pass custom header content.\n * @slot dialog-body - Slot for the dialog body content\n * @slot footer-link - This slot is for passing `mdc-link` component within the footer section.\n * @slot footer-button-secondary - This slot is for passing secondary variant of `mdc-button` component\n * within the footer section.\n * @slot footer-button-primary - This slot is for passing primary variant of\n * `mdc-button` component within the footer section.\n * @slot footer - This slot is for passing custom footer content. Only use this if really needed,\n * using the footer-link and footer-button slots is preferred\n */",
|
10378
|
+
"jsDoc": "/**\n * Dialog component is a modal dialog that can be used to display information or prompt the user for input.\n * It can be used to create custom dialogs where content for the body and footer actions is provided by the consumer.\n * The dialog is available in three sizes: small, medium, and large. It may also receive custom styling/sizing.\n * The dialog interrupts the user and will block interaction with the rest of the application until it is closed.\n *\n * The dialog can be controlled solely through the `visible` property, no trigger element is required.\n * If a `triggerId` is provided, the dialog will manage focus with that element, otherwise it will\n * remember the previously focused element before the dialog was opened.\n *\n * The dialog is a controlled component, meaning it does not have its own state management for visibility.\n * Use the `visible` property to control the visibility of the dialog.\n * Use the `onClose` event to handle the close action of the dialog (fired when Close button is clicked\n * or Escape is pressed).\n *\n * Dialog component have 2 variants: default and promotional.\n *\n * **Accessibility notes for consuming (have to be explicitly set when you consume the component)**\n *\n * - The dialog should have an aria-label or aria-labelledby attribute to provide a label for screen readers.\n * - Use aria-labelledby to reference the ID of the element that labels the dialog when there is no visible title.\n *\n * **Note: Programmatic show/hide requires the ? prefix on the visible attribute**\n * - Use `?visible=true/false` as an attribute instead of `visible=true/false`\n * - Reference docs for more info: https://lit.dev/docs/templates/expressions/#boolean-attribute-expressions\n *\n * @dependency mdc-button\n * @dependency mdc-text\n *\n * @tagname mdc-dialog\n *\n * @event shown - (React: onShown) Dispatched when the dialog is shown\n * @event hidden - (React: onHidden) Dispatched when the dialog is hidden\n * @event created - (React: onCreated) Dispatched when the dialog is created (added to the DOM)\n * @event destroyed - (React: onDestroyed) Dispatched when the dialog is destroyed (removed from the DOM)\n * @event close - (React: onClose) Dispatched when the Close Button is clicked or Escape key is pressed\n * (this does not hide the dialog)\n *\n * @cssproperty --mdc-dialog-primary-background-color - primary background color of the dialog\n * @cssproperty --mdc-dialog-border-color - border color of the dialog\n * @cssproperty --mdc-dialog-header-text-color - text color of the header/title of the dialog\n * @cssproperty --mdc-dialog-description-text-color - text color of the below header description of the dialog\n * @cssproperty --mdc-dialog-elevation-3 - elevation of the dialog\n * @cssproperty --mdc-dialog-width - width of the dialog\n *\n * @slot header-prefix - Slot for the dialog header content. This can be used to pass custom header content.\n * @slot dialog-body - Slot for the dialog body content\n * @slot footer-link - This slot is for passing `mdc-link` component within the footer section.\n * @slot footer-button-secondary - This slot is for passing secondary variant of `mdc-button` component\n * within the footer section.\n * @slot footer-button-primary - This slot is for passing primary variant of\n * `mdc-button` component within the footer section.\n * @slot footer - This slot is for passing custom footer content. Only use this if really needed,\n * using the footer-link and footer-button slots is preferred\n */",
|
10368
10379
|
"customElement": true
|
10369
10380
|
}
|
10370
10381
|
],
|