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

package/dist/components/arcgis-directional-pad/customElement.d.ts

@@ -1,14 +1,11 @@
 /// <reference types="@arcgis/core/interfaces.d.ts" />
 /// <reference types="../../index.d.ts" />
 import { Use } from '@arcgis/lumina/controllers';
-import { Nil } from '@arcgis/components-utils';
 import { default as DirectionalPadViewModel } from '@arcgis/core/widgets/DirectionalPad/DirectionalPadViewModel.js';
 import { JsxNode, PublicLitElement as LitElement, TargetedEvent } from '@arcgis/lumina';
 import { ArcgisReferenceElement } from '../../utils/component-utils';
 
-declare const useDirectionalPadViewModel: (component: LitElement & Pick<DirectionalPadViewModel, never> & import('../../controllers/useViewModel').ViewModelControllerUses<DirectionalPadViewModel>, options?: {
-    editConstructorProperties(props: unknown): unknown;
-} | undefined) => DirectionalPadViewModel;
+declare const useDirectionalPadViewModel: (component: LitElement & Pick<DirectionalPadViewModel, never> & import('../../controllers/useViewModel').ViewModelControllerUses<DirectionalPadViewModel>) => DirectionalPadViewModel;
 /**
  * A directional pad (D-Pad) component can be used to control the position and
  * rotation of the map. The D-Pad provides eight directions of movement, a small
@@ -19,66 +16,116 @@ declare const useDirectionalPadViewModel: (component: LitElement & Pick<Directio
  * of the component.
  *
  * The Directional Pad component is not supported in 3D.
+ *
+ * [Read more...](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-directional-pad/)
  */
 export declare class ArcgisDirectionalPad 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-directional-pad/#destroy) method when you are done to
+     * prevent memory leaks.
+     *
+     * @default false
      */
     autoDestroyDisabled: boolean;
     /**
      * Indicates whether interaction is allowed on the component. When `true`,
      * this property sets the component to a disabled state to disable any user
      * interaction.
+     *
+     * @default false
      */
     disabled: boolean;
     /**
      * Whether to hide directional pad buttons.
+     *
+     * @default false
      */
     hideDirectionalButtons: boolean;
     /**
-     * Icon which represents the component. It is typically used when the
-     * component is controlled by another one (e.g. in the arcgis-expand
-     * component).
+     * Icon which represents the component.
+     * Typically used when the component is controlled by another component (e.g. by the Expand component).
      *
-     * @see [Calcite Icon Search](https://developers.arcgis.com/calcite-design-system/icons/)
+     * @see [Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)
+     * @default "move"
      */
-    icon: Nil | string;
+    icon?: string;
     /** The component's default label. */
-    label: Nil | string;
-    /** Overwrite localized strings for this component */
+    label?: string;
+    /**
+     * Replace localized message strings with your own strings.
+     *
+     * _**Note**: Individual message keys may change between releases._
+     */
     messageOverrides?: typeof this.messages._overrides;
+    /** @default "bottom-left" */
     position: __esri.UIPosition;
-    referenceElement: ArcgisReferenceElement | Nil | string;
+    /**
+     * By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.
+     *
+     * @see [Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)
+     */
+    referenceElement?: ArcgisReferenceElement | string;
     /**
      * Whether to display the button to reset the rotation angle. This only takes
      * effect if showRotationSlider is true.
+     *
+     * @default false
      */
     showRotationResetButton: boolean;
     /**
      * Whether to display the map rotation slider.
+     *
+     * @default false
      */
     showRotationSlider: boolean;
-    /**
-     * The current state of the component.
-     */
+    /** The current state of the component. */
     readonly state: "ready" | "disabled" | "moving";
     /**
      * Determines the size of directional pad buttons and the slider.
      *
      * In addition to this parameter, you can set the width on the component
      * container to dictate directional pad size.
+     *
+     * @default "s"
      */
     visualScale: HTMLCalciteButtonElement["scale"];
-    /** Permanently destroy the component */
+    /** Permanently destroy the component. */
     destroy(): 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";
     }>;
