@arcgis/map-components 4.33.0-next.111 → 4.33.0-next.112

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

@@ -7,40 +7,55 @@ import { JsxNode, PublicLitElement as LitElement, TargetedEvent } from '@arcgis/
 import { ArcgisReferenceElement } from '../../utils/component-utils';
 
 type Layout = "horizontal" | "vertical";
-/** Zoom component allows users to zoom in/out within a view.
+/**
+ * Zoom component allows users to zoom in/out within a view.
+ *
+ * [Read more...](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-zoom/)
  */
 export declare class ArcgisZoom extends LitElement {
     /**
-     * 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 component to a different place on the page, or
-     * temporary hide it. If this is set, make sure to call the
-     * \`destroy\` method when you are done to prevent memory leaks.
+     * 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
+     * component to a different place on the page, or temporarily hide it. If this
+     * is set, make sure to call the [destroy](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-zoom/#destroy) method when you are done to
+     * prevent memory leaks.
+     *
+     * @default false
      */
     autoDestroyDisabled: boolean;
-    /** Icon which represents the component. */
+    /**
+     * Icon which represents the component.
+     * Typically used when the component is controlled by another component (e.g. by the Expand component).
+     *
+     * @see [Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)
+     * @default "magnifying-glass-plus"
+     */
     icon: Nil | string;
     /** The component's default label. */
     label: Nil | string;
-    /** Determines the layout/orientation of the Zoom widget. */
+    /**
+     * Determines the layout/orientation of the Zoom widget.
+     *
+     * @default "vertical"
+     */
     layout: Layout;
     /** Replace localized message strings with your own strings. */
     messageOverrides?: typeof this.messages._overrides;
+    /** @default "top-left" */
     position: __esri.UIPosition;
     referenceElement: ArcgisReferenceElement | Nil | string;
-    /**
-     * The current state of the component.
-     */
     get state(): "disabled" | "ready";
-    /** Permanently destroy the component */
+    /** Permanently destroy the component. */
     destroy(): Promise<void>;
     /** Zooms the view in by an LOD factor of 0.5. */
     zoomIn(): Promise<void>;
     /** Zooms the view out by an LOD factor of 2. */
     zoomOut(): Promise<void>;
+    /** Emitted when the value of a property is changed. Use this to listen to changes to properties. */
     readonly arcgisPropertyChange: TargetedEvent<this, {
         name: "state";
     }>;
+    /** Emitted when the component associated with a map or scene view is is ready to be interacted with. */
     readonly arcgisReady: TargetedEvent<this, undefined>;
     private messages: Partial<{
         componentLabel: string;

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

@@ -3,14 +3,13 @@ import { html as h } from "lit-html";
 import { classes as i } from "@arcgis/components-utils";
 import { ignoreAbortErrors as l } from "@arcgis/core/core/promiseUtils.js";
 import { when as f } from "@arcgis/core/core/reactiveUtils.js";
-import { LitElement as g, createEvent as p, noShadowRoot as y, safeClassMap as r, nothing as m } from "@arcgis/lumina";
+import { LitElement as g, createEvent as y, noShadowRoot as p, safeClassMap as r, nothing as m } from "@arcgis/lumina";
 import { usePropertyChange as z } from "@arcgis/lumina/controllers";
-import { u as b } from "../../chunks/useT9n.js";
-import { u as O } from "../../chunks/useView.js";
+import { u as b, a as O } from "../../chunks/useView.js";
 import { css as Z } from "@lit/reactive-element/css-tag.js";
 /*! All material copyright Esri, All Rights Reserved, unless otherwise specified.
 See https://js.arcgis.com/4.33/esri/copyright.txt for details.
-v4.33.0-next.111 */
+v4.33.0-next.112 */
 const a = {
   base: "arcgis-zoom",
   horizontalLayout: "arcgis-zoom--horizontal",
@@ -41,48 +40,36 @@ function u(t) {
 const x = Z`@layer{arcgis-zoom,.arcgis-zoom{display:flex;flex-flow:column nowrap;box-shadow:0 1px 2px #0000004d}.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)}}`;
 class $ extends g {
   constructor() {
-    super(...arguments), this.messages = b({}), this.view = O(this), this.canZoomIn = !1, this.canZoomOut = !1, this.autoDestroyDisabled = !1, this.icon = "magnifying-glass-plus", this.layout = "vertical", this.position = "top-left", this.arcgisPropertyChange = z()("state"), this.arcgisReady = p();
+    super(...arguments), this.messages = b({}), this.view = O(this), this.canZoomIn = !1, this.canZoomOut = !1, this.autoDestroyDisabled = !1, this.icon = "magnifying-glass-plus", this.layout = "vertical", this.position = "top-left", this.arcgisPropertyChange = z()("state"), this.arcgisReady = y();
   }
   static {
-    this.properties = { canZoomIn: 16, canZoomOut: 16, autoDestroyDisabled: 5, icon: 3, label: 1, layout: 3, messageOverrides: 0, position: 1, referenceElement: 1, state: 35 };
+    this.properties = { canZoomIn: 16, canZoomOut: 16, autoDestroyDisabled: 5, icon: 1, label: 1, layout: 3, messageOverrides: 0, position: 1, referenceElement: 1, state: 35 };
   }
   static {
-    this.shadowRootOptions = y;
+    this.shadowRootOptions = p;
   }
   static {
     this.styles = x;
   }
-  /**
-   * The current state of the component.
-   */
   get state() {
     return this.view?.ready ? "ready" : "disabled";
   }
-  //#endregion
-  //#region Public Methods
-  /** Permanently destroy the component */
   async destroy() {
     await this.manager.destroy();
   }
-  /** Zooms the view in by an LOD factor of 0.5. */
   async zoomIn() {
     const { view: o } = this;
     !this.canZoomIn || !o || (o.type === "2d" ? o.mapViewNavigation.zoomIn() : l(o.goTo({ zoomFactor: 2 })));
   }
-  /** Zooms the view out by an LOD factor of 2. */
   async zoomOut() {
     const { view: o } = this;
     !this.canZoomOut || !o || (o.type === "2d" ? o.mapViewNavigation.zoomOut() : l(o.goTo({ zoomFactor: 0.5 })));
   }
-  //#endregion
-  //#region Lifecycle
   loaded() {
     this.manager.onLifecycle(() => f(() => this.view?.stationary, () => {
       this.canZoomIn = I(this.view), this.canZoomOut = w(this.view);
     }, { initial: !0 }));
   }
-  //#endregion
-  //#region Rendering
   render() {
     const o = {
       [a.horizontalLayout]: this.layout === "horizontal"

package/dist/controllers/Handles.d.ts

@@ -1,7 +1,7 @@
 import { IHandle, Nil } from '@arcgis/components-utils';
 export declare class Handles<T = string, H extends IHandle = IHandle> {
     /**
-     * A handle to a {@link module:esri/views/layers/FeatureLayerView#highlight highlight} call result.
+     * A handle to a [highlight](https://next.sites.afd.arcgis.com/javascript/latest/api-reference/esri-views-layers-FeatureLayerView.html#highlight) call result.
      * The handle can be used to remove the installed highlight.
      *
      * @typedef module:esri/core/Handles~Handle
@@ -36,7 +36,7 @@ export declare class Handles<T = string, H extends IHandle = IHandle> {
      * @param {module:esri/core/Accessor~WatchHandle | module:esri/core/Accessor~WatchHandle[] | module:esri/core/Collection<module:esri/core/Accessor~WatchHandle>} handles - An array or collection handles to group.
      * @param {*} [groupKey]
      *    Key identifying the group to which the handles should be added. All the handles in the group
-     *    can later be removed with {@link module:esri/core/Handles#remove Handles.remove()}. If no
+     *    can later be removed with [Handles.remove()](https://next.sites.afd.arcgis.com/javascript/latest/api-reference/esri-core-Handles.html#remove). If no
      *    key is provided the handles are added to a default group.
      *
      * @example

package/dist/controllers/useHandles.d.ts

@@ -40,7 +40,7 @@ declare class HandleManager extends Controller {
      *    Handles marked for removal once the object is destroyed.
      * @param {*} [groupKey]
      *    Key identifying the group to which the handles should be added. All the handles in the group
-     *    can later be removed with {@link module:esri/core/Accessor#removeHandles Accessor.removeHandles()}.
+     *    can later be removed with [Accessor.removeHandles()](https://next.sites.afd.arcgis.com/javascript/latest/api-reference/esri-core-Accessor.html#removeHandles).
      *    If no key is provided the handles are added to a default group.
      */
     addHandles<T>(handleOrHandles: SafeHandle | SafeHandle[], groupKey?: GroupKey<T>): void;
@@ -85,9 +85,9 @@ declare class HandleManager extends Controller {
 }
 /**
  * useHandles() implements the following methods from JS API's Accessor class:
- * addHandles - https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Accessor.html#addHandles
- * hasHandles - https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Accessor.html#hasHandles
- * removeHandles - https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Accessor.html#removeHandles
+ * addHandles - https://next.sites.afd.arcgis.com/javascript/latest/api-reference/esri-core-Accessor.html#addHandles
+ * hasHandles - https://next.sites.afd.arcgis.com/javascript/latest/api-reference/esri-core-Accessor.html#hasHandles
+ * removeHandles - https://next.sites.afd.arcgis.com/javascript/latest/api-reference/esri-core-Accessor.html#removeHandles
  * removeAllHandles - (hidden from the JS API's JSDoc)
  *
  * Except, to adapt these to web-components, you have an option of picking