@momentum-design/components 0.76.1 → 0.76.2

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.
@@ -2147,138 +2147,6 @@
2147
2147
  }
2148
2148
  ]
2149
2149
  },
2150
- {
2151
- "kind": "javascript-module",
2152
- "path": "components/buttongroup/buttongroup.component.js",
2153
- "declarations": [
2154
- {
2155
- "kind": "class",
2156
- "description": "buttongroup component, is a styled wrapper for multiple buttons.\nIt can support icon buttons, combination of icon and pill buttons, and text buttons.\nThey are available in horizontal and vertical orientation.",
2157
- "name": "ButtonGroup",
2158
- "cssProperties": [
2159
- {
2160
- "description": "The border radius of the buttongroup",
2161
- "name": "--mdc-buttongroup-border-radius"
2162
- },
2163
- {
2164
- "description": "The border color of the buttongroup",
2165
- "name": "--mdc-buttongroup-border-color"
2166
- },
2167
- {
2168
- "description": "The color of the divider between buttons within the buttongroup",
2169
- "name": "--mdc-buttongroup-divider-color"
2170
- }
2171
- ],
2172
- "slots": [
2173
- {
2174
- "description": "This is a default/unnamed slot, which contains the buttons",
2175
- "name": "default"
2176
- }
2177
- ],
2178
- "members": [
2179
- {
2180
- "kind": "field",
2181
- "name": "orientation",
2182
- "type": {
2183
- "text": "ButtonGroupOrientation"
2184
- },
2185
- "description": "Orientation of the buttongroup.",
2186
- "default": "'horizontal'",
2187
- "attribute": "orientation",
2188
- "reflects": true
2189
- },
2190
- {
2191
- "kind": "field",
2192
- "name": "variant",
2193
- "type": {
2194
- "text": "ButtonGroupVariant"
2195
- },
2196
- "description": "Variant of the buttons within the buttongroup.",
2197
- "default": "'primary'",
2198
- "attribute": "variant",
2199
- "reflects": true
2200
- },
2201
- {
2202
- "kind": "field",
2203
- "name": "size",
2204
- "type": {
2205
- "text": "ButtonGroupSize"
2206
- },
2207
- "description": "Size of the buttons within the buttongroup.",
2208
- "default": "'28'",
2209
- "attribute": "size",
2210
- "reflects": true
2211
- },
2212
- {
2213
- "kind": "field",
2214
- "name": "compact",
2215
- "type": {
2216
- "text": "boolean"
2217
- },
2218
- "default": "false",
2219
- "description": "When this is true, the buttons within the buttongroup will be compact.\ni.e. Irrespective of the size of the buttons, they will have a height of 24px.",
2220
- "attribute": "compact",
2221
- "reflects": true
2222
- }
2223
- ],
2224
- "attributes": [
2225
- {
2226
- "name": "orientation",
2227
- "type": {
2228
- "text": "ButtonGroupOrientation"
2229
- },
2230
- "description": "Orientation of the buttongroup.",
2231
- "default": "'horizontal'",
2232
- "fieldName": "orientation"
2233
- },
2234
- {
2235
- "name": "variant",
2236
- "type": {
2237
- "text": "ButtonGroupVariant"
2238
- },
2239
- "description": "Variant of the buttons within the buttongroup.",
2240
- "default": "'primary'",
2241
- "fieldName": "variant"
2242
- },
2243
- {
2244
- "name": "size",
2245
- "type": {
2246
- "text": "ButtonGroupSize"
2247
- },
2248
- "description": "Size of the buttons within the buttongroup.",
2249
- "default": "'28'",
2250
- "fieldName": "size"
2251
- },
2252
- {
2253
- "name": "compact",
2254
- "type": {
2255
- "text": "boolean"
2256
- },
2257
- "default": "false",
2258
- "description": "When this is true, the buttons within the buttongroup will be compact.\ni.e. Irrespective of the size of the buttons, they will have a height of 24px.",
2259
- "fieldName": "compact"
2260
- }
2261
- ],
2262
- "superclass": {
2263
- "name": "Component",
2264
- "module": "/src/models"
2265
- },
2266
- "tagName": "mdc-buttongroup",
2267
- "jsDoc": "/**\n * buttongroup component, is a styled wrapper for multiple buttons.\n * It can support icon buttons, combination of icon and pill buttons, and text buttons.\n * They are available in horizontal and vertical orientation.\n *\n * @tagname mdc-buttongroup\n *\n * @slot default - This is a default/unnamed slot, which contains the buttons\n *\n * @cssproperty --mdc-buttongroup-border-radius - The border radius of the buttongroup\n * @cssproperty --mdc-buttongroup-border-color - The border color of the buttongroup\n * @cssproperty --mdc-buttongroup-divider-color - The color of the divider between buttons within the buttongroup\n */",
2268
- "customElement": true
2269
- }
2270
- ],
2271
- "exports": [
2272
- {
2273
- "kind": "js",
2274
- "name": "default",
2275
- "declaration": {
2276
- "name": "ButtonGroup",
2277
- "module": "components/buttongroup/buttongroup.component.js"
2278
- }
2279
- }
2280
- ]
2281
- },
2282
2150
  {
2283
2151
  "kind": "javascript-module",
2284
2152
  "path": "components/button/button.component.js",
@@ -2946,6 +2814,138 @@
2946
2814
  }
2947
2815
  ]
2948
2816
  },
