@ionic/core 8.4.2-dev.11736277041.14f34ba1 → 8.4.2-dev.11736797843.16cc5058

package/components/ion-loading.js

@@ -123,26 +123,45 @@ const Loading = /*@__PURE__*/ proxyCustomElement(class Loading extends HTMLEleme
         this.triggerController = createTriggerController();
         this.customHTMLEnabled = config.get('innerHTMLTemplatesEnabled', ENABLE_HTML_CONTENT_DEFAULT);
         this.presented = false;
-        this.onBackdropTap = () => {
-            this.dismiss(undefined, BACKDROP);
-        };
-        this.overlayIndex = undefined;
-        this.delegate = undefined;
+        /** @internal */
         this.hasController = false;
+        /**
+         * If `true`, the keyboard will be automatically dismissed when the overlay is presented.
+         */
         this.keyboardClose = true;
-        this.enterAnimation = undefined;
-        this.leaveAnimation = undefined;
-        this.message = undefined;
-        this.cssClass = undefined;
+        /**
+         * Number of milliseconds to wait before dismissing the loading indicator.
+         */
         this.duration = 0;
+        /**
+         * If `true`, the loading indicator will be dismissed when the backdrop is clicked.
+         */
         this.backdropDismiss = false;
+        /**
+         * If `true`, a backdrop will be displayed behind the loading indicator.
+         */
         this.showBackdrop = true;
-        this.spinner = undefined;
+        /**
+         * If `true`, the loading indicator 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 loading indicator will animate.
+         */
         this.animated = true;
-        this.htmlAttributes = undefined;
+        /**
+         * If `true`, the loading indicator will open. If `false`, the loading indicator will close.
+         * Use this if you need finer grained control over presentation, otherwise
+         * just use the loadingController or the `trigger` property.
+         * Note: `isOpen` will not automatically be set back to `false` when
+         * the loading indicator dismisses. You will need to do that in your code.
+         */
         this.isOpen = false;
-        this.trigger = undefined;
+        this.onBackdropTap = () => {
+            this.dismiss(undefined, BACKDROP);
+        };
     }
     onIsOpenChange(newValue, oldValue) {
         if (newValue === true && oldValue === false) {

package/components/ion-menu-button.js

@@ -23,15 +23,22 @@ const MenuButton = /*@__PURE__*/ proxyCustomElement(class MenuButton extends HTM
         this.__registerHost();
         this.__attachShadow();
         this.inheritedAttributes = {};
-        this.onClick = async () => {
-            return menuController.toggle(this.menu);
-        };
         this.visible = false;
-        this.color = undefined;
+        /**
+         * If `true`, the user cannot interact with the menu button.
+         */
         this.disabled = false;
-        this.menu = undefined;
+        /**
+         * Automatically hides the menu button when the corresponding menu is not active
+         */
         this.autoHide = true;
+        /**
+         * The type of the button.
+         */
         this.type = 'button';
+        this.onClick = async () => {
+            return menuController.toggle(this.menu);
+        };
     }
     componentWillLoad() {
         this.inheritedAttributes = inheritAriaAttributes(this.el);

package/components/ion-menu-toggle.js

@@ -14,12 +14,17 @@ const MenuToggle = /*@__PURE__*/ proxyCustomElement(class MenuToggle extends HTM
         super();
         this.__registerHost();
         this.__attachShadow();
+        this.visible = false;
+        /**
+         * Automatically hides the content when the corresponding menu is not active.
+         *
+         * By default, it's `true`. Change it to `false` in order to
+         * keep `ion-menu-toggle` always visible regardless the state of the menu.
+         */
+        this.autoHide = true;
         this.onClick = () => {
             return menuController.toggle(this.menu);
         };
-        this.visible = false;
-        this.menu = undefined;
-        this.autoHide = true;
     }
     connectedCallback() {
         this.visibilityChanged();

package/components/ion-menu.js

@@ -60,14 +60,32 @@ const Menu = /*@__PURE__*/ proxyCustomElement(class Menu extends HTMLElement {
             }
             this.trapKeyboardFocus(ev, document);
         };
+        /**
+         * If true, then the menu should be
+         * visible within a split pane.
+         * If false, then the menu is hidden.
+         * However, the menu-button/menu-toggle
+         * components can be used to open the
+         * menu.
+         */
         this.isPaneVisible = false;
         this.isEndSide = false;
-        this.contentId = undefined;
-        this.menuId = undefined;
-        this.type = undefined;
+        /**
+         * If `true`, the menu is disabled.
+         */
         this.disabled = false;
+        /**
+         * Which side of the view the menu should be placed.
+         */
         this.side = 'start';
+        /**
+         * If `true`, swiping the menu is enabled.
+         */
         this.swipeGesture = true;
+        /**
+         * The edge threshold for dragging the menu open.
+         * If a drag/swipe happens over this value, the menu is not triggered.
+         */
         this.maxEdgeStart = 50;
     }
     typeChanged(type, oldType) {

package/components/ion-nav-link.js

@@ -27,13 +27,13 @@ const NavLink = /*@__PURE__*/ proxyCustomElement(class NavLink extends HTMLEleme
     constructor() {
         super();
         this.__registerHost();
+        /**
+         * The transition direction when navigating to another page.
+         */
+        this.routerDirection = 'forward';
         this.onClick = () => {
             return navLink(this.el, this.routerDirection, this.component, this.componentProps, this.routerAnimation);
         };
-        this.component = undefined;
-        this.componentProps = undefined;
-        this.routerDirection = 'forward';
-        this.routerAnimation = undefined;
     }
     render() {
         return h(Host, { key: 'd2f8545b4fbd5aa25ef36eb01dffbc5d35ccfbb9', onClick: this.onClick });

package/components/ion-nav.js

@@ -94,12 +94,10 @@ const Nav = /*@__PURE__*/ proxyCustomElement(class Nav extends HTMLElement {
         this.destroyed = false;
         this.views = [];
         this.didLoad = false;
-        this.delegate = undefined;
-        this.swipeGesture = undefined;
+        /**
+         * If `true`, the nav should animate the transition of components.
+         */
         this.animated = true;
-        this.animation = undefined;
-        this.rootParams = undefined;
-        this.root = undefined;
     }
     swipeGestureChanged() {
         if (this.gesture) {

package/components/ion-note.js

@@ -16,7 +16,6 @@ const Note = /*@__PURE__*/ proxyCustomElement(class Note extends HTMLElement {
         super();
         this.__registerHost();
         this.__attachShadow();
-        this.color = undefined;
     }
     render() {
         const mode = getIonMode(this);

package/components/ion-picker-legacy.js

@@ -77,33 +77,55 @@ const Picker = /*@__PURE__*/ proxyCustomElement(class Picker extends HTMLElement
         this.delegateController = createDelegateController(this);
         this.lockController = createLockController();
         this.triggerController = createTriggerController();
-        this.onBackdropTap = () => {
-            this.dismiss(undefined, BACKDROP);
-        };
-        this.dispatchCancelHandler = (ev) => {
-            const role = ev.detail.role;
-            if (isCancel(role)) {
-                const cancelButton = this.buttons.find((b) => b.role === 'cancel');
-                this.callButtonHandler(cancelButton);
-            }
-        };
         this.presented = false;
-        this.overlayIndex = undefined;
-        this.delegate = undefined;
+        /** @internal */
         this.hasController = false;
+        /**
+         * If `true`, the keyboard will be automatically dismissed when the overlay is presented.
+         */
         this.keyboardClose = true;
-        this.enterAnimation = undefined;
-        this.leaveAnimation = undefined;
+        /**
+         * Array of buttons to be displayed at the top of the picker.
+         */
         this.buttons = [];
+        /**
+         * Array of columns to be displayed in the picker.
+         */
         this.columns = [];
-        this.cssClass = undefined;
+        /**
+         * Number of milliseconds to wait before dismissing the picker.
+         */
         this.duration = 0;
+        /**
+         * If `true`, a backdrop will be displayed behind the picker.
+         */
         this.showBackdrop = true;
+        /**
+         * If `true`, the picker will be dismissed when the backdrop is clicked.
+         */
         this.backdropDismiss = true;
+        /**
+         * If `true`, the picker will animate.
+         */
         this.animated = true;
-        this.htmlAttributes = undefined;
+        /**
+         * If `true`, the picker will open. If `false`, the picker will close.
+         * Use this if you need finer grained control over presentation, otherwise
+         * just use the pickerController or the `trigger` property.
+         * Note: `isOpen` will not automatically be set back to `false` when
+         * the picker dismisses. You will need to do that in your code.
+         */
         this.isOpen = false;
-        this.trigger = undefined;
+        this.onBackdropTap = () => {
+            this.dismiss(undefined, BACKDROP);
+        };
+        this.dispatchCancelHandler = (ev) => {
+            const role = ev.detail.role;
+            if (isCancel(role)) {
+                const cancelButton = this.buttons.find((b) => b.role === 'cancel');
+                this.callButtonHandler(cancelButton);
+            }
+        };
     }
     onIsOpenChange(newValue, oldValue) {
         if (newValue === true && oldValue === false) {

package/components/ion-progress-bar.js

@@ -17,11 +17,26 @@ const ProgressBar = /*@__PURE__*/ proxyCustomElement(class ProgressBar extends H
         super();
         this.__registerHost();
         this.__attachShadow();
+        /**
+         * The state of the progress bar, based on if the time the process takes is known or not.
+         * Default options are: `"determinate"` (no animation), `"indeterminate"` (animate from left to right).
+         */
         this.type = 'determinate';
+        /**
+         * If true, reverse the progress bar direction.
+         */
         this.reversed = false;
+        /**
+         * The value determines how much of the active bar should display when the
+         * `type` is `"determinate"`.
+         * The value should be between [0, 1].
+         */
         this.value = 0;
+        /**
+         * If the buffer and value are smaller than 1, the buffer circles will show.
+         * The buffer should be between [0, 1].
+         */
         this.buffer = 1;
-        this.color = undefined;
     }
     render() {
         const { color, type, reversed, value, buffer } = this;

package/components/ion-range.js

@@ -75,6 +75,59 @@ const Range = /*@__PURE__*/ proxyCustomElement(class Range extends HTMLElement {
         this.inheritedAttributes = {};
         this.contentEl = null;
         this.initialContentScrollY = true;
+        this.ratioA = 0;
+        this.ratioB = 0;
+        /**
+         * The name of the control, which is submitted with the form data.
+         */
+        this.name = this.rangeId;
+        /**
+         * Show two knobs.
+         */
+        this.dualKnobs = false;
+        /**
+         * Minimum integer value of the range.
+         */
+        this.min = 0;
+        /**
+         * Maximum integer value of the range.
+         */
+        this.max = 100;
+        /**
+         * If `true`, a pin with integer value is shown when the knob
+         * is pressed.
+         */
+        this.pin = false;
+        /**
+         * A callback used to format the pin text.
+         * By default the pin text is set to `Math.round(value)`.
+         *
+         * See https://ionicframework.com/docs/troubleshooting/runtime#accessing-this
+         * if you need to access `this` from within the callback.
+         */
+        this.pinFormatter = (value) => Math.round(value);
+        /**
+         * If `true`, the knob snaps to tick marks evenly spaced based
+         * on the step property value.
+         */
+        this.snaps = false;
+        /**
+         * Specifies the value granularity.
+         */
+        this.step = 1;
+        /**
+         * If `true`, tick marks are displayed based on the step value.
+         * Only applies when `snaps` is `true`.
+         */
+        this.ticks = true;
+        /**
+         * If `true`, the user cannot interact with the range.
+         */
+        this.disabled = false;
+        /**
+         * the value of the range.
+         */
+        this.value = 0;
         this.clampBounds = (value) => {
             return clamp(this.min, value, this.max);
         };
@@ -89,6 +142,14 @@ const Range = /*@__PURE__*/ proxyCustomElement(class Range extends HTMLElement {
                 return this.clampBounds(value);
             }
         };
+        /**
+         * Where to place the label relative to the range.
+         * `"start"`: The label will appear to the left of the range in LTR and to the right in RTL.
+         * `"end"`: The label will appear to the right of the range in LTR and to the left in RTL.
+         * `"fixed"`: The label has the same behavior as `"start"` except it also has a fixed width. Long text will be truncated with ellipses ("...").
+         * `"stacked"`: The label will appear above the range regardless of the direction.
+         */
+        this.labelPlacement = 'start';
         this.setupGesture = async () => {
             const rangeSlider = this.rangeSlider;
             if (rangeSlider) {
@@ -141,25 +202,6 @@ const Range = /*@__PURE__*/ proxyCustomElement(class Range extends HTMLElement {
                 this.ionFocus.emit();
             }
         };
-        this.ratioA = 0;
-        this.ratioB = 0;
-        this.pressedKnob = undefined;
-        this.color = undefined;
-        this.debounce = undefined;
-        this.name = this.rangeId;
-        this.label = undefined;
-        this.dualKnobs = false;
-        this.min = 0;
-        this.max = 100;
-        this.pin = false;
-        this.pinFormatter = (value) => Math.round(value);
-        this.snaps = false;
-        this.step = 1;
-        this.ticks = true;
-        this.activeBarStart = undefined;
-        this.disabled = false;
-        this.value = 0;
-        this.labelPlacement = 'start';
     }
     debounceChanged() {
         const { ionInput, debounce, originalIonInput } = this;

package/components/ion-refresher-content.js

@@ -14,10 +14,6 @@ const RefresherContent = /*@__PURE__*/ proxyCustomElement(class RefresherContent
         super();
         this.__registerHost();
         this.customHTMLEnabled = config.get('innerHTMLTemplatesEnabled', ENABLE_HTML_CONTENT_DEFAULT);
-        this.pullingIcon = undefined;
-        this.pullingText = undefined;
-        this.refreshingSpinner = undefined;
-        this.refreshingText = undefined;
     }
     componentWillLoad() {
         if (this.pullingIcon === undefined) {

package/components/ion-refresher.js

@@ -32,12 +32,62 @@ const Refresher = /*@__PURE__*/ proxyCustomElement(class Refresher extends HTMLE
         this.lastVelocityY = 0;
         this.animations = [];
         this.nativeRefresher = false;
+        /**
+         * The current state which the refresher is in. The refresher's states include:
+         *
+         * - `inactive` - The refresher is not being pulled down or refreshing and is currently hidden.
+         * - `pulling` - The user is actively pulling down the refresher, but has not reached the point yet that if the user lets go, it'll refresh.
+         * - `cancelling` - The user pulled down the refresher and let go, but did not pull down far enough to kick off the `refreshing` state. After letting go, the refresher is in the `cancelling` state while it is closing, and will go back to the `inactive` state once closed.
+         * - `ready` - The user has pulled down the refresher far enough that if they let go, it'll begin the `refreshing` state.
+         * - `refreshing` - The refresher is actively waiting on the async operation to end. Once the refresh handler calls `complete()` it will begin the `completing` state.
+         * - `completing` - The `refreshing` state has finished and the refresher is in the way of closing itself. Once closed, the refresher will go back to the `inactive` state.
+         */
         this.state = 1 /* RefresherState.Inactive */;
+        /**
+         * The minimum distance the user must pull down until the
+         * refresher will go into the `refreshing` state.
+         * Does not apply when the refresher content uses a spinner,
+         * enabling the native refresher.
+         */
         this.pullMin = 60;
+        /**
+         * The maximum distance of the pull until the refresher
+         * will automatically go into the `refreshing` state.
+         * Defaults to the result of `pullMin + 60`.
+         * Does not apply when  the refresher content uses a spinner,
+         * enabling the native refresher.
+         */
         this.pullMax = this.pullMin + 60;
+        /**
+         * Time it takes to close the refresher.
+         * Does not apply when the refresher content uses a spinner,
+         * enabling the native refresher.
+         */
         this.closeDuration = '280ms';
+        /**
+         * Time it takes the refresher to snap back to the `refreshing` state.
+         * Does not apply when the refresher content uses a spinner,
+         * enabling the native refresher.
+         */
         this.snapbackDuration = '280ms';
+        /**
+         * How much to multiply the pull speed by. To slow the pull animation down,
+         * pass a number less than `1`. To speed up the pull, pass a number greater
+         * than `1`. The default value is `1` which is equal to the speed of the cursor.
+         * If a negative value is passed in, the factor will be `1` instead.
+         *
+         * For example: If the value passed is `1.2` and the content is dragged by
+         * `10` pixels, instead of `10` pixels the content will be pulled by `12` pixels
+         * (an increase of 20 percent). If the value passed is `0.8`, the dragged amount
+         * will be `8` pixels, less than the amount the cursor has moved.
+         *
+         * Does not apply when the refresher content uses a spinner,
+         * enabling the native refresher.
+         */
         this.pullFactor = 1;
+        /**
+         * If `true`, the refresher will be hidden.
+         */
         this.disabled = false;
     }
     disabledChanged() {

package/components/ion-reorder-group.js

@@ -23,6 +23,9 @@ const ReorderGroup = /*@__PURE__*/ proxyCustomElement(class ReorderGroup extends
         this.containerTop = 0;
         this.containerBottom = 0;
         this.state = 0 /* ReorderGroupState.Idle */;
+        /**
+         * If `true`, the reorder will be hidden.
+         */
         this.disabled = true;
     }
     disabledChanged() {

package/components/ion-route-redirect.js

@@ -8,8 +8,6 @@ const RouteRedirect = /*@__PURE__*/ proxyCustomElement(class RouteRedirect exten
         super();
         this.__registerHost();
         this.ionRouteRedirectChanged = createEvent(this, "ionRouteRedirectChanged", 7);
-        this.from = undefined;
-        this.to = undefined;
     }
     propDidChange() {
         this.ionRouteRedirectChanged.emit();

package/components/ion-route.js

@@ -8,11 +8,13 @@ const Route = /*@__PURE__*/ proxyCustomElement(class Route extends HTMLElement {
         super();
         this.__registerHost();
         this.ionRouteDataChanged = createEvent(this, "ionRouteDataChanged", 7);
+        /**
+         * Relative path that needs to match in order for this route to apply.
+         *
+         * Accepts paths similar to expressjs so that you can define parameters
+         * in the url /foo/:bar where bar would be available in incoming props.
+         */
         this.url = '';
-        this.component = undefined;
-        this.componentProps = undefined;
-        this.beforeLeave = undefined;
-        this.beforeEnter = undefined;
     }
     onUpdate(newValue) {
         this.ionRouteDataChanged.emit(newValue);

package/components/ion-router-link.js

@@ -13,15 +13,14 @@ const RouterLink = /*@__PURE__*/ proxyCustomElement(class RouterLink extends HTM
         super();
         this.__registerHost();
         this.__attachShadow();
+        /**
+         * When using a router, it specifies the transition direction when navigating to
+         * another page using `href`.
+         */
+        this.routerDirection = 'forward';
         this.onClick = (ev) => {
             openURL(this.href, ev, this.routerDirection, this.routerAnimation);
         };
-        this.color = undefined;
-        this.href = undefined;
-        this.rel = undefined;
-        this.routerDirection = 'forward';
-        this.routerAnimation = undefined;
-        this.target = undefined;
     }
     render() {
         const mode = getIonMode(this);

package/components/ion-router-outlet.js

@@ -22,11 +22,14 @@ const RouterOutlet = /*@__PURE__*/ proxyCustomElement(class RouterOutlet extends
         this.ionNavDidChange = createEvent(this, "ionNavDidChange", 3);
         this.lockController = createLockController();
         this.gestureOrAnimationInProgress = false;
+        /**
+         * The mode determines which platform styles to use.
+         */
         this.mode = getIonMode(this);
-        this.delegate = undefined;
+        /**
+         * If `true`, the router-outlet should animate the transition of components.
+         */
         this.animated = true;
-        this.animation = undefined;
-        this.swipeHandler = undefined;
     }
     swipeHandlerChanged() {
         if (this.gesture) {

package/components/ion-router.js

@@ -537,7 +537,25 @@ const Router = /*@__PURE__*/ proxyCustomElement(class Router extends HTMLElement
         this.busy = false;
         this.state = 0;
         this.lastState = 0;
+        /**
+         * The root path to use when matching URLs. By default, this is set to "/", but you can specify
+         * an alternate prefix for all URL paths.
+         */
         this.root = '/';
+        /**
+         * The router can work in two "modes":
+         * - With hash: `/index.html#/path/to/page`
+         * - Without hash: `/path/to/page`
+         *
+         * Using one or another might depend in the requirements of your app and/or where it's deployed.
+         *
+         * Usually "hash-less" navigation works better for SEO and it's more user friendly too, but it might
+         * requires additional server-side configuration in order to properly work.
+         *
+         * On the other side hash-navigation is much easier to deploy, it even works over the file protocol.
+         *
+         * By default, this property is `true`, change to `false` to allow hash-less URLs.
+         */
         this.useHash = true;
     }
     async componentWillLoad() {