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

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

@@ -1,10 +1,12 @@
 /// <reference path="../../index.d.ts" />
-import { default as SwipeViewModel } from '@arcgis/core/widgets/Swipe/SwipeViewModel.js';
-import { JsxNode, PublicLitElement as LitElement, TargetedEvent } from '@arcgis/lumina';
-import { Use } from '@arcgis/lumina/controllers';
-import { ArcgisReferenceElement } from '../../utils/component-utils';
+import type MapView from "@arcgis/core/views/MapView.js";
+import type Collection from "@arcgis/core/core/Collection.js";
+import type Layer from "@arcgis/core/layers/Layer.js";
+import type { PublicLitElement as LitElement } from "@arcgis/lumina/PublicLitElement";
+import type { ArcgisReferenceElement } from "../../utils/component-utils.js";
+import type { T9nMeta } from "@arcgis/lumina/controllers";
+import type { Direction, State } from "@arcgis/core/widgets/Swipe/types.js";
 
-declare const useSwipeViewModel: (component: LitElement & Pick<SwipeViewModel, never> & import('../../controllers/useViewModel').ViewModelControllerUses<SwipeViewModel>) => SwipeViewModel;
 /**
  * The Swipe component provides a tool to show a portion of a layer or layers
  * on top of a map. Layers can be swiped vertically or horizontally to easily
@@ -18,168 +20,164 @@ declare const useSwipeViewModel: (component: LitElement & Pick<SwipeViewModel, n
  *
  * - This component is not currently supported within a Scene component.
  *
- * [Read more...](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-swipe/)
- *
  * @since 4.31
  * @see [Sample - Swipe component](https://developers.arcgis.com/javascript/latest/sample-code/swipe/)
  * @see [Sample - Swipe component with scroll](https://developers.arcgis.com/javascript/latest/sample-code/swipe-scroll/)
  */
