npm - @esri/calcite-components - Versions diffs - 1.0.0-next.509 → 1.0.0-next.511 - Mend

@esri/calcite-components 1.0.0-next.509 → 1.0.0-next.511

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

package/dist/collection/components/modal/modal.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.509
+ * v1.0.0-next.511
  */
 import { Component, Element, Event, h, Host, Listen, Method, Prop, State, Watch } from "@stencil/core";
 import { ensureId, focusElement, getSlotted, isCalciteFocusable } from "../../utils/dom";
@@ -17,8 +17,8 @@ const getFocusableElements = (el) => {
   return queryShadowRoot(el, isHidden, isFocusableExtended);
 };
 /**
- * @slot header - A slot for adding a `calcite-modal` header.
- * @slot content - A slot for adding `calcite-modal` content.
+ * @slot header - A slot for adding header text.
+ * @slot content - A slot for adding the component's content.
  * @slot primary - A slot for adding a primary button.
  * @slot secondary - A slot for adding a secondary button.
  * @slot back - A slot for adding a back button.
@@ -30,23 +30,23 @@ export class Modal {
     //  Properties
     //
     //--------------------------------------------------------------------------
-    /** When true, the `calcite-modal` is active. */
+    /** When true, the component is active. */
     this.active = false;
-    /** Passes a function to run before the `calcite-modal` closes. */
+    /** Passes a function to run before the component closes. */
     this.beforeClose = () => Promise.resolve();
-    /** When true, disables the close button within the `calcite-modal`. */
+    /** When true, disables the component's close button. */
     this.disableCloseButton = false;
-    /** When true, disables the closing of the `calcite-modal` when clicked outside. */
+    /** When true, disables the closing of the component when clicked outside. */
     this.disableOutsideClose = false;
-    /** Accessible label for the close button. */
+    /** Accessible name for the component's close button. */
     this.intlClose = TEXT.close;
     /** When true, disables the default close on escape behavior. */
     this.disableEscape = false;
-    /** Specify the scale of `calcite-modal`. */
+    /** Specifies the size of the component. */
     this.scale = "m";
-    /** Set the width of the `calcite-modal`. Can use scale sizes or pass a number (displays in pixels). */
+    /** Specifies the width of the component. Can use scale sizes or pass a number (displays in pixels). */
     this.width = "m";
-    /** Sets the background color of `calcite-modal` content. */
+    /** Sets the background color of the component's content. */
     this.backgroundColor = "white";
     /** When true, disables spacing to the content area slot. */
     this.noPadding = false;