2817
+ {
2818
+ "kind": "javascript-module",
2819
+ "path": "components/buttongroup/buttongroup.component.js",
2820
+ "declarations": [
2821
+ {
2822
+ "kind": "class",
2823
+ "description": "buttongroup component, is a styled wrapper for multiple buttons.\nIt can support icon buttons, combination of icon and pill buttons, and text buttons.\nThey are available in horizontal and vertical orientation.",
2824
+ "name": "ButtonGroup",
2825
+ "cssProperties": [
2826
+ {
2827
+ "description": "The border radius of the buttongroup",
2828
+ "name": "--mdc-buttongroup-border-radius"
2829
+ },
2830
+ {
2831
+ "description": "The border color of the buttongroup",
2832
+ "name": "--mdc-buttongroup-border-color"
2833
+ },
2834
+ {
2835
+ "description": "The color of the divider between buttons within the buttongroup",
2836
+ "name": "--mdc-buttongroup-divider-color"
2837
+ }
2838
+ ],
2839
+ "slots": [
2840
+ {
2841
+ "description": "This is a default/unnamed slot, which contains the buttons",
2842
+ "name": "default"
2843
+ }
2844
+ ],
2845
+ "members": [
2846
+ {
2847
+ "kind": "field",
2848
+ "name": "orientation",
2849
+ "type": {
2850
+ "text": "ButtonGroupOrientation"
2851
+ },
2852
+ "description": "Orientation of the buttongroup.",
2853
+ "default": "'horizontal'",
2854
+ "attribute": "orientation",
2855
+ "reflects": true
2856
+ },
2857
+ {
2858
+ "kind": "field",
2859
+ "name": "variant",
2860
+ "type": {
2861
+ "text": "ButtonGroupVariant"
2862
+ },
2863
+ "description": "Variant of the buttons within the buttongroup.",
2864
+ "default": "'primary'",
2865
+ "attribute": "variant",
2866
+ "reflects": true
2867
+ },
2868
+ {
2869
+ "kind": "field",
2870
+ "name": "size",
2871
+ "type": {
2872
+ "text": "ButtonGroupSize"
2873
+ },
2874
+ "description": "Size of the buttons within the buttongroup.",
2875
+ "default": "'28'",
2876
+ "attribute": "size",
2877
+ "reflects": true
2878
+ },
2879
+ {
2880
+ "kind": "field",
2881
+ "name": "compact",
2882
+ "type": {
2883
+ "text": "boolean"
2884
+ },
2885
+ "default": "false",
2886
+ "description": "When this is true, the buttons within the buttongroup will be compact.\ni.e. Irrespective of the size of the buttons, they will have a height of 24px.",
2887
+ "attribute": "compact",
2888
+ "reflects": true
2889
+ }
2890
+ ],
2891
+ "attributes": [
2892
+ {
2893
+ "name": "orientation",
2894
+ "type": {
2895
+ "text": "ButtonGroupOrientation"
2896
+ },
2897
+ "description": "Orientation of the buttongroup.",
2898
+ "default": "'horizontal'",
2899
+ "fieldName": "orientation"
2900
+ },
2901
+ {
2902
+ "name": "variant",
2903
+ "type": {
2904
+ "text": "ButtonGroupVariant"
2905
+ },
2906
+ "description": "Variant of the buttons within the buttongroup.",
2907
+ "default": "'primary'",
2908
+ "fieldName": "variant"
2909
+ },
2910
+ {
2911
+ "name": "size",
2912
+ "type": {
2913
+ "text": "ButtonGroupSize"
2914
+ },
2915
+ "description": "Size of the buttons within the buttongroup.",
2916
+ "default": "'28'",
2917
+ "fieldName": "size"
2918
+ },
2919
+ {
2920
+ "name": "compact",
2921
+ "type": {
2922
+ "text": "boolean"
2923
+ },
2924
+ "default": "false",
2925
+ "description": "When this is true, the buttons within the buttongroup will be compact.\ni.e. Irrespective of the size of the buttons, they will have a height of 24px.",
2926
+ "fieldName": "compact"
2927
+ }
2928
+ ],
2929
+ "superclass": {
2930
+ "name": "Component",
2931
+ "module": "/src/models"
2932
+ },
2933
+ "tagName": "mdc-buttongroup",
2934
+ "jsDoc": "/**\n * buttongroup component, is a styled wrapper for multiple buttons.\n * It can support icon buttons, combination of icon and pill buttons, and text buttons.\n * They are available in horizontal and vertical orientation.\n *\n * @tagname mdc-buttongroup\n *\n * @slot default - This is a default/unnamed slot, which contains the buttons\n *\n * @cssproperty --mdc-buttongroup-border-radius - The border radius of the buttongroup\n * @cssproperty --mdc-buttongroup-border-color - The border color of the buttongroup\n * @cssproperty --mdc-buttongroup-divider-color - The color of the divider between buttons within the buttongroup\n */",
2935
+ "customElement": true
2936
+ }
2937
+ ],
2938
+ "exports": [
2939
+ {
2940
+ "kind": "js",
2941
+ "name": "default",
2942
+ "declaration": {
2943
+ "name": "ButtonGroup",
2944
+ "module": "components/buttongroup/buttongroup.component.js"
2945
+ }
2946
+ }
2947
+ ]
2948
+ },
2949
2949
  {
2950
2950
  "kind": "javascript-module",
2951
2951
  "path": "components/buttonlink/buttonlink.component.js",
@@ -6362,7 +6362,7 @@
6362
6362
  "kind": "method",
6363
6363
  "name": "manageRequired",
6364
6364
  "privacy": "private",
6365
- "description": "Manages the required state of the checkbox.\nIf the checkbox is not checked and the requiredLabel property is set, then the checkbox is invalid."
6365
+ "description": "Manages the required state of the checkbox.\nIf the checkbox is not checked and the required property is set, then the checkbox is invalid."
6366
6366
  },
