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

package/dist/collection/components/checkbox/checkbox.js

@@ -18,6 +18,38 @@ export class Checkbox {
     constructor() {
         this.inputId = `ion-cb-${checkboxIds++}`;
         this.inheritedAttributes = {};
+        /**
+         * The name of the control, which is submitted with the form data.
+         */
+        this.name = this.inputId;
+        /**
+         * If `true`, the checkbox is selected.
+         */
+        this.checked = false;
+        /**
+         * If `true`, the checkbox will visually appear as indeterminate.
+         */
+        this.indeterminate = false;
+        /**
+         * If `true`, the user cannot interact with the checkbox.
+         */
+        this.disabled = false;
+        /**
+         * The value of the checkbox does not mean if it's checked or not, use the `checked`
+         * property for that.
+         *
+         * The value of a checkbox is analogous to the value of an `<input type="checkbox">`,
+         * it's only used when the checkbox participates in a native `<form>`.
+         */
+        this.value = 'on';
+        /**
+         * Where to place the label relative to the checkbox.
+         * `"start"`: The label will appear to the left of the checkbox in LTR and to the right in RTL.
+         * `"end"`: The label will appear to the right of the checkbox 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 checkbox regardless of the direction. The alignment of the label can be controlled with the `alignment` property.
+         */
+        this.labelPlacement = 'start';
         /**
          * Sets the checked property and emits
          * the ionChange event. Use this to update the
@@ -49,15 +81,6 @@ export class Checkbox {
             }
             this.toggleChecked(ev);
         };
-        this.color = undefined;
-        this.name = this.inputId;
-        this.checked = false;
-        this.indeterminate = false;
-        this.disabled = false;
-        this.value = 'on';
-        this.labelPlacement = 'start';
-        this.justify = undefined;
-        this.alignment = undefined;
     }
     componentWillLoad() {
         this.inheritedAttributes = Object.assign({}, inheritAriaAttributes(this.el));
@@ -131,6 +154,8 @@ export class Checkbox {
                     "tags": [],
                     "text": "The color to use from your application's color palette.\nDefault options are: `\"primary\"`, `\"secondary\"`, `\"tertiary\"`, `\"success\"`, `\"warning\"`, `\"danger\"`, `\"light\"`, `\"medium\"`, and `\"dark\"`.\nFor more information on colors, see [theming](/docs/theming/basics)."
                 },
+                "getter": false,
+                "setter": false,
                 "attribute": "color",
                 "reflect": true
             },
@@ -148,6 +173,8 @@ export class Checkbox {
                     "tags": [],
                     "text": "The name of the control, which is submitted with the form data."
                 },
+                "getter": false,
+                "setter": false,
                 "attribute": "name",
                 "reflect": false,
                 "defaultValue": "this.inputId"
@@ -166,6 +193,8 @@ export class Checkbox {
                     "tags": [],
                     "text": "If `true`, the checkbox is selected."
                 },
+                "getter": false,
+                "setter": false,
                 "attribute": "checked",
                 "reflect": false,
                 "defaultValue": "false"
@@ -184,6 +213,8 @@ export class Checkbox {
                     "tags": [],
                     "text": "If `true`, the checkbox will visually appear as indeterminate."
                 },
+                "getter": false,
+                "setter": false,
                 "attribute": "indeterminate",
                 "reflect": false,
                 "defaultValue": "false"
@@ -202,6 +233,8 @@ export class Checkbox {
                     "tags": [],
                     "text": "If `true`, the user cannot interact with the checkbox."
                 },
+                "getter": false,
+                "setter": false,
                 "attribute": "disabled",
                 "reflect": false,
                 "defaultValue": "false"
@@ -220,6 +253,8 @@ export class Checkbox {
                     "tags": [],
                     "text": "The value of the checkbox does not mean if it's checked or not, use the `checked`\nproperty for that.\n\nThe value of a checkbox is analogous to the value of an `<input type=\"checkbox\">`,\nit's only used when the checkbox participates in a native `<form>`."
                 },
+                "getter": false,
+                "setter": false,
                 "attribute": "value",
                 "reflect": false,
                 "defaultValue": "'on'"
@@ -238,6 +273,8 @@ export class Checkbox {
                     "tags": [],
                     "text": "Where to place the label relative to the checkbox.\n`\"start\"`: The label will appear to the left of the checkbox in LTR and to the right in RTL.\n`\"end\"`: The label will appear to the right of the checkbox in LTR and to the left in RTL.\n`\"fixed\"`: The label has the same behavior as `\"start\"` except it also has a fixed width. Long text will be truncated with ellipses (\"...\").\n`\"stacked\"`: The label will appear above the checkbox regardless of the direction. The alignment of the label can be controlled with the `alignment` property."
                 },
+                "getter": false,
+                "setter": false,
                 "attribute": "label-placement",
                 "reflect": false,
                 "defaultValue": "'start'"
@@ -256,6 +293,8 @@ export class Checkbox {
                     "tags": [],
                     "text": "How to pack the label and checkbox within a line.\n`\"start\"`: The label and checkbox will appear on the left in LTR and\non the right in RTL.\n`\"end\"`: The label and checkbox will appear on the right in LTR and\non the left in RTL.\n`\"space-between\"`: The label and checkbox will appear on opposite\nends of the line with space between the two elements.\nSetting this property will change the checkbox `display` to `block`."
                 },
+                "getter": false,
+                "setter": false,
                 "attribute": "justify",
                 "reflect": false
             },
@@ -273,6 +312,8 @@ export class Checkbox {
                     "tags": [],
                     "text": "How to control the alignment of the checkbox and label on the cross axis.\n`\"start\"`: The label and control will appear on the left of the cross axis in LTR, and on the right side in RTL.\n`\"center\"`: The label and control will appear at the center of the cross axis in both LTR and RTL.\nSetting this property will change the checkbox `display` to `block`."
                 },
+                "getter": false,
+                "setter": false,
                 "attribute": "alignment",
                 "reflect": false
             }

package/dist/collection/components/chip/chip.js

@@ -9,8 +9,13 @@ import { getIonMode } from "../../global/ionic-global";
  */
 export class Chip {
     constructor() {
-        this.color = undefined;
+        /**
+         * Display an outline style button.
+         */
         this.outline = false;
+        /**
+         * If `true`, the user cannot interact with the chip.
+         */
         this.disabled = false;
     }
     render() {
@@ -58,6 +63,8 @@ export class Chip {
                     "tags": [],
                     "text": "The color to use from your application's color palette.\nDefault options are: `\"primary\"`, `\"secondary\"`, `\"tertiary\"`, `\"success\"`, `\"warning\"`, `\"danger\"`, `\"light\"`, `\"medium\"`, and `\"dark\"`.\nFor more information on colors, see [theming](/docs/theming/basics)."
                 },
+                "getter": false,
+                "setter": false,
                 "attribute": "color",
                 "reflect": true
             },
@@ -75,6 +82,8 @@ export class Chip {
                     "tags": [],
                     "text": "Display an outline style button."
                 },
+                "getter": false,
+                "setter": false,
                 "attribute": "outline",
                 "reflect": false,
                 "defaultValue": "false"
@@ -93,6 +102,8 @@ export class Chip {
                     "tags": [],
                     "text": "If `true`, the user cannot interact with the chip."
                 },
+                "getter": false,
+                "setter": false,
                 "attribute": "disabled",
                 "reflect": false,
                 "defaultValue": "false"

package/dist/collection/components/col/col.js

@@ -9,32 +9,6 @@ const win = typeof window !== 'undefined' ? window : undefined;
 const SUPPORTS_VARS = win && !!(win.CSS && win.CSS.supports && win.CSS.supports('--a: 0'));
 const BREAKPOINTS = ['', 'xs', 'sm', 'md', 'lg', 'xl'];
 export class Col {
-    constructor() {
-        this.offset = undefined;
-        this.offsetXs = undefined;
-        this.offsetSm = undefined;
-        this.offsetMd = undefined;
-        this.offsetLg = undefined;
-        this.offsetXl = undefined;
-        this.pull = undefined;
-        this.pullXs = undefined;
-        this.pullSm = undefined;
-        this.pullMd = undefined;
-        this.pullLg = undefined;
-        this.pullXl = undefined;
-        this.push = undefined;
-        this.pushXs = undefined;
-        this.pushSm = undefined;
-        this.pushMd = undefined;
-        this.pushLg = undefined;
-        this.pushXl = undefined;
-        this.size = undefined;
-        this.sizeXs = undefined;
-        this.sizeSm = undefined;
-        this.sizeMd = undefined;
-        this.sizeLg = undefined;
-        this.sizeXl = undefined;
-    }
     onResize() {
         forceUpdate(this);
     }
@@ -143,6 +117,8 @@ export class Col {
                     "tags": [],
                     "text": "The amount to offset the column, in terms of how many columns it should shift to the end\nof the total available."
                 },
+                "getter": false,
+                "setter": false,
                 "attribute": "offset",
                 "reflect": false
             },
@@ -160,6 +136,8 @@ export class Col {
                     "tags": [],
                     "text": "The amount to offset the column for xs screens, in terms of how many columns it should shift\nto the end of the total available."
                 },
+                "getter": false,
+                "setter": false,
                 "attribute": "offset-xs",
                 "reflect": false
             },
@@ -177,6 +155,8 @@ export class Col {
                     "tags": [],
                     "text": "The amount to offset the column for sm screens, in terms of how many columns it should shift\nto the end of the total available."
                 },
+                "getter": false,
+                "setter": false,
                 "attribute": "offset-sm",
                 "reflect": false
             },
@@ -194,6 +174,8 @@ export class Col {
                     "tags": [],
                     "text": "The amount to offset the column for md screens, in terms of how many columns it should shift\nto the end of the total available."
                 },
+                "getter": false,
+                "setter": false,
                 "attribute": "offset-md",
                 "reflect": false
             },
