@arcgis/map-components 5.2.0-next.87 → 5.2.0-next.88

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

@@ -1,27 +1,28 @@
 /// <reference path="../../index.d.ts" />
 import type Collection from "@arcgis/core/core/Collection.js";
-import type CatalogLayer from "@arcgis/core/layers/CatalogLayer.js";
-import type KnowledgeGraphLayer from "@arcgis/core/layers/KnowledgeGraphLayer.js";
-import type MapImageLayer from "@arcgis/core/layers/MapImageLayer.js";
-import type TileLayer from "@arcgis/core/layers/TileLayer.js";
 import type Item from "@arcgis/core/layers/list/Item.js";
-import type TableItem from "@arcgis/core/layers/list/TableItem.js";
-import type { UIPosition } from "@arcgis/core/views/ui/types.js";
 import type { BasemapItemCollectionEvents } from "@arcgis/core/layers/list/BasemapItemCollection.js";
 import type { PublicLitElement as LitElement } from "@arcgis/lumina";
 import type { VisibilityAppearance } from "../../utils/action-utils.js";
 import type { CanSortFunction, TableSupportedLayers } from "../../utils/layer-list-utils.js";
-import type { ArcgisCatalogLayerListNext, CatalogLayerListOptions } from "../arcgis-catalog-layer-list-next/customElement.js";
-import type { ArcgisTableListNext, TableListOptions } from "../arcgis-table-list-next/customElement.js";
+import type { ArcgisCatalogLayerListNext } from "../arcgis-catalog-layer-list-next/customElement.js";
+import type { ArcgisTableListNext } from "../arcgis-table-list-next/customElement.js";
 import type { ArcgisReferenceElement, HeadingLevel, IconName } from "../types.js";
+import type { CatalogLayerListParams, FilterPredicate, FlowLayer, TableListParams } from "./types.js";
 import type { T9nMeta } from "@arcgis/lumina/controllers";
-import type { MapViewOrSceneView } from "@arcgis/core/views/MapViewOrSceneView.js";
 import type { ItemModifier, State } from "@arcgis/core/layers/list/types.js";
 import type { List as List } from "@esri/calcite-components/components/calcite-list";
+import type { MapViewOrSceneView } from "@arcgis/core/views/MapViewOrSceneView.js";
 
 /**
- * The Basemap Layer List Next component provides a way to display a list of basemap layers and switch on/off their visibility.
- * Base layers and reference layers are divided into separate sections.
+ * > [!WARNING]
+ * > The Basemap Layer List (next) component is the successor to the Basemap Layer List component, provided to you early for testing and feedback.
+ * In version 6.0, the implementation of [arcgis-basemap-layer-list](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-basemap-layer-list/) will be updated under the hood to that of [arcgis-basemap-layer-list-next](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-basemap-layer-list-next/),
+ * and this component will be removed. There is a breaking change in the name of the events for [catalogLayerList](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-basemap-layer-list-next/#catalogLayerList) compared to the [arcgis-basemap-layer-list](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-basemap-layer-list/).
+ * To update at version 6.0, simply remove `-next` from the component name.
+ *
+ * The Basemap Layer List (next) component provides a way to display a list of [Basemap](https://developers.arcgis.com/javascript/latest/references/core/Basemap/) layers and switch on/off their visibility.
+ * [Base layers](https://developers.arcgis.com/javascript/latest/references/core/Basemap/#baseLayers) and [reference layers](https://developers.arcgis.com/javascript/latest/references/core/Basemap/#referenceLayers) are divided into separate sections.
  *
  * @since 5.2
  * @beta
@@ -35,58 +36,379 @@ export abstract class ArcgisBasemapLayerListNext extends LitElement {
    * prevent memory leaks.
    *
    * @default false
+   * @example
+   * 
+   * ```html
+   * <arcgis-basemap-layer-list-next auto-destroy-disabled></arcgis-basemap-layer-list-next>
+   * ```
+   *
+   * ```js
+   * basemapLayerListNextElement.autoDestroyDisabled = true;
+   * ```
+   * 
    */
   accessor autoDestroyDisabled: boolean;
