@arcgis/map-components 5.0.0-next.136 → 5.0.0-next.137

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

@@ -1,11 +1,15 @@
 /// <reference path="../../index.d.ts" />
-import { Use } from '@arcgis/lumina/controllers';
-import { JsxNode, PublicLitElement as LitElement, TargetedEvent } from '@arcgis/lumina';
-import { ArcgisReferenceElement } from '../../utils/component-utils';
-import { default as LocateViewModel } from './LocateViewModel';
-import { IconName } from '../../utils/action-utils';
+import type MapView from "@arcgis/core/views/MapView.js";
+import type SceneView from "@arcgis/core/views/SceneView.js";
+import type Graphic from "@arcgis/core/Graphic.js";
+import type { PublicLitElement as LitElement } from "@arcgis/lumina/PublicLitElement";
+import type { ArcgisReferenceElement } from "../../utils/component-utils.js";
+import type { IconName } from "../../utils/action-utils.js";
+import type { T9nMeta } from "@arcgis/lumina/controllers";
+import type { GoToOverride } from "@arcgis/core/widgets/support/types.js";
+import type { State } from "./LocateViewModel.js";
+import type { Button as Button } from "@esri/calcite-components/components/calcite-button";
 
-declare const useLocateViewModel: (component: LitElement & Pick<LocateViewModel, never> & import('../../controllers/useViewModel').ViewModelControllerUses<LocateViewModel>) => LocateViewModel;
 /**
  * The Locate component animates the Map or Scene to the user's current location.
  *
@@ -13,134 +17,142 @@ declare const useLocateViewModel: (component: LitElement & Pick<LocateViewModel,
  * Note that localhost is considered "potentially secure" and can be used for easy testing in browsers that support
  * [Window.isSecureContext](https://developer.mozilla.org/en-US/docs/Web/API/isSecureContext#browser_compatibility).
  *
- * [Read more...](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-locate/)
- *
  * @since 4.28
  */
