@arcgis/map-components 4.34.0-next.9 → 4.34.0-next.91

package/dist/components/arcgis-expand/customElement.d.ts

@@ -1,44 +1,29 @@
 /// <reference types="@arcgis/core/interfaces.d.ts" />
-/// <reference types="../../index.d.ts" />
-import { Use } from '@arcgis/lumina/controllers';
-import { default as Expand } from '@arcgis/core/widgets/Expand.js';
-import { PublicLitElement as LitElement, TargetedEvent } from '@arcgis/lumina';
+/// <reference path="../../index.d.ts" />
 import { ArcgisReferenceElement } from '../../utils/component-utils';
+import { default as ExpandViewModel } from '@arcgis/core/widgets/Expand/ExpandViewModel.js';
+import { Use } from '@arcgis/lumina/controllers';
+import { EventEmitter, JsxNode, PublicLitElement as LitElement, TargetedEvent } from '@arcgis/lumina';
+import { nil } from '@arcgis/toolkit/type';
 
-declare const useExpandWidget: (component: LitElement & Pick<Expand, "icon" | "label" | "viewModel" | "autoCollapse" | "closeOnEsc" | "collapseIcon" | "collapseTooltip" | "content" | "expandIcon" | "expandTooltip" | "expanded" | "focusTrapDisabled" | "group" | "iconNumber" | "mode" | "placement"> & {
-    state?: unknown;
-    viewModel?: __esri.ExpandViewModel | undefined;
-    closed?: boolean;
-    icon: import('@arcgis/components-utils').Nil | string;
-    label: import('@arcgis/components-utils').Nil | string;
-    referenceElement?: ArcgisReferenceElement | string;
-    position: __esri.UIPosition;
-    arcgisReady: import('@arcgis/lumina').EventEmitter;
-    arcgisPropertyChange: import('@arcgis/lumina').EventEmitter<{
-        name: string;
-    }> | undefined;
-    el: HTMLElement & {
-        childElem?: HTMLElement & {
-            ownedBy?: HTMLElement;
-        };
-        view?: __esri.LinkChartView | __esri.MapView | __esri.SceneView;
-    };
-    autoDestroyDisabled: boolean;
-    destroy: () => Promise<void>;
-}) => Expand;
-/**
- * The Expand component acts as a clickable button for displaying interactive content, most commonly other components.
- *
- * [Read more...](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-expand/)
- */
+type HTMLElementWithIcon = HTMLElement & {
+    icon?: IconName;
+};
+type ContentSource = HTMLElement | HTMLElementWithIcon | string;
+type IconName = HTMLCalciteIconElement["icon"];
+declare const useExpandViewModel: (component: LitElement & Pick<ExpandViewModel, never> & import('../../controllers/useViewModel').ViewModelControllerUses<ExpandViewModel>) => ExpandViewModel;
+/** [Read more...](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-expand/) */
 export declare class ArcgisExpand extends LitElement {
     /**
-     * Automatically collapses the expand widget instance when the view's
-     * viewpoint updates.
+     * The view model's state.
      *
-     * @default false
+     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Expand-ExpandViewModel.html#state)
+     *
+     * @default "disabled"
      */
-    autoCollapse: boolean;
+    readonly state: "ready" | "disabled";
+    /** The component's default label. */
+    label?: string;
     /**
      * If true, the component will not be destroyed automatically when it is
      * disconnected from the document. This is useful when you want to move the
@@ -49,30 +34,56 @@ export declare class ArcgisExpand extends LitElement {
      * @default false
      */
     autoDestroyDisabled: boolean;
+    /** @default "top-left" */
+    position: __esri.UIPosition;
+    referenceElement?: ArcgisReferenceElement | string;
     /**
-     * When true, the Expand widget will close after the Escape key is pressed when the keyboard focus is within its content.
+     * Automatically collapses the expand widget instance when the view's
+     * [viewpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#viewpoint) updates.
      *
-     * @default true
+     * @default false
      */
-    closeOnEsc: boolean | Function;
+    autoCollapse: boolean;
     /**
-     * Calcite icon used to style the Expand button when the [content](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Expand.html#content) can be collapsed.
-     *
-     * @default "chevrons-right"
+     * When true, the Expand widget will close after the Escape key is pressed when the keyboard focus is within its content.
+     * This property can also be set to a function that returns a boolean, allowing for more customization for when to allow the Expand widget
+     * to be closed from the `esc` key.
+     *
+     * @example
+     * let expand = new Expand({
+     *    view: view,
+     *    content: search,
+     *    // widget will not be able to be closed from the ESC key
+     *    closeOnEsc: false
+     * });
+     * @example
+     * let expand = new Expand({
+     *    view: view,
+     *    content: search,
+     *    // widget will close on ESC when Search has no active menu
+     *    closeOnEsc: function() {
+     *      return search.activeMenu === "none"
+     *    }
+     * });
+     * @default true
      */
-    collapseIcon: string;
+    closeOnEsc: boolean | ((event: KeyboardEvent) => boolean);
     /**
-     * Tooltip to display to indicate Expand widget can be collapsed.
+     * Indicates whether the widget is currently expanded or not.
      *
-     * @default "Collapse" (English locale)
+     * @default false
      */
-    collapseTooltip: string;
+    expanded: boolean;
     /**
      * Calcite icon used when the widget is collapsed.
+     * Will automatically use the [content's](#content) icon if it has one.
      *
+     * @see [Calcite Icon Search](https://developers.arcgis.com/calcite-design-system/icons/)
+     * @since 4.27
      * @default "chevrons-left"
      */
-    expandIcon: string | nullish;
+    get expandIcon(): IconName | nil;
+    set expandIcon(value: IconName | nil);
     /**
      * Tooltip to display to indicate Expand widget can be expanded.
      *
@@ -80,66 +91,94 @@ export declare class ArcgisExpand extends LitElement {
      */
     expandTooltip: string;
     /**
-     * Indicates whether the widget is currently expanded or not.
+     * Calcite icon used to style the Expand button when the [content](#content) can be collapsed.
      *
-     * @default false
+     * @see [Calcite Icon Search](https://developers.arcgis.com/calcite-design-system/icons/)
+     * @since 4.27
+     * @default "chevrons-right"
      */
-    expanded: boolean;
+    get collapseIcon(): IconName;
+    set collapseIcon(value: IconName | nil);
     /**
-     * Disables focus trapping within the expand widget.
-     *
-     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Expand.html#focusTrapDisabled)
+     * Tooltip to display to indicate Expand widget can be collapsed.
      *
-     * @deprecated since 4.33. Use [`focusTrapDisabled`](#focusTrapDisabled) instead.
-     * @default false
+     * @default "Collapse" (English locale)
      */
-    focusTrapEnabled: boolean;
+    collapseTooltip: string;
     /**
-     * Disables focus trapping within the expand component.
+     * TODO: [MIGRATION] rename to focusTrapEnabled to match the name the wrapped widget had
      *
      * @default false
      */
     focusTrapDisabled: boolean;
     /**
      * This value associates two or more Expand widget instances with each other, allowing one
-     * instance to auto collapse when another instance in the same group is expanded.
-     *
-     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Expand.html#group)
+     * instance to auto collapse when another instance in the same group is expanded. For auto collapsing
+     * to take effect, all instances of the group must be included in the view's `ui` property.
+     *
+     * For example, if you place multiple Expand instances in the top-left of the view's ui, you can assign them to a
+     * group called `top-left`. If one Expand instance is expanded and the user clicks on a different instance in the
+     * `top-left` group, then the first instance is collapsed, allowing the content of the second instance to be
+     * fully visible.
+     *
+     * @since 4.6
+     * @example
+     * let expand1 = new Expand({
+     *   view: view,
+     *   content: document.getElementById("bg-gallery"),
+     *   expandIcon: "basemap",
+     *   group: "bottom-right"
+     * });
+     * let expand2 = new Expand({
+     *   view: view,
+     *   content: document.getElementById("legend"),
+     *   expandIcon: "key",
+     *   group: "bottom-right"
+     * });
+     *
+     * view.ui.add([expand1, expand2], "bottom-right");
      */
     group: string | nullish;
     /**
      * A number to display at the corner of the widget to indicate the number of, for example, open issues or unread notices.
      *
-     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Expand.html#iconNumber)
+     * ![expand widget icon number](../assets/img/apiref/widgets/expand-with-iconnumber.png)
+     *
+     * @default 0
      */
     iconNumber: number;
     /**
-     * The widget's default label.
+     * The mode in which the widget displays. These modes are listed below.
      *
-     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Expand.html#label)
-     */
-    label: string;
-    /**
-     * The mode in which the widget displays.
+     * mode | description
+     * ---------------|------------
+     * auto | This is the default mode. It is responsive to browser size changes and will update based on whether the widget is viewed in a desktop or mobile application.
+     * floating | Use this mode if you wish to always display the widget as floating regardless of browser size.
+     * drawer | Use this mode if you wish to always display the widget in a panel regardless of browser size.
      *
+     * @since 4.7
      * @default "auto"
      */
-    mode: "auto" | "floating" | "drawer";
+    mode: "auto" | "drawer" | "floating";
     /**
      * The placement used by the [calcite popover](https://developers.arcgis.com/calcite-design-system/components/popover/) when the widget is expanded.
      *
-     * @default null
+     * @since 4.30
      */
-    placement: nullish | "left" | "right" | "top" | "bottom" | "auto" | "auto-start" | "auto-end" | "top-start" | "top-end" | "bottom-start" | "bottom-end" | "right-start" | "right-end" | "left-start" | "left-end" | "leading-start" | "leading" | "leading-end" | "trailing-end" | "trailing" | "trailing-start";
-    /** @default "top-right" */
-    position: __esri.UIPosition;
-    referenceElement?: ArcgisReferenceElement | string;
+    placement?: HTMLCalcitePanelElement["menuPlacement"];
+    /** Overwrite localized strings for this component */
+    messageOverrides?: typeof this.messages._overrides;
+    /** Collapse the widget. */
     collapse(): Promise<void>;
     /** Permanently destroy the component. */
     destroy(): Promise<void>;
+    /** Expand the widget. */
     expand(): Promise<void>;
-    toggle(): Promise<void>;
-    /** Emitted when the component associated with a map or scene view is is ready to be interacted with. */
+    /** Emitted when the component associated with a map or scene view is ready to be interacted with. */
     readonly arcgisReady: TargetedEvent<this, void>;
+    private messages;
+    readonly _setterTypes: {
+        collapseIcon?: IconName | nil;
+    };
 }
 export {};