-    readonly arcgisReady: TargetedEvent<this, undefined>;
-    private messages;
+    /** Emitted when the component associated with a map or scene view is is ready to be interacted with. */
+    readonly arcgisReady: TargetedEvent<this, void>;
+    private messages: Partial<{
+        componentLabel: string;
+        northWest: string;
+        north: string;
+        northEast: string;
+        east: string;
+        southEast: string;
+        south: string;
+        southWest: string;
+        west: string;
+        heading: string;
+        resetHeading: string;
+        unsupported: string;
+    }> & import('@arcgis/lumina/controllers').T9nMeta<{
+        componentLabel: string;
+        northWest: string;
+        north: string;
+        northEast: string;
+        east: string;
+        southEast: string;
+        south: string;
+        southWest: string;
+        west: string;
+        heading: string;
+        resetHeading: string;
+        unsupported: string;
+    }>;
 }
 export {};

package/dist/components/arcgis-directional-pad/customElement.js

@@ -1,20 +1,21 @@
-import { c as u } from "../../chunks/runtime.js";
+import { c as p } from "../../chunks/runtime.js";
 import { html as o } from "lit-html";
-import { ref as p } from "lit-html/directives/ref.js";
-import { usePropertyChange as m } from "@arcgis/lumina/controllers";
+import { ref as m } from "lit-html/directives/ref.js";
+import { keyed as d } from "lit-html/directives/keyed.js";
+import { usePropertyChange as b } from "@arcgis/lumina/controllers";
 import { focusElement as g } from "@arcgis/components-utils";
