@esri/calcite-components 1.0.0-beta.82 → 1.0.0-beta.83

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

@@ -1,43 +1,47 @@
 import { VNode } from "../../stencil-public-runtime";
 import { StrictModifiers, Instance as Popper } from "@popperjs/core";
-import { PopperPlacement, OverlayPositioning } from "../../utils/popper";
+import { PopperPlacement, OverlayPositioning, ReferenceElement } from "../../utils/popper";
 /**
  * @slot - A slot for adding text.
  */
 export declare class Tooltip {
-  /** Accessible name for the component */
+  /** Closes the `calcite-tooltip` when the `referenceElement` is clicked. */
+  closeOnClick: boolean;
+  /** Accessible name for the `calcite-tooltip`. */
   label: string;
   /**
-   * Offset the position of the tooltip away from the reference element.
+   * Offset the position of the `calcite-tooltip` away from the `referenceElement`.
+   *
    * @default 6
    */
   offsetDistance: number;
   offsetDistanceOffsetHandler(): void;
   /**
-   * Offset the position of the tooltip along the reference element.
+   * Offset the position of the `calcite-tooltip` along the `referenceElement`.
    */
   offsetSkidding: number;
   offsetSkiddingHandler(): void;
   /**
-   * Display and position the component.
+   * When true, the `calcite-tooltip` is open.
    */
   open: boolean;
   openHandler(): void;
-  /** Describes the type of positioning to use for the overlaid content. If your element is in a fixed container, use the 'fixed' value. */
+  /** Describes the positioning type to use for the overlaid content. If the `referenceElement` is in a fixed container, use the "fixed" value. */
   overlayPositioning: OverlayPositioning;
   /**
-   * Determines where the component will be positioned relative to the referenceElement.
+   * 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;
   placementHandler(): void;
   /**
-   * 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.
+   * The `referenceElement` to position `calcite-tooltip` according to its "placement" value. Setting to the `HTMLElement` is preferred so `calcite-tooltip` does not need to query the DOM for the `referenceElement`. However, a string ID of the reference element can be used.
    */
-  referenceElement: HTMLElement | string;
+  referenceElement: ReferenceElement | string;
   referenceElementHandler(): void;
   el: HTMLCalciteTooltipElement;
-  effectiveReferenceElement: HTMLElement;
+  effectiveReferenceElement: ReferenceElement;
   arrowEl: HTMLDivElement;
   popper: Popper;
   guid: string;
@@ -50,7 +54,7 @@ export declare class Tooltip {
   getId: () => string;
   addReferences: () => void;
   removeReferences: () => void;
-  getReferenceElement(): HTMLElement;
+  getReferenceElement(): ReferenceElement;
   getModifiers(): Partial<StrictModifiers>[];
   createPopper(): void;
   destroyPopper(): void;

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

@@ -3,21 +3,27 @@ import { TreeItemSelectDetail } from "../tree-item/interfaces";
 import { TreeSelectDetail, TreeSelectionMode } from "./interfaces";
 import { Scale } from "../interfaces";
 /**
- * @slot - A slot for calcite-tree-item elements.
+ * @slot - A slot for `calcite-tree-item` elements.
  */
 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

@@ -5,7 +5,7 @@ import { Scale } from "../interfaces";
 import { ConditionalSlotComponent } from "../../utils/conditionalSlot";
 /**
  * @slot - A slot for adding content to the item.
- * @slot children - A slot for adding nested calcite-tree elements.
+ * @slot children - A slot for adding nested `calcite-tree` elements.
  */
 export declare class TreeItem implements ConditionalSlotComponent {
   el: HTMLCalciteTreeItemElement;
@@ -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;
@@ -51,7 +65,7 @@ export declare class TreeItem implements ConditionalSlotComponent {
   /**
    * @internal
    */
-  calciteTreeItemSelect: EventEmitter<TreeItemSelectDetail>;
+  calciteInternalTreeItemSelect: EventEmitter<TreeItemSelectDetail>;
   childrenSlotWrapper: HTMLElement;
   defaultSlotWrapper: HTMLElement;
   private parentTreeItem?;

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

@@ -4,7 +4,7 @@ import { ICON_TYPES } from "./resources";
 import { ListFocusId, ItemData } from "../pick-list/shared-list-logic";
 import { InteractiveComponent } from "../../utils/interactive";
 /**
- * @slot - A slot for adding calcite-value-list-item elements. List items are displayed as a vertical list.
+ * @slot - A slot for adding `calcite-value-list-item` elements. List items are displayed as a vertical list.
  * @slot menu-actions - A slot for adding a button and menu combination for performing actions, such as sorting.
  */
 export declare class ValueList<ItemElement extends HTMLCalciteValueListItemElement = HTMLCalciteValueListItemElement> implements InteractiveComponent {
@@ -69,8 +69,8 @@ export declare class ValueList<ItemElement extends HTMLCalciteValueListItemEleme
   calciteListFocusOutHandler(event: FocusEvent): void;
   calciteListItemRemoveHandler(event: CustomEvent<void>): void;
   calciteListItemChangeHandler(event: CustomEvent): void;
-  calciteListItemPropsChangeHandler(event: CustomEvent): void;
-  calciteListItemValueChangeHandler(event: CustomEvent): void;
+  calciteInternalListItemPropsChangeHandler(event: CustomEvent): void;
+  calciteInternalListItemValueChangeHandler(event: CustomEvent): void;
   getItems(): ItemElement[];
   setUpItems(): void;
   setUpFilter(): void;
@@ -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. */