@arcgis/map-components 5.2.0-next.99 → 6.0.0-next.0

package/dist/components/arcgis-sketch/SketchComponentViewModel.d.ts

@@ -0,0 +1,84 @@
+import type Accessor from "@arcgis/core/core/Accessor.js";
+import type VisibleElements from "@arcgis/core/widgets/Sketch/VisibleElements.js";
+import type SelectionToolbarViewModel from "@arcgis/core/widgets/support/SelectionToolbar/SelectionToolbarViewModel.js";
+import type Graphic from "@arcgis/core/Graphic.js";
+import type SelectionOperation from "@arcgis/core/views/selection/SelectionOperation.js";
+import type { EventedAccessor } from "@arcgis/core/core/Evented.js";
+import type { default as SketchViewModel } from "@arcgis/core/widgets/Sketch/SketchViewModel.js";
+import type { CreateOptions, CreateTool, CustomActionProperties, CustomToolOptions, SelectionTool, SketchTool } from "@arcgis/core/widgets/Sketch/types.js";
+import type { PluginConfiguration } from "@arcgis/core/views/draw/support/types.js";
+import type { SelectionToolOptions } from "@arcgis/core/widgets/support/SelectionToolbar/types.js";
+import type { KnownActionGroup } from "./configuration.js";
+import type { MapViewOrSceneView } from "@arcgis/core/views/MapViewOrSceneView.js";
+
+export interface SketchComponentViewModelProperties extends Partial<Pick<SketchComponentViewModel, "availableCreateTools" | "selectionViewModel" | "settingsPopoverOpen" | "sketchViewModel" | "view" | "visibleElements">> {}
+
+/**
+ * Internal ViewModel to support rendering and separation of concerns for the Sketch component.
+ * Traditionally this would be called `SketchViewModel`, but that has taken on a life of its own
+ * and needs to maintain a stable public API; it is unfortunately lower level than we'd like
+ * for optimal use in our UI.
+ *
+ * This component encompasses all transformations from the state of SketchViewModel and
+ * SelectionToolbarViewModel and VisibleElements to state that can be trivially rendered by the view layer.
+ */
+export class SketchComponentViewModel extends Accessor {
+  constructor(properties?: SketchComponentViewModelProperties);
+  get _activeSelectionTool(): "lasso-selection" | "rectangle-selection" | undefined;
+  get activePluginIds(): Set<PluginConfiguration["uniqueId"]> | undefined;
+  get activeTool(): SelectionTool | SketchTool | undefined;
+  accessor availableCreateTools: CreateTool[] | undefined;
+  get groupedActions(): KnownActionGroup[];
+  accessor selectionViewModel: SelectionViewModelLike;
+  /** @default false */
+  accessor settingsPopoverOpen: boolean;
+  accessor sketchViewModel: SketchViewModelLike | undefined;
+  get state(): SketchViewModelLike["state"];
+  get test(): {
+      activeCustomToolOptions: CustomToolOptions | undefined;
+      activeSelectionTool: "lasso-selection" | "rectangle-selection" | undefined;
+      selectionViewModel: SelectionViewModelLike;
+  };
+  accessor view: ViewLike | undefined;
+  accessor visibleElements: VisibleElements;
+  /**
+   * Guards against taking certain actions while geometry simplification is in progress.
+   *
+   * @param command
+   */
+  _executeWhenReady(command: () => Promise<void> | void): Promise<void>;
+  /** Cancels all operations, restoring a neutral, ready state. */
+  cancelAll(): void;
+  /**
+   * Initiates interactive creation of a sketch/drawing using the provided tool and options.
+   *
+   * @param tool - Tool to use for the drawing
+   * @param createOptions - Optional configuration of the drawling experience.
+   */
+  create(tool: CreateTool, createOptions?: CreateOptions): Promise<void>;
+  destroy(): void;
+  initialize(): void;
+  /**
+   * @param createToolOptions
+   * @param customActionOptions
+   */
+  setCustomTools(createToolOptions?: CustomToolOptions[] | null, customActionOptions?: CustomActionProperties[] | null): void;
+  toggleSettingsPopover(): void;
+  /**
+   * @param graphic
+   * @param updateOptions
+   */
+  update(graphic: Graphic | Graphic[], updateOptions?: Parameters<SketchViewModelLike["update"]>[1]): Promise<void>;
+}
+
+export type ViewLike = Pick<MapViewOrSceneView, "focus" | "type">;
+
+export type SketchViewModelLike = EventedAccessor
+  & Pick<SketchViewModel, "@eventTypes" | "activeCreateToolDrawMode" | "activePluginConfigurations" | "activeTool" | "cancel" | "canRedo" | "canUndo" | "complete" | "create" | "creationMode" | "delete" | "duplicate" | "effectiveAvailablePlugins" | "firstPluginWithSwappableLeaf" | "geometrySimplificationInProgress" | "layer" | "multiplePluginsActive" | "redo" | "replaceLeaf" | "rootPlugins" | "state" | "toolTransitionInProgress" | "undo" | "update" | "updateGraphics" | "updateOnGraphicClick">;
+
+export type SelectionViewModelLike = EventedAccessor
+  & Pick<SelectionToolbarViewModel, "@eventTypes" | "cancel" | "sources" | "view">
+  & {
+  activeOperation?: Pick<SelectionOperation, "toolName"> | null;
+  activate?: (options: SelectionToolOptions) => Pick<SelectionOperation, "toolName" | "type">;
+};

