@esri/calcite-components 1.0.0-beta.93 → 1.0.0-beta.94

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

@@ -1,136 +1,138 @@
-import { Event, EventEmitter, VNode } from "../../stencil-public-runtime";
-import { ItemKeyboardEvent, Selection } from "./interfaces";
-import { OverlayPositioning, FloatingUIComponent, EffectivePlacement, MenuPlacement } from "../../utils/floating-ui";
-import { Scale } from "../interfaces";
-import { InteractiveComponent } from "../../utils/interactive";
-import { OpenCloseComponent } from "../../utils/openCloseComponent";
-import { RequestedItem } from "../dropdown-group/interfaces";
-/**
- * @slot - A slot for adding `calcite-dropdown-group` components. Every `calcite-dropdown-item` must have a parent `calcite-dropdown-group`, even if the `groupTitle` property is not set.
- * @slot dropdown-trigger - A slot for the element that triggers the `calcite-dropdown`.
- */
-export declare class Dropdown implements InteractiveComponent, OpenCloseComponent, FloatingUIComponent {
-  el: HTMLCalciteDropdownElement;
-  /**
-   * Opens or closes the dropdown
-   *
-   * @deprecated use open instead.
-   */
-  active: boolean;
-  activeHandler(value: boolean): void;
-  /** When true, opens the dropdown */
-  open: boolean;
-  openHandler(value: boolean): void;
-  /**
-   allow the dropdown to remain open after a selection is made
-   if the selection-mode of the selected item's containing group is "none", the dropdown will always close
-   */
-  disableCloseOnSelect: boolean;
-  /** is the dropdown disabled  */
-  disabled: boolean;
-  handleDisabledChange(value: boolean): void;
-  /**
-   * Defines the available placements that can be used when a flip occurs.
-   */
-  flipPlacements?: EffectivePlacement[];
-  flipPlacementsHandler(): void;
-  /**
-   specify the maximum number of calcite-dropdown-items to display before showing the scroller, must be greater than 0 -
-   this value does not include groupTitles passed to calcite-dropdown-group
-   */
-  maxItems: number;
-  maxItemsHandler(): void;
-  /**
-   * Determines the type of positioning to use for the overlaid content.
-   *
-   * Using the "absolute" value will work for most cases. The component will be positioned inside of overflowing parent containers and will affect the container's layout. The "fixed" value should be used to escape an overflowing parent container, or when the reference element's `position` CSS property is "fixed".
-   *
-   */
-  overlayPositioning: OverlayPositioning;
-  overlayPositioningHandler(): void;
-  /**
-   * Determines where the dropdown will be positioned relative to the button.
-   *
-   * @default "bottom-start"
-   */
-  placement: MenuPlacement;
-  placementHandler(): void;
-  /** specify the scale of dropdown, defaults to m */
-  scale: Scale;
-  /**
-   * **read-only** The currently selected items
-   *
-   * @readonly
-   */
-  selectedItems: HTMLCalciteDropdownItemElement[];
-  /** specify whether the dropdown is opened by hover or click of a trigger element */
-  type: "hover" | "click";
-  /** specify the width of dropdown */
-  width?: Scale;
-  connectedCallback(): void;
-  componentDidLoad(): void;
-  componentDidRender(): void;
-  disconnectedCallback(): void;
-  render(): VNode;
-  /** Updates the position of the component. */
-  reposition(): Promise<void>;
-  /** fires when a dropdown item has been selected or deselected */
-  calciteDropdownSelect: EventEmitter<Selection>;
-  /** Fires when the component is requested to be closed and before the closing transition begins. */
-  calciteDropdownBeforeClose: EventEmitter<void>;
-  /** Fires when the component is closed and animation is complete. */
-  calciteDropdownClose: EventEmitter<void>;
-  /** Fires when the component is added to the DOM but not rendered, and before the opening transition begins. */
-  calciteDropdownBeforeOpen: EventEmitter<void>;
-  /** Fires when the component is open and animation is complete. */
-  calciteDropdownOpen: EventEmitter<void>;
-  closeCalciteDropdownOnClick(event: Event): void;
-  closeCalciteDropdownOnEvent(event: Event): void;
-  closeCalciteDropdownOnOpenEvent(event: Event): void;
-  mouseEnterHandler(): void;
-  mouseLeaveHandler(): void;
-  calciteInternalDropdownItemKeyEvent(event: CustomEvent<ItemKeyboardEvent>): void;
-  handleItemSelect(event: CustomEvent<RequestedItem>): void;
-  filteredFlipPlacements: EffectivePlacement[];
-  private items;
-  private groups;
-  /** trigger elements */
-  private triggers;
-  floatingEl: HTMLDivElement;
-  referenceEl: HTMLDivElement;
-  private scrollerEl;
-  mutationObserver: MutationObserver;
-  resizeObserver: ResizeObserver;
-  openTransitionProp: string;
-  transitionEl: HTMLDivElement;
-  guid: string;
-  defaultAssignedElements: Element[];
-  slotChangeHandler: (event: Event) => void;
-  setFilteredPlacements: () => void;
-  updateTriggers: (event: Event) => void;
-  updateItems: () => void;
-  updateGroups: (event: Event) => void;
-  resizeObserverCallback: (entries: ResizeObserverEntry[]) => void;
-  setDropdownWidth: () => void;
-  setMaxScrollerHeight: () => void;
-  setScrollerAndTransitionEl: (el: HTMLDivElement) => void;
-  onBeforeOpen(): void;
-  onOpen(): void;
-  onBeforeClose(): void;
-  onClose(): void;
-  setReferenceEl: (el: HTMLDivElement) => void;
-  setFloatingEl: (el: HTMLDivElement) => void;
-  private keyDownHandler;
-  private updateSelectedItems;
-  private getMaxScrollerHeight;
-  private closeCalciteDropdown;
-  private focusOnFirstActiveOrFirstItem;
-  private focusFirstItem;
-  private focusLastItem;
-  private focusNextItem;
-  private focusPrevItem;
-  private itemIndex;
-  private getFocusableElement;
-  private toggleOpenEnd;
-  private openCalciteDropdown;
-}
+/// <reference types="lodash" />
+import { Event, EventEmitter, VNode } from "../../stencil-public-runtime";
+import { ItemKeyboardEvent, Selection } from "./interfaces";
+import { OverlayPositioning, FloatingUIComponent, EffectivePlacement, MenuPlacement } from "../../utils/floating-ui";
+import { Scale } from "../interfaces";
+import { InteractiveComponent } from "../../utils/interactive";
+import { OpenCloseComponent } from "../../utils/openCloseComponent";
+import { RequestedItem } from "../dropdown-group/interfaces";
+/**
+ * @slot - A slot for adding `calcite-dropdown-group` components. Every `calcite-dropdown-item` must have a parent `calcite-dropdown-group`, even if the `groupTitle` property is not set.
+ * @slot dropdown-trigger - A slot for the element that triggers the `calcite-dropdown`.
+ */
+export declare class Dropdown implements InteractiveComponent, OpenCloseComponent, FloatingUIComponent {
+  el: HTMLCalciteDropdownElement;
+  /**
+   * Opens or closes the dropdown
+   *
+   * @deprecated use open instead.
+   */
+  active: boolean;
+  activeHandler(value: boolean): void;
+  /** When true, opens the dropdown */
+  open: boolean;
+  openHandler(value: boolean): void;
+  /**
+   allow the dropdown to remain open after a selection is made
+   if the selection-mode of the selected item's containing group is "none", the dropdown will always close
+   */
+  disableCloseOnSelect: boolean;
+  /** is the dropdown disabled  */
+  disabled: boolean;
+  handleDisabledChange(value: boolean): void;
+  /**
+   * Defines the available placements that can be used when a flip occurs.
+   */
+  flipPlacements?: EffectivePlacement[];
+  flipPlacementsHandler(): void;
+  /**
+   specify the maximum number of calcite-dropdown-items to display before showing the scroller, must be greater than 0 -
+   this value does not include groupTitles passed to calcite-dropdown-group
+   */
+  maxItems: number;
+  maxItemsHandler(): void;
+  /**
+   * Determines the type of positioning to use for the overlaid content.
+   *
+   * Using the "absolute" value will work for most cases. The component will be positioned inside of overflowing parent containers and will affect the container's layout. The "fixed" value should be used to escape an overflowing parent container, or when the reference element's `position` CSS property is "fixed".
+   *
+   */
+  overlayPositioning: OverlayPositioning;
+  overlayPositioningHandler(): void;
+  /**
+   * Determines where the dropdown will be positioned relative to the button.
+   *
+   * @default "bottom-start"
+   */
+  placement: MenuPlacement;
+  placementHandler(): void;
+  /** specify the scale of dropdown, defaults to m */
+  scale: Scale;
+  /**
+   * **read-only** The currently selected items
+   *
+   * @readonly
+   */
+  selectedItems: HTMLCalciteDropdownItemElement[];
+  /** specify whether the dropdown is opened by hover or click of a trigger element */
+  type: "hover" | "click";
+  /** specify the width of dropdown */
+  width?: Scale;
+  connectedCallback(): void;
+  componentDidLoad(): void;
+  componentDidRender(): void;
+  disconnectedCallback(): void;
+  render(): VNode;
+  /** Updates the position of the component. */
+  reposition(): Promise<void>;
+  /** fires when a dropdown item has been selected or deselected */
+  calciteDropdownSelect: EventEmitter<Selection>;
+  /** Fires when the component is requested to be closed and before the closing transition begins. */
+  calciteDropdownBeforeClose: EventEmitter<void>;
+  /** Fires when the component is closed and animation is complete. */
+  calciteDropdownClose: EventEmitter<void>;
+  /** Fires when the component is added to the DOM but not rendered, and before the opening transition begins. */
+  calciteDropdownBeforeOpen: EventEmitter<void>;
+  /** Fires when the component is open and animation is complete. */
+  calciteDropdownOpen: EventEmitter<void>;
+  closeCalciteDropdownOnClick(event: Event): void;
+  closeCalciteDropdownOnEvent(event: Event): void;
+  closeCalciteDropdownOnOpenEvent(event: Event): void;
+  mouseEnterHandler(): void;
+  mouseLeaveHandler(): void;
+  calciteInternalDropdownItemKeyEvent(event: CustomEvent<ItemKeyboardEvent>): void;
+  handleItemSelect(event: CustomEvent<RequestedItem>): void;
+  filteredFlipPlacements: EffectivePlacement[];
+  private items;
+  private groups;
+  /** trigger elements */
+  private triggers;
+  floatingEl: HTMLDivElement;
+  referenceEl: HTMLDivElement;
+  private scrollerEl;
+  mutationObserver: MutationObserver;
+  resizeObserver: ResizeObserver;
+  openTransitionProp: string;
+  transitionEl: HTMLDivElement;
+  guid: string;
+  defaultAssignedElements: Element[];
+  debouncedReposition: import("lodash").DebouncedFunc<() => Promise<void>>;
+  slotChangeHandler: (event: Event) => void;
+  setFilteredPlacements: () => void;
+  updateTriggers: (event: Event) => void;
+  updateItems: () => void;
+  updateGroups: (event: Event) => void;
+  resizeObserverCallback: (entries: ResizeObserverEntry[]) => void;
+  setDropdownWidth: () => void;
+  setMaxScrollerHeight: () => void;
+  setScrollerAndTransitionEl: (el: HTMLDivElement) => void;
+  onBeforeOpen(): void;
+  onOpen(): void;
+  onBeforeClose(): void;
+  onClose(): void;
+  setReferenceEl: (el: HTMLDivElement) => void;
+  setFloatingEl: (el: HTMLDivElement) => void;
+  private keyDownHandler;
+  private updateSelectedItems;
+  private getMaxScrollerHeight;
+  private closeCalciteDropdown;
+  private focusOnFirstActiveOrFirstItem;
+  private focusFirstItem;
+  private focusLastItem;
+  private focusNextItem;
+  private focusPrevItem;
+  private itemIndex;
+  private getFocusableElement;
+  private toggleOpenEnd;
+  private openCalciteDropdown;
+}