@@ -219,7 +219,7 @@ export class Modal {
     return focusElement(focusId === "close-button" ? closeButton : getFocusableElements(this.el)[0] || closeButton);
   }
   /**
-   * Set the scroll top of the `calcite-modal` content.
+   * Sets the scroll top of the component's content.
    *
    * @param top
    * @param left
@@ -280,7 +280,7 @@ export class Modal {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "When true, the `calcite-modal` is active."
+        "text": "When true, the component is active."
       },
       "attribute": "active",
       "reflect": true,
@@ -305,7 +305,7 @@ export class Modal {
       "optional": true,
       "docs": {
         "tags": [],
-        "text": "Passes a function to run before the `calcite-modal` closes."
+        "text": "Passes a function to run before the component closes."
       },
       "defaultValue": "() => Promise.resolve()"
     },
@@ -321,7 +321,7 @@ export class Modal {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "When true, disables the close button within the `calcite-modal`."
+        "text": "When true, disables the component's close button."
       },
       "attribute": "disable-close-button",
       "reflect": false,
@@ -339,7 +339,7 @@ export class Modal {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "When true, disables the closing of the `calcite-modal` when clicked outside."
+        "text": "When true, disables the closing of the component when clicked outside."
       },
       "attribute": "disable-outside-close",
       "reflect": false,
@@ -357,7 +357,7 @@ export class Modal {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "Accessible label for the close button."
+        "text": "Accessible name for the component's close button."
       },
       "attribute": "intl-close",
       "reflect": false,
@@ -375,7 +375,7 @@ export class Modal {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "When true, prevents the `calcite-modal` from expanding to the entire screen on mobile devices."
+        "text": "When true, prevents the component from expanding to the entire screen on mobile devices."
       },
       "attribute": "docked",
       "reflect": true
@@ -415,7 +415,7 @@ export class Modal {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "Specify the scale of `calcite-modal`."
+        "text": "Specifies the size of the component."
       },
       "attribute": "scale",
       "reflect": true,
@@ -438,7 +438,7 @@ export class Modal {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "Set the width of the `calcite-modal`. Can use scale sizes or pass a number (displays in pixels)."
+        "text": "Specifies the width of the component. Can use scale sizes or pass a number (displays in pixels)."
       },
       "attribute": "width",
       "reflect": true,
@@ -456,7 +456,7 @@ export class Modal {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "Set the `calcite-modal` to always be fullscreen (overrides width)."
+        "text": "Sets the component to always be fullscreen (overrides width)."
       },
       "attribute": "fullscreen",
       "reflect": true
@@ -473,7 +473,7 @@ export class Modal {
       "optional": true,
       "docs": {
         "tags": [],
-        "text": "Adds a color bar to the top of `calcite-modal` for visual impact.\nUse color to add importance to destructive or workflow dialogs."
+        "text": "Adds a color bar to the top of component for visual impact.\nUse color to add importance to destructive or workflow dialogs."
       },
       "attribute": "color",
       "reflect": true
@@ -495,7 +495,7 @@ export class Modal {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "Sets the background color of `calcite-modal` content."
+        "text": "Sets the background color of the component's content."
       },
       "attribute": "background-color",
       "reflect": true,
@@ -531,7 +531,7 @@ export class Modal {
       "composed": true,
       "docs": {
         "tags": [],
-        "text": "Emits when `calcite-modal` finishes the open animation."
+        "text": "Emits when the component finishes the open animation."
       },
       "complexType": {
         "original": "any",
@@ -546,7 +546,7 @@ export class Modal {
       "composed": true,
       "docs": {
         "tags": [],
-        "text": "Emits when `calcite-modal` finishes the close animation."
+        "text": "Emits when the component finishes the close animation."
       },
       "complexType": {
         "original": "any",
@@ -635,7 +635,7 @@ export class Modal {
         "return": "Promise<void>"
       },
       "docs": {
-        "text": "Set the scroll top of the `calcite-modal` content.",
+        "text": "Sets the scroll top of the component's content.",
         "tags": [{
             "name": "param",
             "text": "top"

package/dist/collection/components/modal/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.509
+ * v1.0.0-next.511
  */
 export const CSS = {
   title: "title",

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

@@ -83,7 +83,7 @@
 *
 * These properties can be overridden using the component's tag as selector.
 *
-* @prop --calcite-notice-width: The width of `calcite-notice`.
+* @prop --calcite-notice-width: The width of the component.
 */
 :host([scale=s]) {
   --calcite-notice-spacing-token-small: 0.5rem;

package/dist/collection/components/notice/notice.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.509
+ * v1.0.0-next.511
  */
 import { Component, Element, Event, h, Method, Prop, Watch } from "@stencil/core";
 import { CSS, SLOTS, TEXT } from "./resources";
@@ -15,10 +15,10 @@ import { connectConditionalSlotComponent, disconnectConditionalSlotComponent } f
  * to display a notice on page load and set the "active" attribute as needed to contextually provide inline messaging to users.
  */
 /**
- * @slot title - A slot for adding the title (optional).
+ * @slot title - A slot for adding the title.
  * @slot message - A slot for adding the message.
- * @slot link - A slot for adding actions to take, such as: undo, try again, link to page, etc. (optional).
- * @slot actions-end - A slot for adding actions to the end of the `calcite-notice` (optional). It is recommended to use two or less actions.
+ * @slot link - A slot for adding actions to take, such as: undo, try again, link to page, etc.
+ * @slot actions-end - A slot for adding actions to the end of the component. It is recommended to use two or less actions.
  */
 export class Notice {
   constructor() {
@@ -27,21 +27,21 @@ export class Notice {
     //  Properties
     //
     //---------------------------------------------------------------------------
-    /** When true, the `calcite-notice` is active. */
+    /** When true, the component is active. */
     this.active = false;
-    /** The color for the `calcite-notice`. Color will apply to top border and icon. */
+    /** The color for the component's top border and icon. */
     this.color = "blue";
-    /** Shows a button the user can click to dismiss the `calcite-notice`. */
+    /** When true, a close button is added to the component. */
     this.dismissible = false;
     /**
-     * Accessible label for the close button.
+     * Accessible name for the close button.
      *
      * @default "Close"
      */
     this.intlClose = TEXT.close;
-    /** Specify the scale of `calcite-notice`. */
+    /** Specifies the size of the component. */
     this.scale = "m";
-    /** Specify the width of the `calcite-notice`. */
+    /** Specifies the width of the component. */
     this.width = "auto";
     //--------------------------------------------------------------------------
     //
@@ -91,7 +91,7 @@ export class Notice {
   //  Public Methods
   //
   //--------------------------------------------------------------------------
-  /** Sets focus on the `calcite-notice`. */
+  /** Sets focus on the component. */
   async setFocus() {
     const noticeLinkEl = this.el.querySelector("calcite-link");
     if (!this.closeButton && !noticeLinkEl) {
@@ -125,7 +125,7 @@ export class Notice {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "When true, the `calcite-notice` is active."
+        "text": "When true, the component is active."
       },
       "attribute": "active",
       "reflect": true,
@@ -148,7 +148,7 @@ export class Notice {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "The color for the `calcite-notice`. Color will apply to top border and icon."
+        "text": "The color for the component's top border and icon."
       },
       "attribute": "color",
       "reflect": true,
@@ -166,7 +166,7 @@ export class Notice {
       "optional": true,
       "docs": {
         "tags": [],
-        "text": "Shows a button the user can click to dismiss the `calcite-notice`."
+        "text": "When true, a close button is added to the component."
       },
       "attribute": "dismissible",
       "reflect": true,
@@ -184,7 +184,7 @@ export class Notice {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "When present, shows a default recommended icon. You can\nalso pass a calcite-ui-icon name to display a requested icon."
+        "text": "Specifies an icon to display - accepts Calcite UI icon names."
       },
       "attribute": "icon",
       "reflect": true
@@ -204,7 +204,7 @@ export class Notice {
             "name": "default",
             "text": "\"Close\""
           }],
-        "text": "Accessible label for the close button."
+        "text": "Accessible name for the close button."
       },
       "attribute": "intl-close",
       "reflect": false,
@@ -227,7 +227,7 @@ export class Notice {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "Specify the scale of `calcite-notice`."
+        "text": "Specifies the size of the component."
       },
       "attribute": "scale",
       "reflect": true,
@@ -250,7 +250,7 @@ export class Notice {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "Specify the width of the `calcite-notice`."
+        "text": "Specifies the width of the component."
       },
       "attribute": "width",
       "reflect": true,
@@ -265,7 +265,7 @@ export class Notice {
       "composed": true,
       "docs": {
         "tags": [],
-        "text": "Fired when `calcite-notice` is closed."
+        "text": "Fired when the component is closed."
       },
       "complexType": {
         "original": "any",
@@ -280,7 +280,7 @@ export class Notice {
       "composed": true,
       "docs": {
         "tags": [],
-        "text": "Fired when `calcite-notice` is opened."
+        "text": "Fired when the component is opened."
       },
       "complexType": {
         "original": "any",
@@ -301,7 +301,7 @@ export class Notice {
         "return": "Promise<void>"
       },
       "docs": {
-        "text": "Sets focus on the `calcite-notice`.",
+        "text": "Sets focus on the component.",
         "tags": []
       }
     }

package/dist/collection/components/notice/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.509
+ * v1.0.0-next.511
  */
 export const TEXT = {
   close: "Close"

package/dist/collection/components/option/option.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.509
+ * v1.0.0-next.511
  */
 import { Component, h, Prop, Element, Event, Watch } from "@stencil/core";
 import { createObserver } from "../../utils/observers";
@@ -13,7 +13,7 @@ export class Option {
     //
     //--------------------------------------------------------------------------
     /**
-     * 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;
     this.mutationObserver = createObserver("mutation", () => {
@@ -91,7 +91,7 @@ export class Option {
       "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,
@@ -109,7 +109,7 @@ export class Option {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "The option label."
+        "text": "Accessible name for the component."
       },
       "attribute": "label",
       "reflect": false
@@ -126,7 +126,7 @@ export class Option {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "When true, this option is selected. Otherwise, false."
+        "text": "When true, the component is selected."
       },
       "attribute": "selected",
       "reflect": true
@@ -143,7 +143,7 @@ export class Option {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "The value associated with this option."
+        "text": "The component's value."
       },
       "attribute": "value",
       "reflect": false

package/dist/collection/components/option-group/option-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.509
+ * v1.0.0-next.511
  */
 import { Component, h, Prop, Watch, Event, Fragment } from "@stencil/core";
 /**
@@ -15,7 +15,7 @@ export class OptionGroup {
     //
     //--------------------------------------------------------------------------
     /**
-     * When true, it prevents selection from any of its associated options.
+     * When true, interaction is prevented and the component is displayed with lower opacity.
      */
     this.disabled = false;
   }
@@ -53,7 +53,7 @@ export class OptionGroup {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "When true, it prevents selection from any of its associated options."
+        "text": "When true, interaction is prevented and the component is displayed with lower opacity."
       },
       "attribute": "disabled",
       "reflect": true,
@@ -71,7 +71,7 @@ export class OptionGroup {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "The group label. This property is required."
+        "text": "Accessible name for the component."
       },
       "attribute": "label",
       "reflect": false

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

@@ -83,7 +83,7 @@
 *
 * These properties can be overridden using the component's tag as selector.
 *
-* @prop --calcite-pagination-spacing: the amount of padding around each pagination item
+* @prop --calcite-pagination-spacing: The amount of padding around each pagination item.
 */
 :host([scale=s]) {
   --calcite-pagination-spacing: 0.25rem 0.5rem;

package/dist/collection/components/pagination/pagination.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.509
+ * v1.0.0-next.511
  */
 import { Component, Element, Event, h, Prop, Method, Fragment, State } from "@stencil/core";
 import { unwatchGlobalAttributes, watchGlobalAttributes } from "../../utils/globalAttributes";
@@ -15,25 +15,25 @@ export class Pagination {
     //  Public Properties
     //
     //--------------------------------------------------------------------------
-    /** number of items per page */
+    /** Specifies the number of items per page. */
     this.num = 20;
-    /** index of item that should begin the page */
+    /** Specifies the starting item number. */
     this.start = 1;
-    /** total number of items */
+    /** Specifies the total number of items. */
     this.total = 0;
     /**
-     * Used as an accessible label (aria-label) for the next button
+     * Accessible name for the component's next button.
      *
      * @default "Next"
      */
     this.textLabelNext = TEXT.nextLabel;
     /**
-     * Used as an accessible label (aria-label) of the previous button
+     * Accessible name for the component's previous button.
      *
      * @default "Previous"
      */
     this.textLabelPrevious = TEXT.previousLabel;
-    /** The scale of the pagination */
+    /** Specifies the size of the component. */
     this.scale = "m";
     //--------------------------------------------------------------------------
     //
@@ -66,11 +66,11 @@ export class Pagination {
   //  Public Methods
   //
   // --------------------------------------------------------------------------
-  /** Go to the next page of results */
+  /** Go to the next page of results. */
   async nextPage() {
     this.start = Math.min(this.getLastStart(), this.start + this.num);
   }
-  /** Go to the previous page of results */
+  /** Go to the previous page of results. */
   async previousPage() {
     this.start = Math.max(1, this.start - this.num);
   }
@@ -201,7 +201,7 @@ export class Pagination {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "number of items per page"
+        "text": "Specifies the number of items per page."
       },
       "attribute": "num",
       "reflect": false,
@@ -219,7 +219,7 @@ export class Pagination {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "index of item that should begin the page"
+        "text": "Specifies the starting item number."
       },
       "attribute": "start",
       "reflect": false,
@@ -237,7 +237,7 @@ export class Pagination {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "total number of items"
+        "text": "Specifies the total number of items."
       },
       "attribute": "total",
       "reflect": false,
@@ -258,7 +258,7 @@ export class Pagination {
             "name": "default",
             "text": "\"Next\""
           }],
-        "text": "Used as an accessible label (aria-label) for the next button"
+        "text": "Accessible name for the component's next button."
       },
       "attribute": "text-label-next",
       "reflect": false,
@@ -279,7 +279,7 @@ export class Pagination {
             "name": "default",
             "text": "\"Previous\""
           }],
-        "text": "Used as an accessible label (aria-label) of the previous button"
+        "text": "Accessible name for the component's previous button."
       },
       "attribute": "text-label-previous",
       "reflect": false,
@@ -302,7 +302,7 @@ export class Pagination {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "The scale of the pagination"
+        "text": "Specifies the size of the component."
       },
       "attribute": "scale",
       "reflect": true,
@@ -323,7 +323,7 @@ export class Pagination {
             "name": "deprecated",
             "text": "use calcitePaginationChange instead"
           }],
-        "text": "Emitted whenever the selected page changes."
+        "text": "Emits when the selected page changes."
       },
       "complexType": {
         "original": "PaginationDetail",
@@ -343,9 +343,9 @@ export class Pagination {
       "docs": {
         "tags": [{
             "name": "see",
-            "text": "[PaginationDetail](https://github.com/Esri/calcite-components/blob/master/src/components/pagination/calcite-pagination.tsx#L18)"
+            "text": "[PaginationDetail](https://github.com/Esri/calcite-components/blob/master/src/components/pagination/pagination.tsx#L23)"
           }],
-        "text": "Emitted whenever the selected page changes."
+        "text": "Emits when the selected page changes."
       },
       "complexType": {
         "original": "PaginationDetail",
@@ -370,7 +370,7 @@ export class Pagination {
         "return": "Promise<void>"
       },
       "docs": {
-        "text": "Go to the next page of results",
+        "text": "Go to the next page of results.",
         "tags": []
       }
     },
@@ -386,7 +386,7 @@ export class Pagination {
         "return": "Promise<void>"
       },
       "docs": {
-        "text": "Go to the previous page of results",
+        "text": "Go to the previous page of results.",
         "tags": []
       }
     }

package/dist/collection/components/pagination/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.509
+ * v1.0.0-next.511
  */
 export const CSS = {
   page: "page",

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

@@ -94,9 +94,9 @@
 *
 * These properties can be overridden using the component's tag as selector.
 *
-* @prop --calcite-panel-max-height: the maximum height of the panel
-* @prop --calcite-panel-max-width: the maximum width of the panel
-* @prop --calcite-panel-min-width: the minimum width of the panel
+* @prop --calcite-panel-max-height: The maximum height of the component.
+* @prop --calcite-panel-max-width: The maximum width of the component.
+* @prop --calcite-panel-min-width: The minimum width of the component.
 */
 :host {
   position: relative;