@arcgis/map-components 4.32.0-next.98 → 4.32.0

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

@@ -12,29 +12,10 @@ declare const useZoomViewModel: (component: import('@arcgis/components-controlle
     el: HTMLElement;
     autoDestroyDisabled?: boolean;
     destroy?: () => Promise<void>;
-} & Pick<ZoomViewModel, never> & {
-    reactiveUtils?: typeof __esri.reactiveUtils;
-    state?: "ready" | "disabled" | undefined;
-    icon: Nil | string;
-    label: Nil | string;
-    referenceElement: ArcgisReferenceElement | Nil | string;
-    arcgisReady: import('@arcgis/components-controllers').EventEmitter;
-    position: __esri.UIPosition;
-    arcgisPropertyChange: import('@arcgis/components-controllers').EventEmitter<{
-        name: string;
-    }> | undefined;
-    el: HTMLElement & {
-        childElem?: HTMLElement & {
-            ownedBy?: HTMLElement;
-        };
-        view?: __esri.MapView | __esri.SceneView | undefined;
-    };
-    autoDestroyDisabled: boolean;
-    destroy: () => Promise<void>;
-}, options?: {
+} & Pick<ZoomViewModel, never> & import('../../controllers/useViewModel').ViewModelControllerUses<ZoomViewModel>, options?: {
     editConstructorProperties(props: unknown): unknown;
 } | undefined) => ZoomViewModel;
