@ionic/core 8.5.4-dev.11744646756.1244bf71 → 8.5.4-dev.11744657992.1bb14c4f

package/dist/collection/components/popover/popover.js

@@ -34,128 +34,6 @@ export class Popover {
         this.lockController = createLockController();
         this.inline = false;
         this.focusDescendantOnPresent = false;
-        this.presented = false;
-        /** @internal */
-        this.hasController = false;
-        /**
-         * If `true`, the keyboard will be automatically dismissed when the overlay is presented.
-         */
-        this.keyboardClose = true;
-        /**
-         * If `true`, the popover will be dismissed when the backdrop is clicked.
-         */
-        this.backdropDismiss = true;
-        /**
-         * If `true`, a backdrop will be displayed behind the popover.
-         * This property controls whether or not the backdrop
-         * darkens the screen when the popover is presented.
-         * It does not control whether or not the backdrop
-         * is active or present in the DOM.
-         */
-        this.showBackdrop = true;
-        /**
-         * If `true`, the popover will be translucent.
-         * Only applies when the mode is `"ios"` and the device supports
-         * [`backdrop-filter`](https://developer.mozilla.org/en-US/docs/Web/CSS/backdrop-filter#Browser_compatibility).
-         */
-        this.translucent = false;
-        /**
-         * If `true`, the popover will animate.
-         */
-        this.animated = true;
-        /**
-         * Describes what kind of interaction with the trigger that
-         * should cause the popover to open. Does not apply when the `trigger`
-         * property is `undefined`.
-         * If `"click"`, the popover will be presented when the trigger is left clicked.
-         * If `"hover"`, the popover will be presented when a pointer hovers over the trigger.
-         * If `"context-menu"`, the popover will be presented when the trigger is right
-         * clicked on desktop and long pressed on mobile. This will also prevent your
-         * device's normal context menu from appearing.
-         */
-        this.triggerAction = 'click';
-        /**
-         * Describes how to calculate the popover width.
-         * If `"cover"`, the popover width will match the width of the trigger.
-         * If `"auto"`, the popover width will be set to a static default value.
-         */
-        this.size = 'auto';
-        /**
-         * If `true`, the popover will be automatically
-         * dismissed when the content has been clicked.
-         */
-        this.dismissOnSelect = false;
-        /**
-         * Describes what to position the popover relative to.
-         * If `"trigger"`, the popover will be positioned relative
-         * to the trigger button. If passing in an event, this is
-         * determined via event.target.
-         * If `"event"`, the popover will be positioned relative
-         * to the x/y coordinates of the trigger action. If passing
-         * in an event, this is determined via event.clientX and event.clientY.
-         */
-        this.reference = 'trigger';
-        /**
-         * Describes which side of the `reference` point to position
-         * the popover on. The `"start"` and `"end"` values are RTL-aware,
-         * and the `"left"` and `"right"` values are not.
-         */
-        this.side = 'bottom';
-        /**
-         * If `true`, the popover will display an arrow that points at the
-         * `reference` when running in `ios` mode. Does not apply in `md` mode.
-         */
-        this.arrow = true;
-        /**
-         * If `true`, the popover will open. If `false`, the popover will close.
-         * Use this if you need finer grained control over presentation, otherwise
-         * just use the popoverController or the `trigger` property.
-         * Note: `isOpen` will not automatically be set back to `false` when
-         * the popover dismisses. You will need to do that in your code.
-         */
-        this.isOpen = false;
-        /**
-         * @internal
-         *
-         * If `true` the popover will not register its own keyboard event handlers.
-         * This allows the contents of the popover to handle their own keyboard interactions.
-         *
-         * If `false`, the popover will register its own keyboard event handlers for
-         * navigating `ion-list` items within a popover (up/down/home/end/etc.).
-         * This will also cancel browser keyboard event bindings to prevent scroll
-         * behavior in a popover using a list of items.
-         */
-        this.keyboardEvents = false;
-        /**
-         * If `true`, focus will not be allowed to move outside of this overlay.
-         * If `false`, focus will be allowed to move outside of the overlay.
-         *
-         * In most scenarios this property should remain set to `true`. Setting
-         * this property to `false` can cause severe accessibility issues as users
-         * relying on assistive technologies may be able to move focus into
-         * a confusing state. We recommend only setting this to `false` when
-         * absolutely necessary.
-         *
-         * Developers may want to consider disabling focus trapping if this
-         * overlay presents a non-Ionic overlay from a 3rd party library.
-         * Developers would disable focus trapping on the Ionic overlay
-         * when presenting the 3rd party overlay and then re-enable
-         * focus trapping when dismissing the 3rd party overlay and moving
-         * focus back to the Ionic overlay.
-         */
-        this.focusTrap = true;
-        /**
-         * If `true`, the component passed into `ion-popover` will
-         * automatically be mounted when the popover is created. The
-         * component will remain mounted even when the popover is dismissed.
-         * However, the component will be destroyed when the popover is
-         * destroyed. This property is not reactive and should only be
-         * used when initially creating a popover.
-         *
-         * Note: This feature only applies to inline popovers in JavaScript
-         * frameworks such as Angular, React, and Vue.
-         */
-        this.keepContentsMounted = false;
         this.onBackdropTap = () => {
             this.dismiss(undefined, BACKDROP);
         };
@@ -203,6 +81,34 @@ export class Popover {
             }
             this.destroyDismissInteraction = configureDismissInteraction(triggerEl, triggerAction, el, parentPopover);
         };
