@momentum-design/components 0.28.5 → 0.28.6

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.
@@ -3238,330 +3238,6 @@
3238
3238
  }
3239
3239
  ]
3240
3240
  },
3241
- {
3242
- "kind": "javascript-module",
3243
- "path": "components/formfieldgroup/formfieldgroup.component.js",
3244
- "declarations": [
3245
- {
3246
- "kind": "class",
3247
- "description": "`mdc-formfieldgroup` component, groups the form field components together.\nAll passed in children will have a gap of 12px (0.75rem) each applied.\n\nThis component is specifically for creating a `checkbox` group and a `toggle` group component.\nFor the radiogroup use the RadioGroup component instead.\n\nThe header text and description text are displayed above the items with accessible labels.<br/>\nThe consumer has to provide atleast the header-text or the aria-label,\nlike one of them <b>has</b> to be passed in always, otherwise its not accessible.\n\nThe role will be set to `group`.\nThe aria-label will be set with the data-aria-label property.\nThe aria-labelledby will be set with the header id which contains the header text information.\nThe aria-describedby will be set with the description id which contains the description text information.",
3248
- "name": "FormfieldGroup",
3249
- "slots": [
3250
- {
3251
- "description": "This is a default slot for checkbox or toggle components.",
3252
- "name": "default"
3253
- },
3254
- {
3255
- "description": "slot to add the label info icon",
3256
- "name": "label-info",
3257
- "inheritedFrom": {
3258
- "name": "FormfieldWrapper",
3259
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
3260
- }
3261
- }
3262
- ],
3263
- "members": [
3264
- {
3265
- "kind": "field",
3266
- "name": "id",
3267
- "type": {
3268
- "text": "string"
3269
- },
3270
- "default": "''",
3271
- "description": "The unique id of the input field. It is used to link the input field with the label.",
3272
- "attribute": "id",
3273
- "inheritedFrom": {
3274
- "name": "FormfieldWrapper",
3275
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
3276
- }
3277
- },
3278
- {
3279
- "kind": "field",
3280
- "name": "helpTextType",
3281
- "type": {
3282
- "text": "ValidationType"
3283
- },
3284
- "description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
3285
- "attribute": "help-text-type",
3286
- "reflects": true,
3287
- "default": "undefined as unknown",
3288
- "inheritedFrom": {
3289
- "name": "FormfieldWrapper",
3290
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
3291
- }
3292
- },
3293
- {
3294
- "kind": "field",
3295
- "name": "disabled",
3296
- "type": {
3297
- "text": "boolean"
3298
- },
3299
- "default": "undefined as unknown",
3300
- "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
3301
- "attribute": "disabled",
3302
- "reflects": true,
3303
- "inheritedFrom": {
3304
- "name": "DisabledMixin",
3305
- "module": "utils/mixins/DisabledMixin.js"
3306
- }
3307
- },
3308
- {
3309
- "kind": "field",
3310
- "name": "dataAriaLabel",
3311
- "type": {
3312
- "text": "string | null"
3313
- },
3314
- "default": "null",
3315
- "description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
3316
- "attribute": "data-aria-label",
3317
- "reflects": true,
3318
- "inheritedFrom": {
3319
- "name": "DataAriaLabelMixin",
3320
- "module": "utils/mixins/DataAriaLabelMixin.js"
3321
- }
3322
- },
3323
- {
3324
- "kind": "field",
3325
- "name": "label",
3326
- "type": {
3327
- "text": "string | undefined"
3328
- },
3329
- "description": "The label of the input field. It is linked to the input field using the `for` attribute.",
3330
- "attribute": "label",
3331
- "reflects": true,
3332
- "inheritedFrom": {
3333
- "name": "FormfieldWrapper",
3334
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
3335
- }
3336
- },
3337
- {
3338
- "kind": "field",
3339
- "name": "requiredLabel",
3340
- "type": {
3341
- "text": "string | undefined"
3342
- },
3343
- "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.",
3344
- "attribute": "required-label",
3345
- "reflects": true,
3346
- "inheritedFrom": {
3347
- "name": "FormfieldWrapper",
3348
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
3349
- }
3350
- },
3351
- {
3352
- "kind": "field",
3353
- "name": "helpText",
3354
- "type": {
3355
- "text": "string | undefined"
3356
- },
3357
- "description": "The help text that is displayed below the input field.",
3358
- "attribute": "help-text",
3359
- "reflects": true,
3360
- "inheritedFrom": {
3361
- "name": "FormfieldWrapper",
3362
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
3363
- }
3364
- },
3365
- {
3366
- "kind": "method",
3367
- "name": "renderLabelElement",
3368
- "privacy": "protected",
3369
- "description": "creates the label element when the label property is set.\nid is used to link the label with the input field.",
3370
- "return": {
3371
- "type": {
3372
- "text": ""
3373
- }
3374
- },
3375
- "inheritedFrom": {
3376
- "name": "FormfieldWrapper",
3377
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
3378
- }
3379
- },
3380
- {
3381
- "kind": "method",
3382
- "name": "renderRequiredLabel",
3383
- "privacy": "protected",
3384
- "inheritedFrom": {
3385
- "name": "FormfieldWrapper",
3386
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
3387
- }
3388
- },
3389
- {
3390
- "kind": "method",
3391
- "name": "renderHelpTextIcon",
3392
- "privacy": "protected",
3393
- "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.",
3394
- "return": {
3395
- "type": {
3396
- "text": ""
3397
- }
3398
- },
3399
- "inheritedFrom": {
3400
- "name": "FormfieldWrapper",
3401
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
3402
- }
3403
- },
3404
- {
3405
- "kind": "method",
3406
- "name": "renderHelpText",
3407
- "privacy": "protected",
3408
- "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.",
3409
- "return": {
3410
- "type": {
3411
- "text": ""
3412
- }
3413
- },
3414
- "inheritedFrom": {
3415
- "name": "FormfieldWrapper",
3416
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
3417
- }
3418
- },
3419
- {
3420
- "kind": "method",
3421
- "name": "renderLabel",
3422
- "privacy": "protected",
3423
- "description": "renders the mdc-label-text container that contains the label and labelInfoToggleTip.",
3424
- "return": {
3425
- "type": {
3426
- "text": ""
3427
- }
3428
- },
3429
- "inheritedFrom": {
3430
- "name": "FormfieldWrapper",
3431
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
3432
- }
3433
- },
3434
- {
3435
- "kind": "method",
3436
- "name": "renderHelperText",
3437
- "privacy": "protected",
3438
- "description": "renders the mdc-help-text container that contains the helpertext icon and helpertext.",
3439
- "return": {
3440
- "type": {
3441
- "text": ""
3442
- }
3443
- },
3444
- "inheritedFrom": {
3445
- "name": "FormfieldWrapper",
3446
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
3447
- }
3448
- }
3449
- ],
3450
- "mixins": [
3451
- {
3452
- "name": "DataAriaLabelMixin",
3453
- "module": "/src/utils/mixins/DataAriaLabelMixin"
3454
- }
3455
- ],
3456
- "superclass": {
3457
- "name": "FormfieldWrapper",
3458
- "module": "/src/components/formfieldwrapper/formfieldwrapper.component"
3459
- },
3460
- "tagName": "mdc-formfieldgroup",
3461
- "jsDoc": "/**\n * `mdc-formfieldgroup` component, groups the form field components together.\n * All passed in children will have a gap of 12px (0.75rem) each applied.\n *\n * This component is specifically for creating a `checkbox` group and a `toggle` group component.\n * For the radiogroup use the RadioGroup component instead.\n *\n * The header text and description text are displayed above the items with accessible labels.<br/>\n * The consumer has to provide atleast the header-text or the aria-label,\n * like one of them <b>has</b> to be passed in always, otherwise its not accessible.\n *\n * The role will be set to `group`.\n * The aria-label will be set with the data-aria-label property.\n * The aria-labelledby will be set with the header id which contains the header text information.\n * The aria-describedby will be set with the description id which contains the description text information.\n *\n * @tagname mdc-formfieldgroup\n *\n * @slot default - This is a default slot for checkbox or toggle components.\n */",
3462
- "customElement": true,
3463
- "attributes": [
3464
- {
3465
- "name": "data-aria-label",
3466
- "type": {
3467
- "text": "string | null"
3468
- },
3469
- "default": "null",
3470
- "description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
3471
- "fieldName": "dataAriaLabel",
3472
- "inheritedFrom": {
3473
- "name": "DataAriaLabelMixin",
3474
- "module": "src/utils/mixins/DataAriaLabelMixin.ts"
3475
- }
3476
- },
3477
- {
3478
- "name": "disabled",
3479
- "type": {
3480
- "text": "boolean"
3481
- },
3482
- "default": "false",
3483
- "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
3484
- "fieldName": "disabled",
3485
- "inheritedFrom": {
3486
- "name": "DisabledMixin",
3487
- "module": "src/utils/mixins/DisabledMixin.ts"
3488
- }
3489
- },
3490
- {
3491
- "name": "label",
3492
- "type": {
3493
- "text": "string | undefined"
3494
- },
3495
- "description": "The label of the input field. It is linked to the input field using the `for` attribute.",
3496
- "fieldName": "label",
3497
- "inheritedFrom": {
3498
- "name": "FormfieldWrapper",
3499
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
3500
- }
3501
- },
3502
- {
3503
- "name": "required-label",
3504
- "type": {
3505
- "text": "string | undefined"
3506
- },
3507
- "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.",
3508
- "fieldName": "requiredLabel",
3509
- "inheritedFrom": {
3510
- "name": "FormfieldWrapper",
3511
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
3512
- }
3513
- },
3514
- {
3515
- "name": "id",
3516
- "type": {
3517
- "text": "string"
3518
- },
3519
- "default": "''",
3520
- "description": "The unique id of the input field. It is used to link the input field with the label.",
3521
- "fieldName": "id",
3522
- "inheritedFrom": {
3523
- "name": "FormfieldWrapper",
3524
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
3525
- }
3526
- },
3527
- {
3528
- "name": "help-text-type",
3529
- "type": {
3530
- "text": "ValidationType"
3531
- },
3532
- "description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
3533
- "fieldName": "helpTextType",
3534
- "inheritedFrom": {
3535
- "name": "FormfieldWrapper",
3536
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
3537
- }
3538
- },
3539
- {
3540
- "name": "help-text",
3541
- "type": {
3542
- "text": "string | undefined"
3543
- },
3544
- "description": "The help text that is displayed below the input field.",
3545
- "fieldName": "helpText",
3546
- "inheritedFrom": {
3547
- "name": "FormfieldWrapper",
3548
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
3549
- }
3550
- }
3551
- ]
3552
- }
3553
- ],
3554
- "exports": [
3555
- {
3556
- "kind": "js",
3557
- "name": "default",
3558
- "declaration": {
3559
- "name": "FormfieldGroup",
3560
- "module": "components/formfieldgroup/formfieldgroup.component.js"
3561
- }
3562
- }
3563
- ]
3564
- },
3565
3241
  {
3566
3242
  "kind": "javascript-module",
3567
3243
  "path": "components/divider/divider.component.js",
@@ -3713,88 +3389,412 @@
3713
3389
  "description": "The arrowDirection to set.",
3714
3390
  "name": "arrowDirection"
3715
3391
  }
