@esri/solutions-components 1.0.0-next.20250501.1 → 1.0.0-next.20250506

package/dist/components/layer-list/customElement.js

@@ -7,7 +7,7 @@ import { LitElement as L, createEvent as c, noShadowRoot as w } from "@arcgis/lu
 import { css as g } from "@lit/reactive-element/css-tag.js";
 /*! All material copyright Esri, All Rights Reserved, unless otherwise specified.
 See https://js.arcgis.com/1.0/esri/copyright.txt for details.
-v1.0.0-next.20250501 */
+v1.0.0-next.20250506 */
 async function _(o, e) {
   const { api: s = 4, type: t = "decimal", places: i = 2 } = e || {};
   if (s === 4) {
@@ -52,69 +52,28 @@ class x extends L {
   static {
     this.shadowRootOptions = w;
   }
-  /** TODO: [MIGRATION] Consider inlining some of the watch functions called inside of this method to reduce boilerplate code */
   willUpdate(e) {
     e.has("filterByMapExtent") && (this.hasUpdated || this.filterByMapExtent !== !1) && this.filterByMapExtentWatchHandler(this.filterByMapExtent);
   }
-  //--------------------------------------------------------------------------
-  //
-  //  Watch handlers
-  //
-  //--------------------------------------------------------------------------
-  /** Watch for filterByMapExtent change and update the layer list */
   filterByMapExtentWatchHandler(e) {
     e ? this.initializeMapExtentFilter() : this._filterByMapExtentHandle && this._filterByMapExtentHandle.remove();
   }
-  //--------------------------------------------------------------------------
-  //
-  //  Methods (public)
-  //
-  //--------------------------------------------------------------------------
-  /**
-   * Refresh the layer list which will fetch the latest layer count and update the list
-   *
-   * @returns Promise that resolves when the operation is complete
-   */
   async refresh() {
     await this.setLayers();
   }
-  /**
-   * Called once just after the component is first connected to the DOM.
-   *
-   * @returns Promise when complete
-   */
   async load() {
     await this.initModules(), this.filterByMapExtent && this.initializeMapExtentFilter();
   }
-  /** Called once just after the component is fully loaded and the first render() occurs. */
-  /** This lifecycle method is not expected to return a promise. The returned promise will be ignored by Lit rather than awaited. */
   async loaded() {
     await this.setLayers();
   }
-  /** Renders the component. */
   render() {
     return r`${this._isLoading && r`<calcite-loader label scale=m></calcite-loader>` || ""}${!this._isLoading && this.mapView && this._noLayersToDisplay && r`<calcite-notice class="error-msg" icon=layers-reference kind=danger open><div slot=title>${this._translations.error}</div><div slot=message>${this._translations.noLayerToDisplayErrorMsg}</div></calcite-notice>` || ""}${!this._isLoading && this.mapView && r`<calcite-list label selection-appearance=border selection-mode=none>${this.renderLayerList()}</calcite-list>` || ""}`;
   }
-  //--------------------------------------------------------------------------
-  //
-  //  Functions (protected)
-  //
-  //--------------------------------------------------------------------------
-  /**
-   * Load esri javascript api modules
-   *
-   * @returns Promise resolving when function is done
-   * @protected
-   */
   async initModules() {
     const [e] = await f(["esri/core/reactiveUtils"]);
     this.reactiveUtils = e;
   }
-  /**
-   * Updates the layer list based on map view extent
-   *
-   * @protected
-   */
   initializeMapExtentFilter() {
     this._filterByMapExtentHandle = this.reactiveUtils?.when(() => this.mapView?.stationary, () => {
       this.setLayers();
@@ -122,21 +81,9 @@ class x extends L {
       initial: !0
     });
   }
-  /**
-   * Fetch the ids of the layers from the map
-   *
-   * @returns Promise when the operation has completed
-   * @protected
-   */
   async setLayers() {
     this.mapView && (this._isLoading = !0, await this.initLayerHash(), this._isLoading = !1);
   }
-  /**
-   * Create a layer hash for layer name display
-   *
-   * @returns Promise when the operation has completed
-   * @protected
-   */
   async initLayerHash() {
     const e = [];
     if (this.mapView) {
@@ -168,26 +115,13 @@ class x extends L {
       });
     }
   }
-  /** Set no layers to display state and emit event */
   handleNoLayersToDisplay() {
     this._noLayersToDisplay = !(this._mapLayerIds.length > 0), this.layersListLoaded.emit(this._mapLayerIds);
   }
-  /**
-   * Returns the ids of configured layers that needs to be shown in the list
-   *
-   * @param hash each layer item details
-   * @returns array of layer ids
-   */
   getLayersToBeShownInList(e) {
     const s = this.layers?.length > 0 ? this.layers : [];
     return Object.keys(e).reduce((t, i) => (s.indexOf(i) > -1 && t.push(i), t), []);
   }
-  /**
-   * Render feature layer list
-   *
-   * @returns layer list
-   * @protected
-   */
   renderLayerList() {
     return this._mapLayerIds.length > 0 ? this._mapLayerIds.reduce((e, s) => {
       if (this._layerItemsHash && this._layerItemsHash[s]) {
@@ -197,25 +131,12 @@ class x extends L {
       return e;
     }, []) : void 0;
   }
-  /**
-   * Get each item
-   *
-   * @param layerId Layer id
-   * @returns individual item
-   * @protected
-   */
   getLayerListItem(e) {
     const s = this._layerItemsHash && this._layerItemsHash[e].name, t = this._layerItemsHash && this._layerItemsHash[e].formattedFeatureCount;
     return r`<calcite-list-item @calciteListItemSelect=${() => {
       this.onLayerItemSelected(e);
     }}><div class="layer-name" slot=content-start>${s}</div>${this.showFeatureCount && t !== void 0 && t !== "" && r`<div class="feature-count" slot=content-end>${`(${t})`}</div>` || ""}${this.showNextIcon && r`<calcite-icon flip-rtl icon=chevron-right scale=s slot=content-end></calcite-icon>` || ""}</calcite-list-item>`;
   }
-  /**
-   * On click of layer list item emit the event along with the selected layerId and layerName
-   *
-   * @param layerId Layer id
-   * @protected
-   */
   onLayerItemSelected(e) {
     this._layerItemsHash && this.layerSelect.emit({ layerId: e, layerName: this._layerItemsHash[e]?.name });
   }

package/dist/components/layer-table/customElement.d.ts

@@ -10,19 +10,43 @@ export declare class LayerTable extends LitElement {
     appLayout: AppLayout | undefined;
     /** string: Global ID of the feature to select */
     defaultGlobalId: string[];
-    /** string: when provided this layer ID will be used when the app loads */
+    /**
+     * string: when provided this layer ID will be used when the app loads
+     *
+     * @default ''
+     */
     defaultLayerId: string;
     /** number: when provided this will be used to select a feature in the table by default */
     defaultOid: number[];
-    /** boolean: when true the layer table will auto refresh the data */
+    /**
+     * boolean: when true the layer table will auto refresh the data
+     *
+     * @default false
+     */
     enableAutoRefresh: boolean;
-    /** boolean: when true the layer table will support drag/drop of columns to adjust order */
+    /**
+     * boolean: when true the layer table will support drag/drop of columns to adjust order
+     *
+     * @default true
+     */
     enableColumnReorder: boolean;
-    /** boolean: when true the export to csv button will be available */
+    /**
+     * boolean: when true the export to csv button will be available
+     *
+     * @default false
+     */
     enableCSV: boolean;
-    /** boolean: when true edits can be applied directly within the table */
+    /**
+     * boolean: when true edits can be applied directly within the table
+     *
+     * @default false
+     */
     enableInlineEdit: boolean;
-    /** boolean: when true the share widget will be available */
+    /**
+     * boolean: when true the share widget will be available
+     *
+     * @default false
+     */
     enableShare: boolean;
     /**
      * boolean: when true we will honor field order and visibility that may have been defined
@@ -30,31 +54,65 @@ export declare class LayerTable extends LitElement {
      *
      * Field order defined in the mapInfo as would be the case for Instant App configurations
      * will always override this map level setting.
+     *
+     * @default false
      */
     honorMapFieldSettings: boolean;
-    /** When true the component will render an optimized view for mobile devices */
+    /**
+     * When true the component will render an optimized view for mobile devices
+     *
+     * @default false
+     */
     isMobile: boolean;
-    /** boolean: when true the map is hidden and map specific controls should be hidden */
+    /**
+     * boolean: when true the map is hidden and map specific controls should be hidden
+     *
+     * @default false
+     */
     mapHidden: boolean;
     /** IMapInfo: key configuration details about the current map */
     mapInfo: IMapInfo | undefined;
     /** esri/views/View: https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html */
     mapView: __esri.MapView | undefined;
-    /** boolean: When true only editable layers that support the update capability will be available */
+    /**
+     * boolean: When true only editable layers that support the update capability will be available
+     *
+     * @default false
+     */
     onlyShowUpdatableLayers: boolean;
     /** number[]: A list of ids that are currently selected */
-    selectedIds: number[];
-    /** boolean: When true the share options will include embed option */
+    selectedIds: (number | string)[];
+    /**
+     * boolean: When true the share options will include embed option
+     *
+     * @default false
+     */
     shareIncludeEmbed: boolean;
-    /** boolean: When true the share options will include social media sharing */
+    /**
+     * boolean: When true the share options will include social media sharing
+     *
+     * @default false
+     */
     shareIncludeSocial: boolean;
-    /** boolean: when true the table will be sorted by objectid in descending order by default */
+    /**
+     * boolean: when true the table will be sorted by objectid in descending order by default
+     *
+     * @default false
+     */
     showNewestFirst: boolean;
-    /** boolean: When true the selected feature will zoomed to in the map and the row will be scrolled to within the table */
+    /**
+     * boolean: When true the selected feature will zoomed to in the map and the row will be scrolled to within the table
+     *
+     * @default false
+     */
     zoomAndScrollToSelected: boolean;
     /** number: default scale to zoom to when zooming to a single point feature */
     zoomToScale: number | undefined;
-    /** boolean: create filter modal optional (default true) boolean value to create filter modal in layer table */
+    /**
+     * boolean: create filter modal optional (default true) boolean value to create filter modal in layer table
+     *
+     * @default true
+     */
     createFilterModal: boolean;
     /** Closes the filter */
     closeFilter(): Promise<void>;
@@ -69,7 +127,7 @@ export declare class LayerTable extends LitElement {
     /** refresh the feature table */
     refresh(): Promise<void>;
     /** Emitted on demand when a layer is selected */
-    readonly featureSelectionChange: TargetedEvent<this, number[]>;
+    readonly featureSelectionChange: TargetedEvent<this, (string | number)[]>;
     /** Emitted on demand when filter action is clicked */
     readonly toggleFilter: TargetedEvent<this, undefined>;
     /** Emitted on demand when when the delete dialog should be shown */