+        this.presented = false;
+        this.hasController = false;
+        this.delegate = undefined;
+        this.overlayIndex = undefined;
+        this.enterAnimation = undefined;
+        this.leaveAnimation = undefined;
+        this.component = undefined;
+        this.componentProps = undefined;
+        this.keyboardClose = true;
+        this.cssClass = undefined;
+        this.backdropDismiss = true;
+        this.event = undefined;
+        this.showBackdrop = true;
+        this.translucent = false;
+        this.animated = true;
+        this.htmlAttributes = undefined;
+        this.triggerAction = 'click';
+        this.trigger = undefined;
+        this.size = 'auto';
+        this.dismissOnSelect = false;
+        this.reference = 'trigger';
+        this.side = 'bottom';
+        this.alignment = undefined;
+        this.arrow = true;
+        this.isOpen = false;
+        this.keyboardEvents = false;
+        this.focusTrap = true;
+        this.keepContentsMounted = false;
     }
     onTriggerChange() {
         this.configureTriggerInteraction();
@@ -454,7 +360,6 @@ export class Popover {
         return {
             "hasController": {
                 "type": "boolean",
-                "attribute": "has-controller",
                 "mutable": false,
                 "complexType": {
                     "original": "boolean",
@@ -470,14 +375,12 @@ export class Popover {
                         }],
                     "text": ""
                 },
-                "getter": false,
-                "setter": false,
+                "attribute": "has-controller",
                 "reflect": false,
                 "defaultValue": "false"
             },
             "delegate": {
                 "type": "unknown",
-                "attribute": "delegate",
                 "mutable": false,
                 "complexType": {
                     "original": "FrameworkDelegate",
@@ -498,13 +401,10 @@ export class Popover {
                             "text": undefined
                         }],
                     "text": ""
-                },
-                "getter": false,
-                "setter": false
+                }
             },
             "overlayIndex": {
                 "type": "number",
-                "attribute": "overlay-index",
                 "mutable": false,
                 "complexType": {
                     "original": "number",
@@ -520,13 +420,11 @@ export class Popover {
                         }],
                     "text": ""
                 },
