@momentum-design/components 0.37.3 → 0.38.0

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.
@@ -3263,239 +3263,211 @@
3263
3263
  },
3264
3264
  {
3265
3265
  "kind": "javascript-module",
3266
- "path": "components/coachmark/coachmark.component.js",
3266
+ "path": "components/chip/chip.component.js",
3267
3267
  "declarations": [
3268
3268
  {
3269
3269
  "kind": "class",
3270
- "description": "Coachmark component based on top of the popover component,\nwith the default value of certain properties changed.",
3271
- "name": "Coachmark",
3270
+ "description": "mdc-chip is an interactive element that can be used to represent a chip. It supports a leading icon along with label.\nConsumers can wrap this component around a tooltip to provide additional context.\n\nIt is recommended to keep the label text for the chip component concise and compact.\nFor best results, we recommend limiting the <b>maximum length of the label text to 20 characters</b>,\nincluding empty spaces to split words.\n\nThis component is built by extending Buttonsimple.",
3271
+ "name": "Chip",
3272
3272
  "cssProperties": [
3273
3273
  {
3274
- "description": "radius of the arrow border",
3275
- "name": "--mdc-popover-arrow-border-radius",
3276
- "inheritedFrom": {
3277
- "name": "Popover",
3278
- "module": "src/components/popover/popover.component.ts"
3279
- }
3280
- },
3281
- {
3282
- "description": "border of the arrow",
3283
- "name": "--mdc-popover-arrow-border",
3284
- "inheritedFrom": {
3285
- "name": "Popover",
3286
- "module": "src/components/popover/popover.component.ts"
3287
- }
3274
+ "description": "The color of the chip.",
3275
+ "name": "--mdc-chip-color"
3288
3276
  },
3289
3277
  {
3290
- "description": "primary background color of the popover",
3291
- "name": "--mdc-popover-primary-background-color",
3292
- "inheritedFrom": {
3293
- "name": "Popover",
3294
- "module": "src/components/popover/popover.component.ts"
3295
- }
3278
+ "description": "The border color of the chip.",
3279
+ "name": "--mdc-chip-border-color"
3296
3280
  },
3297
3281
  {
3298
- "description": "border color of the popover",
3299
- "name": "--mdc-popover-border-color",
3300
- "inheritedFrom": {
3301
- "name": "Popover",
3302
- "module": "src/components/popover/popover.component.ts"
3303
- }
3304
- },
3282
+ "description": "The background color of the chip.",
3283
+ "name": "--mdc-chip-background-color"
3284
+ }
3285
+ ],
3286
+ "members": [
3305
3287
  {
3306
- "description": "inverted background color of the popover",
3307
- "name": "--mdc-popover-inverted-background-color",
3308
- "inheritedFrom": {
3309
- "name": "Popover",
3310
- "module": "src/components/popover/popover.component.ts"
3311
- }
3288
+ "kind": "field",
3289
+ "name": "color",
3290
+ "type": {
3291
+ "text": "ColorType"
3292
+ },
3293
+ "description": "The color of the chip. It supports the following colors\n- default\n- cobalt\n- gold\n- lime\n- mint\n- pink\n- purple\n- slate\n- violet",
3294
+ "default": "default",
3295
+ "attribute": "color",
3296
+ "reflects": true
3312
3297
  },
3313
3298
  {
3314
- "description": "inverted border color of the popover",
3315
- "name": "--mdc-popover-inverted-border-color",
3316
- "inheritedFrom": {
3317
- "name": "Popover",
3318
- "module": "src/components/popover/popover.component.ts"
3319
- }
3299
+ "kind": "field",
3300
+ "name": "label",
3301
+ "type": {
3302
+ "text": "string"
3303
+ },
3304
+ "default": "''",
3305
+ "description": "The visible label text of the chip.\n\nWe recommend limiting the <b>maximum length of the label text to 20 characters</b>,\nincluding empty spaces to split words.",
3306
+ "attribute": "label"
3320
3307
  },
3321
3308
  {
3322
- "description": "inverted text color of the popover",
3323
- "name": "--mdc-popover-inverted-text-color",
3324
- "inheritedFrom": {
3325
- "name": "Popover",
3326
- "module": "src/components/popover/popover.component.ts"
3309
+ "kind": "method",
3310
+ "name": "renderIcon",
3311
+ "privacy": "private",
3312
+ "description": "Renders the icon element if available.",
3313
+ "return": {
3314
+ "type": {
3315
+ "text": ""
3316
+ }
3327
3317
  }
3328
3318
  },
3329
- {
3330
- "description": "elevation of the popover",
3331
- "name": "--mdc-popover-elevation-3",
3332
- "inheritedFrom": {
3333
- "name": "Popover",
3334
- "module": "src/components/popover/popover.component.ts"
3335
- }
3336
- }
3337
- ],
3338
- "slots": [
3339
- {
3340
- "description": "Default slot for modal container",
3341
- "name": "",
3342
- "inheritedFrom": {
3343
- "name": "Popover",
3344
- "module": "src/components/popover/popover.component.ts"
3345
- }
3346
- }
3347
- ],
3348
- "members": [
3349
3319
  {
3350
3320
  "kind": "field",
3351
- "name": "trigger",
3352
- "type": {
3353
- "text": "PopoverTrigger"
3354
- },
3355
- "description": "Determines the events that cause the Coachmark to show.\nMultiple event names should be separated by spaces.\nFor example to allow both click and hover, use 'click mouseenter' as the trigger.\n- **click**\n- **mouseenter**\n- **focusin**\n- **manual**",
3356
- "default": "manual",
3357
- "attribute": "trigger",
3321
+ "name": "role",
3322
+ "description": "This property defines the ARIA role for the element. By default, it is set to 'button'.\nConsumers should override this role when:\n- The element is being used in a context where a different role is more appropriate.\n- Custom behaviors are implemented that require a specific ARIA role for accessibility purposes.",
3323
+ "default": "button",
3324
+ "attribute": "role",
3358
3325
  "reflects": true,
3359
3326
  "inheritedFrom": {
3360
- "name": "Popover",
3361
- "module": "components/popover/popover.component.js"
3327
+ "name": "Buttonsimple",
3328
+ "module": "components/buttonsimple/buttonsimple.component.js"
3362
3329
  }
3363
3330
  },
3364
3331
  {
3365
3332
  "kind": "field",
3366
- "name": "showArrow",
3333
+ "name": "size",
3367
3334
  "type": {
3368
- "text": "boolean"
3335
+ "text": "ButtonSize"
3369
3336
  },
3370
- "description": "The arrow visibility of the Coachmark.",
3371
- "default": "true",
3372
- "attribute": "show-arrow",
3337
+ "description": "Simplebutton size is a super set of all the sizes supported by children components.",
3338
+ "default": "32",
3339
+ "attribute": "size",
3373
3340
  "reflects": true,
3374
3341
  "inheritedFrom": {
3375
- "name": "Popover",
3376
- "module": "components/popover/popover.component.js"
3342
+ "name": "Buttonsimple",
3343
+ "module": "components/buttonsimple/buttonsimple.component.js"
3377
3344
  }
3378
3345
  },
3379
3346
  {
3380
3347
  "kind": "field",
3381
- "name": "closeButton",
3348
+ "name": "active",
3382
3349
  "type": {
3383
3350
  "text": "boolean"
3384
3351
  },
3385
- "description": "The close button visibility of the Coachmark.",
3386
- "default": "true",
3387
- "attribute": "close-button",
3352
+ "default": "undefined as unknown",
3353
+ "description": "The button's active state indicates whether it is currently toggled on (active) or off (inactive).\nWhen the active state is true, the button is considered to be in an active state, meaning it is toggled on.\nConversely, when the active state is false, the button is in an inactive state, indicating it is toggled off.",
3354
+ "attribute": "active",
3388
3355
  "reflects": true,
3389
3356
  "inheritedFrom": {
3390
- "name": "Popover",
3391
- "module": "components/popover/popover.component.js"
3357
+ "name": "Buttonsimple",
3358
+ "module": "components/buttonsimple/buttonsimple.component.js"
3392
3359
  }
3393
3360
  },
3394
3361
  {
3395
3362
  "kind": "field",
3396
- "name": "disableAriaExpanded",
3363
+ "name": "softDisabled",
3397
3364
  "type": {
3398
3365
  "text": "boolean"
3399
3366
  },
3400
- "description": "Disable aria-expanded attribute on trigger element.",
3401
- "default": "true",
3402
- "attribute": "disable-aria-expanded",
3403
- "reflects": true,
3367
+ "default": "undefined as unknown",
3368
+ "description": "Indicates whether the button is soft disabled.\nWhen set to `true`, the button appears visually disabled but still allows\nfocus, click, and keyboard actions to be passed through.\n\n**Important:** When using soft disabled, consumers must ensure that\nthe button behaves like a disabled button, allowing only focus and\npreventing any interactions (clicks or keyboard actions) from triggering unintended actions.",
3369
+ "attribute": "soft-disabled",
3404
3370
  "inheritedFrom": {
3405
- "name": "Popover",
3406
- "module": "components/popover/popover.component.js"
3371
+ "name": "Buttonsimple",
3372
+ "module": "components/buttonsimple/buttonsimple.component.js"
3407
3373
  }
3408
3374
  },
3409
3375
  {
3410
3376
  "kind": "field",
3411
- "name": "color",
3377
+ "name": "iconName",
3412
3378
  "type": {
3413
- "text": "PopoverColor"
3379
+ "text": "IconNames | undefined"
3414
3380
  },
3415
- "description": "Color of the popover\n- **tonal**\n- **contrast**",
3416
- "default": "tonal",
3417
- "attribute": "color",
3418
- "reflects": true,
3381
+ "description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
3382
+ "attribute": "icon-name",
3419
3383
  "inheritedFrom": {
3420
- "name": "Popover",
3421
- "module": "components/popover/popover.component.js"
3384
+ "name": "IconNameMixin",
3385
+ "module": "utils/mixins/IconNameMixin.js"
3422
3386
  }
3423
3387
  },
3424
3388
  {
3425
3389
  "kind": "field",
3426
- "name": "enabledFocusTrap",
3390
+ "name": "tabIndex",
3427
3391
  "type": {
3428
- "text": "boolean"
3392
+ "text": "number"
3429
3393
  },
3430
- "description": "Determines whether the focus trap is enabled.\nIf true, focus will be restricted to the content within this component.",
3431
- "default": "false",
3432
- "attribute": "enabledFocusTrap",
3394
+ "default": "0",
3395
+ "description": "This property specifies the tab order of the element.",
3396
+ "attribute": "tabIndex",
3397
+ "reflects": true,
3433
3398
  "inheritedFrom": {
3434
- "name": "FocusTrapMixin",
3435
- "module": "utils/mixins/FocusTrapMixin.js"
3399
+ "name": "Buttonsimple",
3400
+ "module": "components/buttonsimple/buttonsimple.component.js"
3436
3401
  }
3437
3402
  },
3438
3403
  {
3439
3404
  "kind": "field",
3440
- "name": "enabledPreventScroll",
3405
+ "name": "disabled",
3441
3406
  "type": {
3442
3407
  "text": "boolean"
3443
3408
  },
3444
- "description": "Prevent outside scrolling when popover show.",
3445
3409
  "default": "false",
3446
- "attribute": "enabledPreventScroll",
3410
+ "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
3411
+ "attribute": "disabled",
3412
+ "reflects": true,
3447
3413
  "inheritedFrom": {
3448
- "name": "FocusTrapMixin",
3449
- "module": "utils/mixins/FocusTrapMixin.js"
3414
+ "name": "Buttonsimple",
3415
+ "module": "components/buttonsimple/buttonsimple.component.js"
3450
3416
  }
3451
3417
  },
3452
3418
  {
3453
3419
  "kind": "field",
3454
- "name": "shouldWrapFocus",
3420
+ "name": "type",
3455
3421
  "type": {
3456
- "text": "() => boolean"
3422
+ "text": "ButtonType"
3457
3423
  },
3424
+ "description": "This property defines the type attribute for the button element.\nThe type attribute specifies the behavior of the button when it is clicked.\n- **submit**: The button submits the form data to the server.\n- **reset**: The button resets the form data to its initial state.\n- **button**: The button does nothing when clicked.",
3425
+ "default": "button",
3426
+ "attribute": "type",
3427
+ "reflects": true,
3458
3428
  "inheritedFrom": {
3459
- "name": "FocusTrapMixin",
3460
- "module": "utils/mixins/FocusTrapMixin.js"
3429
+ "name": "Buttonsimple",
3430
+ "module": "components/buttonsimple/buttonsimple.component.js"
3461
3431
  }
3462
3432
  },
3463
3433
  {
3464
3434
  "kind": "method",
3465
- "name": "deactivateFocusTrap",
3466
- "description": "Deactivate the focus trap.",
3435
+ "name": "executeAction",
3436
+ "privacy": "protected",
3467
3437
  "inheritedFrom": {
3468
- "name": "FocusTrapMixin",
3469
- "module": "utils/mixins/FocusTrapMixin.js"
3438
+ "name": "Buttonsimple",
3439
+ "module": "components/buttonsimple/buttonsimple.component.js"
3470
3440
  }
3471
3441
  },
3472
3442
  {
3473
3443
  "kind": "method",
3474
- "name": "hasNoClientRects",
3475
- "privacy": "private",
3444
+ "name": "setActive",
3445
+ "privacy": "protected",
3476
3446
  "parameters": [
3477
3447
  {
3478
3448
  "name": "element",
3479
3449
  "type": {
3480
3450
  "text": "HTMLElement"
3481
3451
  },
3482
- "description": "The element to check."
3452
+ "description": "The button element"
3453
+ },
3454
+ {
3455
+ "name": "active",
3456
+ "type": {
3457
+ "text": "boolean"
3458
+ },
3459
+ "description": "The active state of the element"
3483
3460
  }
3484
3461
  ],
3485
- "description": "Checks if the element has no client rectangles (not visible in the viewport).",
3486
- "return": {
3487
- "type": {
3488
- "text": ""
3489
- }
3490
- },
3462
+ "description": "Sets the aria-pressed attribute based on the active state of the button.",
3491
3463
  "inheritedFrom": {
3492
- "name": "FocusTrapMixin",
3493
- "module": "utils/mixins/FocusTrapMixin.js"
3464
+ "name": "Buttonsimple",
3465
+ "module": "components/buttonsimple/buttonsimple.component.js"
3494
3466
  }
3495
3467
  },
3496
3468
  {
3497
3469
  "kind": "method",
3498
- "name": "hasZeroDimensions",
3470
+ "name": "setSoftDisabled",
3499
3471
  "privacy": "private",
3500
3472
  "parameters": [
3501
3473
  {
@@ -3503,23 +3475,25 @@
3503
3475
  "type": {
3504
3476
  "text": "HTMLElement"
3505
3477
  },
3506
- "description": "The element to check."
3478
+ "description": "The button element."
3479
+ },
3480
+ {
3481
+ "name": "softDisabled",
3482
+ "type": {
3483
+ "text": "boolean"
3484
+ },
3485
+ "description": "The soft-disabled state."
3507
3486
  }
3508
3487
  ],
3509
- "description": "Checks if the element has zero dimensions (width and height are both 0).",
3510
- "return": {
3511
- "type": {
3512
- "text": ""
3513
- }
3514
- },
3488
+ "description": "Sets the soft-disabled attribute for the button.\nWhen soft-disabled, the button looks to be disabled but remains focusable and clickable.\nAlso sets/removes aria-disabled attribute.",
3515
3489
  "inheritedFrom": {
3516
- "name": "FocusTrapMixin",
3517
- "module": "utils/mixins/FocusTrapMixin.js"
3490
+ "name": "Buttonsimple",
3491
+ "module": "components/buttonsimple/buttonsimple.component.js"
3518
3492
  }
3519
3493
  },
3520
3494
  {
3521
3495
  "kind": "method",
3522
- "name": "isNotVisible",
3496
+ "name": "setDisabled",
3523
3497
  "privacy": "private",
3524
3498
  "parameters": [
3525
3499
  {
@@ -3527,509 +3501,362 @@
3527
3501
  "type": {
3528
3502
  "text": "HTMLElement"
3529
3503
  },
3530
- "description": "The element to check."
3531
- }
3532
- ],
3533
- "description": "Determines if the element is not visible in the DOM.",
3534
- "return": {
3535
- "type": {
3536
- "text": ""
3537
- }
3538
- },
3539
- "inheritedFrom": {
3540
- "name": "FocusTrapMixin",
3541
- "module": "utils/mixins/FocusTrapMixin.js"
3542
- }
3543
- },
3544
- {
3545
- "kind": "method",
3546
- "name": "hasHiddenStyle",
3547
- "privacy": "private",
3548
- "parameters": [
3504
+ "description": "The button element."
3505
+ },
3549
3506
  {
3550
- "name": "element",
3507
+ "name": "disabled",
3551
3508
  "type": {
3552
- "text": "HTMLElement"
3509
+ "text": "boolean"
3553
3510
  },
3554
- "description": "The element to check."
3511
+ "description": "The disabled state."
3555
3512
  }
3556
3513
  ],
3557
- "description": "Checks if the element has inline styles that make it hidden.",
3558
- "return": {
3559
- "type": {
3560
- "text": ""
3561
- }
3562
- },
3514
+ "description": "Sets the disabled attribute for the button.\nWhen disabled, the button is not focusable or clickable, and tabindex is set to -1.\nThe previous tabindex is stored and restored when enabled.\nAlso sets/removes aria-disabled attribute.",
3563
3515
  "inheritedFrom": {
3564
- "name": "FocusTrapMixin",
3565
- "module": "utils/mixins/FocusTrapMixin.js"
3516
+ "name": "Buttonsimple",
3517
+ "module": "components/buttonsimple/buttonsimple.component.js"
3566
3518
  }
3567
3519
  },
3568
3520
  {
3569
3521
  "kind": "method",
3570
- "name": "hasComputedHidden",
3522
+ "name": "triggerClickEvent",
3571
3523
  "privacy": "private",
3572
- "parameters": [
3573
- {
3574
- "name": "element",
3575
- "type": {
3576
- "text": "HTMLElement"
3577
- },
3578
- "description": "The element to check."
3579
- }
3580
- ],
3581
- "description": "Checks if the element is hidden by a computed style.",
3582
- "return": {
3583
- "type": {
3584
- "text": ""
3585
- }
3586
- },
3587
3524
  "inheritedFrom": {
3588
- "name": "FocusTrapMixin",
3589
- "module": "utils/mixins/FocusTrapMixin.js"
3525
+ "name": "Buttonsimple",
3526
+ "module": "components/buttonsimple/buttonsimple.component.js"
3590
3527
  }
3591
3528
  },
3592
3529
  {
3593
3530
  "kind": "method",
3594
- "name": "isHidden",
3531
+ "name": "handleBlur",
3595
3532
  "privacy": "private",
3596
- "parameters": [
3597
- {
3598
- "name": "element",
3599
- "type": {
3600
- "text": "HTMLElement"
3601
- },
3602
- "description": "The element to check."
3603
- }
3604
- ],
3605
- "description": "Checks if the element is hidden from the user.",
3606
- "return": {
3607
- "type": {
3608
- "text": ""
3609
- }
3610
- },
3533
+ "description": "In case the button is pressed and the focus is lost while pressing,\nthe pressed class is removed.",
3611
3534
  "inheritedFrom": {
3612
- "name": "FocusTrapMixin",
3613
- "module": "utils/mixins/FocusTrapMixin.js"
3535
+ "name": "Buttonsimple",
3536
+ "module": "components/buttonsimple/buttonsimple.component.js"
3614
3537
  }
3615
3538
  },
3616
3539
  {
3617
3540
  "kind": "method",
3618
- "name": "isNotTabbable",
3541
+ "name": "handleKeyDown",
3619
3542
  "privacy": "private",
3620
3543
  "parameters": [
3621
3544
  {
3622
- "name": "element",
3545
+ "name": "event",
3623
3546
  "type": {
3624
- "text": "HTMLElement"
3547
+ "text": "KeyboardEvent"
3625
3548
  },
3626
- "description": "The element to check."
3549
+ "description": "The keyboard event."
3627
3550
  }
3628
3551
  ],
3629
- "description": "Checks if the element is not tabbable.",
3630
- "return": {
3631
- "type": {
3632
- "text": ""
3633
- }
3634
- },
3552
+ "description": "Handles the keydown event on the button.\nIf the key is 'Enter' or 'Space', the button is pressed.\nIf the key is 'Enter', the button is pressed. The native HTML button works in the same way.",
3635
3553
  "inheritedFrom": {
3636
- "name": "FocusTrapMixin",
3637
- "module": "utils/mixins/FocusTrapMixin.js"
3554
+ "name": "Buttonsimple",
3555
+ "module": "components/buttonsimple/buttonsimple.component.js"
3638
3556
  }
3639
3557
  },
3640
3558
  {
3641
3559
  "kind": "method",
3642
- "name": "isInteractiveElement",
3560
+ "name": "handleKeyUp",
3643
3561
  "privacy": "private",
3644
- "return": {
3645
- "type": {
3646
- "text": ""
3647
- }
3648
- },
3649
3562
  "parameters": [
3650
3563
  {
3651
- "name": "element",
3564
+ "name": "event",
3652
3565
  "type": {
3653
- "text": "HTMLElement"
3566
+ "text": "KeyboardEvent"
3654
3567
  },
3655
- "description": "The element to check."
3568
+ "description": "The keyboard event."
3656
3569
  }
3657
3570
  ],
3658
- "description": "Checks if the element is interactive.",
3571
+ "description": "Handles the keyup event on the button.\nIf the key is 'Enter' or 'Space', the button is clicked.\nIf the key is 'Space', the button is pressed. The native HTML button works in the same way.",
3659
3572
  "inheritedFrom": {
3660
- "name": "FocusTrapMixin",
3661
- "module": "utils/mixins/FocusTrapMixin.js"
3573
+ "name": "Buttonsimple",
3574
+ "module": "components/buttonsimple/buttonsimple.component.js"
3662
3575
  }
3576
+ }
3577
+ ],
3578
+ "attributes": [
3579
+ {
3580
+ "name": "color",
3581
+ "type": {
3582
+ "text": "ColorType"
3583
+ },
3584
+ "description": "The color of the chip. It supports the following colors\n- default\n- cobalt\n- gold\n- lime\n- mint\n- pink\n- purple\n- slate\n- violet",
3585
+ "default": "default",
3586
+ "fieldName": "color"
3663
3587
  },
3664
3588
  {
3665
- "kind": "method",
3666
- "name": "isFocusable",
3667
- "privacy": "private",
3668
- "parameters": [
3669
- {
3670
- "name": "element",
3671
- "type": {
3672
- "text": "HTMLElement"
3673
- },
3674
- "description": "The element to check."
3675
- }
3676
- ],
3677
- "description": "Checks if the element is focusable.",
3678
- "return": {
3679
- "type": {
3680
- "text": ""
3681
- }
3589
+ "name": "label",
3590
+ "type": {
3591
+ "text": "string"
3682
3592
  },
3593
+ "default": "''",
3594
+ "description": "The visible label text of the chip.\n\nWe recommend limiting the <b>maximum length of the label text to 20 characters</b>,\nincluding empty spaces to split words.",
3595
+ "fieldName": "label"
3596
+ },
3597
+ {
3598
+ "name": "icon-name",
3599
+ "type": {
3600
+ "text": "IconNames | undefined"
3601
+ },
3602
+ "description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
3603
+ "fieldName": "iconName",
3683
3604
  "inheritedFrom": {
3684
- "name": "FocusTrapMixin",
3685
- "module": "utils/mixins/FocusTrapMixin.js"
3605
+ "name": "IconNameMixin",
3606
+ "module": "src/utils/mixins/IconNameMixin.ts"
3686
3607
  }
3687
3608
  },
3688
3609
  {
3689
- "kind": "method",
3690
- "name": "findFocusable",
3691
- "privacy": "private",
3692
- "return": {
3693
- "type": {
3694
- "text": ""
3695
- }
3610
+ "name": "tabIndex",
3611
+ "type": {
3612
+ "text": "number"
3696
3613
  },
3697
- "parameters": [
3698
- {
3699
- "name": "root",
3700
- "type": {
3701
- "text": "ShadowRoot | HTMLElement"
3702
- },
3703
- "description": "The root element to search for focusable elements."
3704
- },
3705
- {
3706
- "name": "matches",
3707
- "default": "new Set()",
3708
- "type": {
3709
- "text": "Set<HTMLElement>"
3710
- },
3711
- "description": "The set of focusable elements."
3712
- }
3713
- ],
3714
- "description": "Recursively finds all focusable elements within the given root and its descendants.",
3614
+ "default": "0",
3615
+ "description": "This property specifies the tab order of the element.",
3616
+ "fieldName": "tabIndex",
3715
3617
  "inheritedFrom": {
3716
- "name": "FocusTrapMixin",
3717
- "module": "utils/mixins/FocusTrapMixin.js"
3618
+ "name": "Buttonsimple",
3619
+ "module": "src/components/buttonsimple/buttonsimple.component.ts"
3718
3620
  }
3719
3621
  },
3720
3622
  {
3721
- "kind": "method",
3722
- "name": "setFocusableElements",
3723
- "privacy": "public",
3724
- "description": "Updates the list of focusable elements within the component's shadow root.",
3623
+ "name": "disabled",
3624
+ "type": {
3625
+ "text": "boolean"
3626
+ },
3627
+ "default": "false",
3628
+ "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
3629
+ "fieldName": "disabled",
3725
3630
  "inheritedFrom": {
3726
- "name": "FocusTrapMixin",
3727
- "module": "utils/mixins/FocusTrapMixin.js"
3631
+ "name": "Buttonsimple",
3632
+ "module": "src/components/buttonsimple/buttonsimple.component.ts"
3728
3633
  }
3729
3634
  },
3730
3635
  {
3731
- "kind": "method",
3732
- "name": "setInitialFocus",
3733
- "privacy": "public",
3734
- "parameters": [
3735
- {
3736
- "name": "prefferableElement",
3737
- "default": "0",
3738
- "type": {
3739
- "text": "number"
3740
- },
3741
- "description": "The index of the prefferable element to focus."
3742
- }
3743
- ],
3744
- "description": "Sets the initial focus within the container.",
3636
+ "name": "active",
3637
+ "type": {
3638
+ "text": "boolean"
3639
+ },
3640
+ "default": "false",
3641
+ "description": "The button's active state indicates whether it is currently toggled on (active) or off (inactive).\nWhen the active state is true, the button is considered to be in an active state, meaning it is toggled on.\nConversely, when the active state is false, the button is in an inactive state, indicating it is toggled off.",
3642
+ "fieldName": "active",
3745
3643
  "inheritedFrom": {
3746
- "name": "FocusTrapMixin",
3747
- "module": "utils/mixins/FocusTrapMixin.js"
3644
+ "name": "Buttonsimple",
3645
+ "module": "src/components/buttonsimple/buttonsimple.component.ts"
3748
3646
  }
3749
3647
  },
3750
3648
  {
3751
- "kind": "method",
3752
- "name": "calculateNextIndex",
3753
- "privacy": "private",
3754
- "parameters": [
3755
- {
3756
- "name": "currentIndex",
3757
- "type": {
3758
- "text": "number"
3759
- },
3760
- "description": "The current index."
3761
- },
3762
- {
3763
- "name": "step",
3764
- "type": {
3765
- "text": "number"
3766
- },
3767
- "description": "The step to calculate the next index."
3768
- }
3769
- ],
3770
- "description": "Calculates the next index for the focus trap.",
3771
- "return": {
3772
- "type": {
3773
- "text": ""
3774
- }
3649
+ "name": "soft-disabled",
3650
+ "type": {
3651
+ "text": "boolean"
3775
3652
  },
3653
+ "default": "false",
3654
+ "description": "Indicates whether the button is soft disabled.\nWhen set to `true`, the button appears visually disabled but still allows\nfocus, click, and keyboard actions to be passed through.\n\n**Important:** When using soft disabled, consumers must ensure that\nthe button behaves like a disabled button, allowing only focus and\npreventing any interactions (clicks or keyboard actions) from triggering unintended actions.",
3655
+ "fieldName": "softDisabled",
3776
3656
  "inheritedFrom": {
3777
- "name": "FocusTrapMixin",
3778
- "module": "utils/mixins/FocusTrapMixin.js"
3657
+ "name": "Buttonsimple",
3658
+ "module": "src/components/buttonsimple/buttonsimple.component.ts"
3779
3659
  }
3780
3660
  },
3781
3661
  {
3782
- "kind": "method",
3783
- "name": "getDeepActiveElement",
3784
- "privacy": "private",
3785
- "description": "Returns the deepest active element in the shadow DOM.",
3786
- "return": {
3787
- "type": {
3788
- "text": ""
3789
- }
3662
+ "name": "size",
3663
+ "type": {
3664
+ "text": "ButtonSize"
3790
3665
  },
3666
+ "description": "Simplebutton size is a super set of all the sizes supported by children components.",
3667
+ "default": "32",
3668
+ "fieldName": "size",
3791
3669
  "inheritedFrom": {
3792
- "name": "FocusTrapMixin",
3793
- "module": "utils/mixins/FocusTrapMixin.js"
3670
+ "name": "Buttonsimple",
3671
+ "module": "src/components/buttonsimple/buttonsimple.component.ts"
3794
3672
  }
3795
3673
  },
3796
3674
  {
3797
- "kind": "method",
3798
- "name": "findElement",
3799
- "privacy": "private",
3800
- "parameters": [
3801
- {
3802
- "name": "activeElement",
3803
- "type": {
3804
- "text": "HTMLElement"
3805
- },
3806
- "description": "The active element."
3807
- }
3808
- ],
3809
- "description": "Finds the index of the active element within the focusable elements.",
3810
- "return": {
3811
- "type": {
3812
- "text": ""
3813
- }
3814
- },
3675
+ "name": "role",
3676
+ "description": "This property defines the ARIA role for the element. By default, it is set to 'button'.\nConsumers should override this role when:\n- The element is being used in a context where a different role is more appropriate.\n- Custom behaviors are implemented that require a specific ARIA role for accessibility purposes.",
3677
+ "default": "button",
3678
+ "fieldName": "role",
3815
3679
  "inheritedFrom": {
3816
- "name": "FocusTrapMixin",
3817
- "module": "utils/mixins/FocusTrapMixin.js"
3680
+ "name": "Buttonsimple",
3681
+ "module": "src/components/buttonsimple/buttonsimple.component.ts"
3818
3682
  }
3819
3683
  },
3820
3684
  {
3821
- "kind": "method",
3822
- "name": "isEqualFocusNode",
3823
- "privacy": "private",
3824
- "parameters": [
3825
- {
3826
- "name": "activeElement",
3827
- "type": {
3828
- "text": "HTMLElement"
3829
- },
3830
- "description": "The active element."
3831
- },
3832
- {
3833
- "name": "element",
3834
- "type": {
3835
- "text": "HTMLElement"
3836
- },
3837
- "description": "The element to compare."
3838
- }
3839
- ],
3840
- "description": "Checks if the active element is equal to the given element.",
3841
- "return": {
3842
- "type": {
3843
- "text": ""
3844
- }
3685
+ "name": "type",
3686
+ "type": {
3687
+ "text": "ButtonType"
3845
3688
  },
3689
+ "description": "This property defines the type attribute for the button element.\nThe type attribute specifies the behavior of the button when it is clicked.\n- **submit**: The button submits the form data to the server.\n- **reset**: The button resets the form data to its initial state.\n- **button**: The button does nothing when clicked.",
3690
+ "default": "button",
3691
+ "fieldName": "type",
3846
3692
  "inheritedFrom": {
3847
- "name": "FocusTrapMixin",
3848
- "module": "utils/mixins/FocusTrapMixin.js"
3693
+ "name": "Buttonsimple",
3694
+ "module": "src/components/buttonsimple/buttonsimple.component.ts"
3695
+ }
3696
+ }
3697
+ ],
3698
+ "mixins": [
3699
+ {
3700
+ "name": "IconNameMixin",
3701
+ "module": "/src/utils/mixins/IconNameMixin"
3702
+ }
3703
+ ],
3704
+ "superclass": {
3705
+ "name": "Buttonsimple",
3706
+ "module": "/src/components/buttonsimple/buttonsimple.component"
3707
+ },
3708
+ "tagName": "mdc-chip",
3709
+ "jsDoc": "/**\n * mdc-chip is an interactive element that can be used to represent a chip. It supports a leading icon along with label.\n * Consumers can wrap this component around a tooltip to provide additional context.\n *\n * It is recommended to keep the label text for the chip component concise and compact.\n * For best results, we recommend limiting the <b>maximum length of the label text to 20 characters</b>,\n * including empty spaces to split words.\n *\n * This component is built by extending Buttonsimple.\n *\n * @tagname mdc-chip\n *\n * @dependency mdc-icon\n * @dependency mdc-text\n *\n * @cssproperty --mdc-chip-color - The color of the chip.\n * @cssproperty --mdc-chip-border-color - The border color of the chip.\n * @cssproperty --mdc-chip-background-color - The background color of the chip.\n *\n */",
3710
+ "customElement": true,
3711
+ "events": [
3712
+ {
3713
+ "description": "(React: onClick) This event is dispatched when the button is clicked.",
3714
+ "name": "click",
3715
+ "reactName": "onClick",
3716
+ "eventName": "ClickEvent",
3717
+ "inheritedFrom": {
3718
+ "name": "Buttonsimple",
3719
+ "module": "src/components/buttonsimple/buttonsimple.component.ts"
3849
3720
  }
3850
3721
  },
3851
3722
  {
3852
- "kind": "method",
3853
- "name": "trapFocus",
3854
- "privacy": "private",
3855
- "parameters": [
3856
- {
3857
- "name": "direction",
3858
- "type": {
3859
- "text": "boolean"
3860
- },
3861
- "description": "The direction of the focus trap.\nIf true, the focus will be trapped in the previous element."
3862
- }
3863
- ],
3864
- "description": "Traps focus within the container.",
3723
+ "description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the button.",
3724
+ "name": "keydown",
3725
+ "reactName": "onKeyDown",
3726
+ "eventName": "KeydownEvent",
3865
3727
  "inheritedFrom": {
3866
- "name": "FocusTrapMixin",
3867
- "module": "utils/mixins/FocusTrapMixin.js"
3728
+ "name": "Buttonsimple",
3729
+ "module": "src/components/buttonsimple/buttonsimple.component.ts"
3868
3730
  }
3869
3731
  },
3870
3732
  {
3871
- "kind": "method",
3872
- "name": "handleKeydown",
3873
- "privacy": "private",
3874
- "parameters": [
3875
- {
3876
- "name": "event",
3877
- "type": {
3878
- "text": "KeyboardEvent"
3879
- },
3880
- "description": "The keyboard event."
3881
- }
3882
- ],
3883
- "description": "Traps focus within the container.",
3733
+ "description": "(React: onKeyUp) This event is dispatched when a key is released on the button.",
3734
+ "name": "keyup",
3735
+ "reactName": "onKeyUp",
3736
+ "eventName": "KeyupEvent",
3884
3737
  "inheritedFrom": {
3885
- "name": "FocusTrapMixin",
3886
- "module": "utils/mixins/FocusTrapMixin.js"
3738
+ "name": "Buttonsimple",
3739
+ "module": "src/components/buttonsimple/buttonsimple.component.ts"
3887
3740
  }
3888
3741
  },
3889
3742
  {
3890
- "kind": "field",
3891
- "name": "id",
3892
- "type": {
3893
- "text": "string"
3894
- },
3895
- "default": "''",
3896
- "description": "The unique ID of the popover.",
3897
- "attribute": "id",
3898
- "reflects": true,
3743
+ "description": "(React: onFocus) This event is dispatched when the button receives focus.",
3744
+ "name": "focus",
3745
+ "reactName": "onFocus",
3746
+ "eventName": "FocusEvent",
3747
+ "inheritedFrom": {
3748
+ "name": "Buttonsimple",
3749
+ "module": "src/components/buttonsimple/buttonsimple.component.ts"
3750
+ }
3751
+ }
3752
+ ]
3753
+ }
3754
+ ],
3755
+ "exports": [
3756
+ {
3757
+ "kind": "js",
3758
+ "name": "default",
3759
+ "declaration": {
3760
+ "name": "Chip",
3761
+ "module": "components/chip/chip.component.js"
3762
+ }
3763
+ }
3764
+ ]
3765
+ },
3766
+ {
3767
+ "kind": "javascript-module",
3768
+ "path": "components/coachmark/coachmark.component.js",
3769
+ "declarations": [
3770
+ {
3771
+ "kind": "class",
3772
+ "description": "Coachmark component based on top of the popover component,\nwith the default value of certain properties changed.",
3773
+ "name": "Coachmark",
3774
+ "cssProperties": [
3775
+ {
3776
+ "description": "radius of the arrow border",
3777
+ "name": "--mdc-popover-arrow-border-radius",
3899
3778
  "inheritedFrom": {
3900
3779
  "name": "Popover",
3901
- "module": "components/popover/popover.component.js"
3780
+ "module": "src/components/popover/popover.component.ts"
3902
3781
  }
3903
3782
  },
3904
3783
  {
3905
- "kind": "field",
3906
- "name": "triggerID",
3907
- "type": {
3908
- "text": "string"
3909
- },
3910
- "default": "''",
3911
- "description": "The ID of the element that triggers the popover.\nThis attribute is required for the popover to work.",
3912
- "attribute": "triggerID",
3913
- "reflects": true,
3784
+ "description": "border of the arrow",
3785
+ "name": "--mdc-popover-arrow-border",
3914
3786
  "inheritedFrom": {
3915
3787
  "name": "Popover",
3916
- "module": "components/popover/popover.component.js"
3788
+ "module": "src/components/popover/popover.component.ts"
3917
3789
  }
3918
3790
  },
3919
3791
  {
3920
- "kind": "field",
3921
- "name": "placement",
3922
- "type": {
3923
- "text": "PopoverPlacement"
3924
- },
3925
- "description": "The placement of the popover.\n- **top**\n- **top-start**\n- **top-end**\n- **bottom**\n- **bottom-start**\n- **bottom-end**\n- **left**\n- **left-start**\n- **left-end**\n- **right**\n- **right-start**\n- **right-end**",
3926
- "default": "bottom",
3927
- "attribute": "placement",
3928
- "reflects": true,
3792
+ "description": "primary background color of the popover",
3793
+ "name": "--mdc-popover-primary-background-color",
3929
3794
  "inheritedFrom": {
3930
3795
  "name": "Popover",
3931
- "module": "components/popover/popover.component.js"
3796
+ "module": "src/components/popover/popover.component.ts"
3932
3797
  }
3933
3798
  },
3934
3799
  {
3935
- "kind": "field",
3936
- "name": "visible",
3937
- "type": {
3938
- "text": "boolean"
3939
- },
3940
- "description": "The visibility of the popover.",
3941
- "default": "false",
3942
- "attribute": "visible",
3943
- "reflects": true,
3800
+ "description": "border color of the popover",
3801
+ "name": "--mdc-popover-border-color",
3944
3802
  "inheritedFrom": {
3945
3803
  "name": "Popover",
3946
- "module": "components/popover/popover.component.js"
3804
+ "module": "src/components/popover/popover.component.ts"
3947
3805
  }
3948
3806
  },
3949
3807
  {
3950
- "kind": "field",
3951
- "name": "offset",
3952
- "type": {
3953
- "text": "number"
3954
- },
3955
- "description": "The offset of the popover.",
3956
- "default": "4",
3957
- "attribute": "offset",
3958
- "reflects": true,
3808
+ "description": "inverted background color of the popover",
3809
+ "name": "--mdc-popover-inverted-background-color",
3959
3810
  "inheritedFrom": {
3960
3811
  "name": "Popover",
3961
- "module": "components/popover/popover.component.js"
3812
+ "module": "src/components/popover/popover.component.ts"
3962
3813
  }
3963
3814
  },
3964
3815
  {
3965
- "kind": "field",
3966
- "name": "focusTrap",
3967
- "type": {
3968
- "text": "boolean"
3969
- },
3970
- "description": "Determines whether the focus trap is enabled.\nIf true, focus will be restricted to the content within this component.",
3971
- "default": "false",
3972
- "attribute": "focus-trap",
3973
- "reflects": true,
3816
+ "description": "inverted border color of the popover",
3817
+ "name": "--mdc-popover-inverted-border-color",
3974
3818
  "inheritedFrom": {
3975
3819
  "name": "Popover",
3976
- "module": "components/popover/popover.component.js"
3820
+ "module": "src/components/popover/popover.component.ts"
3977
3821
  }
3978
3822
  },
3979
3823
  {
3980
- "kind": "field",
3981
- "name": "preventScroll",
3982
- "type": {
3983
- "text": "boolean"
3984
- },
3985
- "description": "Prevent outside scrolling when popover show.",
3986
- "default": "false",
3987
- "attribute": "prevent-scroll",
3988
- "reflects": true,
3824
+ "description": "inverted text color of the popover",
3825
+ "name": "--mdc-popover-inverted-text-color",
3989
3826
  "inheritedFrom": {
3990
3827
  "name": "Popover",
3991
- "module": "components/popover/popover.component.js"
3828
+ "module": "src/components/popover/popover.component.ts"
3992
3829
  }
3993
3830
  },
3994
3831
  {
3995
- "kind": "field",
3996
- "name": "interactive",
3997
- "type": {
3998
- "text": "boolean"
3999
- },
4000
- "description": "Determines whether the popover is interactive。",
4001
- "default": "false",
4002
- "attribute": "interactive",
4003
- "reflects": true,
3832
+ "description": "elevation of the popover",
3833
+ "name": "--mdc-popover-elevation-3",
4004
3834
  "inheritedFrom": {
4005
3835
  "name": "Popover",
4006
- "module": "components/popover/popover.component.js"
3836
+ "module": "src/components/popover/popover.component.ts"
4007
3837
  }
4008
- },
3838
+ }
3839
+ ],
3840
+ "slots": [
4009
3841
  {
4010
- "kind": "field",
4011
- "name": "delay",
4012
- "type": {
4013
- "text": "string"
4014
- },
4015
- "description": "The delay of the show/hide popover.",
4016
- "default": "0,0",
4017
- "attribute": "delay",
4018
- "reflects": true,
3842
+ "description": "Default slot for modal container",
3843
+ "name": "",
4019
3844
  "inheritedFrom": {
4020
3845
  "name": "Popover",
4021
- "module": "components/popover/popover.component.js"
3846
+ "module": "src/components/popover/popover.component.ts"
4022
3847
  }
4023
- },
3848
+ }
3849
+ ],
3850
+ "members": [
4024
3851
  {
4025
3852
  "kind": "field",
4026
- "name": "hideOnEscape",
3853
+ "name": "trigger",
4027
3854
  "type": {
4028
- "text": "boolean"
3855
+ "text": "PopoverTrigger"
4029
3856
  },
4030
- "description": "Hide popover on escape key press.",
4031
- "default": "false",
4032
- "attribute": "hide-on-escape",
3857
+ "description": "Determines the events that cause the Coachmark to show.\nMultiple event names should be separated by spaces.\nFor example to allow both click and hover, use 'click mouseenter' as the trigger.\n- **click**\n- **mouseenter**\n- **focusin**\n- **manual**",
3858
+ "default": "manual",
3859
+ "attribute": "trigger",
4033
3860
  "reflects": true,
4034
3861
  "inheritedFrom": {
4035
3862
  "name": "Popover",
@@ -4038,13 +3865,13 @@
4038
3865
  },
4039
3866
  {
4040
3867
  "kind": "field",
4041
- "name": "hideOnBlur",
3868
+ "name": "showArrow",
4042
3869
  "type": {
4043
3870
  "text": "boolean"
4044
3871
  },
4045
- "description": "Hide popover on blur.",
4046
- "default": "false",
4047
- "attribute": "hide-on-blur",
3872
+ "description": "The arrow visibility of the Coachmark.",
3873
+ "default": "true",
3874
+ "attribute": "show-arrow",
4048
3875
  "reflects": true,
4049
3876
  "inheritedFrom": {
4050
3877
  "name": "Popover",
@@ -4053,13 +3880,13 @@
4053
3880
  },
4054
3881
  {
4055
3882
  "kind": "field",
4056
- "name": "hideOnOutsideClick",
3883
+ "name": "closeButton",
4057
3884
  "type": {
4058
3885
  "text": "boolean"
4059
3886
  },
4060
- "description": "Hide on outside click of the popover.",
4061
- "default": "false",
4062
- "attribute": "hide-on-outside-click",
3887
+ "description": "The close button visibility of the Coachmark.",
3888
+ "default": "true",
3889
+ "attribute": "close-button",
4063
3890
  "reflects": true,
4064
3891
  "inheritedFrom": {
4065
3892
  "name": "Popover",
@@ -4068,13 +3895,13 @@
4068
3895
  },
4069
3896
  {
4070
3897
  "kind": "field",
4071
- "name": "focusBackToTrigger",
3898
+ "name": "disableAriaExpanded",
4072
3899
  "type": {
4073
3900
  "text": "boolean"
4074
3901
  },
4075
- "description": "The focus back to trigger after the popover hide.",
4076
- "default": "false",
4077
- "attribute": "focus-back-to-trigger",
3902
+ "description": "Disable aria-expanded attribute on trigger element.",
3903
+ "default": "true",
3904
+ "attribute": "disable-aria-expanded",
4078
3905
  "reflects": true,
4079
3906
  "inheritedFrom": {
4080
3907
  "name": "Popover",
@@ -4083,13 +3910,13 @@
4083
3910
  },
4084
3911
  {
4085
3912
  "kind": "field",
4086
- "name": "backdrop",
3913
+ "name": "color",
4087
3914
  "type": {
4088
- "text": "boolean"
3915
+ "text": "PopoverColor"
4089
3916
  },
4090
- "description": "Determines whether the popover with backdrop.\nOther than popover and trigger element, the rest of the screen will be covered with a backdrop.",
4091
- "default": "false",
4092
- "attribute": "backdrop",
3917
+ "description": "Color of the popover\n- **tonal**\n- **contrast**",
3918
+ "default": "tonal",
3919
+ "attribute": "color",
4093
3920
  "reflects": true,
4094
3921
  "inheritedFrom": {
4095
3922
  "name": "Popover",
@@ -4098,1211 +3925,1384 @@
4098
3925
  },
4099
3926
  {
4100
3927
  "kind": "field",
4101
- "name": "flip",
3928
+ "name": "enabledFocusTrap",
4102
3929
  "type": {
4103
3930
  "text": "boolean"
4104
3931
  },
4105
- "description": "Changes the placement of popover to keep it in view when scrolling.",
4106
- "default": "true",
4107
- "attribute": "flip",
4108
- "reflects": true,
3932
+ "description": "Determines whether the focus trap is enabled.\nIf true, focus will be restricted to the content within this component.",
3933
+ "default": "false",
3934
+ "attribute": "enabledFocusTrap",
4109
3935
  "inheritedFrom": {
4110
- "name": "Popover",
4111
- "module": "components/popover/popover.component.js"
3936
+ "name": "FocusTrapMixin",
3937
+ "module": "utils/mixins/FocusTrapMixin.js"
4112
3938
  }
4113
3939
  },
4114
3940
  {
4115
3941
  "kind": "field",
4116
- "name": "size",
3942
+ "name": "enabledPreventScroll",
4117
3943
  "type": {
4118
3944
  "text": "boolean"
4119
3945
  },
4120
- "description": "Changes the size of popover to keep it in view when scrolling.",
3946
+ "description": "Prevent outside scrolling when popover show.",
4121
3947
  "default": "false",
4122
- "attribute": "size",
4123
- "reflects": true,
3948
+ "attribute": "enabledPreventScroll",
4124
3949
  "inheritedFrom": {
4125
- "name": "Popover",
4126
- "module": "components/popover/popover.component.js"
3950
+ "name": "FocusTrapMixin",
3951
+ "module": "utils/mixins/FocusTrapMixin.js"
4127
3952
  }
4128
3953
  },
4129
3954
  {
4130
3955
  "kind": "field",
4131
- "name": "zIndex",
3956
+ "name": "shouldWrapFocus",
4132
3957
  "type": {
4133
- "text": "number"
3958
+ "text": "() => boolean"
4134
3959
  },
4135
- "description": "The z-index of the popover.",
4136
- "default": "1000",
4137
- "attribute": "z-index",
4138
- "reflects": true,
4139
3960
  "inheritedFrom": {
4140
- "name": "Popover",
4141
- "module": "components/popover/popover.component.js"
3961
+ "name": "FocusTrapMixin",
3962
+ "module": "utils/mixins/FocusTrapMixin.js"
4142
3963
  }
4143
3964
  },
4144
3965
  {
4145
- "kind": "field",
4146
- "name": "appendTo",
4147
- "type": {
4148
- "text": "string"
4149
- },
4150
- "default": "''",
4151
- "description": "Element ID that the popover append to.",
4152
- "attribute": "append-to",
4153
- "reflects": true,
3966
+ "kind": "method",
3967
+ "name": "deactivateFocusTrap",
3968
+ "description": "Deactivate the focus trap.",
4154
3969
  "inheritedFrom": {
4155
- "name": "Popover",
4156
- "module": "components/popover/popover.component.js"
3970
+ "name": "FocusTrapMixin",
3971
+ "module": "utils/mixins/FocusTrapMixin.js"
4157
3972
  }
4158
3973
  },
4159
3974
  {
4160
- "kind": "field",
4161
- "name": "closeButtonAriaLabel",
4162
- "type": {
4163
- "text": "string | null"
3975
+ "kind": "method",
3976
+ "name": "hasNoClientRects",
3977
+ "privacy": "private",
3978
+ "parameters": [
3979
+ {
3980
+ "name": "element",
3981
+ "type": {
3982
+ "text": "HTMLElement"
3983
+ },
3984
+ "description": "The element to check."
3985
+ }
3986
+ ],
3987
+ "description": "Checks if the element has no client rectangles (not visible in the viewport).",
3988
+ "return": {
3989
+ "type": {
3990
+ "text": ""
3991
+ }
4164
3992
  },
4165
- "default": "null",
4166
- "description": "aria-label attribute to be set for close button accessibility.",
4167
- "attribute": "close-button-aria-label",
4168
3993
  "inheritedFrom": {
4169
- "name": "Popover",
4170
- "module": "components/popover/popover.component.js"
3994
+ "name": "FocusTrapMixin",
3995
+ "module": "utils/mixins/FocusTrapMixin.js"
4171
3996
  }
4172
3997
  },
4173
3998
  {
4174
- "kind": "field",
4175
- "name": "role",
4176
- "type": {
4177
- "text": "HTMLElement['role']"
3999
+ "kind": "method",
4000
+ "name": "hasZeroDimensions",
4001
+ "privacy": "private",
4002
+ "parameters": [
4003
+ {
4004
+ "name": "element",
4005
+ "type": {
4006
+ "text": "HTMLElement"
4007
+ },
4008
+ "description": "The element to check."
4009
+ }
4010
+ ],
4011
+ "description": "Checks if the element has zero dimensions (width and height are both 0).",
4012
+ "return": {
4013
+ "type": {
4014
+ "text": ""
4015
+ }
4178
4016
  },
4179
- "description": "Role of the popover",
4180
- "default": "dialog",
4181
- "attribute": "role",
4182
- "reflects": true,
4183
4017
  "inheritedFrom": {
4184
- "name": "Popover",
4185
- "module": "components/popover/popover.component.js"
4018
+ "name": "FocusTrapMixin",
4019
+ "module": "utils/mixins/FocusTrapMixin.js"
4186
4020
  }
4187
4021
  },
4188
4022
  {
4189
- "kind": "field",
4190
- "name": "ariaLabelledby",
4191
- "type": {
4192
- "text": "string | null"
4023
+ "kind": "method",
4024
+ "name": "isNotVisible",
4025
+ "privacy": "private",
4026
+ "parameters": [
4027
+ {
4028
+ "name": "element",
4029
+ "type": {
4030
+ "text": "HTMLElement"
4031
+ },
4032
+ "description": "The element to check."
4033
+ }
4034
+ ],
4035
+ "description": "Determines if the element is not visible in the DOM.",
4036
+ "return": {
4037
+ "type": {
4038
+ "text": ""
4039
+ }
4193
4040
  },
4194
- "default": "null",
4195
- "description": "aria-labelledby for an interactive popover only, defaults to the trigger component id.\nUsed in nested cases where the triggerComponent isn't the actual button.",
4196
- "attribute": "aria-labelledby",
4197
- "reflects": true,
4198
4041
  "inheritedFrom": {
4199
- "name": "Popover",
4200
- "module": "components/popover/popover.component.js"
4042
+ "name": "FocusTrapMixin",
4043
+ "module": "utils/mixins/FocusTrapMixin.js"
4201
4044
  }
4202
4045
  },
4203
4046
  {
4204
- "kind": "field",
4205
- "name": "ariaDescribedby",
4206
- "type": {
4207
- "text": "string | null"
4047
+ "kind": "method",
4048
+ "name": "hasHiddenStyle",
4049
+ "privacy": "private",
4050
+ "parameters": [
4051
+ {
4052
+ "name": "element",
4053
+ "type": {
4054
+ "text": "HTMLElement"
4055
+ },
4056
+ "description": "The element to check."
4057
+ }
4058
+ ],
4059
+ "description": "Checks if the element has inline styles that make it hidden.",
4060
+ "return": {
4061
+ "type": {
4062
+ "text": ""
4063
+ }
4208
4064
  },
4209
- "default": "null",
4210
- "description": "aria-describedby of the popover.",
4211
- "attribute": "aria-describedby",
4212
- "reflects": true,
4213
4065
  "inheritedFrom": {
4214
- "name": "Popover",
4215
- "module": "components/popover/popover.component.js"
4066
+ "name": "FocusTrapMixin",
4067
+ "module": "utils/mixins/FocusTrapMixin.js"
4216
4068
  }
4217
4069
  },
4218
4070
  {
4219
- "kind": "field",
4220
- "name": "arrowElement",
4221
- "type": {
4222
- "text": "HTMLElement | null"
4071
+ "kind": "method",
4072
+ "name": "hasComputedHidden",
4073
+ "privacy": "private",
4074
+ "parameters": [
4075
+ {
4076
+ "name": "element",
4077
+ "type": {
4078
+ "text": "HTMLElement"
4079
+ },
4080
+ "description": "The element to check."
4081
+ }
4082
+ ],
4083
+ "description": "Checks if the element is hidden by a computed style.",
4084
+ "return": {
4085
+ "type": {
4086
+ "text": ""
4087
+ }
4223
4088
  },
4224
- "privacy": "public",
4225
- "default": "null",
4226
4089
  "inheritedFrom": {
4227
- "name": "Popover",
4228
- "module": "components/popover/popover.component.js"
4090
+ "name": "FocusTrapMixin",
4091
+ "module": "utils/mixins/FocusTrapMixin.js"
4229
4092
  }
4230
4093
  },
4231
4094
  {
4232
- "kind": "field",
4233
- "name": "triggerElement",
4234
- "type": {
4235
- "text": "HTMLElement | null"
4095
+ "kind": "method",
4096
+ "name": "isHidden",
4097
+ "privacy": "private",
4098
+ "parameters": [
4099
+ {
4100
+ "name": "element",
4101
+ "type": {
4102
+ "text": "HTMLElement"
4103
+ },
4104
+ "description": "The element to check."
4105
+ }
4106
+ ],
4107
+ "description": "Checks if the element is hidden from the user.",
4108
+ "return": {
4109
+ "type": {
4110
+ "text": ""
4111
+ }
4236
4112
  },
4237
- "privacy": "public",
4238
- "default": "null",
4239
4113
  "inheritedFrom": {
4240
- "name": "Popover",
4241
- "module": "components/popover/popover.component.js"
4114
+ "name": "FocusTrapMixin",
4115
+ "module": "utils/mixins/FocusTrapMixin.js"
4242
4116
  }
4243
4117
  },
4244
4118
  {
4245
4119
  "kind": "method",
4246
- "name": "setupTriggerListener",
4120
+ "name": "isNotTabbable",
4247
4121
  "privacy": "private",
4248
- "description": "Sets up the trigger event listeners based on the trigger type.",
4122
+ "parameters": [
4123
+ {
4124
+ "name": "element",
4125
+ "type": {
4126
+ "text": "HTMLElement"
4127
+ },
4128
+ "description": "The element to check."
4129
+ }
4130
+ ],
4131
+ "description": "Checks if the element is not tabbable.",
4132
+ "return": {
4133
+ "type": {
4134
+ "text": ""
4135
+ }
4136
+ },
4249
4137
  "inheritedFrom": {
4250
- "name": "Popover",
4251
- "module": "components/popover/popover.component.js"
4138
+ "name": "FocusTrapMixin",
4139
+ "module": "utils/mixins/FocusTrapMixin.js"
4252
4140
  }
4253
4141
  },
4254
4142
  {
4255
4143
  "kind": "method",
4256
- "name": "removeEventListeners",
4144
+ "name": "isInteractiveElement",
4257
4145
  "privacy": "private",
4258
- "description": "Removes the trigger event listeners.",
4146
+ "return": {
4147
+ "type": {
4148
+ "text": ""
4149
+ }
4150
+ },
4151
+ "parameters": [
4152
+ {
4153
+ "name": "element",
4154
+ "type": {
4155
+ "text": "HTMLElement"
4156
+ },
4157
+ "description": "The element to check."
4158
+ }
4159
+ ],
4160
+ "description": "Checks if the element is interactive.",
4259
4161
  "inheritedFrom": {
4260
- "name": "Popover",
4261
- "module": "components/popover/popover.component.js"
4162
+ "name": "FocusTrapMixin",
4163
+ "module": "utils/mixins/FocusTrapMixin.js"
4262
4164
  }
4263
4165
  },
4264
4166
  {
4265
- "kind": "field",
4266
- "name": "onOutsidePopoverClick",
4167
+ "kind": "method",
4168
+ "name": "isFocusable",
4267
4169
  "privacy": "private",
4268
- "description": "Handles the outside click event to close the popover.",
4269
4170
  "parameters": [
4270
4171
  {
4271
- "description": "The mouse event.",
4272
- "name": "event"
4172
+ "name": "element",
4173
+ "type": {
4174
+ "text": "HTMLElement"
4175
+ },
4176
+ "description": "The element to check."
4273
4177
  }
4274
4178
  ],
4179
+ "description": "Checks if the element is focusable.",
4180
+ "return": {
4181
+ "type": {
4182
+ "text": ""
4183
+ }
4184
+ },
4275
4185
  "inheritedFrom": {
4276
- "name": "Popover",
4277
- "module": "components/popover/popover.component.js"
4186
+ "name": "FocusTrapMixin",
4187
+ "module": "utils/mixins/FocusTrapMixin.js"
4278
4188
  }
4279
4189
  },
4280
4190
  {
4281
- "kind": "field",
4282
- "name": "onEscapeKeydown",
4191
+ "kind": "method",
4192
+ "name": "findFocusable",
4283
4193
  "privacy": "private",
4284
- "description": "Handles the escape keydown event to close the popover.",
4194
+ "return": {
4195
+ "type": {
4196
+ "text": ""
4197
+ }
4198
+ },
4285
4199
  "parameters": [
4286
4200
  {
4287
- "description": "The keyboard event.",
4288
- "name": "event"
4201
+ "name": "root",
4202
+ "type": {
4203
+ "text": "ShadowRoot | HTMLElement"
4204
+ },
4205
+ "description": "The root element to search for focusable elements."
4206
+ },
4207
+ {
4208
+ "name": "matches",
4209
+ "default": "new Set()",
4210
+ "type": {
4211
+ "text": "Set<HTMLElement>"
4212
+ },
4213
+ "description": "The set of focusable elements."
4289
4214
  }
4290
4215
  ],
4216
+ "description": "Recursively finds all focusable elements within the given root and its descendants.",
4217
+ "inheritedFrom": {
4218
+ "name": "FocusTrapMixin",
4219
+ "module": "utils/mixins/FocusTrapMixin.js"
4220
+ }
4221
+ },
4222
+ {
4223
+ "kind": "method",
4224
+ "name": "setFocusableElements",
4225
+ "privacy": "public",
4226
+ "description": "Updates the list of focusable elements within the component's shadow root.",
4291
4227
  "inheritedFrom": {
4292
- "name": "Popover",
4293
- "module": "components/popover/popover.component.js"
4228
+ "name": "FocusTrapMixin",
4229
+ "module": "utils/mixins/FocusTrapMixin.js"
4294
4230
  }
4295
4231
  },
4296
4232
  {
4297
- "kind": "field",
4298
- "name": "onPopoverFocusOut",
4299
- "privacy": "private",
4300
- "description": "Handles the popover focus out event.",
4233
+ "kind": "method",
4234
+ "name": "setInitialFocus",
4235
+ "privacy": "public",
4301
4236
  "parameters": [
4302
4237
  {
4303
- "description": "The focus event.",
4304
- "name": "event"
4238
+ "name": "prefferableElement",
4239
+ "default": "0",
4240
+ "type": {
4241
+ "text": "number"
4242
+ },
4243
+ "description": "The index of the prefferable element to focus."
4305
4244
  }
4306
4245
  ],
4246
+ "description": "Sets the initial focus within the container.",
4307
4247
  "inheritedFrom": {
4308
- "name": "Popover",
4309
- "module": "components/popover/popover.component.js"
4248
+ "name": "FocusTrapMixin",
4249
+ "module": "utils/mixins/FocusTrapMixin.js"
4310
4250
  }
4311
4251
  },
4312
4252
  {
4313
4253
  "kind": "method",
4314
- "name": "isOpenUpdated",
4254
+ "name": "calculateNextIndex",
4315
4255
  "privacy": "private",
4316
4256
  "parameters": [
4317
4257
  {
4318
- "name": "oldValue",
4258
+ "name": "currentIndex",
4319
4259
  "type": {
4320
- "text": "boolean"
4260
+ "text": "number"
4321
4261
  },
4322
- "description": "The old value of the visible property."
4262
+ "description": "The current index."
4323
4263
  },
4324
4264
  {
4325
- "name": "newValue",
4265
+ "name": "step",
4326
4266
  "type": {
4327
- "text": "boolean"
4267
+ "text": "number"
4328
4268
  },
4329
- "description": "The new value of the visible property."
4269
+ "description": "The step to calculate the next index."
4330
4270
  }
4331
4271
  ],
4332
- "description": "Handles the popover visibility change and position the popover.\nHandles the exit event to close the popover.",
4333
- "inheritedFrom": {
4334
- "name": "Popover",
4335
- "module": "components/popover/popover.component.js"
4336
- }
4337
- },
4338
- {
4339
- "kind": "field",
4340
- "name": "startCloseDelay",
4341
- "privacy": "private",
4342
- "description": "Starts the close delay timer.\nIf the popover is not interactive, it will close the popover after the delay.",
4343
- "inheritedFrom": {
4344
- "name": "Popover",
4345
- "module": "components/popover/popover.component.js"
4346
- }
4347
- },
4348
- {
4349
- "kind": "field",
4350
- "name": "cancelCloseDelay",
4351
- "privacy": "private",
4352
- "description": "Cancels the close delay timer.",
4353
- "inheritedFrom": {
4354
- "name": "Popover",
4355
- "module": "components/popover/popover.component.js"
4356
- }
4357
- },
4358
- {
4359
- "kind": "field",
4360
- "name": "showPopover",
4361
- "privacy": "public",
4362
- "description": "Shows the popover.",
4363
- "inheritedFrom": {
4364
- "name": "Popover",
4365
- "module": "components/popover/popover.component.js"
4366
- }
4367
- },
4368
- {
4369
- "kind": "field",
4370
- "name": "hidePopover",
4371
- "privacy": "public",
4372
- "description": "Hides the popover.",
4373
- "inheritedFrom": {
4374
- "name": "Popover",
4375
- "module": "components/popover/popover.component.js"
4376
- }
4377
- },
4378
- {
4379
- "kind": "field",
4380
- "name": "togglePopoverVisible",
4381
- "privacy": "public",
4382
- "description": "Toggles the popover visibility.",
4272
+ "description": "Calculates the next index for the focus trap.",
4273
+ "return": {
4274
+ "type": {
4275
+ "text": ""
4276
+ }
4277
+ },
4383
4278
  "inheritedFrom": {
4384
- "name": "Popover",
4385
- "module": "components/popover/popover.component.js"
4279
+ "name": "FocusTrapMixin",
4280
+ "module": "utils/mixins/FocusTrapMixin.js"
4386
4281
  }
4387
4282
  },
4388
4283
  {
4389
4284
  "kind": "method",
4390
- "name": "handleCreatePopoverFirstUpdate",
4285
+ "name": "getDeepActiveElement",
4391
4286
  "privacy": "private",
4392
- "description": "Sets the focusable elements inside the popover.",
4287
+ "description": "Returns the deepest active element in the shadow DOM.",
4288
+ "return": {
4289
+ "type": {
4290
+ "text": ""
4291
+ }
4292
+ },
4393
4293
  "inheritedFrom": {
4394
- "name": "Popover",
4395
- "module": "components/popover/popover.component.js"
4294
+ "name": "FocusTrapMixin",
4295
+ "module": "utils/mixins/FocusTrapMixin.js"
4396
4296
  }
4397
4297
  },
4398
4298
  {
4399
4299
  "kind": "method",
4400
- "name": "positionPopover",
4300
+ "name": "findElement",
4401
4301
  "privacy": "private",
4402
- "description": "Positions the popover based on the trigger element.\nIt also handles the flip, size and arrow placement.\nIt uses the floating-ui/dom library to calculate the position.",
4403
- "inheritedFrom": {
4404
- "name": "Popover",
4405
- "module": "components/popover/popover.component.js"
4406
- }
4407
- },
4408
- {
4409
- "kind": "field",
4410
- "name": "utils",
4411
- "default": "new PopoverUtils(this)",
4412
- "inheritedFrom": {
4413
- "name": "Popover",
4414
- "module": "components/popover/popover.component.js"
4415
- }
4416
- }
4417
- ],
4418
- "attributes": [
4419
- {
4420
- "name": "trigger",
4421
- "type": {
4422
- "text": "PopoverTrigger"
4423
- },
4424
- "description": "Determines the events that cause the Coachmark to show.\nMultiple event names should be separated by spaces.\nFor example to allow both click and hover, use 'click mouseenter' as the trigger.\n- **click**\n- **mouseenter**\n- **focusin**\n- **manual**",
4425
- "default": "manual",
4426
- "fieldName": "trigger",
4427
- "inheritedFrom": {
4428
- "name": "Popover",
4429
- "module": "src/components/popover/popover.component.ts"
4430
- }
4431
- },
4432
- {
4433
- "name": "show-arrow",
4434
- "type": {
4435
- "text": "boolean"
4436
- },
4437
- "description": "The arrow visibility of the Coachmark.",
4438
- "default": "true",
4439
- "fieldName": "showArrow",
4440
- "inheritedFrom": {
4441
- "name": "Popover",
4442
- "module": "src/components/popover/popover.component.ts"
4443
- }
4444
- },
4445
- {
4446
- "name": "close-button",
4447
- "type": {
4448
- "text": "boolean"
4302
+ "parameters": [
4303
+ {
4304
+ "name": "activeElement",
4305
+ "type": {
4306
+ "text": "HTMLElement"
4307
+ },
4308
+ "description": "The active element."
4309
+ }
4310
+ ],
4311
+ "description": "Finds the index of the active element within the focusable elements.",
4312
+ "return": {
4313
+ "type": {
4314
+ "text": ""
4315
+ }
4449
4316
  },
4450
- "description": "The close button visibility of the Coachmark.",
4451
- "default": "true",
4452
- "fieldName": "closeButton",
4453
4317
  "inheritedFrom": {
4454
- "name": "Popover",
4455
- "module": "src/components/popover/popover.component.ts"
4318
+ "name": "FocusTrapMixin",
4319
+ "module": "utils/mixins/FocusTrapMixin.js"
4456
4320
  }
4457
4321
  },
4458
4322
  {
4459
- "name": "disable-aria-expanded",
4460
- "type": {
4461
- "text": "boolean"
4323
+ "kind": "method",
4324
+ "name": "isEqualFocusNode",
4325
+ "privacy": "private",
4326
+ "parameters": [
4327
+ {
4328
+ "name": "activeElement",
4329
+ "type": {
4330
+ "text": "HTMLElement"
4331
+ },
4332
+ "description": "The active element."
4333
+ },
4334
+ {
4335
+ "name": "element",
4336
+ "type": {
4337
+ "text": "HTMLElement"
4338
+ },
4339
+ "description": "The element to compare."
4340
+ }
4341
+ ],
4342
+ "description": "Checks if the active element is equal to the given element.",
4343
+ "return": {
4344
+ "type": {
4345
+ "text": ""
4346
+ }
4462
4347
  },
4463
- "description": "Disable aria-expanded attribute on trigger element.",
4464
- "default": "true",
4465
- "fieldName": "disableAriaExpanded",
4466
4348
  "inheritedFrom": {
4467
- "name": "Popover",
4468
- "module": "src/components/popover/popover.component.ts"
4349
+ "name": "FocusTrapMixin",
4350
+ "module": "utils/mixins/FocusTrapMixin.js"
4469
4351
  }
4470
4352
  },
4471
4353
  {
4472
- "name": "enabledFocusTrap",
4473
- "type": {
4474
- "text": "boolean"
4475
- },
4476
- "description": "Determines whether the focus trap is enabled.\nIf true, focus will be restricted to the content within this component.",
4477
- "default": "false",
4478
- "fieldName": "enabledFocusTrap",
4354
+ "kind": "method",
4355
+ "name": "trapFocus",
4356
+ "privacy": "private",
4357
+ "parameters": [
4358
+ {
4359
+ "name": "direction",
4360
+ "type": {
4361
+ "text": "boolean"
4362
+ },
4363
+ "description": "The direction of the focus trap.\nIf true, the focus will be trapped in the previous element."
4364
+ }
4365
+ ],
4366
+ "description": "Traps focus within the container.",
4479
4367
  "inheritedFrom": {
4480
4368
  "name": "FocusTrapMixin",
4481
- "module": "src/utils/mixins/FocusTrapMixin.ts"
4369
+ "module": "utils/mixins/FocusTrapMixin.js"
4482
4370
  }
4483
4371
  },
4484
4372
  {
4485
- "name": "enabledPreventScroll",
4486
- "type": {
4487
- "text": "boolean"
4488
- },
4489
- "description": "Prevent outside scrolling when popover show.",
4490
- "default": "false",
4491
- "fieldName": "enabledPreventScroll",
4373
+ "kind": "method",
4374
+ "name": "handleKeydown",
4375
+ "privacy": "private",
4376
+ "parameters": [
4377
+ {
4378
+ "name": "event",
4379
+ "type": {
4380
+ "text": "KeyboardEvent"
4381
+ },
4382
+ "description": "The keyboard event."
4383
+ }
4384
+ ],
4385
+ "description": "Traps focus within the container.",
4492
4386
  "inheritedFrom": {
4493
4387
  "name": "FocusTrapMixin",
4494
- "module": "src/utils/mixins/FocusTrapMixin.ts"
4388
+ "module": "utils/mixins/FocusTrapMixin.js"
4495
4389
  }
4496
4390
  },
4497
4391
  {
4392
+ "kind": "field",
4498
4393
  "name": "id",
4499
4394
  "type": {
4500
4395
  "text": "string"
4501
4396
  },
4502
4397
  "default": "''",
4503
4398
  "description": "The unique ID of the popover.",
4504
- "fieldName": "id",
4399
+ "attribute": "id",
4400
+ "reflects": true,
4505
4401
  "inheritedFrom": {
4506
4402
  "name": "Popover",
4507
- "module": "src/components/popover/popover.component.ts"
4403
+ "module": "components/popover/popover.component.js"
4508
4404
  }
4509
4405
  },
4510
4406
  {
4407
+ "kind": "field",
4511
4408
  "name": "triggerID",
4512
4409
  "type": {
4513
4410
  "text": "string"
4514
4411
  },
4515
4412
  "default": "''",
4516
4413
  "description": "The ID of the element that triggers the popover.\nThis attribute is required for the popover to work.",
4517
- "fieldName": "triggerID",
4414
+ "attribute": "triggerID",
4415
+ "reflects": true,
4518
4416
  "inheritedFrom": {
4519
4417
  "name": "Popover",
4520
- "module": "src/components/popover/popover.component.ts"
4418
+ "module": "components/popover/popover.component.js"
4521
4419
  }
4522
4420
  },
4523
4421
  {
4422
+ "kind": "field",
4524
4423
  "name": "placement",
4525
4424
  "type": {
4526
4425
  "text": "PopoverPlacement"
4527
4426
  },
4528
4427
  "description": "The placement of the popover.\n- **top**\n- **top-start**\n- **top-end**\n- **bottom**\n- **bottom-start**\n- **bottom-end**\n- **left**\n- **left-start**\n- **left-end**\n- **right**\n- **right-start**\n- **right-end**",
4529
4428
  "default": "bottom",
4530
- "fieldName": "placement",
4531
- "inheritedFrom": {
4532
- "name": "Popover",
4533
- "module": "src/components/popover/popover.component.ts"
4534
- }
4535
- },
4536
- {
4537
- "name": "color",
4538
- "type": {
4539
- "text": "PopoverColor"
4540
- },
4541
- "description": "Color of the popover\n- **tonal**\n- **contrast**",
4542
- "default": "tonal",
4543
- "fieldName": "color",
4429
+ "attribute": "placement",
4430
+ "reflects": true,
4544
4431
  "inheritedFrom": {
4545
4432
  "name": "Popover",
4546
- "module": "src/components/popover/popover.component.ts"
4433
+ "module": "components/popover/popover.component.js"
4547
4434
  }
4548
4435
  },
4549
4436
  {
4437
+ "kind": "field",
4550
4438
  "name": "visible",
4551
4439
  "type": {
4552
4440
  "text": "boolean"
4553
4441
  },
4554
4442
  "description": "The visibility of the popover.",
4555
4443
  "default": "false",
4556
- "fieldName": "visible",
4444
+ "attribute": "visible",
4445
+ "reflects": true,
4557
4446
  "inheritedFrom": {
4558
4447
  "name": "Popover",
4559
- "module": "src/components/popover/popover.component.ts"
4448
+ "module": "components/popover/popover.component.js"
4560
4449
  }
4561
4450
  },
4562
4451
  {
4452
+ "kind": "field",
4563
4453
  "name": "offset",
4564
4454
  "type": {
4565
4455
  "text": "number"
4566
4456
  },
4567
4457
  "description": "The offset of the popover.",
4568
4458
  "default": "4",
4569
- "fieldName": "offset",
4459
+ "attribute": "offset",
4460
+ "reflects": true,
4570
4461
  "inheritedFrom": {
4571
4462
  "name": "Popover",
4572
- "module": "src/components/popover/popover.component.ts"
4463
+ "module": "components/popover/popover.component.js"
4573
4464
  }
4574
4465
  },
4575
4466
  {
4576
- "name": "focus-trap",
4467
+ "kind": "field",
4468
+ "name": "focusTrap",
4577
4469
  "type": {
4578
4470
  "text": "boolean"
4579
4471
  },
4580
4472
  "description": "Determines whether the focus trap is enabled.\nIf true, focus will be restricted to the content within this component.",
4581
4473
  "default": "false",
4582
- "fieldName": "focusTrap",
4474
+ "attribute": "focus-trap",
4475
+ "reflects": true,
4583
4476
  "inheritedFrom": {
4584
4477
  "name": "Popover",
4585
- "module": "src/components/popover/popover.component.ts"
4478
+ "module": "components/popover/popover.component.js"
4586
4479
  }
4587
4480
  },
4588
4481
  {
4589
- "name": "prevent-scroll",
4482
+ "kind": "field",
4483
+ "name": "preventScroll",
4590
4484
  "type": {
4591
4485
  "text": "boolean"
4592
4486
  },
4593
4487
  "description": "Prevent outside scrolling when popover show.",
4594
4488
  "default": "false",
4595
- "fieldName": "preventScroll",
4489
+ "attribute": "prevent-scroll",
4490
+ "reflects": true,
4596
4491
  "inheritedFrom": {
4597
4492
  "name": "Popover",
4598
- "module": "src/components/popover/popover.component.ts"
4493
+ "module": "components/popover/popover.component.js"
4599
4494
  }
4600
4495
  },
4601
4496
  {
4497
+ "kind": "field",
4602
4498
  "name": "interactive",
4603
4499
  "type": {
4604
4500
  "text": "boolean"
4605
4501
  },
4606
4502
  "description": "Determines whether the popover is interactive。",
4607
4503
  "default": "false",
4608
- "fieldName": "interactive",
4504
+ "attribute": "interactive",
4505
+ "reflects": true,
4609
4506
  "inheritedFrom": {
4610
4507
  "name": "Popover",
4611
- "module": "src/components/popover/popover.component.ts"
4508
+ "module": "components/popover/popover.component.js"
4612
4509
  }
4613
4510
  },
4614
4511
  {
4512
+ "kind": "field",
4615
4513
  "name": "delay",
4616
4514
  "type": {
4617
4515
  "text": "string"
4618
4516
  },
4619
4517
  "description": "The delay of the show/hide popover.",
4620
4518
  "default": "0,0",
4621
- "fieldName": "delay",
4519
+ "attribute": "delay",
4520
+ "reflects": true,
4622
4521
  "inheritedFrom": {
4623
4522
  "name": "Popover",
4624
- "module": "src/components/popover/popover.component.ts"
4523
+ "module": "components/popover/popover.component.js"
4625
4524
  }
4626
4525
  },
4627
4526
  {
4628
- "name": "hide-on-escape",
4527
+ "kind": "field",
4528
+ "name": "hideOnEscape",
4629
4529
  "type": {
4630
4530
  "text": "boolean"
4631
4531
  },
4632
4532
  "description": "Hide popover on escape key press.",
4633
4533
  "default": "false",
4634
- "fieldName": "hideOnEscape",
4534
+ "attribute": "hide-on-escape",
4535
+ "reflects": true,
4635
4536
  "inheritedFrom": {
4636
4537
  "name": "Popover",
4637
- "module": "src/components/popover/popover.component.ts"
4538
+ "module": "components/popover/popover.component.js"
4638
4539
  }
4639
4540
  },
4640
4541
  {
4641
- "name": "hide-on-blur",
4542
+ "kind": "field",
4543
+ "name": "hideOnBlur",
4642
4544
  "type": {
4643
4545
  "text": "boolean"
4644
4546
  },
4645
4547
  "description": "Hide popover on blur.",
4646
4548
  "default": "false",
4647
- "fieldName": "hideOnBlur",
4549
+ "attribute": "hide-on-blur",
4550
+ "reflects": true,
4648
4551
  "inheritedFrom": {
4649
4552
  "name": "Popover",
4650
- "module": "src/components/popover/popover.component.ts"
4553
+ "module": "components/popover/popover.component.js"
4651
4554
  }
4652
4555
  },
4653
4556
  {
4654
- "name": "hide-on-outside-click",
4557
+ "kind": "field",
4558
+ "name": "hideOnOutsideClick",
4655
4559
  "type": {
4656
4560
  "text": "boolean"
4657
4561
  },
4658
4562
  "description": "Hide on outside click of the popover.",
4659
4563
  "default": "false",
4660
- "fieldName": "hideOnOutsideClick",
4564
+ "attribute": "hide-on-outside-click",
4565
+ "reflects": true,
4661
4566
  "inheritedFrom": {
4662
4567
  "name": "Popover",
4663
- "module": "src/components/popover/popover.component.ts"
4568
+ "module": "components/popover/popover.component.js"
4664
4569
  }
4665
4570
  },
4666
4571
  {
4667
- "name": "focus-back-to-trigger",
4572
+ "kind": "field",
4573
+ "name": "focusBackToTrigger",
4668
4574
  "type": {
4669
4575
  "text": "boolean"
4670
4576
  },
4671
4577
  "description": "The focus back to trigger after the popover hide.",
4672
4578
  "default": "false",
4673
- "fieldName": "focusBackToTrigger",
4579
+ "attribute": "focus-back-to-trigger",
4580
+ "reflects": true,
4674
4581
  "inheritedFrom": {
4675
4582
  "name": "Popover",
4676
- "module": "src/components/popover/popover.component.ts"
4583
+ "module": "components/popover/popover.component.js"
4677
4584
  }
4678
4585
  },
4679
4586
  {
4587
+ "kind": "field",
4680
4588
  "name": "backdrop",
4681
4589
  "type": {
4682
4590
  "text": "boolean"
4683
4591
  },
4684
4592
  "description": "Determines whether the popover with backdrop.\nOther than popover and trigger element, the rest of the screen will be covered with a backdrop.",
4685
4593
  "default": "false",
4686
- "fieldName": "backdrop",
4594
+ "attribute": "backdrop",
4595
+ "reflects": true,
4596
+ "inheritedFrom": {
4597
+ "name": "Popover",
4598
+ "module": "components/popover/popover.component.js"
4599
+ }
4600
+ },
4601
+ {
4602
+ "kind": "field",
4603
+ "name": "flip",
4604
+ "type": {
4605
+ "text": "boolean"
4606
+ },
4607
+ "description": "Changes the placement of popover to keep it in view when scrolling.",
4608
+ "default": "true",
4609
+ "attribute": "flip",
4610
+ "reflects": true,
4611
+ "inheritedFrom": {
4612
+ "name": "Popover",
4613
+ "module": "components/popover/popover.component.js"
4614
+ }
4615
+ },
4616
+ {
4617
+ "kind": "field",
4618
+ "name": "size",
4619
+ "type": {
4620
+ "text": "boolean"
4621
+ },
4622
+ "description": "Changes the size of popover to keep it in view when scrolling.",
4623
+ "default": "false",
4624
+ "attribute": "size",
4625
+ "reflects": true,
4626
+ "inheritedFrom": {
4627
+ "name": "Popover",
4628
+ "module": "components/popover/popover.component.js"
4629
+ }
4630
+ },
4631
+ {
4632
+ "kind": "field",
4633
+ "name": "zIndex",
4634
+ "type": {
4635
+ "text": "number"
4636
+ },
4637
+ "description": "The z-index of the popover.",
4638
+ "default": "1000",
4639
+ "attribute": "z-index",
4640
+ "reflects": true,
4641
+ "inheritedFrom": {
4642
+ "name": "Popover",
4643
+ "module": "components/popover/popover.component.js"
4644
+ }
4645
+ },
4646
+ {
4647
+ "kind": "field",
4648
+ "name": "appendTo",
4649
+ "type": {
4650
+ "text": "string"
4651
+ },
4652
+ "default": "''",
4653
+ "description": "Element ID that the popover append to.",
4654
+ "attribute": "append-to",
4655
+ "reflects": true,
4656
+ "inheritedFrom": {
4657
+ "name": "Popover",
4658
+ "module": "components/popover/popover.component.js"
4659
+ }
4660
+ },
4661
+ {
4662
+ "kind": "field",
4663
+ "name": "closeButtonAriaLabel",
4664
+ "type": {
4665
+ "text": "string | null"
4666
+ },
4667
+ "default": "null",
4668
+ "description": "aria-label attribute to be set for close button accessibility.",
4669
+ "attribute": "close-button-aria-label",
4670
+ "inheritedFrom": {
4671
+ "name": "Popover",
4672
+ "module": "components/popover/popover.component.js"
4673
+ }
4674
+ },
4675
+ {
4676
+ "kind": "field",
4677
+ "name": "role",
4678
+ "type": {
4679
+ "text": "HTMLElement['role']"
4680
+ },
4681
+ "description": "Role of the popover",
4682
+ "default": "dialog",
4683
+ "attribute": "role",
4684
+ "reflects": true,
4685
+ "inheritedFrom": {
4686
+ "name": "Popover",
4687
+ "module": "components/popover/popover.component.js"
4688
+ }
4689
+ },
4690
+ {
4691
+ "kind": "field",
4692
+ "name": "ariaLabelledby",
4693
+ "type": {
4694
+ "text": "string | null"
4695
+ },
4696
+ "default": "null",
4697
+ "description": "aria-labelledby for an interactive popover only, defaults to the trigger component id.\nUsed in nested cases where the triggerComponent isn't the actual button.",
4698
+ "attribute": "aria-labelledby",
4699
+ "reflects": true,
4700
+ "inheritedFrom": {
4701
+ "name": "Popover",
4702
+ "module": "components/popover/popover.component.js"
4703
+ }
4704
+ },
4705
+ {
4706
+ "kind": "field",
4707
+ "name": "ariaDescribedby",
4708
+ "type": {
4709
+ "text": "string | null"
4710
+ },
4711
+ "default": "null",
4712
+ "description": "aria-describedby of the popover.",
4713
+ "attribute": "aria-describedby",
4714
+ "reflects": true,
4715
+ "inheritedFrom": {
4716
+ "name": "Popover",
4717
+ "module": "components/popover/popover.component.js"
4718
+ }
4719
+ },
4720
+ {
4721
+ "kind": "field",
4722
+ "name": "arrowElement",
4723
+ "type": {
4724
+ "text": "HTMLElement | null"
4725
+ },
4726
+ "privacy": "public",
4727
+ "default": "null",
4728
+ "inheritedFrom": {
4729
+ "name": "Popover",
4730
+ "module": "components/popover/popover.component.js"
4731
+ }
4732
+ },
4733
+ {
4734
+ "kind": "field",
4735
+ "name": "triggerElement",
4736
+ "type": {
4737
+ "text": "HTMLElement | null"
4738
+ },
4739
+ "privacy": "public",
4740
+ "default": "null",
4687
4741
  "inheritedFrom": {
4688
4742
  "name": "Popover",
4689
- "module": "src/components/popover/popover.component.ts"
4743
+ "module": "components/popover/popover.component.js"
4690
4744
  }
4691
4745
  },
4692
4746
  {
4693
- "name": "flip",
4694
- "type": {
4695
- "text": "boolean"
4696
- },
4697
- "description": "Changes the placement of popover to keep it in view when scrolling.",
4698
- "default": "true",
4699
- "fieldName": "flip",
4747
+ "kind": "method",
4748
+ "name": "setupTriggerListener",
4749
+ "privacy": "private",
4750
+ "description": "Sets up the trigger event listeners based on the trigger type.",
4700
4751
  "inheritedFrom": {
4701
4752
  "name": "Popover",
4702
- "module": "src/components/popover/popover.component.ts"
4753
+ "module": "components/popover/popover.component.js"
4703
4754
  }
4704
4755
  },
4705
4756
  {
4706
- "name": "size",
4707
- "type": {
4708
- "text": "boolean"
4709
- },
4710
- "description": "Changes the size of popover to keep it in view when scrolling.",
4711
- "default": "false",
4712
- "fieldName": "size",
4757
+ "kind": "method",
4758
+ "name": "removeEventListeners",
4759
+ "privacy": "private",
4760
+ "description": "Removes the trigger event listeners.",
4713
4761
  "inheritedFrom": {
4714
4762
  "name": "Popover",
4715
- "module": "src/components/popover/popover.component.ts"
4763
+ "module": "components/popover/popover.component.js"
4716
4764
  }
4717
4765
  },
4718
4766
  {
4719
- "name": "z-index",
4720
- "type": {
4721
- "text": "number"
4722
- },
4723
- "description": "The z-index of the popover.",
4724
- "default": "1000",
4725
- "fieldName": "zIndex",
4767
+ "kind": "field",
4768
+ "name": "onOutsidePopoverClick",
4769
+ "privacy": "private",
4770
+ "description": "Handles the outside click event to close the popover.",
4771
+ "parameters": [
4772
+ {
4773
+ "description": "The mouse event.",
4774
+ "name": "event"
4775
+ }
4776
+ ],
4726
4777
  "inheritedFrom": {
4727
4778
  "name": "Popover",
4728
- "module": "src/components/popover/popover.component.ts"
4779
+ "module": "components/popover/popover.component.js"
4729
4780
  }
4730
4781
  },
4731
4782
  {
4732
- "name": "append-to",
4733
- "type": {
4734
- "text": "string"
4735
- },
4736
- "default": "''",
4737
- "description": "Element ID that the popover append to.",
4738
- "fieldName": "appendTo",
4783
+ "kind": "field",
4784
+ "name": "onEscapeKeydown",
4785
+ "privacy": "private",
4786
+ "description": "Handles the escape keydown event to close the popover.",
4787
+ "parameters": [
4788
+ {
4789
+ "description": "The keyboard event.",
4790
+ "name": "event"
4791
+ }
4792
+ ],
4739
4793
  "inheritedFrom": {
4740
4794
  "name": "Popover",
4741
- "module": "src/components/popover/popover.component.ts"
4795
+ "module": "components/popover/popover.component.js"
4742
4796
  }
4743
4797
  },
4744
4798
  {
4745
- "name": "close-button-aria-label",
4746
- "type": {
4747
- "text": "string | null"
4748
- },
4749
- "default": "null",
4750
- "description": "aria-label attribute to be set for close button accessibility.",
4751
- "fieldName": "closeButtonAriaLabel",
4799
+ "kind": "field",
4800
+ "name": "onPopoverFocusOut",
4801
+ "privacy": "private",
4802
+ "description": "Handles the popover focus out event.",
4803
+ "parameters": [
4804
+ {
4805
+ "description": "The focus event.",
4806
+ "name": "event"
4807
+ }
4808
+ ],
4752
4809
  "inheritedFrom": {
4753
4810
  "name": "Popover",
4754
- "module": "src/components/popover/popover.component.ts"
4811
+ "module": "components/popover/popover.component.js"
4755
4812
  }
4756
4813
  },
4757
4814
  {
4758
- "name": "role",
4759
- "type": {
4760
- "text": "HTMLElement['role']"
4761
- },
4762
- "description": "Role of the popover",
4763
- "default": "dialog",
4764
- "fieldName": "role",
4815
+ "kind": "method",
4816
+ "name": "isOpenUpdated",
4817
+ "privacy": "private",
4818
+ "parameters": [
4819
+ {
4820
+ "name": "oldValue",
4821
+ "type": {
4822
+ "text": "boolean"
4823
+ },
4824
+ "description": "The old value of the visible property."
4825
+ },
4826
+ {
4827
+ "name": "newValue",
4828
+ "type": {
4829
+ "text": "boolean"
4830
+ },
4831
+ "description": "The new value of the visible property."
4832
+ }
4833
+ ],
4834
+ "description": "Handles the popover visibility change and position the popover.\nHandles the exit event to close the popover.",
4765
4835
  "inheritedFrom": {
4766
4836
  "name": "Popover",
4767
- "module": "src/components/popover/popover.component.ts"
4837
+ "module": "components/popover/popover.component.js"
4768
4838
  }
4769
4839
  },
4770
4840
  {
4771
- "name": "aria-labelledby",
4772
- "type": {
4773
- "text": "string | null"
4774
- },
4775
- "default": "null",
4776
- "description": "aria-labelledby for an interactive popover only, defaults to the trigger component id.\nUsed in nested cases where the triggerComponent isn't the actual button.",
4777
- "fieldName": "ariaLabelledby",
4841
+ "kind": "field",
4842
+ "name": "startCloseDelay",
4843
+ "privacy": "private",
4844
+ "description": "Starts the close delay timer.\nIf the popover is not interactive, it will close the popover after the delay.",
4778
4845
  "inheritedFrom": {
4779
4846
  "name": "Popover",
4780
- "module": "src/components/popover/popover.component.ts"
4847
+ "module": "components/popover/popover.component.js"
4781
4848
  }
4782
4849
  },
4783
4850
  {
4784
- "name": "aria-describedby",
4785
- "type": {
4786
- "text": "string | null"
4787
- },
4788
- "default": "null",
4789
- "description": "aria-describedby of the popover.",
4790
- "fieldName": "ariaDescribedby",
4851
+ "kind": "field",
4852
+ "name": "cancelCloseDelay",
4853
+ "privacy": "private",
4854
+ "description": "Cancels the close delay timer.",
4791
4855
  "inheritedFrom": {
4792
4856
  "name": "Popover",
4793
- "module": "src/components/popover/popover.component.ts"
4857
+ "module": "components/popover/popover.component.js"
4794
4858
  }
4795
- }
4796
- ],
4797
- "superclass": {
4798
- "name": "Popover",
4799
- "module": "/src/components/popover/popover.component"
4800
- },
4801
- "tagName": "mdc-coachmark",
4802
- "jsDoc": "/**\n * Coachmark component based on top of the popover component,\n * with the default value of certain properties changed.\n *\n * @dependency mdc-popover\n *\n * @tagname mdc-coachmark\n *\n * @cssproperty --mdc-popover-arrow-border-radius - radius of the arrow border\n * @cssproperty --mdc-popover-arrow-border - border of the arrow\n * @cssproperty --mdc-popover-primary-background-color - primary background color of the popover\n * @cssproperty --mdc-popover-border-color - border color of the popover\n * @cssproperty --mdc-popover-inverted-background-color - inverted background color of the popover\n * @cssproperty --mdc-popover-inverted-border-color - inverted border color of the popover\n * @cssproperty --mdc-popover-inverted-text-color - inverted text color of the popover\n * @cssproperty --mdc-popover-elevation-3 - elevation of the popover\n *\n * @slot - Default slot for modal container\n *\n */",
4803
- "customElement": true
4804
- }
4805
- ],
4806
- "exports": [
4807
- {
4808
- "kind": "js",
4809
- "name": "default",
4810
- "declaration": {
4811
- "name": "Coachmark",
4812
- "module": "components/coachmark/coachmark.component.js"
4813
- }
4814
- }
4815
- ]
4816
- },
4817
- {
4818
- "kind": "javascript-module",
4819
- "path": "components/chip/chip.component.js",
4820
- "declarations": [
4821
- {
4822
- "kind": "class",
4823
- "description": "mdc-chip is an interactive element that can be used to represent a chip. It supports a leading icon along with label.\nConsumers can wrap this component around a tooltip to provide additional context.\n\nIt is recommended to keep the label text for the chip component concise and compact.\nFor best results, we recommend limiting the <b>maximum length of the label text to 20 characters</b>,\nincluding empty spaces to split words.\n\nThis component is built by extending Buttonsimple.",
4824
- "name": "Chip",
4825
- "cssProperties": [
4826
- {
4827
- "description": "The color of the chip.",
4828
- "name": "--mdc-chip-color"
4829
4859
  },
4830
4860
  {
4831
- "description": "The border color of the chip.",
4832
- "name": "--mdc-chip-border-color"
4861
+ "kind": "field",
4862
+ "name": "showPopover",
4863
+ "privacy": "public",
4864
+ "description": "Shows the popover.",
4865
+ "inheritedFrom": {
4866
+ "name": "Popover",
4867
+ "module": "components/popover/popover.component.js"
4868
+ }
4833
4869
  },
4834
- {
4835
- "description": "The background color of the chip.",
4836
- "name": "--mdc-chip-background-color"
4837
- }
4838
- ],
4839
- "members": [
4840
4870
  {
4841
4871
  "kind": "field",
4842
- "name": "color",
4843
- "type": {
4844
- "text": "ColorType"
4845
- },
4846
- "description": "The color of the chip. It supports the following colors\n- default\n- cobalt\n- gold\n- lime\n- mint\n- pink\n- purple\n- slate\n- violet",
4847
- "default": "default",
4848
- "attribute": "color",
4849
- "reflects": true
4872
+ "name": "hidePopover",
4873
+ "privacy": "public",
4874
+ "description": "Hides the popover.",
4875
+ "inheritedFrom": {
4876
+ "name": "Popover",
4877
+ "module": "components/popover/popover.component.js"
4878
+ }
4850
4879
  },
4851
4880
  {
4852
4881
  "kind": "field",
4853
- "name": "label",
4854
- "type": {
4855
- "text": "string"
4856
- },
4857
- "default": "''",
4858
- "description": "The visible label text of the chip.\n\nWe recommend limiting the <b>maximum length of the label text to 20 characters</b>,\nincluding empty spaces to split words.",
4859
- "attribute": "label"
4882
+ "name": "togglePopoverVisible",
4883
+ "privacy": "public",
4884
+ "description": "Toggles the popover visibility.",
4885
+ "inheritedFrom": {
4886
+ "name": "Popover",
4887
+ "module": "components/popover/popover.component.js"
4888
+ }
4860
4889
  },
4861
4890
  {
4862
4891
  "kind": "method",
4863
- "name": "renderIcon",
4892
+ "name": "handleCreatePopoverFirstUpdate",
4864
4893
  "privacy": "private",
4865
- "description": "Renders the icon element if available.",
4866
- "return": {
4867
- "type": {
4868
- "text": ""
4869
- }
4870
- }
4871
- },
4872
- {
4873
- "kind": "field",
4874
- "name": "role",
4875
- "description": "This property defines the ARIA role for the element. By default, it is set to 'button'.\nConsumers should override this role when:\n- The element is being used in a context where a different role is more appropriate.\n- Custom behaviors are implemented that require a specific ARIA role for accessibility purposes.",
4876
- "default": "button",
4877
- "attribute": "role",
4878
- "reflects": true,
4894
+ "description": "Sets the focusable elements inside the popover.",
4879
4895
  "inheritedFrom": {
4880
- "name": "Buttonsimple",
4881
- "module": "components/buttonsimple/buttonsimple.component.js"
4896
+ "name": "Popover",
4897
+ "module": "components/popover/popover.component.js"
4882
4898
  }
4883
4899
  },
4884
4900
  {
4885
- "kind": "field",
4886
- "name": "size",
4887
- "type": {
4888
- "text": "ButtonSize"
4889
- },
4890
- "description": "Simplebutton size is a super set of all the sizes supported by children components.",
4891
- "default": "32",
4892
- "attribute": "size",
4893
- "reflects": true,
4901
+ "kind": "method",
4902
+ "name": "positionPopover",
4903
+ "privacy": "private",
4904
+ "description": "Positions the popover based on the trigger element.\nIt also handles the flip, size and arrow placement.\nIt uses the floating-ui/dom library to calculate the position.",
4894
4905
  "inheritedFrom": {
4895
- "name": "Buttonsimple",
4896
- "module": "components/buttonsimple/buttonsimple.component.js"
4906
+ "name": "Popover",
4907
+ "module": "components/popover/popover.component.js"
4897
4908
  }
4898
4909
  },
4899
4910
  {
4900
4911
  "kind": "field",
4901
- "name": "active",
4912
+ "name": "utils",
4913
+ "default": "new PopoverUtils(this)",
4914
+ "inheritedFrom": {
4915
+ "name": "Popover",
4916
+ "module": "components/popover/popover.component.js"
4917
+ }
4918
+ }
4919
+ ],
4920
+ "attributes": [
4921
+ {
4922
+ "name": "trigger",
4902
4923
  "type": {
4903
- "text": "boolean"
4924
+ "text": "PopoverTrigger"
4904
4925
  },
4905
- "default": "undefined as unknown",
4906
- "description": "The button's active state indicates whether it is currently toggled on (active) or off (inactive).\nWhen the active state is true, the button is considered to be in an active state, meaning it is toggled on.\nConversely, when the active state is false, the button is in an inactive state, indicating it is toggled off.",
4907
- "attribute": "active",
4908
- "reflects": true,
4926
+ "description": "Determines the events that cause the Coachmark to show.\nMultiple event names should be separated by spaces.\nFor example to allow both click and hover, use 'click mouseenter' as the trigger.\n- **click**\n- **mouseenter**\n- **focusin**\n- **manual**",
4927
+ "default": "manual",
4928
+ "fieldName": "trigger",
4909
4929
  "inheritedFrom": {
4910
- "name": "Buttonsimple",
4911
- "module": "components/buttonsimple/buttonsimple.component.js"
4930
+ "name": "Popover",
4931
+ "module": "src/components/popover/popover.component.ts"
4912
4932
  }
4913
4933
  },
4914
4934
  {
4915
- "kind": "field",
4916
- "name": "softDisabled",
4935
+ "name": "show-arrow",
4917
4936
  "type": {
4918
4937
  "text": "boolean"
4919
4938
  },
4920
- "default": "undefined as unknown",
4921
- "description": "Indicates whether the button is soft disabled.\nWhen set to `true`, the button appears visually disabled but still allows\nfocus, click, and keyboard actions to be passed through.\n\n**Important:** When using soft disabled, consumers must ensure that\nthe button behaves like a disabled button, allowing only focus and\npreventing any interactions (clicks or keyboard actions) from triggering unintended actions.",
4922
- "attribute": "soft-disabled",
4939
+ "description": "The arrow visibility of the Coachmark.",
4940
+ "default": "true",
4941
+ "fieldName": "showArrow",
4923
4942
  "inheritedFrom": {
4924
- "name": "Buttonsimple",
4925
- "module": "components/buttonsimple/buttonsimple.component.js"
4943
+ "name": "Popover",
4944
+ "module": "src/components/popover/popover.component.ts"
4926
4945
  }
4927
4946
  },
4928
4947
  {
4929
- "kind": "field",
4930
- "name": "iconName",
4948
+ "name": "close-button",
4931
4949
  "type": {
4932
- "text": "IconNames | undefined"
4950
+ "text": "boolean"
4933
4951
  },
4934
- "description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
4935
- "attribute": "icon-name",
4952
+ "description": "The close button visibility of the Coachmark.",
4953
+ "default": "true",
4954
+ "fieldName": "closeButton",
4936
4955
  "inheritedFrom": {
4937
- "name": "IconNameMixin",
4938
- "module": "utils/mixins/IconNameMixin.js"
4956
+ "name": "Popover",
4957
+ "module": "src/components/popover/popover.component.ts"
4939
4958
  }
4940
4959
  },
4941
4960
  {
4942
- "kind": "field",
4943
- "name": "tabIndex",
4961
+ "name": "disable-aria-expanded",
4944
4962
  "type": {
4945
- "text": "number"
4963
+ "text": "boolean"
4946
4964
  },
4947
- "default": "0",
4948
- "description": "This property specifies the tab order of the element.",
4949
- "attribute": "tabIndex",
4950
- "reflects": true,
4965
+ "description": "Disable aria-expanded attribute on trigger element.",
4966
+ "default": "true",
4967
+ "fieldName": "disableAriaExpanded",
4951
4968
  "inheritedFrom": {
4952
- "name": "Buttonsimple",
4953
- "module": "components/buttonsimple/buttonsimple.component.js"
4969
+ "name": "Popover",
4970
+ "module": "src/components/popover/popover.component.ts"
4954
4971
  }
4955
4972
  },
4956
4973
  {
4957
- "kind": "field",
4958
- "name": "disabled",
4974
+ "name": "enabledFocusTrap",
4959
4975
  "type": {
4960
4976
  "text": "boolean"
4961
4977
  },
4978
+ "description": "Determines whether the focus trap is enabled.\nIf true, focus will be restricted to the content within this component.",
4962
4979
  "default": "false",
4963
- "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
4964
- "attribute": "disabled",
4965
- "reflects": true,
4980
+ "fieldName": "enabledFocusTrap",
4966
4981
  "inheritedFrom": {
4967
- "name": "Buttonsimple",
4968
- "module": "components/buttonsimple/buttonsimple.component.js"
4982
+ "name": "FocusTrapMixin",
4983
+ "module": "src/utils/mixins/FocusTrapMixin.ts"
4969
4984
  }
4970
4985
  },
4971
4986
  {
4972
- "kind": "field",
4973
- "name": "type",
4987
+ "name": "enabledPreventScroll",
4974
4988
  "type": {
4975
- "text": "ButtonType"
4989
+ "text": "boolean"
4976
4990
  },
4977
- "description": "This property defines the type attribute for the button element.\nThe type attribute specifies the behavior of the button when it is clicked.\n- **submit**: The button submits the form data to the server.\n- **reset**: The button resets the form data to its initial state.\n- **button**: The button does nothing when clicked.",
4978
- "default": "button",
4979
- "attribute": "type",
4980
- "reflects": true,
4991
+ "description": "Prevent outside scrolling when popover show.",
4992
+ "default": "false",
4993
+ "fieldName": "enabledPreventScroll",
4981
4994
  "inheritedFrom": {
4982
- "name": "Buttonsimple",
4983
- "module": "components/buttonsimple/buttonsimple.component.js"
4995
+ "name": "FocusTrapMixin",
4996
+ "module": "src/utils/mixins/FocusTrapMixin.ts"
4984
4997
  }
4985
4998
  },
4986
4999
  {
4987
- "kind": "method",
4988
- "name": "executeAction",
4989
- "privacy": "protected",
5000
+ "name": "id",
5001
+ "type": {
5002
+ "text": "string"
5003
+ },
5004
+ "default": "''",
5005
+ "description": "The unique ID of the popover.",
5006
+ "fieldName": "id",
4990
5007
  "inheritedFrom": {
4991
- "name": "Buttonsimple",
4992
- "module": "components/buttonsimple/buttonsimple.component.js"
5008
+ "name": "Popover",
5009
+ "module": "src/components/popover/popover.component.ts"
4993
5010
  }
4994
5011
  },
4995
5012
  {
4996
- "kind": "method",
4997
- "name": "setActive",
4998
- "privacy": "protected",
4999
- "parameters": [
5000
- {
5001
- "name": "element",
5002
- "type": {
5003
- "text": "HTMLElement"
5004
- },
5005
- "description": "The button element"
5006
- },
5007
- {
5008
- "name": "active",
5009
- "type": {
5010
- "text": "boolean"
5011
- },
5012
- "description": "The active state of the element"
5013
- }
5014
- ],
5015
- "description": "Sets the aria-pressed attribute based on the active state of the button.",
5013
+ "name": "triggerID",
5014
+ "type": {
5015
+ "text": "string"
5016
+ },
5017
+ "default": "''",
5018
+ "description": "The ID of the element that triggers the popover.\nThis attribute is required for the popover to work.",
5019
+ "fieldName": "triggerID",
5016
5020
  "inheritedFrom": {
5017
- "name": "Buttonsimple",
5018
- "module": "components/buttonsimple/buttonsimple.component.js"
5021
+ "name": "Popover",
5022
+ "module": "src/components/popover/popover.component.ts"
5019
5023
  }
5020
5024
  },
5021
5025
  {
5022
- "kind": "method",
5023
- "name": "setSoftDisabled",
5024
- "privacy": "private",
5025
- "parameters": [
5026
- {
5027
- "name": "element",
5028
- "type": {
5029
- "text": "HTMLElement"
5030
- },
5031
- "description": "The button element."
5032
- },
5033
- {
5034
- "name": "softDisabled",
5035
- "type": {
5036
- "text": "boolean"
5037
- },
5038
- "description": "The soft-disabled state."
5039
- }
5040
- ],
5041
- "description": "Sets the soft-disabled attribute for the button.\nWhen soft-disabled, the button looks to be disabled but remains focusable and clickable.\nAlso sets/removes aria-disabled attribute.",
5026
+ "name": "placement",
5027
+ "type": {
5028
+ "text": "PopoverPlacement"
5029
+ },
5030
+ "description": "The placement of the popover.\n- **top**\n- **top-start**\n- **top-end**\n- **bottom**\n- **bottom-start**\n- **bottom-end**\n- **left**\n- **left-start**\n- **left-end**\n- **right**\n- **right-start**\n- **right-end**",
5031
+ "default": "bottom",
5032
+ "fieldName": "placement",
5042
5033
  "inheritedFrom": {
5043
- "name": "Buttonsimple",
5044
- "module": "components/buttonsimple/buttonsimple.component.js"
5034
+ "name": "Popover",
5035
+ "module": "src/components/popover/popover.component.ts"
5045
5036
  }
5046
5037
  },
5047
5038
  {
5048
- "kind": "method",
5049
- "name": "setDisabled",
5050
- "privacy": "private",
5051
- "parameters": [
5052
- {
5053
- "name": "element",
5054
- "type": {
5055
- "text": "HTMLElement"
5056
- },
5057
- "description": "The button element."
5058
- },
5059
- {
5060
- "name": "disabled",
5061
- "type": {
5062
- "text": "boolean"
5063
- },
5064
- "description": "The disabled state."
5065
- }
5066
- ],
5067
- "description": "Sets the disabled attribute for the button.\nWhen disabled, the button is not focusable or clickable, and tabindex is set to -1.\nThe previous tabindex is stored and restored when enabled.\nAlso sets/removes aria-disabled attribute.",
5039
+ "name": "color",
5040
+ "type": {
5041
+ "text": "PopoverColor"
5042
+ },
5043
+ "description": "Color of the popover\n- **tonal**\n- **contrast**",
5044
+ "default": "tonal",
5045
+ "fieldName": "color",
5068
5046
  "inheritedFrom": {
5069
- "name": "Buttonsimple",
5070
- "module": "components/buttonsimple/buttonsimple.component.js"
5047
+ "name": "Popover",
5048
+ "module": "src/components/popover/popover.component.ts"
5071
5049
  }
5072
5050
  },
5073
5051
  {
5074
- "kind": "method",
5075
- "name": "triggerClickEvent",
5076
- "privacy": "private",
5052
+ "name": "visible",
5053
+ "type": {
5054
+ "text": "boolean"
5055
+ },
5056
+ "description": "The visibility of the popover.",
5057
+ "default": "false",
5058
+ "fieldName": "visible",
5077
5059
  "inheritedFrom": {
5078
- "name": "Buttonsimple",
5079
- "module": "components/buttonsimple/buttonsimple.component.js"
5060
+ "name": "Popover",
5061
+ "module": "src/components/popover/popover.component.ts"
5080
5062
  }
5081
5063
  },
5082
5064
  {
5083
- "kind": "method",
5084
- "name": "handleBlur",
5085
- "privacy": "private",
5086
- "description": "In case the button is pressed and the focus is lost while pressing,\nthe pressed class is removed.",
5065
+ "name": "offset",
5066
+ "type": {
5067
+ "text": "number"
5068
+ },
5069
+ "description": "The offset of the popover.",
5070
+ "default": "4",
5071
+ "fieldName": "offset",
5087
5072
  "inheritedFrom": {
5088
- "name": "Buttonsimple",
5089
- "module": "components/buttonsimple/buttonsimple.component.js"
5073
+ "name": "Popover",
5074
+ "module": "src/components/popover/popover.component.ts"
5090
5075
  }
5091
5076
  },
5092
5077
  {
5093
- "kind": "method",
5094
- "name": "handleKeyDown",
5095
- "privacy": "private",
5096
- "parameters": [
5097
- {
5098
- "name": "event",
5099
- "type": {
5100
- "text": "KeyboardEvent"
5101
- },
5102
- "description": "The keyboard event."
5103
- }
5104
- ],
5105
- "description": "Handles the keydown event on the button.\nIf the key is 'Enter' or 'Space', the button is pressed.\nIf the key is 'Enter', the button is pressed. The native HTML button works in the same way.",
5106
- "inheritedFrom": {
5107
- "name": "Buttonsimple",
5108
- "module": "components/buttonsimple/buttonsimple.component.js"
5078
+ "name": "focus-trap",
5079
+ "type": {
5080
+ "text": "boolean"
5081
+ },
5082
+ "description": "Determines whether the focus trap is enabled.\nIf true, focus will be restricted to the content within this component.",
5083
+ "default": "false",
5084
+ "fieldName": "focusTrap",
5085
+ "inheritedFrom": {
5086
+ "name": "Popover",
5087
+ "module": "src/components/popover/popover.component.ts"
5109
5088
  }
5110
5089
  },
5111
5090
  {
5112
- "kind": "method",
5113
- "name": "handleKeyUp",
5114
- "privacy": "private",
5115
- "parameters": [
5116
- {
5117
- "name": "event",
5118
- "type": {
5119
- "text": "KeyboardEvent"
5120
- },
5121
- "description": "The keyboard event."
5122
- }
5123
- ],
5124
- "description": "Handles the keyup event on the button.\nIf the key is 'Enter' or 'Space', the button is clicked.\nIf the key is 'Space', the button is pressed. The native HTML button works in the same way.",
5091
+ "name": "prevent-scroll",
5092
+ "type": {
5093
+ "text": "boolean"
5094
+ },
5095
+ "description": "Prevent outside scrolling when popover show.",
5096
+ "default": "false",
5097
+ "fieldName": "preventScroll",
5125
5098
  "inheritedFrom": {
5126
- "name": "Buttonsimple",
5127
- "module": "components/buttonsimple/buttonsimple.component.js"
5099
+ "name": "Popover",
5100
+ "module": "src/components/popover/popover.component.ts"
5128
5101
  }
5129
- }
5130
- ],
5131
- "attributes": [
5102
+ },
5132
5103
  {
5133
- "name": "color",
5104
+ "name": "interactive",
5134
5105
  "type": {
5135
- "text": "ColorType"
5106
+ "text": "boolean"
5136
5107
  },
5137
- "description": "The color of the chip. It supports the following colors\n- default\n- cobalt\n- gold\n- lime\n- mint\n- pink\n- purple\n- slate\n- violet",
5138
- "default": "default",
5139
- "fieldName": "color"
5108
+ "description": "Determines whether the popover is interactive。",
5109
+ "default": "false",
5110
+ "fieldName": "interactive",
5111
+ "inheritedFrom": {
5112
+ "name": "Popover",
5113
+ "module": "src/components/popover/popover.component.ts"
5114
+ }
5140
5115
  },
5141
5116
  {
5142
- "name": "label",
5117
+ "name": "delay",
5143
5118
  "type": {
5144
5119
  "text": "string"
5145
5120
  },
5146
- "default": "''",
5147
- "description": "The visible label text of the chip.\n\nWe recommend limiting the <b>maximum length of the label text to 20 characters</b>,\nincluding empty spaces to split words.",
5148
- "fieldName": "label"
5121
+ "description": "The delay of the show/hide popover.",
5122
+ "default": "0,0",
5123
+ "fieldName": "delay",
5124
+ "inheritedFrom": {
5125
+ "name": "Popover",
5126
+ "module": "src/components/popover/popover.component.ts"
5127
+ }
5149
5128
  },
5150
5129
  {
5151
- "name": "icon-name",
5130
+ "name": "hide-on-escape",
5152
5131
  "type": {
5153
- "text": "IconNames | undefined"
5132
+ "text": "boolean"
5154
5133
  },
5155
- "description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
5156
- "fieldName": "iconName",
5134
+ "description": "Hide popover on escape key press.",
5135
+ "default": "false",
5136
+ "fieldName": "hideOnEscape",
5157
5137
  "inheritedFrom": {
5158
- "name": "IconNameMixin",
5159
- "module": "src/utils/mixins/IconNameMixin.ts"
5138
+ "name": "Popover",
5139
+ "module": "src/components/popover/popover.component.ts"
5160
5140
  }
5161
5141
  },
5162
5142
  {
5163
- "name": "tabIndex",
5143
+ "name": "hide-on-blur",
5164
5144
  "type": {
5165
- "text": "number"
5145
+ "text": "boolean"
5166
5146
  },
5167
- "default": "0",
5168
- "description": "This property specifies the tab order of the element.",
5169
- "fieldName": "tabIndex",
5147
+ "description": "Hide popover on blur.",
5148
+ "default": "false",
5149
+ "fieldName": "hideOnBlur",
5170
5150
  "inheritedFrom": {
5171
- "name": "Buttonsimple",
5172
- "module": "src/components/buttonsimple/buttonsimple.component.ts"
5151
+ "name": "Popover",
5152
+ "module": "src/components/popover/popover.component.ts"
5173
5153
  }
5174
5154
  },
5175
5155
  {
5176
- "name": "disabled",
5156
+ "name": "hide-on-outside-click",
5177
5157
  "type": {
5178
5158
  "text": "boolean"
5179
5159
  },
5160
+ "description": "Hide on outside click of the popover.",
5180
5161
  "default": "false",
5181
- "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
5182
- "fieldName": "disabled",
5162
+ "fieldName": "hideOnOutsideClick",
5183
5163
  "inheritedFrom": {
5184
- "name": "Buttonsimple",
5185
- "module": "src/components/buttonsimple/buttonsimple.component.ts"
5164
+ "name": "Popover",
5165
+ "module": "src/components/popover/popover.component.ts"
5186
5166
  }
5187
5167
  },
5188
5168
  {
5189
- "name": "active",
5169
+ "name": "focus-back-to-trigger",
5190
5170
  "type": {
5191
5171
  "text": "boolean"
5192
5172
  },
5173
+ "description": "The focus back to trigger after the popover hide.",
5193
5174
  "default": "false",
5194
- "description": "The button's active state indicates whether it is currently toggled on (active) or off (inactive).\nWhen the active state is true, the button is considered to be in an active state, meaning it is toggled on.\nConversely, when the active state is false, the button is in an inactive state, indicating it is toggled off.",
5195
- "fieldName": "active",
5175
+ "fieldName": "focusBackToTrigger",
5196
5176
  "inheritedFrom": {
5197
- "name": "Buttonsimple",
5198
- "module": "src/components/buttonsimple/buttonsimple.component.ts"
5177
+ "name": "Popover",
5178
+ "module": "src/components/popover/popover.component.ts"
5199
5179
  }
5200
5180
  },
5201
5181
  {
5202
- "name": "soft-disabled",
5182
+ "name": "backdrop",
5203
5183
  "type": {
5204
5184
  "text": "boolean"
5205
5185
  },
5186
+ "description": "Determines whether the popover with backdrop.\nOther than popover and trigger element, the rest of the screen will be covered with a backdrop.",
5206
5187
  "default": "false",
5207
- "description": "Indicates whether the button is soft disabled.\nWhen set to `true`, the button appears visually disabled but still allows\nfocus, click, and keyboard actions to be passed through.\n\n**Important:** When using soft disabled, consumers must ensure that\nthe button behaves like a disabled button, allowing only focus and\npreventing any interactions (clicks or keyboard actions) from triggering unintended actions.",
5208
- "fieldName": "softDisabled",
5188
+ "fieldName": "backdrop",
5209
5189
  "inheritedFrom": {
5210
- "name": "Buttonsimple",
5211
- "module": "src/components/buttonsimple/buttonsimple.component.ts"
5190
+ "name": "Popover",
5191
+ "module": "src/components/popover/popover.component.ts"
5192
+ }
5193
+ },
5194
+ {
5195
+ "name": "flip",
5196
+ "type": {
5197
+ "text": "boolean"
5198
+ },
5199
+ "description": "Changes the placement of popover to keep it in view when scrolling.",
5200
+ "default": "true",
5201
+ "fieldName": "flip",
5202
+ "inheritedFrom": {
5203
+ "name": "Popover",
5204
+ "module": "src/components/popover/popover.component.ts"
5212
5205
  }
5213
5206
  },
5214
5207
  {
5215
5208
  "name": "size",
5216
5209
  "type": {
5217
- "text": "ButtonSize"
5210
+ "text": "boolean"
5218
5211
  },
5219
- "description": "Simplebutton size is a super set of all the sizes supported by children components.",
5220
- "default": "32",
5212
+ "description": "Changes the size of popover to keep it in view when scrolling.",
5213
+ "default": "false",
5221
5214
  "fieldName": "size",
5222
5215
  "inheritedFrom": {
5223
- "name": "Buttonsimple",
5224
- "module": "src/components/buttonsimple/buttonsimple.component.ts"
5216
+ "name": "Popover",
5217
+ "module": "src/components/popover/popover.component.ts"
5225
5218
  }
5226
5219
  },
5227
5220
  {
5228
- "name": "role",
5229
- "description": "This property defines the ARIA role for the element. By default, it is set to 'button'.\nConsumers should override this role when:\n- The element is being used in a context where a different role is more appropriate.\n- Custom behaviors are implemented that require a specific ARIA role for accessibility purposes.",
5230
- "default": "button",
5231
- "fieldName": "role",
5221
+ "name": "z-index",
5222
+ "type": {
5223
+ "text": "number"
5224
+ },
5225
+ "description": "The z-index of the popover.",
5226
+ "default": "1000",
5227
+ "fieldName": "zIndex",
5232
5228
  "inheritedFrom": {
5233
- "name": "Buttonsimple",
5234
- "module": "src/components/buttonsimple/buttonsimple.component.ts"
5229
+ "name": "Popover",
5230
+ "module": "src/components/popover/popover.component.ts"
5235
5231
  }
5236
5232
  },
5237
5233
  {
5238
- "name": "type",
5234
+ "name": "append-to",
5239
5235
  "type": {
5240
- "text": "ButtonType"
5236
+ "text": "string"
5241
5237
  },
5242
- "description": "This property defines the type attribute for the button element.\nThe type attribute specifies the behavior of the button when it is clicked.\n- **submit**: The button submits the form data to the server.\n- **reset**: The button resets the form data to its initial state.\n- **button**: The button does nothing when clicked.",
5243
- "default": "button",
5244
- "fieldName": "type",
5238
+ "default": "''",
5239
+ "description": "Element ID that the popover append to.",
5240
+ "fieldName": "appendTo",
5245
5241
  "inheritedFrom": {
5246
- "name": "Buttonsimple",
5247
- "module": "src/components/buttonsimple/buttonsimple.component.ts"
5242
+ "name": "Popover",
5243
+ "module": "src/components/popover/popover.component.ts"
5248
5244
  }
5249
- }
5250
- ],
5251
- "mixins": [
5252
- {
5253
- "name": "IconNameMixin",
5254
- "module": "/src/utils/mixins/IconNameMixin"
5255
- }
5256
- ],
5257
- "superclass": {
5258
- "name": "Buttonsimple",
5259
- "module": "/src/components/buttonsimple/buttonsimple.component"
5260
- },
5261
- "tagName": "mdc-chip",
5262
- "jsDoc": "/**\n * mdc-chip is an interactive element that can be used to represent a chip. It supports a leading icon along with label.\n * Consumers can wrap this component around a tooltip to provide additional context.\n *\n * It is recommended to keep the label text for the chip component concise and compact.\n * For best results, we recommend limiting the <b>maximum length of the label text to 20 characters</b>,\n * including empty spaces to split words.\n *\n * This component is built by extending Buttonsimple.\n *\n * @tagname mdc-chip\n *\n * @dependency mdc-icon\n * @dependency mdc-text\n *\n * @cssproperty --mdc-chip-color - The color of the chip.\n * @cssproperty --mdc-chip-border-color - The border color of the chip.\n * @cssproperty --mdc-chip-background-color - The background color of the chip.\n *\n */",
5263
- "customElement": true,
5264
- "events": [
5245
+ },
5265
5246
  {
5266
- "description": "(React: onClick) This event is dispatched when the button is clicked.",
5267
- "name": "click",
5268
- "reactName": "onClick",
5269
- "eventName": "ClickEvent",
5247
+ "name": "close-button-aria-label",
5248
+ "type": {
5249
+ "text": "string | null"
5250
+ },
5251
+ "default": "null",
5252
+ "description": "aria-label attribute to be set for close button accessibility.",
5253
+ "fieldName": "closeButtonAriaLabel",
5270
5254
  "inheritedFrom": {
5271
- "name": "Buttonsimple",
5272
- "module": "src/components/buttonsimple/buttonsimple.component.ts"
5255
+ "name": "Popover",
5256
+ "module": "src/components/popover/popover.component.ts"
5273
5257
  }
5274
5258
  },
5275
5259
  {
5276
- "description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the button.",
5277
- "name": "keydown",
5278
- "reactName": "onKeyDown",
5279
- "eventName": "KeydownEvent",
5260
+ "name": "role",
5261
+ "type": {
5262
+ "text": "HTMLElement['role']"
5263
+ },
5264
+ "description": "Role of the popover",
5265
+ "default": "dialog",
5266
+ "fieldName": "role",
5280
5267
  "inheritedFrom": {
5281
- "name": "Buttonsimple",
5282
- "module": "src/components/buttonsimple/buttonsimple.component.ts"
5268
+ "name": "Popover",
5269
+ "module": "src/components/popover/popover.component.ts"
5283
5270
  }
5284
5271
  },
5285
5272
  {
5286
- "description": "(React: onKeyUp) This event is dispatched when a key is released on the button.",
5287
- "name": "keyup",
5288
- "reactName": "onKeyUp",
5289
- "eventName": "KeyupEvent",
5273
+ "name": "aria-labelledby",
5274
+ "type": {
5275
+ "text": "string | null"
5276
+ },
5277
+ "default": "null",
5278
+ "description": "aria-labelledby for an interactive popover only, defaults to the trigger component id.\nUsed in nested cases where the triggerComponent isn't the actual button.",
5279
+ "fieldName": "ariaLabelledby",
5290
5280
  "inheritedFrom": {
5291
- "name": "Buttonsimple",
5292
- "module": "src/components/buttonsimple/buttonsimple.component.ts"
5281
+ "name": "Popover",
5282
+ "module": "src/components/popover/popover.component.ts"
5293
5283
  }
5294
5284
  },
5295
5285
  {
5296
- "description": "(React: onFocus) This event is dispatched when the button receives focus.",
5297
- "name": "focus",
5298
- "reactName": "onFocus",
5299
- "eventName": "FocusEvent",
5286
+ "name": "aria-describedby",
5287
+ "type": {
5288
+ "text": "string | null"
5289
+ },
5290
+ "default": "null",
5291
+ "description": "aria-describedby of the popover.",
5292
+ "fieldName": "ariaDescribedby",
5300
5293
  "inheritedFrom": {
5301
- "name": "Buttonsimple",
5302
- "module": "src/components/buttonsimple/buttonsimple.component.ts"
5294
+ "name": "Popover",
5295
+ "module": "src/components/popover/popover.component.ts"
5303
5296
  }
5304
5297
  }
5305
- ]
5298
+ ],
5299
+ "superclass": {
5300
+ "name": "Popover",
5301
+ "module": "/src/components/popover/popover.component"
5302
+ },
5303
+ "tagName": "mdc-coachmark",
5304
+ "jsDoc": "/**\n * Coachmark component based on top of the popover component,\n * with the default value of certain properties changed.\n *\n * @dependency mdc-popover\n *\n * @tagname mdc-coachmark\n *\n * @cssproperty --mdc-popover-arrow-border-radius - radius of the arrow border\n * @cssproperty --mdc-popover-arrow-border - border of the arrow\n * @cssproperty --mdc-popover-primary-background-color - primary background color of the popover\n * @cssproperty --mdc-popover-border-color - border color of the popover\n * @cssproperty --mdc-popover-inverted-background-color - inverted background color of the popover\n * @cssproperty --mdc-popover-inverted-border-color - inverted border color of the popover\n * @cssproperty --mdc-popover-inverted-text-color - inverted text color of the popover\n * @cssproperty --mdc-popover-elevation-3 - elevation of the popover\n *\n * @slot - Default slot for modal container\n *\n */",
5305
+ "customElement": true
5306
5306
  }
5307
5307
  ],
5308
5308
  "exports": [
@@ -5310,8 +5310,8 @@
5310
5310
  "kind": "js",
5311
5311
  "name": "default",
5312
5312
  "declaration": {
5313
- "name": "Chip",
5314
- "module": "components/chip/chip.component.js"
5313
+ "name": "Coachmark",
5314
+ "module": "components/coachmark/coachmark.component.js"
5315
5315
  }
5316
5316
  }
5317
5317
  ]