@arcgis/map-components 4.33.0-next.99 → 4.34.0-next.0

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

@@ -1,17 +1,17 @@
 /// <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 Slider } from '@arcgis/core/widgets/Slider.js';
 import { PublicLitElement as LitElement, TargetedEvent } from '@arcgis/lumina';
 import { ArcgisReferenceElement } from '../../utils/component-utils';
 
-declare const useSliderWidget: (component: LitElement & Pick<Slider, never> & {
+declare const useSliderWidget: (component: LitElement & Pick<Slider, "icon" | "label" | "viewModel" | "values" | "layout" | "tickConfigs" | "draggableSegmentsEnabled" | "effectiveMax" | "effectiveMin" | "labelInputsEnabled" | "max" | "min" | "precision" | "rangeLabelInputsEnabled" | "snapOnClickEnabled" | "steps" | "syncedSegmentsEnabled" | "thumbsConstrained"> & {
     state?: "ready" | "disabled" | "editing" | "dragging" | undefined;
     viewModel?: __esri.SliderViewModel | 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<{
@@ -21,14 +21,14 @@ declare const useSliderWidget: (component: LitElement & Pick<Slider, never> & {
         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.SliderProperties | undefined): __esri.SliderProperties | Promise<__esri.SliderProperties | undefined> | undefined;
-} | undefined) => Slider;
+}) => Slider;
 /**
+ * [Read more...](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-slider/)
+ *
  * @internal
  */
 export declare class ArcgisSlider extends LitElement {
@@ -36,55 +36,199 @@ export declare class ArcgisSlider 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\` 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-slider/#destroy) method when you are done to
+     * prevent memory leaks.
+     *
+     * @default false
      */
     autoDestroyDisabled: boolean;
+    /**
+     * Indicates if the user can drag the segment between thumbs
+     * to update thumb positions.
+     *
+     * @default true
+     */
     draggableSegmentsEnabled: boolean;
+    /**
+     * When set, the user is restricted from moving slider thumbs to positions higher than
+     * this value.
+     *
+     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#effectiveMax)
+     */
     effectiveMax: number | nullish;
+    /**
+     * When set, the user is restricted from moving slider thumbs to positions less than
+     * this value.
+     *
+     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#effectiveMin)
+     */
     effectiveMin: number | nullish;
+    /**
+     * The HTML Element nodes representing the slider segment between the [min](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#min) and [effectiveMin](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#effectiveMin), and the segment between the
+     * [effectiveMax](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#effectiveMax) and [max](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#max).
+     *
+     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#effectiveSegmentElements)
+     */
     readonly effectiveSegmentElements: __esri.Collection<HTMLElement>;
     /**
-     * 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.
+     * Icon displayed in the widget's button.
+     *
+     * @see [Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)
+     * @default "caret-double-horizontal"
      */
     icon: string;
-    /** The component's default label. */
+    /**
+     * The widget's default label.
+     *
+     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#label)
+     */
     label: string;
+    /**
+     * The HTML Element nodes representing [labels](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#labels) attached to slider thumbs.
+     *
+     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#labelElements)
+     */
     readonly labelElements: __esri.Collection<HTMLElement>;
+    /**
+     * Indicates whether to enable editing input values via keyboard input
+     * when the user clicks a label.
+     *
+     * @default false
+     */
     labelInputsEnabled: boolean;
+    /**
+     * An array of strings associated with 'values' generated using an internal label formatter or
+     * the values returned from [labelFormatFunction](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#labelFormatFunction).
+     *
+     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#labels)
+     */
     readonly labels: __esri.LabelInfos;
+    /**
+     * Determines the layout/orientation of the Slider widget.
+     *
+     * @default "horizontal"
+     */
     layout: "vertical" | "horizontal" | "horizontal-reversed" | "vertical-reversed";
+    /**
+     * The maximum possible data/thumb value of the slider.
+     *
+     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#max)
+     */
     max: number | nullish;
+    /**
+     * The HTML Element node representing the [max](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#max) value label.
+     *
+     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#maxLabelElement)
+     */
     readonly maxLabelElement: HTMLElement | nullish;
+    /**
+     * The minimum possible data/thumb value of the slider.
+     *
+     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#min)
+     */
     min: number | nullish;
+    /**
+     * The HTML Element node representing the [min](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#min) value label.
+     *
+     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#minLabelElement)
+     */
     readonly minLabelElement: HTMLElement | nullish;
+    /** @default "bottom-left" */
     position: __esri.UIPosition;
+    /**
+     * Defines how slider thumb values should be rounded.
+     *
+     * @default 4
+     */
     precision: number;
+    /**
+     * Indicates whether to enable editing range values via keyboard input
+     * when the user clicks a [min](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#min) or [max](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#max) label.
+     *
+     * @default false
+     */
     rangeLabelInputsEnabled: boolean;
-    referenceElement: ArcgisReferenceElement | Nil | string;
+    referenceElement?: ArcgisReferenceElement | string;
+    /**
+     * The HTML Element nodes representing interactive slider segments.
+     *
+     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#segmentElements)
+     */
     readonly segmentElements: __esri.Collection<HTMLElement>;
+    /**
+     * Indicates if the closest thumb will snap to the clicked location on the track.
+     *
+     * @default true
+     */
     snapOnClickEnabled: boolean;
+    /**
+     * The current state of the widget.
+     *
+     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#state)
+     */
     readonly state: "ready" | "disabled" | "editing" | "dragging";
+    /**
+     * Sets steps, or intervals, on the slider that restrict user
+     * input to specific values.
+     *
+     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#steps)
+     */
     steps: number | nullish | number[];
+    /**
+     * When `true`, all segments will sync together in updating thumb values when the user drags any segment.
+     *
+     * @default false
+     */
     syncedSegmentsEnabled: boolean;
+    /**
+     * The HTML Element nodes representing slider thumbs.
+     *
+     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#thumbElements)
+     */
     readonly thumbElements: __esri.Collection<HTMLElement>;
+    /**
+     * When `false`, the user can freely move any slider thumb to any
+     * position along the track.
+     *
+     * @default true
+     */
     thumbsConstrained: boolean;
+    /**
+     * When set, renders ticks along the slider track.
+     *
+     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#tickConfigs)
+     */
     tickConfigs: __esri.TickConfig[];
+    /**
+     * The HTML Element nodes representing slider ticks and their associated labels.
+     *
+     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#tickElements)
+     */
     readonly tickElements: __esri.Collection<__esri.Collection<__esri.TickElementGroup>>;
+    /**
+     * The HTML Element node representing the slider track.
+     *
+     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#trackElement)
+     */
     readonly trackElement: HTMLElement | nullish;
+    /**
+     * An array of numbers representing absolute thumb positions on the slider.
+     *
+     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#values)
+     */
     values: nullish | number[];
-    /** Permanently destroy the component */
+    /** Permanently destroy the component. */
     destroy(): Promise<void>;
     readonly arcgisMaxChange: TargetedEvent<this, __esri.SliderMaxChangeEvent>;
     readonly arcgisMaxClick: TargetedEvent<this, __esri.SliderMaxClickEvent>;
     readonly arcgisMinChange: TargetedEvent<this, __esri.SliderMinChangeEvent>;
     readonly arcgisMinClick: TargetedEvent<this, __esri.SliderMinClickEvent>;
+    /** 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>;
+    /** Emitted when the component associated with a map or scene view is is ready to be interacted with. */
+    readonly arcgisReady: TargetedEvent<this, void>;
     readonly arcgisSegmentClick: TargetedEvent<this, __esri.SliderSegmentClickEvent>;
     readonly arcgisSegmentDrag: TargetedEvent<this, __esri.SliderSegmentDragEvent>;
     readonly arcgisThumbChange: TargetedEvent<this, __esri.SliderThumbChangeEvent>;

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

@@ -6,8 +6,8 @@ import { LitElement as a, createEvent as l, noShadowRoot as h } from "@arcgis/lu
 import { m as g } from "../../chunks/useWidget.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.99 */
+See https://js.arcgis.com/4.34/esri/copyright.txt for details.
+v4.34.0-next.0 */
 const c = m`@layer{arcgis-slider{min-width:200px;min-height:25px}}`, r = g(n);
 class d extends a {
   constructor() {
@@ -22,9 +22,6 @@ class d extends a {
   static {
     this.styles = c;
   }
-  //#endregion
-  //#region Public Methods
-  /** Permanently destroy the component */
   async destroy() {
     await this.manager.destroy();
   }

package/dist/components/arcgis-swipe/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 SwipeViewModel } from '@arcgis/core/widgets/Swipe/SwipeViewModel.js';
 import { JsxNode, PublicLitElement as LitElement, TargetedEvent } from '@arcgis/lumina';
 import { ArcgisReferenceElement } from '../../utils/component-utils';
 
-declare const useSwipeViewModel: (component: LitElement & Pick<SwipeViewModel, never> & import('../../controllers/useViewModel').ViewModelControllerUses<SwipeViewModel>, options?: {
-    editConstructorProperties(props: unknown): unknown;
-} | undefined) => SwipeViewModel;
+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
@@ -21,70 +18,96 @@ declare const useSwipeViewModel: (component: LitElement & Pick<SwipeViewModel, n
  * **Known Limitations**
  *
  * - This component is not currently supported within an `arcgis-scene` component.
+ *
+ * [Read more...](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-swipe/)
  */
 export declare 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
-     * 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-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: "vertical" | "horizontal";
     /**
      * When `true`, sets the component to a disabled state so the user cannot interact with it.
+     *
+     * @default false
      */
     disabled: boolean;
     /**
      * 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.
+     *
+     * @default "compare"
      */
-    icon: Nil | string;
+    icon?: string;
     /**
      * The component's default label.
+     *
+     * @default "Swipe"
      */
-    label: Nil | string;
-    /**
-     * A collection of layers that will show on the left or top side of the Swipe component.
-     */
+    label?: string;
+    /** A collection of layers that will show on the left or top side of the Swipe component. */
     leadingLayers: __esri.Collection<__esri.Layer>;
-    /** Replace localized message strings with your own strings. */
+    /** Replace localized message strings with your own strings. **Warning**: individual message keys may change between releases. */
     messageOverrides?: typeof this.messages._overrides;
+    /** @default "manual" */
     position: __esri.UIPosition;
     /**
      * The position of the Swipe component. This determines what percentage
      * of the view will be taken up by the [leadingLayers](#leadingLayers).
+     *
+     * @default 25
      */
     swipePosition: number;
-    referenceElement: ArcgisReferenceElement | Nil | string;
+    referenceElement?: ArcgisReferenceElement | string;
     /**
-     * The current state of the component.
+     * The current state of the Swipe.
+     *
+     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Swipe-SwipeViewModel.html#state)
+     *
+     * @default "disabled"
      */
     readonly state: "ready" | "disabled";
-    /**
-     * A collection of layers that will show on the right or bottom side of the Swipe component.
-     */
+    /** A collection of layers that will show on the right or bottom side of the Swipe component. */
     trailingLayers: __esri.Collection<__esri.Layer>;
-    /** 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;
+        dragLabel: string;
+    }> & import('@arcgis/lumina/controllers').T9nMeta<{
+        componentLabel: string;
+        dragLabel: string;
+    }>;
 }
 export {};

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

@@ -10,8 +10,8 @@ import { g as m } from "../../chunks/globalCss.js";
 import { l as b } from "../../chunks/legacyIcon.js";
 import { css as A } 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.99 */
+See https://js.arcgis.com/4.34/esri/copyright.txt for details.
+v4.34.0-next.0 */
 const H = A`@layer{arcgis-swipe,.arcgis-swipe{position:absolute;margin:0;background:transparent!important;padding:0;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(--calcite-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(--calcite-color-background);width:var(--calcite-spacing-xxxl);height:var(--calcite-spacing-xxxl);color:var(--calcite-color-border-input)}.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--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-ui-focus-color, 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`,
@@ -32,7 +32,7 @@ class O extends P {
     }, this.autoDestroyDisabled = !1, this.direction = this.viewModel.direction, this.disabled = !1, this.hideDivider = !1, this.hideHandle = !1, this.icon = "compare", this.label = this.messages.componentLabel, this.leadingLayers = this.viewModel.leadingLayers, this.position = "manual", this.swipePosition = this.viewModel.position, this.state = this.viewModel.state, this.trailingLayers = this.viewModel.trailingLayers, this.arcgisPropertyChange = $()("state"), this.arcgisReady = C();
   }
   static {
-    this.properties = { autoDestroyDisabled: 5, direction: 3, disabled: 7, hideDivider: 7, hideHandle: 7, icon: 3, label: 1, leadingLayers: 0, messageOverrides: 0, position: 3, swipePosition: 9, referenceElement: 1, state: 3, trailingLayers: 0 };
+    this.properties = { autoDestroyDisabled: 5, direction: 3, disabled: 7, hideDivider: 7, hideHandle: 7, icon: 1, label: 1, leadingLayers: 0, messageOverrides: 0, position: 3, swipePosition: 9, referenceElement: 1, state: 3, trailingLayers: 0 };
   }
   static {
     this.shadowRootOptions = M;
@@ -40,19 +40,12 @@ class O extends P {
   static {
     this.styles = H;
   }
-  //#endregion
-  //#region Public Methods
-  /** Permanently destroy the component */
   async destroy() {
     await this.manager.destroy();
   }
-  //#endregion
-  //#region Lifecycle
   loaded() {
     this.listenOn(document, "pointermove", this._onContainerPointerMove), this.listenOn(document, "pointerup", this._onContainerPointerUp);
   }
-  //#endregion
-  //#region Private Methods
   _calculatePointerOffset(i) {
     const { direction: e } = this, t = i.target, r = (e === "vertical" ? t.clientHeight : t.clientWidth) / 2, s = t.getBoundingClientRect(), o = i.clientX - s.left, d = i.clientY - s.top;
     this._pointerOffset = e === "vertical" ? d - r : o - r;
@@ -83,8 +76,6 @@ class O extends P {
     const e = this._getKeyPosition(i);
     typeof e == "number" && (this.swipePosition = e);
   }
-  //#endregion
-  //#region Rendering
   render() {
     const { state: i, direction: e } = this.viewModel, t = i === "disabled" || this.disabled, r = {
       [m.disabled]: t,

package/dist/components/arcgis-table-list/customElement.d.ts

@@ -1,17 +1,17 @@
 /// <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 TableList } from '@arcgis/core/widgets/TableList.js';
 import { PublicLitElement as LitElement, TargetedEvent } from '@arcgis/lumina';
 import { ArcgisReferenceElement } from '../../utils/component-utils';
 
-declare const useTableListWidget: (component: LitElement & Pick<TableList, never> & {
+declare const useTableListWidget: (component: LitElement & Pick<TableList, "icon" | "label" | "viewModel" | "collapsed" | "dragEnabled" | "filterPlaceholder" | "filterPredicate" | "filterText" | "listItemCreatedFunction" | "minDragEnabledItems" | "minFilterItems" | "selectedItems" | "selectionMode"> & {
     state?: unknown;
     viewModel?: __esri.TableListViewModel | 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<{
@@ -19,72 +19,154 @@ declare const useTableListWidget: (component: LitElement & Pick<TableList, never
     }> | undefined;
     el: HTMLElement & {
         childElem?: HTMLElement & {
-            ownedBy
-            /**
-             * 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.
-             */
-            ?: 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.TableListProperties | undefined): __esri.TableListProperties | Promise<__esri.TableListProperties | undefined> | undefined;
-} | undefined) => TableList;
-/** The Table List component provides a way to display a list of tables associated with a [Map](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html).
+}) => TableList;
+/**
+ * The Table List component provides a way to display a list of tables associated with a [Map](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html).
+ *
+ * [Read more...](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-table-list/)
  */
 export declare class ArcgisTableList extends LitElement {
+    /**
+     * Emitted when the component's close button is clicked.
+     *
+     * @since 4.33
+     */
     readonly arcgisClose: TargetedEvent<this>;
     /**
      * 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-table-list/#destroy) method when you are done to
+     * prevent memory leaks.
+     *
+     * @default false
      */
     autoDestroyDisabled: boolean;
+    /**
+     * Indicates whether a component is closed. When `true`, the component will be hidden.
+     *
+     * @since 4.33
+     * @default false
+     */
+    closed: boolean;
+    /**
+     * Indicates whether the widget is collapsed.
+     *
+     * @default false
+     */
     collapsed: boolean;
+    /**
+     * Indicates whether [list items](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList-ListItem.html) may be reordered within the list by dragging and dropping.
+     *
+     * @default false
+     */
     dragEnabled: boolean;
+    /**
+     * Placeholder text used in the filter input if [visibleElements.filter](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList.html#visibleElements) is true.
+     *
+     * @default ""
+     */
     filterPlaceholder: string;
+    /**
+     * Specifies a function to handle filtering [list items](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList-ListItem.html).
+     *
+     * @default null
+     */
     filterPredicate: nullish | __esri.TableListFilterPredicate;
+    /**
+     * The value of the filter input text string if [visibleElements.filter](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList.html#visibleElements) is true.
+     *
+     * @default ""
+     */
     filterText: string;
     /**
-     * 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.
+     * Icon which represents the widget.
+     *
+     * @see [Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)
+     * @default "table"
      */
     icon: string;
-    /** The component's default label. */
+    /**
+     * The widget's default label.
+     *
+     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList.html#label)
+     */
     label: string;
+    /**
+     * Specifies a function that accesses each [ListItem](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList-ListItem.html).
+     *
+     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList.html#listItemCreatedFunction)
+     */
     listItemCreatedFunction: nullish | __esri.TableListListItemCreatedHandler;
+    /**
+     * The minimum number of list items required to enable drag and drop reordering with [dragEnabled](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList.html#dragEnabled).
+     *
+     * @default 2
+     */
     minDragEnabledItems: number;
+    /**
+     * The minimum number of list items required to display the visibleElements.filter input box.
+     *
+     * @default 10
+     */
     minFilterItems: number;
+    /** @default "bottom-left" */
     position: __esri.UIPosition;
-    referenceElement: ArcgisReferenceElement | Nil | string;
+    referenceElement?: ArcgisReferenceElement | string;
+    /**
+     * A collection of selected [ListItem](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList-ListItem.html)s representing table list items
+     * selected by the user.
+     *
+     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList.html#selectedItems)
+     */
     selectedItems: __esri.Collection<__esri.TableListListItem>;
+    /**
+     * Specifies the selection mode.
+     *
+     * @default "none"
+     */
     selectionMode: "single" | "multiple" | "none" | "single-persist";
-    readonly state: "ready" | "disabled" | "loading";
+    /**
+     * The view model's state.
+     *
+     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList-TableListViewModel.html#state)
+     *
+     * @default "disabled"
+     */
+    readonly state: "ready" | "loading" | "disabled";
     /** The collection of table ListItems displayed within the component. */
     get tableItems(): __esri.Collection<__esri.TableListListItem>;
+    /** @default false */
     showCloseButton: boolean;
+    /** @default false */
     showCollapseButton: boolean;
+    /** @default false */
     showErrors: boolean;
+    /** @default false */
     showFilter: boolean;
+    /** @default false */
     hideFlow: boolean;
+    /** @default false */
     showHeading: boolean;
+    /** @default false */
     hideStatusIndicators: boolean;
+    /** @default false */
     showTemporaryTableIndicators: boolean;
-    /** 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>;
+    /** Emitted when the component associated with a map or scene view is is ready to be interacted with. */
+    readonly arcgisReady: TargetedEvent<this, void>;
+    /** Emitted when an action is triggered on the component. */
     readonly arcgisTriggerAction: TargetedEvent<this, __esri.TableListTriggerActionEvent>;
 }
 export {};