@esri/calcite-components 1.0.0-next.467 → 1.0.0-next.468

package/dist/extras/docs-json.json

@@ -1,5 +1,5 @@
 {
-  "timestamp": "2022-05-13T16:33:34",
+  "timestamp": "2022-05-13T23:12:54",
   "compiler": {
     "name": "@stencil/core",
     "version": "2.15.2",
@@ -812,7 +812,12 @@
           "signature": "setFocus(focusId?: \"expand-toggle\") => Promise<void>",
           "parameters": [],
           "docs": "Sets focus on the component.",
-          "docsTags": []
+          "docsTags": [
+            {
+              "name": "param",
+              "text": "focusId"
+            }
+          ]
         }
       ],
       "events": [
@@ -1505,7 +1510,12 @@
           "signature": "setFocus(focusId?: \"expand-toggle\") => Promise<void>",
           "parameters": [],
           "docs": "Sets focus on the component.",
-          "docsTags": []
+          "docsTags": [
+            {
+              "name": "param",
+              "text": "focusId"
+            }
+          ]
         }
       ],
       "events": [
@@ -5023,7 +5033,7 @@
           "bubbles": true,
           "cancelable": true,
           "composed": true,
-          "docs": "Called when a selected item in the combobox is dismissed via its chip *",
+          "docs": "Called when a selected item in the combobox is dismissed via its chip",
           "docsTags": []
         },
         {
@@ -5265,7 +5275,12 @@
           "signature": "toggleSelected(coerce?: boolean) => Promise<void>",
           "parameters": [],
           "docs": "Used to toggle the selection state. By default this won't trigger an event.\nThe first argument allows the value to be coerced, rather than swapping values.",
-          "docsTags": []
+          "docsTags": [
+            {
+              "name": "param",
+              "text": "coerce"
+            }
+          ]
         }
       ],
       "events": [
@@ -6807,7 +6822,7 @@
           "bubbles": true,
           "cancelable": true,
           "composed": true,
-          "docs": "fires when a dropdown has been closed *",
+          "docs": "fires when a dropdown has been closed",
           "docsTags": []
         },
         {
@@ -6816,7 +6831,7 @@
           "bubbles": true,
           "cancelable": true,
           "composed": true,
-          "docs": "fires when a dropdown has been opened *",
+          "docs": "fires when a dropdown has been opened",
           "docsTags": []
         },
         {
@@ -6825,7 +6840,7 @@
           "bubbles": true,
           "cancelable": true,
           "composed": true,
-          "docs": "fires when a dropdown item has been selected or deselected *",
+          "docs": "fires when a dropdown item has been selected or deselected",
           "docsTags": []
         }
       ],
@@ -8889,7 +8904,7 @@
           "mutable": false,
           "attr": "suffix-text",
           "reflectToAttr": false,