package/dist/components/arcgis-sketch/configuration.d.ts

@@ -0,0 +1,33 @@
+import type { SketchGroupName } from "@arcgis/core/applications/ExperienceBuilder/sketchUtils.js";
+import type { CustomActionProperties } from "@arcgis/core/widgets/Sketch/types.js";
+import type { IconName } from "../types.js";
+import type { ArcgisToolbarAction as ArcgisToolbarAction } from "@arcgis/common-components/components/arcgis-toolbar-action";
+
+export interface KnownActionGroup {
+  name: SketchComponentGroupName;
+  commands: SketchAction[];
+  visible: boolean;
+}
+
+export type SketchComponentGroupName = SketchGroupName | "geometrySimplification";
+
+export interface SketchAction {
+  active: boolean;
+  afterCreate?: CustomActionProperties["afterCreate"];
+  afterRemoved?: CustomActionProperties["afterRemoved"];
+  afterUpdate?: CustomActionProperties["afterUpdate"];
+  appearance?: ArcgisToolbarAction["appearance"];
+  disabled: boolean;
+  icon?: IconName;
+  id?: string;
+  kind?: ArcgisToolbarAction["kind"];
+  labelKey: string;
+  labelParameters?: Record<string, number | string>;
+  loading?: boolean;
+  tooltipKey?: string;
+  iconFlipRTL?: boolean;
+  refKey?: string;
+  textEnabled?: boolean;
+  renderAsAction?: boolean;
+  onClick: () => void;
+}

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

@@ -1,19 +1,24 @@
 /// <reference path="../../index.d.ts" />
 import type GraphicsLayer from "@arcgis/core/layers/GraphicsLayer.js";
-import type Sketch from "@arcgis/core/widgets/Sketch.js";
+import type TextSymbol from "@arcgis/core/symbols/TextSymbol.js";
+import type SketchViewModel from "@arcgis/core/widgets/Sketch/SketchViewModel.js";
+import type VisibleElements from "@arcgis/core/widgets/Sketch/VisibleElements.js";
 import type Graphic from "@arcgis/core/Graphic.js";
 import type SketchLabelOptions from "@arcgis/core/views/interactive/sketch/SketchLabelOptions.js";
 import type MapNotesLayer from "@arcgis/core/layers/MapNotesLayer.js";
+import type SketchLayer from "@arcgis/core/layers/SketchLayer.js";
 import type SnappingOptions from "@arcgis/core/views/interactive/snapping/SnappingOptions.js";
-import type TextSymbol from "@arcgis/core/symbols/TextSymbol.js";
 import type SketchTooltipOptions from "@arcgis/core/views/interactive/sketch/SketchTooltipOptions.js";
+import type SketchValueOptions from "@arcgis/core/views/interactive/sketch/SketchValueOptions.js";
 import type Collection from "@arcgis/core/core/Collection.js";
 import type { SketchGroupName } from "@arcgis/core/applications/ExperienceBuilder/sketchUtils.js";
 import type { PublicLitElement as LitElement } from "@arcgis/lumina";
 import type { ArcgisReferenceElement, IconName } from "../types.js";
