@arcgis/map-components 5.0.0-next.135 → 5.0.0-next.137

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

@@ -1,414 +1,394 @@
-/// <reference types="@arcgis/core/interfaces.d.ts" />
 /// <reference path="../../index.d.ts" />
-import { Use } from '@arcgis/lumina/controllers';
-import { default as BasemapLayerList } from '@arcgis/core/widgets/BasemapLayerList.js';
-import { PublicLitElement as LitElement, TargetedEvent } from '@arcgis/lumina';
-import { ArcgisReferenceElement } from '../../utils/component-utils';
-import { IconName } from '../../utils/action-utils';
+/// <reference types="@arcgis/core/interfaces.d.ts" />
+import type Collection from "@arcgis/core/core/Collection.js";
+import type ListItem from "@arcgis/core/widgets/LayerList/ListItem.js";
+import type { PublicLitElement as LitElement } from "@arcgis/lumina/PublicLitElement";
+import type { ArcgisReferenceElement } from "../../utils/component-utils.js";
+import type { IconName } from "../../utils/action-utils.js";
+import type { MapViewOrSceneView } from "@arcgis/core/views/MapViewOrSceneView.js";
+import type { FilterPredicate, ListItemModifier, VisibilityAppearance } from "@arcgis/core/widgets/LayerList/types.js";
+import type { CatalogLayerListProperties } from "@arcgis/core/widgets/CatalogLayerList.js";
+import type { HeadingLevel } from "@arcgis/core/widgets/support/types.js";
+import type { Icon } from "@esri/calcite-components/components/calcite-icon";
+import type { BasemapLayerListState } from "@arcgis/core/widgets/BasemapLayerList/types.js";
 
-declare const useBasemapLayerListWidget: (component: LitElement & Pick<BasemapLayerList, "label" | "headingLevel" | "viewModel" | "icon" | "collapsed" | "baseFilterPredicate" | "baseFilterText" | "baseListItemCreatedFunction" | "basemapTitle" | "catalogOptions" | "dragEnabled" | "editingTitle" | "filterPlaceholder" | "minFilterItems" | "referenceFilterPredicate" | "referenceFilterText" | "referenceListItemCreatedFunction" | "selectedItems" | "selectionMode" | "visibilityAppearance"> & {
-    state?: unknown;
-    viewModel?: import('@arcgis/core/widgets/BasemapLayerList/BasemapLayerListViewModel').default | undefined;
-    closed?: boolean;
-    icon: import('@arcgis/toolkit/type').nil | string;
-    label: import('@arcgis/toolkit/type').nil | string;
-    referenceElement?: ArcgisReferenceElement | string;
-    arcgisReady: import('@arcgis/lumina').EventEmitter;
-    arcgisPropertyChange: import('@arcgis/lumina').EventEmitter<{
-        name: string;
-    }> | undefined;
-    el: HTMLElement & {
-        childElem?: HTMLElement & {
-            ownedBy?: HTMLElement;
-        };
-        view?: __esri.LinkChartView | __esri.MapView | __esri.SceneView | nullish;
-    };
-    autoDestroyDisabled: boolean;
-    destroy: () => Promise<void>;
-}) => BasemapLayerList;
 /**
  * The Basemap Layer List component provides a way to display a list of [Basemap](https://developers.arcgis.com/javascript/latest/api-reference/esri-Basemap.html) layers and switch on/off their visibility. [Base layers](https://developers.arcgis.com/javascript/latest/api-reference/esri-Basemap.html#baseLayers) and [reference layers](https://developers.arcgis.com/javascript/latest/api-reference/esri-Basemap.html#referenceLayers) are divided into separate sections. When editing is enabled, layers can be reordered by dragging and dropping between the lists and the title can be edited.
  *
- * [Read more...](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-basemap-layer-list/)
- *
  * @since 4.28
  */
