@esri/calcite-components 1.0.0-next.476 → 1.0.0-next.479

package/dist/extras/docs-json.json

@@ -1,5 +1,5 @@
 {
-  "timestamp": "2022-05-23T23:57:33",
+  "timestamp": "2022-05-31T21:05:25",
   "compiler": {
     "name": "@stencil/core",
     "version": "2.15.2",
@@ -11279,23 +11279,23 @@
       "docsTags": [
         {
           "name": "slot",
-          "text": "header - a slot for adding a modal header"
+          "text": "header - A slot for adding a `calcite-modal` header."
         },
         {
           "name": "slot",
-          "text": "content - a slot for adding modal content"
+          "text": "content - A slot for adding `calcite-modal` content."
         },
         {
           "name": "slot",
-          "text": "primary - a slot for adding a primary button"
+          "text": "primary - A slot for adding a primary button."
         },
         {
           "name": "slot",
-          "text": "secondary - a slot for adding a secondary button"
+          "text": "secondary - A slot for adding a secondary button."
         },
         {
           "name": "slot",
-          "text": "back - a slot for adding a back button"
+          "text": "back - A slot for adding a back button."
         }
       ],
       "usage": {
@@ -11310,7 +11310,7 @@
           "mutable": true,
           "attr": "active",
           "reflectToAttr": true,
-          "docs": "Add the active attribute to open the modal",
+          "docs": "When true, the `calcite-modal` is active.",
           "docsTags": [],
           "default": "false",
           "values": [
@@ -11327,7 +11327,7 @@
           "mutable": false,
           "attr": "background-color",
           "reflectToAttr": true,
-          "docs": "Background color of modal content",
+          "docs": "Sets the background color of `calcite-modal` content.",
           "docsTags": [],
           "default": "\"white\"",
           "values": [
@@ -11348,7 +11348,7 @@
           "type": "(el: HTMLElement) => Promise<void>",
           "mutable": false,
           "reflectToAttr": false,
-          "docs": "Optionally pass a function to run before close",
+          "docs": "Passes a function to run before the `calcite-modal` closes.",
           "docsTags": [],
           "default": "() => Promise.resolve()",
           "values": [
@@ -11356,7 +11356,7 @@
               "type": "(el: HTMLElement) => Promise<void>"
             }
           ],
-          "optional": false,
+          "optional": true,
           "required": false
         },
         {
@@ -11365,7 +11365,7 @@
           "mutable": false,
           "attr": "color",
           "reflectToAttr": true,
-          "docs": "Adds a color bar at the top for visual impact,\nUse color to add importance to destructive/workflow dialogs.",
+          "docs": "Adds a color bar to the top of `calcite-modal` for visual impact.\nUse color to add importance to destructive or workflow dialogs.",
           "docsTags": [],
           "values": [
             {
@@ -11386,7 +11386,7 @@
           "mutable": false,
           "attr": "disable-close-button",
           "reflectToAttr": false,
-          "docs": "Disables the display a close button within the Modal",
+          "docs": "When true, disables the close button within the `calcite-modal`.",
           "docsTags": [],
           "default": "false",
           "values": [
@@ -11403,7 +11403,7 @@
           "mutable": false,
           "attr": "disable-escape",
           "reflectToAttr": false,
-          "docs": "Flag to disable the default close on escape behavior",
+          "docs": "When true, disables the default close on escape behavior.",
           "docsTags": [],
           "default": "false",
           "values": [
@@ -11420,7 +11420,7 @@
           "mutable": false,
           "attr": "disable-outside-close",
           "reflectToAttr": false,
-          "docs": "Disables the closing of the Modal when clicked outside.",
+          "docs": "When true, disables the closing of the `calcite-modal` when clicked outside.",
           "docsTags": [],
           "default": "false",
           "values": [
@@ -11437,7 +11437,7 @@
           "mutable": false,
           "attr": "docked",
           "reflectToAttr": true,
-          "docs": "Prevent the modal from taking up the entire screen on mobile",
+          "docs": "When true, prevents the `calcite-modal` from expanding to the entire screen on mobile devices.",
           "docsTags": [],
           "values": [
             {
@@ -11452,14 +11452,14 @@
           "type": "HTMLElement",
           "mutable": false,
           "reflectToAttr": false,
-          "docs": "Specify an element to focus when the modal is first opened",
+          "docs": "Specify the initial focus when the `calcite-modal` is first opened.",
           "docsTags": [],
           "values": [
             {
               "type": "HTMLElement"
             }
           ],
-          "optional": true,
+          "optional": false,
           "required": false
         },
         {
@@ -11468,7 +11468,7 @@
           "mutable": false,
           "attr": "fullscreen",
           "reflectToAttr": true,
-          "docs": "Set the modal to always be fullscreen (overrides width)",
+          "docs": "Set the `calcite-modal` to always be fullscreen (overrides width).",
           "docsTags": [],
           "values": [
             {
@@ -11484,7 +11484,7 @@
           "mutable": false,
           "attr": "intl-close",
           "reflectToAttr": false,
-          "docs": "Aria label for the close button",
+          "docs": "Accessible label for the close button.",
           "docsTags": [],
           "default": "TEXT.close",
           "values": [
@@ -11501,7 +11501,7 @@
           "mutable": false,
           "attr": "no-padding",
           "reflectToAttr": false,
-          "docs": "Turn off spacing around the content area slot",
+          "docs": "When true, disables spacing to the content area slot.",
           "docsTags": [],
           "default": "false",
           "values": [
@@ -11518,7 +11518,7 @@
           "mutable": false,
           "attr": "scale",
           "reflectToAttr": true,
-          "docs": "specify the scale of modal, defaults to m",
+          "docs": "Specify the scale of `calcite-modal`.",
           "docsTags": [],
           "default": "\"m\"",
           "values": [
@@ -11544,7 +11544,7 @@
           "mutable": false,
           "attr": "width",
           "reflectToAttr": true,
-          "docs": "Set the width of the modal. Can use stock sizes or pass a number (in pixels)",
+          "docs": "Set the width of the `calcite-modal`. Can use scale sizes or pass a number (displays in pixels).",
           "docsTags": [],
           "default": "\"m\"",
           "values": [
@@ -11577,7 +11577,7 @@
           },
           "signature": "focusElement(el?: HTMLElement) => Promise<void>",
           "parameters": [],
-          "docs": "Focus first interactive element",
+          "docs": "Focus the first interactive element.",
           "docsTags": [
             {
               "name": "param",
@@ -11598,7 +11598,7 @@
           },
           "signature": "scrollContent(top?: number, left?: number) => Promise<void>",
           "parameters": [],
-          "docs": "Set the scroll top of the modal content",
+          "docs": "Set the scroll top of the `calcite-modal` content.",
           "docsTags": [
             {
               "name": "param",
@@ -11618,7 +11618,7 @@
           },
           "signature": "setFocus(focusId?: \"close-button\") => Promise<void>",
           "parameters": [],
-          "docs": "Sets focus on the component.\n\nBy default, will try to focus on any focusable content. If there is none, it will focus on the close button.\nIf you want to focus on the close button, you can use the `close-button` focus ID.",
+          "docs": "Sets focus on the component.\n\nBy default, tries to focus on focusable content. If there is none, it will focus on the close button.\nTo focus on the close button, use the `close-button` focus ID.",
           "docsTags": [
             {
               "name": "param",
@@ -11634,7 +11634,7 @@
           "bubbles": true,
           "cancelable": true,
           "composed": true,
-          "docs": "Fired when the modal finishes the close animation",
+          "docs": "Emits when `calcite-modal` finishes the close animation.",
           "docsTags": []
         },
         {
@@ -11643,7 +11643,7 @@
           "bubbles": true,
           "cancelable": true,
           "composed": true,
-          "docs": "Fired when the modal finishes the open animation",
+          "docs": "Emits when `calcite-modal` finishes the open animation.",
           "docsTags": []
         }
       ],
@@ -11659,49 +11659,49 @@
         {
           "name": "--calcite-modal-content-text",
           "annotation": "prop",
-          "docs": "the font-size of the modal content"
+          "docs": "The `calcite-modal` content font size."
         },
         {
           "name": "--calcite-modal-padding",
           "annotation": "prop",
-          "docs": "the top/bottom padding around items in the modal"
+          "docs": "The top/bottom padding around items in the `calcite-modal`."
         },
         {
           "name": "--calcite-modal-padding-large",
           "annotation": "prop",
-          "docs": "the left/right padding around items in the modal"
+          "docs": "The left/right padding around items in the `calcite-modal`."
         },
         {
           "name": "--calcite-modal-title-text",
           "annotation": "prop",
-          "docs": "the font-size of the modal title"
+          "docs": "The `calcite-modal` title font size."
         },
         {
           "name": "--calcite-scrim-background",
           "annotation": "prop",
-          "docs": "the semi-transparent background color behind modal"
+          "docs": "The semi-transparent background color behind the `calcite-modal`."
         }
       ],
       "slots": [
         {
           "name": "back",
-          "docs": "a slot for adding a back button"
+          "docs": "A slot for adding a back button."
         },
         {
           "name": "content",
-          "docs": "a slot for adding modal content"
+          "docs": "A slot for adding `calcite-modal` content."
         },
         {
           "name": "header",
-          "docs": "a slot for adding a modal header"
+          "docs": "A slot for adding a `calcite-modal` header."
         },
         {
           "name": "primary",
-          "docs": "a slot for adding a primary button"
+          "docs": "A slot for adding a primary button."
         },
         {
           "name": "secondary",
-          "docs": "a slot for adding a secondary button"
+          "docs": "A slot for adding a secondary button."
         }
       ],
       "parts": [],
@@ -11729,19 +11729,19 @@
       "docsTags": [
         {
           "name": "slot",
-          "text": "title - Title of the notice (optional)"
+          "text": "title - A slot for adding the title (optional)."
         },
         {
           "name": "slot",
-          "text": "message - Main text of the notice"
+          "text": "message - A slot for adding the message."
         },
         {
           "name": "slot",
-          "text": "link - Optional action to take from the notice (undo, try again, link to page, etc.)"
+          "text": "link - A slot for adding actions to take, such as: undo, try again, link to page, etc. (optional)."
         },
         {
           "name": "slot",
-          "text": "actions-end - Allows adding a `calcite-action` at the end of the notice. It is recommended to use 2 or less actions."
+          "text": "actions-end - A slot for adding actions to the end of the `calcite-notice` (optional). It is recommended to use two or less actions."
         }
       ],
       "usage": {
@@ -11755,7 +11755,7 @@
           "mutable": true,
           "attr": "active",
           "reflectToAttr": true,
-          "docs": "Is the notice currently active or not",
+          "docs": "When true, the `calcite-notice` is active.",
           "docsTags": [],
           "default": "false",
           "values": [
@@ -11772,7 +11772,7 @@
           "mutable": false,
           "attr": "color",
           "reflectToAttr": true,
-          "docs": "Color for the notice (will apply to top border and icon)",
+          "docs": "The color for the `calcite-notice`. Color will apply to top border and icon.",
           "docsTags": [],
           "default": "\"blue\"",
           "values": [
@@ -11802,7 +11802,7 @@
           "mutable": false,
           "attr": "dismissible",
           "reflectToAttr": true,
-          "docs": "Optionally show a button the user can click to dismiss the notice",
+          "docs": "Shows a button the user can click to dismiss the `calcite-notice`.",
           "docsTags": [],
           "default": "false",
           "values": [
@@ -11810,7 +11810,7 @@
               "type": "boolean"
             }
           ],
-          "optional": false,
+          "optional": true,
           "required": false
         },
         {
@@ -11819,7 +11819,7 @@
           "mutable": false,
           "attr": "icon",
           "reflectToAttr": true,
-          "docs": "when used as a boolean set to true, show a default recommended icon. You can\nalso pass a calcite-ui-icon name to this prop to display a requested icon",
+          "docs": "When present, shows a default recommended icon. You can\nalso pass a calcite-ui-icon name to display a requested icon.",
           "docsTags": [],
           "values": [
             {
@@ -11838,7 +11838,7 @@
           "mutable": false,
           "attr": "intl-close",
           "reflectToAttr": false,
-          "docs": "String for the close button.",
+          "docs": "Accessible label for the close button.",
           "docsTags": [
             {
               "name": "default",
@@ -11860,7 +11860,7 @@
           "mutable": false,
           "attr": "scale",
           "reflectToAttr": true,
-          "docs": "specify the scale of the notice, defaults to m",
+          "docs": "Specify the scale of `calcite-notice`.",
           "docsTags": [],
           "default": "\"m\"",
           "values": [
@@ -11886,7 +11886,7 @@
           "mutable": false,
           "attr": "width",
           "reflectToAttr": true,
-          "docs": "specify the width of the notice, defaults to auto",
+          "docs": "Specify the width of the `calcite-notice`.",
           "docsTags": [],
           "default": "\"auto\"",
           "values": [
@@ -11916,7 +11916,7 @@
           },
           "signature": "setFocus() => Promise<void>",
           "parameters": [],
-          "docs": "Sets focus on the component.",
+          "docs": "Sets focus on the `calcite-notice`.",
           "docsTags": []
         }
       ],
@@ -11927,7 +11927,7 @@
           "bubbles": true,
           "cancelable": true,
           "composed": true,
-          "docs": "Fired when an notice is closed",
+          "docs": "Fired when `calcite-notice` is closed.",
           "docsTags": []
         },
         {
@@ -11936,7 +11936,7 @@
           "bubbles": true,
           "cancelable": true,
           "composed": true,
-          "docs": "Fired when an Notice is opened",
+          "docs": "Fired when `calcite-notice` is opened.",
           "docsTags": []
         }
       ],
@@ -11945,25 +11945,25 @@
         {
           "name": "--calcite-notice-width",
           "annotation": "prop",
-          "docs": "the width of the notice"
+          "docs": "The width of `calcite-notice`."
         }
       ],
       "slots": [
         {
           "name": "actions-end",
-          "docs": "Allows adding a `calcite-action` at the end of the notice. It is recommended to use 2 or less actions."
+          "docs": "A slot for adding actions to the end of the `calcite-notice` (optional). It is recommended to use two or less actions."
         },
         {
           "name": "link",
-          "docs": "Optional action to take from the notice (undo, try again, link to page, etc.)"
+          "docs": "A slot for adding actions to take, such as: undo, try again, link to page, etc. (optional)."
         },
         {
           "name": "message",
-          "docs": "Main text of the notice"
+          "docs": "A slot for adding the message."
         },
         {
           "name": "title",
-          "docs": "Title of the notice (optional)"
+          "docs": "A slot for adding the title (optional)."
         }
       ],
       "parts": [],

package/dist/loader/cdn.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.476
+ * v1.0.0-next.479
  */
 module.exports = require('../cjs/loader.cjs.js');
 module.exports.applyPolyfills = function() { return Promise.resolve() };

package/dist/loader/index.cjs.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.476
+ * v1.0.0-next.479
  */
 module.exports = require('../cjs/loader.cjs.js');
 module.exports.applyPolyfills = function() { return Promise.resolve() };

package/dist/loader/index.es2017.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.476
+ * v1.0.0-next.479
  */
 export * from '../esm/polyfills/index.js';
 export * from '../esm/loader.js';

package/dist/loader/index.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.476
+ * v1.0.0-next.479
  */
 (function(){if("undefined"!==typeof window&&void 0!==window.Reflect&&void 0!==window.customElements){var a=HTMLElement;window.HTMLElement=function(){return Reflect.construct(a,[],this.constructor)};HTMLElement.prototype=a.prototype;HTMLElement.prototype.constructor=HTMLElement;Object.setPrototypeOf(HTMLElement,a)}})();
 export * from '../esm/polyfills/index.js';

package/dist/types/components/modal/modal.d.ts

@@ -3,44 +3,44 @@ import { Scale } from "../interfaces";
 import { ModalBackgroundColor } from "./interfaces";
 import { ConditionalSlotComponent } from "../../utils/conditionalSlot";
 /**
- * @slot header - a slot for adding a modal header
- * @slot content - a slot for adding modal 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
+ * @slot header - A slot for adding a `calcite-modal` header.
+ * @slot content - A slot for adding `calcite-modal` 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.
  */
 export declare class Modal implements ConditionalSlotComponent {
   el: HTMLCalciteModalElement;
-  /** Add the active attribute to open the modal */
+  /** When true, the `calcite-modal` is active. */
   active: boolean;
-  /** Optionally pass a function to run before close */
-  beforeClose: (el: HTMLElement) => Promise<void>;
-  /** Disables the display a close button within the Modal */
+  /** Passes a function to run before the `calcite-modal` closes. */
+  beforeClose?: (el: HTMLElement) => Promise<void>;
+  /** When true, disables the close button within the `calcite-modal`. */
   disableCloseButton: boolean;
-  /** Disables the closing of the Modal when clicked outside. */
+  /** When true, disables the closing of the `calcite-modal` when clicked outside. */
   disableOutsideClose: boolean;
-  /** Aria label for the close button */
+  /** Accessible label for the close button. */
   intlClose: string;
-  /** Prevent the modal from taking up the entire screen on mobile */
+  /** When true, prevents the `calcite-modal` from expanding to the entire screen on mobile devices. */
   docked: boolean;
-  /** Specify an element to focus when the modal is first opened */
-  firstFocus?: HTMLElement;
-  /** Flag to disable the default close on escape behavior */
+  /** Specify the initial focus when the `calcite-modal` is first opened. */
+  firstFocus: HTMLElement;
+  /** When true, disables the default close on escape behavior. */
   disableEscape: boolean;
-  /** specify the scale of modal, defaults to m */
+  /** Specify the scale of `calcite-modal`. */
   scale: Scale;
-  /** Set the width of the modal. Can use stock sizes or pass a number (in pixels) */
+  /** Set the width of the `calcite-modal`. Can use scale sizes or pass a number (displays in pixels). */
   width: Scale | number;
-  /** Set the modal to always be fullscreen (overrides width) */
+  /** Set the `calcite-modal` to always be fullscreen (overrides width). */
   fullscreen: boolean;
   /**
-   * Adds a color bar at the top for visual impact,
-   * Use color to add importance to destructive/workflow dialogs.
+   * Adds a color bar to the top of `calcite-modal` for visual impact.
+   * Use color to add importance to destructive or workflow dialogs.
    */
   color?: "red" | "blue";
-  /** Background color of modal content */
+  /** Sets the background color of `calcite-modal` content. */
   backgroundColor: ModalBackgroundColor;
-  /** Turn off spacing around the content area slot */
+  /** When true, disables spacing to the content area slot. */
   noPadding: boolean;
   componentWillLoad(): void;
   connectedCallback(): void;
@@ -58,12 +58,12 @@ export declare class Modal implements ConditionalSlotComponent {
   titleId: string;
   private activeTransitionProp;
   handleEscape(e: KeyboardEvent): void;
-  /** Fired when the modal finishes the open animation */
+  /** Emits when `calcite-modal` finishes the open animation. */
   calciteModalOpen: EventEmitter;
-  /** Fired when the modal finishes the close animation */
+  /** Emits when `calcite-modal` finishes the close animation. */
   calciteModalClose: EventEmitter;
   /**
-   * Focus first interactive element
+   * Focus the first interactive element.
    *
    * @param el
    * @deprecated use `setFocus` instead.
@@ -72,14 +72,14 @@ export declare class Modal implements ConditionalSlotComponent {
   /**
    * Sets focus on the component.
    *
-   * By default, will try to focus on any focusable content. If there is none, it will focus on the close button.
-   * If you want to focus on the close button, you can use the `close-button` focus ID.
+   * By default, tries to focus on focusable content. If there is none, it will focus on the close button.
+   * To focus on the close button, use the `close-button` focus ID.
    *
    * @param focusId
    */
   setFocus(focusId?: "close-button"): Promise<void>;
   /**
-   * Set the scroll top of the modal content
+   * Set the scroll top of the `calcite-modal` content.
    *
    * @param top
    * @param left

package/dist/types/components/notice/notice.d.ts

@@ -9,48 +9,48 @@ import { ConditionalSlotComponent } from "../../utils/conditionalSlot";
  * to display a notice on page load and set the "active" attribute as needed to contextually provide inline messaging to users.
  */
 /**
- * @slot title - Title of the notice (optional)
- * @slot message - Main text of the notice
- * @slot link - Optional action to take from the notice (undo, try again, link to page, etc.)
- * @slot actions-end - Allows adding a `calcite-action` at the end of the notice. It is recommended to use 2 or less actions.
+ * @slot title - A slot for adding the title (optional).
+ * @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.
  */
 export declare class Notice implements ConditionalSlotComponent {
   el: HTMLCalciteNoticeElement;
-  /** Is the notice currently active or not */
+  /** When true, the `calcite-notice` is active. */
   active: boolean;
-  /** Color for the notice (will apply to top border and icon) */
+  /** The color for the `calcite-notice`. Color will apply to top border and icon. */
   color: StatusColor;
-  /** Optionally show a button the user can click to dismiss the notice */
-  dismissible: boolean;
+  /** Shows a button the user can click to dismiss the `calcite-notice`. */
+  dismissible?: boolean;
   /**
-   * when used as a boolean set to true, show a default recommended icon. You can
-   * also pass a calcite-ui-icon name to this prop to display a requested icon
+   * When present, shows a default recommended icon. You can
+   * also pass a calcite-ui-icon name to display a requested icon.
    */
   icon: string | boolean;
   /**
-   * String for the close button.
+   * Accessible label for the close button.
    *
    * @default "Close"
    */
   intlClose: string;
-  /** specify the scale of the notice, defaults to m */
+  /** Specify the scale of `calcite-notice`. */
   scale: Scale;
-  /** specify the width of the notice, defaults to auto */
+  /** Specify the width of the `calcite-notice`. */
   width: Width;
   updateRequestedIcon(): void;
   connectedCallback(): void;
   disconnectedCallback(): void;
   componentWillLoad(): void;
   render(): VNode;
-  /** Fired when an notice is closed */
+  /** Fired when `calcite-notice` is closed. */
   calciteNoticeClose: EventEmitter;
-  /** Fired when an Notice is opened */
+  /** Fired when `calcite-notice` is opened. */
   calciteNoticeOpen: EventEmitter;
-  /** Sets focus on the component. */
+  /** Sets focus on the `calcite-notice`. */
   setFocus(): Promise<void>;
   private close;
-  /** the close button element */
+  /** The close button element. */
   private closeButton?;
-  /** the computed icon to render */
+  /** The computed icon to render. */
   private requestedIcon?;
 }