-export declare class ArcgisLocate extends LitElement {
-    /**
-     * The view associated with the component.
-     *   > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the Locate component will be associated with a map or scene component rather than using the `view` property.
-     */
-    view?: import('@arcgis/core/views/MapView').default | import('@arcgis/core/views/SceneView').default | undefined;
-    /**
-     * 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-locate/#destroy) method when you are done to
-     * prevent memory leaks.
-     *
-     * @default false
-     */
-    autoDestroyDisabled: boolean;
-    geolocationOptions: PositionOptions | undefined;
-    /**
-     * Indicates whether to navigate the view to the position and scale of the geolocated result.
-     *
-     * @default false
-     */
-    goToLocationDisabled: boolean;
-    goToOverride: import('@arcgis/core/widgets/support/types').GoToOverride | undefined;
-    /** The graphic used to show the user's location on the map. */
-    graphic: import('@arcgis/core/Graphic').default;
-    /**
-     * Icon which represents the component.
-     * Typically used when the component is controlled by another component (e.g. by the Expand component).
-     *
-     * @default "gps-off"
-     * @see [Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)
-     */
-    icon?: IconName;
-    /** The component's default label. */
-    label?: string;
-    /**
-     * Replace localized message strings with your own strings.
-     *
-     * _**Note**: Individual message keys may change between releases._
-     */
-    messageOverrides?: typeof this.messages._overrides;
-    /** @default false */
-    popupDisabled: boolean;
-    /**
-     * 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;
-    /**
-     * Indicates the scale to set on the view when navigating to the position of the geolocated
-     * result, after a location is returned from the [track](#event-track) event.
-     *
-     * @default null
-     */
-    scale: number | undefined;
-    /** The current state of the component. */
-    readonly state: "error" | "disabled" | "ready" | "feature-unsupported" | "locating";
-    /**
-     * Specifies the size of the component.
-     *
-     * @default "m"
-     * @since 5.0
-     */
-    visualScale: HTMLCalciteButtonElement["scale"];
-    /**
-     * This function provides the ability to interrupt and cancel the process of
-     * programmatically obtaining the location of the user's device.
-     */
-    cancelLocate(): Promise<void>;
-    /** Permanently destroy the component. */
-    destroy(): Promise<void>;
-    locate(): Promise<GeolocationPosition | null>;
-    readonly arcgisError: TargetedEvent<this, {
-        error: GeolocationPositionError;
-    }>;
-    /** 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 ready to be interacted with. */
-    readonly arcgisReady: TargetedEvent<this, void>;
-    readonly arcgisSuccess: TargetedEvent<this, {
-        position: GeolocationPosition;
-    }>;
-    private messages: Partial<{
-        componentLabel: string;
-        title: string;
-        currentLocation: string;
-        timestamp: string;
-        latitude: string;
-        longitude: string;
-        accuracy: string;
-        altitude: string;
-        altitudeAccuracy: string;
-        heading: string;
-        speed: string;
-        permissionError: string;
-        timeoutError: string;
-        positionUnavailable: string;
-        cancel: string;
-    }> & import('@arcgis/lumina/controllers').T9nMeta<{
-        componentLabel: string;
-        title: string;
-        currentLocation: string;
-        timestamp: string;
-        latitude: string;
-        longitude: string;
-        accuracy: string;
-        altitude: string;
-        altitudeAccuracy: string;
-        heading: string;
-        speed: string;
-        permissionError: string;
-        timeoutError: string;
-        positionUnavailable: string;
-        cancel: string;
-    }>;
-    "@eventTypes": {
-        "arcgisError": ArcgisLocate["arcgisError"]["detail"];
-        "arcgisPropertyChange": ArcgisLocate["arcgisPropertyChange"]["detail"];
-        "arcgisReady": ArcgisLocate["arcgisReady"]["detail"];
-        "arcgisSuccess": ArcgisLocate["arcgisSuccess"]["detail"];
-    };
-}
-export {};
+export abstract class ArcgisLocate 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 temporarily hide it. If this
+   * is set, make sure to call the [destroy()](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-locate/#destroy) method when you are done to
+   * prevent memory leaks.
+   *
+   * @default false
+   */
+  accessor autoDestroyDisabled: boolean;
+  accessor geolocationOptions: PositionOptions | undefined;
+  /**
+   * Indicates whether to navigate the view to the position and scale of the geolocated result.
+   *
+   * @default false
+   */
+  accessor goToLocationDisabled: boolean;
+  accessor goToOverride: GoToOverride | undefined;
+  /** The graphic used to show the user's location on the map. */
+  accessor graphic: Graphic;
+  /**
+   * Icon which represents the component.
+   * Typically used when the component is controlled by another component (e.g. by the Expand component).
+   *
+   * @default "gps-off"
+   * @see [Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)
+   */
+  accessor icon: IconName | undefined;
+  /** The component's default label. */
+  accessor label: string | undefined;
+  /**
+   * Replace localized message strings with your own strings.
+   *
+   * _**Note**: Individual message keys may change between releases._
+   */
+  accessor messageOverrides: {
+      componentLabel?: string | undefined;
+      title?: string | undefined;
+      currentLocation?: string | undefined;
+      timestamp?: string | undefined;
+      latitude?: string | undefined;
+      longitude?: string | undefined;
+      accuracy?: string | undefined;
+      altitude?: string | undefined;
+      altitudeAccuracy?: string | undefined;
+      heading?: string | undefined;
+      speed?: string | undefined;
+      permissionError?: string | undefined;
+      timeoutError?: string | undefined;
+      positionUnavailable?: string | undefined;
+      cancel?: string | undefined;
+  };
+  /** @internal */
+  protected messages: Partial<{
+      componentLabel: string;
+      title: string;
+      currentLocation: string;
+      timestamp: string;
+      latitude: string;
+      longitude: string;
+      accuracy: string;
+      altitude: string;
+      altitudeAccuracy: string;
+      heading: string;
+      speed: string;
+      permissionError: string;
+      timeoutError: string;
+      positionUnavailable: string;
+      cancel: string;
+  }> & T9nMeta<{
+      componentLabel: string;
+      title: string;
+      currentLocation: string;
+      timestamp: string;
+      latitude: string;
+      longitude: string;
+      accuracy: string;
+      altitude: string;
+      altitudeAccuracy: string;
+      heading: string;
+      speed: string;
+      permissionError: string;
+      timeoutError: string;
+      positionUnavailable: string;
+      cancel: string;
+  }>;
+  /** @default false */
+  accessor popupDisabled: boolean;
+  /**
+   * 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)
+   */
+  accessor referenceElement: ArcgisReferenceElement | string | undefined;
+  /**
+   * Indicates the scale to set on the view when navigating to the position of the geolocated
+   * result, after a location is returned from the [track](#event-track) event.
+   *
+   * @default null
+   */
+  accessor scale: number | undefined;
+  /** The current state of the component. */
+  get state(): State;
+  /**
+   * The view associated with the component. 
+   *   > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the Locate component will be associated with a map or scene component rather than using the `view` property.
+   */
+  accessor view: MapView | SceneView | undefined;
+  /**
+   * Specifies the size of the component.
+   *
+   * @default "m"
+   * @since 5.0
+   */
+  accessor visualScale: Button["scale"];
+  /**
+   * This function provides the ability to interrupt and cancel the process of
+   * programmatically obtaining the location of the user's device.
+   */
+  cancelLocate(): Promise<void>;
+  /** Permanently destroy the component. */
+  destroy(): Promise<void>;
+  locate(): Promise<GeolocationPosition | null>;
+  readonly arcgisError: import("@arcgis/lumina").TargetedEvent<this, { error: GeolocationPositionError; }>;
+  /** Emitted when the value of a property is changed. Use this to listen to changes to properties. */
+  readonly arcgisPropertyChange: import("@arcgis/lumina").TargetedEvent<this, { name: "state"; }>;
+  /** Emitted when the component associated with a map or scene view is ready to be interacted with. */
+  readonly arcgisReady: import("@arcgis/lumina").TargetedEvent<this, void>;
+  readonly arcgisSuccess: import("@arcgis/lumina").TargetedEvent<this, { position: GeolocationPosition; }>;
+  readonly "@eventTypes": {
+    arcgisError: ArcgisLocate["arcgisError"]["detail"];
+    arcgisPropertyChange: ArcgisLocate["arcgisPropertyChange"]["detail"];
+    arcgisReady: ArcgisLocate["arcgisReady"]["detail"];
+    arcgisSuccess: ArcgisLocate["arcgisSuccess"]["detail"];
+  };
+}

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