+  /**
+   * Specifies a function to handle filtering base layer [items](https://developers.arcgis.com/javascript/latest/references/core/layers/list/Item/).
+   *
+   * @example
+   * ```js
+   * basemapLayerListElement.baseFilterPredicate = (item) => item.title.toLowerCase().includes("streets");
+   * ```
+   */
   accessor baseFilterPredicate: FilterPredicate | undefined;
-  /** @default "" */
+  /**
+   * The value of the [base layers](https://developers.arcgis.com/javascript/latest/references/core/Basemap/#baseLayers)
+   * filter input text string if [showFilter](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-basemap-layer-list-next/#showFilter) is true.
+   *
+   * @default ""
+   * @see [showFilter](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-basemap-layer-list-next/#showFilter)
+   * @example
+   * ```js
+   * reactiveUtils.watch(
+   *   () => basemapLayerListElement.baseFilterText,
+   *   (baseFilterText) => console.log(baseFilterText)
+   * );
+   * ```
+   */
   accessor baseFilterText: string;
+  /**
+   * Specifies a function that accesses each [Item](https://developers.arcgis.com/javascript/latest/references/core/layers/list/Item/) representing a base layer.
+   * Each list item's modifiable properties can be updated within. Actions can be added to list items
+   * using the [actionsSections](https://developers.arcgis.com/javascript/latest/references/core/layers/list/Item/#actionsSections)
+   * property of the Item.
+   *
+   * @example
+   * ```js
+   * basemapLayerListElement.baseItemCreatedFunction = (event) => {
+   *   const baseListItem = event.item;
+   *   if(baseListItem.title === "World Imagery_01"){
+   *     // clean up title
+   *     baseListItem.title = "World Imagery";
+   *     // open the baseList item
+   *     baseListItem.open = true;
+   *   }
+   * }
+   * ```
+   */
   accessor baseItemCreatedFunction: ItemModifier | null | undefined;
+  /**
+   * A collection of [items](https://developers.arcgis.com/javascript/latest/references/core/layers/list/Item/)
+   * representing the [base layers](https://developers.arcgis.com/javascript/latest/references/core/Basemap/#baseLayers).
+   *
+   * @example
+   * ```js
+   * basemapLayerListElement.baseItems.forEach(item =>  console.log(item.title));
+   * ```
+   */
   get baseItems(): Collection<Item>;
+  /**
+   * The current basemap's title.
+   *
+   * @example
+   * ```html
+   * <arcgis-basemap-layer-list-next basemap-title="My Basemap"></arcgis-basemap-layer-list-next>
+   * ```
+   * ```js
+   * basemapLayerListElement.basemapTitle = "My Basemap";
+   * ```
+   */
   accessor basemapTitle: string | null | undefined;
+  /**
+   * The [arcgis-catalog-layer-list-next](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-catalog-layer-list-next/) that displays a catalog layer's [dynamic group layer](https://developers.arcgis.com/javascript/latest/references/core/layers/CatalogLayer/#dynamicGroupLayer).
+   * The catalog layer list will be displayed as an expandable [Item](https://developers.arcgis.com/javascript/latest/references/core/layers/list/Item/) in the root of the layer list when a CatalogLayer is present in the map.
+   * This property is set when a catalog layer's dynamic group layer is expanded in the layer list. Otherwise, it is `null`.
+   * This property is useful for listening to the [arcgis-catalog-layer-list-next.@arcgisTriggerAction](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-catalog-layer-list-next/#event-arcgisTriggerAction) event and managing selections in catalog layers.
+   *
+   * @example
+   * ```js
+   * // Use reactiveUtils to respond to the basemapLayerListElement.catalogLayerList "arcgisTriggerAction" event
+   * const catalogLayerListActionHandle = reactiveUtils.on(
+   *   () => basemapLayerListElement.catalogLayerList,
+   *   "arcgisTriggerAction",
+   *   async (event) => {
+   *     const { action, item } = event.detail;
+   *     if (action.id === "add-layer") {
+   *       try {
+   *         const parentCatalogLayer = getCatalogLayerForLayer(item.layer);
+   *         if (!parentCatalogLayer) {
+   *           return;
+   *         }
+   *         await addLayerFromDynamicGroup(item.layer);
+   *         alert(`Added ${item.layer.title} to the map`);
+   *       } catch (error) {
+   *         console.error("Failed to add layer from dynamic group", error);
+   *         alert(`Unable to add ${item.layer.title} to the map`);
+   *       }
+   *       basemapLayerListElement?.openedLayers?.pop();
+   *     }
+   *   },
+   * );
+   * basemapLayerListHandles.push(catalogLayerListActionHandle);
+   *
+   * // Use reactiveUtils to watch for a selected item in the basemapLayerListElement.catalogLayerList
+   * const catalogSelectionWatchHandle = reactiveUtils.watch(
+   *   () =>
+   *     basemapLayerListElement.catalogLayerList?.selectedItems?.at(0)?.layer as Layer,
+   *   (layer) => {
+   *     layer && handleLayerSelection(layer);
+   *   },
+   * );
+   * basemapLayerListHandles.push(catalogSelectionWatchHandle);
+   * ```
+   * @see [arcgis-catalog-layer-list-next](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-catalog-layer-list-next/)
+   * @see [catalogOptions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-basemap-layer-list-next/#catalogOptions)
+   */
   get catalogLayerList(): ArcgisCatalogLayerListNext | undefined;