package/dist/types/components/dropdown/interfaces.d.ts

@@ -1,9 +1,9 @@
-export interface ItemKeyboardEvent {
-  keyboardEvent: KeyboardEvent;
-}
-export interface Selection {
-  /**
-   * The item that caused a selection event to emit.
-   */
-  item: HTMLCalciteDropdownItemElement;
-}
+export interface ItemKeyboardEvent {
+  keyboardEvent: KeyboardEvent;
+}
+export interface Selection {
+  /**
+   * The item that caused a selection event to emit.
+   */
+  item: HTMLCalciteDropdownItemElement;
+}

package/dist/types/components/dropdown/resources.d.ts

@@ -1,6 +1,6 @@
-export declare const SLOTS: {
-  dropdownTrigger: string;
-};
-export declare const CSS: {
-  calciteDropdownContent: string;
-};
+export declare const SLOTS: {
+  dropdownTrigger: string;
+};
+export declare const CSS: {
+  calciteDropdownContent: string;
+};

package/dist/types/components/dropdown-group/dropdown-group.d.ts

@@ -1,34 +1,34 @@
-import { EventEmitter, VNode } from "../../stencil-public-runtime";
-import { RequestedItem, SelectionMode } from "./interfaces";
-import { Scale } from "../interfaces";
-/**
- * @slot - A slot for adding `calcite-dropdown-item` components.
- */
-export declare class DropdownGroup {
-  el: HTMLCalciteDropdownGroupElement;
-  /** optionally set a group title for display */
-  groupTitle?: string;
-  /**
-    specify the selection mode - multi (allow any number of (or no) active items), single (allow and require one active item),
-   none (no active items), defaults to single
-   */
-  selectionMode: SelectionMode;
-  /**
-   * Specifies the size of the action.
-   */
-  scale: Scale;
-  /**
-   * @internal
-   */
-  calciteInternalDropdownItemChange: EventEmitter<RequestedItem>;
-  componentWillLoad(): void;
-  render(): VNode;
-  updateActiveItemOnChange(event: CustomEvent): void;
-  /** position of group within a dropdown */
-  private groupPosition;
-  /** the requested group */
-  private requestedDropdownGroup;
-  /** the requested item */
-  private requestedDropdownItem;
-  private getGroupPosition;
-}
+import { EventEmitter, VNode } from "../../stencil-public-runtime";
+import { RequestedItem, SelectionMode } from "./interfaces";
+import { Scale } from "../interfaces";
+/**
+ * @slot - A slot for adding `calcite-dropdown-item` components.
+ */
+export declare class DropdownGroup {
+  el: HTMLCalciteDropdownGroupElement;
+  /** optionally set a group title for display */
+  groupTitle?: string;
+  /**
+    specify the selection mode - multi (allow any number of (or no) active items), single (allow and require one active item),
+   none (no active items), defaults to single
+   */
+  selectionMode: SelectionMode;
+  /**
+   * Specifies the size of the action.
+   */
+  scale: Scale;
+  /**
+   * @internal
+   */
+  calciteInternalDropdownItemChange: EventEmitter<RequestedItem>;
+  componentWillLoad(): void;
+  render(): VNode;
+  updateActiveItemOnChange(event: CustomEvent): void;
+  /** position of group within a dropdown */
+  private groupPosition;
+  /** the requested group */
+  private requestedDropdownGroup;
+  /** the requested item */
+  private requestedDropdownItem;
+  private getGroupPosition;
+}

