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