+  /**
+   * [CatalogLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/CatalogLayer/) specific properties.
+   * Catalog layers will display their [CatalogLayer#dynamicGroupLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/CatalogLayer/#dynamicGroupLayer) as an expandable [arcgis-catalog-layer-list-next](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-catalog-layer-list-next/) in the arcgis-basemap-layer-list-next component.
+   * This list item will only be displayed when catalog layers with dynamic group layers are loaded in the map.
+   * These are the properties that are used to configure the [arcgis-catalog-layer-list-next](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-catalog-layer-list-next/).
+   *
+   * @example
+   * ```js
+   * basemapLayerListElement.catalogOptions = {
+   *   listItemCreatedFunction: (event) => {
+   *     const { item } = event;
+   *     item.actionsSections = [
+   *       [
+   *         new ActionToggle({
+   *           title: "Add layer to map",
+   *           icon: "add-layer",
+   *           id: "add-layer"
+   *         });
+   *       ]
+   *     ];
+   *   },
+   *   selectionMode: "single"
+   * };
+   * ```
+   * @see [arcgis-catalog-layer-list-next](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-catalog-layer-list-next/)
+   * @see [catalogLayerList](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-basemap-layer-list-next/#catalogLayerList)
+   */
   accessor catalogOptions: CatalogLayerListParams | undefined;
-  /** @default false */
+  /**
+   * Indicates whether a component is closed. When `true`, the component will be hidden.
+   *
+   * @default false
+   * @example
+   * 
+   * ```html
+   * <arcgis-basemap-layer-list-next closed></arcgis-basemap-layer-list-next>
+   * ```
+   *
+   * ```js
+   * basemapLayerListNextElement.closed = true;
+   * ```
+   * 
+   */
   accessor closed: boolean;
-  /** @default false */
+  /**
+   * Indicates whether the component is collapsed. When collapsed, only the collapse button and heading are displayed.
+   *
+   * @default false
+   * @example
+   * 
+   * ```html
+   * <arcgis-basemap-layer-list-next collapsed></arcgis-basemap-layer-list-next>
+   * ```
+   *
+   * ```js
+   * basemapLayerListNextElement.collapsed = true;
+   * ```
+   * 
+   */
   accessor collapsed: boolean;
-  /** @default false */
+  /**
+   * Indicates whether [items](https://developers.arcgis.com/javascript/latest/references/core/layers/list/Item/) may be reordered within the list by dragging and dropping. MapImageLayer [MapImageLayer#sublayers](https://developers.arcgis.com/javascript/latest/references/core/layers/MapImageLayer/#sublayers) can be reordered only within their parent MapImageLayer and can not be dragged out as a separate layer.
+   *
+   * @default false
+   * @example
+   * 
+   * ```html
+   * <arcgis-basemap-layer-list-next drag-enabled></arcgis-basemap-layer-list-next>
+   * ```
+   *
+   * ```js
+   * basemapLayerListNextElement.dragEnabled = true;
+   * ```
+   * 
+   */
   accessor dragEnabled: boolean;