@@ -211,6 +193,8 @@ export class Col {
                     "tags": [],
                     "text": "The amount to offset the column for lg screens, in terms of how many columns it should shift\nto the end of the total available."
                 },
+                "getter": false,
+                "setter": false,
                 "attribute": "offset-lg",
                 "reflect": false
             },
@@ -228,6 +212,8 @@ export class Col {
                     "tags": [],
                     "text": "The amount to offset the column for xl screens, in terms of how many columns it should shift\nto the end of the total available."
                 },
+                "getter": false,
+                "setter": false,
                 "attribute": "offset-xl",
                 "reflect": false
             },
@@ -245,6 +231,8 @@ export class Col {
                     "tags": [],
                     "text": "The amount to pull the column, in terms of how many columns it should shift to the start of\nthe total available."
                 },
+                "getter": false,
+                "setter": false,
                 "attribute": "pull",
                 "reflect": false
             },
@@ -262,6 +250,8 @@ export class Col {
                     "tags": [],
                     "text": "The amount to pull the column for xs screens, in terms of how many columns it should shift\nto the start of the total available."
                 },
+                "getter": false,
+                "setter": false,
                 "attribute": "pull-xs",
                 "reflect": false
             },
@@ -279,6 +269,8 @@ export class Col {
                     "tags": [],
                     "text": "The amount to pull the column for sm screens, in terms of how many columns it should shift\nto the start of the total available."
                 },
