@esri/calcite-components 1.0.0-next.556 → 1.0.0-next.559

package/dist/collection/components/slider/slider.js

@@ -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.556
+ * v1.0.0-next.559
  */
 import { Component, Element, Event, h, Host, Listen, Method, Prop, State, Watch } from "@stencil/core";
 import { guid } from "../../utils/guid";
@@ -21,17 +21,17 @@ export class Slider {
     //  Properties
     //
     //--------------------------------------------------------------------------
-    /** Disable and gray out the slider */
+    /** When true, interaction is prevented and the component is displayed with lower opacity. */
     this.disabled = false;
-    /** Indicates if a histogram is present */
+    /** When true, indicates a histogram is present. */
     this.hasHistogram = false;
-    /** Label handles with their numeric value */
+    /** When true, displays label handles with their numeric value. */
     this.labelHandles = false;
-    /** Label tick marks with their numeric value. */
+    /** When true and "ticks" is specified, displays label tick marks with their numeric value. */
     this.labelTicks = false;
-    /** Maximum selectable value */
+    /** The component's maximum selectable value. */
     this.max = 100;
-    /** Minimum selectable value */
+    /** The component's minimum selectable value. */
     this.min = 0;
     /**
      * When true, the slider will display values from high to low.
@@ -39,20 +39,20 @@ export class Slider {
      * Note that this value will be ignored if the slider has an associated histogram.
      */
     this.mirrored = false;
-    /** Use finer point for handles */
+    /** When true, sets a finer point for handles. */
     this.precise = false;
     /**
-     * When true, makes the component required for form-submission.
+     * When true, the component must have a value on form submission.
      */
     this.required = false;
-    /** When true, enables snap selection along the step interval */
+    /** When true, enables snap selection in coordination with "step" via a mouse. */
     this.snap = false;
-    /** Interval to move on up/down keys */
+    /** Specifies the interval to move with the up, or down keys. */
     this.step = 1;
-    /** Currently selected number (if single select) */
+    /** The component's value. */
     this.value = 0;
     /**
-     * Specify the scale of the slider, defaults to m
+     *  Specifies the size of the component.
      */
     this.scale = "m";
     this.guid = `calcite-slider-${guid()}`;
@@ -838,7 +838,7 @@ export class Slider {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "Disable and gray out the slider"
+        "text": "When true, interaction is prevented and the component is displayed with lower opacity."
       },
       "attribute": "disabled",
       "reflect": true,
@@ -856,7 +856,7 @@ export class Slider {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "Indicates if a histogram is present"
+        "text": "When true, indicates a histogram is present."
       },
       "attribute": "has-histogram",
       "reflect": true,
@@ -882,7 +882,7 @@ export class Slider {
             "name": "see",
             "text": "[DataSeries](https://github.com/Esri/calcite-components/blob/master/src/components/graph/interfaces.ts#L5)"
           }],