@@ -28,7 +28,7 @@ import { log as O } from "@arcgis/toolkit/log";
 import { g as ae } from "../../chunks/globalCss.js";
 /*! All material copyright Esri, All Rights Reserved, unless otherwise specified.
 See https://js.arcgis.com/5.0/esri/copyright.txt for details.
-v5.0.0-next.136 */
+v5.0.0-next.137 */
 const se = z`.arcgis-button{--calcite-icon-color: var(--calcite-color-text-3);--calcite-button-background-color: var(--calcite-color-foreground-1);color:var(--calcite-color-text-3);line-height:var(--calcite-font-line-height-relative-tight);display:flex;flex-flow:column;cursor:pointer;background-color:var(--calcite-color-foreground-1);font-size:var(--calcite-font-size);:hover{--calcite-icon-color: var(--calcite-color-text-1);--calcite-button-background-color: var(--calcite-color-transparent-hover)}}:host{width:fit-content;height:fit-content}`;
 let E = !1;
 const ne = {
@@ -580,7 +580,7 @@ class Oe extends k {
     }, this.isErrorTooltipOpen = !1, this.view = this.viewModel.view, this.autoDestroyDisabled = !1, this.geolocationOptions = this.viewModel.geolocationOptions, this.goToLocationDisabled = this.viewModel.goToLocationEnabled, this.goToOverride = this.viewModel.goToOverride, this.graphic = this.viewModel.graphic, this.icon = S, this.popupDisabled = this.viewModel.popupEnabled, this.scale = this.viewModel.scale, this.state = this.viewModel.state, this.visualScale = "m", this.arcgisError = f(), this.arcgisPropertyChange = F()("state"), this.arcgisReady = f(), this.arcgisSuccess = f(), this.listenOn(document, "click", this.hideErrorTooltip);
   }
   static {
-    this.properties = { isErrorTooltipOpen: 16, view: 0, autoDestroyDisabled: 5, geolocationOptions: 0, goToLocationDisabled: 7, goToOverride: 0, graphic: 0, icon: 0, label: 1, messageOverrides: 0, popupDisabled: 5, referenceElement: 1, scale: 9, state: 32, visualScale: 1 };
+    this.properties = { isErrorTooltipOpen: 16, view: 0, autoDestroyDisabled: 5, geolocationOptions: 0, goToLocationDisabled: 7, goToOverride: 0, graphic: 0, icon: 1, label: 1, messageOverrides: 0, popupDisabled: 5, referenceElement: 1, scale: 9, state: 32, visualScale: 1 };
   }
   static {
     this.styles = se;

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

@@ -1,3 +1 @@
-import "@esri/calcite-components/components/calcite-button";
-import "@esri/calcite-components/components/calcite-tooltip";
 export * from "./customElement.js";