-export declare class ArcgisSwipe 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 Swipe component will be associated with a map or scene component rather than using the `view` property.
-     */
-    view?: import('@arcgis/core/views/MapView').default | null | 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-swipe/#destroy) method when you are done to
-     * prevent memory leaks.
-     *
-     * @default false
-     */
-    autoDestroyDisabled: boolean;
-    /**
-     * The direction the Swipe component moves across the view.
-     * If `"horizontal"`, the component will move left and right and
-     * if `"vertical"`, the component will move up and down.
-     *
-     * @default "horizontal"
-     */
-    direction: import('@arcgis/core/widgets/Swipe/types').Direction;
-    /**
-     * When `true`, sets the component to a disabled state so the user cannot interact with it.
-     *
-     * @default false
-     */
-    disabled: boolean;
-    /**
-     * A collection of layers that will show on the right or bottom side of the Swipe component.
-     *
-     * @see [trailingLayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Swipe-SwipeViewModel.html#trailingLayers)
-     * @since 5.0
-     */
-    endLayers: import('@arcgis/core/core/Collection').default<import('@arcgis/core/layers/Layer').default>;
-    /**
-     * When `true`, the divider between the leading and trailing layers will be hidden.
-     *
-     * @default false
-     */
-    hideDivider: boolean;
-    /**
-     * When `true`, the handle from which you drag the component will be hidden.
-     *
-     * @default false
-     */
-    hideHandle: boolean;
-    /**
-     * Icon which represents the component.
-     * Typically used when the component is controlled by another component (e.g. by the Expand component).
-     *
-     * @default "compare"
-     * @see [Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)
-     */
-    icon?: string;
-    /**
-     * The component's default label.
-     *
-     * @default "Swipe"
-     */
-    label?: string;
-    /**
-     * A collection of layers that will show on the left or top side of the Swipe component.
-     *
-     * @deprecated since 5.0, use [`startLayers`](#startLayers) instead.
-     * @see [leadingLayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Swipe-SwipeViewModel.html#leadingLayers)
-     */
-    get leadingLayers(): typeof this.viewModel.leadingLayers;
-    set leadingLayers(value: typeof this.viewModel.leadingLayers);
-    /**
-     * Replace localized message strings with your own strings.
-     *
-     * _**Note**: Individual message keys may change between releases._
-     */
-    messageOverrides?: typeof this.messages._overrides;
-    /**
-     * The position of the Swipe component. This determines what percentage
-     * of the view will be taken up by the [startLayers](#startLayers).
-     *
-     * @default 25
-     * @since 5.0
-     */
-    position: number;
-    /**
-     * A collection of layers that will show on the left or top side of the Swipe component.
-     *
-     * @see [leadingLayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Swipe-SwipeViewModel.html#leadingLayers)
-     * @since 5.0
-     */
-    startLayers: import('@arcgis/core/core/Collection').default<import('@arcgis/core/layers/Layer').default>;
-    /**
-     * The position of the Swipe component. This determines what percentage
-     * of the view will be taken up by the [startLayers](#startLayers).
-     *
-     * @deprecated since 5.0, use [`position`](#position) instead.
-     * @default 25
-     */
-    get swipePosition(): number;
-    set swipePosition(value: number);
-    /**
-     * 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;
-    /**
-     * The current state of the component.
-     *
-     * @default "disabled"
-     */
-    readonly state: import('@arcgis/core/widgets/Swipe/types').State;
-    /**
-     * A collection of layers that will show on the right or bottom side of the Swipe component.
-     *
-     * @deprecated since 5.0, use [`endLayers`](#endLayers) instead.
-     * @see [trailingLayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Swipe-SwipeViewModel.html#trailingLayers)
-     */
-    get trailingLayers(): typeof this.viewModel.trailingLayers;
-    set trailingLayers(value: typeof this.viewModel.trailingLayers);
-    /** 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";
-    }>;
-    /** Emitted when the component associated with a map or scene view is ready to be interacted with. */
-    readonly arcgisReady: TargetedEvent<this, void>;
-    /**
-     * Fires when the swipe position changes and the drag handle is released on the component.
-     *
-     * **Note:** To constantly listen to changes while dragging, use the `arcgisSwipeInput` event instead.
-     *
-     * @since 4.34
-     */
-    readonly arcgisSwipeChange: TargetedEvent<this, void>;
-    /**
-     * Fires when the swipe position is updated.
-     * This event is fired continuously while dragging the handle.
-     *
-     * @since 4.34
-     */
-    readonly arcgisSwipeInput: TargetedEvent<this, void>;
-    private messages: Partial<{
-        componentLabel: string;
-        dragLabel: string;
-    }> & import('@arcgis/lumina/controllers').T9nMeta<{
-        componentLabel: string;
-        dragLabel: string;
-    }>;
-    "@eventTypes": {
-        "arcgisPropertyChange": ArcgisSwipe["arcgisPropertyChange"]["detail"];
-        "arcgisReady": ArcgisSwipe["arcgisReady"]["detail"];
-        "arcgisSwipeChange": ArcgisSwipe["arcgisSwipeChange"]["detail"];
-        "arcgisSwipeInput": ArcgisSwipe["arcgisSwipeInput"]["detail"];
-    };
-}
-export {};
+export abstract class ArcgisSwipe 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-swipe/#destroy) method when you are done to
+   * prevent memory leaks.
+   *
+   * @default false
+   */
+  accessor autoDestroyDisabled: boolean;
+  /**
+   * The direction the Swipe component moves across the view.
+   * If `"horizontal"`, the component will move left and right and
+   * if `"vertical"`, the component will move up and down.
+   *
+   * @default "horizontal"
+   */
+  accessor direction: Direction;
+  /**
+   * When `true`, sets the component to a disabled state so the user cannot interact with it.
+   *
+   * @default false
+   */
+  accessor disabled: boolean;
+  /**
+   * A collection of layers that will show on the right or bottom side of the Swipe component.
+   *
+   * @see [trailingLayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Swipe-SwipeViewModel.html#trailingLayers)
+   * @since 5.0
+   */
+  accessor endLayers: Collection<Layer>;
+  /**
+   * When `true`, the divider between the leading and trailing layers will be hidden.
+   *
+   * @default false
+   */
+  accessor hideDivider: boolean;
+  /**
+   * When `true`, the handle from which you drag the component will be hidden.
+   *
+   * @default false
+   */
+  accessor hideHandle: boolean;
+  /**
+   * Icon which represents the component.
+   * Typically used when the component is controlled by another component (e.g. by the Expand component).
+   *
+   * @default "compare"
+   * @see [Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)
+   */
+  accessor icon: string | undefined;
+  /**
+   * The component's default label.
+   *
+   * @default "Swipe"
+   */
+  accessor label: string | undefined;
+  /**
+   * A collection of layers that will show on the left or top side of the Swipe component.
+   *
+   * @deprecated since 5.0, use [`startLayers`](#startLayers) instead.
+   * @see [leadingLayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Swipe-SwipeViewModel.html#leadingLayers)
+   */
+  accessor leadingLayers: Collection<Layer>;
+  /**
+   * Replace localized message strings with your own strings.
+   *
+   * _**Note**: Individual message keys may change between releases._
+   */
+  accessor messageOverrides: {
+      componentLabel?: string | undefined;
+      dragLabel?: string | undefined;
+  };
+  /** @internal */
+  protected messages: Partial<{
+      componentLabel: string;
+      dragLabel: string;
+  }> & T9nMeta<{
+      componentLabel: string;
+      dragLabel: string;
+  }>;
+  /**
+   * The position of the Swipe component. This determines what percentage
+   * of the view will be taken up by the [startLayers](#startLayers).
+   *
+   * @default 25
+   * @since 5.0
+   */
+  accessor position: number;
+  /**
+   * 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;
+  /**
+   * A collection of layers that will show on the left or top side of the Swipe component.
+   *
+   * @see [leadingLayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Swipe-SwipeViewModel.html#leadingLayers)
+   * @since 5.0
+   */
+  accessor startLayers: Collection<Layer>;
+  /**
+   * The current state of the component.
+   *
+   * @default "disabled"
+   */
+  get state(): State;
+  /**
+   * The position of the Swipe component. This determines what percentage
+   * of the view will be taken up by the [startLayers](#startLayers).
+   *
+   * @deprecated since 5.0, use [`position`](#position) instead.
+   * @default 25
+   */
+  accessor swipePosition: number;
+  /**
+   * A collection of layers that will show on the right or bottom side of the Swipe component.
+   *
+   * @deprecated since 5.0, use [`endLayers`](#endLayers) instead.
+   * @see [trailingLayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Swipe-SwipeViewModel.html#trailingLayers)
+   */
+  accessor trailingLayers: Collection<Layer>;
+  /**
+   * 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 Swipe component will be associated with a map or scene component rather than using the `view` property.
+   */
+  accessor view: MapView | null | undefined;
+  /** 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: 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>;
+  /**
+   * Fires when the swipe position changes and the drag handle is released on the component.
+   *
+   * **Note:** To constantly listen to changes while dragging, use the `arcgisSwipeInput` event instead.
+   *
+   * @since 4.34
+   */
+  readonly arcgisSwipeChange: import("@arcgis/lumina").TargetedEvent<this, void>;
+  /**
+   * Fires when the swipe position is updated.
+   * This event is fired continuously while dragging the handle.
+   *
+   * @since 4.34
+   */
+  readonly arcgisSwipeInput: import("@arcgis/lumina").TargetedEvent<this, void>;
+  readonly "@eventTypes": {
+    arcgisPropertyChange: ArcgisSwipe["arcgisPropertyChange"]["detail"];
+    arcgisReady: ArcgisSwipe["arcgisReady"]["detail"];
+    arcgisSwipeChange: ArcgisSwipe["arcgisSwipeChange"]["detail"];
+    arcgisSwipeInput: ArcgisSwipe["arcgisSwipeInput"]["detail"];
+  };
+}

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