package/dist/components/arcgis-expand/customElement.js

@@ -1,39 +1,139 @@
-import { c as t } from "../../chunks/runtime.js";
-import e from "@arcgis/core/widgets/Expand.js";
-import { LitElement as s, createEvent as i, noShadowRoot as o } from "@arcgis/lumina";
-import { m as a } from "../../chunks/useWidget.js";
-import { css as n } from "@lit/reactive-element/css-tag.js";
+import { c as x } from "../../chunks/runtime.js";
+import { css as m, html as i } from "lit";
+import { watch as v } from "@arcgis/core/core/reactiveUtils.js";
+import { g as d } from "../../chunks/globalCss.js";
+import { u as f } from "../../chunks/useT9n.js";
+import { createRef as h, ref as g } from "lit-html/directives/ref.js";
+import w from "@arcgis/core/widgets/Expand/ExpandViewModel.js";
+import { c as _ } from "../../chunks/index.js";
+import { m as $ } from "../../chunks/useViewModel.js";
+import { LitElement as b, createEvent as y, safeClassMap as n, nothing as C } from "@arcgis/lumina";
 /*! All material copyright Esri, All Rights Reserved, unless otherwise specified.
 See https://js.arcgis.com/4.34/esri/copyright.txt for details.
-v4.34.0-next.9 */
-const d = n`@layer{arcgis-expand{display:flex;pointer-events:auto}arcgis-expand>.esri-expand__content--expanded{background-color:var(--calcite-color-background)}}`, c = a(e);
-class l extends s {
+v4.34.0-next.91 */
+const E = m`:host{display:flex;pointer-events:auto;--arcgis-expand-icon-number-left: none;--arcgis-expand-icon-number-right: none}arcgis-expand>.arcgis-expand__content--expanded{background-color:var(--calcite-color-background)}.arcgis-expand{--esri-widget-panel-max-height: 95vh;--calcite-sheet-max-height: var(--esri-widget-panel-max-height);--calcite-sheet-height: auto;min-width:32px;min-height:32px}.arcgis-expand__toggle{position:relative}.arcgis-expand__popover-content{flex-direction:column;display:flex;max-height:var(--arcgis-expand-max-height, 95vh);overflow-y:auto}.arcgis-expand__popover-content .esri-widget--panel{width:300px}.arcgis-expand__panel{max-height:var(--esri-widget-panel-max-height)}.arcgis-expand__panel-content .esri-widget{width:auto}.arcgis-expand__panel-content .esri-widget--panel{flex:auto}.arcgis-map-container-ui__element .arcgis-expand__popover-content .esri-widget,.arcgis-map-container-ui__element .arcgis-expand__popover-content .esri-widget.esri-component,.arcgis-map-container-ui__element .arcgis-expand__panel-content .esri-widget,.arcgis-map-container-ui__element .arcgis-expand__panel-content .esri-widget.esri-component,.arcgis-expand__popover-content .esri-widget,.arcgis-expand__popover-content .esri-widget.esri-component,.arcgis-expand__panel-content .esri-widget,.arcgis-expand__panel-content .esri-widget.esri-component{box-sizing:border-box;box-shadow:none;margin-bottom:0}.arcgis-expand__panel-content,.arcgis-expand__content-container{background-color:var(--calcite-color-foreground-1);flex-direction:column;flex:auto;justify-content:stretch;display:flex}.arcgis-expand__sheet .arcgis-expand__panel-content,.arcgis-expand__sheet .arcgis-expand__content-container{overflow:hidden}.arcgis-expand__panel-icon-number{align-self:center}.esri-collapse__icon{display:flex}calcite-button:not(:hover) .esri-collapse__icon:not(calcite-icon){color:var(--calcite-color-text-3)}.esri-collapse__icon-flip{transform:rotate(var(--arcgis-collapse-icon-flip))}.arcgis-expand__icon-number{transform-origin:50%;color:var(--calcite-color-text-inverse);pointer-events:none;background-color:var(--calcite-color-text-3);border-radius:var(--calcite-spacing-xl);justify-content:center;align-items:center;height:var(--calcite-spacing-md);padding:.125em .333em;font-size:var(--calcite-font-size-sm);line-height:1em;display:flex;position:absolute;top:-6px;left:var(--arcgis-expand-icon-number-left);right:var(--arcgis-expand-icon-number-right)}`, a = "arcgis-expand", o = {
+  base: a,
+  toggle: `${a}__toggle`,
+  popoverContent: `${a}__popover-content`,
+  panel: `${a}__panel`,
+  panelContent: `${a}__panel-content`,
+  sheet: `${a}__sheet`,
+  contentContainer: `${a}__content-container`,
+  icon: "arcgis-collapse__icon",
+  iconFlip: "arcgis-collapse__icon-flip",
+  iconNumber: `${a}__icon-number`
+}, r = "chevrons-left", p = "chevrons-right", M = $(w);
+class T extends b {
   constructor() {
-    super(), this.widget = c(this), this.viewModel = this.widget.viewModel, this.autoCollapse = this.widget.autoCollapse, this.autoDestroyDisabled = !1, this.closeOnEsc = this.widget.closeOnEsc, this.collapseIcon = this.widget.collapseIcon, this.collapseTooltip = this.widget.collapseTooltip, this.content = this.widget.content, this.expandIcon = this.widget.expandIcon, this.expandTooltip = this.widget.expandTooltip, this.expanded = this.widget.expanded, this.focusTrapEnabled = this.widget.focusTrapDisabled, this.focusTrapDisabled = this.widget.focusTrapDisabled, this.group = this.widget.group, this.icon = this.widget.icon, this.iconNumber = this.widget.iconNumber, this.label = this.widget.label, this.mode = this.widget.mode, this.placement = this.widget.placement, this.position = "top-right", this.arcgisReady = i(), this.content = document.createElement("div");
+    super(...arguments), this.popoverEl = h(), this.messages = f({}), this.viewModel = M(this), this.toggleActionEl = h(), this._collapseIcon = p, this._expandIcon = r, this.state = this.viewModel.state, this.autoDestroyDisabled = !1, this.position = /* TODO: [MIGRATION] review default value */
+    "top-left", this.autoCollapse = this.viewModel.autoCollapse, this.closeOnEsc = !0, this.content = "", this.expanded = this.viewModel.expanded, this.expandTooltip = "", this.collapseTooltip = "", this.focusTrapDisabled = !1, this.group = this.viewModel.group, this.iconNumber = 0, this.mode = "auto", this.arcgisReady = y();
   }
   static {
-    this.properties = { autoCollapse: 5, autoDestroyDisabled: 5, closeOnEsc: 5, collapseIcon: 1, collapseTooltip: 1, content: 1, expandIcon: 1, expandTooltip: 1, expanded: 7, focusTrapEnabled: 5, focusTrapDisabled: 5, group: 1, icon: 1, iconNumber: 9, label: 1, mode: 1, placement: 1, position: 1, referenceElement: 1 };
+    this.properties = { expandTitle: 16, _displaySheet: 16, state: 3, icon: 1, label: 1, autoDestroyDisabled: 5, position: 3, referenceElement: 1, autoCollapse: 5, closeOnEsc: 5, content: 1, expanded: 5, expandIcon: 1, expandTooltip: 1, collapseIcon: 1, collapseTooltip: 1, focusTrapDisabled: 5, group: 1, iconNumber: 9, mode: 1, placement: 1, messageOverrides: 0 };
   }
   static {
-    this.shadowRootOptions = o;
+    this.styles = E;
   }
-  static {
-    this.styles = d;
+  get expandTitle() {
+    const { expanded: e, messages: t, collapseTooltip: l, expandTooltip: s } = this;
+    return (e ? l || t.collapse : s || t.expand) ?? "";
+  }
+  get _displaySheet() {
+    switch (this.mode) {
+      case "drawer":
+        return !0;
+      case "auto":
+        return this.viewModel.view?.widthBreakpoint === "xsmall";
+      default:
+        return !1;
+    }
+  }
+  get expandIcon() {
+    return this.content.icon ?? this._expandIcon ?? r;
+  }
+  set expandIcon(e) {
+    this._expandIcon = e;
+  }
+  get collapseIcon() {
+    return this._collapseIcon ?? p;
+  }
+  set collapseIcon(e) {
+    this._collapseIcon = e;
   }
   async collapse() {
-    this.widget?.collapse();
+    this.viewModel.expanded = !1;
   }
   async destroy() {
     await this.manager.destroy();
   }
   async expand() {
-    this.widget?.expand();
+    this.viewModel.expanded = !0;
+  }
+  loaded() {
+    this.manager.onLifecycle(() => [
+      v(() => this.viewModel?.view?.size, () => this.popoverEl?.value?.reposition(), { initial: !0 })
+    ]);
+  }
+  toggle() {
+    this.viewModel.expanded = !this.viewModel.expanded;
+  }
+  getPopoverPlacement() {
+    if (this.placement)
+      return this.placement;
+    switch (this.position) {
+      case "bottom-leading":
+      case "bottom-left":
+        return "right";
+      case "bottom-right":
+      case "bottom-trailing":
+        return "left-end";
+      case "top-leading":
+      case "top-left":
+        return "right";
+      case "top-right":
+      case "top-trailing":
+        return "left";
+      case "manual":
+      default:
+        return "auto";
+    }
+  }
+  _willCloseOnEsc(e) {
+    const { closeOnEsc: t } = this;
+    return typeof t == "function" ? t(e) : t;
+  }
+  _handlePopoverClose(e) {
+    e.target === this.popoverEl.value && (this.viewModel.expanded = e.currentTarget.open);
+  }
+  _handleSheetClose(e) {
+    this.viewModel.expanded = e.currentTarget.open;
+  }
+  _handlePanelClose(e) {
+    this.viewModel.expanded = !e.currentTarget.closed;
+  }
+  _handleKeyDown(e) {
+    this.viewModel.expanded && e.key === "Escape" && !this._willCloseOnEsc(e) && e.preventDefault();
+  }
+  render() {
+    const { _displaySheet: e, toggleActionEl: t, viewModel: { expanded: l }, label: s } = this;
+    return i`<div class=${n(_(o.base, d.widget))}>${this._renderToggle()}${e ? i`<calcite-sheet class=${n(o.sheet)} height=l .label=${s ?? ""} @keydown=${this._handleKeyDown} .open=${l} position=block-end @calciteSheetClose=${this._handleSheetClose}><calcite-panel class=${n(o.panel)} closable .closed=${!l} .heading=${s} @keydown=${this._handleKeyDown} @calcitePanelClose=${this._handlePanelClose}><div class=${n(o.panelContent)}>${this._renderContent()}</div></calcite-panel></calcite-sheet>` : t.value ? i`<calcite-popover .focusTrapDisabled=${this.focusTrapDisabled} .label=${s ?? ""} @keydown=${this._handleKeyDown} trigger-disabled .open=${this.viewModel.expanded} overlay-positioning=fixed .placement=${this.getPopoverPlacement()} .referenceElement=${t.value} @calcitePopoverClose=${this._handlePopoverClose} ${g(this.popoverEl)}><div class=${n(o.popoverContent)}>${this._renderContent()}</div></calcite-popover>` : null}</div>`;
+  }
+  _renderBadgeNumber() {
+    const { expanded: e, iconNumber: t } = this;
+    return t && !e ? i`<span class=${n(o.iconNumber)}>${t}</span>` : null;
+  }
+  _renderToggleButton() {
+    const { expanded: e, expandTitle: t, expandIcon: l, collapseIcon: s } = this, c = e ? s : l, u = c === r || c === p;
+    return i`<calcite-action class=${n(d.widgetButton)} @click=${this.toggle} scale=s .text=${t} title=${t ?? C} ${g(this.toggleActionEl)}>${c ? i`<calcite-icon class=${n(_(o.icon, u && o.iconFlip))} .icon=${c} scale=s></calcite-icon>` : null}</calcite-action>`;
+  }
+  _renderToggle() {
+    return i`<div class=${n(o.toggle)}>${this._renderToggleButton()}${this._renderBadgeNumber()}</div>`;
   }
-  async toggle() {
-    this.expanded ? await this.collapse() : await this.expand();
+  _renderContent() {
+    return i`<div class=${n(o.contentContainer)}><slot></slot></div>`;
   }
 }
-t("arcgis-expand", l);
+x("arcgis-expand", T);
 export {
-  l as ArcgisExpand
+  T as ArcgisExpand
 };

package/dist/components/arcgis-expand/index.d.ts

@@ -1 +1,6 @@
+import "@esri/calcite-components/components/calcite-sheet";
+import "@esri/calcite-components/components/calcite-panel";
+import "@esri/calcite-components/components/calcite-popover";
+import "@esri/calcite-components/components/calcite-action";
+import "@esri/calcite-components/components/calcite-icon";
 export * from "./customElement.js";

package/dist/components/arcgis-expand/index.js

@@ -1 +1,6 @@
+import "@esri/calcite-components/components/calcite-sheet";
+import "@esri/calcite-components/components/calcite-panel";
+import "@esri/calcite-components/components/calcite-popover";
+import "@esri/calcite-components/components/calcite-action";
+import "@esri/calcite-components/components/calcite-icon";
 export * from "./customElement.js";