-import { watch as b } from "@arcgis/core/core/reactiveUtils.js";
-import _ from "@arcgis/core/widgets/DirectionalPad/DirectionalPadViewModel.js";
-import { LitElement as v, createEvent as f, noShadowRoot as $, safeClassMap as n, nothing as l, safeStyleMap as w } from "@arcgis/lumina";
-import { u as R } from "../../chunks/useT9n.js";
-import { m as C } from "../../chunks/useViewModel.js";
-import { g as x } from "../../chunks/component-utils.js";
-import { g as d } from "../../chunks/globalCss.js";
-import { css as y } from "@lit/reactive-element/css-tag.js";
+import { watch as _ } from "@arcgis/core/core/reactiveUtils.js";
+import f from "@arcgis/core/widgets/DirectionalPad/DirectionalPadViewModel.js";
+import { LitElement as v, createEvent as $, noShadowRoot as w, safeClassMap as n, nothing as l, safeStyleMap as R } from "@arcgis/lumina";
+import { u as C } from "../../chunks/useT9n.js";
+import { m as x } from "../../chunks/useViewModel.js";
+import { g as y } from "../../chunks/component-utils.js";
+import { g as h } from "../../chunks/globalCss.js";
+import { css as M } 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.98 */
-const h = [-45, 0, 45, -90, 90, -135, 180, 135], M = {
+v4.33.0 */
+const u = [-45, 0, 45, -90, 90, -135, 180, 135], S = {
   0: { label: "north", iconName: "chevron-up" },
   45: { label: "northEast", iconName: "chevron-up-right" },
   90: { label: "east", iconName: "chevron-right" },
@@ -32,55 +33,42 @@ const h = [-45, 0, 45, -90, 90, -135, 180, 135], M = {
   rotationSliderContainer: `${a}__rotation-slider-container`,
   rotationReset: `${a}__rotation-reset-button`,
   error: `${a}__error`
-}, S = y`@layer{.arcgis-directional-pad{display:flex;flex-direction:column;gap:var(--calcite-spacing-sm);outline:none;box-shadow:none!important;background:transparent;user-select:none;calcite-action-pad{display:contents}calcite-action-group{touch-action:none}calcite-action{aspect-ratio:1}}.arcgis-directional-pad__buttons-container{--calcite-color-background: transparent;--calcite-action-group-gap: 0;--calcite-action-group-padding: 0;calcite-action{--calcite-color-focus: var(--calcite-color-foreground-3)}calcite-action:not([active]){--calcite-action-background-color-press: var(--calcite-color-foreground-1)}calcite-action[active]{--calcite-action-background-color: var(--calcite-color-foreground-3)}calcite-icon{transform:var(--rotation, unset)}@media (hover: none){calcite-action{--calcite-action-background-color-hover: var(--calcite-color-foreground-1);--calcite-action-text-color-press: var(--calcite-color-text-3)}}}.arcgis-directional-pad__rotation-container{display:block;width:100%;calcite-action{flex:.3}}.arcgis-directional-pad__rotation-slider-container{display:flex;flex:1;align-items:center;calcite-slider{flex:1;padding-inline:var(--calcite-spacing-xxs)}}}`;
-function B(c) {
+}, B = M`@layer{.arcgis-directional-pad{display:flex;flex-direction:column;gap:var(--calcite-spacing-sm);outline:none;box-shadow:none!important;background-color:transparent!important;user-select:none;calcite-action-pad{display:contents}calcite-action-group{touch-action:none}calcite-action{aspect-ratio:1}}.arcgis-directional-pad__buttons-container{--calcite-color-background: transparent;--calcite-action-group-gap: 0;--calcite-action-group-padding: 0;calcite-action{--calcite-color-focus: var(--calcite-color-foreground-3)}calcite-action:not([active]){--calcite-action-background-color-press: var(--calcite-color-foreground-1)}calcite-action[active]{--calcite-action-background-color: var(--calcite-color-foreground-3)}calcite-icon{transform:var(--rotation, unset)}@media (hover: none){calcite-action{--calcite-action-background-color-hover: var(--calcite-color-foreground-1);--calcite-action-text-color-press: var(--calcite-color-text-3)}}}.arcgis-directional-pad__rotation-container{display:block;width:100%;calcite-action{flex:.3}}.arcgis-directional-pad__rotation-slider-container{display:flex;flex:1;align-items:center;calcite-slider{flex:1;padding-inline:var(--calcite-spacing-xxs)}}}`;
+function E(c) {
   const { x: t, y: e, width: i, height: r } = c.getBoundingClientRect();
   return { x: t + i / 2, y: e + r / 2 };
 }
-function E(c) {
+function D(c) {
   return c?.spatialReference?.isWebMercator || c?.spatialReference?.isGeographic || !1;
 }
-const D = C(_);
-class k extends v {
+const k = x(f);
+class P extends v {
   constructor() {
-    super(...arguments), this.messages = R({}), this._onContextMenu = (t) => t.preventDefault(), this._buttons = {}, this.viewModel = D(this), this.angle = this.viewModel.angle, this.rotation = this.viewModel.rotation, this.autoDestroyDisabled = !1, this.disabled = this.viewModel.disabled, this.hideDirectionalButtons = !1, this.icon = "move", this.position = "bottom-left", this.showRotationResetButton = !1, this.showRotationSlider = !1, this.state = this.viewModel.state, this.visualScale = "s", this.arcgisPropertyChange = m()("state"), this.arcgisReady = f();
+    super(...arguments), this.messages = C({}), this._onContextMenu = (t) => t.preventDefault(), this._buttons = {}, this.viewModel = k(this), this.angle = this.viewModel.angle, this.rotation = this.viewModel.rotation, this.autoDestroyDisabled = !1, this.disabled = this.viewModel.disabled, this.hideDirectionalButtons = !1, this.icon = "move", this.position = "bottom-left", this.showRotationResetButton = !1, this.showRotationSlider = !1, this.state = this.viewModel.state, this.visualScale = "s", this.arcgisPropertyChange = b()("state"), this.arcgisReady = $();
   }
   static {
-    this.properties = { _rotationEnabled: 16, angle: 16, rotation: 16, autoDestroyDisabled: 5, disabled: 5, hideDirectionalButtons: 5, icon: 3, label: 1, messageOverrides: 0, position: 3, referenceElement: 1, showRotationResetButton: 5, showRotationSlider: 5, state: 3, visualScale: 1 };
+    this.properties = { _rotationEnabled: 16, angle: 16, rotation: 16, autoDestroyDisabled: 5, disabled: 5, hideDirectionalButtons: 5, icon: 1, label: 1, messageOverrides: 0, position: 3, referenceElement: 1, showRotationResetButton: 5, showRotationSlider: 5, state: 3, visualScale: 1 };
   }
   static {
-    this.shadowRootOptions = $;
+    this.shadowRootOptions = w;
   }
   static {
-    this.styles = S;
-  }
-  //#endregion
-  //#region State Properties
-  /**
-   * When `false`, sets rotation-related controls to a disabled state so the
-   * user  cannot interact with them.
-   */
+    this.styles = B;
+  }
   get _rotationEnabled() {
     return this.view?.ready ? this.view.constraints.rotationEnabled ?? !1 : !0;
   }
-  //#endregion
-  //#region Public Methods
-  /** Permanently destroy the component */
   async destroy() {
     await this.manager.destroy();
   }
-  //#endregion
-  //#region Lifecycle
   loaded() {
     this.manager.onLifecycle(() => [
       // Move focus when movement angle changed by touch/mouse (not keyboard!)
-      b(() => this.viewModel.angle, () => {
-        this._buttonsContainer?.contains(document.activeElement) && (this.viewModel.angle == null ? x(this)?.focus() : g(this._buttons[this.viewModel.angle]));
+      _(() => this.viewModel.angle, () => {
+        this._buttonsContainer?.contains(document.activeElement) && (this.viewModel.angle == null ? y(this)?.focus() : g(this._buttons[this.viewModel.angle]));
       })
     ]);
   }
-  //#endregion
-  //#region Private Methods
   _rotateIcon(t) {
     return {
       "--rotation": `rotate(${t}deg)`
@@ -94,36 +82,25 @@ class k extends v {
       ]));
     })) : (this._buttonsContainer = void 0, this._buttons = {});
   }
-  /**
-   * Find component center and start movement
-   */
   _onButtonPointerDown(t) {
     if (this._buttonsContainer === void 0)
       return;
     t.composedPath().find((r) => r.hasPointerCapture?.(t.pointerId))?.releasePointerCapture(t.pointerId);
-    const i = B(this._buttonsContainer);
+    const i = E(this._buttonsContainer);
     this.viewModel.beginFollowingPointer(t, i);
   }
   _onSliderInput({ currentTarget: t }) {
     typeof t.value == "number" && (this.viewModel.rotation = t.value);
   }
-  /**
-   * Reset angle of rotation
-   */
   _onRotationReset() {
     this.viewModel.rotation = 0;
   }
-  /**
-   * Handle directional pad clicks only when using the keyboard
-   */
   _onClick(t) {
     this.viewModel.moveOnce(t);
   }
-  //#endregion
-  //#region Rendering
   render() {
     const { label: t, disabled: e } = this, i = this.view == null || this.view.type === "2d";
-    return o`<div .ariaLabel=${t ?? void 0} class=${n({ [s.base]: !0, [d.widget]: !0, [d.disabled]: e })} tabindex=-1>${i ? this._renderContent() : this._renderUnsupportedMessage()}</div>`;
+    return o`<div .ariaLabel=${t ?? void 0} class=${n({ [s.base]: !0, [h.widget]: !0, [h.disabled]: e })} tabindex=-1>${i ? this._renderContent() : this._renderUnsupportedMessage()}</div>`;
   }
   _renderUnsupportedMessage() {
     return o`<section class=${n(s.error)}><p>${this.messages.unsupported}</p></section>`;
@@ -135,21 +112,21 @@ class k extends v {
     ];
   }
   _renderDirectionalButtons() {
-    return o`<calcite-action-pad expand-disabled layout=grid><calcite-action-group class=${n(s.buttonsContainer)} dir=ltr @contextmenu=${{
+    return d("directional-buttons-container", o`<calcite-action-bar expand-disabled floating layout=grid overflow-actions-disabled><calcite-action-group class=${n(s.buttonsContainer)} dir=ltr @contextmenu=${{
       handleEvent: this._onContextMenu,
       capture: !0
-    }} ${p(this._setButtonContainerRef)}>${h.slice(0, 4).map(this._renderButton, this)}${this._renderCompass()}${h.slice(4).map(this._renderButton, this)}</calcite-action-group></calcite-action-pad>`;
+    }} ${m(this._setButtonContainerRef)}>${u.slice(0, 4).map(this._renderButton, this)}${this._renderCompass()}${u.slice(4).map(this._renderButton, this)}</calcite-action-group></calcite-action-bar>`);
   }
   _renderButton(t) {
-    const { label: e, iconName: i } = M[t], r = this.messages[e];
+    const { label: e, iconName: i } = S[t], r = this.messages[e];
     return o`<calcite-action .active=${this.angle === t} alignment=center class=${n(s.button)} data-angle=${t ?? l} .disabled=${this.disabled} @click=${this._onClick.bind(this, t)} @pointerdown=${this._onButtonPointerDown} .scale=${this.visualScale} .text=${r ?? ""} title=${r ?? l}><calcite-icon .icon=${i} .scale=${this.visualScale}></calcite-icon></calcite-action>`;
   }
   _renderCompass() {
-    const t = this.disabled || E(this.view) ? "compass-needle" : "arrow-up", e = this.rotation === 0, i = this.messages.resetHeading;
-    return o`<calcite-action alignment=center class=${n(s.compassButton)} .disabled=${this.disabled || !this._rotationEnabled || e} @click=${this._onRotationReset} .scale=${this.visualScale} style=${w(this._rotateIcon(this.rotation))} .text=${i ?? ""} title=${i ?? l}>${!e && o`<calcite-icon .icon=${t} .scale=${this.visualScale}></calcite-icon>` || ""}</calcite-action>`;
+    const t = this.disabled || D(this.view) ? "compass-needle" : "arrow-up", e = this.rotation === 0, i = this.messages.resetHeading;
+    return o`<calcite-action alignment=center class=${n(s.compassButton)} .disabled=${this.disabled || !this._rotationEnabled || e} @click=${this._onRotationReset} .scale=${this.visualScale} style=${R(this._rotateIcon(this.rotation))} .text=${i ?? ""} title=${i ?? l}>${!e && o`<calcite-icon .icon=${t} .scale=${this.visualScale}></calcite-icon>` || ""}</calcite-action>`;
   }
   _renderRotation() {
-    return o`<calcite-action-pad expand-disabled layout=horizontal><calcite-action-group class=${n(s.rotationContainer)}>${this.showRotationResetButton ? this._renderRotationResetButton() : null}${this._renderRotationSlider()}</calcite-action-group></calcite-action-pad>`;
+    return d("slider-container", o`<calcite-action-bar expand-disabled floating layout=horizontal><calcite-action-group class=${n(s.rotationContainer)}>${this.showRotationResetButton ? this._renderRotationResetButton() : null}${this._renderRotationSlider()}</calcite-action-group></calcite-action-bar>`);
   }
   _renderRotationResetButton() {
     const t = this.messages.resetHeading;
@@ -159,7 +136,7 @@ class k extends v {
     return o`<div class=${n(s.rotationSliderContainer)}><calcite-slider .ariaLabel=${this.messages.heading} .disabled=${this.disabled || !this._rotationEnabled} label-handles max=360 min=0 required .scale=${this.visualScale} .value=${Math.round(this.rotation)} @calciteSliderInput=${this._onSliderInput}></calcite-slider></div>`;
   }
 }
-u("arcgis-directional-pad", k);
+p("arcgis-directional-pad", P);
 export {
-  k as ArcgisDirectionalPad
+  P as ArcgisDirectionalPad
 };

package/dist/components/arcgis-directional-pad/index.d.ts

@@ -1,4 +1,4 @@
-import "@esri/calcite-components/components/calcite-action-pad";
+import "@esri/calcite-components/components/calcite-action-bar";
 import "@esri/calcite-components/components/calcite-action-group";
 import "@esri/calcite-components/components/calcite-action";
 import "@esri/calcite-components/components/calcite-icon";

package/dist/components/arcgis-directional-pad/index.js

@@ -1,4 +1,4 @@
-import "@esri/calcite-components/components/calcite-action-pad";
+import "@esri/calcite-components/components/calcite-action-bar";
 import "@esri/calcite-components/components/calcite-action-group";
 import "@esri/calcite-components/components/calcite-action";
 import "@esri/calcite-components/components/calcite-icon";

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

@@ -1,19 +1,19 @@
 /// <reference types="@arcgis/core/interfaces.d.ts" />
 /// <reference types="../../index.d.ts" />
 import { Use } from '@arcgis/lumina/controllers';
-import { Nil } from '@arcgis/components-utils';
 import { default as RouteLayer } from '@arcgis/core/layers/RouteLayer.js';
 import { default as Directions } from '@arcgis/core/widgets/Directions.js';
 import { PublicLitElement as LitElement, TargetedEvent } from '@arcgis/lumina';
 import { PropertyValues } from 'lit';
 import { ArcgisReferenceElement } from '../../utils/component-utils';
 
-declare const useDirectionsWidget: (component: LitElement & Pick<Directions, never> & {
+declare const useDirectionsWidget: (component: LitElement & Pick<Directions, "icon" | "label" | "viewModel" | "headingLevel" | "layer" | "goToOverride" | "unit" | "apiKey" | "maxStops" | "searchProperties"> & {
     state?: unknown;
     viewModel?: __esri.DirectionsViewModel | undefined;
-    icon: Nil | string;
-    label: Nil | string;
-    referenceElement: ArcgisReferenceElement | Nil | string;
+    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<{
@@ -23,49 +23,119 @@ declare const useDirectionsWidget: (component: LitElement & Pick<Directions, nev
         childElem?: HTMLElement & {
             ownedBy?: HTMLElement;
         };
-        view?: __esri.MapView | __esri.SceneView | Nil;
+        view?: __esri.LinkChartView | __esri.MapView | __esri.SceneView;
     };
     autoDestroyDisabled: boolean;
     destroy: () => Promise<void>;
-}, options?: {
-    editConstructorProperties(props: __esri.DirectionsProperties | undefined): __esri.DirectionsProperties | Promise<__esri.DirectionsProperties | undefined> | undefined;
-} | undefined) => Directions;
-/** Directions component provides a way to calculate directions, between two or more input locations with a [RouteLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-RouteLayer.html), using ArcGIS Online and custom Network Analysis Route services.
+}) => Directions;
+/**
+ * The Directions component provides a way to calculate directions, between two or more input locations with a [RouteLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-RouteLayer.html), using ArcGIS Online and custom Network Analysis Route services.
+ *
+ * [Read more...](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-directions/)
  */
 export declare class ArcgisDirections extends LitElement {
+    /**
+     * An authorization string used to access a resource or service.
+     *
+     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions.html#apiKey)
+     */
     apiKey: string | nullish;
     /**
      * 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\` method when you are done to prevent
-     * memory leaks.
+     * is set, make sure to call the [destroy](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-directions/#destroy) method when you are done to
+     * prevent memory leaks.
+     *
+     * @default false
      */
     autoDestroyDisabled: boolean;
+    /**
+     * This function provides the ability to override either the
+     * [MapView goTo()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#goTo) or
+     * [SceneView goTo()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#goTo) methods.
+     *
+     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions.html#goToOverride)
+     *
+     * @since 4.33
+     */
     goToOverride: nullish | __esri.GoToOverride;
+    /**
+     * Indicates the heading level to use for the origin and destination addresses (i.e.
+     *
+     * @default 2
+     */
     headingLevel: number;
+    /** @default false */
     hideLayerDetails: boolean | undefined;
+    /** @default false */
     hideSaveAsButton: boolean | undefined;
+    /** @default false */
     hideSaveButton: boolean | undefined;
     /**
      * Icon which represents the component.
      * Typically used when the component is controlled by another component (e.g. by the Expand component).
-     * Search [Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/) for possible values.
+     *
+     * @see [Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)
+     * @default "right"
      */
     icon: string;
-    /** The component's default label. */
+    /**
+     * The widget's default label.
+     *
+     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions.html#label)
+     */
     label: string;
+    /**
+     * The most recent route result.
+     *
+     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions.html#lastRoute)
+     *
+     * @default null
+     */
     readonly lastRoute: nullish | __esri.DirectionsLastRoute;
+    /**
+     * The [RouteLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-RouteLayer.html) associated with the Directions widget.
+     *
+     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions.html#layer)
+     */
     layer: nullish | RouteLayer;
+    /**
+     * The maximum number of stops allowed for routing.
+     *
+     * @default 50
+     */
     maxStops: number;
+    /** @default "bottom-left" */
     position: __esri.UIPosition;
-    referenceElement: ArcgisReferenceElement | Nil | string;
+    /**
+     * By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.
+     *
+     * @see [Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)
+     */
+    referenceElement?: ArcgisReferenceElement | string;
     routeLayerItemId?: string;
+    /**
+     * Controls the default properties used when searching.
+     *
+     * @default null
+     */
     searchProperties: nullish | __esri.DirectionsSearchProperties;
+    /**
+     * The current state of the component.
+     *
+     * @default "disabled"
+     */
     readonly state: "ready" | "disabled" | "error" | "initializing" | "routing" | "unauthenticated";
+    /**
+     * Unit system (imperial, metric) or specific unit used for displaying the distance values.
+     *
+     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions.html#unit)
+     */
     unit: __esri.SystemOrLengthUnit;
+    /** @default false */
     useDefaultRouteLayer: boolean;
-    /** Permanently destroy the component */
+    /** Permanently destroy the component. */
     destroy(): Promise<void>;
     getDirections(): Promise<__esri.RouteLayerSolveResult>;
     save(): Promise<__esri.PortalItem>;
@@ -73,9 +143,11 @@ export declare class ArcgisDirections extends LitElement {
         folder: __esri.PortalFolder;
     }): Promise<__esri.PortalItem>;
     zoomToRoute(): 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" | "lastRoute";
     }>;
-    readonly arcgisReady: TargetedEvent<this, undefined>;
+    /** Emitted when the component associated with a map or scene view is is ready to be interacted with. */
+    readonly arcgisReady: TargetedEvent<this, void>;
 }
 export {};

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

@@ -9,14 +9,14 @@ import { e as u } from "../../chunks/component-utils.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.33/esri/copyright.txt for details.
-v4.33.0-next.98 */
+v4.33.0 */
 const c = y`@layer{arcgis-directions{display:block}}`, g = m(d), i = "map-components:arcgis-directions";
 class p extends n {
   constructor() {
     super(...arguments), this.widget = g(this), this.viewModel = this.widget.viewModel, this.apiKey = this.widget.apiKey, this.autoDestroyDisabled = !1, this.goToOverride = this.widget.goToOverride, this.headingLevel = this.widget.headingLevel, this.hideLayerDetails = this.widget.visibleElements.layerDetails, this.hideSaveAsButton = this.widget.visibleElements.saveAsButton, this.hideSaveButton = this.widget.visibleElements.saveButton, this.icon = this.widget.icon, this.label = this.widget.label, this.lastRoute = this.widget.lastRoute, this.layer = this.widget.layer, this.maxStops = this.widget.maxStops, this.position = "bottom-left", this.searchProperties = this.widget.searchProperties, this.state = this.viewModel.state, this.unit = this.widget.unit, this.useDefaultRouteLayer = !1, this.arcgisPropertyChange = r()("lastRoute", "state"), this.arcgisReady = l();
   }
   static {
-    this.properties = { apiKey: 1, autoDestroyDisabled: 5, goToOverride: 0, headingLevel: 9, hideLayerDetails: 5, hideSaveAsButton: 5, hideSaveButton: 5, icon: 1, label: 1, lastRoute: 0, layer: 0, maxStops: 9, position: 1, referenceElement: 1, routeLayerItemId: 1, searchProperties: 0, state: 0, unit: 1, useDefaultRouteLayer: 5 };
+    this.properties = { apiKey: 1, autoDestroyDisabled: 5, goToOverride: 0, headingLevel: 9, hideLayerDetails: 5, hideSaveAsButton: 5, hideSaveButton: 5, icon: 1, label: 1, lastRoute: 0, layer: 0, maxStops: 9, position: 1, referenceElement: 1, routeLayerItemId: 1, searchProperties: 0, state: 3, unit: 1, useDefaultRouteLayer: 5 };
   }
   static {
     this.shadowRootOptions = w;
@@ -24,9 +24,6 @@ class p extends n {
   static {
     this.styles = c;
   }
-  //#endregion
-  //#region Public Methods
-  /** Permanently destroy the component */
   async destroy() {
     await this.manager.destroy();
   }
@@ -50,27 +47,22 @@ class p extends n {
       throw new Error(`${i} - component not ready to zoom to route`);
     this.widget?.zoomToRoute();
   }
-  //#endregion
-  //#region Lifecycle
   willUpdate(e) {
     if (e.has("routeLayerItemId")) {
       const t = this.routeLayerItemId;
       if (u(t) && !this.useDefaultRouteLayer) {
         const { layer: s } = this;
-        s && this.widget.view?.map.remove(s), this._setDefaultLayer();
+        s && this.widget.view?.map?.remove(s), this._setDefaultLayer();
       } else t && this.widget && (this.layer = new o({
         portalItem: {
           id: t
         }
-      }), this.widget.view?.map.add(this.layer));
+      }), this.widget.view?.map?.add(this.layer));
     }
     e.has("useDefaultRouteLayer") && this._setDefaultLayer();
   }
-  //#endregion
-  //#region Private Methods
-  /** Maintain a default route layer */
   _setDefaultLayer() {
-    this.useDefaultRouteLayer && !this.routeLayerItemId && (this.layer = new o(), h(() => this.widget.view, () => this.widget.view?.map.add(this.layer), { once: !0 }));
+    this.useDefaultRouteLayer && !this.routeLayerItemId && (this.layer = new o(), h(() => this.widget.view, () => this.widget.view?.map?.add(this.layer), { once: !0 }));
   }
 }
 a("arcgis-directions", p);