-  /** @default false */
+  /**
+   * Indicates whether the form to edit the basemap's title is currently visible.
+   * Any edits made will only be shown locally and will not be saved.
+   *
+   * @default false
+   * @see [showEditTitleButton](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-basemap-layer-list-next/#showEditTitleButton)
+   * @example
+   * ```html
+   * <arcgis-basemap-layer-list-next editing-title></arcgis-basemap-layer-list-next>
+   * ```
+   * ```js
+   * basemapLayerListElement.editingTitle = true;
+   * ```
+   */
   accessor editingTitle: boolean;
-  /** @default "" */
+  /**
+   * Placeholder text used in the filter input when filtering is enabled.
+   *
+   * @default ""
+   * @example
+   * 
+   * ```html
+   * <arcgis-basemap-layer-list-next filter-placeholder="Search..."></arcgis-basemap-layer-list-next>
+   * ```
+   *
+   * ```js
+   * basemapLayerListNextElement.filterPlaceholder = "Search...";
+   * ```
+   * 
+   */
   accessor filterPlaceholder: string;
-  /** @default 2 */
+  /**
+   * Indicates the heading level to use for the heading of the component. By default, the heading is rendered as a `<h2>`. Depending on the component's placement in your app, you may need to adjust this heading for proper semantics. This is important for meeting accessibility standards.
+   *
+   * @default 2
+   * @see [HTML heading elements](https://developer.mozilla.org/docs/Web/HTML/Element/Heading_Elements)
+   * @example
+   * 
+   * ```html
+   * <arcgis-basemap-layer-list-next heading-level="2"></arcgis-basemap-layer-list-next>
+   * ```
+   *
+   * ```js
+   * basemapLayerListNextElement.headingLevel = 2;
+   * ```
+   * 
+   */
   accessor headingLevel: HeadingLevel;
-  /** @default false */
+  /**
+   * This property provides the ability to show or hide the
+   * [base layers](https://developers.arcgis.com/javascript/latest/references/core/Basemap/#baseLayers).
+   *
+   * @default false
+   * @example
+   * ```html
+   * <arcgis-basemap-layer-list-next hide-base-layers></arcgis-basemap-layer-list-next>
+   * ```
+   * ```js
+   * basemapLayerListElement.hideBaseLayers = true;
+   * ```
+   */
   accessor hideBaseLayers: boolean;
-  /** @default false */
+  /**
+   * Indicates whether to hide the catalog layer list in the component.
+   *
+   * @default false
+   * @example
+   * 
+   * ```html
+   * <arcgis-basemap-layer-list-next hide-catalog-layer-list></arcgis-basemap-layer-list-next>
+   * ```
+   *
+   * ```js
+   * basemapLayerListNextElement.hideCatalogLayerList = true;
+   * ```
+   * 
+   */
   accessor hideCatalogLayerList: boolean;
-  /** @default false */
+  /**
+   * Indicates whether to hide the component's heading.
+   *
+   * @default false
+   * @example
+   * 
+   * ```html
+   * <arcgis-basemap-layer-list-next hide-heading></arcgis-basemap-layer-list-next>
+   * ```
+   *
+   * ```js
+   * basemapLayerListNextElement.hideHeading = true;
+   * ```
+   * 
+   */
   accessor hideHeading: boolean;
   /**
-   * This property provides the ability to show or hide the no items to display notice when there are no filter results.
+   * Indicates whether to hide the notice that appears when no results are found after filtering.
    *
    * @default false
-   * @since 5.2
+   * @example
+   * 
+   * ```html
+   * <arcgis-basemap-layer-list-next hide-no-filter-results-notice></arcgis-basemap-layer-list-next>
+   * ```
+   *
+   * ```js
+   * basemapLayerListNextElement.hideNoFilterResultsNotice = true;
+   * ```
+   * 
    */
   accessor hideNoFilterResultsNotice: boolean;
   /**
-   * This property provides the ability to show or hide the no items to display notice.
+   * Indicates whether to hide the notice that appears when there are no items to display.
    *
    * @default false
-   * @since 5.2
+   * @example
+   * 
+   * ```html
+   * <arcgis-basemap-layer-list-next hide-no-items-notice></arcgis-basemap-layer-list-next>
+   * ```
+   *
+   * ```js
+   * basemapLayerListNextElement.hideNoItemsNotice = true;
+   * ```
+   * 
    */
   accessor hideNoItemsNotice: boolean;