+                "getter": false,
+                "setter": false,
                 "attribute": "pull-sm",
                 "reflect": false
             },
@@ -296,6 +288,8 @@ export class Col {
                     "tags": [],
                     "text": "The amount to pull the column for md screens, in terms of how many columns it should shift\nto the start of the total available."
                 },
+                "getter": false,
+                "setter": false,
                 "attribute": "pull-md",
                 "reflect": false
             },
@@ -313,6 +307,8 @@ export class Col {
                     "tags": [],
                     "text": "The amount to pull the column for lg screens, in terms of how many columns it should shift\nto the start of the total available."
                 },
+                "getter": false,
+                "setter": false,
                 "attribute": "pull-lg",
                 "reflect": false
             },
@@ -330,6 +326,8 @@ export class Col {
                     "tags": [],
                     "text": "The amount to pull the column for xl screens, in terms of how many columns it should shift\nto the start of the total available."
                 },
+                "getter": false,
+                "setter": false,
                 "attribute": "pull-xl",
                 "reflect": false
             },
@@ -347,6 +345,8 @@ export class Col {
                     "tags": [],
                     "text": "The amount to push the column, in terms of how many columns it should shift to the end\nof the total available."
                 },
+                "getter": false,
+                "setter": false,
                 "attribute": "push",
                 "reflect": false
             },