package/dist/types/components/dropdown-group/interfaces.d.ts

@@ -1,5 +1,5 @@
-export declare type SelectionMode = "multi" | "single" | "none";
-export interface RequestedItem {
-  requestedDropdownItem: HTMLCalciteDropdownItemElement;
-  requestedDropdownGroup: HTMLCalciteDropdownGroupElement;
-}
+export declare type SelectionMode = "multi" | "single" | "none";
+export interface RequestedItem {
+  requestedDropdownItem: HTMLCalciteDropdownItemElement;
+  requestedDropdownGroup: HTMLCalciteDropdownGroupElement;
+}

package/dist/types/components/dropdown-group/resources.d.ts

@@ -1,5 +1,5 @@
-export declare const CSS: {
-  containerSmall: string;
-  containerMedium: string;
-  containerLarge: string;
-};
+export declare const CSS: {
+  containerSmall: string;
+  containerMedium: string;
+  containerLarge: string;
+};

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

@@ -1,63 +1,63 @@
-import { EventEmitter, VNode } from "../../stencil-public-runtime";
-import { ItemKeyboardEvent } from "../dropdown/interfaces";
-import { FlipContext } from "../interfaces";
-import { RequestedItem } from "../dropdown-group/interfaces";
-/**
- * @slot - A slot for adding text.
- */
-export declare class DropdownItem {
-  el: HTMLCalciteDropdownItemElement;
-  /**
-   * Indicates whether the item is active.
-   *
-   * @deprecated Use selected instead.
-   */
-  active: boolean;
-  activeHandler(value: boolean): void;
-  /** When true, item is selected  */
-  selected: boolean;
-  selectedHandler(value: boolean): void;
-  /** flip the icon(s) in rtl */
-  iconFlipRtl?: FlipContext;
-  /** optionally pass an icon to display at the start of an item - accepts calcite ui icon names  */
-  iconStart?: string;
-  /** optionally pass an icon to display at the end of an item - accepts calcite ui icon names  */
-  iconEnd?: string;
-  /** optionally pass a href - used to determine if the component should render as anchor */
-  href?: string;
-  /** Applies to the aria-label attribute on the button or hyperlink */
-  label?: string;
-  /** The rel attribute to apply to the hyperlink */
-  rel?: string;
-  /** The target attribute to apply to the hyperlink */
-  target?: string;
-  /**
-   * @internal
-   */
-  calciteInternalDropdownItemSelect: EventEmitter<RequestedItem>;
-  /** @internal */
-  calciteInternalDropdownItemKeyEvent: EventEmitter<ItemKeyboardEvent>;
-  /** @internal */
-  calciteInternalDropdownCloseRequest: EventEmitter<void>;
-  /** Sets focus on the component. */
-  setFocus(): Promise<void>;
-  componentWillLoad(): void;
-  connectedCallback(): void;
-  render(): VNode;
-  onClick(): void;
-  keyDownHandler(event: KeyboardEvent): void;
-  updateActiveItemOnChange(event: CustomEvent): void;
-  /** id of containing group */
-  private parentDropdownGroupEl;
-  /** requested group */
-  private requestedDropdownGroup;
-  /** requested item */
-  private requestedDropdownItem;
-  /** what selection mode is the parent dropdown group in */
-  private selectionMode;
-  /** if href is requested, track the rendered child link*/
-  private childLink;
-  private initialize;
-  private determineActiveItem;
-  private emitRequestedItem;
-}
+import { EventEmitter, VNode } from "../../stencil-public-runtime";
+import { ItemKeyboardEvent } from "../dropdown/interfaces";
+import { FlipContext } from "../interfaces";
+import { RequestedItem } from "../dropdown-group/interfaces";
+/**
+ * @slot - A slot for adding text.
+ */
+export declare class DropdownItem {
+  el: HTMLCalciteDropdownItemElement;
+  /**
+   * Indicates whether the item is active.
+   *
+   * @deprecated Use selected instead.
+   */
+  active: boolean;
+  activeHandler(value: boolean): void;
+  /** When true, item is selected  */
+  selected: boolean;
+  selectedHandler(value: boolean): void;
+  /** flip the icon(s) in rtl */
+  iconFlipRtl?: FlipContext;
+  /** optionally pass an icon to display at the start of an item - accepts calcite ui icon names  */
+  iconStart?: string;
+  /** optionally pass an icon to display at the end of an item - accepts calcite ui icon names  */
+  iconEnd?: string;
+  /** optionally pass a href - used to determine if the component should render as anchor */
+  href?: string;
+  /** Applies to the aria-label attribute on the button or hyperlink */
+  label?: string;
+  /** The rel attribute to apply to the hyperlink */
+  rel?: string;
+  /** The target attribute to apply to the hyperlink */
+  target?: string;
+  /**
+   * @internal
+   */
+  calciteInternalDropdownItemSelect: EventEmitter<RequestedItem>;
+  /** @internal */
+  calciteInternalDropdownItemKeyEvent: EventEmitter<ItemKeyboardEvent>;
+  /** @internal */
+  calciteInternalDropdownCloseRequest: EventEmitter<void>;
+  /** Sets focus on the component. */
+  setFocus(): Promise<void>;
+  componentWillLoad(): void;
+  connectedCallback(): void;
+  render(): VNode;
+  onClick(): void;
+  keyDownHandler(event: KeyboardEvent): void;
+  updateActiveItemOnChange(event: CustomEvent): void;
+  /** id of containing group */
+  private parentDropdownGroupEl;
+  /** requested group */
+  private requestedDropdownGroup;
+  /** requested item */
+  private requestedDropdownItem;
+  /** what selection mode is the parent dropdown group in */
+  private selectionMode;
+  /** if href is requested, track the rendered child link*/
+  private childLink;
+  private initialize;
+  private determineActiveItem;
+  private emitRequestedItem;
+}