6367
6367
  {
6368
6368
  "kind": "method",
@@ -6565,12 +6565,13 @@
6565
6565
  },
6566
6566
  {
6567
6567
  "kind": "field",
6568
- "name": "requiredLabel",
6568
+ "name": "required",
6569
6569
  "type": {
6570
- "text": "string | undefined"
6570
+ "text": "boolean"
6571
6571
  },
6572
- "description": "The required label of the input field.\nWhen an appropriate string value is set,\nthe input field is marked as required and the label is appended with this text.",
6573
- "attribute": "required-label",
6572
+ "default": "false",
6573
+ "description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
6574
+ "attribute": "required",
6574
6575
  "reflects": true,
6575
6576
  "inheritedFrom": {
6576
6577
  "name": "FormfieldWrapper",
@@ -6634,15 +6635,6 @@
6634
6635
  "module": "components/formfieldwrapper/formfieldwrapper.component.js"
6635
6636
  }
6636
6637
  },
6637
- {
6638
- "kind": "method",
6639
- "name": "renderRequiredLabel",
6640
- "privacy": "protected",
6641
- "inheritedFrom": {
6642
- "name": "FormfieldWrapper",
6643
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
6644
- }
6645
- },
6646
6638
  {
6647
6639
  "kind": "method",
6648
6640
  "name": "renderHelpTextIcon",
@@ -6826,12 +6818,13 @@
6826
6818
  }
6827
6819
  },
6828
6820
  {
6829
- "name": "required-label",
6821
+ "name": "required",
6830
6822
  "type": {
6831
- "text": "string | undefined"
6823
+ "text": "boolean"
6832
6824
  },
6833
- "description": "The required label of the input field.\nWhen an appropriate string value is set,\nthe input field is marked as required and the label is appended with this text.",
6834
- "fieldName": "requiredLabel",
6825
+ "default": "false",
6826
+ "description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
6827
+ "fieldName": "required",
6835
6828
  "inheritedFrom": {
6836
6829
  "name": "FormfieldWrapper",
6837
6830
  "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
@@ -10893,12 +10886,13 @@
10893
10886
  },
10894
10887
  {
10895
10888
  "kind": "field",
10896
- "name": "requiredLabel",
10889
+ "name": "required",
10897
10890
  "type": {
10898
- "text": "string | undefined"
10891
+ "text": "boolean"
10899
10892
  },
10900
- "description": "The required label of the input field.\nWhen an appropriate string value is set,\nthe input field is marked as required and the label is appended with this text.",
10901
- "attribute": "required-label",
10893
+ "default": "false",
10894
+ "description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
10895
+ "attribute": "required",
10902
10896
  "reflects": true,
10903
10897
  "inheritedFrom": {
10904
10898
  "name": "FormfieldWrapper",
@@ -10962,15 +10956,6 @@
10962
10956
  "module": "components/formfieldwrapper/formfieldwrapper.component.js"
10963
10957
  }
10964
10958
  },
10965
- {
10966
- "kind": "method",
10967
- "name": "renderRequiredLabel",
10968
- "privacy": "protected",
10969
- "inheritedFrom": {
10970
- "name": "FormfieldWrapper",
10971
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
10972
- }
10973
- },
10974
10959
  {
10975
10960
  "kind": "method",
10976
10961
  "name": "renderHelpTextIcon",
@@ -11085,12 +11070,13 @@
11085
11070
  }
11086
11071
  },
11087
11072
  {
11088
- "name": "required-label",
11073
+ "name": "required",
11089
11074
  "type": {
11090
- "text": "string | undefined"
11075
+ "text": "boolean"
11091
11076
  },
11092
- "description": "The required label of the input field.\nWhen an appropriate string value is set,\nthe input field is marked as required and the label is appended with this text.",
11093
- "fieldName": "requiredLabel",
11077
+ "default": "false",
11078
+ "description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
11079
+ "fieldName": "required",
11094
11080
  "inheritedFrom": {
11095
11081
  "name": "FormfieldWrapper",
11096
11082
  "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
@@ -11174,12 +11160,13 @@
11174
11160
  },
11175
11161
  {
11176
11162
  "kind": "field",
11177
- "name": "requiredLabel",
11163
+ "name": "required",
11178
11164
  "type": {
11179
- "text": "string | undefined"
11165
+ "text": "boolean"
11180
11166
  },
11181
- "description": "The required label of the input field.\nWhen an appropriate string value is set,\nthe input field is marked as required and the label is appended with this text.",
11182
- "attribute": "required-label",
11167
+ "default": "false",
11168
+ "description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
11169
+ "attribute": "required",
11183
11170
  "reflects": true
11184
11171
  },
11185
11172
  {
@@ -11223,11 +11210,6 @@
11223
11210
  }
11224
11211
  }
11225
11212
  },
11226
- {
11227
- "kind": "method",
11228
- "name": "renderRequiredLabel",
11229
- "privacy": "protected"
11230
- },
11231
11213
  {
11232
11214
  "kind": "method",
11233
11215
  "name": "renderHelpTextIcon",
@@ -11298,12 +11280,13 @@
11298
11280
  "fieldName": "label"
11299
11281
  },