-import type { CreateOptions, CreateTool, UpdateEvent, UndoEvent, DuplicateEvent, RedoEvent, DeleteEvent, CreateEvent, CustomToolOptions, CustomActionProperties, SketchTool, SelectionTool, CreationMode, UpdateOptions, Layout, SketchPointSymbol, SketchPolygonSymbol, SketchPolylineSymbol, State, ToolbarKind } from "@arcgis/core/widgets/Sketch/types.js";
+import type { CreateOptions, CreateTool, UpdateEvent, UndoEvent, DuplicateEvent, RedoEvent, DeleteEvent, CreateEvent, CustomToolOptions, CustomActionProperties, CreationMode, UpdateOptions, SketchPointSymbol, SketchPolygonSymbol, SketchPolylineSymbol } from "@arcgis/core/widgets/Sketch/types.js";
+import type { RelativePosition } from "./support.js";
+import type { SketchComponentViewModel } from "./SketchComponentViewModel.js";
+import type { T9nMeta } from "@arcgis/lumina/controllers";
 import type { MapViewOrSceneView } from "@arcgis/core/views/MapViewOrSceneView.js";
-import type { Icon } from "@esri/calcite-components/components/calcite-icon";
 import type { Button as Button } from "@esri/calcite-components/components/calcite-button";
 
 /**
@@ -22,6 +27,140 @@ import type { Button as Button } from "@esri/calcite-components/components/calci
  * @since 4.28
  */
 export abstract class ArcgisSketch extends LitElement {
+  /** @internal */
+  protected _messages: Partial<{
+      componentLabel: string;
+      more: {
+          generic: string;
+          action: string;
+          drawing: string;
+          selection: string;
+      };
+      undo: string;
+      redo: string;
+      draw: {
+          point: string;
+          polygon: string;
+          polyline: string;
+          circle: string;
+          rectangle: string;
+          multipoint: string;
+          mesh: string;
+          freehandPolyline: string;
+          freehandPolygon: string;
+          text: string;
+      };
+      digitizers: {
+          "root-point": string;
+          "root-polygon": string;
+          "root-polyline": string;
+          "root-circle": string;
+          "root-rectangle": string;
+          "root-multipoint": string;
+          "root-mesh": string;
+          "root-text": string;
+          "leaf-point": string;
+          "leaf-distance-distance": string;
+          "leaf-direction-distance": string;
+          "leaf-direction-direction": string;
+          "leaf-point-segment": string;
+          "leaf-autocomplete": string;
+          "leaf-right-angle": string;
+          "leaf-freehand": string;
+          "leaf-stream": string;
+          "leaf-tangent-arc": string;
+          "leaf-circular-arc": string;
+          "leaf-endpoint-arc": string;
+          "leaf-bezier": string;
+      };
+      settings: {
+          heading: string;
+          toolOptionsHeading: string;
+          freehandSnappingEnabledTitle: string;
+          freehandSnappingEnabledDescription: string;
+          bezierEnableSplineBehaviorTitle: string;
+          bezierEnableSplineBehaviorDescription: string;
+      };
+      deselectCount: string;
+      selectedCountTruncated: string;
+      deleteFeature: string;
+      deleteFeatures: string;
+      selectFeature: string;
+      duplicateFeature: string;
+      duplicateFeatures: string;
+      back: string;
+      rectangleSelection: string;
+      lassoSelection: string;
+      defaultGraphicsLayerTitle: string;
+      processing: string;
+      plugin: string;
+  }> & T9nMeta<{
+      componentLabel: string;
+      more: {
+          generic: string;
+          action: string;
+          drawing: string;
+          selection: string;
+      };
+      undo: string;
+      redo: string;
+      draw: {
+          point: string;
+          polygon: string;
+          polyline: string;
+          circle: string;
+          rectangle: string;
+          multipoint: string;
+          mesh: string;
+          freehandPolyline: string;
+          freehandPolygon: string;
+          text: string;
+      };
+      digitizers: {
+          "root-point": string;
+          "root-polygon": string;
+          "root-polyline": string;
+          "root-circle": string;
+          "root-rectangle": string;
+          "root-multipoint": string;
+          "root-mesh": string;
+          "root-text": string;
+          "leaf-point": string;
+          "leaf-distance-distance": string;
+          "leaf-direction-distance": string;
+          "leaf-direction-direction": string;
+          "leaf-point-segment": string;
+          "leaf-autocomplete": string;
+          "leaf-right-angle": string;
+          "leaf-freehand": string;
+          "leaf-stream": string;
+          "leaf-tangent-arc": string;
+          "leaf-circular-arc": string;
+          "leaf-endpoint-arc": string;
+          "leaf-bezier": string;
+      };
+      settings: {
+          heading: string;
+          toolOptionsHeading: string;
+          freehandSnappingEnabledTitle: string;
+          freehandSnappingEnabledDescription: string;
+          bezierEnableSplineBehaviorTitle: string;
+          bezierEnableSplineBehaviorDescription: string;
+      };
+      deselectCount: string;
+      selectedCountTruncated: string;
+      deleteFeature: string;
+      deleteFeatures: string;
+      selectFeature: string;
+      duplicateFeature: string;
+      duplicateFeatures: string;
+      back: string;
+      rectangleSelection: string;
+      lassoSelection: string;
+      defaultGraphicsLayerTitle: string;
+      processing: string;
+      plugin: string;
+  }>;
   /**
    * When creating new graphics (for example after [create()](https://developers.arcgis.com/javascript/latest/references/core/widgets/Sketch/#create) has been called),
    * this property reflects the create tool being used. When updating graphics
@@ -39,9 +178,9 @@ export abstract class ArcgisSketch extends LitElement {
    * polygon in freehand mode.
    *
    * To opt in to freehandPolyline and freehandPolygon tools, include them when setting availableCreateTools,
-   * and hideCreateTools* properties
+   * and hideCreateTools* properties.
    */
-  get activeTool(): SketchTool | SelectionTool | null;
+  get activeTool(): SketchComponentViewModel["activeTool"];
   /**
    * 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
@@ -68,7 +207,14 @@ export abstract class ArcgisSketch extends LitElement {
    *
    * @default ["point", "polyline", "freehandPolyline", "polygon", "freehandPolygon", "rectangle", "circle"]
    */
-  accessor availableCreateTools: Array<CreateTool> | null | undefined;
+  accessor availableCreateTools: CreateTool[] | undefined;
+  /**
+   * Indicates whether clicking away from an update graphic should not end the current update operation.
+   *
+   * @default false
+   * @internal
+   */
+  accessor cancelUpdateOnClickAwayDisabled: boolean;
   /** The graphic that is being created. */
   get createGraphic(): Graphic | null | undefined;
   /**
@@ -94,8 +240,10 @@ export abstract class ArcgisSketch extends LitElement {
    */
   accessor defaultCreateOptions: CreateOptions;
   /**
-   * By default, sketch will auto-create a new graphics layer if none was
-   * provided. Set this prop to true to disable this behavior.
+   * By default, sketch will create and manage a graphics layer.
+   *
+   * Set this prop to true to disable this behavior. Disabling the default
+   * graphics layer is recommended if supplying your own layer.
    *
    * @default false
    */
@@ -120,6 +268,16 @@ export abstract class ArcgisSketch extends LitElement {
    * sketch.update(graphic, updateOptions);
    */
   accessor defaultUpdateOptions: UpdateOptions;
+  /**
+   * Indicates whether an asynchronous geometry simplification operation is in progress.
+   *
+   * New create and update operations are blocked until this is `true`. Call `cancel()`
+   * to cancel the long-running operation.
+   *
+   * @default false
+   * @since 5.2
+   */
+  get geometrySimplificationInProgress(): boolean;
   /**
    * Indicates whether to hide the circle sketch tool.
    *
@@ -178,6 +336,21 @@ export abstract class ArcgisSketch extends LitElement {
    * @since 5.0
    */
   accessor hideDuplicateButton: boolean;
+  /**
+   * Indicates whether to hide display of the geometry simplification progress indicator while geometry simplification is in progress.
+   *
+   * When set to `false`, the progress indicator is not shown
+   *
+   * @default false
+   * @remarks
+   * Before 5.1, simplification of geometries was done synchronously on the main thread. With the
+   * introduction of support for true curves, this simplification step can take some time (multiple seconds)
+   * in extreme cases. At 5.1, simplification is asynchronous and Sketch is disabled during simplification.
+   * If this process takes a significant amount of time, an activity indicator is shown.
+   * This property only affects rendering of that indicator.
+   * @since 5.2
+   */
+  accessor hideGeometrySimplificationActivityIndicator: boolean;
   /**
    * Indicates whether to hide the sketch labels toggle`.
    *
@@ -192,19 +365,37 @@ export abstract class ArcgisSketch extends LitElement {
    * @since 5.0
    */
   accessor hideSelectionCountLabel: boolean;
-  /** @default false */
+  /**
+   * Indicates whether to hide the 'lasso' (freehand polygon) selection tool.
+   *
+   * @default false
+   * @since 5.2
+   */
   accessor hideSelectionToolsLassoSelection: boolean;
-  /** @default false */
+  /**
+   * Indicates whether to hide the rectangle selection tool.
+   *
+   * @default false
+   * @since 5.2
+   */
   accessor hideSelectionToolsRectangleSelection: boolean;
   /**
-   * Indicates whether to hide the settings menu. Currently this menu contains snapping options`.
+   * Indicates whether to hide the settings menu. The settings menu includes controls for tooltips, segment labels,
+   * grid display, and snapping.
    *
    * @default false
    * @since 5.0
    */
   accessor hideSettingsMenu: boolean;
   /**
-   * Indicates whether to hide the `SnappingControls` component.
+   * Indicates whether to hide the back button on the segment drawing toolbar when only one create tool is available.
+   *
+   * @default false
+   * @internal
+   */
+  accessor hideSinglePluginBackButton: boolean;
+  /**
+   * Indicates whether to hide the snapping controls portion of the settings menu.
    *
    * @default false
    * @since 5.0
@@ -212,7 +403,7 @@ export abstract class ArcgisSketch extends LitElement {
   accessor hideSnappingControls: boolean;
   /**
    * Indicates whether to hide the `enabledToggle` (Enable snapping). This toggles
-   * the [SnappingOptions#enabled](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/snapping/SnappingOptions/#enabled) property.
+   * the [SnappingOptions#enabled](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/options/SnappingOptions/#enabled) property.
    * > [!WARNING]
    * >
    * > **Note**
@@ -226,7 +417,7 @@ export abstract class ArcgisSketch extends LitElement {
   accessor hideSnappingControlsElementsEnabledToggle: boolean;
   /**
    * Indicates whether to hide the `featureEnabledToggle` (Feature to feature). This toggles
-   * the [SnappingOptions#featureEnabled](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/snapping/SnappingOptions/#featureEnabled) property.
+   * the [SnappingOptions#featureEnabled](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/options/SnappingOptions/#featureEnabled) property.
    *
    * @default false
    * @since 5.0
@@ -304,7 +495,7 @@ export abstract class ArcgisSketch extends LitElement {
   accessor hideSnappingControlsElementsLayerList: boolean;
   /**
    * Indicates whether to hide the `selfEnabledToggle` (Geometry guides). This toggles
-   * the [SnappingOptions#selfEnabled](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/snapping/SnappingOptions/#selfEnabled) property.
+   * the [SnappingOptions#selfEnabled](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/options/SnappingOptions/#selfEnabled) property.
    *
    * @default false
    * @since 5.0
@@ -332,22 +523,16 @@ export abstract class ArcgisSketch extends LitElement {
    * @since 4.27
    * @see [Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)
    */
-  get icon(): Icon["icon"];
-  set icon(value: IconName);
+  accessor icon: IconName;
   /**
    * The component's default label.
    *
+   * @default "Sketch"
    * @since 4.11
    */
-  accessor label: string;
+  accessor label: string | undefined;
   /**
-   * Options to configure the sketch labels shown next to each segment of the geometry being created or updated.
-   *
-   * > [!WARNING]
-   * >
-   * > **Known Limitation**
-   * >
-   * > Sketch labels are currently only supported when working with a [SceneView](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/).
+   * Options to configure the measurement labels shown next to each segment of the geometry being created or updated.
    *
    * @since 4.24
    */
@@ -356,14 +541,14 @@ export abstract class ArcgisSketch extends LitElement {
    * The [GraphicsLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/GraphicsLayer/) associated with the Sketch component. The Sketch component adds new [graphics](https://developers.arcgis.com/javascript/latest/references/core/Graphic/) to this layer or can only update graphics
    * stored in this layer.
    */
-  accessor layer: GraphicsLayer | MapNotesLayer | null | undefined;
+  accessor layer: GraphicsLayer | MapNotesLayer | SketchLayer | null | undefined;
   /**
    * Determines the layout/orientation of the Sketch component.
    *
    * @default "horizontal"
    * @since 4.10
    */
-  accessor layout: Layout;
+  accessor layout: "horizontal" | "vertical";
   /**
    * A [SimpleMarkerSymbol](https://developers.arcgis.com/javascript/latest/references/core/symbols/SimpleMarkerSymbol/), [PictureMarkerSymbol](https://developers.arcgis.com/javascript/latest/references/core/symbols/PictureMarkerSymbol/), [PointSymbol3D](https://developers.arcgis.com/javascript/latest/references/core/symbols/PointSymbol3D/), [TextSymbol](https://developers.arcgis.com/javascript/latest/references/core/symbols/TextSymbol/), [CIMSymbol](https://developers.arcgis.com/javascript/latest/references/core/symbols/CIMSymbol/), or [WebStyleSymbol](https://developers.arcgis.com/javascript/latest/references/core/symbols/WebStyleSymbol/) used for representing the point geometry that is being drawn. [SimpleMarkerSymbol](https://developers.arcgis.com/javascript/latest/references/core/symbols/SimpleMarkerSymbol/) may also be used to symbolize point features in a [SceneView](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/). However, it is recommended you use [PointSymbol3D](https://developers.arcgis.com/javascript/latest/references/core/symbols/PointSymbol3D/) instead.
    *
@@ -432,6 +617,18 @@ export abstract class ArcgisSketch extends LitElement {
    * @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;
+  /**
+   * Relative position is used to control the appearance of elements rendered by `arcgis-sketch`. If used within
+   * the slots of an `arcgis-map` or `arcgis-scene` component, you do not need to manually set this value.
+   *
+   * Examples of elements that depend on relative position include the split button chevrons (in vertical layout), the settings
+   * popover, and tooltips.
+   *
+   * @default "top-right"
+   * @since 5.2
+   */
+  get relativePosition(): RelativePosition;
+  set relativePosition(value: RelativePosition | undefined);
   /**
    * Determines the size of component elements.
    *
@@ -468,10 +665,10 @@ export abstract class ArcgisSketch extends LitElement {
    * @since 5.0
    */
   accessor showSnappingControlsElementsHeader: boolean;
-  /** The [SnappingOptions](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/snapping/SnappingOptions/) for sketching. It supports [self](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/snapping/SnappingOptions/#selfEnabled) and [feature](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/snapping/SnappingOptions/#featureEnabled) snapping. */
+  /** The [SnappingOptions](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/options/SnappingOptions/) for sketching. It supports [self](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/options/SnappingOptions/#selfEnabled) and [feature](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/options/SnappingOptions/#featureEnabled) snapping. */
   accessor snappingOptions: SnappingOptions;
-  /** The current state of the component. */
-  get state(): State;
+  /** The Sketch component's state. */
+  get state(): SketchViewModel["state"];
   /**
    * A [TextSymbol](https://developers.arcgis.com/javascript/latest/references/core/symbols/TextSymbol/) used for representing the geometry that is being drawn.
    *
@@ -500,7 +697,7 @@ export abstract class ArcgisSketch extends LitElement {
    * @default "floating"
    * @since 4.32
    */
-  accessor toolbarKind: ToolbarKind;
+  accessor toolbarKind: "docked" | "floating";
   /** Options to configure the tooltip shown next to the cursor when creating or updating graphics. */
   accessor tooltipOptions: SketchTooltipOptions;
   /** An array of [graphics](https://developers.arcgis.com/javascript/latest/references/core/Graphic/) that are being updated by the Sketch component. */
@@ -531,14 +728,40 @@ export abstract class ArcgisSketch extends LitElement {
    * @since 5.0
    */
   accessor useLegacyCreateTools: boolean;
+  /**
+   * Indicates whether the component uses the snapping, tooltip, display-unit, and input-unit options configured through [ViewOptions](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/options/ViewOptions/).
+   *
+   * When `true`, snapping and tooltip options are inherited from the view. Options specified through [snappingOptions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-sketch/#snappingOptions) and [tooltipOptions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-sketch/#tooltipOptions) are preserved but ignored. When `false`, those options are used instead.
+   *
+   * While this property is `true`, snapping controls and the tooltip toggle are hidden from the component's settings menu because these options are inherited from the view.
+   *
+   * Explicit unit overrides take precedence over the units inherited from the view for the corresponding measurement type, such as length or area, without changing the units configured in the view. Setting an explicit unit to `null` or `undefined` restores inheritance for that measurement type.
+   *
+   * Label [options](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-sketch/#labelOptions) and [direction mode](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/options/ValueOptions/#directionMode) are not inherited from the view.
+   *
+   * Changes to this property apply when the next create or update operation starts, not to an operation already in progress.
+   *
+   * @default false
+   * @beta
+   * @since 5.2
+   * @default false
+   */
+  accessor useViewOptions: boolean;
+  /** Options to configure how values are displayed and input when creating or updating graphics. */
+  accessor valueOptions: SketchValueOptions;
   /**
    * 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 arcgis-sketch component will be associated with a map or scene component rather than using the `view` property.
    */
   accessor view: MapViewOrSceneView | null | undefined;
+  /** @internal */
+  accessor viewModel: SketchViewModel;
+  /** @internal */
+  accessor visibleElements: VisibleElements;
   /**
    * Specifies the size of the component.
    *
+   * @default "m"
    * @since 5.0
    */
   accessor visualScale: Button["scale"];
@@ -552,46 +775,38 @@ export abstract class ArcgisSketch extends LitElement {
   delete(): Promise<void>;
   /** Permanently destroy the component. */
   destroy(): Promise<void>;
-  /**
-   * @internal
-   * @since 5.1
-   */
+  /** @internal */
   dismissFloatingElements(): Promise<void>;
   duplicate(): Promise<void>;
   redo(): Promise<void>;
   /**
    * @param location
    * @internal
-   * @since 5.1
    */
   setContextualToolLocation(location: "inline-end" | "inline" | "separate"): Promise<void>;
   /**
    * @param createToolOptions
    * @param customActionOptions
    * @internal
-   * @since 5.1
    */
   setCustomTools(createToolOptions?: CustomToolOptions[] | null, customActionOptions?: CustomActionProperties[] | null): Promise<void>;
   /**
-   * @param options
-   * @internal
-   * @since 5.1
-   */
-  setGroupAllowCollapseOptions(options: Map<SketchGroupName, boolean>): Promise<void>;
-  /**
+   * Note: `setGroupAllowCollapseOptions` has been removed in favor of a single priority setting.
+   * Set the group's priority to `LayoutPriorities.NeverCollapse` (1000) or `LayoutPriorities.ForceCollapse` (0)
+   * to control collapse behavior.
+   *
    * @param priorities
    * @internal
-   * @since 5.1
    */
   setGroupCollapsePriorities(priorities: Map<SketchGroupName, number> | null): Promise<void>;
   /**
    * @param graphic
    * @param updateOptions
    */
-  triggerUpdate(graphic: Parameters<Sketch["update"]>[0], updateOptions?: Parameters<Sketch["update"]>[1]): Promise<void>;
+  triggerUpdate(graphic: Parameters<SketchViewModel["update"]>[0], updateOptions?: Parameters<SketchViewModel["update"]>[1]): Promise<void>;
   undo(): Promise<void>;
   "@setterTypes": {
-    icon?: IconName;
+    relativePosition?: RelativePosition | undefined;
   };
   /** Fires when a user starts sketching a graphic, is actively sketching a graphic and completes sketching a graphic. */
   readonly arcgisCreate: import("@arcgis/lumina").TargetedEvent<this, CreateEvent>;
@@ -600,8 +815,8 @@ export abstract class ArcgisSketch extends LitElement {
   /** Fires when the user duplicates selected graphics. */
   readonly arcgisDuplicate: import("@arcgis/lumina").TargetedEvent<this, DuplicateEvent>;
   /** 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 arcgisPropertyChange: import("@arcgis/lumina").TargetedEvent<this, { name: "activeTool" | "geometrySimplificationInProgress" | "state"; }>;
+  /** Emitted when the component associated with a map or scene view is ready for user interaction. */
   readonly arcgisReady: import("@arcgis/lumina").TargetedEvent<this, void>;
   /** Fires in response to redo action during creation of a new graphic or updating existing graphics. The undo/redo stack is for an individual sketch operation, meaning you can undo/redo actions while creating or updating a graphic. */
   readonly arcgisRedo: import("@arcgis/lumina").TargetedEvent<this, RedoEvent>;