@@ -364,6 +364,8 @@ export class Col {
                     "tags": [],
                     "text": "The amount to push the column for xs screens, in terms of how many columns it should shift\nto the end of the total available."
                 },
+                "getter": false,
+                "setter": false,
                 "attribute": "push-xs",
                 "reflect": false
             },
@@ -381,6 +383,8 @@ export class Col {
                     "tags": [],
                     "text": "The amount to push the column for sm screens, in terms of how many columns it should shift\nto the end of the total available."
                 },
+                "getter": false,
+                "setter": false,
                 "attribute": "push-sm",
                 "reflect": false
             },
@@ -398,6 +402,8 @@ export class Col {
                     "tags": [],
                     "text": "The amount to push the column for md screens, in terms of how many columns it should shift\nto the end of the total available."
                 },
+                "getter": false,
+                "setter": false,
                 "attribute": "push-md",
                 "reflect": false
             },
@@ -415,6 +421,8 @@ export class Col {
                     "tags": [],
                     "text": "The amount to push the column for lg screens, in terms of how many columns it should shift\nto the end of the total available."
                 },
+                "getter": false,
+                "setter": false,
                 "attribute": "push-lg",
                 "reflect": false
             },
@@ -432,6 +440,8 @@ export class Col {
                     "tags": [],
                     "text": "The amount to push the column for xl screens, in terms of how many columns it should shift\nto the end of the total available."
                 },
+                "getter": false,
+                "setter": false,
                 "attribute": "push-xl",
                 "reflect": false
             },
@@ -449,6 +459,8 @@ export class Col {
                     "tags": [],
                     "text": "The size of the column, in terms of how many columns it should take up out of the total\navailable. If `\"auto\"` is passed, the column will be the size of its content."
                 },
+                "getter": false,
+                "setter": false,
                 "attribute": "size",
                 "reflect": false
             },
@@ -466,6 +478,8 @@ export class Col {
                     "tags": [],
                     "text": "The size of the column for xs screens, in terms of how many columns it should take up out\nof the total available. If `\"auto\"` is passed, the column will be the size of its content."
                 },
+                "getter": false,
+                "setter": false,
                 "attribute": "size-xs",
                 "reflect": false
             },
@@ -483,6 +497,8 @@ export class Col {
                     "tags": [],
                     "text": "The size of the column for sm screens, in terms of how many columns it should take up out\nof the total available. If `\"auto\"` is passed, the column will be the size of its content."
                 },
+                "getter": false,
+                "setter": false,
                 "attribute": "size-sm",
                 "reflect": false
             },
@@ -500,6 +516,8 @@ export class Col {
                     "tags": [],
                     "text": "The size of the column for md screens, in terms of how many columns it should take up out\nof the total available. If `\"auto\"` is passed, the column will be the size of its content."
                 },
+                "getter": false,
+                "setter": false,
                 "attribute": "size-md",
                 "reflect": false
             },
@@ -517,6 +535,8 @@ export class Col {
                     "tags": [],
                     "text": "The size of the column for lg screens, in terms of how many columns it should take up out\nof the total available. If `\"auto\"` is passed, the column will be the size of its content."
                 },
+                "getter": false,
+                "setter": false,
                 "attribute": "size-lg",
                 "reflect": false
             },
@@ -534,6 +554,8 @@ export class Col {
                     "tags": [],
                     "text": "The size of the column for xl screens, in terms of how many columns it should take up out\nof the total available. If `\"auto\"` is passed, the column will be the size of its content."
                 },
+                "getter": false,
+                "setter": false,
                 "attribute": "size-xl",
                 "reflect": false
             }