11300
11282
  {
11301
- "name": "required-label",
11283
+ "name": "required",
11302
11284
  "type": {
11303
- "text": "string | undefined"
11285
+ "text": "boolean"
11304
11286
  },
11305
- "description": "The required label of the input field.\nWhen an appropriate string value is set,\nthe input field is marked as required and the label is appended with this text.",
11306
- "fieldName": "requiredLabel"
11287
+ "default": "false",
11288
+ "description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
11289
+ "fieldName": "required"
11307
11290
  },
11308
11291
  {
11309
11292
  "name": "id",
@@ -12296,12 +12279,13 @@
12296
12279
  },
12297
12280
  {
12298
12281
  "kind": "field",
12299
- "name": "requiredLabel",
12282
+ "name": "required",
12300
12283
  "type": {
12301
- "text": "string | undefined"
12284
+ "text": "boolean"
12302
12285
  },
12303
- "description": "The required label of the input field.\nWhen an appropriate string value is set,\nthe input field is marked as required and the label is appended with this text.",
12304
- "attribute": "required-label",
12286
+ "default": "false",
12287
+ "description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
12288
+ "attribute": "required",
12305
12289
  "reflects": true,
12306
12290
  "inheritedFrom": {
12307
12291
  "name": "FormfieldWrapper",
@@ -12365,15 +12349,6 @@
12365
12349
  "module": "components/formfieldwrapper/formfieldwrapper.component.js"
12366
12350
  }
12367
12351
  },
12368
- {
12369
- "kind": "method",
12370
- "name": "renderRequiredLabel",
12371
- "privacy": "protected",
12372
- "inheritedFrom": {
12373
- "name": "FormfieldWrapper",
12374
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
12375
- }
12376
- },
12377
12352
  {
12378
12353
  "kind": "method",
12379
12354
  "name": "renderHelpTextIcon",
@@ -12668,12 +12643,13 @@
12668
12643
  }
12669
12644
  },
12670
12645
  {
12671
- "name": "required-label",
12646
+ "name": "required",
12672
12647
  "type": {
12673
- "text": "string | undefined"
12648
+ "text": "boolean"
12674
12649
  },
12675
- "description": "The required label of the input field.\nWhen an appropriate string value is set,\nthe input field is marked as required and the label is appended with this text.",
12676
- "fieldName": "requiredLabel",
12650
+ "default": "false",
12651
+ "description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
12652
+ "fieldName": "required",
12677
12653
  "inheritedFrom": {
12678
12654
  "name": "FormfieldWrapper",
12679
12655
  "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
@@ -22433,12 +22409,13 @@
22433
22409
  },
22434
22410
  {
22435
22411
  "kind": "field",
22436
- "name": "requiredLabel",
22412
+ "name": "required",
22437
22413
  "type": {
22438
- "text": "string | undefined"
22414
+ "text": "boolean"
22439
22415
  },
22440
- "description": "The required label of the input field.\nWhen an appropriate string value is set,\nthe input field is marked as required and the label is appended with this text.",
22441
- "attribute": "required-label",
22416
+ "default": "false",
22417
+ "description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
22418
+ "attribute": "required",
22442
22419
  "reflects": true,
22443
22420
  "inheritedFrom": {
22444
22421
  "name": "FormfieldWrapper",
@@ -22502,15 +22479,6 @@
22502
22479
  "module": "components/formfieldwrapper/formfieldwrapper.component.js"
22503
22480
  }
22504
22481
  },
22505
- {
22506
- "kind": "method",
22507
- "name": "renderRequiredLabel",
22508
- "privacy": "protected",
22509
- "inheritedFrom": {
22510
- "name": "FormfieldWrapper",
22511
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
22512
- }
22513
- },
22514
22482
  {
22515
22483
  "kind": "method",
22516
22484
  "name": "renderHelpTextIcon",
@@ -22639,12 +22607,13 @@
22639
22607
  }
22640
22608
  },
22641
22609
  {
22642
- "name": "required-label",
22610
+ "name": "required",
22643
22611
  "type": {
22644
- "text": "string | undefined"
22612
+ "text": "boolean"
22645
22613
  },
22646
- "description": "The required label of the input field.\nWhen an appropriate string value is set,\nthe input field is marked as required and the label is appended with this text.",
22647
- "fieldName": "requiredLabel",
22614
+ "default": "false",
22615
+ "description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
22616
+ "fieldName": "required",
22648
22617
  "inheritedFrom": {
22649
22618
  "name": "FormfieldWrapper",
22650
22619
  "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
@@ -22975,12 +22944,13 @@
22975
22944
  },
22976
22945
  {
22977
22946
  "kind": "field",
22978
- "name": "requiredLabel",
22947
+ "name": "required",
22979
22948
  "type": {
22980
- "text": "string | undefined"
22949
+ "text": "boolean"
22981
22950
  },
22982
- "description": "The required label of the input field.\nWhen an appropriate string value is set,\nthe input field is marked as required and the label is appended with this text.",
22983
- "attribute": "required-label",
22951
+ "default": "false",
22952
+ "description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
22953
+ "attribute": "required",
22984
22954
  "reflects": true,
22985
22955
  "inheritedFrom": {
22986
22956
  "name": "FormfieldWrapper",
@@ -23044,15 +23014,6 @@
23044
23014
  "module": "components/formfieldwrapper/formfieldwrapper.component.js"
23045
23015
  }
23046
23016
  },
23047
- {
23048
- "kind": "method",
23049
- "name": "renderRequiredLabel",
23050
- "privacy": "protected",
23051
- "inheritedFrom": {
23052
- "name": "FormfieldWrapper",
23053
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
23054
- }
23055
- },
23056
23017
  {
23057
23018
  "kind": "method",
23058
23019
  "name": "renderHelpTextIcon",
@@ -23200,12 +23161,13 @@
23200
23161
  }
23201
23162
  },