3716
- ]
3392
+ ]
3393
+ },
3394
+ {
3395
+ "kind": "method",
3396
+ "name": "setGrabberButton",
3397
+ "privacy": "private",
3398
+ "return": {
3399
+ "type": {
3400
+ "text": "void"
3401
+ }
3402
+ },
3403
+ "description": "Configures the grabber button within the divider.\n\n- Sets the `prefix-icon` attribute for the grabber button based\non the `arrow-direction` and `orientation` properties.\n\nThis method updates the DOM element dynamically if a grabber button is present."
3404
+ },
3405
+ {
3406
+ "kind": "method",
3407
+ "name": "getArrowIcon",
3408
+ "privacy": "private",
3409
+ "return": {
3410
+ "type": {
3411
+ "text": ""
3412
+ }
3413
+ },
3414
+ "description": "Determines the arrow icon based on the consumer-defined `arrowDirection`."
3415
+ },
3416
+ {
3417
+ "kind": "method",
3418
+ "name": "inferDividerType",
3419
+ "privacy": "private",
3420
+ "description": "Infers the type of divider based on the kind of slot present.",
3421
+ "parameters": [
3422
+ {
3423
+ "description": "default slot of divider",
3424
+ "name": "slot"
3425
+ }
3426
+ ]
3427
+ }
3428
+ ],
3429
+ "attributes": [
3430
+ {
3431
+ "name": "orientation",
3432
+ "type": {
3433
+ "text": "DividerOrientation"
3434
+ },
3435
+ "description": "Two orientations of divider\n- **horizontal**: A thin, horizontal line with 0.0625rem width.\n- **vertical**: A thin, vertical line with 0.0625rem width.\n\nNote: We do not support \"Vertical Text Divider\" as of now.",
3436
+ "default": "horizontal",
3437
+ "fieldName": "orientation"
3438
+ },
3439
+ {
3440
+ "name": "variant",
3441
+ "type": {
3442
+ "text": "DividerVariant"
3443
+ },
3444
+ "description": "Two variants of divider\n- **solid**: Solid line.\n- **gradient**: Gradient Line that fades on either sides of the divider.",
3445
+ "default": "solid",
3446
+ "fieldName": "variant"
3447
+ },
3448
+ {
3449
+ "name": "arrow-direction",
3450
+ "type": {
3451
+ "text": "Directions"
3452
+ },
3453
+ "description": "Direction of the arrow icon, if applicable.\n- **positive**\n- **negative**\n\nNote: Positive and Negative directions are defined based on Cartesian plane.",
3454
+ "default": "'negative'",
3455
+ "fieldName": "arrowDirection"
3456
+ },
3457
+ {
3458
+ "name": "button-position",
3459
+ "type": {
3460
+ "text": "Directions"
3461
+ },
3462
+ "description": "Position of the button, if applicable.\n- **positive**\n- **negative**\n\nNote: Positive and Negative directions are defined based on Cartesian plane.",
3463
+ "default": "'negative'",
3464
+ "fieldName": "buttonPosition"
3465
+ }
3466
+ ],
3467
+ "superclass": {
3468
+ "name": "Component",
3469
+ "module": "/src/models"
3470
+ },
3471
+ "tagName": "mdc-divider",
3472
+ "jsDoc": "/**\n * `mdc-divider` is a component that provides a line to separate and organize content.\n * It can also include a button or text positioned centrally, allowing users to interact with the layout.\n *\n * **Divider Orientation:**\n * - **Horizontal**: A thin, horizontal line.\n * - **Vertical**: A thin, vertical line.\n *\n * **Divider Variants:**\n * - **solid**: Solid line.\n * - **gradient**: Gradient Line.\n *\n * **Divider Types:**\n * - The type of divider is inferred based on the kind of slot present.\n * - **Primary**: A simple horizontal or vertical divider.\n * - **Text**: A horizontal divider with a text label in the center.\n * - **Grabber Button**: A horizontal or vertical divider with a styled button in the center.\n *\n * **Accessibility:**\n * - When the slot is replaced by an `mdc-button`:\n * - `aria-label` should be passed to the `mdc-button`.\n * - `aria-expanded` should be passed to the `mdc-button`.\n *\n * **Notes:**\n * - If the slot is replaced by an invalid tag name or contains multiple elements,\n * the divider defaults to the **Primary** type.\n * - To override the styles of the divider, use the provided CSS custom properties.\n *\n * @tagname mdc-divider\n *\n * @cssproperty --mdc-divider-background-color - background color of the divider\n * @cssproperty --mdc-divider-width - width of the divider\n * @cssproperty --mdc-divider-horizontal-gradient - gradient of the horizontal divider\n * @cssproperty --mdc-divider-vertical-gradient - gradient of the vertical divider\n * @cssproperty --mdc-divider-text-size - font size of label in the text divider\n * @cssproperty --mdc-divider-text-color - font color of label in the text divider\n * @cssproperty --mdc-divider-text-margin - left and right margin of label in the text divider\n * @cssproperty --mdc-divider-text-line-height - line height of label in the text divider\n * @cssproperty --mdc-divider-grabber-button-background-color-normal - background color of the grabber button\n * in rest state\n * @cssproperty --mdc-divider-grabber-button-background-color-hover - background color of the grabber button\n * in hover state\n * @cssproperty --mdc-divider-grabber-button-background-color-pressed - background color of the grabber button\n * in pressed state\n * @cssproperty --mdc-divider-grabber-button-border-color - border color of the grabber button\n * @cssproperty --mdc-divider-grabber-button-border-radius - border radius of the grabber button\n */",
3473
+ "customElement": true
3474
+ }
3475
+ ],
3476
+ "exports": [
3477
+ {
3478
+ "kind": "js",
3479
+ "name": "default",
3480
+ "declaration": {
3481
+ "name": "Divider",
3482
+ "module": "components/divider/divider.component.js"
3483
+ }
3484
+ }
3485
+ ]
3486
+ },
3487
+ {
3488
+ "kind": "javascript-module",
3489
+ "path": "components/formfieldgroup/formfieldgroup.component.js",
3490
+ "declarations": [
3491
+ {
3492
+ "kind": "class",
3493
+ "description": "`mdc-formfieldgroup` component, groups the form field components together.\nAll passed in children will have a gap of 12px (0.75rem) each applied.\n\nThis component is specifically for creating a `checkbox` group and a `toggle` group component.\nFor the radiogroup use the RadioGroup component instead.\n\nThe header text and description text are displayed above the items with accessible labels.<br/>\nThe consumer has to provide atleast the header-text or the aria-label,\nlike one of them <b>has</b> to be passed in always, otherwise its not accessible.\n\nThe role will be set to `group`.\nThe aria-label will be set with the data-aria-label property.\nThe aria-labelledby will be set with the header id which contains the header text information.\nThe aria-describedby will be set with the description id which contains the description text information.",
3494
+ "name": "FormfieldGroup",
3495
+ "slots": [
3496
+ {
3497
+ "description": "This is a default slot for checkbox or toggle components.",
3498
+ "name": "default"
3499
+ },
3500
+ {
3501
+ "description": "slot to add the label info icon",
3502
+ "name": "label-info",
3503
+ "inheritedFrom": {
3504
+ "name": "FormfieldWrapper",
3505
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
3506
+ }
3507
+ }
3508
+ ],
3509
+ "members": [
3510
+ {
3511
+ "kind": "field",
3512
+ "name": "id",
3513
+ "type": {
3514
+ "text": "string"
3515
+ },
3516
+ "default": "''",
3517
+ "description": "The unique id of the input field. It is used to link the input field with the label.",
3518
+ "attribute": "id",
3519
+ "inheritedFrom": {
3520
+ "name": "FormfieldWrapper",
3521
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
3522
+ }
3523
+ },
3524
+ {
3525
+ "kind": "field",
3526
+ "name": "helpTextType",
3527
+ "type": {
3528
+ "text": "ValidationType"
3529
+ },
3530
+ "description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
3531
+ "attribute": "help-text-type",
3532
+ "reflects": true,
3533
+ "default": "undefined as unknown",
3534
+ "inheritedFrom": {
3535
+ "name": "FormfieldWrapper",
3536
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
3537
+ }
3538
+ },
3539
+ {
3540
+ "kind": "field",
3541
+ "name": "disabled",
3542
+ "type": {
3543
+ "text": "boolean"
3544
+ },
3545
+ "default": "undefined as unknown",
3546
+ "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
3547
+ "attribute": "disabled",
3548
+ "reflects": true,
3549
+ "inheritedFrom": {
3550
+ "name": "DisabledMixin",
3551
+ "module": "utils/mixins/DisabledMixin.js"
3552
+ }
3553
+ },
3554
+ {
3555
+ "kind": "field",
3556
+ "name": "dataAriaLabel",
3557
+ "type": {
3558
+ "text": "string | null"
3559
+ },
3560
+ "default": "null",
3561
+ "description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
3562
+ "attribute": "data-aria-label",
3563
+ "reflects": true,
3564
+ "inheritedFrom": {
3565
+ "name": "DataAriaLabelMixin",
3566
+ "module": "utils/mixins/DataAriaLabelMixin.js"
3567
+ }
3568
+ },
3569
+ {
3570
+ "kind": "field",
3571
+ "name": "label",
3572
+ "type": {
3573
+ "text": "string | undefined"
3574
+ },
3575
+ "description": "The label of the input field. It is linked to the input field using the `for` attribute.",
3576
+ "attribute": "label",
3577
+ "reflects": true,
3578
+ "inheritedFrom": {
3579
+ "name": "FormfieldWrapper",
3580
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
3581
+ }
3582
+ },
3583
+ {
3584
+ "kind": "field",
3585
+ "name": "requiredLabel",
3586
+ "type": {
3587
+ "text": "string | undefined"
3588
+ },
3589
+ "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.",
3590
+ "attribute": "required-label",
3591
+ "reflects": true,
3592
+ "inheritedFrom": {
3593
+ "name": "FormfieldWrapper",
3594
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
3595
+ }
3596
+ },
3597
+ {
3598
+ "kind": "field",
3599
+ "name": "helpText",
3600
+ "type": {
3601
+ "text": "string | undefined"
3602
+ },
3603
+ "description": "The help text that is displayed below the input field.",
3604
+ "attribute": "help-text",
3605
+ "reflects": true,
3606
+ "inheritedFrom": {
3607
+ "name": "FormfieldWrapper",
3608
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
3609
+ }
3610
+ },
3611
+ {
3612
+ "kind": "method",
3613
+ "name": "renderLabelElement",
3614
+ "privacy": "protected",
3615
+ "description": "creates the label element when the label property is set.\nid is used to link the label with the input field.",
3616
+ "return": {
3617
+ "type": {
3618
+ "text": ""
3619
+ }
3620
+ },
3621
+ "inheritedFrom": {
3622
+ "name": "FormfieldWrapper",
3623
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
3624
+ }
3625
+ },
3626
+ {
3627
+ "kind": "method",
3628
+ "name": "renderRequiredLabel",
3629
+ "privacy": "protected",
3630
+ "inheritedFrom": {
3631
+ "name": "FormfieldWrapper",
3632
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
3633
+ }
3634
+ },
3635
+ {
3636
+ "kind": "method",
3637
+ "name": "renderHelpTextIcon",
3638
+ "privacy": "protected",
3639
+ "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.",
3640
+ "return": {
3641
+ "type": {
3642
+ "text": ""
3643
+ }
3644
+ },
3645
+ "inheritedFrom": {
3646
+ "name": "FormfieldWrapper",
3647
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
3648
+ }
3717
3649
  },
3718
3650
  {
3719
3651
  "kind": "method",
3720
- "name": "setGrabberButton",
3721
- "privacy": "private",
3652
+ "name": "renderHelpText",
3653
+ "privacy": "protected",
3654
+ "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.",
3722
3655
  "return": {
3723
3656
  "type": {
3724
- "text": "void"
3657
+ "text": ""
3725
3658
  }
3726
3659
  },
3727
- "description": "Configures the grabber button within the divider.\n\n- Sets the `prefix-icon` attribute for the grabber button based\non the `arrow-direction` and `orientation` properties.\n\nThis method updates the DOM element dynamically if a grabber button is present."
3660
+ "inheritedFrom": {
3661
+ "name": "FormfieldWrapper",
3662
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
3663
+ }
3728
3664
  },
3729
3665
  {
3730
3666
  "kind": "method",
3731
- "name": "getArrowIcon",
3732
- "privacy": "private",
3667
+ "name": "renderLabel",
3668
+ "privacy": "protected",
3669
+ "description": "renders the mdc-label-text container that contains the label and labelInfoToggleTip.",
3733
3670
  "return": {
3734
3671
  "type": {
3735
3672
  "text": ""
3736
3673
  }
3737
3674
  },
3738
- "description": "Determines the arrow icon based on the consumer-defined `arrowDirection`."
3675
+ "inheritedFrom": {
3676
+ "name": "FormfieldWrapper",
3677
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
3678
+ }
3739
3679
  },
3740
3680
  {
3741
3681
  "kind": "method",
3742
- "name": "inferDividerType",
3743
- "privacy": "private",
3744
- "description": "Infers the type of divider based on the kind of slot present.",
3745
- "parameters": [
3746
- {
3747
- "description": "default slot of divider",
3748
- "name": "slot"
3682
+ "name": "renderHelperText",
3683
+ "privacy": "protected",
3684
+ "description": "renders the mdc-help-text container that contains the helpertext icon and helpertext.",
3685
+ "return": {
3686
+ "type": {
3687
+ "text": ""
3749
3688
  }
3750
- ]
3689
+ },
3690
+ "inheritedFrom": {
3691
+ "name": "FormfieldWrapper",
3692
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
3693
+ }
3694
+ }
3695
+ ],
3696
+ "mixins": [
3697
+ {
3698
+ "name": "DataAriaLabelMixin",
3699
+ "module": "/src/utils/mixins/DataAriaLabelMixin"
3751
3700
  }
3752
3701
  ],
3702
+ "superclass": {
3703
+ "name": "FormfieldWrapper",
3704
+ "module": "/src/components/formfieldwrapper/formfieldwrapper.component"
3705
+ },
3706
+ "tagName": "mdc-formfieldgroup",
3707
+ "jsDoc": "/**\n * `mdc-formfieldgroup` component, groups the form field components together.\n * All passed in children will have a gap of 12px (0.75rem) each applied.\n *\n * This component is specifically for creating a `checkbox` group and a `toggle` group component.\n * For the radiogroup use the RadioGroup component instead.\n *\n * The header text and description text are displayed above the items with accessible labels.<br/>\n * The consumer has to provide atleast the header-text or the aria-label,\n * like one of them <b>has</b> to be passed in always, otherwise its not accessible.\n *\n * The role will be set to `group`.\n * The aria-label will be set with the data-aria-label property.\n * The aria-labelledby will be set with the header id which contains the header text information.\n * The aria-describedby will be set with the description id which contains the description text information.\n *\n * @tagname mdc-formfieldgroup\n *\n * @slot default - This is a default slot for checkbox or toggle components.\n */",
3708
+ "customElement": true,
3753
3709
  "attributes": [
3754
3710
  {
3755
- "name": "orientation",
3711
+ "name": "data-aria-label",
3756
3712
  "type": {
3757
- "text": "DividerOrientation"
3713
+ "text": "string | null"
3758
3714
  },
3759
- "description": "Two orientations of divider\n- **horizontal**: A thin, horizontal line with 0.0625rem width.\n- **vertical**: A thin, vertical line with 0.0625rem width.\n\nNote: We do not support \"Vertical Text Divider\" as of now.",
3760
- "default": "horizontal",
3761
- "fieldName": "orientation"
3715
+ "default": "null",
3716
+ "description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
3717
+ "fieldName": "dataAriaLabel",
3718
+ "inheritedFrom": {
3719
+ "name": "DataAriaLabelMixin",
3720
+ "module": "src/utils/mixins/DataAriaLabelMixin.ts"
3721
+ }
3762
3722
  },
3763
3723
  {
3764
- "name": "variant",
3724
+ "name": "disabled",
3765
3725
  "type": {
3766
- "text": "DividerVariant"
3726
+ "text": "boolean"
3767
3727
  },
3768
- "description": "Two variants of divider\n- **solid**: Solid line.\n- **gradient**: Gradient Line that fades on either sides of the divider.",
3769
- "default": "solid",
3770
- "fieldName": "variant"
3728
+ "default": "false",
3729
+ "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
3730
+ "fieldName": "disabled",
3731
+ "inheritedFrom": {
3732
+ "name": "DisabledMixin",
3733
+ "module": "src/utils/mixins/DisabledMixin.ts"
3734
+ }
3771
3735
  },
3772
3736
  {
3773
- "name": "arrow-direction",
3737
+ "name": "label",
3774
3738
  "type": {
3775
- "text": "Directions"
3739
+ "text": "string | undefined"
3776
3740
  },
3777
- "description": "Direction of the arrow icon, if applicable.\n- **positive**\n- **negative**\n\nNote: Positive and Negative directions are defined based on Cartesian plane.",
3778
- "default": "'negative'",
3779
- "fieldName": "arrowDirection"
3741
+ "description": "The label of the input field. It is linked to the input field using the `for` attribute.",
3742
+ "fieldName": "label",
3743
+ "inheritedFrom": {
3744
+ "name": "FormfieldWrapper",
3745
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
3746
+ }
3780
3747
  },
3781
3748
  {
3782
- "name": "button-position",
3749
+ "name": "required-label",
3783
3750
  "type": {
3784
- "text": "Directions"
3751
+ "text": "string | undefined"
3785
3752
  },
3786
- "description": "Position of the button, if applicable.\n- **positive**\n- **negative**\n\nNote: Positive and Negative directions are defined based on Cartesian plane.",
3787
- "default": "'negative'",
3788
- "fieldName": "buttonPosition"
3753
+ "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.",
3754
+ "fieldName": "requiredLabel",
3755
+ "inheritedFrom": {
3756
+ "name": "FormfieldWrapper",
3757
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
3758
+ }
3759
+ },
3760
+ {
3761
+ "name": "id",
3762
+ "type": {
3763
+ "text": "string"
3764
+ },
3765
+ "default": "''",
3766
+ "description": "The unique id of the input field. It is used to link the input field with the label.",
3767
+ "fieldName": "id",
3768
+ "inheritedFrom": {
3769
+ "name": "FormfieldWrapper",
3770
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
3771
+ }
3772
+ },
3773
+ {
3774
+ "name": "help-text-type",
3775
+ "type": {
3776
+ "text": "ValidationType"
3777
+ },
3778
+ "description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
3779
+ "fieldName": "helpTextType",
3780
+ "inheritedFrom": {
3781
+ "name": "FormfieldWrapper",
3782
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
3783
+ }
3784
+ },
3785
+ {
3786
+ "name": "help-text",
3787
+ "type": {
3788
+ "text": "string | undefined"
3789
+ },
3790
+ "description": "The help text that is displayed below the input field.",
3791
+ "fieldName": "helpText",
3792
+ "inheritedFrom": {
3793
+ "name": "FormfieldWrapper",
3794
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
3795
+ }
3789
3796
  }
3790
- ],
3791
- "superclass": {
3792
- "name": "Component",
3793
- "module": "/src/models"
3794
- },
3795
- "tagName": "mdc-divider",
3796
- "jsDoc": "/**\n * `mdc-divider` is a component that provides a line to separate and organize content.\n * It can also include a button or text positioned centrally, allowing users to interact with the layout.\n *\n * **Divider Orientation:**\n * - **Horizontal**: A thin, horizontal line.\n * - **Vertical**: A thin, vertical line.\n *\n * **Divider Variants:**\n * - **solid**: Solid line.\n * - **gradient**: Gradient Line.\n *\n * **Divider Types:**\n * - The type of divider is inferred based on the kind of slot present.\n * - **Primary**: A simple horizontal or vertical divider.\n * - **Text**: A horizontal divider with a text label in the center.\n * - **Grabber Button**: A horizontal or vertical divider with a styled button in the center.\n *\n * **Accessibility:**\n * - When the slot is replaced by an `mdc-button`:\n * - `aria-label` should be passed to the `mdc-button`.\n * - `aria-expanded` should be passed to the `mdc-button`.\n *\n * **Notes:**\n * - If the slot is replaced by an invalid tag name or contains multiple elements,\n * the divider defaults to the **Primary** type.\n * - To override the styles of the divider, use the provided CSS custom properties.\n *\n * @tagname mdc-divider\n *\n * @cssproperty --mdc-divider-background-color - background color of the divider\n * @cssproperty --mdc-divider-width - width of the divider\n * @cssproperty --mdc-divider-horizontal-gradient - gradient of the horizontal divider\n * @cssproperty --mdc-divider-vertical-gradient - gradient of the vertical divider\n * @cssproperty --mdc-divider-text-size - font size of label in the text divider\n * @cssproperty --mdc-divider-text-color - font color of label in the text divider\n * @cssproperty --mdc-divider-text-margin - left and right margin of label in the text divider\n * @cssproperty --mdc-divider-text-line-height - line height of label in the text divider\n * @cssproperty --mdc-divider-grabber-button-background-color-normal - background color of the grabber button\n * in rest state\n * @cssproperty --mdc-divider-grabber-button-background-color-hover - background color of the grabber button\n * in hover state\n * @cssproperty --mdc-divider-grabber-button-background-color-pressed - background color of the grabber button\n * in pressed state\n * @cssproperty --mdc-divider-grabber-button-border-color - border color of the grabber button\n * @cssproperty --mdc-divider-grabber-button-border-radius - border radius of the grabber button\n */",
3797
- "customElement": true
3797
+ ]
3798
3798
  }
3799
3799
  ],
3800
3800
  "exports": [
@@ -3802,8 +3802,8 @@
3802
3802
  "kind": "js",
3803
3803
  "name": "default",
3804
3804
  "declaration": {
3805
- "name": "Divider",
3806
- "module": "components/divider/divider.component.js"
3805
+ "name": "FormfieldGroup",
3806
+ "module": "components/formfieldgroup/formfieldgroup.component.js"
3807
3807
  }
3808
3808
  }
3809
3809
  ]