-                "getter": false,
-                "setter": false,
+                "attribute": "overlay-index",
                 "reflect": false
             },
             "enterAnimation": {
                 "type": "unknown",
-                "attribute": "enter-animation",
                 "mutable": false,
                 "complexType": {
                     "original": "AnimationBuilder",
@@ -544,13 +442,10 @@ export class Popover {
                 "docs": {
                     "tags": [],
                     "text": "Animation to use when the popover is presented."
-                },
-                "getter": false,
-                "setter": false
+                }
             },
             "leaveAnimation": {
                 "type": "unknown",
-                "attribute": "leave-animation",
                 "mutable": false,
                 "complexType": {
                     "original": "AnimationBuilder",
@@ -568,13 +463,10 @@ export class Popover {
                 "docs": {
                     "tags": [],
                     "text": "Animation to use when the popover is dismissed."
-                },
-                "getter": false,
-                "setter": false
+                }
             },
             "component": {
                 "type": "string",
-                "attribute": "component",
                 "mutable": false,
                 "complexType": {
                     "original": "ComponentRef",
@@ -593,13 +485,11 @@ export class Popover {
                     "tags": [],
                     "text": "The component to display inside of the popover.\nYou only need to use this if you are not using\na JavaScript framework. Otherwise, you can just\nslot your component inside of `ion-popover`."
                 },
-                "getter": false,
-                "setter": false,
+                "attribute": "component",
                 "reflect": false
             },
             "componentProps": {
                 "type": "unknown",
-                "attribute": "component-props",
                 "mutable": false,
                 "complexType": {
                     "original": "ComponentProps",
@@ -617,13 +507,10 @@ export class Popover {
                 "docs": {
                     "tags": [],
                     "text": "The data to pass to the popover component.\nYou only need to use this if you are not using\na JavaScript framework. Otherwise, you can just\nset the props directly on your component."
-                },
-                "getter": false,
-                "setter": false
+                }
             },
             "keyboardClose": {
                 "type": "boolean",
-                "attribute": "keyboard-close",
                 "mutable": false,
                 "complexType": {
                     "original": "boolean",
@@ -636,14 +523,12 @@ export class Popover {
                     "tags": [],
                     "text": "If `true`, the keyboard will be automatically dismissed when the overlay is presented."
                 },
-                "getter": false,
-                "setter": false,
+                "attribute": "keyboard-close",
                 "reflect": false,
                 "defaultValue": "true"
             },
             "cssClass": {
                 "type": "string",
-                "attribute": "css-class",
                 "mutable": false,
                 "complexType": {
                     "original": "string | string[]",
@@ -659,13 +544,11 @@ export class Popover {
                         }],
                     "text": "Additional classes to apply for custom CSS. If multiple classes are\nprovided they should be separated by spaces."
                 },
-                "getter": false,
-                "setter": false,
+                "attribute": "css-class",
                 "reflect": false
             },
             "backdropDismiss": {
                 "type": "boolean",
-                "attribute": "backdrop-dismiss",
                 "mutable": false,
                 "complexType": {
                     "original": "boolean",
@@ -678,14 +561,12 @@ export class Popover {
                     "tags": [],
                     "text": "If `true`, the popover will be dismissed when the backdrop is clicked."
                 },
-                "getter": false,
-                "setter": false,
+                "attribute": "backdrop-dismiss",
                 "reflect": false,
                 "defaultValue": "true"
             },
             "event": {
                 "type": "any",
-                "attribute": "event",
                 "mutable": false,
                 "complexType": {
                     "original": "any",
@@ -698,13 +579,11 @@ export class Popover {
                     "tags": [],
                     "text": "The event to pass to the popover animation."
                 },
-                "getter": false,
-                "setter": false,
+                "attribute": "event",
                 "reflect": false
             },
             "showBackdrop": {
                 "type": "boolean",
-                "attribute": "show-backdrop",
                 "mutable": false,
                 "complexType": {
                     "original": "boolean",
@@ -717,14 +596,12 @@ export class Popover {
                     "tags": [],
                     "text": "If `true`, a backdrop will be displayed behind the popover.\nThis property controls whether or not the backdrop\ndarkens the screen when the popover is presented.\nIt does not control whether or not the backdrop\nis active or present in the DOM."
                 },
-                "getter": false,
-                "setter": false,
+                "attribute": "show-backdrop",
                 "reflect": false,
                 "defaultValue": "true"
             },
             "translucent": {
                 "type": "boolean",
-                "attribute": "translucent",
                 "mutable": false,
                 "complexType": {
                     "original": "boolean",
@@ -737,14 +614,12 @@ export class Popover {
                     "tags": [],
                     "text": "If `true`, the popover will be translucent.\nOnly applies when the mode is `\"ios\"` and the device supports\n[`backdrop-filter`](https://developer.mozilla.org/en-US/docs/Web/CSS/backdrop-filter#Browser_compatibility)."
                 },
-                "getter": false,
-                "setter": false,
+                "attribute": "translucent",
                 "reflect": false,
                 "defaultValue": "false"
             },
             "animated": {
                 "type": "boolean",
-                "attribute": "animated",
                 "mutable": false,
                 "complexType": {
                     "original": "boolean",
@@ -757,14 +632,12 @@ export class Popover {
                     "tags": [],
                     "text": "If `true`, the popover will animate."
                 },
-                "getter": false,
-                "setter": false,
+                "attribute": "animated",
                 "reflect": false,
                 "defaultValue": "true"
             },
             "htmlAttributes": {
                 "type": "unknown",
-                "attribute": "html-attributes",
                 "mutable": false,
                 "complexType": {
                     "original": "{ [key: string]: any }",
@@ -776,13 +649,10 @@ export class Popover {
                 "docs": {
                     "tags": [],
                     "text": "Additional attributes to pass to the popover."
-                },
-                "getter": false,
-                "setter": false
+                }
             },
             "triggerAction": {
                 "type": "string",
-                "attribute": "trigger-action",
                 "mutable": false,
                 "complexType": {
                     "original": "TriggerAction",
@@ -801,14 +671,12 @@ export class Popover {
                     "tags": [],
                     "text": "Describes what kind of interaction with the trigger that\nshould cause the popover to open. Does not apply when the `trigger`\nproperty is `undefined`.\nIf `\"click\"`, the popover will be presented when the trigger is left clicked.\nIf `\"hover\"`, the popover will be presented when a pointer hovers over the trigger.\nIf `\"context-menu\"`, the popover will be presented when the trigger is right\nclicked on desktop and long pressed on mobile. This will also prevent your\ndevice's normal context menu from appearing."
                 },
-                "getter": false,
-                "setter": false,
+                "attribute": "trigger-action",
                 "reflect": false,
                 "defaultValue": "'click'"
             },
             "trigger": {
                 "type": "string",
-                "attribute": "trigger",
                 "mutable": false,
                 "complexType": {
                     "original": "string | undefined",
@@ -821,13 +689,11 @@ export class Popover {
                     "tags": [],
                     "text": "An ID corresponding to the trigger element that\ncauses the popover to open. Use the `trigger-action`\nproperty to customize the interaction that results in\nthe popover opening."
                 },
-                "getter": false,
-                "setter": false,
+                "attribute": "trigger",
                 "reflect": false
             },
             "size": {
                 "type": "string",
-                "attribute": "size",
                 "mutable": false,
                 "complexType": {
                     "original": "PopoverSize",
@@ -846,14 +712,12 @@ export class Popover {
                     "tags": [],
                     "text": "Describes how to calculate the popover width.\nIf `\"cover\"`, the popover width will match the width of the trigger.\nIf `\"auto\"`, the popover width will be set to a static default value."
                 },
-                "getter": false,
-                "setter": false,
+                "attribute": "size",
                 "reflect": false,
                 "defaultValue": "'auto'"
             },
             "dismissOnSelect": {
                 "type": "boolean",
-                "attribute": "dismiss-on-select",
                 "mutable": false,
                 "complexType": {
                     "original": "boolean",
@@ -866,14 +730,12 @@ export class Popover {
                     "tags": [],
                     "text": "If `true`, the popover will be automatically\ndismissed when the content has been clicked."
                 },
-                "getter": false,
-                "setter": false,
+                "attribute": "dismiss-on-select",
                 "reflect": false,
                 "defaultValue": "false"
             },
             "reference": {
                 "type": "string",
-                "attribute": "reference",
                 "mutable": false,
                 "complexType": {
                     "original": "PositionReference",
@@ -892,14 +754,12 @@ export class Popover {
                     "tags": [],
                     "text": "Describes what to position the popover relative to.\nIf `\"trigger\"`, the popover will be positioned relative\nto the trigger button. If passing in an event, this is\ndetermined via event.target.\nIf `\"event\"`, the popover will be positioned relative\nto the x/y coordinates of the trigger action. If passing\nin an event, this is determined via event.clientX and event.clientY."
                 },
-                "getter": false,
-                "setter": false,
+                "attribute": "reference",
                 "reflect": false,
                 "defaultValue": "'trigger'"
             },
             "side": {
                 "type": "string",
-                "attribute": "side",
                 "mutable": false,
                 "complexType": {
                     "original": "PositionSide",
@@ -918,14 +778,12 @@ export class Popover {
                     "tags": [],
                     "text": "Describes which side of the `reference` point to position\nthe popover on. The `\"start\"` and `\"end\"` values are RTL-aware,\nand the `\"left\"` and `\"right\"` values are not."
                 },
-                "getter": false,
-                "setter": false,
+                "attribute": "side",
                 "reflect": false,
                 "defaultValue": "'bottom'"
             },
             "alignment": {
                 "type": "string",
-                "attribute": "alignment",
                 "mutable": true,
                 "complexType": {
                     "original": "PositionAlign",
@@ -944,13 +802,11 @@ export class Popover {
                     "tags": [],
                     "text": "Describes how to align the popover content with the `reference` point.\nDefaults to `\"center\"` for `ios` mode, and `\"start\"` for `md` mode."
                 },
-                "getter": false,
-                "setter": false,
+                "attribute": "alignment",
                 "reflect": false
             },
             "arrow": {
                 "type": "boolean",
-                "attribute": "arrow",
                 "mutable": false,
                 "complexType": {
                     "original": "boolean",
@@ -963,14 +819,12 @@ export class Popover {
                     "tags": [],
                     "text": "If `true`, the popover will display an arrow that points at the\n`reference` when running in `ios` mode. Does not apply in `md` mode."
                 },
-                "getter": false,
-                "setter": false,
+                "attribute": "arrow",
                 "reflect": false,
                 "defaultValue": "true"
             },
             "isOpen": {
                 "type": "boolean",
-                "attribute": "is-open",
                 "mutable": false,
                 "complexType": {
                     "original": "boolean",
@@ -983,14 +837,12 @@ export class Popover {
                     "tags": [],
                     "text": "If `true`, the popover will open. If `false`, the popover will close.\nUse this if you need finer grained control over presentation, otherwise\njust use the popoverController or the `trigger` property.\nNote: `isOpen` will not automatically be set back to `false` when\nthe popover dismisses. You will need to do that in your code."
                 },
-                "getter": false,
-                "setter": false,
+                "attribute": "is-open",
                 "reflect": false,
                 "defaultValue": "false"
             },
             "keyboardEvents": {
                 "type": "boolean",
-                "attribute": "keyboard-events",
                 "mutable": false,
                 "complexType": {
                     "original": "boolean",
@@ -1006,14 +858,12 @@ export class Popover {
                         }],
                     "text": ""
                 },
-                "getter": false,
-                "setter": false,
+                "attribute": "keyboard-events",
                 "reflect": false,
                 "defaultValue": "false"
             },
             "focusTrap": {
                 "type": "boolean",
-                "attribute": "focus-trap",
                 "mutable": false,
                 "complexType": {
                     "original": "boolean",
@@ -1026,14 +876,12 @@ export class Popover {
                     "tags": [],
                     "text": "If `true`, focus will not be allowed to move outside of this overlay.\nIf `false`, focus will be allowed to move outside of the overlay.\n\nIn most scenarios this property should remain set to `true`. Setting\nthis property to `false` can cause severe accessibility issues as users\nrelying on assistive technologies may be able to move focus into\na confusing state. We recommend only setting this to `false` when\nabsolutely necessary.\n\nDevelopers may want to consider disabling focus trapping if this\noverlay presents a non-Ionic overlay from a 3rd party library.\nDevelopers would disable focus trapping on the Ionic overlay\nwhen presenting the 3rd party overlay and then re-enable\nfocus trapping when dismissing the 3rd party overlay and moving\nfocus back to the Ionic overlay."
                 },
-                "getter": false,
-                "setter": false,
+                "attribute": "focus-trap",
                 "reflect": false,
                 "defaultValue": "true"
             },
             "keepContentsMounted": {
                 "type": "boolean",
-                "attribute": "keep-contents-mounted",
                 "mutable": false,
                 "complexType": {
                     "original": "boolean",
@@ -1046,8 +894,7 @@ export class Popover {
                     "tags": [],
                     "text": "If `true`, the component passed into `ion-popover` will\nautomatically be mounted when the popover is created. The\ncomponent will remain mounted even when the popover is dismissed.\nHowever, the component will be destroyed when the popover is\ndestroyed. This property is not reactive and should only be\nused when initially creating a popover.\n\nNote: This feature only applies to inline popovers in JavaScript\nframeworks such as Angular, React, and Vue."
                 },
-                "getter": false,
-                "setter": false,
+                "attribute": "keep-contents-mounted",
                 "reflect": false,
                 "defaultValue": "false"
             }