@momentum-design/components 0.54.3 → 0.56.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/browser/index.js +163 -134
- package/dist/browser/index.js.map +4 -4
- package/dist/components/popover/popover.component.d.ts +1 -0
- package/dist/components/popover/popover.component.js +9 -7
- package/dist/components/popover/popover.utils.d.ts +8 -0
- package/dist/components/popover/popover.utils.js +28 -0
- package/dist/components/toggletip/index.d.ts +9 -0
- package/dist/components/toggletip/index.js +6 -0
- package/dist/components/toggletip/toggletip.component.d.ts +66 -0
- package/dist/components/toggletip/toggletip.component.js +131 -0
- package/dist/components/toggletip/toggletip.constants.d.ts +10 -0
- package/dist/components/toggletip/toggletip.constants.js +12 -0
- package/dist/components/toggletip/toggletip.styles.d.ts +2 -0
- package/dist/components/toggletip/toggletip.styles.js +25 -0
- package/dist/components/toggletip/toggletip.types.d.ts +7 -0
- package/dist/components/toggletip/toggletip.types.js +1 -0
- package/dist/custom-elements.json +1832 -160
- package/dist/index.d.ts +2 -1
- package/dist/index.js +2 -1
- package/dist/react/index.d.ts +2 -1
- package/dist/react/index.js +2 -1
- package/dist/react/toggletip/index.d.ts +44 -0
- package/dist/react/toggletip/index.js +52 -0
- package/package.json +1 -1
@@ -4947,6 +4947,7 @@
|
|
4947
4947
|
"default": "null",
|
4948
4948
|
"description": "aria-label attribute to be set for close button accessibility.",
|
4949
4949
|
"attribute": "close-button-aria-label",
|
4950
|
+
"reflects": true,
|
4950
4951
|
"inheritedFrom": {
|
4951
4952
|
"name": "Popover",
|
4952
4953
|
"module": "components/popover/popover.component.js"
|
@@ -9533,6 +9534,77 @@
|
|
9533
9534
|
}
|
9534
9535
|
]
|
9535
9536
|
},
|
9537
|
+
{
|
9538
|
+
"kind": "javascript-module",
|
9539
|
+
"path": "components/marker/marker.component.js",
|
9540
|
+
"declarations": [
|
9541
|
+
{
|
9542
|
+
"kind": "class",
|
9543
|
+
"description": "`mdc-marker`, which is a vertical line and\nused to draw attention to specific parts of\nthe content or to signify important information.\n\n**Marker Variants**:\n- **solid**: Solid marker.\n- **striped**: Striped marker.",
|
9544
|
+
"name": "Marker",
|
9545
|
+
"cssProperties": [
|
9546
|
+
{
|
9547
|
+
"description": "Allows customization of the default background color in solid variant.",
|
9548
|
+
"name": "--mdc-marker-solid-background-color"
|
9549
|
+
},
|
9550
|
+
{
|
9551
|
+
"description": "Allows customization of the default stripes in striped variant.",
|
9552
|
+
"name": "--mdc-marker-striped-color"
|
9553
|
+
},
|
9554
|
+
{
|
9555
|
+
"description": "Allows customization of the default background color in striped variant.",
|
9556
|
+
"name": "--mdc-marker-striped-background-color"
|
9557
|
+
},
|
9558
|
+
{
|
9559
|
+
"description": "Allows customization of the default width.",
|
9560
|
+
"name": "--mdc-marker-width"
|
9561
|
+
}
|
9562
|
+
],
|
9563
|
+
"members": [
|
9564
|
+
{
|
9565
|
+
"kind": "field",
|
9566
|
+
"name": "variant",
|
9567
|
+
"type": {
|
9568
|
+
"text": "MarkerVariants"
|
9569
|
+
},
|
9570
|
+
"privacy": "public",
|
9571
|
+
"description": "There are two variants of markers, each with a width of 0.25rem:\n- **solid**: Solid marker.\n- **striped**: Striped marker.",
|
9572
|
+
"default": "solid",
|
9573
|
+
"attribute": "variant",
|
9574
|
+
"reflects": true
|
9575
|
+
}
|
9576
|
+
],
|
9577
|
+
"attributes": [
|
9578
|
+
{
|
9579
|
+
"name": "variant",
|
9580
|
+
"type": {
|
9581
|
+
"text": "MarkerVariants"
|
9582
|
+
},
|
9583
|
+
"description": "There are two variants of markers, each with a width of 0.25rem:\n- **solid**: Solid marker.\n- **striped**: Striped marker.",
|
9584
|
+
"default": "solid",
|
9585
|
+
"fieldName": "variant"
|
9586
|
+
}
|
9587
|
+
],
|
9588
|
+
"superclass": {
|
9589
|
+
"name": "Component",
|
9590
|
+
"module": "/src/models"
|
9591
|
+
},
|
9592
|
+
"tagName": "mdc-marker",
|
9593
|
+
"jsDoc": "/**\n * `mdc-marker`, which is a vertical line and\n * used to draw attention to specific parts of\n * the content or to signify important information.\n *\n * **Marker Variants**:\n * - **solid**: Solid marker.\n * - **striped**: Striped marker.\n *\n * @tagname mdc-marker\n *\n * @cssproperty --mdc-marker-solid-background-color - Allows customization of the default background color\n * in solid variant.\n * @cssproperty --mdc-marker-striped-color - Allows customization of the default stripes in striped variant.\n * @cssproperty --mdc-marker-striped-background-color - Allows customization of the default background color\n * in striped variant.\n * @cssproperty --mdc-marker-width - Allows customization of the default width.\n */",
|
9594
|
+
"customElement": true
|
9595
|
+
}
|
9596
|
+
],
|
9597
|
+
"exports": [
|
9598
|
+
{
|
9599
|
+
"kind": "js",
|
9600
|
+
"name": "default",
|
9601
|
+
"declaration": {
|
9602
|
+
"name": "Marker",
|
9603
|
+
"module": "components/marker/marker.component.js"
|
9604
|
+
}
|
9605
|
+
}
|
9606
|
+
]
|
9607
|
+
},
|
9536
9608
|
{
|
9537
9609
|
"kind": "javascript-module",
|
9538
9610
|
"path": "components/optgroup/optgroup.component.js",
|
@@ -10440,77 +10512,6 @@
|
|
10440
10512
|
}
|
10441
10513
|
]
|
10442
10514
|
},
|
10443
|
-
{
|
10444
|
-
"kind": "javascript-module",
|
10445
|
-
"path": "components/marker/marker.component.js",
|
10446
|
-
"declarations": [
|
10447
|
-
{
|
10448
|
-
"kind": "class",
|
10449
|
-
"description": "`mdc-marker`, which is a vertical line and\nused to draw attention to specific parts of\nthe content or to signify important information.\n\n**Marker Variants**:\n- **solid**: Solid marker.\n- **striped**: Striped marker.",
|
10450
|
-
"name": "Marker",
|
10451
|
-
"cssProperties": [
|
10452
|
-
{
|
10453
|
-
"description": "Allows customization of the default background color in solid variant.",
|
10454
|
-
"name": "--mdc-marker-solid-background-color"
|
10455
|
-
},
|
10456
|
-
{
|
10457
|
-
"description": "Allows customization of the default stripes in striped variant.",
|
10458
|
-
"name": "--mdc-marker-striped-color"
|
10459
|
-
},
|
10460
|
-
{
|
10461
|
-
"description": "Allows customization of the default background color in striped variant.",
|
10462
|
-
"name": "--mdc-marker-striped-background-color"
|
10463
|
-
},
|
10464
|
-
{
|
10465
|
-
"description": "Allows customization of the default width.",
|
10466
|
-
"name": "--mdc-marker-width"
|
10467
|
-
}
|
10468
|
-
],
|
10469
|
-
"members": [
|
10470
|
-
{
|
10471
|
-
"kind": "field",
|
10472
|
-
"name": "variant",
|
10473
|
-
"type": {
|
10474
|
-
"text": "MarkerVariants"
|
10475
|
-
},
|
10476
|
-
"privacy": "public",
|
10477
|
-
"description": "There are two variants of markers, each with a width of 0.25rem:\n- **solid**: Solid marker.\n- **striped**: Striped marker.",
|
10478
|
-
"default": "solid",
|
10479
|
-
"attribute": "variant",
|
10480
|
-
"reflects": true
|
10481
|
-
}
|
10482
|
-
],
|
10483
|
-
"attributes": [
|
10484
|
-
{
|
10485
|
-
"name": "variant",
|
10486
|
-
"type": {
|
10487
|
-
"text": "MarkerVariants"
|
10488
|
-
},
|
10489
|
-
"description": "There are two variants of markers, each with a width of 0.25rem:\n- **solid**: Solid marker.\n- **striped**: Striped marker.",
|
10490
|
-
"default": "solid",
|
10491
|
-
"fieldName": "variant"
|
10492
|
-
}
|
10493
|
-
],
|
10494
|
-
"superclass": {
|
10495
|
-
"name": "Component",
|
10496
|
-
"module": "/src/models"
|
10497
|
-
},
|
10498
|
-
"tagName": "mdc-marker",
|
10499
|
-
"jsDoc": "/**\n * `mdc-marker`, which is a vertical line and\n * used to draw attention to specific parts of\n * the content or to signify important information.\n *\n * **Marker Variants**:\n * - **solid**: Solid marker.\n * - **striped**: Striped marker.\n *\n * @tagname mdc-marker\n *\n * @cssproperty --mdc-marker-solid-background-color - Allows customization of the default background color\n * in solid variant.\n * @cssproperty --mdc-marker-striped-color - Allows customization of the default stripes in striped variant.\n * @cssproperty --mdc-marker-striped-background-color - Allows customization of the default background color\n * in striped variant.\n * @cssproperty --mdc-marker-width - Allows customization of the default width.\n */",
|
10500
|
-
"customElement": true
|
10501
|
-
}
|
10502
|
-
],
|
10503
|
-
"exports": [
|
10504
|
-
{
|
10505
|
-
"kind": "js",
|
10506
|
-
"name": "default",
|
10507
|
-
"declaration": {
|
10508
|
-
"name": "Marker",
|
10509
|
-
"module": "components/marker/marker.component.js"
|
10510
|
-
}
|
10511
|
-
}
|
10512
|
-
]
|
10513
|
-
},
|
10514
10515
|
{
|
10515
10516
|
"kind": "javascript-module",
|
10516
10517
|
"path": "components/popover/popover.component.js",
|
@@ -10818,7 +10819,8 @@
|
|
10818
10819
|
},
|
10819
10820
|
"default": "null",
|
10820
10821
|
"description": "aria-label attribute to be set for close button accessibility.",
|
10821
|
-
"attribute": "close-button-aria-label"
|
10822
|
+
"attribute": "close-button-aria-label",
|
10823
|
+
"reflects": true
|
10822
10824
|
},
|
10823
10825
|
{
|
10824
10826
|
"kind": "field",
|
@@ -10859,7 +10861,7 @@
|
|
10859
10861
|
"type": {
|
10860
10862
|
"text": "boolean"
|
10861
10863
|
},
|
10862
|
-
"description": "Disable aria-expanded attribute on trigger element.",
|
10864
|
+
"description": "Disable aria-expanded attribute on trigger element.\nMake sure to set this to false when the popover is interactive.",
|
10863
10865
|
"default": "false",
|
10864
10866
|
"attribute": "disable-aria-expanded",
|
10865
10867
|
"reflects": true
|
@@ -11727,7 +11729,7 @@
|
|
11727
11729
|
"type": {
|
11728
11730
|
"text": "boolean"
|
11729
11731
|
},
|
11730
|
-
"description": "Disable aria-expanded attribute on trigger element.",
|
11732
|
+
"description": "Disable aria-expanded attribute on trigger element.\nMake sure to set this to false when the popover is interactive.",
|
11731
11733
|
"default": "false",
|
11732
11734
|
"fieldName": "disableAriaExpanded"
|
11733
11735
|
},
|
@@ -19299,28 +19301,24 @@
|
|
19299
19301
|
},
|
19300
19302
|
{
|
19301
19303
|
"kind": "javascript-module",
|
19302
|
-
"path": "components/
|
19304
|
+
"path": "components/toggletip/toggletip.component.js",
|
19303
19305
|
"declarations": [
|
19304
19306
|
{
|
19305
19307
|
"kind": "class",
|
19306
|
-
"description": "A
|
19307
|
-
"name": "
|
19308
|
+
"description": "A toggletip is triggered by clicking a trigger element.\n\nIt can contain interactive content and can be closed by\nclicking outside the toggletip or pressing the escape key.\n\nIt can have optional close button to close the toggletip.\n\nToggletip component uses `mdc-screenreaderannouncer` internally to\nannounce the toggletip text content with screen readers when the toggletip is shown.\n\n`screenreader-announcer-identity` attribute can be used to provide ID of an element\nin DOM to which announcement elements are added. If not set, a visually hidden\ndiv element is created in DOM to which announcement elements are added.\n\nPlease refer to the `mdc-screenreaderannouncer` component for more details.",
|
19309
|
+
"name": "ToggleTip",
|
19308
19310
|
"cssProperties": [
|
19309
19311
|
{
|
19310
|
-
"description": "The maximum width of the
|
19311
|
-
"name": "--mdc-
|
19312
|
-
},
|
19313
|
-
{
|
19314
|
-
"description": "The padding of the tooltip.",
|
19315
|
-
"name": "--mdc-tooltip-padding"
|
19312
|
+
"description": "The maximum width of the toggletip.",
|
19313
|
+
"name": "--mdc-toggletip-max-width"
|
19316
19314
|
},
|
19317
19315
|
{
|
19318
|
-
"description": "The text color of the
|
19319
|
-
"name": "--mdc-
|
19316
|
+
"description": "The text color of the toggletip.",
|
19317
|
+
"name": "--mdc-toggletip-text-color"
|
19320
19318
|
},
|
19321
19319
|
{
|
19322
|
-
"description": "The text color of the
|
19323
|
-
"name": "--mdc-
|
19320
|
+
"description": "The text color of the toggletip when the color is contrast.",
|
19321
|
+
"name": "--mdc-toggletip-text-color-contrast"
|
19324
19322
|
},
|
19325
19323
|
{
|
19326
19324
|
"description": "radius of the arrow border",
|
@@ -19403,29 +19401,39 @@
|
|
19403
19401
|
}
|
19404
19402
|
}
|
19405
19403
|
],
|
19404
|
+
"slots": [
|
19405
|
+
{
|
19406
|
+
"description": "Default slot for the toggletip content",
|
19407
|
+
"name": "",
|
19408
|
+
"inheritedFrom": {
|
19409
|
+
"name": "Popover",
|
19410
|
+
"module": "src/components/popover/popover.component.ts"
|
19411
|
+
}
|
19412
|
+
}
|
19413
|
+
],
|
19406
19414
|
"members": [
|
19407
19415
|
{
|
19408
19416
|
"kind": "field",
|
19409
|
-
"name": "
|
19417
|
+
"name": "defaultSlotNodes",
|
19410
19418
|
"type": {
|
19411
|
-
"text": "
|
19419
|
+
"text": "Array<Node>"
|
19412
19420
|
},
|
19413
|
-
"
|
19414
|
-
"default": "'description'",
|
19415
|
-
"attribute": "tooltip-type",
|
19416
|
-
"reflects": true
|
19421
|
+
"privacy": "private"
|
19417
19422
|
},
|
19418
19423
|
{
|
19419
19424
|
"kind": "field",
|
19420
|
-
"name": "
|
19425
|
+
"name": "screenreaderAnnouncerIdentity",
|
19421
19426
|
"type": {
|
19422
|
-
"text": "
|
19427
|
+
"text": "string"
|
19423
19428
|
},
|
19424
|
-
"
|
19429
|
+
"default": "''",
|
19430
|
+
"description": "Set this attribute with the id of the element in the DOM, to which announcement\nelements will be appended.\nIf an id is provided, the announcement elements will be appended to this element.\nIf id is not provided, a visually hidden div element will be created in the DOM.\n\nPlease refer to the `mdc-screenreaderannouncer` component for more details.",
|
19431
|
+
"attribute": "screenreader-announcer-identity",
|
19432
|
+
"reflects": true
|
19425
19433
|
},
|
19426
19434
|
{
|
19427
19435
|
"kind": "method",
|
19428
|
-
"name": "
|
19436
|
+
"name": "getToggleTipText",
|
19429
19437
|
"privacy": "private",
|
19430
19438
|
"return": {
|
19431
19439
|
"type": {
|
@@ -19433,37 +19441,6 @@
|
|
19433
19441
|
}
|
19434
19442
|
}
|
19435
19443
|
},
|
19436
|
-
{
|
19437
|
-
"kind": "method",
|
19438
|
-
"name": "setTooltipType",
|
19439
|
-
"privacy": "private",
|
19440
|
-
"return": {
|
19441
|
-
"type": {
|
19442
|
-
"text": "void"
|
19443
|
-
}
|
19444
|
-
},
|
19445
|
-
"parameters": [
|
19446
|
-
{
|
19447
|
-
"name": "type",
|
19448
|
-
"type": {
|
19449
|
-
"text": "TooltipType"
|
19450
|
-
},
|
19451
|
-
"description": "The type to set."
|
19452
|
-
}
|
19453
|
-
],
|
19454
|
-
"description": "Sets the type attribute for the tooltip component.\nIf the provided type is not included in the TOOLTIP_TYPES,\nit defaults to the value specified in DEFAULTS.TOOLTIP_TYPE."
|
19455
|
-
},
|
19456
|
-
{
|
19457
|
-
"kind": "method",
|
19458
|
-
"name": "onIdUpdated",
|
19459
|
-
"privacy": "private",
|
19460
|
-
"return": {
|
19461
|
-
"type": {
|
19462
|
-
"text": "void"
|
19463
|
-
}
|
19464
|
-
},
|
19465
|
-
"description": "Updates the tooltip id if it is empty."
|
19466
|
-
},
|
19467
19444
|
{
|
19468
19445
|
"kind": "method",
|
19469
19446
|
"name": "onPlacementUpdated",
|
@@ -19473,27 +19450,7 @@
|
|
19473
19450
|
"text": "void"
|
19474
19451
|
}
|
19475
19452
|
},
|
19476
|
-
"description": "Updates the placement attribute if it is not a valid placement.\
|
19477
|
-
},
|
19478
|
-
{
|
19479
|
-
"kind": "method",
|
19480
|
-
"name": "onTooltipTypeUpdated",
|
19481
|
-
"privacy": "private",
|
19482
|
-
"return": {
|
19483
|
-
"type": {
|
19484
|
-
"text": "void"
|
19485
|
-
}
|
19486
|
-
},
|
19487
|
-
"parameters": [
|
19488
|
-
{
|
19489
|
-
"name": "changedProperties",
|
19490
|
-
"type": {
|
19491
|
-
"text": "PropertyValues"
|
19492
|
-
},
|
19493
|
-
"description": "The changed properties."
|
19494
|
-
}
|
19495
|
-
],
|
19496
|
-
"description": "Updates the tooltip type attribute and sets the appropriate aria props on the trigger component."
|
19453
|
+
"description": "Updates the placement attribute if it is not a valid placement.\nDefault placement for toggle tip is top."
|
19497
19454
|
},
|
19498
19455
|
{
|
19499
19456
|
"kind": "field",
|
@@ -20299,6 +20256,7 @@
|
|
20299
20256
|
"default": "null",
|
20300
20257
|
"description": "aria-label attribute to be set for close button accessibility.",
|
20301
20258
|
"attribute": "close-button-aria-label",
|
20259
|
+
"reflects": true,
|
20302
20260
|
"inheritedFrom": {
|
20303
20261
|
"name": "Popover",
|
20304
20262
|
"module": "components/popover/popover.component.js"
|
@@ -20355,7 +20313,7 @@
|
|
20355
20313
|
"type": {
|
20356
20314
|
"text": "boolean"
|
20357
20315
|
},
|
20358
|
-
"description": "Disable aria-expanded attribute on trigger element.",
|
20316
|
+
"description": "Disable aria-expanded attribute on trigger element.\nMake sure to set this to false when the popover is interactive.",
|
20359
20317
|
"default": "false",
|
20360
20318
|
"attribute": "disable-aria-expanded",
|
20361
20319
|
"reflects": true,
|
@@ -20566,7 +20524,7 @@
|
|
20566
20524
|
],
|
20567
20525
|
"events": [
|
20568
20526
|
{
|
20569
|
-
"description": "(React: onShown) This event is dispatched when the
|
20527
|
+
"description": "(React: onShown) This event is dispatched when the toggletip is shown",
|
20570
20528
|
"name": "shown",
|
20571
20529
|
"reactName": "onShown",
|
20572
20530
|
"inheritedFrom": {
|
@@ -20575,7 +20533,7 @@
|
|
20575
20533
|
}
|
20576
20534
|
},
|
20577
20535
|
{
|
20578
|
-
"description": "(React: onHidden) This event is dispatched when the
|
20536
|
+
"description": "(React: onHidden) This event is dispatched when the toggletip is hidden",
|
20579
20537
|
"name": "hidden",
|
20580
20538
|
"reactName": "onHidden",
|
20581
20539
|
"inheritedFrom": {
|
@@ -20584,7 +20542,7 @@
|
|
20584
20542
|
}
|
20585
20543
|
},
|
20586
20544
|
{
|
20587
|
-
"description": "(React: onCreated) This event is dispatched when the
|
20545
|
+
"description": "(React: onCreated) This event is dispatched when the toggletip is created (added to the DOM)",
|
20588
20546
|
"name": "created",
|
20589
20547
|
"reactName": "onCreated",
|
20590
20548
|
"inheritedFrom": {
|
@@ -20593,7 +20551,7 @@
|
|
20593
20551
|
}
|
20594
20552
|
},
|
20595
20553
|
{
|
20596
|
-
"description": "(React: onDestroyed) This event is dispatched when the
|
20554
|
+
"description": "(React: onDestroyed) This event is dispatched when the toggletip is destroyed (removed from the DOM)",
|
20597
20555
|
"name": "destroyed",
|
20598
20556
|
"reactName": "onDestroyed",
|
20599
20557
|
"inheritedFrom": {
|
@@ -20604,13 +20562,13 @@
|
|
20604
20562
|
],
|
20605
20563
|
"attributes": [
|
20606
20564
|
{
|
20607
|
-
"name": "
|
20565
|
+
"name": "screenreader-announcer-identity",
|
20608
20566
|
"type": {
|
20609
|
-
"text": "
|
20567
|
+
"text": "string"
|
20610
20568
|
},
|
20611
|
-
"
|
20612
|
-
"
|
20613
|
-
"fieldName": "
|
20569
|
+
"default": "''",
|
20570
|
+
"description": "Set this attribute with the id of the element in the DOM, to which announcement\nelements will be appended.\nIf an id is provided, the announcement elements will be appended to this element.\nIf id is not provided, a visually hidden div element will be created in the DOM.\n\nPlease refer to the `mdc-screenreaderannouncer` component for more details.",
|
20571
|
+
"fieldName": "screenreaderAnnouncerIdentity"
|
20614
20572
|
},
|
20615
20573
|
{
|
20616
20574
|
"name": "enabledFocusTrap",
|
@@ -20981,7 +20939,1721 @@
|
|
20981
20939
|
"type": {
|
20982
20940
|
"text": "boolean"
|
20983
20941
|
},
|
20984
|
-
"description": "Disable aria-expanded attribute on trigger element.",
|
20942
|
+
"description": "Disable aria-expanded attribute on trigger element.\nMake sure to set this to false when the popover is interactive.",
|
20943
|
+
"default": "false",
|
20944
|
+
"fieldName": "disableAriaExpanded",
|
20945
|
+
"inheritedFrom": {
|
20946
|
+
"name": "Popover",
|
20947
|
+
"module": "src/components/popover/popover.component.ts"
|
20948
|
+
}
|
20949
|
+
}
|
20950
|
+
],
|
20951
|
+
"superclass": {
|
20952
|
+
"name": "Popover",
|
20953
|
+
"module": "/src/components/popover/popover.component"
|
20954
|
+
},
|
20955
|
+
"tagName": "mdc-toggletip",
|
20956
|
+
"jsDoc": "/**\n * A toggletip is triggered by clicking a trigger element.\n *\n * It can contain interactive content and can be closed by\n * clicking outside the toggletip or pressing the escape key.\n *\n * It can have optional close button to close the toggletip.\n *\n * Toggletip component uses `mdc-screenreaderannouncer` internally to\n * announce the toggletip text content with screen readers when the toggletip is shown.\n *\n * `screenreader-announcer-identity` attribute can be used to provide ID of an element\n * in DOM to which announcement elements are added. If not set, a visually hidden\n * div element is created in DOM to which announcement elements are added.\n *\n * Please refer to the `mdc-screenreaderannouncer` component for more details.\n *\n * @dependency mdc-screenreaderannouncer\n * @dependency mdc-button\n *\n * @tagname mdc-toggletip\n *\n * @event shown - (React: onShown) This event is dispatched when the toggletip is shown\n * @event hidden - (React: onHidden) This event is dispatched when the toggletip is hidden\n * @event created - (React: onCreated) This event is dispatched when the toggletip is created (added to the DOM)\n * @event destroyed - (React: onDestroyed) This event is dispatched when the toggletip\n * is destroyed (removed from the DOM)\n *\n * @cssproperty --mdc-toggletip-max-width - The maximum width of the toggletip.\n * @cssproperty --mdc-toggletip-text-color - The text color of the toggletip.\n * @cssproperty --mdc-toggletip-text-color-contrast - The text color of the toggletip\n * when the color is contrast.\n *\n * @slot - Default slot for the toggletip content\n */",
|
20957
|
+
"customElement": true
|
20958
|
+
}
|
20959
|
+
],
|
20960
|
+
"exports": [
|
20961
|
+
{
|
20962
|
+
"kind": "js",
|
20963
|
+
"name": "default",
|
20964
|
+
"declaration": {
|
20965
|
+
"name": "ToggleTip",
|
20966
|
+
"module": "components/toggletip/toggletip.component.js"
|
20967
|
+
}
|
20968
|
+
}
|
20969
|
+
]
|
20970
|
+
},
|
20971
|
+
{
|
20972
|
+
"kind": "javascript-module",
|
20973
|
+
"path": "components/tooltip/tooltip.component.js",
|
20974
|
+
"declarations": [
|
20975
|
+
{
|
20976
|
+
"kind": "class",
|
20977
|
+
"description": "A tooltip is triggered by mouse hover or by keyboard focus\nand will disappear upon mouse exit or focus change.\n\nNote: Tooltips cannot contain content that can be focused or interacted with.",
|
20978
|
+
"name": "Tooltip",
|
20979
|
+
"cssProperties": [
|
20980
|
+
{
|
20981
|
+
"description": "The maximum width of the tooltip.",
|
20982
|
+
"name": "--mdc-tooltip-max-width"
|
20983
|
+
},
|
20984
|
+
{
|
20985
|
+
"description": "The padding of the tooltip.",
|
20986
|
+
"name": "--mdc-tooltip-padding"
|
20987
|
+
},
|
20988
|
+
{
|
20989
|
+
"description": "The text color of the tooltip.",
|
20990
|
+
"name": "--mdc-tooltip-text-color"
|
20991
|
+
},
|
20992
|
+
{
|
20993
|
+
"description": "The text color of the tooltip when the color is contrast.",
|
20994
|
+
"name": "--mdc-tooltip-text-color-contrast"
|
20995
|
+
},
|
20996
|
+
{
|
20997
|
+
"description": "radius of the arrow border",
|
20998
|
+
"name": "--mdc-popover-arrow-border-radius",
|
20999
|
+
"inheritedFrom": {
|
21000
|
+
"name": "Popover",
|
21001
|
+
"module": "src/components/popover/popover.component.ts"
|
21002
|
+
}
|
21003
|
+
},
|
21004
|
+
{
|
21005
|
+
"description": "border of the arrow",
|
21006
|
+
"name": "--mdc-popover-arrow-border",
|
21007
|
+
"inheritedFrom": {
|
21008
|
+
"name": "Popover",
|
21009
|
+
"module": "src/components/popover/popover.component.ts"
|
21010
|
+
}
|
21011
|
+
},
|
21012
|
+
{
|
21013
|
+
"description": "primary background color of the popover",
|
21014
|
+
"name": "--mdc-popover-primary-background-color",
|
21015
|
+
"inheritedFrom": {
|
21016
|
+
"name": "Popover",
|
21017
|
+
"module": "src/components/popover/popover.component.ts"
|
21018
|
+
}
|
21019
|
+
},
|
21020
|
+
{
|
21021
|
+
"description": "border color of the popover",
|
21022
|
+
"name": "--mdc-popover-border-color",
|
21023
|
+
"inheritedFrom": {
|
21024
|
+
"name": "Popover",
|
21025
|
+
"module": "src/components/popover/popover.component.ts"
|
21026
|
+
}
|
21027
|
+
},
|
21028
|
+
{
|
21029
|
+
"description": "inverted background color of the popover",
|
21030
|
+
"name": "--mdc-popover-inverted-background-color",
|
21031
|
+
"inheritedFrom": {
|
21032
|
+
"name": "Popover",
|
21033
|
+
"module": "src/components/popover/popover.component.ts"
|
21034
|
+
}
|
21035
|
+
},
|
21036
|
+
{
|
21037
|
+
"description": "inverted border color of the popover",
|
21038
|
+
"name": "--mdc-popover-inverted-border-color",
|
21039
|
+
"inheritedFrom": {
|
21040
|
+
"name": "Popover",
|
21041
|
+
"module": "src/components/popover/popover.component.ts"
|
21042
|
+
}
|
21043
|
+
},
|
21044
|
+
{
|
21045
|
+
"description": "inverted text color of the popover",
|
21046
|
+
"name": "--mdc-popover-inverted-text-color",
|
21047
|
+
"inheritedFrom": {
|
21048
|
+
"name": "Popover",
|
21049
|
+
"module": "src/components/popover/popover.component.ts"
|
21050
|
+
}
|
21051
|
+
},
|
21052
|
+
{
|
21053
|
+
"description": "elevation of the popover",
|
21054
|
+
"name": "--mdc-popover-elevation-3",
|
21055
|
+
"inheritedFrom": {
|
21056
|
+
"name": "Popover",
|
21057
|
+
"module": "src/components/popover/popover.component.ts"
|
21058
|
+
}
|
21059
|
+
},
|
21060
|
+
{
|
21061
|
+
"description": "max width of the popover",
|
21062
|
+
"name": "--mdc-popover-max-width",
|
21063
|
+
"inheritedFrom": {
|
21064
|
+
"name": "Popover",
|
21065
|
+
"module": "src/components/popover/popover.component.ts"
|
21066
|
+
}
|
21067
|
+
},
|
21068
|
+
{
|
21069
|
+
"description": "max height of the popover",
|
21070
|
+
"name": "--mdc-popover-max-height",
|
21071
|
+
"inheritedFrom": {
|
21072
|
+
"name": "Popover",
|
21073
|
+
"module": "src/components/popover/popover.component.ts"
|
21074
|
+
}
|
21075
|
+
}
|
21076
|
+
],
|
21077
|
+
"members": [
|
21078
|
+
{
|
21079
|
+
"kind": "field",
|
21080
|
+
"name": "tooltipType",
|
21081
|
+
"type": {
|
21082
|
+
"text": "TooltipType"
|
21083
|
+
},
|
21084
|
+
"description": "The type of tooltip.\n- **description** sets aria-describedby on the trigger component which refers to the tooltip id.\n- **label** sets aria-labelledby on the trigger component which refers to the tooltip id.\n- **none** no aria props set on trigger component referring to the tooltip id.",
|
21085
|
+
"default": "'description'",
|
21086
|
+
"attribute": "tooltip-type",
|
21087
|
+
"reflects": true
|
21088
|
+
},
|
21089
|
+
{
|
21090
|
+
"kind": "field",
|
21091
|
+
"name": "defaultSlotNodes",
|
21092
|
+
"type": {
|
21093
|
+
"text": "Array<Node>"
|
21094
|
+
},
|
21095
|
+
"privacy": "private"
|
21096
|
+
},
|
21097
|
+
{
|
21098
|
+
"kind": "method",
|
21099
|
+
"name": "getTooltipText",
|
21100
|
+
"privacy": "private",
|
21101
|
+
"return": {
|
21102
|
+
"type": {
|
21103
|
+
"text": ""
|
21104
|
+
}
|
21105
|
+
}
|
21106
|
+
},
|
21107
|
+
{
|
21108
|
+
"kind": "method",
|
21109
|
+
"name": "setTooltipType",
|
21110
|
+
"privacy": "private",
|
21111
|
+
"return": {
|
21112
|
+
"type": {
|
21113
|
+
"text": "void"
|
21114
|
+
}
|
21115
|
+
},
|
21116
|
+
"parameters": [
|
21117
|
+
{
|
21118
|
+
"name": "type",
|
21119
|
+
"type": {
|
21120
|
+
"text": "TooltipType"
|
21121
|
+
},
|
21122
|
+
"description": "The type to set."
|
21123
|
+
}
|
21124
|
+
],
|
21125
|
+
"description": "Sets the type attribute for the tooltip component.\nIf the provided type is not included in the TOOLTIP_TYPES,\nit defaults to the value specified in DEFAULTS.TOOLTIP_TYPE."
|
21126
|
+
},
|
21127
|
+
{
|
21128
|
+
"kind": "method",
|
21129
|
+
"name": "onIdUpdated",
|
21130
|
+
"privacy": "private",
|
21131
|
+
"return": {
|
21132
|
+
"type": {
|
21133
|
+
"text": "void"
|
21134
|
+
}
|
21135
|
+
},
|
21136
|
+
"description": "Updates the tooltip id if it is empty."
|
21137
|
+
},
|
21138
|
+
{
|
21139
|
+
"kind": "method",
|
21140
|
+
"name": "onPlacementUpdated",
|
21141
|
+
"privacy": "private",
|
21142
|
+
"return": {
|
21143
|
+
"type": {
|
21144
|
+
"text": "void"
|
21145
|
+
}
|
21146
|
+
},
|
21147
|
+
"description": "Updates the placement attribute if it is not a valid placement.\nOverriding the default from Popover"
|
21148
|
+
},
|
21149
|
+
{
|
21150
|
+
"kind": "method",
|
21151
|
+
"name": "onTooltipTypeUpdated",
|
21152
|
+
"privacy": "private",
|
21153
|
+
"return": {
|
21154
|
+
"type": {
|
21155
|
+
"text": "void"
|
21156
|
+
}
|
21157
|
+
},
|
21158
|
+
"parameters": [
|
21159
|
+
{
|
21160
|
+
"name": "changedProperties",
|
21161
|
+
"type": {
|
21162
|
+
"text": "PropertyValues"
|
21163
|
+
},
|
21164
|
+
"description": "The changed properties."
|
21165
|
+
}
|
21166
|
+
],
|
21167
|
+
"description": "Updates the tooltip type attribute and sets the appropriate aria props on the trigger component."
|
21168
|
+
},
|
21169
|
+
{
|
21170
|
+
"kind": "field",
|
21171
|
+
"name": "enabledFocusTrap",
|
21172
|
+
"type": {
|
21173
|
+
"text": "boolean"
|
21174
|
+
},
|
21175
|
+
"description": "Determines whether the focus trap is enabled.\nIf true, focus will be restricted to the content within this component.",
|
21176
|
+
"default": "false",
|
21177
|
+
"attribute": "enabledFocusTrap",
|
21178
|
+
"inheritedFrom": {
|
21179
|
+
"name": "Popover",
|
21180
|
+
"module": "components/popover/popover.component.js"
|
21181
|
+
}
|
21182
|
+
},
|
21183
|
+
{
|
21184
|
+
"kind": "field",
|
21185
|
+
"name": "enabledPreventScroll",
|
21186
|
+
"type": {
|
21187
|
+
"text": "boolean"
|
21188
|
+
},
|
21189
|
+
"description": "Prevent outside scrolling when popover show.",
|
21190
|
+
"default": "false",
|
21191
|
+
"attribute": "enabledPreventScroll",
|
21192
|
+
"inheritedFrom": {
|
21193
|
+
"name": "Popover",
|
21194
|
+
"module": "components/popover/popover.component.js"
|
21195
|
+
}
|
21196
|
+
},
|
21197
|
+
{
|
21198
|
+
"kind": "field",
|
21199
|
+
"name": "shouldWrapFocus",
|
21200
|
+
"type": {
|
21201
|
+
"text": "() => boolean"
|
21202
|
+
},
|
21203
|
+
"inheritedFrom": {
|
21204
|
+
"name": "Popover",
|
21205
|
+
"module": "components/popover/popover.component.js"
|
21206
|
+
}
|
21207
|
+
},
|
21208
|
+
{
|
21209
|
+
"kind": "method",
|
21210
|
+
"name": "deactivateFocusTrap",
|
21211
|
+
"description": "Deactivate the focus trap.",
|
21212
|
+
"inheritedFrom": {
|
21213
|
+
"name": "Popover",
|
21214
|
+
"module": "components/popover/popover.component.js"
|
21215
|
+
}
|
21216
|
+
},
|
21217
|
+
{
|
21218
|
+
"kind": "method",
|
21219
|
+
"name": "hasNoClientRects",
|
21220
|
+
"privacy": "private",
|
21221
|
+
"parameters": [
|
21222
|
+
{
|
21223
|
+
"name": "element",
|
21224
|
+
"type": {
|
21225
|
+
"text": "HTMLElement"
|
21226
|
+
},
|
21227
|
+
"description": "The element to check."
|
21228
|
+
}
|
21229
|
+
],
|
21230
|
+
"description": "Checks if the element has no client rectangles (not visible in the viewport).",
|
21231
|
+
"return": {
|
21232
|
+
"type": {
|
21233
|
+
"text": ""
|
21234
|
+
}
|
21235
|
+
},
|
21236
|
+
"inheritedFrom": {
|
21237
|
+
"name": "Popover",
|
21238
|
+
"module": "components/popover/popover.component.js"
|
21239
|
+
}
|
21240
|
+
},
|
21241
|
+
{
|
21242
|
+
"kind": "method",
|
21243
|
+
"name": "hasZeroDimensions",
|
21244
|
+
"privacy": "private",
|
21245
|
+
"parameters": [
|
21246
|
+
{
|
21247
|
+
"name": "element",
|
21248
|
+
"type": {
|
21249
|
+
"text": "HTMLElement"
|
21250
|
+
},
|
21251
|
+
"description": "The element to check."
|
21252
|
+
}
|
21253
|
+
],
|
21254
|
+
"description": "Checks if the element has zero dimensions (width and height are both 0).",
|
21255
|
+
"return": {
|
21256
|
+
"type": {
|
21257
|
+
"text": ""
|
21258
|
+
}
|
21259
|
+
},
|
21260
|
+
"inheritedFrom": {
|
21261
|
+
"name": "Popover",
|
21262
|
+
"module": "components/popover/popover.component.js"
|
21263
|
+
}
|
21264
|
+
},
|
21265
|
+
{
|
21266
|
+
"kind": "method",
|
21267
|
+
"name": "isNotVisible",
|
21268
|
+
"privacy": "private",
|
21269
|
+
"parameters": [
|
21270
|
+
{
|
21271
|
+
"name": "element",
|
21272
|
+
"type": {
|
21273
|
+
"text": "HTMLElement"
|
21274
|
+
},
|
21275
|
+
"description": "The element to check."
|
21276
|
+
}
|
21277
|
+
],
|
21278
|
+
"description": "Determines if the element is not visible in the DOM.",
|
21279
|
+
"return": {
|
21280
|
+
"type": {
|
21281
|
+
"text": ""
|
21282
|
+
}
|
21283
|
+
},
|
21284
|
+
"inheritedFrom": {
|
21285
|
+
"name": "Popover",
|
21286
|
+
"module": "components/popover/popover.component.js"
|
21287
|
+
}
|
21288
|
+
},
|
21289
|
+
{
|
21290
|
+
"kind": "method",
|
21291
|
+
"name": "hasHiddenStyle",
|
21292
|
+
"privacy": "private",
|
21293
|
+
"parameters": [
|
21294
|
+
{
|
21295
|
+
"name": "element",
|
21296
|
+
"type": {
|
21297
|
+
"text": "HTMLElement"
|
21298
|
+
},
|
21299
|
+
"description": "The element to check."
|
21300
|
+
}
|
21301
|
+
],
|
21302
|
+
"description": "Checks if the element has inline styles that make it hidden.",
|
21303
|
+
"return": {
|
21304
|
+
"type": {
|
21305
|
+
"text": ""
|
21306
|
+
}
|
21307
|
+
},
|
21308
|
+
"inheritedFrom": {
|
21309
|
+
"name": "Popover",
|
21310
|
+
"module": "components/popover/popover.component.js"
|
21311
|
+
}
|
21312
|
+
},
|
21313
|
+
{
|
21314
|
+
"kind": "method",
|
21315
|
+
"name": "hasComputedHidden",
|
21316
|
+
"privacy": "private",
|
21317
|
+
"parameters": [
|
21318
|
+
{
|
21319
|
+
"name": "element",
|
21320
|
+
"type": {
|
21321
|
+
"text": "HTMLElement"
|
21322
|
+
},
|
21323
|
+
"description": "The element to check."
|
21324
|
+
}
|
21325
|
+
],
|
21326
|
+
"description": "Checks if the element is hidden by a computed style.",
|
21327
|
+
"return": {
|
21328
|
+
"type": {
|
21329
|
+
"text": ""
|
21330
|
+
}
|
21331
|
+
},
|
21332
|
+
"inheritedFrom": {
|
21333
|
+
"name": "Popover",
|
21334
|
+
"module": "components/popover/popover.component.js"
|
21335
|
+
}
|
21336
|
+
},
|
21337
|
+
{
|
21338
|
+
"kind": "method",
|
21339
|
+
"name": "isHidden",
|
21340
|
+
"privacy": "private",
|
21341
|
+
"parameters": [
|
21342
|
+
{
|
21343
|
+
"name": "element",
|
21344
|
+
"type": {
|
21345
|
+
"text": "HTMLElement"
|
21346
|
+
},
|
21347
|
+
"description": "The element to check."
|
21348
|
+
}
|
21349
|
+
],
|
21350
|
+
"description": "Checks if the element is hidden from the user.",
|
21351
|
+
"return": {
|
21352
|
+
"type": {
|
21353
|
+
"text": ""
|
21354
|
+
}
|
21355
|
+
},
|
21356
|
+
"inheritedFrom": {
|
21357
|
+
"name": "Popover",
|
21358
|
+
"module": "components/popover/popover.component.js"
|
21359
|
+
}
|
21360
|
+
},
|
21361
|
+
{
|
21362
|
+
"kind": "method",
|
21363
|
+
"name": "isNotTabbable",
|
21364
|
+
"privacy": "private",
|
21365
|
+
"parameters": [
|
21366
|
+
{
|
21367
|
+
"name": "element",
|
21368
|
+
"type": {
|
21369
|
+
"text": "HTMLElement"
|
21370
|
+
},
|
21371
|
+
"description": "The element to check."
|
21372
|
+
}
|
21373
|
+
],
|
21374
|
+
"description": "Checks if the element is not tabbable.",
|
21375
|
+
"return": {
|
21376
|
+
"type": {
|
21377
|
+
"text": ""
|
21378
|
+
}
|
21379
|
+
},
|
21380
|
+
"inheritedFrom": {
|
21381
|
+
"name": "Popover",
|
21382
|
+
"module": "components/popover/popover.component.js"
|
21383
|
+
}
|
21384
|
+
},
|
21385
|
+
{
|
21386
|
+
"kind": "method",
|
21387
|
+
"name": "isInteractiveElement",
|
21388
|
+
"privacy": "private",
|
21389
|
+
"return": {
|
21390
|
+
"type": {
|
21391
|
+
"text": ""
|
21392
|
+
}
|
21393
|
+
},
|
21394
|
+
"parameters": [
|
21395
|
+
{
|
21396
|
+
"name": "element",
|
21397
|
+
"type": {
|
21398
|
+
"text": "HTMLElement"
|
21399
|
+
},
|
21400
|
+
"description": "The element to check."
|
21401
|
+
}
|
21402
|
+
],
|
21403
|
+
"description": "Checks if the element is interactive.",
|
21404
|
+
"inheritedFrom": {
|
21405
|
+
"name": "Popover",
|
21406
|
+
"module": "components/popover/popover.component.js"
|
21407
|
+
}
|
21408
|
+
},
|
21409
|
+
{
|
21410
|
+
"kind": "method",
|
21411
|
+
"name": "isFocusable",
|
21412
|
+
"privacy": "private",
|
21413
|
+
"parameters": [
|
21414
|
+
{
|
21415
|
+
"name": "element",
|
21416
|
+
"type": {
|
21417
|
+
"text": "HTMLElement"
|
21418
|
+
},
|
21419
|
+
"description": "The element to check."
|
21420
|
+
}
|
21421
|
+
],
|
21422
|
+
"description": "Checks if the element is focusable.",
|
21423
|
+
"return": {
|
21424
|
+
"type": {
|
21425
|
+
"text": ""
|
21426
|
+
}
|
21427
|
+
},
|
21428
|
+
"inheritedFrom": {
|
21429
|
+
"name": "Popover",
|
21430
|
+
"module": "components/popover/popover.component.js"
|
21431
|
+
}
|
21432
|
+
},
|
21433
|
+
{
|
21434
|
+
"kind": "method",
|
21435
|
+
"name": "findFocusable",
|
21436
|
+
"privacy": "private",
|
21437
|
+
"return": {
|
21438
|
+
"type": {
|
21439
|
+
"text": ""
|
21440
|
+
}
|
21441
|
+
},
|
21442
|
+
"parameters": [
|
21443
|
+
{
|
21444
|
+
"name": "root",
|
21445
|
+
"type": {
|
21446
|
+
"text": "ShadowRoot | HTMLElement"
|
21447
|
+
},
|
21448
|
+
"description": "The root element to search for focusable elements."
|
21449
|
+
},
|
21450
|
+
{
|
21451
|
+
"name": "matches",
|
21452
|
+
"default": "new Set()",
|
21453
|
+
"type": {
|
21454
|
+
"text": "Set<HTMLElement>"
|
21455
|
+
},
|
21456
|
+
"description": "The set of focusable elements."
|
21457
|
+
}
|
21458
|
+
],
|
21459
|
+
"description": "Recursively finds all focusable elements within the given root and its descendants.",
|
21460
|
+
"inheritedFrom": {
|
21461
|
+
"name": "Popover",
|
21462
|
+
"module": "components/popover/popover.component.js"
|
21463
|
+
}
|
21464
|
+
},
|
21465
|
+
{
|
21466
|
+
"kind": "method",
|
21467
|
+
"name": "setFocusableElements",
|
21468
|
+
"privacy": "public",
|
21469
|
+
"description": "Updates the list of focusable elements within the component's shadow root.",
|
21470
|
+
"inheritedFrom": {
|
21471
|
+
"name": "Popover",
|
21472
|
+
"module": "components/popover/popover.component.js"
|
21473
|
+
}
|
21474
|
+
},
|
21475
|
+
{
|
21476
|
+
"kind": "method",
|
21477
|
+
"name": "setInitialFocus",
|
21478
|
+
"privacy": "public",
|
21479
|
+
"parameters": [
|
21480
|
+
{
|
21481
|
+
"name": "prefferableElement",
|
21482
|
+
"default": "0",
|
21483
|
+
"type": {
|
21484
|
+
"text": "number"
|
21485
|
+
},
|
21486
|
+
"description": "The index of the prefferable element to focus."
|
21487
|
+
}
|
21488
|
+
],
|
21489
|
+
"description": "Sets the initial focus within the container.",
|
21490
|
+
"inheritedFrom": {
|
21491
|
+
"name": "Popover",
|
21492
|
+
"module": "components/popover/popover.component.js"
|
21493
|
+
}
|
21494
|
+
},
|
21495
|
+
{
|
21496
|
+
"kind": "method",
|
21497
|
+
"name": "calculateNextIndex",
|
21498
|
+
"privacy": "private",
|
21499
|
+
"parameters": [
|
21500
|
+
{
|
21501
|
+
"name": "currentIndex",
|
21502
|
+
"type": {
|
21503
|
+
"text": "number"
|
21504
|
+
},
|
21505
|
+
"description": "The current index."
|
21506
|
+
},
|
21507
|
+
{
|
21508
|
+
"name": "step",
|
21509
|
+
"type": {
|
21510
|
+
"text": "number"
|
21511
|
+
},
|
21512
|
+
"description": "The step to calculate the next index."
|
21513
|
+
}
|
21514
|
+
],
|
21515
|
+
"description": "Calculates the next index for the focus trap.",
|
21516
|
+
"return": {
|
21517
|
+
"type": {
|
21518
|
+
"text": ""
|
21519
|
+
}
|
21520
|
+
},
|
21521
|
+
"inheritedFrom": {
|
21522
|
+
"name": "Popover",
|
21523
|
+
"module": "components/popover/popover.component.js"
|
21524
|
+
}
|
21525
|
+
},
|
21526
|
+
{
|
21527
|
+
"kind": "method",
|
21528
|
+
"name": "getDeepActiveElement",
|
21529
|
+
"privacy": "private",
|
21530
|
+
"description": "Returns the deepest active element in the shadow DOM.",
|
21531
|
+
"return": {
|
21532
|
+
"type": {
|
21533
|
+
"text": ""
|
21534
|
+
}
|
21535
|
+
},
|
21536
|
+
"inheritedFrom": {
|
21537
|
+
"name": "Popover",
|
21538
|
+
"module": "components/popover/popover.component.js"
|
21539
|
+
}
|
21540
|
+
},
|
21541
|
+
{
|
21542
|
+
"kind": "method",
|
21543
|
+
"name": "findElement",
|
21544
|
+
"privacy": "private",
|
21545
|
+
"parameters": [
|
21546
|
+
{
|
21547
|
+
"name": "activeElement",
|
21548
|
+
"type": {
|
21549
|
+
"text": "HTMLElement"
|
21550
|
+
},
|
21551
|
+
"description": "The active element."
|
21552
|
+
}
|
21553
|
+
],
|
21554
|
+
"description": "Finds the index of the active element within the focusable elements.",
|
21555
|
+
"return": {
|
21556
|
+
"type": {
|
21557
|
+
"text": ""
|
21558
|
+
}
|
21559
|
+
},
|
21560
|
+
"inheritedFrom": {
|
21561
|
+
"name": "Popover",
|
21562
|
+
"module": "components/popover/popover.component.js"
|
21563
|
+
}
|
21564
|
+
},
|
21565
|
+
{
|
21566
|
+
"kind": "method",
|
21567
|
+
"name": "isEqualFocusNode",
|
21568
|
+
"privacy": "private",
|
21569
|
+
"parameters": [
|
21570
|
+
{
|
21571
|
+
"name": "activeElement",
|
21572
|
+
"type": {
|
21573
|
+
"text": "HTMLElement"
|
21574
|
+
},
|
21575
|
+
"description": "The active element."
|
21576
|
+
},
|
21577
|
+
{
|
21578
|
+
"name": "element",
|
21579
|
+
"type": {
|
21580
|
+
"text": "HTMLElement"
|
21581
|
+
},
|
21582
|
+
"description": "The element to compare."
|
21583
|
+
}
|
21584
|
+
],
|
21585
|
+
"description": "Checks if the active element is equal to the given element.",
|
21586
|
+
"return": {
|
21587
|
+
"type": {
|
21588
|
+
"text": ""
|
21589
|
+
}
|
21590
|
+
},
|
21591
|
+
"inheritedFrom": {
|
21592
|
+
"name": "Popover",
|
21593
|
+
"module": "components/popover/popover.component.js"
|
21594
|
+
}
|
21595
|
+
},
|
21596
|
+
{
|
21597
|
+
"kind": "method",
|
21598
|
+
"name": "trapFocus",
|
21599
|
+
"privacy": "private",
|
21600
|
+
"parameters": [
|
21601
|
+
{
|
21602
|
+
"name": "direction",
|
21603
|
+
"type": {
|
21604
|
+
"text": "boolean"
|
21605
|
+
},
|
21606
|
+
"description": "The direction of the focus trap.\nIf true, the focus will be trapped in the previous element."
|
21607
|
+
}
|
21608
|
+
],
|
21609
|
+
"description": "Traps focus within the container.",
|
21610
|
+
"inheritedFrom": {
|
21611
|
+
"name": "Popover",
|
21612
|
+
"module": "components/popover/popover.component.js"
|
21613
|
+
}
|
21614
|
+
},
|
21615
|
+
{
|
21616
|
+
"kind": "method",
|
21617
|
+
"name": "handleKeydown",
|
21618
|
+
"privacy": "private",
|
21619
|
+
"parameters": [
|
21620
|
+
{
|
21621
|
+
"name": "event",
|
21622
|
+
"type": {
|
21623
|
+
"text": "KeyboardEvent"
|
21624
|
+
},
|
21625
|
+
"description": "The keyboard event."
|
21626
|
+
}
|
21627
|
+
],
|
21628
|
+
"description": "Traps focus within the container.",
|
21629
|
+
"inheritedFrom": {
|
21630
|
+
"name": "Popover",
|
21631
|
+
"module": "components/popover/popover.component.js"
|
21632
|
+
}
|
21633
|
+
},
|
21634
|
+
{
|
21635
|
+
"kind": "field",
|
21636
|
+
"name": "id",
|
21637
|
+
"type": {
|
21638
|
+
"text": "string"
|
21639
|
+
},
|
21640
|
+
"default": "''",
|
21641
|
+
"description": "The unique ID of the popover.",
|
21642
|
+
"attribute": "id",
|
21643
|
+
"reflects": true,
|
21644
|
+
"inheritedFrom": {
|
21645
|
+
"name": "Popover",
|
21646
|
+
"module": "components/popover/popover.component.js"
|
21647
|
+
}
|
21648
|
+
},
|
21649
|
+
{
|
21650
|
+
"kind": "field",
|
21651
|
+
"name": "triggerID",
|
21652
|
+
"type": {
|
21653
|
+
"text": "string"
|
21654
|
+
},
|
21655
|
+
"default": "''",
|
21656
|
+
"description": "The ID of the element that triggers the popover.\nThis attribute is required for the popover to work.",
|
21657
|
+
"attribute": "triggerID",
|
21658
|
+
"reflects": true,
|
21659
|
+
"inheritedFrom": {
|
21660
|
+
"name": "Popover",
|
21661
|
+
"module": "components/popover/popover.component.js"
|
21662
|
+
}
|
21663
|
+
},
|
21664
|
+
{
|
21665
|
+
"kind": "field",
|
21666
|
+
"name": "trigger",
|
21667
|
+
"type": {
|
21668
|
+
"text": "PopoverTrigger"
|
21669
|
+
},
|
21670
|
+
"description": "Determines the events that cause the Popover 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**",
|
21671
|
+
"default": "click",
|
21672
|
+
"attribute": "trigger",
|
21673
|
+
"reflects": true,
|
21674
|
+
"inheritedFrom": {
|
21675
|
+
"name": "Popover",
|
21676
|
+
"module": "components/popover/popover.component.js"
|
21677
|
+
}
|
21678
|
+
},
|
21679
|
+
{
|
21680
|
+
"kind": "field",
|
21681
|
+
"name": "placement",
|
21682
|
+
"type": {
|
21683
|
+
"text": "PopoverPlacement"
|
21684
|
+
},
|
21685
|
+
"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**",
|
21686
|
+
"default": "bottom",
|
21687
|
+
"attribute": "placement",
|
21688
|
+
"reflects": true,
|
21689
|
+
"inheritedFrom": {
|
21690
|
+
"name": "Popover",
|
21691
|
+
"module": "components/popover/popover.component.js"
|
21692
|
+
}
|
21693
|
+
},
|
21694
|
+
{
|
21695
|
+
"kind": "field",
|
21696
|
+
"name": "color",
|
21697
|
+
"type": {
|
21698
|
+
"text": "PopoverColor"
|
21699
|
+
},
|
21700
|
+
"description": "Color of the popover\n- **tonal**\n- **contrast**",
|
21701
|
+
"default": "tonal",
|
21702
|
+
"attribute": "color",
|
21703
|
+
"reflects": true,
|
21704
|
+
"inheritedFrom": {
|
21705
|
+
"name": "Popover",
|
21706
|
+
"module": "components/popover/popover.component.js"
|
21707
|
+
}
|
21708
|
+
},
|
21709
|
+
{
|
21710
|
+
"kind": "field",
|
21711
|
+
"name": "visible",
|
21712
|
+
"type": {
|
21713
|
+
"text": "boolean"
|
21714
|
+
},
|
21715
|
+
"description": "The visibility of the popover.",
|
21716
|
+
"default": "false",
|
21717
|
+
"attribute": "visible",
|
21718
|
+
"reflects": true,
|
21719
|
+
"inheritedFrom": {
|
21720
|
+
"name": "Popover",
|
21721
|
+
"module": "components/popover/popover.component.js"
|
21722
|
+
}
|
21723
|
+
},
|
21724
|
+
{
|
21725
|
+
"kind": "field",
|
21726
|
+
"name": "offset",
|
21727
|
+
"type": {
|
21728
|
+
"text": "number"
|
21729
|
+
},
|
21730
|
+
"description": "The offset of the popover.",
|
21731
|
+
"default": "4",
|
21732
|
+
"attribute": "offset",
|
21733
|
+
"reflects": true,
|
21734
|
+
"inheritedFrom": {
|
21735
|
+
"name": "Popover",
|
21736
|
+
"module": "components/popover/popover.component.js"
|
21737
|
+
}
|
21738
|
+
},
|
21739
|
+
{
|
21740
|
+
"kind": "field",
|
21741
|
+
"name": "focusTrap",
|
21742
|
+
"type": {
|
21743
|
+
"text": "boolean"
|
21744
|
+
},
|
21745
|
+
"description": "Determines whether the focus trap is enabled.\nIf true, focus will be restricted to the content within this component.",
|
21746
|
+
"default": "false",
|
21747
|
+
"attribute": "focus-trap",
|
21748
|
+
"reflects": true,
|
21749
|
+
"inheritedFrom": {
|
21750
|
+
"name": "Popover",
|
21751
|
+
"module": "components/popover/popover.component.js"
|
21752
|
+
}
|
21753
|
+
},
|
21754
|
+
{
|
21755
|
+
"kind": "field",
|
21756
|
+
"name": "preventScroll",
|
21757
|
+
"type": {
|
21758
|
+
"text": "boolean"
|
21759
|
+
},
|
21760
|
+
"description": "Prevent outside scrolling when popover show.",
|
21761
|
+
"default": "false",
|
21762
|
+
"attribute": "prevent-scroll",
|
21763
|
+
"reflects": true,
|
21764
|
+
"inheritedFrom": {
|
21765
|
+
"name": "Popover",
|
21766
|
+
"module": "components/popover/popover.component.js"
|
21767
|
+
}
|
21768
|
+
},
|
21769
|
+
{
|
21770
|
+
"kind": "field",
|
21771
|
+
"name": "showArrow",
|
21772
|
+
"type": {
|
21773
|
+
"text": "boolean"
|
21774
|
+
},
|
21775
|
+
"description": "The arrow visibility of the popover.",
|
21776
|
+
"default": "false",
|
21777
|
+
"attribute": "show-arrow",
|
21778
|
+
"reflects": true,
|
21779
|
+
"inheritedFrom": {
|
21780
|
+
"name": "Popover",
|
21781
|
+
"module": "components/popover/popover.component.js"
|
21782
|
+
}
|
21783
|
+
},
|
21784
|
+
{
|
21785
|
+
"kind": "field",
|
21786
|
+
"name": "closeButton",
|
21787
|
+
"type": {
|
21788
|
+
"text": "boolean"
|
21789
|
+
},
|
21790
|
+
"description": "The close button visibility of the popover.",
|
21791
|
+
"default": "false",
|
21792
|
+
"attribute": "close-button",
|
21793
|
+
"reflects": true,
|
21794
|
+
"inheritedFrom": {
|
21795
|
+
"name": "Popover",
|
21796
|
+
"module": "components/popover/popover.component.js"
|
21797
|
+
}
|
21798
|
+
},
|
21799
|
+
{
|
21800
|
+
"kind": "field",
|
21801
|
+
"name": "interactive",
|
21802
|
+
"type": {
|
21803
|
+
"text": "boolean"
|
21804
|
+
},
|
21805
|
+
"description": "Determines whether the popover is interactive。",
|
21806
|
+
"default": "false",
|
21807
|
+
"attribute": "interactive",
|
21808
|
+
"reflects": true,
|
21809
|
+
"inheritedFrom": {
|
21810
|
+
"name": "Popover",
|
21811
|
+
"module": "components/popover/popover.component.js"
|
21812
|
+
}
|
21813
|
+
},
|
21814
|
+
{
|
21815
|
+
"kind": "field",
|
21816
|
+
"name": "delay",
|
21817
|
+
"type": {
|
21818
|
+
"text": "string"
|
21819
|
+
},
|
21820
|
+
"description": "The delay of the show/hide popover.",
|
21821
|
+
"default": "0,0",
|
21822
|
+
"attribute": "delay",
|
21823
|
+
"reflects": true,
|
21824
|
+
"inheritedFrom": {
|
21825
|
+
"name": "Popover",
|
21826
|
+
"module": "components/popover/popover.component.js"
|
21827
|
+
}
|
21828
|
+
},
|
21829
|
+
{
|
21830
|
+
"kind": "field",
|
21831
|
+
"name": "hideOnEscape",
|
21832
|
+
"type": {
|
21833
|
+
"text": "boolean"
|
21834
|
+
},
|
21835
|
+
"description": "Hide popover on escape key press.",
|
21836
|
+
"default": "false",
|
21837
|
+
"attribute": "hide-on-escape",
|
21838
|
+
"reflects": true,
|
21839
|
+
"inheritedFrom": {
|
21840
|
+
"name": "Popover",
|
21841
|
+
"module": "components/popover/popover.component.js"
|
21842
|
+
}
|
21843
|
+
},
|
21844
|
+
{
|
21845
|
+
"kind": "field",
|
21846
|
+
"name": "hideOnBlur",
|
21847
|
+
"type": {
|
21848
|
+
"text": "boolean"
|
21849
|
+
},
|
21850
|
+
"description": "Hide popover on blur.",
|
21851
|
+
"default": "false",
|
21852
|
+
"attribute": "hide-on-blur",
|
21853
|
+
"reflects": true,
|
21854
|
+
"inheritedFrom": {
|
21855
|
+
"name": "Popover",
|
21856
|
+
"module": "components/popover/popover.component.js"
|
21857
|
+
}
|
21858
|
+
},
|
21859
|
+
{
|
21860
|
+
"kind": "field",
|
21861
|
+
"name": "hideOnOutsideClick",
|
21862
|
+
"type": {
|
21863
|
+
"text": "boolean"
|
21864
|
+
},
|
21865
|
+
"description": "Hide on outside click of the popover.",
|
21866
|
+
"default": "false",
|
21867
|
+
"attribute": "hide-on-outside-click",
|
21868
|
+
"reflects": true,
|
21869
|
+
"inheritedFrom": {
|
21870
|
+
"name": "Popover",
|
21871
|
+
"module": "components/popover/popover.component.js"
|
21872
|
+
}
|
21873
|
+
},
|
21874
|
+
{
|
21875
|
+
"kind": "field",
|
21876
|
+
"name": "focusBackToTrigger",
|
21877
|
+
"type": {
|
21878
|
+
"text": "boolean"
|
21879
|
+
},
|
21880
|
+
"description": "The focus back to trigger after the popover hide.",
|
21881
|
+
"default": "false",
|
21882
|
+
"attribute": "focus-back-to-trigger",
|
21883
|
+
"reflects": true,
|
21884
|
+
"inheritedFrom": {
|
21885
|
+
"name": "Popover",
|
21886
|
+
"module": "components/popover/popover.component.js"
|
21887
|
+
}
|
21888
|
+
},
|
21889
|
+
{
|
21890
|
+
"kind": "field",
|
21891
|
+
"name": "backdrop",
|
21892
|
+
"type": {
|
21893
|
+
"text": "boolean"
|
21894
|
+
},
|
21895
|
+
"description": "Determines whether the popover with backdrop.\nOther than popover and trigger element, the rest of the screen will be covered with a backdrop.",
|
21896
|
+
"default": "false",
|
21897
|
+
"attribute": "backdrop",
|
21898
|
+
"reflects": true,
|
21899
|
+
"inheritedFrom": {
|
21900
|
+
"name": "Popover",
|
21901
|
+
"module": "components/popover/popover.component.js"
|
21902
|
+
}
|
21903
|
+
},
|
21904
|
+
{
|
21905
|
+
"kind": "field",
|
21906
|
+
"name": "flip",
|
21907
|
+
"type": {
|
21908
|
+
"text": "boolean"
|
21909
|
+
},
|
21910
|
+
"description": "Changes the placement of popover to keep it in view when scrolling.",
|
21911
|
+
"default": "true",
|
21912
|
+
"attribute": "flip",
|
21913
|
+
"reflects": true,
|
21914
|
+
"inheritedFrom": {
|
21915
|
+
"name": "Popover",
|
21916
|
+
"module": "components/popover/popover.component.js"
|
21917
|
+
}
|
21918
|
+
},
|
21919
|
+
{
|
21920
|
+
"kind": "field",
|
21921
|
+
"name": "size",
|
21922
|
+
"type": {
|
21923
|
+
"text": "boolean"
|
21924
|
+
},
|
21925
|
+
"description": "Changes the size of popover to keep it in view when scrolling.",
|
21926
|
+
"default": "false",
|
21927
|
+
"attribute": "size",
|
21928
|
+
"reflects": true,
|
21929
|
+
"inheritedFrom": {
|
21930
|
+
"name": "Popover",
|
21931
|
+
"module": "components/popover/popover.component.js"
|
21932
|
+
}
|
21933
|
+
},
|
21934
|
+
{
|
21935
|
+
"kind": "field",
|
21936
|
+
"name": "zIndex",
|
21937
|
+
"type": {
|
21938
|
+
"text": "number"
|
21939
|
+
},
|
21940
|
+
"description": "The z-index of the popover.",
|
21941
|
+
"default": "1000",
|
21942
|
+
"attribute": "z-index",
|
21943
|
+
"reflects": true,
|
21944
|
+
"inheritedFrom": {
|
21945
|
+
"name": "Popover",
|
21946
|
+
"module": "components/popover/popover.component.js"
|
21947
|
+
}
|
21948
|
+
},
|
21949
|
+
{
|
21950
|
+
"kind": "field",
|
21951
|
+
"name": "appendTo",
|
21952
|
+
"type": {
|
21953
|
+
"text": "string"
|
21954
|
+
},
|
21955
|
+
"default": "''",
|
21956
|
+
"description": "Element ID that the popover append to.",
|
21957
|
+
"attribute": "append-to",
|
21958
|
+
"reflects": true,
|
21959
|
+
"inheritedFrom": {
|
21960
|
+
"name": "Popover",
|
21961
|
+
"module": "components/popover/popover.component.js"
|
21962
|
+
}
|
21963
|
+
},
|
21964
|
+
{
|
21965
|
+
"kind": "field",
|
21966
|
+
"name": "closeButtonAriaLabel",
|
21967
|
+
"type": {
|
21968
|
+
"text": "string | null"
|
21969
|
+
},
|
21970
|
+
"default": "null",
|
21971
|
+
"description": "aria-label attribute to be set for close button accessibility.",
|
21972
|
+
"attribute": "close-button-aria-label",
|
21973
|
+
"reflects": true,
|
21974
|
+
"inheritedFrom": {
|
21975
|
+
"name": "Popover",
|
21976
|
+
"module": "components/popover/popover.component.js"
|
21977
|
+
}
|
21978
|
+
},
|
21979
|
+
{
|
21980
|
+
"kind": "field",
|
21981
|
+
"name": "role",
|
21982
|
+
"type": {
|
21983
|
+
"text": "HTMLElement['role']"
|
21984
|
+
},
|
21985
|
+
"description": "Role of the popover",
|
21986
|
+
"default": "dialog",
|
21987
|
+
"attribute": "role",
|
21988
|
+
"reflects": true,
|
21989
|
+
"inheritedFrom": {
|
21990
|
+
"name": "Popover",
|
21991
|
+
"module": "components/popover/popover.component.js"
|
21992
|
+
}
|
21993
|
+
},
|
21994
|
+
{
|
21995
|
+
"kind": "field",
|
21996
|
+
"name": "ariaLabelledby",
|
21997
|
+
"type": {
|
21998
|
+
"text": "string | null"
|
21999
|
+
},
|
22000
|
+
"default": "null",
|
22001
|
+
"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.",
|
22002
|
+
"attribute": "aria-labelledby",
|
22003
|
+
"reflects": true,
|
22004
|
+
"inheritedFrom": {
|
22005
|
+
"name": "Popover",
|
22006
|
+
"module": "components/popover/popover.component.js"
|
22007
|
+
}
|
22008
|
+
},
|
22009
|
+
{
|
22010
|
+
"kind": "field",
|
22011
|
+
"name": "ariaDescribedby",
|
22012
|
+
"type": {
|
22013
|
+
"text": "string | null"
|
22014
|
+
},
|
22015
|
+
"default": "null",
|
22016
|
+
"description": "aria-describedby of the popover.",
|
22017
|
+
"attribute": "aria-describedby",
|
22018
|
+
"reflects": true,
|
22019
|
+
"inheritedFrom": {
|
22020
|
+
"name": "Popover",
|
22021
|
+
"module": "components/popover/popover.component.js"
|
22022
|
+
}
|
22023
|
+
},
|
22024
|
+
{
|
22025
|
+
"kind": "field",
|
22026
|
+
"name": "disableAriaExpanded",
|
22027
|
+
"type": {
|
22028
|
+
"text": "boolean"
|
22029
|
+
},
|
22030
|
+
"description": "Disable aria-expanded attribute on trigger element.\nMake sure to set this to false when the popover is interactive.",
|
22031
|
+
"default": "false",
|
22032
|
+
"attribute": "disable-aria-expanded",
|
22033
|
+
"reflects": true,
|
22034
|
+
"inheritedFrom": {
|
22035
|
+
"name": "Popover",
|
22036
|
+
"module": "components/popover/popover.component.js"
|
22037
|
+
}
|
22038
|
+
},
|
22039
|
+
{
|
22040
|
+
"kind": "field",
|
22041
|
+
"name": "arrowElement",
|
22042
|
+
"type": {
|
22043
|
+
"text": "HTMLElement | null"
|
22044
|
+
},
|
22045
|
+
"privacy": "public",
|
22046
|
+
"default": "null",
|
22047
|
+
"inheritedFrom": {
|
22048
|
+
"name": "Popover",
|
22049
|
+
"module": "components/popover/popover.component.js"
|
22050
|
+
}
|
22051
|
+
},
|
22052
|
+
{
|
22053
|
+
"kind": "field",
|
22054
|
+
"name": "triggerElement",
|
22055
|
+
"type": {
|
22056
|
+
"text": "HTMLElement | null"
|
22057
|
+
},
|
22058
|
+
"privacy": "public",
|
22059
|
+
"default": "null",
|
22060
|
+
"inheritedFrom": {
|
22061
|
+
"name": "Popover",
|
22062
|
+
"module": "components/popover/popover.component.js"
|
22063
|
+
}
|
22064
|
+
},
|
22065
|
+
{
|
22066
|
+
"kind": "method",
|
22067
|
+
"name": "setupTriggerListener",
|
22068
|
+
"privacy": "private",
|
22069
|
+
"description": "Sets up the trigger event listeners based on the trigger type.",
|
22070
|
+
"inheritedFrom": {
|
22071
|
+
"name": "Popover",
|
22072
|
+
"module": "components/popover/popover.component.js"
|
22073
|
+
}
|
22074
|
+
},
|
22075
|
+
{
|
22076
|
+
"kind": "method",
|
22077
|
+
"name": "removeEventListeners",
|
22078
|
+
"privacy": "private",
|
22079
|
+
"description": "Removes the trigger event listeners.",
|
22080
|
+
"inheritedFrom": {
|
22081
|
+
"name": "Popover",
|
22082
|
+
"module": "components/popover/popover.component.js"
|
22083
|
+
}
|
22084
|
+
},
|
22085
|
+
{
|
22086
|
+
"kind": "field",
|
22087
|
+
"name": "onOutsidePopoverClick",
|
22088
|
+
"privacy": "private",
|
22089
|
+
"description": "Handles the outside click event to close the popover.",
|
22090
|
+
"parameters": [
|
22091
|
+
{
|
22092
|
+
"description": "The mouse event.",
|
22093
|
+
"name": "event"
|
22094
|
+
}
|
22095
|
+
],
|
22096
|
+
"inheritedFrom": {
|
22097
|
+
"name": "Popover",
|
22098
|
+
"module": "components/popover/popover.component.js"
|
22099
|
+
}
|
22100
|
+
},
|
22101
|
+
{
|
22102
|
+
"kind": "field",
|
22103
|
+
"name": "onEscapeKeydown",
|
22104
|
+
"privacy": "private",
|
22105
|
+
"description": "Handles the escape keydown event to close the popover.",
|
22106
|
+
"parameters": [
|
22107
|
+
{
|
22108
|
+
"description": "The keyboard event.",
|
22109
|
+
"name": "event"
|
22110
|
+
}
|
22111
|
+
],
|
22112
|
+
"inheritedFrom": {
|
22113
|
+
"name": "Popover",
|
22114
|
+
"module": "components/popover/popover.component.js"
|
22115
|
+
}
|
22116
|
+
},
|
22117
|
+
{
|
22118
|
+
"kind": "field",
|
22119
|
+
"name": "onPopoverFocusOut",
|
22120
|
+
"privacy": "private",
|
22121
|
+
"description": "Handles the popover focus out event.",
|
22122
|
+
"parameters": [
|
22123
|
+
{
|
22124
|
+
"description": "The focus event.",
|
22125
|
+
"name": "event"
|
22126
|
+
}
|
22127
|
+
],
|
22128
|
+
"inheritedFrom": {
|
22129
|
+
"name": "Popover",
|
22130
|
+
"module": "components/popover/popover.component.js"
|
22131
|
+
}
|
22132
|
+
},
|
22133
|
+
{
|
22134
|
+
"kind": "method",
|
22135
|
+
"name": "isOpenUpdated",
|
22136
|
+
"privacy": "private",
|
22137
|
+
"parameters": [
|
22138
|
+
{
|
22139
|
+
"name": "oldValue",
|
22140
|
+
"type": {
|
22141
|
+
"text": "boolean"
|
22142
|
+
},
|
22143
|
+
"description": "The old value of the visible property."
|
22144
|
+
},
|
22145
|
+
{
|
22146
|
+
"name": "newValue",
|
22147
|
+
"type": {
|
22148
|
+
"text": "boolean"
|
22149
|
+
},
|
22150
|
+
"description": "The new value of the visible property."
|
22151
|
+
}
|
22152
|
+
],
|
22153
|
+
"description": "Handles the popover visibility change and position the popover.\nHandles the exit event to close the popover.",
|
22154
|
+
"inheritedFrom": {
|
22155
|
+
"name": "Popover",
|
22156
|
+
"module": "components/popover/popover.component.js"
|
22157
|
+
}
|
22158
|
+
},
|
22159
|
+
{
|
22160
|
+
"kind": "field",
|
22161
|
+
"name": "startCloseDelay",
|
22162
|
+
"privacy": "private",
|
22163
|
+
"description": "Starts the close delay timer.\nIf the popover is not interactive, it will close the popover after the delay.",
|
22164
|
+
"inheritedFrom": {
|
22165
|
+
"name": "Popover",
|
22166
|
+
"module": "components/popover/popover.component.js"
|
22167
|
+
}
|
22168
|
+
},
|
22169
|
+
{
|
22170
|
+
"kind": "field",
|
22171
|
+
"name": "cancelCloseDelay",
|
22172
|
+
"privacy": "private",
|
22173
|
+
"description": "Cancels the close delay timer.",
|
22174
|
+
"inheritedFrom": {
|
22175
|
+
"name": "Popover",
|
22176
|
+
"module": "components/popover/popover.component.js"
|
22177
|
+
}
|
22178
|
+
},
|
22179
|
+
{
|
22180
|
+
"kind": "field",
|
22181
|
+
"name": "showPopover",
|
22182
|
+
"privacy": "public",
|
22183
|
+
"description": "Shows the popover.",
|
22184
|
+
"inheritedFrom": {
|
22185
|
+
"name": "Popover",
|
22186
|
+
"module": "components/popover/popover.component.js"
|
22187
|
+
}
|
22188
|
+
},
|
22189
|
+
{
|
22190
|
+
"kind": "field",
|
22191
|
+
"name": "hidePopover",
|
22192
|
+
"privacy": "public",
|
22193
|
+
"description": "Hides the popover.",
|
22194
|
+
"inheritedFrom": {
|
22195
|
+
"name": "Popover",
|
22196
|
+
"module": "components/popover/popover.component.js"
|
22197
|
+
}
|
22198
|
+
},
|
22199
|
+
{
|
22200
|
+
"kind": "field",
|
22201
|
+
"name": "togglePopoverVisible",
|
22202
|
+
"privacy": "public",
|
22203
|
+
"description": "Toggles the popover visibility.",
|
22204
|
+
"inheritedFrom": {
|
22205
|
+
"name": "Popover",
|
22206
|
+
"module": "components/popover/popover.component.js"
|
22207
|
+
}
|
22208
|
+
},
|
22209
|
+
{
|
22210
|
+
"kind": "method",
|
22211
|
+
"name": "handleCreatePopoverFirstUpdate",
|
22212
|
+
"privacy": "private",
|
22213
|
+
"description": "Sets the focusable elements inside the popover.",
|
22214
|
+
"inheritedFrom": {
|
22215
|
+
"name": "Popover",
|
22216
|
+
"module": "components/popover/popover.component.js"
|
22217
|
+
}
|
22218
|
+
},
|
22219
|
+
{
|
22220
|
+
"kind": "method",
|
22221
|
+
"name": "positionPopover",
|
22222
|
+
"privacy": "private",
|
22223
|
+
"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.",
|
22224
|
+
"inheritedFrom": {
|
22225
|
+
"name": "Popover",
|
22226
|
+
"module": "components/popover/popover.component.js"
|
22227
|
+
}
|
22228
|
+
},
|
22229
|
+
{
|
22230
|
+
"kind": "field",
|
22231
|
+
"name": "utils",
|
22232
|
+
"default": "new PopoverUtils(this)",
|
22233
|
+
"inheritedFrom": {
|
22234
|
+
"name": "Popover",
|
22235
|
+
"module": "components/popover/popover.component.js"
|
22236
|
+
}
|
22237
|
+
}
|
22238
|
+
],
|
22239
|
+
"events": [
|
22240
|
+
{
|
22241
|
+
"description": "(React: onShown) This event is dispatched when the tooltip is shown",
|
22242
|
+
"name": "shown",
|
22243
|
+
"reactName": "onShown",
|
22244
|
+
"inheritedFrom": {
|
22245
|
+
"name": "Popover",
|
22246
|
+
"module": "src/components/popover/popover.component.ts"
|
22247
|
+
}
|
22248
|
+
},
|
22249
|
+
{
|
22250
|
+
"description": "(React: onHidden) This event is dispatched when the tooltip is hidden",
|
22251
|
+
"name": "hidden",
|
22252
|
+
"reactName": "onHidden",
|
22253
|
+
"inheritedFrom": {
|
22254
|
+
"name": "Popover",
|
22255
|
+
"module": "src/components/popover/popover.component.ts"
|
22256
|
+
}
|
22257
|
+
},
|
22258
|
+
{
|
22259
|
+
"description": "(React: onCreated) This event is dispatched when the tooltip is created (added to the DOM)",
|
22260
|
+
"name": "created",
|
22261
|
+
"reactName": "onCreated",
|
22262
|
+
"inheritedFrom": {
|
22263
|
+
"name": "Popover",
|
22264
|
+
"module": "src/components/popover/popover.component.ts"
|
22265
|
+
}
|
22266
|
+
},
|
22267
|
+
{
|
22268
|
+
"description": "(React: onDestroyed) This event is dispatched when the tooltip is destroyed (removed from the DOM)",
|
22269
|
+
"name": "destroyed",
|
22270
|
+
"reactName": "onDestroyed",
|
22271
|
+
"inheritedFrom": {
|
22272
|
+
"name": "Popover",
|
22273
|
+
"module": "src/components/popover/popover.component.ts"
|
22274
|
+
}
|
22275
|
+
}
|
22276
|
+
],
|
22277
|
+
"attributes": [
|
22278
|
+
{
|
22279
|
+
"name": "tooltip-type",
|
22280
|
+
"type": {
|
22281
|
+
"text": "TooltipType"
|
22282
|
+
},
|
22283
|
+
"description": "The type of tooltip.\n- **description** sets aria-describedby on the trigger component which refers to the tooltip id.\n- **label** sets aria-labelledby on the trigger component which refers to the tooltip id.\n- **none** no aria props set on trigger component referring to the tooltip id.",
|
22284
|
+
"default": "'description'",
|
22285
|
+
"fieldName": "tooltipType"
|
22286
|
+
},
|
22287
|
+
{
|
22288
|
+
"name": "enabledFocusTrap",
|
22289
|
+
"type": {
|
22290
|
+
"text": "boolean"
|
22291
|
+
},
|
22292
|
+
"description": "Determines whether the focus trap is enabled.\nIf true, focus will be restricted to the content within this component.",
|
22293
|
+
"default": "false",
|
22294
|
+
"fieldName": "enabledFocusTrap",
|
22295
|
+
"inheritedFrom": {
|
22296
|
+
"name": "Popover",
|
22297
|
+
"module": "src/components/popover/popover.component.ts"
|
22298
|
+
}
|
22299
|
+
},
|
22300
|
+
{
|
22301
|
+
"name": "enabledPreventScroll",
|
22302
|
+
"type": {
|
22303
|
+
"text": "boolean"
|
22304
|
+
},
|
22305
|
+
"description": "Prevent outside scrolling when popover show.",
|
22306
|
+
"default": "false",
|
22307
|
+
"fieldName": "enabledPreventScroll",
|
22308
|
+
"inheritedFrom": {
|
22309
|
+
"name": "Popover",
|
22310
|
+
"module": "src/components/popover/popover.component.ts"
|
22311
|
+
}
|
22312
|
+
},
|
22313
|
+
{
|
22314
|
+
"name": "id",
|
22315
|
+
"type": {
|
22316
|
+
"text": "string"
|
22317
|
+
},
|
22318
|
+
"default": "''",
|
22319
|
+
"description": "The unique ID of the popover.",
|
22320
|
+
"fieldName": "id",
|
22321
|
+
"inheritedFrom": {
|
22322
|
+
"name": "Popover",
|
22323
|
+
"module": "src/components/popover/popover.component.ts"
|
22324
|
+
}
|
22325
|
+
},
|
22326
|
+
{
|
22327
|
+
"name": "triggerID",
|
22328
|
+
"type": {
|
22329
|
+
"text": "string"
|
22330
|
+
},
|
22331
|
+
"default": "''",
|
22332
|
+
"description": "The ID of the element that triggers the popover.\nThis attribute is required for the popover to work.",
|
22333
|
+
"fieldName": "triggerID",
|
22334
|
+
"inheritedFrom": {
|
22335
|
+
"name": "Popover",
|
22336
|
+
"module": "src/components/popover/popover.component.ts"
|
22337
|
+
}
|
22338
|
+
},
|
22339
|
+
{
|
22340
|
+
"name": "trigger",
|
22341
|
+
"type": {
|
22342
|
+
"text": "PopoverTrigger"
|
22343
|
+
},
|
22344
|
+
"description": "Determines the events that cause the Popover 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**",
|
22345
|
+
"default": "click",
|
22346
|
+
"fieldName": "trigger",
|
22347
|
+
"inheritedFrom": {
|
22348
|
+
"name": "Popover",
|
22349
|
+
"module": "src/components/popover/popover.component.ts"
|
22350
|
+
}
|
22351
|
+
},
|
22352
|
+
{
|
22353
|
+
"name": "placement",
|
22354
|
+
"type": {
|
22355
|
+
"text": "PopoverPlacement"
|
22356
|
+
},
|
22357
|
+
"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**",
|
22358
|
+
"default": "bottom",
|
22359
|
+
"fieldName": "placement",
|
22360
|
+
"inheritedFrom": {
|
22361
|
+
"name": "Popover",
|
22362
|
+
"module": "src/components/popover/popover.component.ts"
|
22363
|
+
}
|
22364
|
+
},
|
22365
|
+
{
|
22366
|
+
"name": "color",
|
22367
|
+
"type": {
|
22368
|
+
"text": "PopoverColor"
|
22369
|
+
},
|
22370
|
+
"description": "Color of the popover\n- **tonal**\n- **contrast**",
|
22371
|
+
"default": "tonal",
|
22372
|
+
"fieldName": "color",
|
22373
|
+
"inheritedFrom": {
|
22374
|
+
"name": "Popover",
|
22375
|
+
"module": "src/components/popover/popover.component.ts"
|
22376
|
+
}
|
22377
|
+
},
|
22378
|
+
{
|
22379
|
+
"name": "visible",
|
22380
|
+
"type": {
|
22381
|
+
"text": "boolean"
|
22382
|
+
},
|
22383
|
+
"description": "The visibility of the popover.",
|
22384
|
+
"default": "false",
|
22385
|
+
"fieldName": "visible",
|
22386
|
+
"inheritedFrom": {
|
22387
|
+
"name": "Popover",
|
22388
|
+
"module": "src/components/popover/popover.component.ts"
|
22389
|
+
}
|
22390
|
+
},
|
22391
|
+
{
|
22392
|
+
"name": "offset",
|
22393
|
+
"type": {
|
22394
|
+
"text": "number"
|
22395
|
+
},
|
22396
|
+
"description": "The offset of the popover.",
|
22397
|
+
"default": "4",
|
22398
|
+
"fieldName": "offset",
|
22399
|
+
"inheritedFrom": {
|
22400
|
+
"name": "Popover",
|
22401
|
+
"module": "src/components/popover/popover.component.ts"
|
22402
|
+
}
|
22403
|
+
},
|
22404
|
+
{
|
22405
|
+
"name": "focus-trap",
|
22406
|
+
"type": {
|
22407
|
+
"text": "boolean"
|
22408
|
+
},
|
22409
|
+
"description": "Determines whether the focus trap is enabled.\nIf true, focus will be restricted to the content within this component.",
|
22410
|
+
"default": "false",
|
22411
|
+
"fieldName": "focusTrap",
|
22412
|
+
"inheritedFrom": {
|
22413
|
+
"name": "Popover",
|
22414
|
+
"module": "src/components/popover/popover.component.ts"
|
22415
|
+
}
|
22416
|
+
},
|
22417
|
+
{
|
22418
|
+
"name": "prevent-scroll",
|
22419
|
+
"type": {
|
22420
|
+
"text": "boolean"
|
22421
|
+
},
|
22422
|
+
"description": "Prevent outside scrolling when popover show.",
|
22423
|
+
"default": "false",
|
22424
|
+
"fieldName": "preventScroll",
|
22425
|
+
"inheritedFrom": {
|
22426
|
+
"name": "Popover",
|
22427
|
+
"module": "src/components/popover/popover.component.ts"
|
22428
|
+
}
|
22429
|
+
},
|
22430
|
+
{
|
22431
|
+
"name": "show-arrow",
|
22432
|
+
"type": {
|
22433
|
+
"text": "boolean"
|
22434
|
+
},
|
22435
|
+
"description": "The arrow visibility of the popover.",
|
22436
|
+
"default": "false",
|
22437
|
+
"fieldName": "showArrow",
|
22438
|
+
"inheritedFrom": {
|
22439
|
+
"name": "Popover",
|
22440
|
+
"module": "src/components/popover/popover.component.ts"
|
22441
|
+
}
|
22442
|
+
},
|
22443
|
+
{
|
22444
|
+
"name": "close-button",
|
22445
|
+
"type": {
|
22446
|
+
"text": "boolean"
|
22447
|
+
},
|
22448
|
+
"description": "The close button visibility of the popover.",
|
22449
|
+
"default": "false",
|
22450
|
+
"fieldName": "closeButton",
|
22451
|
+
"inheritedFrom": {
|
22452
|
+
"name": "Popover",
|
22453
|
+
"module": "src/components/popover/popover.component.ts"
|
22454
|
+
}
|
22455
|
+
},
|
22456
|
+
{
|
22457
|
+
"name": "interactive",
|
22458
|
+
"type": {
|
22459
|
+
"text": "boolean"
|
22460
|
+
},
|
22461
|
+
"description": "Determines whether the popover is interactive。",
|
22462
|
+
"default": "false",
|
22463
|
+
"fieldName": "interactive",
|
22464
|
+
"inheritedFrom": {
|
22465
|
+
"name": "Popover",
|
22466
|
+
"module": "src/components/popover/popover.component.ts"
|
22467
|
+
}
|
22468
|
+
},
|
22469
|
+
{
|
22470
|
+
"name": "delay",
|
22471
|
+
"type": {
|
22472
|
+
"text": "string"
|
22473
|
+
},
|
22474
|
+
"description": "The delay of the show/hide popover.",
|
22475
|
+
"default": "0,0",
|
22476
|
+
"fieldName": "delay",
|
22477
|
+
"inheritedFrom": {
|
22478
|
+
"name": "Popover",
|
22479
|
+
"module": "src/components/popover/popover.component.ts"
|
22480
|
+
}
|
22481
|
+
},
|
22482
|
+
{
|
22483
|
+
"name": "hide-on-escape",
|
22484
|
+
"type": {
|
22485
|
+
"text": "boolean"
|
22486
|
+
},
|
22487
|
+
"description": "Hide popover on escape key press.",
|
22488
|
+
"default": "false",
|
22489
|
+
"fieldName": "hideOnEscape",
|
22490
|
+
"inheritedFrom": {
|
22491
|
+
"name": "Popover",
|
22492
|
+
"module": "src/components/popover/popover.component.ts"
|
22493
|
+
}
|
22494
|
+
},
|
22495
|
+
{
|
22496
|
+
"name": "hide-on-blur",
|
22497
|
+
"type": {
|
22498
|
+
"text": "boolean"
|
22499
|
+
},
|
22500
|
+
"description": "Hide popover on blur.",
|
22501
|
+
"default": "false",
|
22502
|
+
"fieldName": "hideOnBlur",
|
22503
|
+
"inheritedFrom": {
|
22504
|
+
"name": "Popover",
|
22505
|
+
"module": "src/components/popover/popover.component.ts"
|
22506
|
+
}
|
22507
|
+
},
|
22508
|
+
{
|
22509
|
+
"name": "hide-on-outside-click",
|
22510
|
+
"type": {
|
22511
|
+
"text": "boolean"
|
22512
|
+
},
|
22513
|
+
"description": "Hide on outside click of the popover.",
|
22514
|
+
"default": "false",
|
22515
|
+
"fieldName": "hideOnOutsideClick",
|
22516
|
+
"inheritedFrom": {
|
22517
|
+
"name": "Popover",
|
22518
|
+
"module": "src/components/popover/popover.component.ts"
|
22519
|
+
}
|
22520
|
+
},
|
22521
|
+
{
|
22522
|
+
"name": "focus-back-to-trigger",
|
22523
|
+
"type": {
|
22524
|
+
"text": "boolean"
|
22525
|
+
},
|
22526
|
+
"description": "The focus back to trigger after the popover hide.",
|
22527
|
+
"default": "false",
|
22528
|
+
"fieldName": "focusBackToTrigger",
|
22529
|
+
"inheritedFrom": {
|
22530
|
+
"name": "Popover",
|
22531
|
+
"module": "src/components/popover/popover.component.ts"
|
22532
|
+
}
|
22533
|
+
},
|
22534
|
+
{
|
22535
|
+
"name": "backdrop",
|
22536
|
+
"type": {
|
22537
|
+
"text": "boolean"
|
22538
|
+
},
|
22539
|
+
"description": "Determines whether the popover with backdrop.\nOther than popover and trigger element, the rest of the screen will be covered with a backdrop.",
|
22540
|
+
"default": "false",
|
22541
|
+
"fieldName": "backdrop",
|
22542
|
+
"inheritedFrom": {
|
22543
|
+
"name": "Popover",
|
22544
|
+
"module": "src/components/popover/popover.component.ts"
|
22545
|
+
}
|
22546
|
+
},
|
22547
|
+
{
|
22548
|
+
"name": "flip",
|
22549
|
+
"type": {
|
22550
|
+
"text": "boolean"
|
22551
|
+
},
|
22552
|
+
"description": "Changes the placement of popover to keep it in view when scrolling.",
|
22553
|
+
"default": "true",
|
22554
|
+
"fieldName": "flip",
|
22555
|
+
"inheritedFrom": {
|
22556
|
+
"name": "Popover",
|
22557
|
+
"module": "src/components/popover/popover.component.ts"
|
22558
|
+
}
|
22559
|
+
},
|
22560
|
+
{
|
22561
|
+
"name": "size",
|
22562
|
+
"type": {
|
22563
|
+
"text": "boolean"
|
22564
|
+
},
|
22565
|
+
"description": "Changes the size of popover to keep it in view when scrolling.",
|
22566
|
+
"default": "false",
|
22567
|
+
"fieldName": "size",
|
22568
|
+
"inheritedFrom": {
|
22569
|
+
"name": "Popover",
|
22570
|
+
"module": "src/components/popover/popover.component.ts"
|
22571
|
+
}
|
22572
|
+
},
|
22573
|
+
{
|
22574
|
+
"name": "z-index",
|
22575
|
+
"type": {
|
22576
|
+
"text": "number"
|
22577
|
+
},
|
22578
|
+
"description": "The z-index of the popover.",
|
22579
|
+
"default": "1000",
|
22580
|
+
"fieldName": "zIndex",
|
22581
|
+
"inheritedFrom": {
|
22582
|
+
"name": "Popover",
|
22583
|
+
"module": "src/components/popover/popover.component.ts"
|
22584
|
+
}
|
22585
|
+
},
|
22586
|
+
{
|
22587
|
+
"name": "append-to",
|
22588
|
+
"type": {
|
22589
|
+
"text": "string"
|
22590
|
+
},
|
22591
|
+
"default": "''",
|
22592
|
+
"description": "Element ID that the popover append to.",
|
22593
|
+
"fieldName": "appendTo",
|
22594
|
+
"inheritedFrom": {
|
22595
|
+
"name": "Popover",
|
22596
|
+
"module": "src/components/popover/popover.component.ts"
|
22597
|
+
}
|
22598
|
+
},
|
22599
|
+
{
|
22600
|
+
"name": "close-button-aria-label",
|
22601
|
+
"type": {
|
22602
|
+
"text": "string | null"
|
22603
|
+
},
|
22604
|
+
"default": "null",
|
22605
|
+
"description": "aria-label attribute to be set for close button accessibility.",
|
22606
|
+
"fieldName": "closeButtonAriaLabel",
|
22607
|
+
"inheritedFrom": {
|
22608
|
+
"name": "Popover",
|
22609
|
+
"module": "src/components/popover/popover.component.ts"
|
22610
|
+
}
|
22611
|
+
},
|
22612
|
+
{
|
22613
|
+
"name": "role",
|
22614
|
+
"type": {
|
22615
|
+
"text": "HTMLElement['role']"
|
22616
|
+
},
|
22617
|
+
"description": "Role of the popover",
|
22618
|
+
"default": "dialog",
|
22619
|
+
"fieldName": "role",
|
22620
|
+
"inheritedFrom": {
|
22621
|
+
"name": "Popover",
|
22622
|
+
"module": "src/components/popover/popover.component.ts"
|
22623
|
+
}
|
22624
|
+
},
|
22625
|
+
{
|
22626
|
+
"name": "aria-labelledby",
|
22627
|
+
"type": {
|
22628
|
+
"text": "string | null"
|
22629
|
+
},
|
22630
|
+
"default": "null",
|
22631
|
+
"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.",
|
22632
|
+
"fieldName": "ariaLabelledby",
|
22633
|
+
"inheritedFrom": {
|
22634
|
+
"name": "Popover",
|
22635
|
+
"module": "src/components/popover/popover.component.ts"
|
22636
|
+
}
|
22637
|
+
},
|
22638
|
+
{
|
22639
|
+
"name": "aria-describedby",
|
22640
|
+
"type": {
|
22641
|
+
"text": "string | null"
|
22642
|
+
},
|
22643
|
+
"default": "null",
|
22644
|
+
"description": "aria-describedby of the popover.",
|
22645
|
+
"fieldName": "ariaDescribedby",
|
22646
|
+
"inheritedFrom": {
|
22647
|
+
"name": "Popover",
|
22648
|
+
"module": "src/components/popover/popover.component.ts"
|
22649
|
+
}
|
22650
|
+
},
|
22651
|
+
{
|
22652
|
+
"name": "disable-aria-expanded",
|
22653
|
+
"type": {
|
22654
|
+
"text": "boolean"
|
22655
|
+
},
|
22656
|
+
"description": "Disable aria-expanded attribute on trigger element.\nMake sure to set this to false when the popover is interactive.",
|
20985
22657
|
"default": "false",
|
20986
22658
|
"fieldName": "disableAriaExpanded",
|
20987
22659
|
"inheritedFrom": {
|