-          "docs": "optionally add suffix  *",
+          "docs": "optionally add suffix",
           "docsTags": [],
           "values": [
             {
@@ -11564,6 +11579,10 @@
           "parameters": [],
           "docs": "Focus first interactive element",
           "docsTags": [
+            {
+              "name": "param",
+              "text": "el"
+            },
             {
               "name": "deprecated",
               "text": "use `setFocus` instead."
@@ -11580,7 +11599,16 @@
           "signature": "scrollContent(top?: number, left?: number) => Promise<void>",
           "parameters": [],
           "docs": "Set the scroll top of the modal content",
-          "docsTags": []
+          "docsTags": [
+            {
+              "name": "param",
+              "text": "top"
+            },
+            {
+              "name": "param",
+              "text": "left"
+            }
+          ]
         },
         {
           "name": "setFocus",
@@ -11591,7 +11619,12 @@
           "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.",
-          "docsTags": []
+          "docsTags": [
+            {
+              "name": "param",
+              "text": "focusId"
+            }
+          ]
         }
       ],
       "events": [
@@ -12641,8 +12674,13 @@
           },
           "signature": "scrollContentTo(options?: ScrollToOptions) => Promise<void>",
           "parameters": [],
-          "docs": "Scrolls panel content to a particular set of coordinates.\n\n```\n myCalcitePanel.scrollContentTo({\n   left: 0, // Specifies the number of pixels along the X axis to scroll the window or element.\n   top: 0, // Specifies the number of pixels along the Y axis to scroll the window or element\n   behavior: \"auto\" // Specifies whether the scrolling should animate smoothly (smooth), or happen instantly in a single jump (auto, the default value).\n });\n```",
-          "docsTags": []
+          "docs": "Scrolls panel content to a particular set of coordinates.\n\n```\n  myCalcitePanel.scrollContentTo({\n    left: 0, // Specifies the number of pixels along the X axis to scroll the window or element.\n    top: 0, // Specifies the number of pixels along the Y axis to scroll the window or element\n    behavior: \"auto\" // Specifies whether the scrolling should animate smoothly (smooth), or happen instantly in a single jump (auto, the default value).\n  });\n```",
+          "docsTags": [
+            {
+              "name": "param",
+              "text": "options"
+            }
+          ]
         },
         {
           "name": "setFocus",
@@ -12653,7 +12691,12 @@
           "signature": "setFocus(focusId?: \"dismiss-button\" | \"back-button\") => Promise<void>",
           "parameters": [],
           "docs": "Sets focus on the component.",
-          "docsTags": []
+          "docsTags": [
+            {
+              "name": "param",
+              "text": "focusId"
+            }
+          ]
         }
       ],
       "events": [
@@ -12964,7 +13007,12 @@
           "signature": "setFocus(focusId?: ListFocusId) => Promise<void>",
           "parameters": [],
           "docs": "Sets focus on the component.",
-          "docsTags": []
+          "docsTags": [
+            {
+              "name": "param",
+              "text": "focusId"
+            }
+          ]
         }
       ],
       "events": [
@@ -13343,7 +13391,12 @@
           "signature": "toggleSelected(coerce?: boolean) => Promise<void>",
           "parameters": [],
           "docs": "Used to toggle the selection state. By default this won't trigger an event.\nThe first argument allows the value to be coerced, rather than swapping values.",
-          "docsTags": []
+          "docsTags": [
+            {
+              "name": "param",
+              "text": "coerce"
+            }
+          ]
         }
       ],
       "events": [
@@ -13737,6 +13790,23 @@
           ],
           "optional": false,
           "required": true
+        },
+        {
+          "name": "triggerDisabled",
+          "type": "boolean",
+          "mutable": false,
+          "attr": "trigger-disabled",
+          "reflectToAttr": true,
+          "docs": "Disables automatically toggling a popover when its referenceElement has been triggered. This property can be set to true to manage when a popover is open.",
+          "docsTags": [],
+          "default": "false",
+          "values": [
+            {
+              "type": "boolean"
+            }
+          ],
+          "optional": false,
+          "required": false
         }
       ],
       "methods": [
@@ -13760,7 +13830,12 @@
           "signature": "setFocus(focusId?: \"close-button\") => Promise<void>",
           "parameters": [],
           "docs": "Sets focus on the component.",
-          "docsTags": []
+          "docsTags": [
+            {
+              "name": "param",
+              "text": "focusId"
+            }
+          ]
         },
         {
           "name": "toggle",
@@ -13771,7 +13846,12 @@
           "signature": "toggle(value?: boolean) => Promise<void>",
           "parameters": [],
           "docs": "Toggles the popover's open property.",
-          "docsTags": []
+          "docsTags": [
+            {
+              "name": "param",
+              "text": "value"
+            }
+          ]
         }
       ],
       "events": [
@@ -16823,7 +16903,12 @@
           "signature": "goToStep(step: number) => Promise<void>",
           "parameters": [],
           "docs": "set the requested step as active",
-          "docsTags": []
+          "docsTags": [
+            {
+              "name": "param",
+              "text": "step"
+            }
+          ]
         },
         {
           "name": "nextStep",
@@ -18702,7 +18787,12 @@
           "signature": "setFocus(target: TimePart) => Promise<void>",
           "parameters": [],
           "docs": "Sets focus on the component.",
-          "docsTags": []
+          "docsTags": [
+            {
+              "name": "param",
+              "text": "target"
+            }
+          ]
         }
       ],
       "events": [],
@@ -19892,7 +19982,12 @@
           "signature": "setFocus(focusId?: ListFocusId) => Promise<void>",
           "parameters": [],
           "docs": "Sets focus on the component.",
