npm - @esri/calcite-components - Versions diffs - 1.0.0-next.574 → 1.0.0-next.577 - Mend

@esri/calcite-components 1.0.0-next.574 → 1.0.0-next.577

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.

Files changed (866) hide show

package/dist/collection/components/tab-title/tab-title.js CHANGED Viewed

@@ -1,7 +1,7 @@
 /*!
  * All material copyright ESRI, All Rights Reserved, unless otherwise specified.
  * See https://github.com/Esri/calcite-components/blob/master/LICENSE.md for details.
- * v1.0.0-next.574
+ * v1.0.0-next.577
  */
 import { Build, Component, Element, Event, h, Host, Listen, Method, Prop, State, Watch } from "@stencil/core";
 import { guid } from "../../utils/guid";
@@ -19,16 +19,20 @@ export class TabTitle {
     //
     //--------------------------------------------------------------------------
     /**
-     * Show this tab title as selected
+     * When true, the component and its respective `calcite-tab` contents are selected.
      *
-     * @deprecated Use selected instead.
+     * Only one tab can be selected within the `calcite-tabs` parent.
+     *
+     * @deprecated Use "selected" instead.
      */
     this.active = false;
     /**
-     * When true, display this tab title as selected.
+     * When true, the component and its respective `calcite-tab` contents are selected.
+     *
+     * Only one tab can be selected within the `calcite-tabs` parent.
      */
     this.selected = false;
-    /** Disable this tab title  */
+    /** When true, interaction is prevented and the component is displayed with lower opacity.  */
     this.disabled = false;
     /**
      * @internal
@@ -179,7 +183,7 @@ export class TabTitle {
   //
   //--------------------------------------------------------------------------
   /**
-   * Return the index of this title within the nav
+   * Returns the index of the title within the `calcite-tab-nav`.
    */
   async getTabIndex() {
     return Array.prototype.indexOf.call(this.el.parentElement.querySelectorAll("calcite-tab-title"), this.el);
@@ -237,9 +241,9 @@ export class TabTitle {
       "docs": {
         "tags": [{
             "name": "deprecated",
-            "text": "Use selected instead."
+            "text": "Use \"selected\" instead."
           }],
-        "text": "Show this tab title as selected"
+        "text": "When true, the component and its respective `calcite-tab` contents are selected.\n\nOnly one tab can be selected within the `calcite-tabs` parent."
       },
       "attribute": "active",
       "reflect": true,
@@ -257,7 +261,7 @@ export class TabTitle {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "When true, display this tab title as selected."
+        "text": "When true, the component and its respective `calcite-tab` contents are selected.\n\nOnly one tab can be selected within the `calcite-tabs` parent."
       },
       "attribute": "selected",
       "reflect": true,
@@ -275,7 +279,7 @@ export class TabTitle {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "Disable this tab title"
+        "text": "When true, interaction is prevented and the component is displayed with lower opacity."
       },
       "attribute": "disabled",
       "reflect": true,
@@ -293,7 +297,7 @@ export class TabTitle {
       "optional": true,
       "docs": {
         "tags": [],
-        "text": "optionally pass an icon to display at the end of a tab title - accepts calcite ui icon names"
+        "text": "Specifies an icon to display at the end of the component - accepts Calcite UI icon names."
       },
       "attribute": "icon-end",
       "reflect": true
@@ -315,7 +319,7 @@ export class TabTitle {
       "optional": true,
       "docs": {
         "tags": [],
-        "text": "flip the icon(s) in rtl"
+        "text": "When true, the icon will be flipped when the element direction is right-to-left (\"rtl\")."
       },
       "attribute": "icon-flip-rtl",
       "reflect": true
@@ -332,7 +336,7 @@ export class TabTitle {
       "optional": true,
       "docs": {
         "tags": [],
-        "text": "optionally pass an icon to display at the start of a tab title - accepts calcite ui icon names"
+        "text": "Specifies an icon to display at the start of the component - accepts Calcite UI icon names."
       },
       "attribute": "icon-start",
       "reflect": true
@@ -445,7 +449,7 @@ export class TabTitle {
       "optional": true,
       "docs": {
         "tags": [],
-        "text": "Optionally include a unique name for the tab title,\nbe sure to also set this name on the associated tab."
+        "text": "Specifies a unique name for the component.\n\nWhen specified, use the same value on the `calcite-tab`."
       },
       "attribute": "tab",
       "reflect": true
@@ -466,7 +470,7 @@ export class TabTitle {
             "name": "see",
             "text": "[TabChangeEventDetail](https://github.com/Esri/calcite-components/blob/master/src/components/tab/interfaces.ts#L1)"
           }],
-        "text": "Fires when a specific tab is activated. Emits the \"tab\" property or the index position."
+        "text": "Fires when a `calcite-tab` is selected. Emits the \"tab\" property, or the index position."
       },
       "complexType": {
         "original": "TabChangeEventDetail",
@@ -492,7 +496,7 @@ export class TabTitle {
             "name": "internal",
             "text": undefined
           }],
-        "text": "Fires when a specific tab is activated (`event.details`)"
+        "text": "Fires when a `calcite-tab` is selected (`event.details`)."
       },
       "complexType": {
         "original": "TabChangeEventDetail",
@@ -577,7 +581,7 @@ export class TabTitle {
         "return": "Promise<number>"
       },
       "docs": {
-        "text": "Return the index of this title within the nav",
+        "text": "Returns the index of the title within the `calcite-tab-nav`.",
         "tags": []
       }
     },

package/dist/collection/components/tabs/interfaces.js CHANGED Viewed

@@ -1,6 +1,6 @@
 /*!
  * All material copyright ESRI, All Rights Reserved, unless otherwise specified.
  * See https://github.com/Esri/calcite-components/blob/master/LICENSE.md for details.
- * v1.0.0-next.574
+ * v1.0.0-next.577
  */
 export {};

package/dist/collection/components/tabs/resources.js CHANGED Viewed

@@ -1,7 +1,7 @@
 /*!
  * All material copyright ESRI, All Rights Reserved, unless otherwise specified.
  * See https://github.com/Esri/calcite-components/blob/master/LICENSE.md for details.
- * v1.0.0-next.574
+ * v1.0.0-next.577
  */
 export const SLOTS = {
   tabNav: "tab-nav"

package/dist/collection/components/tabs/tabs.js CHANGED Viewed

@@ -1,13 +1,13 @@
 /*!
  * All material copyright ESRI, All Rights Reserved, unless otherwise specified.
  * See https://github.com/Esri/calcite-components/blob/master/LICENSE.md for details.
- * v1.0.0-next.574
+ * v1.0.0-next.577
  */
 import { Component, Prop, h, Element, Listen, State, Fragment } from "@stencil/core";
 import { SLOTS } from "./resources";
 /**
  * @slot - A slot for adding `calcite-tab`s.
- * @slot tab-nav - A slot for adding a tab navigation component.
+ * @slot tab-nav - A slot for adding a `calcite-tab-nav`.
  */
 export class Tabs {
   constructor() {
@@ -17,20 +17,20 @@ export class Tabs {
     //
     //--------------------------------------------------------------------------
     /**
-     * Align tab titles to the edge or fully justify them across the tab nav ("center")
+     * Specifies the layout of the `calcite-tab-nav`, justifying the `calcite-tab-title`s to the start ("inline"), or across and centered ("center").
      */
     this.layout = "inline";
     /**
-     * Display the tabs top (default) or bottom of the tab content. above and below are deprecated.
+     * Specifies the position of the component in relation to the `calcite-tab`s. The "above" and "below" values are deprecated.
      *
      */
     this.position = "top";
     /**
-     * Specify the scale of the tabs component, defaults to m
+     * Specifies the size of the component.
      */
     this.scale = "m";
     /**
-     * Optionally enable tabs to appear like a folder-style menu when its layout is "inline"
+     * When true and layout is set to "inline", the component will display with a folder style menu.
      */
     this.bordered = false;
     //--------------------------------------------------------------------------
@@ -184,7 +184,7 @@ export class Tabs {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "Align tab titles to the edge or fully justify them across the tab nav (\"center\")"
+        "text": "Specifies the layout of the `calcite-tab-nav`, justifying the `calcite-tab-title`s to the start (\"inline\"), or across and centered (\"center\")."
       },
       "attribute": "layout",
       "reflect": true,
@@ -207,7 +207,7 @@ export class Tabs {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "Display the tabs top (default) or bottom of the tab content. above and below are deprecated."
+        "text": "Specifies the position of the component in relation to the `calcite-tab`s. The \"above\" and \"below\" values are deprecated."
       },
       "attribute": "position",
       "reflect": true,
@@ -230,7 +230,7 @@ export class Tabs {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "Specify the scale of the tabs component, defaults to m"
+        "text": "Specifies the size of the component."
       },
       "attribute": "scale",
       "reflect": true,
@@ -248,7 +248,7 @@ export class Tabs {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "Optionally enable tabs to appear like a folder-style menu when its layout is \"inline\""
+        "text": "When true and layout is set to \"inline\", the component will display with a folder style menu."
       },
       "attribute": "bordered",
       "reflect": true,

package/dist/collection/components/tile/resources.js CHANGED Viewed

@@ -1,7 +1,7 @@
 /*!
  * All material copyright ESRI, All Rights Reserved, unless otherwise specified.
  * See https://github.com/Esri/calcite-components/blob/master/LICENSE.md for details.
- * v1.0.0-next.574
+ * v1.0.0-next.577
  */
 export const SLOTS = {
   contentStart: "content-start",

package/dist/collection/components/tile/tile.js CHANGED Viewed

@@ -1,7 +1,7 @@
 /*!
  * All material copyright ESRI, All Rights Reserved, unless otherwise specified.
  * See https://github.com/Esri/calcite-components/blob/master/LICENSE.md for details.
- * v1.0.0-next.574
+ * v1.0.0-next.577
  */
 import { Component, Element, Fragment, h, Prop } from "@stencil/core";
 import { SLOTS } from "./resources";
@@ -9,8 +9,8 @@ import { getSlotted } from "../../utils/dom";
 import { connectConditionalSlotComponent, disconnectConditionalSlotComponent } from "../../utils/conditionalSlot";
 import { updateHostInteraction } from "../../utils/interactive";
 /**
- * @slot content-start - A slot for adding non-actionable elements before the tile content.
- * @slot content-end - A slot for adding non-actionable elements after the tile content.
+ * @slot content-start - A slot for adding non-actionable elements before the component's content.
+ * @slot content-end - A slot for adding non-actionable elements after the component's content.
  */
 export class Tile {
   constructor() {
@@ -19,21 +19,27 @@ export class Tile {
     //  Properties
     //
     //--------------------------------------------------------------------------
-    /** The active state of the tile. */
+    /**
+     * When true, the component is active.
+     */
     this.active = false;
     /**
-     * When true, prevents interaction.
+     * When true, interaction is prevented and the component is displayed with lower opacity.
      */
     this.disabled = false;
-    /** The embed mode of the tile.  When true, renders without a border and padding for use by other components. */
+    /**
+     * The component's embed mode.
+     *
+     * When true, renders without a border and padding for use by other components.
+     */
     this.embed = false;
     /**
-     * The focused state of the tile.
+     * The focused state of the component.
      *
      * @internal
      */
     this.focused = false;
-    /** The hidden state of the tile. */
+    /** When true, the component is not displayed and is not focusable.  */
     this.hidden = false;
   }
   // --------------------------------------------------------------------------
@@ -100,7 +106,7 @@ export class Tile {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "The active state of the tile."
+        "text": "When true, the component is active."
       },
       "attribute": "active",
       "reflect": true,
@@ -118,7 +124,7 @@ export class Tile {
       "optional": true,
       "docs": {
         "tags": [],
-        "text": "The description text that appears beneath the heading of the tile."
+        "text": "A description for the component, which displays below the heading."
       },
       "attribute": "description",
       "reflect": true
@@ -135,7 +141,7 @@ export class Tile {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "When true, prevents interaction."
+        "text": "When true, interaction is prevented and the component is displayed with lower opacity."
       },
       "attribute": "disabled",
       "reflect": true,
@@ -153,7 +159,7 @@ export class Tile {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "The embed mode of the tile.  When true, renders without a border and padding for use by other components."
+        "text": "The component's embed mode.\n\nWhen true, renders without a border and padding for use by other components."
       },
       "attribute": "embed",
       "reflect": true,
@@ -174,7 +180,7 @@ export class Tile {
             "name": "internal",
             "text": undefined
           }],
-        "text": "The focused state of the tile."
+        "text": "The focused state of the component."
       },
       "attribute": "focused",
       "reflect": true,
@@ -192,7 +198,7 @@ export class Tile {
       "optional": true,
       "docs": {
         "tags": [],
-        "text": "The heading text that appears between the icon and description of the tile."
+        "text": "The component header text, which displays between the icon and description."
       },
       "attribute": "heading",
       "reflect": true
@@ -209,7 +215,7 @@ export class Tile {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "The hidden state of the tile."
+        "text": "When true, the component is not displayed and is not focusable."
       },
       "attribute": "hidden",
       "reflect": true,
@@ -227,7 +233,7 @@ export class Tile {
       "optional": true,
       "docs": {
         "tags": [],
-        "text": "The (optional) url for the tile. (Only applies when embed is set to false)"
+        "text": "When embed is \"false\", the url for the component."
       },
       "attribute": "href",
       "reflect": true
@@ -244,7 +250,7 @@ export class Tile {
       "optional": true,
       "docs": {
         "tags": [],
-        "text": "The icon that appears at the top of the tile."
+        "text": "Specifies an icon to display."
       },
       "attribute": "icon",
       "reflect": true

package/dist/collection/components/tile-select/interfaces.js CHANGED Viewed

@@ -1,6 +1,6 @@
 /*!
  * All material copyright ESRI, All Rights Reserved, unless otherwise specified.
  * See https://github.com/Esri/calcite-components/blob/master/LICENSE.md for details.
- * v1.0.0-next.574
+ * v1.0.0-next.577
  */
 export {};

package/dist/collection/components/tile-select/resources.js CHANGED Viewed

@@ -1,7 +1,7 @@
 /*!
  * All material copyright ESRI, All Rights Reserved, unless otherwise specified.
  * See https://github.com/Esri/calcite-components/blob/master/LICENSE.md for details.
- * v1.0.0-next.574
+ * v1.0.0-next.577
  */
 export const CSS = {
   checked: "checked",

package/dist/collection/components/tile-select/tile-select.js CHANGED Viewed

@@ -1,7 +1,7 @@
 /*!
  * All material copyright ESRI, All Rights Reserved, unless otherwise specified.
  * See https://github.com/Esri/calcite-components/blob/master/LICENSE.md for details.
- * v1.0.0-next.574
+ * v1.0.0-next.577
  */
 import { Component, Element, Event, h, Prop, Listen, Watch, State, Method } from "@stencil/core";
 import { guid } from "../../utils/guid";
@@ -17,19 +17,23 @@ export class TileSelect {
     //  Properties
     //
     //--------------------------------------------------------------------------
-    /** The checked state of the tile select. */
+    /** When true, the component is checked. */
     this.checked = false;
-    /** The disabled state of the tile select. */
+    /** When true, interaction is prevented and the component is displayed with lower opacity. */
     this.disabled = false;
-    /** The hidden state of the tile select. */
+    /** When true, the component is not displayed and is not focusable or checkable. */
     this.hidden = false;
-    /** Display an interactive radio or checkbox. */
+    /** When true, displays an interactive input based on the "type" property. */
     this.inputEnabled = false;
-    /** The side of the tile that the radio or checkbox appears on when inputEnabled is true. */
+    /** When inputEnabled is true, the placement of the interactive input on the component. */
     this.inputAlignment = "start";
-    /** The selection mode of the tile select: radio (single) or checkbox (multiple). */
+    /**
+     * The selection mode of the component.
+     *
+     * Use radio for single selection, and checkbox for multiple selections.
+     */
     this.type = "radio";
-    /** specify the width of the tile, defaults to auto */
+    /** Specifies the width of the component. */
     this.width = "auto";
     this.guid = `calcite-tile-select-${guid()}`;
     //--------------------------------------------------------------------------
@@ -199,7 +203,7 @@ export class TileSelect {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "The checked state of the tile select."
+        "text": "When true, the component is checked."
       },
       "attribute": "checked",
       "reflect": true,
@@ -217,7 +221,7 @@ export class TileSelect {
       "optional": true,
       "docs": {
         "tags": [],
-        "text": "The description text that appears beneath the heading of the tile."
+        "text": "A description for the component, which displays below the heading."
       },
       "attribute": "description",
       "reflect": true
@@ -234,7 +238,7 @@ export class TileSelect {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "The disabled state of the tile select."
+        "text": "When true, interaction is prevented and the component is displayed with lower opacity."
       },
       "attribute": "disabled",
       "reflect": true,
@@ -252,7 +256,7 @@ export class TileSelect {
       "optional": true,
       "docs": {
         "tags": [],
-        "text": "The heading text that appears between the icon and description of the tile."
+        "text": "The component header text, which displays between the icon and description."
       },
       "attribute": "heading",
       "reflect": true
@@ -269,7 +273,7 @@ export class TileSelect {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "The hidden state of the tile select."
+        "text": "When true, the component is not displayed and is not focusable or checkable."
       },
       "attribute": "hidden",
       "reflect": true,
@@ -287,7 +291,7 @@ export class TileSelect {
       "optional": true,
       "docs": {
         "tags": [],
-        "text": "The icon that appears at the top of the tile."
+        "text": "Specifies an icon to display."
       },
       "attribute": "icon",
       "reflect": true
@@ -304,7 +308,7 @@ export class TileSelect {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "The name of the tile select.  This name will appear in form submissions as either a radio or checkbox identifier based on the `type` property."
+        "text": "Specifies the name of the component on form submission."
       },
       "attribute": "name",
       "reflect": true
@@ -321,7 +325,7 @@ export class TileSelect {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "Display an interactive radio or checkbox."
+        "text": "When true, displays an interactive input based on the \"type\" property."
       },
       "attribute": "input-enabled",
       "reflect": true,
@@ -347,7 +351,7 @@ export class TileSelect {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "The side of the tile that the radio or checkbox appears on when inputEnabled is true."
+        "text": "When inputEnabled is true, the placement of the interactive input on the component."
       },
       "attribute": "input-alignment",
       "reflect": true,
@@ -370,7 +374,7 @@ export class TileSelect {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "The selection mode of the tile select: radio (single) or checkbox (multiple)."
+        "text": "The selection mode of the component.\n\nUse radio for single selection, and checkbox for multiple selections."
       },
       "attribute": "type",
       "reflect": true,
@@ -388,7 +392,7 @@ export class TileSelect {
       "optional": true,
       "docs": {
         "tags": [],
-        "text": "The value of the tile select.  This value will appear in form submissions when this tile select is checked."
+        "text": "The component's value."
       },
       "attribute": "value",
       "reflect": false
@@ -413,7 +417,7 @@ export class TileSelect {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "specify the width of the tile, defaults to auto"
+        "text": "Specifies the width of the component."
       },
       "attribute": "width",
       "reflect": true,
@@ -431,7 +435,7 @@ export class TileSelect {
       "composed": true,
       "docs": {
         "tags": [],
-        "text": "Emits a custom change event.  For checkboxes, it emits when the checkbox is checked or unchecked.  For radios it only emits when it is checked."
+        "text": "Emits a custom change event.\n\nFor checkboxes it emits when checked or unchecked.\n\nFor radios it only emits when checked."
       },
       "complexType": {
         "original": "void",

package/dist/collection/components/tile-select-group/interfaces.js CHANGED Viewed

@@ -1,6 +1,6 @@
 /*!
  * All material copyright ESRI, All Rights Reserved, unless otherwise specified.
  * See https://github.com/Esri/calcite-components/blob/master/LICENSE.md for details.
- * v1.0.0-next.574
+ * v1.0.0-next.577
  */
 export {};

package/dist/collection/components/tile-select-group/tile-select-group.js CHANGED Viewed

@@ -1,7 +1,7 @@
 /*!
  * All material copyright ESRI, All Rights Reserved, unless otherwise specified.
  * See https://github.com/Esri/calcite-components/blob/master/LICENSE.md for details.
- * v1.0.0-next.574
+ * v1.0.0-next.577
  */
 import { Component, h, Prop, Element } from "@stencil/core";
 import { updateHostInteraction } from "../../utils/interactive";
@@ -15,9 +15,13 @@ export class TileSelectGroup {
     //  Properties
     //
     //--------------------------------------------------------------------------
-    /** The disabled state of the tile select. */
+    /** When true, interaction is prevented and the component is displayed with lower opacity. */
     this.disabled = false;
-    /** Tiles by default move horizontally, stacking with each row, vertical allows single-column layouts */
+    /**
+     * Defines the layout of the component.
+     *
+     * Use "horizontal" for rows, and "vertical" for a single column.
+     */
     this.layout = "horizontal";
   }
   //--------------------------------------------------------------------------
@@ -52,7 +56,7 @@ export class TileSelectGroup {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "The disabled state of the tile select."
+        "text": "When true, interaction is prevented and the component is displayed with lower opacity."
       },
       "attribute": "disabled",
       "reflect": true,
@@ -75,7 +79,7 @@ export class TileSelectGroup {
       "optional": true,
       "docs": {
         "tags": [],
-        "text": "Tiles by default move horizontally, stacking with each row, vertical allows single-column layouts"
+        "text": "Defines the layout of the component.\n\nUse \"horizontal\" for rows, and \"vertical\" for a single column."
       },
       "attribute": "layout",
       "reflect": true,

package/dist/collection/components/time-picker/resources.js CHANGED Viewed

@@ -1,7 +1,7 @@
 /*!
  * All material copyright ESRI, All Rights Reserved, unless otherwise specified.
  * See https://github.com/Esri/calcite-components/blob/master/LICENSE.md for details.
- * v1.0.0-next.574
+ * v1.0.0-next.577
  */
 export const CSS = {
   button: "button",