@arcgis/map-components 4.33.0-next.14 → 4.33.0-next.140

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

@@ -1,98 +1,212 @@
 /// <reference types="@arcgis/core/interfaces.d.ts" />
 /// <reference types="../../index.d.ts" />
-import { Use } from '@arcgis/components-controllers';
-import { Nil } from '@arcgis/components-utils';
+import { Use } from '@arcgis/lumina/controllers';
 import { default as LayerList } from '@arcgis/core/widgets/LayerList.js';
 import { PublicLitElement as LitElement, TargetedEvent } from '@arcgis/lumina';
 import { ArcgisReferenceElement } from '../../utils/component-utils';
 
-declare const useLayerListWidget: (component: import('@arcgis/components-controllers').StencilLifecycles & {
-    manager: import('@arcgis/components-controllers').ControllerManager;
-    el: HTMLElement;
-    autoDestroyDisabled?: boolean;
-    destroy?: () => Promise<void>;
-} & Pick<LayerList, never> & {
-    reactiveUtils?: typeof __esri.reactiveUtils;
+declare const useLayerListWidget: (component: LitElement & Pick<LayerList, "icon" | "label" | "viewModel" | "headingLevel" | "collapsed" | "dragEnabled" | "filterPlaceholder" | "filterPredicate" | "filterText" | "listItemCreatedFunction" | "minDragEnabledItems" | "minFilterItems" | "selectedItems" | "selectionMode" | "catalogOptions" | "knowledgeGraphOptions" | "visibilityAppearance"> & {
     state?: unknown;
     viewModel?: __esri.LayerListViewModel | 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/components-controllers').EventEmitter;
-    arcgisPropertyChange: import('@arcgis/components-controllers').EventEmitter<{
+    arcgisReady: import('@arcgis/lumina').EventEmitter;
+    arcgisPropertyChange: import('@arcgis/lumina').EventEmitter<{
         name: string;
     }> | undefined;
     el: HTMLElement & {
         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.LayerListProperties | undefined): __esri.LayerListProperties | Promise<__esri.LayerListProperties | undefined> | undefined;
-} | undefined) => LayerList;
-/** The LayerList component provides a way to display a list of layers, and switch on/off their visibility.
+}) => LayerList;
+/**
+ * The Layer List component provides a way to display a list of layers, and switch on/off their visibility.
+ *
+ * [Read more...](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-layer-list/)
  */
 export declare class ArcgisLayerList 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-layer-list/#destroy) method when you are done to
+     * prevent memory leaks.
+     *
+     * @default false
      */
     autoDestroyDisabled: boolean;
     /** The CatalogLayerList that displays a catalog layer's dynamic group layer. */
     get catalogLayerList(): __esri.CatalogLayerList | nullish;
+    /**
+     * [CatalogLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CatalogLayer.html) specific properties.
+     *
+     * @default null
+     */
     catalogOptions: nullish | __esri.LayerListCatalogOptions;
+    /**
+     * 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-LayerList-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-LayerList.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-LayerList-ListItem.html).
+     *
+     * @default null
+     */
     filterPredicate: nullish | __esri.LayerListFilterPredicate;
+    /**
+     * The value of the filter input if [visibleElements.filter](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#visibleElements) is true.
+     *
+     * @default ""
+     */
     filterText: string;
+    /**
+     * Indicates the heading level to use for the heading of the widget.
+     *
+     * @default 2
+     */
     headingLevel: number;
+    /** @default false */
     hideCatalogLayerList: boolean;
+    /** @default false */
     hideFlow: boolean;
+    /** @default false */
     hideStatusIndicators: boolean;
     /**
-     * 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 "layers"
      */
     icon: string;
+    /**
+     * [KnowledgeGraphLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-KnowledgeGraphLayer.html) specific properties.
+     *
+     * @default null
+     */
     knowledgeGraphOptions: nullish | __esri.LayerListKnowledgeGraphOptions;
-    /** The component's default label. */
+    /**
+     * The widget's default label.
+     *
+     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#label)
+     */
     label: string;
+    /**
+     * A function that executes each time a [ListItem](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItem.html) is created.
+     *
+     * @default null
+     */
     listItemCreatedFunction: nullish | __esri.LayerListListItemCreatedHandler;
+    /**
+     * 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-LayerList.html#dragEnabled).
+     *
+     * @default 2
+     */
     minDragEnabledItems: number;
+    /**
+     * The minimum number of list items required to display the visibleElements.filter input box.
+     *
+     * @default 10
+     */
     minFilterItems: number;
+    /**
+     * A collection of [Layer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html)s that are opened
+     * in a [catalogLayerList](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#catalogLayerList) or [tableList](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#tableList) flow item.
+     *
+     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#openedLayers)
+     *
+     * @default []
+     */
     readonly openedLayers: __esri.Collection<__esri.Layer>;
     /** A collection of ListItems representing operational layers. */
     get operationalItems(): __esri.Collection<__esri.ListItem>;
+    /** @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-LayerList-ListItem.html)s representing operational layers
+     * selected by the user.
+     *
+     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#selectedItems)
+     */
     selectedItems: __esri.Collection<__esri.ListItem>;
-    selectionMode: "none" | "single" | "multiple" | "single-persist";
+    /**
+     * Specifies the selection mode.
+     *
+     * @default "none"
+     */
+    selectionMode: "single" | "multiple" | "none" | "single-persist";
+    /** @default false */
     showCloseButton: boolean;
+    /** @default false */
     showCollapseButton: boolean;
+    /** @default false */
     showErrors: boolean;
+    /** @default false */
     showFilter: boolean;
+    /** @default false */
     showHeading: boolean;
+    /** @default false */
     showTemporaryLayerIndicators: boolean;
+    /**
+     * The view model's state.
+     *
+     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-LayerListViewModel.html#state)
+     *
+     * @default "disabled"
+     */
     readonly state: "ready" | "loading" | "disabled";
     /** The TableList that displays the tables associated with a KnowledgeGraphLayer. */
     get tableList(): __esri.TableList | nullish;
+    /**
+     * Determines the icons used to indicate visibility.
+     *
+     * @default "default"
+     */
     visibilityAppearance: "default" | "checkbox";
-    /** Permanently destroy the component */
+    /** Permanently destroy the component. */
     destroy(): Promise<void>;
     triggerAction(action: __esri.ActionButton | __esri.ActionToggle, item: __esri.ListItem): 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.LayerListTriggerActionEvent>;
 }
 export {};

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

@@ -1,42 +1,37 @@
 import { c as i } from "../../chunks/runtime.js";
-import { usePropertyChange as s } from "@arcgis/components-controllers";
-import { reEmitEvent as a } from "@arcgis/components-controllers/accessor";
-import o from "@arcgis/core/widgets/LayerList.js";
+import { usePropertyChange as s } from "@arcgis/lumina/controllers";
+import { reEmitEvent as o } from "@arcgis/lumina/controllers/accessor";
+import a from "@arcgis/core/widgets/LayerList.js";
 import { LitElement as r, createEvent as l, noShadowRoot as h } from "@arcgis/lumina";
 import { m as d } from "../../chunks/useWidget.js";
-import { css as n } from "@lit/reactive-element/css-tag.js";
+import { s as n } from "../../chunks/layer-list.js";
+import { c as g } from "../../chunks/createCloseEvent.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.14 */
-const g = n`@layer{arcgis-layer-list{display:block}}`, c = d(o);
+v4.33.0-next.140 */
+const c = d(a);
 class m extends r {
   constructor() {
-    super(...arguments), this.widget = c(this), this.viewModel = this.widget.viewModel, this.autoDestroyDisabled = !1, this.catalogOptions = this.widget.catalogOptions, this.collapsed = this.widget.collapsed, this.dragEnabled = this.widget.dragEnabled, this.filterPlaceholder = this.widget.filterPlaceholder, this.filterPredicate = this.widget.filterPredicate, this.filterText = this.widget.filterText, this.headingLevel = this.widget.headingLevel, this.hideCatalogLayerList = this.widget.visibleElements.catalogLayerList, this.hideFlow = this.widget.visibleElements.flow, this.hideStatusIndicators = this.widget.visibleElements.statusIndicators, this.icon = this.widget.icon, this.knowledgeGraphOptions = this.widget.knowledgeGraphOptions, this.label = this.widget.label, this.listItemCreatedFunction = this.widget.listItemCreatedFunction, this.minDragEnabledItems = this.widget.minDragEnabledItems, this.minFilterItems = this.widget.minFilterItems, this.openedLayers = this.widget.openedLayers, this.position = "bottom-left", this.selectedItems = this.widget.selectedItems, this.selectionMode = this.widget.selectionMode, this.showCloseButton = this.widget.visibleElements.closeButton, this.showCollapseButton = this.widget.visibleElements.collapseButton, this.showErrors = this.widget.visibleElements.errors, this.showFilter = this.widget.visibleElements.filter, this.showHeading = this.widget.visibleElements.heading, this.showTemporaryLayerIndicators = this.widget.visibleElements.temporaryLayerIndicators, this.state = this.viewModel.state, this.visibilityAppearance = this.widget.visibilityAppearance, this.arcgisPropertyChange = s()("state"), this.arcgisReady = l(), this.arcgisTriggerAction = a(() => this.widget, "trigger-action");
+    super(...arguments), this.widget = c(this), this.viewModel = this.widget.viewModel, this.arcgisClose = g(this), this.autoDestroyDisabled = !1, this.catalogOptions = this.widget.catalogOptions, this.closed = !1, this.collapsed = this.widget.collapsed, this.dragEnabled = this.widget.dragEnabled, this.filterPlaceholder = this.widget.filterPlaceholder, this.filterPredicate = this.widget.filterPredicate, this.filterText = this.widget.filterText, this.headingLevel = this.widget.headingLevel, this.hideCatalogLayerList = this.widget.visibleElements.catalogLayerList, this.hideFlow = this.widget.visibleElements.flow, this.hideStatusIndicators = this.widget.visibleElements.statusIndicators, this.icon = this.widget.icon, this.knowledgeGraphOptions = this.widget.knowledgeGraphOptions, this.label = this.widget.label, this.listItemCreatedFunction = this.widget.listItemCreatedFunction, this.minDragEnabledItems = this.widget.minDragEnabledItems, this.minFilterItems = this.widget.minFilterItems, this.openedLayers = this.widget.openedLayers, this.position = "bottom-left", this.selectedItems = this.widget.selectedItems, this.selectionMode = this.widget.selectionMode, this.showCloseButton = this.widget.visibleElements.closeButton, this.showCollapseButton = this.widget.visibleElements.collapseButton, this.showErrors = this.widget.visibleElements.errors, this.showFilter = this.widget.visibleElements.filter, this.showHeading = this.widget.visibleElements.heading, this.showTemporaryLayerIndicators = this.widget.visibleElements.temporaryLayerIndicators, this.state = this.viewModel.state, this.visibilityAppearance = this.widget.visibilityAppearance, this.arcgisPropertyChange = s()("state"), this.arcgisReady = l(), this.arcgisTriggerAction = o(() => this.widget, "trigger-action");
   }
   static {
-    this.properties = { autoDestroyDisabled: 5, catalogLayerList: 32, catalogOptions: 0, collapsed: 7, dragEnabled: 5, filterPlaceholder: 1, filterPredicate: 0, filterText: 1, headingLevel: 9, hideCatalogLayerList: 5, hideFlow: 5, hideStatusIndicators: 5, icon: 1, knowledgeGraphOptions: 0, label: 1, listItemCreatedFunction: 0, minDragEnabledItems: 9, minFilterItems: 9, openedLayers: 0, operationalItems: 32, position: 1, referenceElement: 1, selectedItems: 0, selectionMode: 1, showCloseButton: 5, showCollapseButton: 5, showErrors: 5, showFilter: 5, showHeading: 5, showTemporaryLayerIndicators: 5, state: 3, tableList: 32, visibilityAppearance: 1 };
+    this.properties = { autoDestroyDisabled: 5, catalogLayerList: 32, catalogOptions: 0, closed: 5, collapsed: 7, dragEnabled: 5, filterPlaceholder: 1, filterPredicate: 0, filterText: 1, headingLevel: 9, hideCatalogLayerList: 5, hideFlow: 5, hideStatusIndicators: 5, icon: 1, knowledgeGraphOptions: 0, label: 1, listItemCreatedFunction: 0, minDragEnabledItems: 9, minFilterItems: 9, openedLayers: 0, operationalItems: 32, position: 1, referenceElement: 1, selectedItems: 0, selectionMode: 1, showCloseButton: 5, showCollapseButton: 5, showErrors: 5, showFilter: 5, showHeading: 5, showTemporaryLayerIndicators: 5, state: 3, tableList: 32, visibilityAppearance: 1 };
   }
   static {
     this.shadowRootOptions = h;
   }
   static {
-    this.styles = g;
+    this.styles = n;
   }
-  /** The CatalogLayerList that displays a catalog layer's dynamic group layer. */
   get catalogLayerList() {
     return this.widget.catalogLayerList;
   }
-  /** A collection of ListItems representing operational layers. */
   get operationalItems() {
     return this.widget.operationalItems;
   }
-  /** The TableList that displays the tables associated with a KnowledgeGraphLayer. */
   get tableList() {
     return this.widget.tableList;
   }
-  // #endregion
-  // #region Public Methods
-  /** Permanently destroy the component */
   async destroy() {
     await this.manager.destroy();
   }

package/dist/components/arcgis-layer-list-item/customElement.d.ts

@@ -0,0 +1,70 @@
+/// <reference types="@arcgis/core/interfaces.d.ts" />
+/// <reference types="../../index.d.ts" />
+import { Action, VisibilityAppearance } from '../../utils/action-utils';
+import { TableSupportedLayers } from '../../utils/layer-list-utils';
+import { css as LayerListCSS } from '../arcgis-layer-list/css';
+import { JsxNode, PublicLitElement as LitElement, TargetedEvent } from '@arcgis/lumina';
+
+type ListDisplayMode = "flat" | "nested";
+type DragDetail = Parameters<HTMLCalciteSortableListElement["canPull"]>[0];
+type UnionListItem = __esri.ListItem | __esri.TableListListItem;
+type UnionCSS = typeof LayerListCSS;
+/** @private */
+export declare class ArcgisLayerListItem extends LitElement {
+    activeItem?: UnionListItem;
+    canMove?: ({ dragEl, fromEl, toEl }: DragDetail, type: "pull" | "put") => boolean;
+    css: UnionCSS;
+    displayMode: ListDisplayMode;
+    /** @default false */
+    hideCatalogLayerList: boolean;
+    /** @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 */
+    showTemporaryLayerIndicators: boolean;
+    /** @default false */
+    showTemporaryTableIndicators: boolean;
+    /** @default false */
+    dragEnabled: boolean;
+    item: UnionListItem;
+    layerTablesEnabled?: __esri.Collection<TableSupportedLayers>;
+    /** @default false */
+    listModeDisabled: boolean;
+    handleAction: (action: Action, item: UnionListItem) => void;
+    handlePanelOpen: () => void;
+    handleCatalogOpen?: (item: __esri.ListItem) => void;
+    handleTablesOpen?: (item: __esri.ListItem) => void;
+    handleSelectedDragItemLayerUidChange?: (uid: string | null) => void;
+    handleTooltipReferenceChange?: (id: string, element: HTMLSpanElement | null) => void;
+    parent?: UnionListItem;
+    parentTitles?: string[];
+    rootGroupUid: string;
+    selectionMode: HTMLCalciteListElement["selectionMode"];
+    selectedItems: __esri.Collection<UnionListItem>;
+    selectedDragItemLayerUid?: string;
+    visibilityAppearance?: VisibilityAppearance;
+    /**
+     * 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-layer-list-item/#destroy) method when you are done to
+     * prevent memory leaks.
+     *
+     * @default false
+     */
+    autoDestroyDisabled: boolean;
+    /** Permanently destroy the component. */
+    destroy(): Promise<void>;
+}
+export {};