-  /** @default false */
+  /**
+   * This property provides the ability to show or hide the
+   * [reference layers](https://developers.arcgis.com/javascript/latest/references/core/Basemap/#referenceLayers).
+   *
+   * @default false
+   * @example
+   * ```html
+   * <arcgis-basemap-layer-list-next hide-reference-layers></arcgis-basemap-layer-list-next>
+   * ```
+   * ```js
+   * basemapLayerListElement.hideReferenceLayers = true;
+   * ```
+   */
   accessor hideReferenceLayers: boolean;
-  /** @default false */
+  /**
+   * Indicates whether to hide status indicators in the component.
+   *
+   * @default false
+   * @example
+   * 
+   * ```html
+   * <arcgis-basemap-layer-list-next hide-status-indicators></arcgis-basemap-layer-list-next>
+   * ```
+   *
+   * ```js
+   * basemapLayerListNextElement.hideStatusIndicators = true;
+   * ```
+   * 
+   */
   accessor hideStatusIndicators: boolean;
-  /** @default "layers" */
+  /**
+   * Icon which represents the component.
+   * Typically used when the component is controlled by another component (e.g. by the Expand component).
+   *
+   * @default "layers"
+   * @see [Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)
+   */
   accessor icon: IconName;
+  /** @internal */
   accessor knowledgeGraphOptions: TableListParams | undefined;
+  /** The component's default label. */
   accessor label: string | undefined;
+  /** @internal */
   accessor layerTablesEnabled: Collection<TableSupportedLayers>;
+  /** @internal */
   accessor listItemCanGiveFunction: CanSortFunction | undefined;
+  /** @internal */
   accessor listItemCanReceiveFunction: CanSortFunction | undefined;
   /**
    * Specifies whether to ignore the [listMode](https://developers.arcgis.com/javascript/latest/references/core/layers/Layer/#listMode) property to display all layers. A common use case for `listModeDisabled` is when you want to use the component to manage and configure a layer's `listMode` value.
@@ -94,9 +416,25 @@ export abstract class ArcgisBasemapLayerListNext extends LitElement {
    * @default false
    * @see [listMode](https://developers.arcgis.com/javascript/latest/references/core/layers/Layer/#listMode)
    * @since 5.2
+   * @example
+   * 
+   * ```html
+   * <arcgis-basemap-layer-list-next list-mode-disabled></arcgis-basemap-layer-list-next>
+   * ```
+   *
+   * ```js
+   * basemapLayerListNextElement.listModeDisabled = true;
+   * ```
+   * 
    */
   accessor listModeDisabled: boolean;
+  /** @internal */
   accessor mapImageOptions: TableListParams | undefined;