@@ -10338,7 +10338,7 @@
10338
10338
  "kind": "field",
10339
10339
  "name": "onscroll",
10340
10340
  "type": {
10341
- "text": "((this: GlobalEventHandlers, ev: Event) => any) | null"
10341
+ "text": "((this: GlobalEventHandlers, ev: Event) => void) | null"
10342
10342
  },
10343
10343
  "description": "Callback that gets called when user scrolls inside of list. This gives access to the scroll container element\nas well via the event. Particularly useful for\nhandling logic related when the user scrolls to the top or bottom of a list.",
10344
10344
  "default": "null",
@@ -10346,7 +10346,7 @@
10346
10346
  },
10347
10347
  {
10348
10348
  "kind": "field",
10349
- "name": "virtualizerprops",
10349
+ "name": "virtualizerProps",
10350
10350
  "type": {
10351
10351
  "text": "VirtualizerProps"
10352
10352
  },
@@ -10380,6 +10380,15 @@
10380
10380
  "privacy": "public",
10381
10381
  "default": "null"
10382
10382
  },
10383
+ {
10384
+ "kind": "field",
10385
+ "name": "virtualItems",
10386
+ "type": {
10387
+ "text": "Array<VirtualItem>"
10388
+ },
10389
+ "privacy": "public",
10390
+ "default": "[]"
10391
+ },
10383
10392
  {
10384
10393
  "kind": "field",
10385
10394
  "name": "virtualizerController",
@@ -10401,7 +10410,7 @@
10401
10410
  {
10402
10411
  "name": "onscroll",
10403
10412
  "type": {
10404
- "text": "((this: GlobalEventHandlers, ev: Event) => any) | null"
10413
+ "text": "((this: GlobalEventHandlers, ev: Event) => void) | null"
10405
10414
  },
10406
10415
  "description": "Callback that gets called when user scrolls inside of list. This gives access to the scroll container element\nas well via the event. Particularly useful for\nhandling logic related when the user scrolls to the top or bottom of a list.",
10407
10416
  "default": "null",
@@ -10413,7 +10422,7 @@
10413
10422
  "text": "VirtualizerProps"
10414
10423
  },
10415
10424
  "description": "Object that sets and updates the virtualizer with any relevant props.\nThere are two required object props in order to get virtualization to work properly.\ncount - The length of your list that you are virtualizing.\nAs your list grows/shrinks, this component must be updated with the appropriate value\n(Same with any other updated prop).\nestimateSize - A function that returns the estimated size of your items.\nIf your list is fixed, this will just be the size of your items.\nIf your list is dynamic, try to return approximate the size of each item.\n\nA full list of possible props can be in\n[Tanstack Virtualizer API Docs](https://tanstack.com/virtual/latest/docs/api/virtualizer)",
10416
- "fieldName": "virtualizerprops"
10425
+ "fieldName": "virtualizerProps"
10417
10426
  },