@@ -11,7 +11,7 @@ import { g as b } from "../../chunks/globalCss.js";
 import { l as y } from "../../chunks/legacyIcon.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.138 */
 const k = C`:host{position:absolute;margin:0;background:transparent!important;padding:0;width:100%;height:100%;overflow:hidden;user-select:none;--arcgis-internal-swipe-handle-color-background: var(--calcite-color-background);--arcgis-internal-swipe-divider-color-background: var(--calcite-color-background)}.arcgis-swipe{width:100%;height:100%;overflow:hidden;user-select:none}.arcgis-swipe,.arcgis-ui .arcgis-swipe{pointer-events:none!important}.arcgis-swipe__container{position:absolute;z-index:1;margin:0;outline:0;border:0;padding:0;overflow:hidden;pointer-events:auto;touch-action:none;outline-color:transparent}.arcgis-swipe--horizontal .arcgis-swipe__container{margin-left:calc(var(--calcite-spacing-xxxl) / 2 * -1);cursor:col-resize;height:100%}.arcgis-swipe--vertical .arcgis-swipe__container{margin-top:calc(var(--calcite-spacing-xxxl) / 2 * -1);cursor:row-resize;width:100%}.arcgis-swipe--disabled .arcgis-swipe__container{cursor:default;pointer-events:none}.arcgis-swipe__divider{position:absolute;background-color:var(--arcgis-internal-swipe-divider-color-background)}.arcgis-swipe--horizontal .arcgis-swipe__divider{top:0;left:calc(var(--calcite-spacing-xxxl) / 2);margin-left:calc(var(--calcite-border-width-lg) * .5 * -1);border-right:var(--calcite-border-width-sm) solid var(--calcite-color-border-1);border-left:var(--calcite-border-width-sm) solid var(--calcite-color-border-1);width:var(--calcite-border-width-lg);height:100%}.arcgis-swipe--vertical .arcgis-swipe__divider{top:calc(var(--calcite-spacing-xxxl) / 2);left:0;margin-top:calc(var(--calcite-border-width-lg) * .5 * -1);border-top:var(--calcite-border-width-sm) solid var(--calcite-color-border-1);border-bottom:var(--calcite-border-width-sm) solid var(--calcite-color-border-1);width:100%;height:var(--calcite-border-width-lg)}.arcgis-swipe__handle{display:flex;position:relative;align-items:center;justify-content:center;border:var(--calcite-border-width-sm) solid var(--calcite-color-border-1);border-radius:var(--calcite-corner-radius-round);background-color:var(--arcgis-internal-swipe-handle-color-background);width:var(--calcite-spacing-xxxl);height:var(--calcite-spacing-xxxl);color:var(--calcite-color-text-3)}.arcgis-swipe__handle--hidden{visibility:hidden}.arcgis-swipe--vertical .arcgis-swipe__handle{rotate:90deg}.arcgis-swipe__handle-icon{position:relative;z-index:2}.arcgis-swipe__handle-icon:before{content:"|||";color:inherit}.arcgis-swipe--horizontal .arcgis-swipe__handle{top:calc(50% - calc(var(--calcite-spacing-xxxl) / 2))}.arcgis-swipe--vertical .arcgis-swipe__handle{left:calc(50% - calc(var(--calcite-spacing-xxxl) / 2))}.arcgis-swipe__container:focus .arcgis-swipe__handle,.arcgis-swipe__container:focus .arcgis-swipe__divider{outline:inset 2px var(--calcite-color-focus, var(--calcite-color-focus, var(--calcite-color-brand)))}.arcgis-swipe__container:focus .arcgis-swipe__handle{outline-offset:calc(-2px*(1 - (2*clamp(0,var(--calcite-offset-invert-focus),1))))}`, l = "arcgis-swipe", n = {
   base: l,
   baseDisabled: `${l}--disabled`,