@momentum-design/components 0.31.2 → 0.32.1

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.
@@ -9241,6 +9241,942 @@
9241
9241
  }
9242
9242
  ]
9243
9243
  },
9244
+ {
9245
+ "kind": "javascript-module",
9246
+ "path": "components/textarea/textarea.component.js",
9247
+ "declarations": [
9248
+ {
9249
+ "kind": "class",
9250
+ "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- clear-button: A boolean value when marked to true represents a button that can\n clear the text value within 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.",
9251
+ "name": "Textarea",
9252
+ "cssProperties": [
9253
+ {
9254
+ "description": "Border color for the textarea container when disabled",
9255
+ "name": "--mdc-textarea-disabled-border-color"
9256
+ },
9257
+ {
9258
+ "description": "Text color for the textarea field when disabled",
9259
+ "name": "--mdc-textarea-disabled-text-color"
9260
+ },
9261
+ {
9262
+ "description": "Background color for the textarea field when disabled",
9263
+ "name": "--mdc-textarea-disabled-background-color"
9264
+ },
9265
+ {
9266
+ "description": "Text color for the textarea field",
9267
+ "name": "--mdc-textarea-text-color"
9268
+ },
9269
+ {
9270
+ "description": "Background color for the textarea field",
9271
+ "name": "--mdc-textarea-background-color"
9272
+ },
9273
+ {
9274
+ "description": "Border color for the textarea field",
9275
+ "name": "--mdc-textarea-border-color"
9276
+ },
9277
+ {
9278
+ "description": "Text color for the character counter",
9279
+ "name": "--mdc-textarea-text-secondary-normal"
9280
+ },
9281
+ {
9282
+ "description": "Border color for the error related help text",
9283
+ "name": "--mdc-textarea-error-border-color"
9284
+ },
9285
+ {
9286
+ "description": "Border color for the warning related help text",
9287
+ "name": "--mdc-textarea-warning-border-color"
9288
+ },
9289
+ {
9290
+ "description": "Border color for the success related help text",
9291
+ "name": "--mdc-textarea-success-border-color"
9292
+ },
9293
+ {
9294
+ "description": "Border color for the priority related help text",
9295
+ "name": "--mdc-textarea-primary-border-color"
9296
+ },
9297
+ {
9298
+ "description": "Background color for the textarea container when hover",
9299
+ "name": "--mdc-textarea-hover-background-color"
9300
+ },
9301
+ {
9302
+ "description": "Background color for the textarea container when focused",
9303
+ "name": "--mdc-textarea-focused-background-color"
9304
+ },
9305
+ {
9306
+ "description": "Border color for the textarea container when focused",
9307
+ "name": "--mdc-textarea-focused-border-color"
9308
+ }
9309
+ ],
9310
+ "members": [
9311
+ {
9312
+ "kind": "field",
9313
+ "name": "placeholder",
9314
+ "type": {
9315
+ "text": "string | undefined"
9316
+ },
9317
+ "description": "The placeholder text that is displayed when the textarea field is empty.",
9318
+ "attribute": "placeholder"
9319
+ },
9320
+ {
9321
+ "kind": "field",
9322
+ "name": "readonly",
9323
+ "type": {
9324
+ "text": "boolean"
9325
+ },
9326
+ "default": "false",
9327
+ "description": "readonly attribute of the textarea field. If true, the textarea field is read-only.",
9328
+ "attribute": "readonly"
9329
+ },
9330
+ {
9331
+ "kind": "field",
9332
+ "name": "rows",
9333
+ "description": "The rows attribute specifies the visible number of lines in a text area.",
9334
+ "default": "5",
9335
+ "attribute": "rows"
9336
+ },
9337
+ {
9338
+ "kind": "field",
9339
+ "name": "cols",
9340
+ "description": "The cols attribute specifies the visible number of lines in a text area.",
9341
+ "default": "40",
9342
+ "attribute": "cols"
9343
+ },
9344
+ {
9345
+ "kind": "field",
9346
+ "name": "wrap",
9347
+ "type": {
9348
+ "text": "WrapType"
9349
+ },
9350
+ "description": "The wrap attribute specifies how the text in a text area is to be wrapped when submitted in a form.",
9351
+ "default": "'soft'",
9352
+ "attribute": "wrap"
9353
+ },
9354
+ {
9355
+ "kind": "field",
9356
+ "name": "autocapitalize",
9357
+ "type": {
9358
+ "text": "AutoCapitalizeType"
9359
+ },
9360
+ "description": "The autocapitalize attribute of the textarea field.",
9361
+ "default": "'off'",
9362
+ "attribute": "autocapitalize"
9363
+ },
9364
+ {
9365
+ "kind": "field",
9366
+ "name": "autocomplete",
9367
+ "type": {
9368
+ "text": "AutoCompleteType"
9369
+ },
9370
+ "description": "The autocomplete attribute of the textarea field.",
9371
+ "default": "'off'",
9372
+ "attribute": "autocomplete"
9373
+ },
9374
+ {
9375
+ "kind": "field",
9376
+ "name": "autofocus",
9377
+ "type": {
9378
+ "text": "boolean"
9379
+ },
9380
+ "default": "false",
9381
+ "description": "If true, the textarea field is focused when the component is rendered.",
9382
+ "attribute": "autofocus"
9383
+ },
9384
+ {
9385
+ "kind": "field",
9386
+ "name": "dirname",
9387
+ "type": {
9388
+ "text": "string | undefined"
9389
+ },
9390
+ "description": "Specifies the name of the directionality of text for submission purposes (e.g., \"rtl\" for right-to-left).",
9391
+ "attribute": "dirname"
9392
+ },
9393
+ {
9394
+ "kind": "field",
9395
+ "name": "maxlength",
9396
+ "type": {
9397
+ "text": "number | undefined"
9398
+ },
9399
+ "description": "The maximum number of characters that the textarea field can accept.",
9400
+ "attribute": "maxlength"
9401
+ },
9402
+ {
9403
+ "kind": "field",
9404
+ "name": "minlength",
9405
+ "type": {
9406
+ "text": "number | undefined"
9407
+ },
9408
+ "description": "The minimum number of characters that the textarea field can accept.",
9409
+ "attribute": "minlength"
9410
+ },
9411
+ {
9412
+ "kind": "field",
9413
+ "name": "clearButton",
9414
+ "type": {
9415
+ "text": "boolean"
9416
+ },
9417
+ "default": "false",
9418
+ "description": "The clear button when set to true, shows a clear button that clears the textarea field.",
9419
+ "attribute": "clear-button"
9420
+ },
9421
+ {
9422
+ "kind": "field",
9423
+ "name": "clearAriaLabel",
9424
+ "type": {
9425
+ "text": "string"
9426
+ },
9427
+ "default": "''",
9428
+ "description": "Aria label for the clear button. If clear button is set to true, this label is used for the clear button.",
9429
+ "attribute": "clear-aria-label"
9430
+ },
9431
+ {
9432
+ "kind": "field",
9433
+ "name": "maxCharacterLimit",
9434
+ "type": {
9435
+ "text": "number | undefined"
9436
+ },
9437
+ "description": "maximum character limit for the textarea field for character counter.",
9438
+ "attribute": "max-character-limit"
9439
+ },
9440
+ {
9441
+ "kind": "field",
9442
+ "name": "characterLimitExceedingFired",
9443
+ "type": {
9444
+ "text": "boolean"
9445
+ },
9446
+ "privacy": "private",
9447
+ "default": "false"
9448
+ },
9449
+ {
9450
+ "kind": "field",
9451
+ "name": "textarea",
9452
+ "type": {
9453
+ "text": "HTMLTextAreaElement"
9454
+ },
9455
+ "privacy": "protected",
9456
+ "readonly": true
9457
+ },
9458
+ {
9459
+ "kind": "method",
9460
+ "name": "setTextareaValidity",
9461
+ "privacy": "private"
9462
+ },
9463
+ {
9464
+ "kind": "method",
9465
+ "name": "handleValueChange",
9466
+ "description": "Handles the value change of the textarea field.\nSets the form value and updates the validity of the textarea field.",
9467
+ "return": {
9468
+ "type": {
9469
+ "text": ""
9470
+ }
9471
+ }
9472
+ },
9473
+ {
9474
+ "kind": "method",
9475
+ "name": "dispatchCharacterOverflowStateChangeEvent",
9476
+ "privacy": "private",
9477
+ "description": "Dispatches the character overflow state change event.",
9478
+ "return": {
9479
+ "type": {
9480
+ "text": ""
9481
+ }
9482
+ }
9483
+ },
9484
+ {
9485
+ "kind": "method",
9486
+ "name": "handleCharacterOverflowStateChange",
9487
+ "privacy": "private",
9488
+ "description": "Handles the character overflow state change.\nDispatches the character overflow state change event if the character limit is exceeded or restored.",
9489
+ "return": {
9490
+ "type": {
9491
+ "text": ""
9492
+ }
9493
+ }
9494
+ },
9495
+ {
9496
+ "kind": "method",
9497
+ "name": "updateValue",
9498
+ "privacy": "private",
9499
+ "description": "Updates the value of the textarea field.\nSets the form value.",
9500
+ "return": {
9501
+ "type": {
9502
+ "text": ""
9503
+ }
9504
+ }
9505
+ },
9506
+ {
9507
+ "kind": "method",
9508
+ "name": "onChange",
9509
+ "privacy": "private",
9510
+ "parameters": [
9511
+ {
9512
+ "name": "event",
9513
+ "type": {
9514
+ "text": "Event"
9515
+ },
9516
+ "description": "Event which contains information about the value change."
9517
+ }
9518
+ ],
9519
+ "description": "Handles the change event of the textarea field.\nUpdates the value and sets the validity of the textarea field.\n\nThe 'change' event does not bubble up through the shadow DOM as it was not composed.\nTherefore, we need to re-dispatch the same event to ensure it is propagated correctly.\nRead more: https://developer.mozilla.org/en-US/docs/Web/API/Event/composed"
9520
+ },
9521
+ {
9522
+ "kind": "method",
9523
+ "name": "handleKeyDown",
9524
+ "privacy": "private",
9525
+ "parameters": [
9526
+ {
9527
+ "name": "event",
9528
+ "type": {
9529
+ "text": "KeyboardEvent"
9530
+ },
9531
+ "description": "Keyboard event"
9532
+ }
9533
+ ],
9534
+ "description": "Handles the keydown event of the textarea field.\nClears the textarea field when the 'Enter' key is pressed.",
9535
+ "return": {
9536
+ "type": {
9537
+ "text": ""
9538
+ }
9539
+ }
9540
+ },
9541
+ {
9542
+ "kind": "method",
9543
+ "name": "clearInputText",
9544
+ "privacy": "private",
9545
+ "description": "Clears the textarea field.",
9546
+ "return": {
9547
+ "type": {
9548
+ "text": ""
9549
+ }
9550
+ }
9551
+ },
9552
+ {
9553
+ "kind": "method",
9554
+ "name": "renderClearButton",
9555
+ "privacy": "protected",
9556
+ "description": "Renders the clear button to clear the textarea field if the clearButton is set to true.",
9557
+ "return": {
9558
+ "type": {
9559
+ "text": ""
9560
+ }
9561
+ }
9562
+ },
9563
+ {
9564
+ "kind": "method",
9565
+ "name": "renderCharacterCounter",
9566
+ "privacy": "protected"
9567
+ },
9568
+ {
9569
+ "kind": "method",
9570
+ "name": "renderTextareaFooter",
9571
+ "privacy": "protected"
9572
+ },
9573
+ {
9574
+ "kind": "field",
9575
+ "name": "value",
9576
+ "type": {
9577
+ "text": "string"
9578
+ },
9579
+ "default": "''",
9580
+ "description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
9581
+ "attribute": "value",
9582
+ "reflects": true,
9583
+ "inheritedFrom": {
9584
+ "name": "FormInternalsMixin",
9585
+ "module": "utils/mixins/FormInternalsMixin.js"
9586
+ }
9587
+ },
9588
+ {
9589
+ "kind": "field",
9590
+ "name": "name",
9591
+ "type": {
9592
+ "text": "string"
9593
+ },
9594
+ "default": "''",
9595
+ "description": "Indicates the name of the component group.\nThey are used to group elements in a form together.",
9596
+ "attribute": "name",
9597
+ "reflects": true,
9598
+ "inheritedFrom": {
9599
+ "name": "FormInternalsMixin",
9600
+ "module": "utils/mixins/FormInternalsMixin.js"
9601
+ }
9602
+ },
9603
+ {
9604
+ "kind": "field",
9605
+ "name": "validationMessage",
9606
+ "type": {
9607
+ "text": "string | undefined"
9608
+ },
9609
+ "description": "Custom validation message that will override the default message and displayed when the input is invalid.",
9610
+ "attribute": "validation-message",
9611
+ "reflects": true,
9612
+ "inheritedFrom": {
9613
+ "name": "FormInternalsMixin",
9614
+ "module": "utils/mixins/FormInternalsMixin.js"
9615
+ }
9616
+ },
9617
+ {
9618
+ "kind": "field",
9619
+ "name": "validity",
9620
+ "type": {
9621
+ "text": "ValidityState"
9622
+ },
9623
+ "readonly": true,
9624
+ "inheritedFrom": {
9625
+ "name": "FormInternalsMixin",
9626
+ "module": "utils/mixins/FormInternalsMixin.js"
9627
+ }
9628
+ },
9629
+ {
9630
+ "kind": "field",
9631
+ "name": "willValidate",
9632
+ "readonly": true,
9633
+ "inheritedFrom": {
9634
+ "name": "FormInternalsMixin",
9635
+ "module": "utils/mixins/FormInternalsMixin.js"
9636
+ }
9637
+ },
9638
+ {
9639
+ "kind": "method",
9640
+ "name": "setValidity",
9641
+ "description": "Sets the validity of the input field based on the input field's validity.",
9642
+ "return": {
9643
+ "type": {
9644
+ "text": ""
9645
+ }
9646
+ },
9647
+ "inheritedFrom": {
9648
+ "name": "FormInternalsMixin",
9649
+ "module": "utils/mixins/FormInternalsMixin.js"
9650
+ }
9651
+ },
9652
+ {
9653
+ "kind": "method",
9654
+ "name": "checkValidity",
9655
+ "return": {
9656
+ "type": {
9657
+ "text": "boolean"
9658
+ }
9659
+ },
9660
+ "inheritedFrom": {
9661
+ "name": "FormInternalsMixin",
9662
+ "module": "utils/mixins/FormInternalsMixin.js"
9663
+ }
9664
+ },
9665
+ {
9666
+ "kind": "method",
9667
+ "name": "reportValidity",
9668
+ "inheritedFrom": {
9669
+ "name": "FormInternalsMixin",
9670
+ "module": "utils/mixins/FormInternalsMixin.js"
9671
+ }
9672
+ },
9673
+ {
9674
+ "kind": "field",
9675
+ "name": "id",
9676
+ "type": {
9677
+ "text": "string"
9678
+ },
9679
+ "default": "`mdc-input-${uuidv4()}`",
9680
+ "description": "The unique id of the input field. It is used to link the input field with the label.",
9681
+ "attribute": "id",
9682
+ "inheritedFrom": {
9683
+ "name": "FormfieldWrapper",
9684
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
9685
+ }
9686
+ },
9687
+ {
9688
+ "kind": "field",
9689
+ "name": "dataAriaLabel",
9690
+ "type": {
9691
+ "text": "string | null"
9692
+ },
9693
+ "default": "null",
9694
+ "description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
9695
+ "attribute": "data-aria-label",
9696
+ "reflects": true,
9697
+ "inheritedFrom": {
9698
+ "name": "DataAriaLabelMixin",
9699
+ "module": "utils/mixins/DataAriaLabelMixin.js"
9700
+ }
9701
+ },
9702
+ {
9703
+ "kind": "field",
9704
+ "name": "disabled",
9705
+ "type": {
9706
+ "text": "boolean"
9707
+ },
9708
+ "default": "false",
9709
+ "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
9710
+ "attribute": "disabled",
9711
+ "reflects": true,
9712
+ "inheritedFrom": {
9713
+ "name": "FormfieldWrapper",
9714
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
9715
+ }
9716
+ },
9717
+ {
9718
+ "kind": "field",
9719
+ "name": "label",
9720
+ "type": {
9721
+ "text": "string | undefined"
9722
+ },
9723
+ "description": "The label of the input field. It is linked to the input field using the `for` attribute.",
9724
+ "attribute": "label",
9725
+ "reflects": true,
9726
+ "inheritedFrom": {
9727
+ "name": "FormfieldWrapper",
9728
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
9729
+ }
9730
+ },
9731
+ {
9732
+ "kind": "field",
9733
+ "name": "requiredLabel",
9734
+ "type": {
9735
+ "text": "string | undefined"
9736
+ },
9737
+ "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.",
9738
+ "attribute": "required-label",
9739
+ "reflects": true,
9740
+ "inheritedFrom": {
9741
+ "name": "FormfieldWrapper",
9742
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
9743
+ }
9744
+ },
9745
+ {
9746
+ "kind": "field",
9747
+ "name": "helpTextType",
9748
+ "type": {
9749
+ "text": "ValidationType"
9750
+ },
9751
+ "description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
9752
+ "attribute": "help-text-type",
9753
+ "reflects": true,
9754
+ "inheritedFrom": {
9755
+ "name": "FormfieldWrapper",
9756
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
9757
+ }
9758
+ },
9759
+ {
9760
+ "kind": "field",
9761
+ "name": "helpText",
9762
+ "type": {
9763
+ "text": "string | undefined"
9764
+ },
9765
+ "description": "The help text that is displayed below the input field.",
9766
+ "attribute": "help-text",
9767
+ "reflects": true,
9768
+ "inheritedFrom": {
9769
+ "name": "FormfieldWrapper",
9770
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
9771
+ }
9772
+ },
9773
+ {
9774
+ "kind": "method",
9775
+ "name": "renderLabelElement",
9776
+ "privacy": "protected",
9777
+ "description": "creates the label element when the label property is set.\nid is used to link the label with the input field.",
9778
+ "return": {
9779
+ "type": {
9780
+ "text": ""
9781
+ }
9782
+ },
9783
+ "inheritedFrom": {
9784
+ "name": "FormfieldWrapper",
9785
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
9786
+ }
9787
+ },
9788
+ {
9789
+ "kind": "method",
9790
+ "name": "renderRequiredLabel",
9791
+ "privacy": "protected",
9792
+ "inheritedFrom": {
9793
+ "name": "FormfieldWrapper",
9794
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
9795
+ }
9796
+ },
9797
+ {
9798
+ "kind": "method",
9799
+ "name": "renderHelpTextIcon",
9800
+ "privacy": "protected",
9801
+ "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.",
9802
+ "return": {
9803
+ "type": {
9804
+ "text": ""
9805
+ }
9806
+ },
9807
+ "inheritedFrom": {
9808
+ "name": "FormfieldWrapper",
9809
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
9810
+ }
9811
+ },
9812
+ {
9813
+ "kind": "method",
9814
+ "name": "renderHelpText",
9815
+ "privacy": "protected",
9816
+ "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.",
9817
+ "return": {
9818
+ "type": {
9819
+ "text": ""
9820
+ }
9821
+ },
9822
+ "inheritedFrom": {
9823
+ "name": "FormfieldWrapper",
9824
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
9825
+ }
9826
+ },
9827
+ {
9828
+ "kind": "method",
9829
+ "name": "renderLabel",
9830
+ "privacy": "protected",
9831
+ "description": "renders the mdc-label-text container that contains the label and labelInfoToggleTip.",
9832
+ "return": {
9833
+ "type": {
9834
+ "text": ""
9835
+ }
9836
+ },
9837
+ "inheritedFrom": {
9838
+ "name": "FormfieldWrapper",
9839
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
9840
+ }
9841
+ },
9842
+ {
9843
+ "kind": "method",
9844
+ "name": "renderHelperText",
9845
+ "privacy": "protected",
9846
+ "description": "renders the mdc-help-text container that contains the helpertext icon and helpertext.",
9847
+ "return": {
9848
+ "type": {
9849
+ "text": ""
9850
+ }
9851
+ },
9852
+ "inheritedFrom": {
9853
+ "name": "FormfieldWrapper",
9854
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
9855
+ }
9856
+ }
9857
+ ],
9858
+ "events": [
9859
+ {
9860
+ "name": "limitexceeded",
9861
+ "type": {
9862
+ "text": "CustomEvent"
9863
+ },
9864
+ "description": "(React: onLimitExceeded) This event is dispatched once when the character limit exceeds or restored.",
9865
+ "reactName": "onLimitExceeded",
9866
+ "eventName": "LimitexceededEvent"
9867
+ },
9868
+ {
9869
+ "type": {
9870
+ "text": "EventConstructor"
9871
+ }
9872
+ },
9873
+ {
9874
+ "description": "(React: onInput) This event is dispatched when the value of the textarea field changes (every press).",
9875
+ "name": "input",
9876
+ "reactName": "onInput",
9877
+ "eventName": "InputEvent"
9878
+ },
9879
+ {
9880
+ "description": "(React: onChange) This event is dispatched when the value of the textarea field changes (on blur).",
9881
+ "name": "change",
9882
+ "reactName": "onChange",
9883
+ "eventName": "ChangeEvent"
9884
+ },
9885
+ {
9886
+ "description": "(React: onFocus) This event is dispatched when the textarea receives focus.",
9887
+ "name": "focus",
9888
+ "reactName": "onFocus",
9889
+ "eventName": "FocusEvent"
9890
+ },
9891
+ {
9892
+ "description": "(React: onBlur) This event is dispatched when the textarea loses focus.",
9893
+ "name": "blur",
9894
+ "reactName": "onBlur",
9895
+ "eventName": "BlurEvent"
9896
+ }
9897
+ ],
9898
+ "attributes": [
9899
+ {
9900
+ "name": "placeholder",
9901
+ "type": {
9902
+ "text": "string | undefined"
9903
+ },
9904
+ "description": "The placeholder text that is displayed when the textarea field is empty.",
9905
+ "fieldName": "placeholder"
9906
+ },
9907
+ {
9908
+ "name": "readonly",
9909
+ "type": {
9910
+ "text": "boolean"
9911
+ },
9912
+ "default": "false",
9913
+ "description": "readonly attribute of the textarea field. If true, the textarea field is read-only.",
9914
+ "fieldName": "readonly"
9915
+ },
9916
+ {
9917
+ "name": "rows",
9918
+ "description": "The rows attribute specifies the visible number of lines in a text area.",
9919
+ "default": "5",
9920
+ "fieldName": "rows"
9921
+ },
9922
+ {
9923
+ "name": "cols",
9924
+ "description": "The cols attribute specifies the visible number of lines in a text area.",
9925
+ "default": "40",
9926
+ "fieldName": "cols"
9927
+ },
9928
+ {
9929
+ "name": "wrap",
9930
+ "type": {
9931
+ "text": "WrapType"
9932
+ },
9933
+ "description": "The wrap attribute specifies how the text in a text area is to be wrapped when submitted in a form.",
9934
+ "default": "'soft'",
9935
+ "fieldName": "wrap"
9936
+ },
9937
+ {
9938
+ "name": "autocapitalize",
9939
+ "type": {
9940
+ "text": "AutoCapitalizeType"
9941
+ },
9942
+ "description": "The autocapitalize attribute of the textarea field.",
9943
+ "default": "'off'",
9944
+ "fieldName": "autocapitalize"
9945
+ },
9946
+ {
9947
+ "name": "autocomplete",
9948
+ "type": {
9949
+ "text": "AutoCompleteType"
9950
+ },
9951
+ "description": "The autocomplete attribute of the textarea field.",
9952
+ "default": "'off'",
9953
+ "fieldName": "autocomplete"
9954
+ },
9955
+ {
9956
+ "name": "autofocus",
9957
+ "type": {
9958
+ "text": "boolean"
9959
+ },
9960
+ "default": "false",
9961
+ "description": "If true, the textarea field is focused when the component is rendered.",
9962
+ "fieldName": "autofocus"
9963
+ },
9964
+ {
9965
+ "name": "dirname",
9966
+ "type": {
9967
+ "text": "string | undefined"
9968
+ },
9969
+ "description": "Specifies the name of the directionality of text for submission purposes (e.g., \"rtl\" for right-to-left).",
9970
+ "fieldName": "dirname"
9971
+ },
9972
+ {
9973
+ "name": "maxlength",
9974
+ "type": {
9975
+ "text": "number | undefined"
9976
+ },
9977
+ "description": "The maximum number of characters that the textarea field can accept.",
9978
+ "fieldName": "maxlength"
9979
+ },
9980
+ {
9981
+ "name": "minlength",
9982
+ "type": {
9983
+ "text": "number | undefined"
9984
+ },
9985
+ "description": "The minimum number of characters that the textarea field can accept.",
9986
+ "fieldName": "minlength"
9987
+ },
9988
+ {
9989
+ "name": "clear-button",
9990
+ "type": {
9991
+ "text": "boolean"
9992
+ },
9993
+ "default": "false",
9994
+ "description": "The clear button when set to true, shows a clear button that clears the textarea field.",
9995
+ "fieldName": "clearButton"
9996
+ },
9997
+ {
9998
+ "name": "clear-aria-label",
9999
+ "type": {
10000
+ "text": "string"
10001
+ },
10002
+ "default": "''",
10003
+ "description": "Aria label for the clear button. If clear button is set to true, this label is used for the clear button.",
10004
+ "fieldName": "clearAriaLabel"
10005
+ },
10006
+ {
10007
+ "name": "max-character-limit",
10008
+ "type": {
10009
+ "text": "number | undefined"
10010
+ },
10011
+ "description": "maximum character limit for the textarea field for character counter.",
10012
+ "fieldName": "maxCharacterLimit"
10013
+ },
10014
+ {
10015
+ "name": "name",
10016
+ "type": {
10017
+ "text": "string"
10018
+ },
10019
+ "default": "''",
10020
+ "description": "Indicates the name of the component group.\nThey are used to group elements in a form together.",
10021
+ "fieldName": "name",
10022
+ "inheritedFrom": {
10023
+ "name": "FormInternalsMixin",
10024
+ "module": "src/utils/mixins/FormInternalsMixin.ts"
10025
+ }
10026
+ },
10027
+ {
10028
+ "name": "value",
10029
+ "type": {
10030
+ "text": "string"
10031
+ },
10032
+ "default": "''",
10033
+ "description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
10034
+ "fieldName": "value",
10035
+ "inheritedFrom": {
10036
+ "name": "FormInternalsMixin",
10037
+ "module": "src/utils/mixins/FormInternalsMixin.ts"
10038
+ }
10039
+ },
10040
+ {
10041
+ "name": "validation-message",
10042
+ "type": {
10043
+ "text": "string | undefined"
10044
+ },
10045
+ "description": "Custom validation message that will override the default message and displayed when the input is invalid.",
10046
+ "fieldName": "validationMessage",
10047
+ "inheritedFrom": {
10048
+ "name": "FormInternalsMixin",
10049
+ "module": "src/utils/mixins/FormInternalsMixin.ts"
10050
+ }
10051
+ },
10052
+ {
10053
+ "name": "data-aria-label",
10054
+ "type": {
10055
+ "text": "string | null"
10056
+ },
10057
+ "default": "null",
10058
+ "description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
10059
+ "fieldName": "dataAriaLabel",
10060
+ "inheritedFrom": {
10061
+ "name": "DataAriaLabelMixin",
10062
+ "module": "src/utils/mixins/DataAriaLabelMixin.ts"
10063
+ }
10064
+ },
10065
+ {
10066
+ "name": "disabled",
10067
+ "type": {
10068
+ "text": "boolean"
10069
+ },
10070
+ "default": "false",
10071
+ "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
10072
+ "fieldName": "disabled",
10073
+ "inheritedFrom": {
10074
+ "name": "FormfieldWrapper",
10075
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
10076
+ }
10077
+ },
10078
+ {
10079
+ "name": "label",
10080
+ "type": {
10081
+ "text": "string | undefined"
10082
+ },
10083
+ "description": "The label of the input field. It is linked to the input field using the `for` attribute.",
10084
+ "fieldName": "label",
10085
+ "inheritedFrom": {
10086
+ "name": "FormfieldWrapper",
10087
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
10088
+ }
10089
+ },
10090
+ {
10091
+ "name": "required-label",
10092
+ "type": {
10093
+ "text": "string | undefined"
10094
+ },
10095
+ "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.",
10096
+ "fieldName": "requiredLabel",
10097
+ "inheritedFrom": {
10098
+ "name": "FormfieldWrapper",
10099
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
10100
+ }
10101
+ },
10102
+ {
10103
+ "name": "id",
10104
+ "type": {
10105
+ "text": "string"
10106
+ },
10107
+ "default": "''",
10108
+ "description": "The unique id of the input field. It is used to link the input field with the label.",
10109
+ "fieldName": "id",
10110
+ "inheritedFrom": {
10111
+ "name": "FormfieldWrapper",
10112
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
10113
+ }
10114
+ },
10115
+ {
10116
+ "name": "help-text-type",
10117
+ "type": {
10118
+ "text": "ValidationType"
10119
+ },
10120
+ "description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
10121
+ "fieldName": "helpTextType",
10122
+ "inheritedFrom": {
10123
+ "name": "FormfieldWrapper",
10124
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
10125
+ }
10126
+ },
10127
+ {
10128
+ "name": "help-text",
10129
+ "type": {
10130
+ "text": "string | undefined"
10131
+ },
10132
+ "description": "The help text that is displayed below the input field.",
10133
+ "fieldName": "helpText",
10134
+ "inheritedFrom": {
10135
+ "name": "FormfieldWrapper",
10136
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
10137
+ }
10138
+ }
10139
+ ],
10140
+ "mixins": [
10141
+ {
10142
+ "name": "FormInternalsMixin",
10143
+ "module": "/src/utils/mixins/FormInternalsMixin"
10144
+ },
10145
+ {
10146
+ "name": "DataAriaLabelMixin",
10147
+ "module": "/src/utils/mixins/DataAriaLabelMixin"
10148
+ }
10149
+ ],
10150
+ "superclass": {
10151
+ "name": "FormfieldWrapper",
10152
+ "module": "/src/components/formfieldwrapper"
10153
+ },
10154
+ "tagName": "mdc-textarea",
10155
+ "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 * - clear-button: A boolean value when marked to true represents a button that can\n * clear the text value within 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 */",
10156
+ "customElement": true,
10157
+ "slots": [
10158
+ {
10159
+ "description": "slot to add the label info icon",
10160
+ "name": "label-info",
10161
+ "inheritedFrom": {
10162
+ "name": "FormfieldWrapper",
10163
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
10164
+ }
10165
+ }
10166
+ ]
10167
+ }
10168
+ ],
10169
+ "exports": [
10170
+ {
10171
+ "kind": "js",
10172
+ "name": "default",
10173
+ "declaration": {
10174
+ "name": "Textarea",
10175
+ "module": "components/textarea/textarea.component.js"
10176
+ }
10177
+ }
10178
+ ]
10179
+ },
9244
10180
  {
9245
10181
  "kind": "javascript-module",
9246
10182
  "path": "components/themeprovider/themeprovider.component.js",