npm - @esri/calcite-components - Versions diffs - 1.0.0-next.557 → 1.0.0-next.558 - Mend

@esri/calcite-components 1.0.0-next.557 → 1.0.0-next.558

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 (881) hide show

package/dist/collection/components/select/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.557
+ * v1.0.0-next.558
  */
 import { Component, Element, Event, Fragment, h, Listen, Method, Prop, Watch } from "@stencil/core";
 import { focusElement } from "../../utils/dom";
@@ -27,23 +27,23 @@ export class Select {
     //
     //--------------------------------------------------------------------------
     /**
-     * When true, it prevents the option from being selected.
+     * When true, interaction is prevented and the component is displayed with lower opacity.
      */
     this.disabled = false;
     /**
-     * When true, makes the component required for form-submission.
+     * When true, the component must have a value on form submission.
      *
      * @internal
      */
     this.required = false;
     /**
-     * The component scale.
+     * Specifies the size of the component.
      */
     this.scale = "m";
-    /** The value of the selectedOption */
+    /** The component's "selectedOption" value. */
     this.value = null;
     /**
-     * The component width.
+     * Specifies the width of the component.
      */
     this.width = "auto";
     this.componentToNativeEl = new Map();
@@ -230,7 +230,7 @@ export class Select {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "When true, it prevents the option from being selected."
+        "text": "When true, interaction is prevented and the component is displayed with lower opacity."
       },
       "attribute": "disabled",
       "reflect": true,
@@ -248,7 +248,7 @@ export class Select {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "The component's label. This is required for accessibility purposes."
+        "text": "Accessible name for the component."
       },
       "attribute": "label",
       "reflect": false
@@ -265,7 +265,7 @@ export class Select {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "The select's name. Gets submitted with the form."
+        "text": "Specifies the name of the component on form submission."
       },
       "attribute": "name",
       "reflect": false
@@ -285,7 +285,7 @@ export class Select {
             "name": "internal",
             "text": undefined
           }],
-        "text": "When true, makes the component required for form-submission."
+        "text": "When true, the component must have a value on form submission."
       },
       "attribute": "required",
       "reflect": true,
@@ -308,7 +308,7 @@ export class Select {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "The component scale."
+        "text": "Specifies the size of the component."
       },
       "attribute": "scale",
       "reflect": true,
@@ -326,7 +326,7 @@ export class Select {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "The value of the selectedOption"
+        "text": "The component's \"selectedOption\" value."
       },
       "attribute": "value",
       "reflect": false,
@@ -351,7 +351,7 @@ export class Select {
             "name": "readonly",
             "text": undefined
           }],