23202
23163
  {
23203
- "name": "required-label",
23164
+ "name": "required",
23204
23165
  "type": {
23205
- "text": "string | undefined"
23166
+ "text": "boolean"
23206
23167
  },
23207
- "description": "The required label of the input field.\nWhen an appropriate string value is set,\nthe input field is marked as required and the label is appended with this text.",
23208
- "fieldName": "requiredLabel",
23168
+ "default": "false",
23169
+ "description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
23170
+ "fieldName": "required",
23209
23171
  "inheritedFrom": {
23210
23172
  "name": "FormfieldWrapper",
23211
23173
  "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
@@ -23635,12 +23597,13 @@
23635
23597
  },
23636
23598
  {
23637
23599
  "kind": "field",
23638
- "name": "requiredLabel",
23600
+ "name": "required",
23639
23601
  "type": {
23640
- "text": "string | undefined"
23602
+ "text": "boolean"
23641
23603
  },
23642
- "description": "The required label of the input field.\nWhen an appropriate string value is set,\nthe input field is marked as required and the label is appended with this text.",
23643
- "attribute": "required-label",
23604
+ "default": "false",
23605
+ "description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
23606
+ "attribute": "required",
23644
23607
  "reflects": true,
23645
23608
  "inheritedFrom": {
23646
23609
  "name": "FormfieldWrapper",
@@ -23704,15 +23667,6 @@
23704
23667
  "module": "components/formfieldwrapper/formfieldwrapper.component.js"
23705
23668
  }
23706
23669
  },
23707
- {
23708
- "kind": "method",
23709
- "name": "renderRequiredLabel",
23710
- "privacy": "protected",
23711
- "inheritedFrom": {
23712
- "name": "FormfieldWrapper",
23713
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
23714
- }
23715
- },
23716
23670
  {
23717
23671
  "kind": "method",
23718
23672
  "name": "renderHelpTextIcon",
@@ -23896,12 +23850,13 @@
23896
23850
  }
23897
23851
  },
23898
23852
  {
23899
- "name": "required-label",
23853
+ "name": "required",
23900
23854
  "type": {
23901
- "text": "string | undefined"
23855
+ "text": "boolean"
23902
23856
  },
23903
- "description": "The required label of the input field.\nWhen an appropriate string value is set,\nthe input field is marked as required and the label is appended with this text.",
23904
- "fieldName": "requiredLabel",
23857
+ "default": "false",
23858
+ "description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
23859
+ "fieldName": "required",
23905
23860
  "inheritedFrom": {
23906
23861
  "name": "FormfieldWrapper",
23907
23862
  "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
@@ -24056,12 +24011,13 @@
24056
24011
  },
24057
24012
  {
24058
24013
  "kind": "field",
24059
- "name": "requiredLabel",
24014
+ "name": "required",
24060
24015
  "type": {
24061
- "text": "string | undefined"
24016
+ "text": "boolean"
24062
24017
  },
24063
- "description": "The required label of the input field.\nWhen an appropriate string value is set,\nthe input field is marked as required and the label is appended with this text.",
24064
- "attribute": "required-label",
24018
+ "default": "false",
24019
+ "description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
24020
+ "attribute": "required",
24065
24021
  "reflects": true,
24066
24022
  "inheritedFrom": {
24067
24023
  "name": "FormfieldWrapper",
@@ -24125,15 +24081,6 @@
24125
24081
  "module": "components/formfieldwrapper/formfieldwrapper.component.js"
24126
24082
  }
24127
24083
  },
24128
- {
24129
- "kind": "method",
24130
- "name": "renderRequiredLabel",
24131
- "privacy": "protected",
24132
- "inheritedFrom": {
24133
- "name": "FormfieldWrapper",
24134
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
24135
- }
24136
- },
24137
24084
  {
24138
24085
  "kind": "method",
24139
24086
  "name": "renderHelpTextIcon",
@@ -24244,12 +24191,13 @@
24244
24191
  }
24245
24192
  },
24246
24193
  {
24247
- "name": "required-label",
24194
+ "name": "required",
24248
24195
  "type": {
24249
- "text": "string | undefined"
24196
+ "text": "boolean"
24250
24197
  },
24251
- "description": "The required label of the input field.\nWhen an appropriate string value is set,\nthe input field is marked as required and the label is appended with this text.",
24252
- "fieldName": "requiredLabel",
24198
+ "default": "false",
24199
+ "description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
24200
+ "fieldName": "required",
24253
24201
  "inheritedFrom": {
24254
24202
  "name": "FormfieldWrapper",
24255
24203
  "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
@@ -25063,12 +25011,13 @@
25063
25011
  },
25064
25012
  {
25065
25013
  "kind": "field",
25066
- "name": "requiredLabel",
25014
+ "name": "required",
25067
25015
  "type": {
25068
- "text": "string | undefined"
25016
+ "text": "boolean"
25069
25017
  },
25070
- "description": "The required label of the input field.\nWhen an appropriate string value is set,\nthe input field is marked as required and the label is appended with this text.",
25071
- "attribute": "required-label",
25018
+ "default": "false",
25019
+ "description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
25020
+ "attribute": "required",
25072
25021
  "reflects": true,
25073
25022
  "inheritedFrom": {
25074
25023
  "name": "FormfieldWrapper",
@@ -25132,15 +25081,6 @@
25132
25081
  "module": "components/formfieldwrapper/formfieldwrapper.component.js"
25133
25082
  }
25134
25083
  },
25135
- {
25136
- "kind": "method",
25137
- "name": "renderRequiredLabel",
25138
- "privacy": "protected",
25139
- "inheritedFrom": {
25140
- "name": "FormfieldWrapper",
25141
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
25142
- }
25143
- },
25144
25084
  {
25145
25085
  "kind": "method",
25146
25086
  "name": "renderHelpTextIcon",
@@ -25475,12 +25415,13 @@
25475
25415
  }
25476
25416
  },