package/dist/types/components/dropdown-item/resources.d.ts

@@ -1,9 +1,9 @@
-export declare const CSS: {
-  containerLink: string;
-  containerSmall: string;
-  containerMedium: string;
-  containerLarge: string;
-  containerMulti: string;
-  containerSingle: string;
-  containerNone: string;
-};
+export declare const CSS: {
+  containerLink: string;
+  containerSmall: string;
+  containerMedium: string;
+  containerLarge: string;
+  containerMulti: string;
+  containerSingle: string;
+  containerNone: string;
+};

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

@@ -1,50 +1,50 @@
-import { VNode } from "../../stencil-public-runtime";
-import { Appearance, Scale } from "../interfaces";
-import { ButtonColor } from "../button/interfaces";
-import { InteractiveComponent } from "../../utils/interactive";
-export declare class Fab implements InteractiveComponent {
-  /**
-   * Used to set the button's appearance. Default is outline.
-   */
-  appearance: Extract<"solid" | "outline", Appearance>;
-  /**
-   * Used to set the button's color. Default is light.
-   */
-  color: ButtonColor;
-  /**
-   * When true, disabled prevents interaction. This state shows items with lower opacity/grayed.
-   */
-  disabled: boolean;
-  /**
-   * The name of the icon to display. The value of this property must match the icon name from https://esri.github.io/calcite-ui-icons/.
-   *
-   * @default "plus"
-   */
-  icon?: string;
-  /**
-   * Label of the FAB, exposed on hover when textEnabled is false. If no label is provided, the label inherits what's provided for the `text` prop.
-   */
-  label?: string;
-  /**
-   * When true, content is waiting to be loaded. This state shows a busy indicator.
-   */
-  loading: boolean;
-  /**
-   * Specifies the size of the fab.
-   */
-  scale: Scale;
-  /**
-   * Text that accompanies the FAB icon.
-   */
-  text?: string;
-  /**
-   * Indicates whether the text is displayed.
-   */
-  textEnabled: boolean;
-  el: HTMLCalciteFabElement;
-  private buttonEl;
-  componentDidRender(): void;
-  /** Sets focus on the component. */
-  setFocus(): Promise<void>;
-  render(): VNode;
-}
+import { VNode } from "../../stencil-public-runtime";
+import { Appearance, Scale } from "../interfaces";
+import { ButtonColor } from "../button/interfaces";
+import { InteractiveComponent } from "../../utils/interactive";
+export declare class Fab implements InteractiveComponent {
+  /**
+   * Used to set the button's appearance. Default is outline.
+   */
+  appearance: Extract<"solid" | "outline", Appearance>;
+  /**
+   * Used to set the button's color. Default is light.
+   */
+  color: ButtonColor;
+  /**
+   * When true, disabled prevents interaction. This state shows items with lower opacity/grayed.
+   */
+  disabled: boolean;
+  /**
+   * The name of the icon to display. The value of this property must match the icon name from https://esri.github.io/calcite-ui-icons/.
+   *
+   * @default "plus"
+   */
+  icon?: string;
+  /**
+   * Label of the FAB, exposed on hover when textEnabled is false. If no label is provided, the label inherits what's provided for the `text` prop.
+   */
+  label?: string;
+  /**
+   * When true, content is waiting to be loaded. This state shows a busy indicator.
+   */
+  loading: boolean;
+  /**
+   * Specifies the size of the fab.
+   */
+  scale: Scale;
+  /**
+   * Text that accompanies the FAB icon.
+   */
+  text?: string;
+  /**
+   * Indicates whether the text is displayed.
+   */
+  textEnabled: boolean;
+  el: HTMLCalciteFabElement;
+  private buttonEl;
+  componentDidRender(): void;
+  /** Sets focus on the component. */
+  setFocus(): Promise<void>;
+  render(): VNode;
+}