-/** [Zoom](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Zoom.html) allows users to zoom in/out within a view.
+/** Zoom component allows users to zoom in/out within a view.
  */
 export declare class ArcgisZoom extends LitElement {
     private messages: Partial<{
@@ -54,16 +35,19 @@ export declare class ArcgisZoom extends LitElement {
      * \`destroy\` method when you are done to prevent memory leaks.
      */
     autoDestroyDisabled: boolean;
-    /** Icon which represents the widget. */
+    /** Icon which represents the component. */
     icon: Nil | string;
     /** The component's default label. */
     label: Nil | string;
     /** Determines the layout/orientation of the Zoom widget. */
     layout: Layout;
-    /** Overwrite localized strings for this component */
+    /** Replace localized message strings with your own strings. */
     messageOverrides?: typeof this.messages._overrides;
     position: __esri.UIPosition;
     referenceElement: ArcgisReferenceElement | Nil | string;
+    /**
+     * The current state of the component.
+     */
     readonly state: "ready" | "disabled";
     /** Permanently destroy the component */
     destroy(): Promise<void>;

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

@@ -3,31 +3,32 @@ import { html as m } from "lit-html";
 import { usePropertyChange as u } from "@arcgis/components-controllers";
 import { classes as t } from "@arcgis/components-utils";
 import d from "@arcgis/core/widgets/Zoom/ZoomViewModel.js";
-import { LitElement as h, createEvent as z, noShadowRoot as g, safeClassMap as s, nothing as a } from "@arcgis/lumina";
-import { u as p, m as b } from "../../chunks/useViewModel.js";
-import { css as w } from "@lit/reactive-element/css-tag.js";
+import { LitElement as h, createEvent as z, noShadowRoot as p, safeClassMap as s, nothing as a } from "@arcgis/lumina";
+import { u as g } from "../../chunks/useView.js";
+import { m as b } from "../../chunks/useViewModel.js";
+import { css as y } from "@lit/reactive-element/css-tag.js";
 /*! All material copyright Esri, All Rights Reserved, unless otherwise specified.
 See https://js.arcgis.com/4.32/esri/copyright.txt for details.
-v4.32.0-next.98 */
+v4.32.0 */
 const o = {
   base: "arcgis-zoom",
   horizontalLayout: "arcgis-zoom--horizontal",
   button: "esri-widget--button",
   zoomIn: "arcgis-zoom__zoom-in",
   zoomOut: "arcgis-zoom__zoom-out"
-}, y = w`arcgis-zoom,.arcgis-zoom{display:flex;flex-flow:column nowrap}.arcgis-zoom__zoom-out{border-block-start:solid 1px var(--calcite-color-border-1)}.arcgis-zoom--horizontal{flex-flow:row-reverse nowrap}.arcgis-zoom--horizontal .arcgis-zoom__zoom-out{border-block-start:none;border-inline-end:solid 1px var(--calcite-color-border-1)}`, f = b(d);
+}, f = y`@layer{arcgis-zoom,.arcgis-zoom{display:flex;flex-flow:column nowrap}.arcgis-zoom__zoom-out{border-block-start:solid 1px var(--calcite-color-border-1)}.arcgis-zoom--horizontal{flex-flow:row-reverse nowrap}.arcgis-zoom--horizontal .arcgis-zoom__zoom-out{border-block-start:none;border-inline-end:solid 1px var(--calcite-color-border-1)}}`, w = b(d);
 class v extends h {
   constructor() {
-    super(...arguments), this.messages = p({}), this.viewModel = f(this), this.canZoomIn = this.viewModel.canZoomIn, this.canZoomOut = this.viewModel.canZoomOut, this.autoDestroyDisabled = !1, this.icon = "magnifying-glass-plus", this.layout = "vertical", this.position = "top-left", this.state = this.viewModel.state, this.arcgisPropertyChange = u()("state"), this.arcgisReady = z();
+    super(...arguments), this.messages = g({}), this.viewModel = w(this), this.canZoomIn = this.viewModel.canZoomIn, this.canZoomOut = this.viewModel.canZoomOut, this.autoDestroyDisabled = !1, this.icon = "magnifying-glass-plus", this.layout = "vertical", this.position = "top-left", this.state = this.viewModel.state, this.arcgisPropertyChange = u()("state"), this.arcgisReady = z();
   }
   static {
     this.properties = { canZoomIn: 16, canZoomOut: 16, autoDestroyDisabled: 5, icon: 3, label: 1, layout: 3, messageOverrides: 0, position: 1, referenceElement: 1, state: 3 };
   }
   static {
-    this.shadowRootOptions = g;
+    this.shadowRootOptions = p;
   }
   static {
-    this.styles = y;
+    this.styles = f;
   }
   // #endregion
   // #region Public Methods

package/dist/controllers/useView.d.ts

@@ -0,0 +1,42 @@
+/// <reference types="@arcgis/core/interfaces.d.ts" />
+import { BaseComponent, EventEmitter, GenericController } from '@arcgis/components-controllers';
+import { Nil } from '@arcgis/components-utils';
+import { default as MapView } from '@arcgis/core/views/MapView';
+import { default as SceneView } from '@arcgis/core/views/SceneView';
+import { default as LinkChartView } from '@arcgis/core/views/LinkChartView';
+import { ArcgisReferenceElement } from '../utils/component-utils';
+type View = LinkChartView | MapView | SceneView;
+type ViewControllerRequires<ViewType extends View> = BaseComponent & ViewControllerUses<ViewType>;
+export interface ViewControllerUses<ViewType extends View> {
+    view?: Nil | ViewType;
+    position: __esri.UIPosition;
+    referenceElement: ArcgisReferenceElement | Nil | string;
+    arcgisReady: EventEmitter;
+    el: HTMLElement & {
+        childElem?: HTMLElement & {
+            ownedBy?: HTMLElement;
+        };
+        view?: Nil | ViewType;
+    };
+    autoDestroyDisabled: boolean;
+    destroy: () => Promise<void>;
+}
+/**
+ * Creates a controller which adds a `view` property to the component and connects the component to that view, both when
+ * the view is provided directly or linked via the `referenceElement` property. The controller also handles emitting the
+ * `arcgisViewReady` event and removing the component from the view's UI when the component is disconnected.
+ */
+export declare const useView: <ViewType extends View = View>(component: ViewControllerRequires<ViewType>) => ViewType | undefined;
+export declare class ViewController<ViewType extends View = View> extends GenericController<ViewType | undefined, ViewControllerRequires<ViewType>> {
+    private _view$;
+    private _viewDestroyHandle;
+    private _arcgisReadyEmitted;
+    constructor(component: ViewControllerRequires<ViewType>);
+    hostConnected(): void;
+    hostLoad(): void;
+    hostLoaded(): void;
+    hostDisconnected(): void;
+    hostDestroy(): void;
+    private _watchMetaProperties;
+}
+export {};

package/dist/controllers/useViewModel.d.ts

@@ -1,35 +1,29 @@
-/// <reference types="@arcgis/core/interfaces.d.ts" />
 import { BaseComponent, EventEmitter } from '@arcgis/components-controllers';
 import { AccessorController } from '@arcgis/components-controllers/accessor';
 import { Nil } from '@arcgis/components-utils';
+import { default as Accessor } from '@arcgis/core/core/Accessor';
+import { default as Evented } from '@arcgis/core/core/Evented';
 import { default as ArcgisMap } from '@arcgis/core/Map';
-import { ArcgisReferenceElement } from '../utils/component-utils';
-type Requires<Props, ViewModel extends ViewModelInstance> = BaseComponent & Pick<ViewModel, keyof Props & keyof ViewModel> & Uses<ViewModel>;
-type ViewModelInstance = __esri.Accessor & Partial<__esri.Evented> & {
+import { default as MapView } from '@arcgis/core/views/MapView';
+import { default as SceneView } from '@arcgis/core/views/SceneView';
+import { default as LinkChartView } from '@arcgis/core/views/LinkChartView';
+import { ViewControllerUses, ViewController } from './useView';
+type ViewModelControllerRequires<Props, ViewModel extends ViewModelInstance> = BaseComponent & Pick<ViewModel, keyof Props & keyof ViewModel> & ViewModelControllerUses<ViewModel>;
+type ViewModelInstance = Accessor & Partial<Evented> & {
     state?: string;
-    view?: __esri.MapView | __esri.SceneView | nullish;
+    view?: LinkChartView | MapView | Nil | SceneView;
     map?: ArcgisMap | Nil;
 };
-type Uses<ViewModel extends ViewModelInstance> = {
-    reactiveUtils?: typeof __esri.reactiveUtils;
+export interface ViewModelControllerUses<ViewModel extends ViewModelInstance> extends ViewControllerUses<NonNullable<ViewModelInstance["view"]>> {
     state?: ViewModel["state"];
     icon: Nil | string;
     label: Nil | string;
-    referenceElement: ArcgisReferenceElement | Nil | string;
-    arcgisReady: EventEmitter;
-    position: __esri.UIPosition;
     arcgisPropertyChange: EventEmitter<{
         name: string;
     }> | undefined;
-    el: HTMLElement & {
-        childElem?: HTMLElement & {
-            ownedBy?: HTMLElement;
-        };
-        view?: __esri.MapView | __esri.SceneView | undefined;
-    };
     autoDestroyDisabled: boolean;
     destroy: () => Promise<void>;
-};
+}
 /**
  * A controller for a mapping component that:
  * - loads the viewModel
@@ -53,31 +47,13 @@ export declare const makeViewModelController: <Props, ViewModel extends ViewMode
      * \@State() timeZone = this.viewModel.timeZone;
      */
     omitProps: OmitProps[];
-}) => (component: Requires<Omit<Props, OmitProps>, ViewModel>, options?: {
+}) => (component: ViewModelControllerRequires<Omit<Props, OmitProps>, ViewModel>, options?: {
     editConstructorProperties(props: Props): Promise<Props> | Props;
 }) => ViewModel;
-export declare class ViewModelController<Props, ViewModel extends ViewModelInstance> extends AccessorController<Props, ViewModel, Uses<ViewModel>> {
-    hostConnected(): void;
+export declare class ViewModelController<Props, ViewModel extends ViewModelInstance> extends AccessorController<Props, ViewModel, ViewModelControllerUses<ViewModel>> {
+    viewController: ViewController<MapView | SceneView | LinkChartView>;
+    private _viewWatchHandle;
     hostLoad(): Promise<void>;
-    hostLoaded(): void;
-    hostDisconnected(): void;
     hostDestroy(): void;
-    private _watchMetaProperties;
-    /**
-     * Destroy the component if view gets destroyed.
-     *
-     * When view is destroyed, component disconnect is triggered, which will
-     * destroy the component in 1s but that can be too late, because in the
-     * meanwhile, a watcher on the widget/viewModel instance may get triggered,
-     * and throw an error if it's not able to access this.view.map or etc
-     * (happens in VersionManagementViewModel for example).
-     *
-     * We can't check for this in disconnectedCallback though as, if the entire
-     * component tree is removed, the disconnect for the component will be
-     * triggered before that of arcgis-map, so the view might not be destroyed
-     * yet at that point.
-     */
-    private _watchViewDestroy;
-    private _watchViewDestroyHandle?;
 }
 export {};