+  /**
+   * Replace localized message strings with your own strings.
+   *
+   * _**Note**: Individual message keys may change between releases._
+   */
   accessor messageOverrides: {
       componentLabel?: string | undefined;
       baseHeading?: string | undefined;
@@ -199,49 +537,275 @@ export abstract class ArcgisBasemapLayerListNext extends LitElement {
       ok: string;
       submit: string;
   }>;
-  /** @default 10 */
+  /**
+   * The minimum number of list items required to display the filter input box.
+   *
+   * @default 10
+   * @example
+   * 
+   * ```html
+   * <arcgis-basemap-layer-list-next min-filter-items="3"></arcgis-basemap-layer-list-next>
+   * ```
+   *
+   * ```js
+   * basemapLayerListNextElement.minFilterItems = 3;
+   * ```
+   * 
+   */
   accessor minFilterItems: number;
+  /**
+   * A collection of [layers](https://developers.arcgis.com/javascript/latest/references/core/layers/Layer/) that are opened
+   * in a [catalogLayerList](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-basemap-layer-list-next/#catalogLayerList) or [arcgis-layer-list-next.tableList](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-layer-list-next/#tableList) flow item.
+   * This property is useful for backing out of the catalog layer list or table list programmatically to the parent layer list.
+   *
+   * @see [catalogLayerList](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-basemap-layer-list-next/#catalogLayerList)
+   * @see [tableList](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-basemap-layer-list-next/#tableList)
+   * @example
+   * ```js
+   * // back out of the catalog layer list to the basemap layer list
+   * basemapLayerListElement.openedLayers.pop();
+   * ```
+   */
   get openedLayers(): Collection<FlowLayer>;
-  accessor position: UIPosition | undefined;
+  /**
+   * 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;
+  /**
+   * Specifies a function to handle filtering reference layer [items](https://developers.arcgis.com/javascript/latest/references/core/layers/list/Item/).
+   *
+   * @example
+   * ```js
+   * basemapLayerListElement.referenceFilterPredicate = (item) => item.title.toLowerCase().includes("streets");
+   * ```
+   */
   accessor referenceFilterPredicate: FilterPredicate | undefined;
-  /** @default "" */
+  /**
+   * The value of the [reference layers](https://developers.arcgis.com/javascript/latest/references/core/Basemap/#referenceLayers)
+   * filter input text string if [showFilter](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-basemap-layer-list-next/#showFilter) is true.
+   *
+   * @default ""
+   * @see [showFilter](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-basemap-layer-list-next/#showFilter)
+   * @example
+   * ```js
+   * reactiveUtils.watch(
+   *   () => basemapLayerListElement.referenceFilterText,
+   *   (referenceFilterText) => console.log(referenceFilterText)
+   * );
+   * ```
+   */
   accessor referenceFilterText: string;
+  /**
+   * Specifies a function that accesses each [Item](https://developers.arcgis.com/javascript/latest/references/core/layers/list/Item/) representing a reference layer.
+   * Each list item's modifiable properties can be updated within. Actions can be added to list items
+   * using the [actionsSections](https://developers.arcgis.com/javascript/latest/references/core/layers/list/Item/#actionsSections) property.
+   *
+   * @example
+   * ```js
+   * basemapLayerListElement.referenceItemCreatedFunction = (event) => {
+   *   referenceListItem = event.item;
+   *   if(referenceListItem.title === "World Imagery_01_reference_layer"){
+   *     // clean up title
+   *     referenceListItem.title = "Reference layer";
+   *     // open the baseList item
+   *     referenceListItem.open = true;
+   *   }
+   * }
+   * ```
+   */
   accessor referenceItemCreatedFunction: ItemModifier | null | undefined;
+  /**
+   * A collection of [items](https://developers.arcgis.com/javascript/latest/references/core/layers/list/Item/)
+   * representing the [reference layers](https://developers.arcgis.com/javascript/latest/references/core/Basemap/#referenceLayers).
+   *
+   * @example
+   * ```js
+   * basemapLayerListElement.referenceItems.forEach(item => console.log(item.title));
+   * ```
+   */
   get referenceItems(): Collection<Item>;
+  /**
+   * A collection of selected [items](https://developers.arcgis.com/javascript/latest/references/core/layers/list/Item/) in the list. This collection is updated when the user changes selection and is only populated when [selectionMode](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-basemap-layer-list-next/#selectionMode) is not set to `"none"`.
+   *
+   * @see [selectionMode](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-basemap-layer-list-next/#selectionMode)
+   * @example
+   * ```js
+   * reactiveUtils.watch(
+   *   () => basemapLayerListNext.selectedItems?.at(0)?.layer,
+   *   (layer) => {
+   *     layer && handleLayerSelection(layer);
+   *   },
+   * );
+   * ```
+   */
   accessor selectedItems: Collection<Item>;
-  /** @default "none" */
+  /**
+   * Specifies the selection mode. Selected items are available in the [selectedItems](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-basemap-layer-list-next/#selectedItems) property.
+   *
+   * | Value | Description |
+   * | ----- | ----------- |
+   * | multiple | Allows any number of items to be selected at once. This is useful when you want to apply an operation to multiple items at the same time. |
+   * | none | Disables selection. Use this when you want to prevent selecting items. |
+   * | single | Allows only one item to be selected at a time. If another item is selected, the previous selection is cleared. This is useful when you want to ensure that a maximum of one item is selected at a time. |
+   * | single-persist | Allows only one item to be selected at a time and prevents de-selection. Once an item is selected, it remains selected until another item is selected. This is useful when you want to ensure that there is always exactly one selected item. |
+   *
+   * @default "none"
+   * @see [selectedItems](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-basemap-layer-list-next/#selectedItems)
+   * @example
+   * 
+   * ```html
+   * <arcgis-basemap-layer-list-next selection-mode="multiple"></arcgis-basemap-layer-list-next>
+   * ```
+   *
+   * ```js
+   * basemapLayerListNextElement.selectionMode = "multiple";
+   * ```
+   * 
+   */
   accessor selectionMode: List["selectionMode"];
-  /** @default false */
+  /**
+   * This property provides the ability to show or hide the close button.
+   *
+   * @default false
+   * @example
+   * 
+   * ```html
+   * <arcgis-basemap-layer-list-next show-close-button></arcgis-basemap-layer-list-next>
+   * ```
+   *
+   * ```js
+   * basemapLayerListNextElement.showCloseButton = true;
+   * ```
+   * 
+   */
   accessor showCloseButton: boolean;
-  /** @default false */
+  /**
+   * This property provides the ability to show or hide the collapse button.
+   *
+   * @default false
+   * @example
+   * 
+   * ```html
+   * <arcgis-basemap-layer-list-next show-collapse-button></arcgis-basemap-layer-list-next>
+   * ```
+   *
+   * ```js
+   * basemapLayerListNextElement.showCollapseButton = true;
+   * ```
+   * 
+   */
   accessor showCollapseButton: boolean;
-  /** @default false */
+  /**
+   * This property provides the ability to show or hide the edit title button in the header.
+   *
+   * @default false
+   * @see [editingTitle](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-basemap-layer-list-next/#editingTitle)
+   * @example
+   * ```html
+   * <arcgis-basemap-layer-list-next show-edit-title-button></arcgis-basemap-layer-list-next>
+   * ```
+   * ```js
+   * basemapLayerListElement.showEditTitleButton = true;
+   * ```
+   */
   accessor showEditTitleButton: boolean;
-  /** @default false */
+  /**
+   * This property provides the ability to show or hide layer error indicators.
+   *
+   * @default false
+   * @example
+   * 
+   * ```html
+   * <arcgis-basemap-layer-list-next show-errors></arcgis-basemap-layer-list-next>
+   * ```
+   *
+   * ```js
+   * basemapLayerListNextElement.showErrors = true;
+   * ```
+   * 
+   */
   accessor showErrors: boolean;
-  /** @default false */
+  /**
+   * This property provides the ability to show or hide the filter input box when then number of list items is equal to or greater than the value set in [minFilterItems](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-basemap-layer-list-next/#minFilterItems), allowing users to filter layers by their title.
+   *
+   * @default false
+   * @example
+   * 
+   * ```html
+   * <arcgis-basemap-layer-list-next show-filter></arcgis-basemap-layer-list-next>
+   * ```
+   *
+   * ```js
+   * basemapLayerListNextElement.showFilter = true;
+   * ```
+   * 
+   */
   accessor showFilter: boolean;
-  /** @default false */
+  /**
+   * This property provides the ability to show or hide the temporary layer indicators for layers with [Layer#persistenceEnabled](https://developers.arcgis.com/javascript/latest/references/core/layers/Layer/#persistenceEnabled) set to `false`. A [temporary icon](https://developers.arcgis.com/calcite-design-system/icons/?icon=temporary&library=Calcite%20UI&query=temporary) will be displayed on the near side of the layer title.
+   *
+   * @default false
+   * @example
+   * 
+   * ```html
+   * <arcgis-basemap-layer-list-next show-temporary-layer-indicators></arcgis-basemap-layer-list-next>
+   * ```
+   *
+   * ```js
+   * basemapLayerListNextElement.showTemporaryLayerIndicators = true;
+   * ```
+   * 
+   */
   accessor showTemporaryLayerIndicators: boolean;
+  /** The current state of the component. */
   get state(): State;
+  /** @internal */
   get tableList(): ArcgisTableListNext | undefined;
+  /** @internal */
   accessor tileOptions: TableListParams | undefined;
   /**
    * 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-basemap-layer-list-next component will be associated with a map or scene component rather than using the `view` property.
    */
   accessor view: MapViewOrSceneView | null | undefined;
-  /** @default "default" */
+  /**
+   * Determines the icons used to indicate visibility.
+   * | Value | Description | Example |
+   * | ----- | ----------- | ------- |
+   * | default | Displays view icons on the far side. Icons are hidden except on hover or if they have keyboard focus. See [view-visible](https://developers.arcgis.com/calcite-design-system/icons/?icon=view-visible&library=Calcite%20UI&query=view) and [view-hide](https://developers.arcgis.com/calcite-design-system/icons/?icon=view-hide&library=Calcite%20UI&query=view) calcite icons. | ![visibilityAppearance-default](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/basemap-layer-list/visibilityAppearance-default.avif) |
+   * | checkbox | Displays checkbox icons on the near side. See [check-square-f](https://developers.arcgis.com/calcite-design-system/icons/?icon=check-square-f&library=Calcite%20UI&query=check) and [square](https://developers.arcgis.com/calcite-design-system/icons/?icon=square&library=Calcite%20UI&query=square) calcite icons. | ![visibilityAppearance-checkbox](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/basemap-layer-list/visibilityAppearance-checkbox.avif) |
+   * 
+   *
+   * @default "default"
+   * @example
+   * 
+   * ```html
+   * <arcgis-basemap-layer-list-next visibility-appearance="checkbox"></arcgis-basemap-layer-list-next>
+   * ```
+   *
+   * ```js
+   * basemapLayerListNextElement.visibilityAppearance = "checkbox";
+   * ```
+   * 
+   */
   accessor visibilityAppearance: VisibilityAppearance;
+  /** Permanently destroy the component. */
   destroy(): Promise<void>;
+  /** Emitted when the value of the [baseFilterText](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-basemap-layer-list-next/#baseFilterText) changes. */
   readonly arcgisBaseFilterChange: import("@arcgis/lumina").TargetedEvent<this, void>;
   /** Emitted when the component's close button is clicked. */
   readonly arcgisClose: import("@arcgis/lumina").TargetedEvent<this, void>;
+  /** Emitted when the collection of [openedLayers](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-basemap-layer-list-next/#openedLayers) changes. */
   readonly arcgisOpenedLayersChange: import("@arcgis/lumina").TargetedEvent<this, 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>;
+  /** Emitted when the value of the [referenceFilterText](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-basemap-layer-list-next/#referenceFilterText) changes. */
   readonly arcgisReferenceFilterChange: import("@arcgis/lumina").TargetedEvent<this, void>;
+  /** Emitted when an action is triggered on the component. */
   readonly arcgisTriggerAction: import("@arcgis/lumina").TargetedEvent<this, BasemapItemCollectionEvents["trigger-action"]>;
   readonly "@eventTypes": {
     arcgisBaseFilterChange: ArcgisBasemapLayerListNext["arcgisBaseFilterChange"]["detail"];
@@ -252,15 +816,4 @@ export abstract class ArcgisBasemapLayerListNext extends LitElement {
     arcgisReferenceFilterChange: ArcgisBasemapLayerListNext["arcgisReferenceFilterChange"]["detail"];
     arcgisTriggerAction: ArcgisBasemapLayerListNext["arcgisTriggerAction"]["detail"];
   };
-}
-
-export type CatalogLayerListParams = CatalogLayerListOptions;
-
-export type TableListParams = TableListOptions;
-
-export type FlowLayer = CatalogLayer | SubtablesLayer;
-
-/** @param item */
-export type FilterPredicate = (item: Item | TableItem) => boolean;
-
-export type SubtablesLayer = KnowledgeGraphLayer | MapImageLayer | TileLayer;
+}