-        "text": "List of x,y coordinates within the slider's min and max, displays above the slider track."
+        "text": "A list of the histogram's x,y coordinates within the component's \"min\" and \"max\". Displays above the component's track."
       }
     },
     "histogramStops": {
@@ -902,7 +902,7 @@ export class Slider {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "Array of values describing a single color stop, sorted by offset ascending."
+        "text": "A set of single color stops for a histogram, sorted by offset ascending."
       }
     },
     "labelHandles": {
@@ -917,7 +917,7 @@ export class Slider {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "Label handles with their numeric value"
+        "text": "When true, displays label handles with their numeric value."
       },
       "attribute": "label-handles",
       "reflect": true,
@@ -935,7 +935,7 @@ export class Slider {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "Label tick marks with their numeric value."
+        "text": "When true and \"ticks\" is specified, displays label tick marks with their numeric value."
       },
       "attribute": "label-ticks",
       "reflect": true,
@@ -953,7 +953,7 @@ export class Slider {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "Maximum selectable value"
+        "text": "The component's maximum selectable value."
       },
       "attribute": "max",
       "reflect": true,
@@ -971,7 +971,7 @@ export class Slider {
       "optional": true,
       "docs": {
         "tags": [],
-        "text": "Used as an accessible label (aria-label) for second handle if needed (ex. \"Temperature, upper bound\")"
+        "text": "For multiple selections, the accessible name for the second handle, such as \"Temperature, upper bound\"."
       },
       "attribute": "max-label",
       "reflect": false
@@ -988,7 +988,7 @@ export class Slider {
       "optional": true,
       "docs": {
         "tags": [],
-        "text": "Currently selected upper number (if multi-select)"
+        "text": "For multiple selections, the component's upper value."
       },
       "attribute": "max-value",
       "reflect": false
@@ -1005,7 +1005,7 @@ export class Slider {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "Minimum selectable value"
+        "text": "The component's minimum selectable value."
       },
       "attribute": "min",
       "reflect": true,
@@ -1023,7 +1023,7 @@ export class Slider {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "Used as an accessible label (aria-label) for first (or only) handle (ex. \"Temperature, lower bound\")"
+        "text": "Accessible name for first (or only) handle, such as \"Temperature, lower bound\"."
       },
       "attribute": "min-label",
       "reflect": false
@@ -1040,7 +1040,7 @@ export class Slider {
       "optional": true,
       "docs": {
         "tags": [],
-        "text": "Currently selected lower number (if multi-select)"
+        "text": "For multiple selections, the component's lower value."
       },
       "attribute": "min-value",
       "reflect": false
@@ -1075,7 +1075,7 @@ export class Slider {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "The name of the slider"
+        "text": "Specifies the name of the component on form submission."
       },
       "attribute": "name",
       "reflect": true
@@ -1092,7 +1092,7 @@ export class Slider {
       "optional": true,
       "docs": {
         "tags": [],
-        "text": "Interval to move on page up/page down keys"
+        "text": "Specifies the interval to move with the page up, or page down keys."
       },
       "attribute": "page-step",
       "reflect": false
@@ -1109,7 +1109,7 @@ export class Slider {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "Use finer point for handles"
+        "text": "When true, sets a finer point for handles."
       },
       "attribute": "precise",
       "reflect": false,
@@ -1127,7 +1127,7 @@ export class Slider {
       "optional": false,
       "docs": {
         "tags": [],
-        "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,
@@ -1145,7 +1145,7 @@ export class Slider {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "When true, enables snap selection along the step interval"
+        "text": "When true, enables snap selection in coordination with \"step\" via a mouse."
       },
       "attribute": "snap",
       "reflect": false,
@@ -1163,7 +1163,7 @@ export class Slider {
       "optional": true,
       "docs": {
         "tags": [],
-        "text": "Interval to move on up/down keys"
+        "text": "Specifies the interval to move with the up, or down keys."
       },
       "attribute": "step",
       "reflect": false,
@@ -1181,7 +1181,7 @@ export class Slider {
       "optional": true,
       "docs": {
         "tags": [],
-        "text": "Show tick marks on the number line at provided interval"
+        "text": "Displays tick marks on the number line at a specified interval."
       },
       "attribute": "ticks",
       "reflect": false
@@ -1198,7 +1198,7 @@ export class Slider {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "Currently selected number (if single select)"
+        "text": "The component's value."
       },
       "attribute": "value",
       "reflect": true,
@@ -1221,7 +1221,7 @@ export class Slider {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "Specify the scale of the slider, defaults to m"
+        "text": "Specifies the size of the component."
       },
       "attribute": "scale",
       "reflect": false,
@@ -1243,7 +1243,7 @@ export class Slider {
       "composed": true,
       "docs": {
         "tags": [],
-        "text": "Fires on all updates to the slider.\n:warning: Will be fired frequently during drag. If you are performing any\nexpensive operations consider using a debounce or throttle to avoid\nlocking up the main thread."
+        "text": "Fires on all updates to the component.\n\n**Note:** Will be fired frequently during drag. If you are performing any\nexpensive operations consider using a debounce or throttle to avoid\nlocking up the main thread."
       },
       "complexType": {
         "original": "void",
@@ -1258,7 +1258,7 @@ export class Slider {
       "composed": true,
       "docs": {
         "tags": [],
-        "text": "Fires on when the thumb is released on slider\nIf you need to constantly listen to the drag event,\nplease use calciteSliderInput instead"
+        "text": "Fires when the thumb is released on the component.\n\n**Note:** If you need to constantly listen to the drag event,\nuse \"calciteSliderInput\" instead."
       },
       "complexType": {
         "original": "void",
@@ -1274,9 +1274,9 @@ export class Slider {
       "docs": {
         "tags": [{
             "name": "deprecated",
-            "text": "use calciteSliderInput instead"
+            "text": "use \"calciteSliderInput\" instead."
           }],
-        "text": "Fires on all updates to the slider.\n:warning: Will be fired frequently during drag. If you are performing any\nexpensive operations consider using a debounce or throttle to avoid\nlocking up the main thread."
+        "text": "Fires on all updates to the component.\n\n**Note:** Will be fired frequently during drag. If you are performing any\nexpensive operations consider using a debounce or throttle to avoid\nlocking up the main thread."
       },
       "complexType": {
         "original": "void",

package/dist/collection/components/sortable-list/resources.js

@@ -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.556
+ * v1.0.0-next.559
  */
 export const CSS = {
   sortItem: "sort-item",

package/dist/collection/components/sortable-list/sortable-list.js

@@ -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.556
+ * v1.0.0-next.559
  */
 import Sortable from "sortablejs";
 import { Component, Element, Event, Listen, Prop, State, h } from "@stencil/core";

package/dist/collection/components/split-button/resources.js

@@ -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.556
+ * v1.0.0-next.559
  */
 export const CSS = {
   container: "split-button__container",

package/dist/collection/components/split-button/split-button.js

@@ -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.556
+ * v1.0.0-next.559
  */
 import { Component, Element, Event, h, Prop, Watch } from "@stencil/core";
 import { CSS } from "./resources";
@@ -11,30 +11,34 @@ import { updateHostInteraction } from "../../utils/interactive";
  */
 export class SplitButton {
   constructor() {
-    /** specify the appearance style of the button, defaults to solid. */
+    /** Specifies the appearance style of the component. */
     this.appearance = "solid";
-    /** specify the color of the control, defaults to blue */
+    /** Specifies the color of the component. */
     this.color = "blue";
-    /** is the control disabled  */
+    /** When true, interaction is prevented and the component is displayed with lower opacity. */
     this.disabled = false;
     /**
-     * Is the dropdown currently active or not
+     * When true, the component is active.
      *
      * @internal
      */
     this.active = false;
-    /** specify the icon used for the dropdown menu, defaults to chevron */
+    /** Specifies the icon used for the dropdown menu. */
     this.dropdownIconType = "chevron";
     /**
-      optionally add a calcite-loader component to the control,
-     disabling interaction. with the primary button
+      When true, a busy indicator is displayed on the primary button.
      */
     this.loading = false;
-    /** Describes the type of positioning to use for the dropdown. If your element is in a fixed container, use the 'fixed' value. */
+    /**
+     * Determines the type of positioning to use for the overlaid content.
+     *
+     * Using the "absolute" value will work for most cases. The component will be positioned inside of overflowing parent containers and will affect the container's layout. The "fixed" value should be used to escape an overflowing parent container, or when the reference element's `position` CSS property is "fixed".
+     *
+     */
     this.overlayPositioning = "absolute";
-    /** specify the scale of the control, defaults to m */
+    /** Specifies the size of the component. */
     this.scale = "m";
-    /** specify the width of the button, defaults to auto */
+    /** Specifies the width of the component. */
     this.width = "auto";
     this.calciteSplitButtonPrimaryClickHandler = (event) => this.calciteSplitButtonPrimaryClick.emit(event);
     this.calciteSplitButtonSecondaryClickHandler = (event) => this.calciteSplitButtonSecondaryClick.emit(event);
@@ -108,7 +112,7 @@ export class SplitButton {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "specify the appearance style of the button, defaults to solid."
+        "text": "Specifies the appearance style of the component."
       },
       "attribute": "appearance",
       "reflect": true,
@@ -131,7 +135,7 @@ export class SplitButton {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "specify the color of the control, defaults to blue"
+        "text": "Specifies the color of the component."
       },
       "attribute": "color",
       "reflect": true,
@@ -149,7 +153,7 @@ export class SplitButton {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "is the control disabled"
+        "text": "When true, interaction is prevented and the component is displayed with lower opacity."
       },
       "attribute": "disabled",
       "reflect": true,
@@ -170,7 +174,7 @@ export class SplitButton {
             "name": "internal",
             "text": undefined
           }],
-        "text": "Is the dropdown currently active or not"
+        "text": "When true, the component is active."
       },
       "attribute": "active",
       "reflect": true,
@@ -193,7 +197,7 @@ export class SplitButton {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "specify the icon used for the dropdown menu, defaults to chevron"
+        "text": "Specifies the icon used for the dropdown menu."
       },
       "attribute": "dropdown-icon-type",
       "reflect": true,
@@ -211,7 +215,7 @@ export class SplitButton {
       "optional": true,
       "docs": {
         "tags": [],
-        "text": "aria label for overflow button"
+        "text": "Accessible name for the dropdown menu."
       },
       "attribute": "dropdown-label",
       "reflect": true
@@ -228,7 +232,7 @@ export class SplitButton {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "optionally add a calcite-loader component to the control,\ndisabling interaction. with the primary button"
+        "text": "When true, a busy indicator is displayed on the primary button."
       },
       "attribute": "loading",
       "reflect": true,
@@ -251,7 +255,7 @@ export class SplitButton {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "Describes the type of positioning to use for the dropdown. If your element is in a fixed container, use the 'fixed' value."
+        "text": "Determines the type of positioning to use for the overlaid content.\n\nUsing the \"absolute\" value will work for most cases. The component will be positioned inside of overflowing parent containers and will affect the container's layout. The \"fixed\" value should be used to escape an overflowing parent container, or when the reference element's `position` CSS property is \"fixed\"."
       },
       "attribute": "overlay-positioning",
       "reflect": false,
@@ -269,7 +273,7 @@ export class SplitButton {
       "optional": true,
       "docs": {
         "tags": [],
-        "text": "optionally pass an icon to display at the end of the primary button - accepts Calcite UI icon names"
+        "text": "Specifies an icon to display at the end of the primary button - accepts Calcite UI icon names."
       },
       "attribute": "primary-icon-end",
       "reflect": true
@@ -291,7 +295,7 @@ export class SplitButton {
       "optional": true,
       "docs": {
         "tags": [],
-        "text": "flip the primary icon(s) in rtl"
+        "text": "When true, the primary button icon will be flipped when the element direction is right-to-left (\"rtl\")."
       },
       "attribute": "primary-icon-flip-rtl",
       "reflect": true
@@ -308,7 +312,7 @@ export class SplitButton {
       "optional": true,
       "docs": {
         "tags": [],
-        "text": "optionally pass an icon to display at the start of the primary button - accepts Calcite UI icon names"
+        "text": "Specifies an icon to display at the start of the primary button - accepts Calcite UI icon names."
       },
       "attribute": "primary-icon-start",
       "reflect": true
@@ -325,7 +329,7 @@ export class SplitButton {
       "optional": true,
       "docs": {
         "tags": [],
-        "text": "optionally pass an aria-label for the primary button"
+        "text": "Accessible name for the primary button."
       },
       "attribute": "primary-label",
       "reflect": true
@@ -342,7 +346,7 @@ export class SplitButton {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "text for primary action button"
+        "text": "Text displayed in the primary button."
       },
       "attribute": "primary-text",
       "reflect": true
@@ -364,7 +368,7 @@ export class SplitButton {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "specify the scale of the control, defaults to m"
+        "text": "Specifies the size of the component."
       },
       "attribute": "scale",
       "reflect": true,
@@ -387,7 +391,7 @@ export class SplitButton {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "specify the width of the button, defaults to auto"
+        "text": "Specifies the width of the component."
       },
       "attribute": "width",
       "reflect": true,
@@ -402,7 +406,7 @@ export class SplitButton {
       "composed": true,
       "docs": {
         "tags": [],
-        "text": "fired when the primary button is clicked\n\n**Note:** The event payload is deprecated, please use separate mouse event listeners to get info about click."
+        "text": "Fires when the primary button is clicked.\n\n**Note:** The event payload is deprecated, use separate mouse event listeners to get info about click."
       },
       "complexType": {
         "original": "DeprecatedEventPayload",
@@ -422,7 +426,7 @@ export class SplitButton {
       "composed": true,
       "docs": {
         "tags": [],
-        "text": "fired when the secondary button is clicked\n\n**Note:** The event payload is deprecated, please use separate mouse event listeners to get info about click."
+        "text": "Fires when the dropdown menu is clicked.\n\n**Note:** The event payload is deprecated, use separate mouse event listeners to get info about click."
       },
       "complexType": {
         "original": "DeprecatedEventPayload",

package/dist/collection/components/stepper/interfaces.js

@@ -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.556
+ * v1.0.0-next.559
  */
 export {};