package/dist/collection/components/content/content.js

@@ -47,12 +47,32 @@ export class Content {
             data: undefined,
             isScrolling: true,
         };
-        this.color = undefined;
+        /**
+         * If `true`, the content will scroll behind the headers
+         * and footers. This effect can easily be seen by setting the toolbar
+         * to transparent.
+         */
         this.fullscreen = false;
+        /**
+         * Controls where the fixed content is placed relative to the main content
+         * in the DOM. This can be used to control the order in which fixed elements
+         * receive keyboard focus.
+         * For example, if a FAB in the fixed slot should receive keyboard focus before
+         * the main page content, set this property to `'before'`.
+         */
         this.fixedSlotPlacement = 'after';
-        this.forceOverscroll = undefined;
+        /**
+         * If you want to enable the content scrolling in the X axis, set this property to `true`.
+         */
         this.scrollX = false;
+        /**
+         * If you want to disable the content scrolling in the Y axis, set this property to `false`.
+         */
         this.scrollY = true;
+        /**
+         * Because of performance reasons, ionScroll events are disabled by default, in order to enable them
+         * and start listening from (ionScroll), set this property to `true`.
+         */
         this.scrollEvents = false;
     }
     componentWillLoad() {
@@ -389,6 +409,8 @@ export class Content {
                     "tags": [],
                     "text": "The color to use from your application's color palette.\nDefault options are: `\"primary\"`, `\"secondary\"`, `\"tertiary\"`, `\"success\"`, `\"warning\"`, `\"danger\"`, `\"light\"`, `\"medium\"`, and `\"dark\"`.\nFor more information on colors, see [theming](/docs/theming/basics)."
                 },
+                "getter": false,
+                "setter": false,
                 "attribute": "color",
                 "reflect": true
             },
@@ -406,6 +428,8 @@ export class Content {
                     "tags": [],
                     "text": "If `true`, the content will scroll behind the headers\nand footers. This effect can easily be seen by setting the toolbar\nto transparent."
                 },
+                "getter": false,
+                "setter": false,
                 "attribute": "fullscreen",
                 "reflect": false,
                 "defaultValue": "false"
@@ -424,6 +448,8 @@ export class Content {
                     "tags": [],
                     "text": "Controls where the fixed content is placed relative to the main content\nin the DOM. This can be used to control the order in which fixed elements\nreceive keyboard focus.\nFor example, if a FAB in the fixed slot should receive keyboard focus before\nthe main page content, set this property to `'before'`."
                 },
+                "getter": false,
+                "setter": false,
                 "attribute": "fixed-slot-placement",
                 "reflect": false,
                 "defaultValue": "'after'"
@@ -442,6 +468,8 @@ export class Content {
                     "tags": [],
                     "text": "If `true` and the content does not cause an overflow scroll, the scroll interaction will cause a bounce.\nIf the content exceeds the bounds of ionContent, nothing will change.\nNote, this does not disable the system bounce on iOS. That is an OS level setting."
                 },
+                "getter": false,
+                "setter": false,
                 "attribute": "force-overscroll",
                 "reflect": false
             },
@@ -459,6 +487,8 @@ export class Content {
                     "tags": [],
                     "text": "If you want to enable the content scrolling in the X axis, set this property to `true`."
                 },
+                "getter": false,
+                "setter": false,
                 "attribute": "scroll-x",
                 "reflect": false,
                 "defaultValue": "false"
@@ -477,6 +507,8 @@ export class Content {
                     "tags": [],
                     "text": "If you want to disable the content scrolling in the Y axis, set this property to `false`."
                 },
+                "getter": false,
+                "setter": false,
                 "attribute": "scroll-y",
                 "reflect": false,
                 "defaultValue": "true"
@@ -495,6 +527,8 @@ export class Content {
                     "tags": [],
                     "text": "Because of performance reasons, ionScroll events are disabled by default, in order to enable them\nand start listening from (ionScroll), set this property to `true`."
                 },
+                "getter": false,
+                "setter": false,
                 "attribute": "scroll-events",
                 "reflect": false,
                 "defaultValue": "false"