-        "text": "The currently selected option."
+        "text": "The component's selected option `HTMLElement`."
       }
     },
     "width": {
@@ -371,7 +371,7 @@ export class Select {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "The component width."
+        "text": "Specifies the width of the component."
       },
       "attribute": "width",
       "reflect": true,
@@ -386,7 +386,7 @@ export class Select {
       "composed": true,
       "docs": {
         "tags": [],
-        "text": "This event will fire whenever the selected option changes."
+        "text": "Fires when the selected option changes."
       },
       "complexType": {
         "original": "void",

package/dist/collection/components/shell/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.557
+ * v1.0.0-next.558
  */
 export const CSS = {
   main: "main",

package/dist/collection/components/shell/shell.css CHANGED Viewed

@@ -94,7 +94,7 @@
 *
 * These properties can be overridden using the component's tag as selector.
 *
-* @prop --calcite-shell-tip-spacing: the left/right positioning of the tip-manager when slotted within a shell
+* @prop --calcite-shell-tip-spacing: The left and right spacing of the `calcite-tip-manager` when slotted in the component.
 */
 :host {
   position: absolute;

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

@@ -1,21 +1,21 @@
 /*!
  * 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.557
+ * v1.0.0-next.558
  */
 import { Component, Element, Prop, h, Fragment } from "@stencil/core";
 import { CSS, SLOTS } from "./resources";
 import { getSlotted } from "../../utils/dom";
 import { connectConditionalSlotComponent, disconnectConditionalSlotComponent } from "../../utils/conditionalSlot";
 /**
- * @slot - A slot for adding content to the shell. This content will appear between any leading and trailing panels added to the shell. (eg. a map)
- * @slot header - A slot for adding header content. This content will be positioned at the top of the shell.
- * @slot footer - A slot for adding footer content. This content will be positioned at the bottom of the shell.
+ * @slot - A slot for adding content to the component. This content will appear between any leading and trailing panels added to the component, such as a map.
+ * @slot header - A slot for adding header content. This content will be positioned at the top of the component.
+ * @slot footer - A slot for adding footer content. This content will be positioned at the bottom of the component.
  * @slot panel-start - A slot for adding the starting `calcite-shell-panel`.
  * @slot panel-end - A slot for adding the ending `calcite-shell-panel`.
  * @slot primary-panel - [DEPRECATED] A slot for adding the leading `calcite-shell-panel`.
  * @slot contextual-panel - [DEPRECATED] A slot for adding the trailing `calcite-shell-panel`.
- * @slot center-row - A slot for adding custom content in the center row.
+ * @slot center-row - A slot for adding content to the center row.
  */
 export class Shell {
   constructor() {
@@ -25,7 +25,7 @@ export class Shell {
     //
     // --------------------------------------------------------------------------
     /**
-     * Positions the center content behind any calcite-shell-panels.
+     * Positions the center content behind any `calcite-shell-panel`s.
      */
     this.contentBehind = false;
   }
@@ -113,7 +113,7 @@ export class Shell {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "Positions the center content behind any calcite-shell-panels."
+        "text": "Positions the center content behind any `calcite-shell-panel`s."
       },
       "attribute": "content-behind",
       "reflect": true,

package/dist/collection/components/shell-center-row/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.557
+ * v1.0.0-next.558
  */
 export const CSS = {
   actionBarContainer: "action-bar-container",

package/dist/collection/components/shell-center-row/shell-center-row.js CHANGED Viewed

@@ -1,15 +1,15 @@
 /*!
  * 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.557
+ * v1.0.0-next.558
  */
 import { Component, Element, Prop, h, Fragment } from "@stencil/core";
 import { CSS, SLOTS } from "./resources";
 import { getSlotted } from "../../utils/dom";
 import { connectConditionalSlotComponent, disconnectConditionalSlotComponent } from "../../utils/conditionalSlot";
 /**
- * @slot - A slot for adding content to the shell panel.
- * @slot action-bar - A slot for adding a `calcite-action-bar` to the panel.
+ * @slot - A slot for adding content to the `calcite-shell-panel`.
+ * @slot action-bar - A slot for adding a `calcite-action-bar` to the `calcite-shell-panel`.
  */
 export class ShellCenterRow {
   constructor() {
@@ -19,15 +19,15 @@ export class ShellCenterRow {
     //
     // --------------------------------------------------------------------------
     /**
-     * This property makes the content area appear like a "floating" panel.
+     * When true, the content area displays like a floating panel.
      */
     this.detached = false;
     /**
-     * Specifies the maximum height of the row.
+     * Specifies the maximum height of the component.
      */
     this.heightScale = "s";
     /**
-     * Arranges the component depending on the elements 'dir' property.
+     * Specifies the component's position. Will be flipped when the element direction is right-to-left ("rtl").
      */
     this.position = "end";
   }
@@ -81,7 +81,7 @@ export class ShellCenterRow {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "This property makes the content area appear like a \"floating\" panel."
+        "text": "When true, the content area displays like a floating panel."
       },
       "attribute": "detached",
       "reflect": true,
@@ -104,7 +104,7 @@ export class ShellCenterRow {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "Specifies the maximum height of the row."
+        "text": "Specifies the maximum height of the component."
       },
       "attribute": "height-scale",
       "reflect": true,
@@ -127,7 +127,7 @@ export class ShellCenterRow {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "Arranges the component depending on the elements 'dir' property."
+        "text": "Specifies the component's position. Will be flipped when the element direction is right-to-left (\"rtl\")."
       },
       "attribute": "position",
       "reflect": true,

package/dist/collection/components/shell-panel/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.557
+ * v1.0.0-next.558
  */
 export const CSS = {
   container: "container",

package/dist/collection/components/shell-panel/shell-panel.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.557
+ * v1.0.0-next.558
  */
 import { Component, Element, Event, Prop, Watch, h, State, forceUpdate } from "@stencil/core";
 import { CSS, SLOTS, TEXT } from "./resources";
@@ -9,8 +9,8 @@ import { getSlotted, getElementDir } from "../../utils/dom";
 import { clamp } from "../../utils/math";
 import { connectConditionalSlotComponent, disconnectConditionalSlotComponent } from "../../utils/conditionalSlot";
 /**
- * @slot - A slot for adding content to the shell panel.
- * @slot action-bar - A slot for adding a `calcite-action-bar` to the panel.
+ * @slot - A slot for adding content to the component.
+ * @slot action-bar - A slot for adding a `calcite-action-bar` to the component.
  */
 export class ShellPanel {
   constructor() {
@@ -20,29 +20,29 @@ export class ShellPanel {
     //
     // --------------------------------------------------------------------------
     /**
-     * Hide the content panel.
+     * When true, hides the component's content area.
      */
     this.collapsed = false;
     /**
-     * This property makes the content area appear like a "floating" panel.
+     * When true, the content area displays like a floating panel.
      */
     this.detached = false;
     /**
-     * Specifies the maximum height of the contents when detached.
+     * When "detached", specifies the maximum height of the component.
      */
     this.detachedHeightScale = "l";
     /**
-     * This sets width of the content area.
+     * Specifies the width of the component's content area.
      */
     this.widthScale = "m";
     /**
-     * Accessible label for resize separator.
+     * Accessible name for the resize separator.
      *
      * @default "Resize"
      */
     this.intlResize = TEXT.resize;
     /**
-     * This property makes the content area resizable if the calcite-shell-panel is not 'detached'.
+     * When true and not "detached", the component's content area is resizable.
      */
     this.resizable = false;
     this.contentWidth = null;
@@ -244,7 +244,7 @@ export class ShellPanel {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "Hide the content panel."
+        "text": "When true, hides the component's content area."
       },
       "attribute": "collapsed",
       "reflect": true,
@@ -262,7 +262,7 @@ export class ShellPanel {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "This property makes the content area appear like a \"floating\" panel."
+        "text": "When true, the content area displays like a floating panel."
       },
       "attribute": "detached",
       "reflect": true,
@@ -285,7 +285,7 @@ export class ShellPanel {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "Specifies the maximum height of the contents when detached."
+        "text": "When \"detached\", specifies the maximum height of the component."
       },
       "attribute": "detached-height-scale",
       "reflect": true,
@@ -308,7 +308,7 @@ export class ShellPanel {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "This sets width of the content area."
+        "text": "Specifies the width of the component's content area."
       },
       "attribute": "width-scale",
       "reflect": true,
@@ -331,7 +331,7 @@ export class ShellPanel {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "Arranges the component depending on the elements 'dir' property."
+        "text": "Specifies the component's position. Will be flipped when the element direction is right-to-left (\"rtl\")."
       },
       "attribute": "position",
       "reflect": true
@@ -351,7 +351,7 @@ export class ShellPanel {
             "name": "default",
             "text": "\"Resize\""
           }],
-        "text": "Accessible label for resize separator."
+        "text": "Accessible name for the resize separator."
       },
       "attribute": "intl-resize",
       "reflect": false,
@@ -369,7 +369,7 @@ export class ShellPanel {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "This property makes the content area resizable if the calcite-shell-panel is not 'detached'."
+        "text": "When true and not \"detached\", the component's content area is resizable."
       },
       "attribute": "resizable",
       "reflect": true,
@@ -388,7 +388,7 @@ export class ShellPanel {
       "docs": {
         "tags": [{
             "name": "deprecated",
-            "text": "use a resizeObserver on the shell-panel to listen for changes to its size."
+            "text": "use a resizeObserver on the component to listen for changes to its size."
           }],
         "text": "Emitted when collapse has been toggled."
       },