25477
25417
  {
25478
- "name": "required-label",
25418
+ "name": "required",
25479
25419
  "type": {
25480
- "text": "string | undefined"
25420
+ "text": "boolean"
25481
25421
  },
25482
- "description": "The required label of the input field.\nWhen an appropriate string value is set,\nthe input field is marked as required and the label is appended with this text.",
25483
- "fieldName": "requiredLabel",
25422
+ "default": "false",
25423
+ "description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
25424
+ "fieldName": "required",
25484
25425
  "inheritedFrom": {
25485
25426
  "name": "FormfieldWrapper",
25486
25427
  "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
@@ -25853,12 +25794,6 @@
25853
25794
  ],
25854
25795
  "description": "Sets the selected value based on the provided option element.\nIt retrieves the 'label' attribute of the option, if present,\notherwise it falls back to the option's text content."
25855
25796
  },
25856
- {
25857
- "kind": "method",
25858
- "name": "manageRequired",
25859
- "privacy": "private",
25860
- "description": "Manages the required state of the select.\nIf the value is not set and the requiredLabel property is set,\nthen the select is invalid."
25861
- },
25862
25797
  {
25863
25798
  "kind": "method",
25864
25799
  "name": "dispatchChange",
@@ -26236,12 +26171,13 @@
26236
26171
  },
26237
26172
  {
26238
26173
  "kind": "field",
26239
- "name": "requiredLabel",
26174
+ "name": "required",
26240
26175
  "type": {
26241
- "text": "string | undefined"
26176
+ "text": "boolean"
26242
26177
  },
26243
- "description": "The required label of the input field.\nWhen an appropriate string value is set,\nthe input field is marked as required and the label is appended with this text.",
26244
- "attribute": "required-label",
26178
+ "default": "false",
26179
+ "description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
26180
+ "attribute": "required",
26245
26181
  "reflects": true,
26246
26182
  "inheritedFrom": {
26247
26183
  "name": "FormfieldWrapper",
@@ -26305,15 +26241,6 @@
26305
26241
  "module": "components/formfieldwrapper/formfieldwrapper.component.js"
26306
26242
  }
26307
26243
  },
26308
- {
26309
- "kind": "method",
26310
- "name": "renderRequiredLabel",
26311
- "privacy": "protected",
26312
- "inheritedFrom": {
26313
- "name": "FormfieldWrapper",
26314
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
26315
- }
26316
- },
26317
26244
  {
26318
26245
  "kind": "method",
26319
26246
  "name": "renderHelpTextIcon",
@@ -26504,12 +26431,13 @@
26504
26431
  }
26505
26432
  },
