@esri/calcite-components 1.0.0-beta.73 → 1.0.0-beta.74

package/dist/extras/docs-json.json

@@ -1,5 +1,5 @@
 {
-  "timestamp": "2022-01-04T23:59:03",
+  "timestamp": "2022-01-11T02:11:37",
   "compiler": {
     "name": "@stencil/core",
     "version": "2.12.1",
@@ -1740,13 +1740,51 @@
           "optional": false,
           "required": true
         },
+        {
+          "name": "placement",
+          "type": "\"bottom\" | \"bottom-end\" | \"bottom-start\" | \"top\" | \"top-end\" | \"top-start\"",
+          "mutable": false,
+          "attr": "placement",
+          "reflectToAttr": false,
+          "docs": "specify the placement of the alert",
+          "docsTags": [],
+          "default": "\"bottom\"",
+          "values": [
+            {
+              "value": "bottom",
+              "type": "string"
+            },
+            {
+              "value": "bottom-end",
+              "type": "string"
+            },
+            {
+              "value": "bottom-start",
+              "type": "string"
+            },
+            {
+              "value": "top",
+              "type": "string"
+            },
+            {
+              "value": "top-end",
+              "type": "string"
+            },
+            {
+              "value": "top-start",
+              "type": "string"
+            }
+          ],
+          "optional": false,
+          "required": false
+        },
         {
           "name": "scale",
           "type": "\"l\" | \"m\" | \"s\"",
           "mutable": false,
           "attr": "scale",
           "reflectToAttr": true,
-          "docs": "specify the scale of the button, defaults to m",
+          "docs": "specify the scale of the alert, defaults to m",
           "docsTags": [],
           "default": "\"m\"",
           "values": [
@@ -4915,7 +4953,7 @@
       "events": [
         {
           "event": "calciteComboboxChange",
-          "detail": "{ selectedItems: any[]; }",
+          "detail": "{ selectedItems: HTMLCalciteComboboxItemElement[]; }",
           "bubbles": true,
           "cancelable": true,
           "composed": true,
@@ -4933,7 +4971,7 @@
         },
         {
           "event": "calciteComboboxFilterChange",
-          "detail": "{ visibleItems: any[]; text: string; }",
+          "detail": "{ visibleItems: HTMLCalciteComboboxItemElement[]; text: string; }",
           "bubbles": true,
           "cancelable": true,
           "composed": true,
@@ -4942,7 +4980,7 @@
         },
         {
           "event": "calciteLookupChange",
-          "detail": "any[]",
+          "detail": "HTMLCalciteComboboxItemElement[]",
           "bubbles": true,
           "cancelable": true,
           "composed": true,
@@ -5031,14 +5069,14 @@
         },
         {
           "name": "ancestors",
-          "type": "any[]",
+          "type": "ComboboxChildElement[]",
           "mutable": true,
           "reflectToAttr": false,
           "docs": "Parent and grandparent combobox items, this is set internally for use from combobox",
           "docsTags": [],
           "values": [
             {
-              "type": "any[]"
+              "type": "ComboboxChildElement[]"
             }
           ],
           "optional": false,
@@ -5219,14 +5257,14 @@
       "props": [
         {
           "name": "ancestors",
-          "type": "any[]",
+          "type": "ComboboxChildElement[]",
           "mutable": true,
           "reflectToAttr": false,
           "docs": "Parent and grandparent combobox items, this is set internally for use from combobox",
           "docsTags": [],
           "values": [
             {
-              "type": "any[]"
+              "type": "ComboboxChildElement[]"
             }
           ],
           "optional": false,
@@ -6610,7 +6648,7 @@
         },
         {
           "name": "selectedItems",
-          "type": "any[]",
+          "type": "HTMLCalciteDropdownItemElement[]",
           "mutable": true,
           "reflectToAttr": false,
           "docs": "**read-only** The currently selected items",
@@ -6622,7 +6660,7 @@
           "default": "[]",
           "values": [
             {
-              "type": "any[]"
+              "type": "HTMLCalciteDropdownItemElement[]"
             }
           ],
           "optional": false,
@@ -7526,7 +7564,7 @@
         {
           "name": "back",
           "returns": {
-            "type": "Promise<any>",
+            "type": "Promise<HTMLCalcitePanelElement>",
             "docs": ""
           },
           "signature": "back() => Promise<HTMLCalcitePanelElement>",
@@ -9445,7 +9483,13 @@
           "cancelable": true,
           "composed": true,
           "docs": "Trigger calcite date change when a user changes the date.",
-          "docsTags": []
+          "docsTags": [
+            {
+              "name": "deprecated",
+              "text": "use `calciteInputDatePickerChange` instead."
+            }
+          ],
+          "deprecation": "use `calciteInputDatePickerChange` instead."
         },
         {
           "event": "calciteDatePickerRangeChange",
@@ -9458,11 +9502,35 @@
             {
               "name": "see",
               "text": " [DateRangeChange](https://github.com/Esri/calcite-components/blob/master/src/components/calcite-date-picker/interfaces.ts#L1)"
+            },
+            {
+              "name": "deprecated",
+              "text": "use `calciteInputDatePickerChange` instead."
             }
-          ]
+          ],
+          "deprecation": "use `calciteInputDatePickerChange` instead."
+        },
+        {
+          "event": "calciteInputDatePickerChange",
+          "detail": "void",
+          "bubbles": true,
+          "cancelable": true,
+          "composed": true,
+          "docs": "This event fires when the input date picker value changes.",
+          "docsTags": []
         }
       ],
       "listeners": [
+        {
+          "event": "calciteDatePickerChange",
+          "capture": false,
+          "passive": false
+        },
+        {
+          "event": "calciteDatePickerRangeChange",
+          "capture": false,
+          "passive": false
+        },
         {
           "event": "calciteDaySelect",
           "capture": false,
@@ -12602,7 +12670,7 @@
         {
           "name": "getSelectedItems",
           "returns": {
-            "type": "Promise<Map<string, any>>",
+            "type": "Promise<Map<string, HTMLCalcitePickListItemElement>>",
             "docs": ""
           },
           "signature": "getSelectedItems() => Promise<Map<string, HTMLCalcitePickListItemElement>>",
@@ -12625,7 +12693,7 @@
       "events": [
         {
           "event": "calciteListChange",
-          "detail": "Map<string, any>",
+          "detail": "Map<string, HTMLCalcitePickListItemElement>",
           "bubbles": true,
           "cancelable": true,
           "composed": true,
@@ -13006,7 +13074,7 @@
       "events": [
         {
           "event": "calciteListItemChange",
-          "detail": "{ item: any; value: any; selected: boolean; shiftPressed: boolean; }",
+          "detail": "{ item: HTMLCalcitePickListItemElement; value: any; selected: boolean; shiftPressed: boolean; }",
           "bubbles": true,
           "cancelable": true,
           "composed": true,
@@ -14151,15 +14219,14 @@
         },
         {
           "name": "selectedItem",
-          "type": "any",
+          "type": "HTMLCalciteRadioGroupItemElement",
           "mutable": true,
-          "attr": "selected-item",
           "reflectToAttr": false,
           "docs": "The group's selected item.",
           "docsTags": [],
           "values": [
             {
-              "type": "any"
+              "type": "HTMLCalciteRadioGroupItemElement"
             }
           ],
           "optional": false,
@@ -14821,9 +14888,8 @@
         },
         {
           "name": "selectedOption",
-          "type": "any",
+          "type": "HTMLCalciteOptionElement",
           "mutable": true,
-          "attr": "selected-option",
           "reflectToAttr": false,
           "docs": "The currently selected option.",
           "docsTags": [
@@ -14833,7 +14899,7 @@
           ],
           "values": [
             {
-              "type": "any"
+              "type": "HTMLCalciteOptionElement"
             }
           ],
           "optional": false,
@@ -19524,7 +19590,7 @@
         {
           "name": "getSelectedItems",
           "returns": {
-            "type": "Promise<Map<string, any>>",
+            "type": "Promise<Map<string, HTMLCalciteValueListItemElement>>",
             "docs": ""
           },
           "signature": "getSelectedItems() => Promise<Map<string, HTMLCalciteValueListItemElement>>",
@@ -19547,7 +19613,7 @@
       "events": [
         {
           "event": "calciteListChange",
-          "detail": "Map<string, any>",
+          "detail": "Map<string, HTMLCalciteValueListItemElement>",
           "bubbles": true,
           "cancelable": true,
           "composed": true,

package/dist/types/components/calcite-accordion/calcite-accordion.d.ts

@@ -0,0 +1,42 @@
+import { EventEmitter, VNode } from "../../stencil-public-runtime";
+import { AccordionAppearance } from "./interfaces";
+import { Position, Scale } from "../interfaces";
+/**
+ * @slot - A slot for adding `calcite-accordion-item`s. `calcite-accordion` cannot be nested, however calcite-accordion-item`s can.
+ */
+export declare class CalciteAccordion {
+  el: HTMLCalciteAccordionElement;
+  /** specify the appearance - default (containing border), or minimal (no containing border), defaults to default */
+  appearance: AccordionAppearance;
+  /** specify the placement of the icon in the header, defaults to end */
+  iconPosition: Position;
+  /** specify the type of the icon in the header, defaults to chevron */
+  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 */
+  selectionMode: "multi" | "single" | "single-persist";
+  /**
+   * @internal
+   */
+  calciteAccordionChange: EventEmitter;
+  componentDidLoad(): void;
+  render(): VNode;
+  calciteAccordionItemKeyEvent(e: CustomEvent): void;
+  registerCalciteAccordionItem(e: CustomEvent): void;
+  updateActiveItemOnChange(event: CustomEvent): void;
+  /** created list of Accordion items */
+  private items;
+  /** keep track of whether the items have been sorted so we don't re-sort */
+  private sorted;
+  /** keep track of the requested item for multi mode */
+  private requestedAccordionItem;
+  private focusFirstItem;
+  private focusLastItem;
+  private focusNextItem;
+  private focusPrevItem;
+  private itemIndex;
+  private focusElement;
+  private sortItems;
+}

package/dist/types/components/calcite-accordion-item/calcite-accordion-item.d.ts

@@ -0,0 +1,53 @@
+import { EventEmitter, VNode } from "../../stencil-public-runtime";
+/**
+ * @slot - A slot for adding custom content, including nested `calcite-accordion-item`s.
+ */
+export declare class CalciteAccordionItem {
+  el: HTMLCalciteAccordionItemElement;
+  /** Indicates whether the item is active. */
+  active: boolean;
+  /** pass a title for the accordion item */
+  itemTitle?: string;
+  /** pass a title for the accordion item */
+  itemSubtitle?: string;
+  /** optionally pass an icon to display - accepts Calcite UI icon names  */
+  icon?: string;
+  /**
+   * @internal
+   */
+  calciteAccordionItemKeyEvent: EventEmitter;
+  /**
+   * @internal
+   */
+  calciteAccordionItemSelect: EventEmitter;
+  /**
+   * @internal
+   */
+  calciteAccordionItemClose: EventEmitter;
+  /**
+   * @internal
+   */
+  calciteAccordionItemRegister: EventEmitter;
+  connectedCallback(): void;
+  componentDidLoad(): void;
+  render(): VNode;
+  keyDownHandler(e: KeyboardEvent): void;
+  updateActiveItemOnChange(event: CustomEvent): void;
+  /** the containing accordion element */
+  private parent;
+  /** position within parent */
+  private itemPosition;
+  /** the latest requested item */
+  private requestedAccordionItem;
+  /** what selection mode is the parent accordion in */
+  private selectionMode;
+  /** what icon position does the parent accordion specify */
+  private iconPosition;
+  /** what icon type does the parent accordion specify */
+  private iconType;
+  /** handle clicks on item header */
+  private itemHeaderClickHandler;
+  private determineActiveItem;
+  private emitRequestedItem;
+  private getItemPosition;
+}

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

@@ -0,0 +1,73 @@
+import { EventEmitter, VNode } from "../../stencil-public-runtime";
+import { Alignment, Appearance, Scale } from "../interfaces";
+/**
+ * @slot - A slot for adding a `calcite-icon`.
+ */
+export declare class CalciteAction {
+  /**
+   * Indicates whether the action is highlighted.
+   */
+  active: boolean;
+  /**
+   * Optionally specify the horizontal alignment of button elements with text content.
+   */
+  alignment?: Alignment;
+  /** Specify the appearance style of the action, defaults to solid. */
+  appearance: Extract<"solid" | "clear", Appearance>;
+  /**
+   * Compact mode is used internally by components to reduce side padding, e.g. calcite-block-section.
+   */
+  compact: boolean;
+  /**
+   * 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/.
+   */
+  icon?: string;
+  /**
+   * Indicates unread changes.
+   */
+  indicator: boolean;
+  /** string to override English loading text
+   * @default "Loading"
+   */
+  intlLoading?: string;
+  /**
+   * The label of the action. 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 action.
+   */
+  scale: Scale;
+  /**
+   * Text that accompanies the action icon.
+   */
+  text: string;
+  /**
+   * Indicates whether the text is displayed.
+   */
+  textEnabled: boolean;
+  /**
+   * Emitted when the action has been clicked.
+   * @deprecated use onClick instead.
+   */
+  calciteActionClick: EventEmitter;
+  el: HTMLCalciteActionElement;
+  buttonEl: HTMLButtonElement;
+  mutationObserver: MutationObserver;
+  connectedCallback(): void;
+  disconnectedCallback(): void;
+  /** Sets focus on the component. */
+  setFocus(): Promise<void>;
+  renderTextContainer(): VNode;
+  renderIconContainer(): VNode;
+  render(): VNode;
+  calciteActionClickHandler: () => void;
+}

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

@@ -0,0 +1,69 @@
+/// <reference types="lodash" />
+import { EventEmitter, VNode } from "../../stencil-public-runtime";
+import { Position, Scale } from "../interfaces";
+import { ConditionalSlotComponent } from "../../utils/conditionalSlot";
+/**
+ * @slot - A slot for adding `calcite-action`s that will appear at the top of the action bar.
+ * @slot bottom-actions - A slot for adding `calcite-action`s that will appear at the bottom of the action bar, above the collapse/expand button.
+ * @slot expand-tooltip - Used to set the tooltip for the expand toggle.
+ */
+export declare class CalciteActionBar implements ConditionalSlotComponent {
+  /**
+   * When set to true, the expand-toggling behavior will be disabled.
+   */
+  expandDisabled: boolean;
+  expandHandler(expandDisabled: boolean): void;
+  /**
+   * Indicates whether widget is expanded.
+   */
+  expanded: boolean;
+  expandedHandler(expanded: boolean): void;
+  /**
+   * Updates the label of the expand icon when the component is not expanded.
+   */
+  intlExpand?: string;
+  /**
+   * Updates the label of the collapse icon when the component is expanded.
+   */
+  intlCollapse?: string;
+  /**
+   * Disables automatically overflowing actions that won't fit into menus.
+   */
+  overflowActionsDisabled: boolean;
+  overflowDisabledHandler(overflowActionsDisabled: boolean): void;
+  /**
+   * Arranges the component depending on the elements 'dir' property.
+   */
+  position: Position;
+  /**
+   * Specifies the size of the expand action.
+   */
+  scale: Scale;
+  /**
+   * Emitted when expanded has been toggled.
+   */
+  calciteActionBarToggle: EventEmitter;
+  el: HTMLCalciteActionBarElement;
+  mutationObserver: MutationObserver;
+  resizeObserver: ResizeObserver;
+  expandToggleEl: HTMLCalciteActionElement;
+  componentDidLoad(): void;
+  connectedCallback(): void;
+  disconnectedCallback(): void;
+  /**
+   * Overflows actions that won't fit into menus.
+   * @internal
+   */
+  overflowActions(): Promise<void>;
+  /** Sets focus on the component. */
+  setFocus(focusId?: "expand-toggle"): Promise<void>;
+  actionMenuOpenChangeHandler: (event: CustomEvent<boolean>) => void;
+  resizeHandlerEntries: (entries: ResizeObserverEntry[]) => void;
+  resizeHandler: (entry: ResizeObserverEntry) => void;
+  resize: import("lodash").DebouncedFunc<(height: number) => void>;
+  conditionallyOverflowActions: () => void;
+  toggleExpand: () => void;
+  setExpandToggleRef: (el: HTMLCalciteActionElement) => void;
+  renderBottomActionGroup(): VNode;
+  render(): VNode;
+}

package/dist/types/components/calcite-action-group/calcite-action-group.d.ts

@@ -0,0 +1,39 @@
+import { VNode } from "../../stencil-public-runtime";
+import { Columns, Layout, Scale } from "../interfaces";
+/**
+ * @slot - A slot for adding a group of `calcite-action`s.
+ * @slot menu-actions - a slot for adding an overflow menu with actions inside a dropdown.
+ * @slot menu-tooltip - a slot for adding an tooltip for the menu.
+ */
+export declare class CalciteActionGroup {
+  /**
+   * Indicates whether widget is expanded.
+   */
+  expanded: boolean;
+  expandedHandler(): void;
+  /**
+   * Indicates the horizontal, vertical, or grid layout of the component.
+   */
+  layout: Layout;
+  /**
+   * Indicates number of columns.
+   */
+  columns?: Columns;
+  /**
+   * Text string for the actions menu.
+   */
+  intlMore?: string;
+  /**
+   * Opens the action menu.
+   */
+  menuOpen: boolean;
+  /**
+   * Specifies the size of the action-menu.
+   */
+  scale: Scale;
+  el: HTMLCalciteActionGroupElement;
+  renderTooltip(): VNode;
+  renderMenu(): VNode;
+  render(): VNode;
+  setMenuOpen: (event: CustomEvent<boolean>) => void;
+}

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

@@ -0,0 +1,82 @@
+import { EventEmitter } from "../../stencil-public-runtime";
+import { VNode } from "../../stencil-public-runtime";
+import { PopperPlacement, OverlayPositioning } from "../../utils/popper";
+import { Placement } from "@popperjs/core";
+import { Scale } from "../interfaces";
+/**
+ * @slot - A slot for adding `calcite-action`s.
+ * @slot trigger - A slot for adding a `calcite-action` to trigger opening the menu.
+ * @slot tooltip - A slot for adding an tooltip for the menu.
+ */
+export declare class CalciteActionMenu {
+  connectedCallback(): void;
+  disconnectedCallback(): void;
+  /**
+   * Indicates whether widget is expanded.
+   */
+  expanded: boolean;
+  expandedHandler(): void;
+  /**
+   * Defines the available placements that can be used when a flip occurs.
+   */
+  flipPlacements?: Placement[];
+  /**
+   *  Text string for the actions menu.
+   */
+  label: string;
+  /**
+   * Opens the action menu.
+   */
+  open: boolean;
+  openHandler(open: boolean): void;
+  /** Describes the type of positioning to use for the overlaid content. If your element is in a fixed container, use the 'fixed' value. */
+  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;
+  /**
+   * Specifies the size of the menu trigger action.
+   */
+  scale: Scale;
+  /**
+   * Emitted when the open property has changed.
+   */
+  calciteActionMenuOpenChange: EventEmitter;
+  closeCalciteActionMenuOnClick(event: Event): void;
+  el: HTMLCalciteActionMenuElement;
+  menuButtonEl: HTMLCalciteActionElement;
+  defaultMenuButtonEl: HTMLCalciteActionElement;
+  menuEl: HTMLDivElement;
+  actionElements: HTMLCalciteActionElement[];
+  mutationObserver: MutationObserver;
+  guid: string;
+  menuId: string;
+  menuButtonId: string;
+  activeMenuItemIndex: number;
+  activeMenuItemIndexHandler(): void;
+  /** Sets focus on the component. */
+  setFocus(): Promise<void>;
+  connectMenuButtonEl: () => void;
+  disconnectMenuButtonEl: () => void;
+  setDefaultMenuButtonEl: (el: HTMLCalciteActionElement) => void;
+  renderMenuButton(): VNode;
+  renderMenuItems(): VNode;
+  render(): VNode;
+  handleCalciteActionClick: () => void;
+  menuButtonClick: () => void;
+  setTooltipReferenceElement: () => void;
+  updateAction: (action: HTMLCalciteActionElement, index: number) => void;
+  updateActions: (actions: HTMLCalciteActionElement[]) => void;
+  getAssignedElements(): HTMLElement[];
+  getActions: () => void;
+  isValidKey(key: string, supportedKeys: string[]): boolean;
+  menuButtonKeyUp: (event: KeyboardEvent) => void;
+  menuButtonKeyDown: (event: KeyboardEvent) => void;
+  menuActionsContainerKeyDown: (event: KeyboardEvent) => void;
+  menuActionsContainerKeyUp: (event: KeyboardEvent) => void;
+  handleActionNavigation: (key: string, actions: HTMLCalciteActionElement[]) => void;
+  toggleOpenEnd: () => void;
+  toggleOpen: (value?: boolean) => void;
+}