@esri/calcite-components 1.0.0-next.466 → 1.0.0-next.469

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
    */
@@ -56,15 +66,15 @@ export declare class TabTitle implements InteractiveComponent {
   /**
    * @internal
    */
-  calciteTabsFocusNext: EventEmitter;
+  calciteInternalTabsFocusNext: EventEmitter;
   /**
    * @internal
    */
-  calciteTabsFocusPrevious: EventEmitter;
+  calciteInternalTabsFocusPrevious: EventEmitter;
   /**
    * @internal
    */
-  calciteTabTitleRegister: EventEmitter<TabID>;
+  calciteInternalTabTitleRegister: EventEmitter<TabID>;
   /**
    * Return the index of this title within the nav
    */
@@ -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
    */
-  calciteTabTitleRegister(e: CustomEvent): void;
+  calciteInternalTabTitleRegister(e: CustomEvent): void;
   /**
+   * @param e
    * @internal
    */
   calciteTabTitleUnregister(e: CustomEvent): void;
   /**
+   * @param e
    * @internal
    */
-  calciteTabRegister(e: CustomEvent): void;
+  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;
@@ -86,19 +111,23 @@ export declare class TimePicker {
   /**
    * @internal
    */
-  calciteTimePickerBlur: EventEmitter<void>;
+  calciteInternalTimePickerBlur: EventEmitter<void>;
   /**
    * @internal
    */
-  calciteTimePickerChange: EventEmitter<string>;
+  calciteInternalTimePickerChange: EventEmitter<string>;
   /**
    * @internal
    */
-  calciteTimePickerFocus: EventEmitter<void>;
+  calciteInternalTimePickerFocus: EventEmitter<void>;
   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

@@ -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. */