10418
10427
  {
10419
10428
  "name": "setlistdata",
@@ -10445,99 +10454,6 @@
10445
10454
  }
10446
10455
  ]
10447
10456
  },
10448
- {
10449
- "kind": "javascript-module",
10450
- "path": "components/virtualizedlist/virtualizedlist.test.component.js",
10451
- "declarations": [
10452
- {
10453
- "kind": "class",
10454
- "description": "",
10455
- "name": "VirtualizedWrapper",
10456
- "members": [
10457
- {
10458
- "kind": "field",
10459
- "name": "onscroll",
10460
- "type": {
10461
- "text": "((this: GlobalEventHandlers, ev: Event) => any) | null"
10462
- },
10463
- "default": "null",
10464
- "attribute": "onscroll"
10465
- },
10466
- {
10467
- "kind": "field",
10468
- "name": "virtualizerprops",
10469
- "type": {
10470
- "text": "VirtualizerProps"
10471
- },
10472
- "default": "{ count: 100, estimateSize: () => 100 }",
10473
- "attribute": "virtualizerprops"
10474
- },
10475
- {
10476
- "kind": "field",
10477
- "name": "list",
10478
- "type": {
10479
- "text": "TemplateResult<1>"
10480
- },
10481
- "default": "html``"
10482
- },
10483
- {
10484
- "kind": "field",
10485
- "name": "listItemTexts"
10486
- },
10487
- {
10488
- "kind": "method",
10489
- "name": "updateListItemTextArray",
10490
- "privacy": "private"
10491
- },
10492
- {
10493
- "kind": "method",
10494
- "name": "setListData",
10495
- "privacy": "private",
10496
- "parameters": [
10497
- {
10498
- "name": "{ virtualItems, measureElement, listStyle }",
10499
- "type": {
10500
- "text": "SetListDataProps"
10501
- }
10502
- }
10503
- ]
10504
- }
10505
- ],
10506
- "attributes": [
10507
- {
10508
- "name": "onscroll",
10509
- "type": {
10510
- "text": "((this: GlobalEventHandlers, ev: Event) => any) | null"
10511
- },
10512
- "default": "null",
10513
- "fieldName": "onscroll"
10514
- },
10515
- {
10516
- "name": "virtualizerprops",
10517
- "type": {
10518
- "text": "VirtualizerProps"
10519
- },
10520
- "default": "{ count: 100, estimateSize: () => 100 }",
10521
- "fieldName": "virtualizerprops"
10522
- }
10523
- ],
10524
- "superclass": {
10525
- "name": "Component",
10526
- "module": "/src/models"
10527
- }
10528
- }
10529
- ],
10530
- "exports": [
10531
- {
10532
- "kind": "js",
10533
- "name": "default",
10534
- "declaration": {
10535
- "name": "VirtualizedWrapper",
10536
- "module": "components/virtualizedlist/virtualizedlist.test.component.js"
10537
- }
10538
- }
10539
- ]
10540
- },
10541
10457
  {
10542
10458
  "kind": "javascript-module",
10543
10459
  "path": "utils/mixins/AvatarComponentMixin.js",