-export declare class ArcgisBasemapLayerList extends LitElement {
-    /**
-     * Emitted when the component's close button is clicked.
-     *
-     * @since 4.33
-     */
-    readonly arcgisClose: TargetedEvent<this>;
-    /**
-     * 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 Basemap Layer List component will be associated with a map or scene component rather than using the `view` property.
-     */
-    view?: import('@arcgis/core/views/MapViewOrSceneView').MapViewOrSceneView | null | undefined;
-    /**
-     * If true, the component will not be destroyed automatically when it is
-     * disconnected from the document. This is useful when you want to move the
-     * component to a different place on the page, or temporarily hide it. If this
-     * is set, make sure to call the [destroy](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-basemap-layer-list/#destroy) method when you are done to
-     * prevent memory leaks.
-     *
-     * @default false
-     */
-    autoDestroyDisabled: boolean;
-    /**
-     * Specifies a function to handle filtering base layer [list items](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItem.html).
-     *
-     * @since 4.32
-     * @example layerList.baseFilterPredicate = (item) => item.title.toLowerCase().includes("streets");
-     */
-    baseFilterPredicate: import('@arcgis/core/widgets/LayerList/types').FilterPredicate | null | undefined;
-    /**
-     * The value of the filter input text string if [visibleElements.filter](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList.html#visibleElements) is true.
-     *
-     * @default ""
-     * @since 4.29
-     * @see [showFilter](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-basemap-layer-list/#showFilter)
-     * @example
-     * reactiveUtils.watch(
-     *   () => basemapLayerList.baseFilterText,
-     *   (baseFilterText) => console.log(baseFilterText)
-     * );
-     */
-    baseFilterText: string;
-    /** A collection of ListItems representing the baseLayers. */
-    get baseItems(): __esri.Collection<__esri.ListItem>;
-    /**
-     * Specifies a function that accesses each [ListItem](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItem.html) representing a base layer.
-     * Each list item's modifiable properties can be updated within. Actions can be added to list items
-     * using the [ListItem#actionsSections](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItem.html#actionsSections)
-     * property of the ListItem.
-     *
-     * @example
-     * const bmLayerList = new BasemapLayerList({
-     *   view: view,
-     *   baseListItemCreatedFunction: (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;
-     *     }
-     *   }
-     * })
-     */
-    baseListItemCreatedFunction: import('@arcgis/core/widgets/LayerList/types').ListItemModifier | null | undefined;
-    /** The current basemap's title. */
-    basemapTitle: string | null | undefined;
-    /** 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.
-     * Catalog layers will display their [dynamicGroupLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CatalogLayer.html#dynamicGroupLayer) as an expandable [catalogLayerList](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList.html#catalogLayerList) in the BasemapLayerList widget.
-     * 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 [catalogLayerList](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList.html#catalogLayerList).
-     *
-     * @since 4.30
-     * @see [catalogLayerList](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList.html#catalogLayerList)
-     * @example
-     * const basemapLayerList = new BasemapLayerList({
-     *   catalogOptions: {
-     *     listItemCreatedFunction: (event) => {
-     *       const { item } = event;
-     *       item.actionsSections = [
-     *         [
-     *           {
-     *             title: "Add layer to map",
-     *             icon: "add-layer",
-     *             id: "add-layer"
-     *           }
-     *         ]
-     *       ];
-     *     },
-     *     selectionMode: "single",
-     *     visibleElements: {
-     *       filter: true
-     *       temporaryLayerIndicators: true
-     *     }
-     *   },
-     *   view,
-     * });
-     */
-    catalogOptions: import('@arcgis/core/widgets/CatalogLayerList').CatalogLayerListProperties | null | undefined;
-    /**
-     * Indicates whether a component is closed. When `true`, the component will be hidden.
-     *
-     * @default false
-     * @since 4.33
-     */
-    closed: boolean;
-    /**
-     * Indicates whether the component is collapsed.
-     * When collapsed, only the collapse button and heading are displayed.
-     *
-     * @default false
-     * @since 4.29
-     * @see [showCollapseButton](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-basemap-layer-list/#showCollapseButton)
-     * @example basemapLayerList.collapsed = true;
-     */
-    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.
-     * MapImageLayer [sublayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MapImageLayer.html#sublayers) can be reordered only within their parent MapImageLayer and can not be dragged out as a separate layer.
-     *
-     * @default false
-     * @since 4.29
-     * @example basemapLayerList.dragEnabled = true;
-     */
-    dragEnabled: boolean;
-    /**
-     * 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
-     * @since 4.29
-     * @see [showEditTitleButton](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-basemap-layer-list/#showEditTitleButton)
-     * @example basemapLayerList.editingTitle = true;
-     */
-    editingTitle: boolean;
-    /**
-     * Placeholder text used in the filter input if [visibleElements.filter](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList.html#visibleElements) is true.
-     *
-     * @default ""
-     * @since 4.29
-     * @see [showFilter](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-basemap-layer-list/#showFilter)
-     * @example basemapLayerList.filterPlaceholder = "Filter layers";
-     */
-    filterPlaceholder: string;
-    /**
-     * Indicates the heading level to use for the widget title (i.e. "Navigation").
-     * By default, the basemap's title is rendered
-     * as a level 2 heading (e.g. `<h2>Navigation</h2>`). Depending on the widget's placement
-     * in your app, you may need to adjust this heading for proper semantics. This is
-     * important for meeting accessibility standards.
-     *
-     * @default 2
-     * @since 4.20
-     * @see [Heading Elements](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/Heading_Elements)
-     * @example
-     * // the component title will render as an <h3>
-     * basemapLayerList.headingLevel = 3;
-     */
-    headingLevel: import('@arcgis/core/widgets/support/types').HeadingLevel;
-    /**
-     * Indicates whether the base layers will be displayed.
-     *
-     * @default false
-     * @since 5.0
-     */
-    hideBaseLayers: boolean;
-    /**
-     * Determines whether the basemap layer list should be shown within its built-in [flow component](https://developers.arcgis.com/calcite-design-system/components/flow/) or if the flow component should be excluded. The basemap layer list will be displayed within its original flow component if set to `true`. The flow component will be omitted from the basemap layer list if set to `false`. To place the basemap layer list into an existing Calcite flow component, set this property to `false`.
-     *
-     * @default false
-     * @since 5.0
-     */
-    hideFlow: boolean;
-    /**
-     * Indicates whether the basemap layer list displays a heading. The heading text is the title of the basemap. The heading level can be set with the [BasemapLayerList#headingLevel](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList.html#headingLevel).
-     *
-     * @default false
-     * @since 5.0
-     */
-    hideHeading: boolean;
-    /**
-     * Indicates whether to the reference layers will be displayed.
-     *
-     * @default false
-     * @since 5.0
-     */
-    hideReferenceLayers: boolean;
-    /**
-     * Indicates whether the status indicators will be displayed.
-     *
-     * @default false
-     * @since 5.0
-     */
-    hideStatusIndicators: boolean;
-    /**
-     * Icon which represents the widget. It is typically used when the widget is controlled by another
-     * one (e.g. in the Expand widget).
-     *
-     * @default "layers"
-     * @since 4.27
-     * @see [Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)
-     */
-    get icon(): typeof this.widget.icon;
-    set icon(value: IconName);
-    /**
-     * The widget's default label.
-     *
-     * @since 4.11
-     */
-    label: string;
-    /**
-     * The minimum number of list items required to display the [visibleElements.filter](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList-BasemapLayerListVisibleElements.html) input box.
-     *
-     * @default 10
-     * @since 4.29
-     * @see [showFilter](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-basemap-layer-list/#showFilter)
-     * @example
-     * basemapLayerList.showFilter = true;
-     * basemapLayerList.minFilterItems = 5;
-     */
-    minFilterItems: number;
-    /**
-     * By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.
-     *
-     * @see [Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)
-     */
-    referenceElement?: ArcgisReferenceElement | string;
-    /**
-     * Specifies a function to handle filtering reference layer [list items](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItem.html).
-     *
-     * @since 4.32
-     * @example layerList.referenceFilterPredicate = (item) => item.title.toLowerCase().includes("streets");
-     */
-    referenceFilterPredicate: import('@arcgis/core/widgets/LayerList/types').FilterPredicate | null | undefined;
-    /**
-     * The value of the filter input text string if [visibleElements.filter](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList.html#visibleElements) is true.
-     *
-     * @default ""
-     * @since 4.29
-     * @see [showFilter](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-basemap-layer-list/#showFilter)
-     * @example
-     * reactiveUtils.watch(
-     *   () => basemapLayerList.referenceFilterText,
-     *   (referenceFilterText) => console.log(referenceFilterText)
-     * );
-     */
-    referenceFilterText: string;
-    /** A collection of ListItems representing the referenceLayers. */
-    get referenceItems(): __esri.Collection<__esri.ListItem>;
-    /**
-     * Specifies a function that accesses each [ListItem](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItem.html) representing a reference layer.
-     * Each list item's modifiable properties can be updated within. Actions can be added to list items
-     * using the [ListItem#actionsSections](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItem.html#actionsSections).
-     *
-     * @example
-     * let bmLayerList = new BasemapLayerList({
-     *   view: view,
-     *   referenceListItemCreatedFunction: (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;
-     *     }
-     *   }
-     * })
-     */
-    referenceListItemCreatedFunction: import('@arcgis/core/widgets/LayerList/types').ListItemModifier | null | undefined;
-    /**
-     * A collection of selected [ListItem](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItem.html)s representing basemap layers
-     * selected by the user.
-     *
-     * @see [selectionMode](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList.html#selectionMode)
-     */
-    selectedItems: import('@arcgis/core/core/Collection').default<import('@arcgis/core/widgets/LayerList/ListItem').default>;
-    /**
-     * Specifies the selection mode.
-     * Selected items are available in the [selectedItems](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList.html#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"
-     * @since 4.29
-     * @see [selectedItems](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList.html#selectedItems)
-     * @example basemapLayerList.selectionMode = "multiple";
-     */
-    selectionMode: "none" | "multiple" | "single" | "single-persist";
-    /**
-     * Indicates whether to display a close button in the header.
-     *
-     * @default false
-     * @since 5.0
-     */
-    showCloseButton: boolean;
-    /**
-     * Indicates whether to display a collapse button in the header.
-     *
-     * @default false
-     * @since 5.0
-     */
-    showCollapseButton: boolean;
-    /**
-     * Indicates whether to display a button in the header to edit the basemap title.
-     *
-     * @default false
-     * @since 5.0
-     */
-    showEditTitleButton: boolean;
-    /**
-     * Indicates whether to display layers with load errors.
-     *
-     * @default false
-     * @since 5.0
-     */
-    showErrors: boolean;
-    /**
-     * Indicates whether to display a filter input box when then number of list items is equal to or greater than the value set in [BasemapLayerList#minFilterItems](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList.html#minFilterItems), allowing users to filter layers by their title.
-     *
-     * @default false
-     * @since 5.0
-     */
-    showFilter: boolean;
-    /**
-     * Indicates whether temporary layer indicators will be displayed for layers with [Layer#persistenceEnabled](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html#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
-     * @since 5.0
-     */
-    showTemporaryLayerIndicators: boolean;
-    /**
-     * The current state of the component.
-     *
-     * @default "disabled"
-     */
-    readonly state: import('@arcgis/core/widgets/BasemapLayerList/types').BasemapLayerListState;
-    /**
-     * 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/img/apiref/widgets/basemap-layer-list/visibilityAppearance-default.png) |
-     * | 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/img/apiref/widgets/basemap-layer-list/visibilityAppearance-checkbox.png) |
-     *
-     * @default "default"
-     * @since 4.29
-     * @example basemapLayerList.visibilityAppearance = "checkbox";
-     */
-    visibilityAppearance: import('@arcgis/core/widgets/LayerList/types').VisibilityAppearance;
-    /** Permanently destroy the component. */
-    destroy(): Promise<void>;
-    /** Emitted when the value of a property is changed. Use this to listen to changes to properties. */
-    readonly arcgisPropertyChange: TargetedEvent<this, {
-        name: "state";
-    }>;
-    /** Emitted when the component associated with a map or scene view is ready to be interacted with. */
-    readonly arcgisReady: TargetedEvent<this, void>;
-    /** Emitted when an action is triggered on the component. */
-    readonly arcgisTriggerAction: TargetedEvent<this, import('@arcgis/core/widgets/LayerList/LayerListViewModel').LayerListViewModelTriggerActionEvent>;
-    private widget: BasemapLayerList;
-    readonly _setterTypes: {
-        icon?: IconName;
-    };
-    "@eventTypes": {
-        "arcgisClose": ArcgisBasemapLayerList["arcgisClose"]["detail"];
-        "arcgisPropertyChange": ArcgisBasemapLayerList["arcgisPropertyChange"]["detail"];
-        "arcgisReady": ArcgisBasemapLayerList["arcgisReady"]["detail"];
-        "arcgisTriggerAction": ArcgisBasemapLayerList["arcgisTriggerAction"]["detail"];
-    };
-}
-export {};
+export abstract class ArcgisBasemapLayerList extends LitElement {
+  /**
+   * If true, the component will not be destroyed automatically when it is
+   * disconnected from the document. This is useful when you want to move the
+   * component to a different place on the page, or temporarily hide it. If this
+   * is set, make sure to call the [destroy()](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-basemap-layer-list/#destroy) method when you are done to
+   * prevent memory leaks.
+   *
+   * @default false
+   */
+  accessor autoDestroyDisabled: boolean;
+  /**
+   * Specifies a function to handle filtering base layer [list items](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItem.html).
+   *
+   * @since 4.32
+   * @example layerList.baseFilterPredicate = (item) => item.title.toLowerCase().includes("streets");
+   */
+  accessor baseFilterPredicate: FilterPredicate | null | undefined;
+  /**
+   * The value of the filter input text string if [visibleElements.filter](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList.html#visibleElements) is true.
+   *
+   * @default ""
+   * @since 4.29
+   * @see [showFilter](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-basemap-layer-list/#showFilter)
+   * @example
+   * reactiveUtils.watch(
+   *   () => basemapLayerList.baseFilterText,
+   *   (baseFilterText) => console.log(baseFilterText)
+   * );
+   */
+  accessor baseFilterText: string;
+  /** A collection of ListItems representing the baseLayers. */
+  get baseItems(): __esri.Collection<__esri.ListItem>;
+  /**
+   * Specifies a function that accesses each [ListItem](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItem.html) representing a base layer.
+   * Each list item's modifiable properties can be updated within. Actions can be added to list items
+   * using the [ListItem#actionsSections](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItem.html#actionsSections)
+   * property of the ListItem.
+   *
+   * @example
+   * const bmLayerList = new BasemapLayerList({
+   *   view: view,
+   *   baseListItemCreatedFunction: (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 baseListItemCreatedFunction: ListItemModifier | null | undefined;
+  /** The current basemap's title. */
+  accessor basemapTitle: string | null | undefined;
+  /** 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.
+   * Catalog layers will display their [dynamicGroupLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CatalogLayer.html#dynamicGroupLayer) as an expandable [catalogLayerList](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList.html#catalogLayerList) in the BasemapLayerList widget.
+   * 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 [catalogLayerList](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList.html#catalogLayerList).
+   *
+   * @since 4.30
+   * @see [catalogLayerList](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList.html#catalogLayerList)
+   * @example
+   * const basemapLayerList = new BasemapLayerList({
+   *   catalogOptions: {
+   *     listItemCreatedFunction: (event) => {
+   *       const { item } = event;
+   *       item.actionsSections = [
+   *         [
+   *           {
+   *             title: "Add layer to map",
+   *             icon: "add-layer",
+   *             id: "add-layer"
+   *           }
+   *         ]
+   *       ];
+   *     },
+   *     selectionMode: "single",
+   *     visibleElements: {
+   *       filter: true
+   *       temporaryLayerIndicators: true
+   *     }
+   *   },
+   *   view,
+   * });
+   */
+  accessor catalogOptions: CatalogLayerListProperties | null | undefined;
+  /**
+   * Indicates whether a component is closed. When `true`, the component will be hidden.
+   *
+   * @default false
+   * @since 4.33
+   */
+  accessor closed: boolean;
+  /**
+   * Indicates whether the component is collapsed.
+   * When collapsed, only the collapse button and heading are displayed.
+   *
+   * @default false
+   * @since 4.29
+   * @see [showCollapseButton](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-basemap-layer-list/#showCollapseButton)
+   * @example basemapLayerList.collapsed = true;
+   */
+  accessor 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.
+   * MapImageLayer [sublayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MapImageLayer.html#sublayers) can be reordered only within their parent MapImageLayer and can not be dragged out as a separate layer.
+   *
+   * @default false
+   * @since 4.29
+   * @example basemapLayerList.dragEnabled = true;
+   */
+  accessor dragEnabled: boolean;
+  /**
+   * 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
+   * @since 4.29
+   * @see [showEditTitleButton](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-basemap-layer-list/#showEditTitleButton)
+   * @example basemapLayerList.editingTitle = true;
+   */
+  accessor editingTitle: boolean;
+  /**
+   * Placeholder text used in the filter input if [visibleElements.filter](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList.html#visibleElements) is true.
+   *
+   * @default ""
+   * @since 4.29
+   * @see [showFilter](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-basemap-layer-list/#showFilter)
+   * @example basemapLayerList.filterPlaceholder = "Filter layers";
+   */
+  accessor filterPlaceholder: string;
+  /**
+   * Indicates the heading level to use for the widget title (i.e. "Navigation").
+   * By default, the basemap's title is rendered
+   * as a level 2 heading (e.g. `<h2>Navigation</h2>`). Depending on the widget's placement
+   * in your app, you may need to adjust this heading for proper semantics. This is
+   * important for meeting accessibility standards.
+   *
+   * @default 2
+   * @since 4.20
+   * @see [Heading Elements](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/Heading_Elements)
+   * @example
+   * // the component title will render as an <h3>
+   * basemapLayerList.headingLevel = 3;
+   */
+  accessor headingLevel: HeadingLevel;
+  /**
+   * Indicates whether the base layers will be displayed.
+   *
+   * @default false
+   * @since 5.0
+   */
+  accessor hideBaseLayers: boolean;
+  /**
+   * Determines whether the basemap layer list should be shown within its built-in [flow component](https://developers.arcgis.com/calcite-design-system/components/flow/) or if the flow component should be excluded. The basemap layer list will be displayed within its original flow component if set to `true`. The flow component will be omitted from the basemap layer list if set to `false`. To place the basemap layer list into an existing Calcite flow component, set this property to `false`.
+   *
+   * @default false
+   * @since 5.0
+   */
+  accessor hideFlow: boolean;
+  /**
+   * Indicates whether the basemap layer list displays a heading. The heading text is the title of the basemap. The heading level can be set with the [BasemapLayerList#headingLevel](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList.html#headingLevel).
+   *
+   * @default false
+   * @since 5.0
+   */
+  accessor hideHeading: boolean;
+  /**
+   * Indicates whether to the reference layers will be displayed.
+   *
+   * @default false
+   * @since 5.0
+   */
+  accessor hideReferenceLayers: boolean;
+  /**
+   * Indicates whether the status indicators will be displayed.
+   *
+   * @default false
+   * @since 5.0
+   */
+  accessor hideStatusIndicators: boolean;
+  /**
+   * Icon which represents the component.
+   * Typically used when the component is controlled by another component (e.g. by the Expand component).
+   *
+   * @default "layers"
+   * @since 4.27
+   * @see [Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)
+   */
+  get icon(): Icon["icon"];
+  set icon(value: IconName);
+  /**
+   * The component's default label.
+   *
+   * @since 4.11
+   */
+  accessor label: string;
+  /**
+   * The minimum number of list items required to display the [visibleElements.filter](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList-BasemapLayerListVisibleElements.html) input box.
+   *
+   * @default 10
+   * @since 4.29
+   * @see [showFilter](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-basemap-layer-list/#showFilter)
+   * @example
+   * basemapLayerList.showFilter = true;
+   * basemapLayerList.minFilterItems = 5;
+   */
+  accessor minFilterItems: number;
+  /**
+   * By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.
+   *
+   * @see [Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)
+   */
+  accessor referenceElement: ArcgisReferenceElement | string | undefined;
+  /**
+   * Specifies a function to handle filtering reference layer [list items](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItem.html).
+   *
+   * @since 4.32
+   * @example layerList.referenceFilterPredicate = (item) => item.title.toLowerCase().includes("streets");
+   */
+  accessor referenceFilterPredicate: FilterPredicate | null | undefined;
+  /**
+   * The value of the filter input text string if [visibleElements.filter](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList.html#visibleElements) is true.
+   *
+   * @default ""
+   * @since 4.29
+   * @see [showFilter](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-basemap-layer-list/#showFilter)
+   * @example
+   * reactiveUtils.watch(
+   *   () => basemapLayerList.referenceFilterText,
+   *   (referenceFilterText) => console.log(referenceFilterText)
+   * );
+   */
+  accessor referenceFilterText: string;
+  /** A collection of ListItems representing the referenceLayers. */
+  get referenceItems(): __esri.Collection<__esri.ListItem>;
+  /**
+   * Specifies a function that accesses each [ListItem](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItem.html) representing a reference layer.
+   * Each list item's modifiable properties can be updated within. Actions can be added to list items
+   * using the [ListItem#actionsSections](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItem.html#actionsSections).
+   *
+   * @example
+   * let bmLayerList = new BasemapLayerList({
+   *   view: view,
+   *   referenceListItemCreatedFunction: (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 referenceListItemCreatedFunction: ListItemModifier | null | undefined;
+  /**
+   * A collection of selected [ListItem](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItem.html)s representing basemap layers
+   * selected by the user.
+   *
+   * @see [selectionMode](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList.html#selectionMode)
+   */
+  accessor selectedItems: Collection<ListItem>;
+  /**
+   * Specifies the selection mode.
+   * Selected items are available in the [selectedItems](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList.html#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"
+   * @since 4.29
+   * @see [selectedItems](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList.html#selectedItems)
+   * @example basemapLayerList.selectionMode = "multiple";
+   */
+  accessor selectionMode: "none" | "multiple" | "single" | "single-persist";
+  /**
+   * Indicates whether to display a close button in the header.
+   *
+   * @default false
+   * @since 5.0
+   */
+  accessor showCloseButton: boolean;
+  /**
+   * Indicates whether to display a collapse button in the header.
+   *
+   * @default false
+   * @since 5.0
+   */
+  accessor showCollapseButton: boolean;
+  /**
+   * Indicates whether to display a button in the header to edit the basemap title.
+   *
+   * @default false
+   * @since 5.0
+   */
+  accessor showEditTitleButton: boolean;
+  /**
+   * Indicates whether to display layers with load errors.
+   *
+   * @default false
+   * @since 5.0
+   */
+  accessor showErrors: boolean;
+  /**
+   * Indicates whether to display a filter input box when then number of list items is equal to or greater than the value set in [BasemapLayerList#minFilterItems](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList.html#minFilterItems), allowing users to filter layers by their title.
+   *
+   * @default false
+   * @since 5.0
+   */
+  accessor showFilter: boolean;
+  /**
+   * Indicates whether temporary layer indicators will be displayed for layers with [Layer#persistenceEnabled](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html#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
+   * @since 5.0
+   */
+  accessor showTemporaryLayerIndicators: boolean;
+  /**
+   * The current state of the component.
+   *
+   * @default "disabled"
+   */
+  get state(): BasemapLayerListState;
+  /**
+   * 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 Basemap Layer List component will be associated with a map or scene component rather than using the `view` property.
+   */
+  accessor view: MapViewOrSceneView | null | undefined;
+  /**
+   * 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/img/apiref/widgets/basemap-layer-list/visibilityAppearance-default.png) |
+   * | 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/img/apiref/widgets/basemap-layer-list/visibilityAppearance-checkbox.png) |
+   *
+   * @default "default"
+   * @since 4.29
+   * @example basemapLayerList.visibilityAppearance = "checkbox";
+   */
+  accessor visibilityAppearance: VisibilityAppearance;
+  /** Permanently destroy the component. */
+  destroy(): Promise<void>;
+  "@setterTypes": {
+    icon?: IconName;
+  };
+  /**
+   * Emitted when the component's close button is clicked.
+   *
+   * @since 4.33
+   */
+  readonly arcgisClose: 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 an action is triggered on the component. */
+  readonly arcgisTriggerAction: import("@arcgis/lumina").TargetedEvent<this, __esri.BasemapLayerListTriggerActionEvent>;
+  readonly "@eventTypes": {
+    arcgisClose: ArcgisBasemapLayerList["arcgisClose"]["detail"];
+    arcgisPropertyChange: ArcgisBasemapLayerList["arcgisPropertyChange"]["detail"];
+    arcgisReady: ArcgisBasemapLayerList["arcgisReady"]["detail"];
+    arcgisTriggerAction: ArcgisBasemapLayerList["arcgisTriggerAction"]["detail"];
+  };
+}