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

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

@@ -19,6 +19,7 @@ export declare class Stepper {
   contentWatcher(): void;
   /**
    * This event fires when the active stepper item has changed.
+   *
    * @internal
    */
   calciteInternalStepperItemChange: EventEmitter<StepperItemChangeEventDetail>;
@@ -32,7 +33,11 @@ export declare class Stepper {
   nextStep(): Promise<void>;
   /** set the previous step as active */
   prevStep(): Promise<void>;
-  /** set the requested step as active */
+  /**
+   * set the requested step as active
+   *
+   * @param step
+   */
   goToStep(step: number): Promise<void>;
   /** set the first step as active */
   startStep(): Promise<void>;

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

@@ -13,7 +13,9 @@ export declare class Switch implements LabelableComponent, CheckableFormCompomen
   name: string;
   /** The scale of the switch */
   scale: Scale;
-  /** True if the switch is initially on
+  /**
+   * True if the switch is initially on
+   *
    * @deprecated use 'checked' instead.
    */
   switched: boolean;

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

@@ -15,7 +15,9 @@ export declare class Tab {
    * Show this tab
    */
   active: boolean;
-  /** @internal Parent tabs component scale value */
+  /**
+   * @internal
+   */
   scale: Scale;
   render(): VNode;
   connectedCallback(): void;
@@ -35,6 +37,8 @@ export declare class Tab {
   guid: string;
   labeledBy: string;
   /**
+   * @param tabIds
+   * @param titleIds
    * @internal
    */
   updateAriaInfo(tabIds?: string[], titleIds?: string[]): Promise<void>;

package/dist/types/components/tab-nav/tab-nav.d.ts

@@ -16,13 +16,21 @@ export declare class TabNav {
    * Pass the same string to multiple tab navs to keep them all in sync if one changes
    */
   syncId: string;
-  /** @internal Parent tabs component scale value */
+  /**
+   * @internal
+   */
   scale: Scale;
-  /** @internal Parent tabs component layout value */
+  /**
+   * @internal
+   */
   layout: TabLayout;
-  /** @internal Parent tabs component position value */
+  /**
+   * @internal
+   */
   position: TabPosition;
-  /** @internal Parent tabs component bordered value when layout is "inline" */
+  /**
+   * @internal
+   */
   bordered: boolean;
   /**
    * @internal
@@ -46,11 +54,14 @@ export declare class TabNav {
   activateTabHandler(e: CustomEvent<TabChangeEventDetail>): void;
   /**
    * Check for active tabs on register and update selected
+   *
+   * @param e
    */
   updateTabTitles(e: CustomEvent<TabID>): void;
   globalInternalTabChangeHandler(e: CustomEvent<TabChangeEventDetail>): void;
   /**
    * Emitted when the active tab changes
+   *
    * @see [TabChangeEventDetail](https://github.com/Esri/calcite-components/blob/master/src/components/tab/interfaces.ts#L1)
    */
   calciteTabChange: EventEmitter<TabChangeEventDetail>;

package/dist/types/components/tab-title/tab-title.d.ts

@@ -18,13 +18,21 @@ export declare class TabTitle implements InteractiveComponent {
   iconFlipRtl?: FlipContext;
   /** optionally pass an icon to display at the start of a tab title - accepts calcite ui icon names  */
   iconStart?: string;
-  /** @internal Parent tabs component layout value */
+  /**
+   * @internal
+   */
   layout: TabLayout;
-  /** @internal Parent tabs component or parent tab-nav component's position */
+  /**
+   * @internal
+   */
   position: TabPosition;
-  /** @internal Parent tabs component or parent tab-nav component's scale */
+  /**
+   * @internal
+   */
   scale: Scale;
-  /** @internal Parent tabs component bordered value */
+  /**
+   * @internal
+   */
   bordered: boolean;
   /**
    * Optionally include a unique name for the tab title,
@@ -44,11 +52,13 @@ export declare class TabTitle implements InteractiveComponent {
   keyDownHandler(e: KeyboardEvent): void;
   /**
    * Fires when a specific tab is activated. Emits the "tab" property or the index position.
+   *
    * @see [TabChangeEventDetail](https://github.com/Esri/calcite-components/blob/master/src/components/tab/interfaces.ts#L1)
    */
   calciteTabsActivate: EventEmitter<TabChangeEventDetail>;
   /**
    * Fires when a specific tab is activated (`event.details`)
+   *
    * @see [TabChangeEventDetail](https://github.com/Esri/calcite-components/blob/master/src/components/tab/interfaces.ts#L1)
    * @internal
    */
@@ -74,10 +84,12 @@ export declare class TabTitle implements InteractiveComponent {
    */
   getTabIdentifier(): Promise<TabID>;
   /**
+   * @param tabIds
+   * @param titleIds
    * @internal
    */
   updateAriaInfo(tabIds?: string[], titleIds?: string[]): Promise<void>;
-  /** watches for changing text content **/
+  /** watches for changing text content */
   mutationObserver: MutationObserver;
   controls: string;
   /** determine if there is slotted text for styling purposes */

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

@@ -26,18 +26,22 @@ export declare class Tabs {
   connectedCallback(): void;
   render(): VNode;
   /**
+   * @param e
    * @internal
    */
   calciteInternalTabTitleRegister(e: CustomEvent): void;
   /**
+   * @param e
    * @internal
    */
   calciteTabTitleUnregister(e: CustomEvent): void;
   /**
+   * @param e
    * @internal
    */
   calciteInternalTabRegister(e: CustomEvent): void;
   /**
+   * @param e
    * @internal
    */
   calciteTabUnregister(e: CustomEvent): void;

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

@@ -19,6 +19,7 @@ export declare class Tile implements ConditionalSlotComponent, InteractiveCompon
   embed: boolean;
   /**
    * The focused state of the tile.
+   *
    * @internal
    */
   focused: boolean;

package/dist/types/components/time-picker/time-picker.d.ts

@@ -3,56 +3,81 @@ import { Scale } from "../interfaces";
 import { TimePart, HourCycle, Meridiem } from "../../utils/time";
 export declare class TimePicker {
   el: HTMLCalciteTimePickerElement;
-  /** aria-label for the hour input
+  /**
+   * aria-label for the hour input
+   *
    * @default "Hour"
    */
   intlHour: string;
-  /** aria-label for the hour down button
+  /**
+   * aria-label for the hour down button
+   *
    * @default "Decrease hour"
    */
   intlHourDown: string;
-  /** aria-label for the hour up button
+  /**
+   * aria-label for the hour up button
+   *
    * @default "Increase hour"
    */
   intlHourUp: string;
-  /** aria-label for the meridiem (am/pm) input
+  /**
+   * aria-label for the meridiem (am/pm) input
+   *
    * @default "AM/PM"
    */
   intlMeridiem: string;
-  /** aria-label for the meridiem (am/pm) down button
+  /**
+   * aria-label for the meridiem (am/pm) down button
+   *
    * @default "Decrease AM/PM"
    */
   intlMeridiemDown: string;
-  /** aria-label for the meridiem (am/pm) up button
+  /**
+   * aria-label for the meridiem (am/pm) up button
+   *
    * @default "Increase AM/PM"
    */
   intlMeridiemUp: string;
-  /** aria-label for the minute input
+  /**
+   * aria-label for the minute input
+   *
    * @default "Minute"
    */
   intlMinute: string;
-  /** aria-label for the minute down button
+  /**
+   * aria-label for the minute down button
+   *
    * @default "Decrease minute"
    */
   intlMinuteDown: string;
-  /** aria-label for the minute up button
+  /**
+   * aria-label for the minute up button
+   *
    * @default "Increase minute"
    */
   intlMinuteUp: string;
-  /** aria-label for the second input
+  /**
+   * aria-label for the second input
+   *
    * @default "Second"
    */
   intlSecond: string;
-  /** aria-label for the second down button
+  /**
+   * aria-label for the second down button
+   *
    * @default "Decrease second"
    */
   intlSecondDown: string;
-  /** aria-label for the second up button
+  /**
+   * aria-label for the second up button
+   *
    * @default "Increase second"
    */
   intlSecondUp: string;
   /**
    * BCP 47 language tag for desired language and country format
+   *
    * @internal
    */
   locale: string;
@@ -98,7 +123,11 @@ export declare class TimePicker {
   hostBlurHandler(): void;
   hostFocusHandler(): void;
   keyDownHandler(event: KeyboardEvent): void;
-  /** Sets focus on the component. */
+  /**
+   * Sets focus on the component.
+   *
+   * @param target
+   */
   setFocus(target: TimePart): Promise<void>;
   private buttonActivated;
   private decrementHour;

package/dist/types/components/tip-manager/tip-manager.d.ts

@@ -50,6 +50,7 @@ export declare class TipManager {
   previousTip(): Promise<void>;
   /**
    * Emitted when the `calcite-tip-manager` has been toggled open or closed.
+   *
    * @deprecated use calciteTipManagerClose instead.
    */
   calciteTipManagerToggle: EventEmitter;

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

@@ -9,6 +9,7 @@ export declare class Tooltip {
   label: string;
   /**
    * Offset the position of the tooltip away from the reference element.
+   *
    * @default 6
    */
   offsetDistance: number;
@@ -27,6 +28,7 @@ export declare class Tooltip {
   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/tooltip-manager/tooltip-manager.d.ts

@@ -6,6 +6,7 @@ import { VNode } from "../../stencil-public-runtime";
 export declare class TooltipManager {
   /**
    * CSS Selector to match reference elements for tooltips. Reference elements will be identified by this selector in order to open their associated tooltip.
+   *
    * @default `[data-calcite-tooltip-reference]`
    */
   selector: string;

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

@@ -9,15 +9,21 @@ export declare class Tree {
   el: HTMLCalciteTreeElement;
   /** Display indentation guide lines. */
   lines: boolean;
-  /** Display input
+  /**
+   * Display input
+   *
    * @deprecated Use "ancestors" selection-mode for checkbox input.
    */
   inputEnabled: boolean;
-  /** @internal If this tree is nested within another tree, set to false. */
+  /**
+   * @internal
+   */
   child: boolean;
   /** Specify the scale of the tree. */
   scale: Scale;
-  /** Customize how tree selection works.
+  /**
+   * Customize how tree selection works.
+   *
    * @default "single"
    * @see [TreeSelectionMode](https://github.com/Esri/calcite-components/blob/master/src/components/tree/interfaces.ts#L5)
    */
@@ -32,6 +38,7 @@ export declare class Tree {
   updateAncestorTree(e: CustomEvent<TreeItemSelectDetail>): void;
   /**
    * Emits when the user selects/deselects tree items. An object including an array of selected items will be passed in the event's "detail" property.
+   *
    * @see [TreeSelectDetail](https://github.com/Esri/calcite-components/blob/master/src/components/tree/interfaces.ts#L1)
    */
   calciteTreeSelect: EventEmitter<TreeSelectDetail>;

package/dist/types/components/tree-item/tree-item.d.ts

@@ -14,28 +14,42 @@ export declare class TreeItem implements ConditionalSlotComponent {
   /** Expanded state of the item. */
   expanded: boolean;
   expandedHandler(newValue: boolean): void;
-  /** @internal Expanded state of the parent. */
+  /**
+   * @internal
+   */
   parentExpanded: boolean;
-  /** @internal Level of depth of the item. */
+  /**
+   * @internal
+   */
   depth: number;
-  /** @internal Does this tree item have a tree inside it? */
+  /**
+   * @internal
+   */
   hasChildren: boolean;
-  /** @internal Draws lines (set on parent). */
+  /**
+   * @internal
+   */
   lines: boolean;
-  /** Displays checkboxes (set on parent).
+  /**
+   * Displays checkboxes (set on parent).
+   *
    * @internal
    * @deprecated Use "ancestors" selection-mode on parent for checkbox input.
    */
   inputEnabled: boolean;
-  /** @internal Scale of the parent tree. */
+  /**
+   * @internal
+   */
   scale: Scale;
   /**
+   * In ancestor selection mode, show as indeterminate when only some children are selected.
+   *
    * @internal
-   * In ancestor selection mode,
-   * show as indeterminate when only some children are selected.
-   **/
+   */
   indeterminate: boolean;
-  /** @internal Tree selection-mode (set on parent). */
+  /**
+   * @internal
+   */
   selectionMode: TreeSelectionMode;
   getselectionMode(): void;
   connectedCallback(): void;

package/dist/types/components/value-list/value-list.d.ts

@@ -85,7 +85,11 @@ export declare class ValueList<ItemElement extends HTMLCalciteValueListItemEleme
   keyDownHandler: (event: KeyboardEvent) => void;
   /** Returns the currently selected items */
   getSelectedItems(): Promise<Map<string, HTMLCalciteValueListItemElement>>;
-  /** Sets focus on the component. */
+  /**
+   * Sets focus on the component.
+   *
+   * @param focusId
+   */
   setFocus(focusId?: ListFocusId): Promise<void>;
   getIconType(): ICON_TYPES | null;
   render(): VNode;

package/dist/types/components/value-list-item/value-list-item.d.ts

@@ -16,7 +16,7 @@ export declare class ValueListItem implements ConditionalSlotComponent, Interact
    */
   disabled: boolean;
   /**
-   * @internal When false, the list item cannot be deselected by user interaction.
+   * @internal
    */
   disableDeselect: boolean;
   /**
@@ -24,11 +24,12 @@ export declare class ValueListItem implements ConditionalSlotComponent, Interact
    */
   nonInteractive: boolean;
   /**
-   * @internal - Stores the activated state of the drag handle.
+   * @internal
    */
   handleActivated?: boolean;
   /**
    * Determines the icon SVG symbol that will be shown. Options are circle, square, grip or null.
+   *
    * @see [ICON_TYPES](https://github.com/Esri/calcite-components/blob/master/src/components/pick-list/resources.ts#L5)
    */
   icon?: ICON_TYPES | null;
@@ -61,6 +62,8 @@ export declare class ValueListItem implements ConditionalSlotComponent, Interact
   /**
    * Toggle the selection state. By default this won't trigger an event.
    * The first argument allows the value to be coerced, rather than swapping values.
+   *
+   * @param coerce
    */
   toggleSelected(coerce?: boolean): Promise<void>;
   /** Set focus on the component. */

package/dist/types/components.d.ts

@@ -171,6 +171,7 @@ export namespace Components {
         "scale": Scale;
         /**
           * Sets focus on the component.
+          * @param focusId
          */
         "setFocus": (focusId?: "expand-toggle") => Promise<void>;
     }
@@ -266,6 +267,7 @@ export namespace Components {
         "scale": Scale;
         /**
           * Sets focus on the component.
+          * @param focusId
          */
         "setFocus": (focusId?: "expand-toggle") => Promise<void>;
     }
@@ -913,6 +915,7 @@ export namespace Components {
         "textLabel": string;
         /**
           * Used to toggle the selection state. By default this won't trigger an event. The first argument allows the value to be coerced, rather than swapping values.
+          * @param coerce
          */
         "toggleSelected": (coerce?: boolean) => Promise<void>;
         /**
@@ -1563,7 +1566,7 @@ export namespace Components {
          */
         "step"?: number | "any";
         /**
-          * optionally add suffix  *
+          * optionally add suffix
          */
         "suffixText"?: string;
         /**
@@ -2019,6 +2022,7 @@ export namespace Components {
         "firstFocus"?: HTMLElement;
         /**
           * Focus first interactive element
+          * @param el
           * @deprecated use `setFocus` instead.
          */
         "focusElement": (el?: HTMLElement) => Promise<void>;
@@ -2040,10 +2044,13 @@ export namespace Components {
         "scale": Scale;
         /**
           * Set the scroll top of the modal content
+          * @param top
+          * @param left
          */
         "scrollContent": (top?: number, left?: number) => Promise<void>;
         /**
           * 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.
+          * @param focusId
          */
         "setFocus": (focusId?: "close-button") => Promise<void>;
         /**
@@ -2200,11 +2207,13 @@ export namespace Components {
          */
         "menuOpen": boolean;
         /**
-          * Scrolls panel content to a particular set of coordinates.  ```  myCalcitePanel.scrollContentTo({    left: 0, // Specifies the number of pixels along the X axis to scroll the window or element.    top: 0, // Specifies the number of pixels along the Y axis to scroll the window or element    behavior: "auto" // Specifies whether the scrolling should animate smoothly (smooth), or happen instantly in a single jump (auto, the default value).  }); ```
+          * Scrolls panel content to a particular set of coordinates.  ```   myCalcitePanel.scrollContentTo({     left: 0, // Specifies the number of pixels along the X axis to scroll the window or element.     top: 0, // Specifies the number of pixels along the Y axis to scroll the window or element     behavior: "auto" // Specifies whether the scrolling should animate smoothly (smooth), or happen instantly in a single jump (auto, the default value).   }); ```
+          * @param options
          */
         "scrollContentTo": (options?: ScrollToOptions) => Promise<void>;
         /**
           * Sets focus on the component.
+          * @param focusId
          */
         "setFocus": (focusId?: "dismiss-button" | "back-button") => Promise<void>;
         /**
@@ -2255,6 +2264,7 @@ export namespace Components {
         "selectionFollowsFocus": boolean;
         /**
           * Sets focus on the component.
+          * @param focusId
          */
         "setFocus": (focusId?: ListFocusId) => Promise<void>;
     }
@@ -2314,6 +2324,7 @@ export namespace Components {
         "setFocus": () => Promise<void>;
         /**
           * Used to toggle the selection state. By default this won't trigger an event. The first argument allows the value to be coerced, rather than swapping values.
+          * @param coerce
          */
         "toggleSelected": (coerce?: boolean) => Promise<void>;
         /**
@@ -2396,12 +2407,18 @@ export namespace Components {
         "reposition": () => Promise<void>;
         /**
           * Sets focus on the component.
+          * @param focusId
          */
         "setFocus": (focusId?: "close-button") => Promise<void>;
         /**
           * Toggles the popover's open property.
+          * @param value
          */
         "toggle": (value?: boolean) => Promise<void>;
+        /**
+          * 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.
+         */
+        "triggerDisabled": boolean;
     }
     interface CalcitePopoverManager {
         /**
@@ -2920,6 +2937,7 @@ export namespace Components {
         "endStep": () => Promise<void>;
         /**
           * set the requested step as active
+          * @param step
          */
         "goToStep": (step: number) => Promise<void>;
         /**
@@ -3031,6 +3049,10 @@ export namespace Components {
           * Optionally include a unique name for this tab, be sure to also set this name on the associated title.
          */
         "tab": string;
+        /**
+          * @param tabIds
+          * @param titleIds
+         */
         "updateAriaInfo": (tabIds?: string[], titleIds?: string[]) => Promise<void>;
     }
     interface CalciteTabNav {
@@ -3083,6 +3105,10 @@ export namespace Components {
           * Optionally include a unique name for the tab title, be sure to also set this name on the associated tab.
          */
         "tab"?: string;
+        /**
+          * @param tabIds
+          * @param titleIds
+         */
         "updateAriaInfo": (tabIds?: string[], titleIds?: string[]) => Promise<void>;
     }
     interface CalciteTabs {
@@ -3276,6 +3302,7 @@ export namespace Components {
         "scale": Scale;
         /**
           * Sets focus on the component.
+          * @param target
          */
         "setFocus": (target: TimePart) => Promise<void>;
         /**
@@ -3429,6 +3456,9 @@ export namespace Components {
          */
         "expanded": boolean;
         "hasChildren": boolean;
+        /**
+          * In ancestor selection mode, show as indeterminate when only some children are selected.
+         */
         "indeterminate": boolean;
         /**
           * Displays checkboxes (set on parent).
@@ -3483,6 +3513,7 @@ export namespace Components {
         "selectionFollowsFocus": boolean;
         /**
           * Sets focus on the component.
+          * @param focusId
          */
         "setFocus": (focusId?: ListFocusId) => Promise<void>;
     }
@@ -3528,6 +3559,7 @@ export namespace Components {
         "setFocus": () => Promise<void>;
         /**
           * Toggle the selection state. By default this won't trigger an event. The first argument allows the value to be coerced, rather than swapping values.
+          * @param coerce
          */
         "toggleSelected": (coerce?: boolean) => Promise<void>;
         /**
@@ -4981,7 +5013,7 @@ declare namespace LocalJSX {
          */
         "onCalciteComboboxChange"?: (event: CustomEvent<{ selectedItems: HTMLCalciteComboboxItemElement[] }>) => void;
         /**
-          * Called when a selected item in the combobox is dismissed via its chip *
+          * Called when a selected item in the combobox is dismissed via its chip
          */
         "onCalciteComboboxChipDismiss"?: (event: CustomEvent<any>) => void;
         /**
@@ -5335,15 +5367,15 @@ declare namespace LocalJSX {
          */
         "maxItems"?: number;
         /**
-          * fires when a dropdown has been closed *
+          * fires when a dropdown has been closed
          */
         "onCalciteDropdownClose"?: (event: CustomEvent<void>) => void;
         /**
-          * fires when a dropdown has been opened *
+          * fires when a dropdown has been opened
          */
         "onCalciteDropdownOpen"?: (event: CustomEvent<void>) => void;
         /**
-          * fires when a dropdown item has been selected or deselected *
+          * fires when a dropdown item has been selected or deselected
          */
         "onCalciteDropdownSelect"?: (event: CustomEvent<void>) => void;
         /**
@@ -5724,7 +5756,7 @@ declare namespace LocalJSX {
          */
         "step"?: number | "any";
         /**
-          * optionally add suffix  *
+          * optionally add suffix
          */
         "suffixText"?: string;
         /**
@@ -6548,6 +6580,10 @@ declare namespace LocalJSX {
           * Reference HTMLElement used to position this component according to the placement property. As a convenience, a string ID of the reference element can be used. However, setting this property to use an HTMLElement is preferred so that the component does not need to query the DOM for the referenceElement.
          */
         "referenceElement": HTMLElement | string;
+        /**
+          * 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.
+         */
+        "triggerDisabled"?: boolean;
     }
     interface CalcitePopoverManager {
         /**