26506
26433
  {
26507
- "name": "required-label",
26434
+ "name": "required",
26508
26435
  "type": {
26509
- "text": "string | undefined"
26436
+ "text": "boolean"
26510
26437
  },
26511
- "description": "The required label of the input field.\nWhen an appropriate string value is set,\nthe input field is marked as required and the label is appended with this text.",
26512
- "fieldName": "requiredLabel",
26438
+ "default": "false",
26439
+ "description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
26440
+ "fieldName": "required",
26513
26441
  "inheritedFrom": {
26514
26442
  "name": "FormfieldWrapper",
26515
26443
  "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
@@ -28147,7 +28075,7 @@
28147
28075
  "declarations": [
28148
28076
  {
28149
28077
  "kind": "class",
28150
- "description": "mdc-textarea component, which is used to get the multi-line text input from the user.\nIt contains:\n- label: It is the title of the textarea field.\n- required-label: A string depicting that the textarea field is required.\n- Textarea: It is the multi-line text input field.\n- helper-text: It is the text that provides additional information about the textarea field.\n- max-character-limit: It is the text that shows the character count of the textarea field.\n- Error, Warning, Success, Priority Help Text type: It is the text that provides additional information\n about the textarea field based on the validation state.\n- limitexceeded: It is the event that is dispatched when the character limit exceeds or restored.\n This event exposes 3 properties:\n - currentCharacterCount - the current number of characters in the textarea field,\n - maxCharacterLimit - the maximum number of characters allowed in the textarea field,\n - value - the current value of the textarea field,\n\n**Note**: Consumers must set the help-text-type with 'error' and\nhelp-text attribute with the error message using limitexceeded event.\nThe same help-text value will be used for the validation message to be displayed.",
28078
+ "description": "mdc-textarea component, which is used to get the multi-line text input from the user.\nIt contains:\n- label: It is the title of the textarea field.\n- required: A boolean attribute depicting that the textarea field is required.\n- Textarea: It is the multi-line text input field.\n- helper-text: It is the text that provides additional information about the textarea field.\n- max-character-limit: It is the text that shows the character count of the textarea field.\n- Error, Warning, Success, Priority Help Text type: It is the text that provides additional information\n about the textarea field based on the validation state.\n- limitexceeded: It is the event that is dispatched when the character limit exceeds or restored.\n This event exposes 3 properties:\n - currentCharacterCount - the current number of characters in the textarea field,\n - maxCharacterLimit - the maximum number of characters allowed in the textarea field,\n - value - the current value of the textarea field,\n\n**Note**: Consumers must set the help-text-type with 'error' and\nhelp-text attribute with the error message using limitexceeded event.\nThe same help-text value will be used for the validation message to be displayed.",
28151
28079
  "name": "Textarea",
28152
28080
  "cssProperties": [
28153
28081
  {
@@ -28554,12 +28482,13 @@
28554
28482
  },
28555
28483
  {
28556
28484
  "kind": "field",
28557
- "name": "requiredLabel",
28485
+ "name": "required",
28558
28486
  "type": {
28559
- "text": "string | undefined"
28487
+ "text": "boolean"
28560
28488
  },
28561
- "description": "The required label of the input field.\nWhen an appropriate string value is set,\nthe input field is marked as required and the label is appended with this text.",
28562
- "attribute": "required-label",
28489
+ "default": "false",
28490
+ "description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
28491
+ "attribute": "required",
28563
28492
  "reflects": true,
28564
28493
  "inheritedFrom": {
28565
28494
  "name": "FormfieldWrapper",
@@ -28623,15 +28552,6 @@
28623
28552
  "module": "components/formfieldwrapper/formfieldwrapper.component.js"
28624
28553
  }
28625
28554
  },
28626
- {
28627
- "kind": "method",
28628
- "name": "renderRequiredLabel",
28629
- "privacy": "protected",
28630
- "inheritedFrom": {
28631
- "name": "FormfieldWrapper",
28632
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
28633
- }
28634
- },
28635
28555
  {
28636
28556
  "kind": "method",
28637
28557
  "name": "renderHelpTextIcon",
@@ -28903,12 +28823,13 @@
28903
28823
  }
28904
28824
  },
28905
28825
  {
28906
- "name": "required-label",
28826
+ "name": "required",
28907
28827
  "type": {
28908
- "text": "string | undefined"
28828
+ "text": "boolean"
28909
28829
  },
28910
- "description": "The required label of the input field.\nWhen an appropriate string value is set,\nthe input field is marked as required and the label is appended with this text.",
28911
- "fieldName": "requiredLabel",
28830
+ "default": "false",
28831
+ "description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
28832
+ "fieldName": "required",
28912
28833
  "inheritedFrom": {
28913
28834
  "name": "FormfieldWrapper",
28914
28835
  "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
@@ -28967,7 +28888,7 @@
28967
28888
  "module": "/src/components/formfieldwrapper"
28968
28889
  },
28969
28890
  "tagName": "mdc-textarea",
28970
- "jsDoc": "/**\n * mdc-textarea component, which is used to get the multi-line text input from the user.\n * It contains:\n * - label: It is the title of the textarea field.\n * - required-label: A string depicting that the textarea field is required.\n * - Textarea: It is the multi-line text input field.\n * - helper-text: It is the text that provides additional information about the textarea field.\n * - max-character-limit: It is the text that shows the character count of the textarea field.\n * - Error, Warning, Success, Priority Help Text type: It is the text that provides additional information\n * about the textarea field based on the validation state.\n * - limitexceeded: It is the event that is dispatched when the character limit exceeds or restored.\n * This event exposes 3 properties:\n * - currentCharacterCount - the current number of characters in the textarea field,\n * - maxCharacterLimit - the maximum number of characters allowed in the textarea field,\n * - value - the current value of the textarea field,\n *\n * **Note**: Consumers must set the help-text-type with 'error' and\n * help-text attribute with the error message using limitexceeded event.\n * The same help-text value will be used for the validation message to be displayed.\n *\n * @tagname mdc-textarea\n *\n * @event input - (React: onInput) This event is dispatched when the value of the textarea field changes (every press).\n * @event change - (React: onChange) This event is dispatched when the value of the textarea field changes (on blur).\n * @event focus - (React: onFocus) This event is dispatched when the textarea receives focus.\n * @event blur - (React: onBlur) This event is dispatched when the textarea loses focus.\n * @event limitexceeded - (React: onLimitExceeded) This event is dispatched once when the character limit\n * exceeds or restored.\n *\n *\n * @dependency mdc-icon\n * @dependency mdc-text\n * @dependency mdc-button\n *\n * @cssproperty --mdc-textarea-disabled-border-color - Border color for the textarea container when disabled\n * @cssproperty --mdc-textarea-disabled-text-color - Text color for the textarea field when disabled\n * @cssproperty --mdc-textarea-disabled-background-color - Background color for the textarea field when disabled\n * @cssproperty --mdc-textarea-text-color - Text color for the textarea field\n * @cssproperty --mdc-textarea-background-color - Background color for the textarea field\n * @cssproperty --mdc-textarea-border-color - Border color for the textarea field\n * @cssproperty --mdc-textarea-text-secondary-normal - Text color for the character counter\n * @cssproperty --mdc-textarea-error-border-color - Border color for the error related help text\n * @cssproperty --mdc-textarea-warning-border-color - Border color for the warning related help text\n * @cssproperty --mdc-textarea-success-border-color - Border color for the success related help text\n * @cssproperty --mdc-textarea-primary-border-color - Border color for the priority related help text\n * @cssproperty --mdc-textarea-hover-background-color - Background color for the textarea container when hover\n * @cssproperty --mdc-textarea-focused-background-color - Background color for the textarea container when focused\n * @cssproperty --mdc-textarea-focused-border-color - Border color for the textarea container when focused\n */",
28891
+ "jsDoc": "/**\n * mdc-textarea component, which is used to get the multi-line text input from the user.\n * It contains:\n * - label: It is the title of the textarea field.\n * - required: A boolean attribute depicting that the textarea field is required.\n * - Textarea: It is the multi-line text input field.\n * - helper-text: It is the text that provides additional information about the textarea field.\n * - max-character-limit: It is the text that shows the character count of the textarea field.\n * - Error, Warning, Success, Priority Help Text type: It is the text that provides additional information\n * about the textarea field based on the validation state.\n * - limitexceeded: It is the event that is dispatched when the character limit exceeds or restored.\n * This event exposes 3 properties:\n * - currentCharacterCount - the current number of characters in the textarea field,\n * - maxCharacterLimit - the maximum number of characters allowed in the textarea field,\n * - value - the current value of the textarea field,\n *\n * **Note**: Consumers must set the help-text-type with 'error' and\n * help-text attribute with the error message using limitexceeded event.\n * The same help-text value will be used for the validation message to be displayed.\n *\n * @tagname mdc-textarea\n *\n * @event input - (React: onInput) This event is dispatched when the value of the textarea field changes (every press).\n * @event change - (React: onChange) This event is dispatched when the value of the textarea field changes (on blur).\n * @event focus - (React: onFocus) This event is dispatched when the textarea receives focus.\n * @event blur - (React: onBlur) This event is dispatched when the textarea loses focus.\n * @event limitexceeded - (React: onLimitExceeded) This event is dispatched once when the character limit\n * exceeds or restored.\n *\n *\n * @dependency mdc-icon\n * @dependency mdc-text\n * @dependency mdc-button\n *\n * @cssproperty --mdc-textarea-disabled-border-color - Border color for the textarea container when disabled\n * @cssproperty --mdc-textarea-disabled-text-color - Text color for the textarea field when disabled\n * @cssproperty --mdc-textarea-disabled-background-color - Background color for the textarea field when disabled\n * @cssproperty --mdc-textarea-text-color - Text color for the textarea field\n * @cssproperty --mdc-textarea-background-color - Background color for the textarea field\n * @cssproperty --mdc-textarea-border-color - Border color for the textarea field\n * @cssproperty --mdc-textarea-text-secondary-normal - Text color for the character counter\n * @cssproperty --mdc-textarea-error-border-color - Border color for the error related help text\n * @cssproperty --mdc-textarea-warning-border-color - Border color for the warning related help text\n * @cssproperty --mdc-textarea-success-border-color - Border color for the success related help text\n * @cssproperty --mdc-textarea-primary-border-color - Border color for the priority related help text\n * @cssproperty --mdc-textarea-hover-background-color - Background color for the textarea container when hover\n * @cssproperty --mdc-textarea-focused-background-color - Background color for the textarea container when focused\n * @cssproperty --mdc-textarea-focused-border-color - Border color for the textarea container when focused\n */",
28971
28892
  "customElement": true,
28972
28893
  "slots": [
28973
28894
  {
@@ -29210,7 +29131,7 @@
29210
29131
  "kind": "method",
29211
29132
  "name": "manageRequired",
29212
29133
  "privacy": "private",
29213
- "description": "Manages the required state of the checkbox.\nIf the checkbox is not checked and the requiredLabel property is set, then the checkbox is invalid."
29134
+ "description": "Manages the required state of the checkbox.\nIf the checkbox is not checked and the required property is set, then the checkbox is invalid.\nIf the validationMessage is set, it will be used as the custom validity message.\nIf the validationMessage is not set, it will clear the custom validity message."
29214
29135
  },
29215
29136
  {
29216
29137
  "kind": "method",
@@ -29424,12 +29345,13 @@
29424
29345
  },
29425
29346
  {
29426
29347
  "kind": "field",
29427
- "name": "requiredLabel",
29348
+ "name": "required",
29428
29349
  "type": {
29429
- "text": "string | undefined"
29350
+ "text": "boolean"
29430
29351
  },
29431
- "description": "The required label of the input field.\nWhen an appropriate string value is set,\nthe input field is marked as required and the label is appended with this text.",
29432
- "attribute": "required-label",
29352
+ "default": "false",
29353
+ "description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
29354
+ "attribute": "required",
29433
29355
  "reflects": true,
29434
29356
  "inheritedFrom": {
29435
29357
  "name": "FormfieldWrapper",
@@ -29493,15 +29415,6 @@
29493
29415
  "module": "components/formfieldwrapper/formfieldwrapper.component.js"
29494
29416
  }
29495
29417
  },
29496
- {
29497
- "kind": "method",
29498
- "name": "renderRequiredLabel",
29499
- "privacy": "protected",
29500
- "inheritedFrom": {
29501
- "name": "FormfieldWrapper",
29502
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
29503
- }
29504
- },
29505
29418
  {
29506
29419
  "kind": "method",
29507
29420
  "name": "renderHelpTextIcon",
@@ -29685,12 +29598,13 @@
29685
29598
  }
29686
29599
  },
29687
29600
  {
29688
- "name": "required-label",
29601
+ "name": "required",
29689
29602
  "type": {
29690
- "text": "string | undefined"
29603
+ "text": "boolean"
29691
29604
  },
29692
- "description": "The required label of the input field.\nWhen an appropriate string value is set,\nthe input field is marked as required and the label is appended with this text.",
29693
- "fieldName": "requiredLabel",
29605
+ "default": "false",
29606
+ "description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
29607
+ "fieldName": "required",
29694
29608
  "inheritedFrom": {
29695
29609
  "name": "FormfieldWrapper",
29696
29610
  "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"