-          "docsTags": []
+          "docsTags": [
+            {
+              "name": "param",
+              "text": "focusId"
+            }
+          ]
         }
       ],
       "events": [
@@ -20175,7 +20270,12 @@
           "signature": "toggleSelected(coerce?: boolean) => Promise<void>",
           "parameters": [],
           "docs": "Toggle the selection state. By default this won't trigger an event.\nThe first argument allows the value to be coerced, rather than swapping values.",
-          "docsTags": []
+          "docsTags": [
+            {
+              "name": "param",
+              "text": "coerce"
+            }
+          ]
         }
       ],
       "events": [

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.467
+ * v1.0.0-next.468
  */
 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.467
+ * v1.0.0-next.468
  */
 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.467
+ * v1.0.0-next.468
  */
 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.467
+ * v1.0.0-next.468
  */
 (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/accordion/accordion.d.ts

@@ -14,8 +14,10 @@ export declare class Accordion {
   iconType: "chevron" | "caret" | "plus-minus";
   /** specify the scale of accordion, defaults to m */
   scale: Scale;
-  /** specify the selection mode - multi (allow any number of open items), single (allow one open item),
-   * or single-persist (allow and require one open item), defaults to multi */
+  /**
+   * specify the selection mode - multi (allow any number of open items), single (allow one open item),
+   * or single-persist (allow and require one open item), defaults to multi
+   */
   selectionMode: "multi" | "single" | "single-persist";
   /**
    * @internal

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

@@ -31,7 +31,9 @@ export declare class Action implements InteractiveComponent {
    * Indicates unread changes.
    */
   indicator: boolean;
-  /** string to override English loading text
+  /**
+   * string to override English loading text
+   *
    * @default "Loading"
    */
   intlLoading?: string;
@@ -57,6 +59,7 @@ export declare class Action implements InteractiveComponent {
   textEnabled: boolean;
   /**
    * Emitted when the action has been clicked.
+   *
    * @deprecated use onClick instead.
    */
   calciteActionClick: EventEmitter;

package/dist/types/components/action-bar/action-bar.d.ts

@@ -52,10 +52,15 @@ export declare class ActionBar implements ConditionalSlotComponent {
   disconnectedCallback(): void;
   /**
    * Overflows actions that won't fit into menus.
+   *
    * @internal
    */
   overflowActions(): Promise<void>;
-  /** Sets focus on the component. */
+  /**
+   * Sets focus on the component.
+   *
+   * @param focusId
+   */
   setFocus(focusId?: "expand-toggle"): Promise<void>;
   actionMenuOpenChangeHandler: (event: CustomEvent<boolean>) => void;
   resizeHandlerEntries: (entries: ResizeObserverEntry[]) => void;

package/dist/types/components/action-menu/action-menu.d.ts

@@ -33,6 +33,7 @@ export declare class ActionMenu implements ConditionalSlotComponent {
   overlayPositioning: OverlayPositioning;
   /**
    * Determines where the component will be positioned relative to the referenceElement.
+   *
    * @see [PopperPlacement](https://github.com/Esri/calcite-components/blob/master/src/utils/popper.ts#L25)
    */
   placement: PopperPlacement;

package/dist/types/components/action-pad/action-pad.d.ts

@@ -44,7 +44,11 @@ export declare class ActionPad implements ConditionalSlotComponent {
   connectedCallback(): void;
   disconnectedCallback(): void;
   componentWillLoad(): void;
-  /** Sets focus on the component. */
+  /**
+   * Sets focus on the component.
+   *
+   * @param focusId
+   */
   setFocus(focusId?: "expand-toggle"): Promise<void>;
   actionMenuOpenChangeHandler: (event: CustomEvent<boolean>) => void;
   toggleExpand: () => void;

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

@@ -1,7 +1,8 @@
 import { EventEmitter, VNode } from "../../stencil-public-runtime";
 import { Scale } from "../interfaces";
 import { AlertDuration, AlertPlacement, StatusColor } from "./interfaces";
-/** Alerts are meant to provide a way to communicate urgent or important information to users, frequently as a result of an action they took in your app. Alerts are positioned
+/**
+ * Alerts are meant to provide a way to communicate urgent or important information to users, frequently as a result of an action they took in your app. Alerts are positioned
  * at the bottom of the page. Multiple opened alerts will be added to a queue, allowing users to dismiss them in the order they are provided.
  */
 /**
@@ -20,10 +21,14 @@ export declare class Alert {
   autoDismissDuration: AlertDuration;
   /** Color for the alert (will apply to top border and icon) */
   color: StatusColor;
-  /** 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 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
+   */
   icon: string | boolean;
-  /** string to override English close text
+  /**
+   * string to override English close text
+   *
    * @default "Close"
    */
   intlClose: string;

package/dist/types/components/avatar/utils.d.ts

@@ -2,14 +2,19 @@ import { RGB } from "../color-picker/interfaces";
 /**
  * Convert a string to a valid hex by hashing its contents
  * and using the hash as a seed for three distinct color values
+ *
+ * @param str
  */
 export declare function stringToHex(str: string): string;
 /**
  * Find the hue of a color given the separate RGB color channels
+ *
+ * @param rgb
  */
 export declare function rgbToHue(rgb: RGB): number;
 /**
  * For a hex color, find the hue
+ *
  * @param hex {string} - form of "#------"
  */
 export declare function hexToHue(hex: string): number;

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

@@ -32,19 +32,25 @@ export declare class Block implements ConditionalSlotComponent, InteractiveCompo
   headingLevel: HeadingLevel;
   /**
    * Aria-label for collapsing the toggle and tooltip used for the toggle when expanded.
+   *
    * @default "Collapse"
    */
   intlCollapse?: string;
   /**
    * Aria-label for expanding the toggle and tooltip used for the toggle when collapsed.
+   *
    * @default "Expand"
    */
   intlExpand?: string;
-  /** string to override English loading text
+  /**
+   * string to override English loading text
+   *
    * @default "Loading"
    */
   intlLoading?: string;
-  /** Text string used for the actions menu
+  /**
+   * Text string used for the actions menu
+   *
    * @default "Options"
    */
   intlOptions?: string;

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

@@ -28,7 +28,9 @@ export declare class Button implements LabelableComponent, InteractiveComponent,
   iconFlipRtl?: FlipContext;
   /** optionally pass an icon to display at the start of a button - accepts calcite ui icon names  */
   iconStart?: string;
-  /** string to override English loading text
+  /**
+   * string to override English loading text
+   *
    * @default "Loading"
    */
   intlLoading?: string;
@@ -66,7 +68,7 @@ export declare class Button implements LabelableComponent, InteractiveComponent,
   setFocus(): Promise<void>;
   formEl: HTMLFormElement;
   labelEl: HTMLCalciteLabelElement;
-  /** watches for changing text content **/
+  /** watches for changing text content */
   private mutationObserver;
   /** the rendered child element */
   private childEl?;

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

@@ -1,6 +1,7 @@
 import { EventEmitter, VNode } from "../../stencil-public-runtime";
 import { ConditionalSlotComponent } from "../../utils/conditionalSlot";
-/** Cards do not include a grid or bounding container
+/**
+ * Cards do not include a grid or bounding container
  * - cards will expand to fit the width of their container
  */
 /**
@@ -19,15 +20,21 @@ export declare class Card implements ConditionalSlotComponent {
   selected: boolean;
   /** Indicates whether the card is selectable. */
   selectable: boolean;
-  /** string to override English loading text
+  /**
+   * string to override English loading text
+   *
    * @default "Loading"
    */
   intlLoading?: string;
-  /** string to override English select text for checkbox when selectable is true
+  /**
+   * string to override English select text for checkbox when selectable is true
+   *
    * @default "Select"
    */
   intlSelect: string;
-  /** string to override English deselect text for checkbox when selectable is true
+  /**
+   * string to override English deselect text for checkbox when selectable is true
+   *
    * @default "Deselect"
    */
   intlDeselect: string;

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

@@ -13,6 +13,7 @@ export declare class Checkbox implements LabelableComponent, CheckableFormCompom
   guid: string;
   /**
    * The hovered state of the checkbox.
+   *
    * @internal
    */
   hovered: boolean;
@@ -20,10 +21,11 @@ export declare class Checkbox implements LabelableComponent, CheckableFormCompom
    * True if the checkbox is initially indeterminate,
    * which is independent from its checked state
    * https://css-tricks.com/indeterminate-checkboxes/
-   * */
+   */
   indeterminate: boolean;
   /**
    * The label of the checkbox input
+   *
    * @internal
    */
   label?: string;

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

@@ -13,7 +13,9 @@ export declare class Chip implements ConditionalSlotComponent {
   color: ChipColor;
   /** Optionally show a button the user can click to dismiss the chip */
   dismissible: boolean;
-  /** Aria label for the "x" button
+  /**
+   * Aria label for the "x" button
+   *
    * @default "Close"
    */
   dismissLabel?: string;