@arcgis/map-components 5.1.0-next.1 → 5.1.0-next.100

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

@@ -1,13 +1,10 @@
 /// <reference path="../../index.d.ts" />
-import type ListItem from "@arcgis/core/widgets/LayerList/ListItem";
-import type Collection from "@arcgis/core/core/Collection";
-import type CatalogLayerList from "@arcgis/core/widgets/CatalogLayerList";
-import type Collection2 from "@arcgis/core/core/Collection.js";
-import type ListItem2 from "@arcgis/core/widgets/LayerList/ListItem.js";
+import type ListItem from "@arcgis/core/widgets/LayerList/ListItem.js";
+import type Collection from "@arcgis/core/core/Collection.js";
+import type CatalogLayerList from "@arcgis/core/widgets/CatalogLayerList.js";
 import type { PublicLitElement as LitElement } from "@arcgis/lumina";
-import type { ArcgisReferenceElement } from "../../utils/component-utils.js";
-import type { IconName } from "../../utils/action-utils.js";
-import type { LayerListViewModelTriggerActionEvent } from "@arcgis/core/widgets/LayerList/LayerListViewModel";
+import type { ArcgisReferenceElement, IconName } from "../types.js";
+import type { LayerListViewModelTriggerActionEvent } from "@arcgis/core/widgets/LayerList/LayerListViewModel.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";
@@ -16,7 +13,7 @@ import type { Icon } from "@esri/calcite-components/components/calcite-icon";
 import type { BasemapLayerListState } from "@arcgis/core/widgets/BasemapLayerList/types.js";
 
 /**
- * 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.
+ * The Basemap Layer List 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. When editing is enabled, layers can be reordered by dragging and dropping between the lists and the title can be edited.
  *
  * @since 4.28
  */
@@ -32,83 +29,91 @@ export abstract class ArcgisBasemapLayerList extends LitElement {
    */
   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).
+   * Specifies a function to handle filtering base layer [list items](https://developers.arcgis.com/javascript/latest/references/core/widgets/LayerList/ListItem/).
    *
    * @since 4.32
-   * @example layerList.baseFilterPredicate = (item) => item.title.toLowerCase().includes("streets");
+   * @example
+   * ```js
+   * basemapLayerListElement.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.
+   * The value of the filter input text string if [showFilter](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-basemap-layer-list/#showFilter) is true.
    *
    * @default ""
    * @since 4.29
    * @see [showFilter](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-basemap-layer-list/#showFilter)
    * @example
+   * ```js
    * reactiveUtils.watch(
-   *   () => basemapLayerList.baseFilterText,
+   *   () => basemapLayerListElement.baseFilterText,
    *   (baseFilterText) => console.log(baseFilterText)
    * );
+   * ```
    */
   accessor baseFilterText: string;
   /** A collection of ListItems representing the baseLayers. */
   get baseItems(): Collection<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.
+   * Specifies a function that accesses each [ListItem](https://developers.arcgis.com/javascript/latest/references/core/widgets/LayerList/ListItem/) 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)
+   * using the [ListItem#actionsSections](https://developers.arcgis.com/javascript/latest/references/core/widgets/LayerList/ListItem/#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;
-   *     }
+   * ```js
+   * basemapLayerListElement.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. */
+  /**
+   * The CatalogLayerList that displays a catalog layer's dynamic group layer.
+   *
+   * @see [arcgis-catalog-layer-list](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-catalog-layer-list/)
+   * @see [catalogOptions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-basemap-layer-list/#catalogOptions)
+   */
   get catalogLayerList(): CatalogLayerList | null | undefined;
   /**
-   * [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.
+   * [CatalogLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/CatalogLayer/) specific properties.
+   * Catalog layers will display their [dynamicGroupLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/CatalogLayer/#dynamicGroupLayer) as an expandable [catalogLayerList](https://developers.arcgis.com/javascript/latest/references/core/widgets/BasemapLayerList/#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).
+   * These are the properties that are used to configure the [catalogLayerList](https://developers.arcgis.com/javascript/latest/references/core/widgets/BasemapLayerList/#catalogLayerList).
    *
    * @since 4.30
-   * @see [catalogLayerList](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList.html#catalogLayerList)
+   * @see [catalogLayerList](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-basemap-layer-list/#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
-   *     }
+   * ```js
+   * basemapLayerListElement.catalogOptions = {
+   *   listItemCreatedFunction: (event) => {
+   *     const { item } = event;
+   *     item.actionsSections = [
+   *       [
+   *         {
+   *           title: "Add layer to map",
+   *           icon: "add-layer",
+   *           id: "add-layer"
+   *         }
+   *       ]
+   *     ];
    *   },
-   *   view,
-   * });
+   *   selectionMode: "single",
+   *   visibleElements: {
+   *     filter: true
+   *     temporaryLayerIndicators: true
+   *   }
+   * };
+   * ```
    */
   accessor catalogOptions: CatalogLayerListProperties | null | undefined;
   /**
@@ -125,16 +130,22 @@ export abstract class ArcgisBasemapLayerList extends LitElement {
    * @default false
    * @since 4.29
    * @see [showCollapseButton](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-basemap-layer-list/#showCollapseButton)
-   * @example basemapLayerList.collapsed = true;
+   * @example
+   * ```js
+   * basemapLayerListElement.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.
+   * Indicates whether [list items](https://developers.arcgis.com/javascript/latest/references/core/widgets/LayerList/ListItem/) may be reordered within the list by dragging and dropping.
+   * 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
    * @since 4.29
-   * @example basemapLayerList.dragEnabled = true;
+   * @example
+   * ```js
+   * basemapLayerListElement.dragEnabled = true;
+   * ```
    */
   accessor dragEnabled: boolean;
   /**
@@ -144,22 +155,28 @@ export abstract class ArcgisBasemapLayerList extends LitElement {
    * @default false
    * @since 4.29
    * @see [showEditTitleButton](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-basemap-layer-list/#showEditTitleButton)
-   * @example basemapLayerList.editingTitle = true;
+   * @example
+   * ```js
+   * basemapLayerListElement.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.
+   * Placeholder text used in the filter input if [showFilter](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-basemap-layer-list/#showFilter) is true.
    *
    * @default ""
    * @since 4.29
    * @see [showFilter](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-basemap-layer-list/#showFilter)
-   * @example basemapLayerList.filterPlaceholder = "Filter layers";
+   * @example
+   * ```js
+   * basemapLayerListElement.filterPlaceholder = "Filter layers";
+   * ```
    */
   accessor filterPlaceholder: string;
   /**
-   * Indicates the heading level to use for the widget title (i.e. "Navigation").
+   * Indicates the heading level to use for the component's 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
+   * as a level 2 heading (e.g. `<h2>Navigation</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.
    *
@@ -167,8 +184,10 @@ export abstract class ArcgisBasemapLayerList extends LitElement {
    * @since 4.20
    * @see [Heading Elements](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/Heading_Elements)
    * @example
+   * ```js
    * // the component title will render as an <h3>
-   * basemapLayerList.headingLevel = 3;
+   * basemapLayerListElement.headingLevel = 3;
+   * ```
    */
   accessor headingLevel: HeadingLevel;
   /**
@@ -179,7 +198,7 @@ export abstract class ArcgisBasemapLayerList extends LitElement {
    */
   accessor hideBaseLayers: 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).
+   * 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/references/core/widgets/BasemapLayerList/#headingLevel).
    *
    * @default false
    * @since 5.0
@@ -209,21 +228,19 @@ export abstract class ArcgisBasemapLayerList extends LitElement {
    */
   get icon(): Icon["icon"];
   set icon(value: IconName);
-  /**
-   * The component's default label.
-   *
-   * @since 4.11
-   */
+  /** The component's default label. */
   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.
+   * The minimum number of list items required to display the [showFilter](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-basemap-layer-list/#showFilter) input box.
    *
    * @default 10
    * @since 4.29
    * @see [showFilter](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-basemap-layer-list/#showFilter)
    * @example
-   * basemapLayerList.showFilter = true;
-   * basemapLayerList.minFilterItems = 5;
+   * ```js
+   * basemapLayerListElement.showFilter = true;
+   * basemapLayerListElement.minFilterItems = 5;
+   * ```
    */
   accessor minFilterItems: number;
   /**
@@ -233,57 +250,61 @@ export abstract class ArcgisBasemapLayerList extends LitElement {
    */
   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).
+   * Specifies a function to handle filtering reference layer [list items](https://developers.arcgis.com/javascript/latest/references/core/widgets/LayerList/ListItem/).
    *
    * @since 4.32
-   * @example layerList.referenceFilterPredicate = (item) => item.title.toLowerCase().includes("streets");
+   * @example
+   * ```js
+   * 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.
+   * The value of the filter input text string if [showFilter](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-basemap-layer-list/#showFilter) is true.
    *
    * @default ""
    * @since 4.29
    * @see [showFilter](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-basemap-layer-list/#showFilter)
    * @example
+   * ```js
    * reactiveUtils.watch(
-   *   () => basemapLayerList.referenceFilterText,
+   *   () => basemapLayerListElement.referenceFilterText,
    *   (referenceFilterText) => console.log(referenceFilterText)
    * );
+   * ```
    */
   accessor referenceFilterText: string;
   /** A collection of ListItems representing the referenceLayers. */
   get referenceItems(): Collection<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.
+   * Specifies a function that accesses each [ListItem](https://developers.arcgis.com/javascript/latest/references/core/widgets/LayerList/ListItem/) 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).
+   * using the [ListItem#actionsSections](https://developers.arcgis.com/javascript/latest/references/core/widgets/LayerList/ListItem/#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;
-   *     }
+   * ```js
+   * basemapLayerListElement.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
+   * A collection of selected [ListItem](https://developers.arcgis.com/javascript/latest/references/core/widgets/LayerList/ListItem/)s representing basemap layers
    * selected by the user.
    *
-   * @see [selectionMode](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList.html#selectionMode)
+   * @see [selectionMode](https://developers.arcgis.com/javascript/latest/references/core/widgets/BasemapLayerList/#selectionMode)
    */
-  accessor selectedItems: Collection2<ListItem2>;
+  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.
+   * Selected items are available in the [selectedItems](https://developers.arcgis.com/javascript/latest/references/core/widgets/BasemapLayerList/#selectedItems) property.
    *
    * | Value | Description |
    * | ----- | ----------- |
@@ -294,10 +315,13 @@ export abstract class ArcgisBasemapLayerList extends LitElement {
    *
    * @default "none"
    * @since 4.29
-   * @see [selectedItems](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList.html#selectedItems)
-   * @example basemapLayerList.selectionMode = "multiple";
+   * @see [selectedItems](https://developers.arcgis.com/javascript/latest/references/core/widgets/BasemapLayerList/#selectedItems)
+   * @example
+   * ```js
+   * basemapLayerListElement.selectionMode = "multiple";
+   * ```
    */
-  accessor selectionMode: "none" | "multiple" | "single" | "single-persist";
+  accessor selectionMode: "multiple" | "single" | "none" | "single-persist";
   /**
    * Indicates whether to display a close button in the header.
    *
@@ -327,14 +351,14 @@ export abstract class ArcgisBasemapLayerList extends LitElement {
    */
   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.
+   * 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/references/core/widgets/BasemapLayerList/#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.
+   * Indicates whether temporary layer indicators will be displayed 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
    * @since 5.0
@@ -356,12 +380,15 @@ export abstract class ArcgisBasemapLayerList extends LitElement {
    *
    * | 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 | 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"
    * @since 4.29
-   * @example basemapLayerList.visibilityAppearance = "checkbox";
+   * @example
+   * ```js
+   * basemapLayerListElement.visibilityAppearance = "checkbox";
+   * ```
    */
   accessor visibilityAppearance: VisibilityAppearance;
   /** Permanently destroy the component. */

package/dist/components/arcgis-basemap-toggle/customElement.d.ts

@@ -1,8 +1,8 @@
 /// <reference path="../../index.d.ts" />
-import type Basemap2 from "@arcgis/core/Basemap.js";
+import type Basemap from "@arcgis/core/Basemap.js";
 import type { PublicLitElement as LitElement } from "@arcgis/lumina";
-import type { ArcgisReferenceElement } from "../../utils/component-utils.js";
-import type { BasemapProperties } from "@arcgis/core/Basemap";
+import type { ArcgisReferenceElement } from "../types.js";
+import type { BasemapProperties } from "@arcgis/core/Basemap.js";
 import type { T9nMeta } from "@arcgis/lumina/controllers";
 import type { MapViewOrSceneView } from "@arcgis/core/views/MapViewOrSceneView.js";
 import type { BasemapToggleViewModelState } from "@arcgis/core/widgets/BasemapToggle/BasemapToggleViewModel.js";
@@ -15,8 +15,8 @@ import type { BasemapToggleViewModelState } from "@arcgis/core/widgets/BasemapTo
  * @since 4.28
  */
 export abstract class ArcgisBasemapToggle extends LitElement {
-  /** The map's current [basemap](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#basemap). */
-  get activeBasemap(): Basemap2 | null | undefined;
+  /** The map's current [basemap](https://developers.arcgis.com/javascript/latest/references/core/Map/#basemap). */
+  get activeBasemap(): Basemap | 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
@@ -81,7 +81,7 @@ export abstract class ArcgisBasemapToggle extends LitElement {
   accessor view: MapViewOrSceneView | null | undefined;
   /** Permanently destroy the component. */
   destroy(): Promise<void>;
-  /** Toggles to the [next basemap](#nextBasemap). */
+  /** Toggles to the [nextBasemap](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-basemap-toggle/#nextBasemap). */
   toggle(): Promise<any>;
   /** 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: "activeBasemap" | "nextBasemap" | "state"; }>;

package/dist/components/arcgis-basemap-toggle/customElement.js

@@ -5,7 +5,7 @@ import { usePropertyChange as x } from "@arcgis/lumina/controllers";
 import { classes as a } from "@arcgis/toolkit/dom";
 import { getBasemapThumbnailUrl as y } from "@arcgis/core/applications/Components/basemapUtils.js";
 import k from "@arcgis/core/widgets/BasemapToggle/BasemapToggleViewModel.js";
-import { LitElement as z, createEvent as B, safeClassMap as r, nothing as n, safeStyleMap as h } from "@arcgis/lumina";
+import { LitElement as z, createEvent as B, nothing as n, safeClassMap as r, safeStyleMap as h } from "@arcgis/lumina";
 import { u as $ } from "../../chunks/useT9n.js";
 import { m as M } from "../../chunks/useViewModel.js";
 import { g as m } from "../../chunks/globalCss.js";
@@ -34,7 +34,9 @@ class E extends z {
     const e = this.viewModel, o = e.state === "disabled" ? null : e.activeBasemap, i = e.state === "disabled" ? null : e.nextBasemap, u = e.state === "loading", s = e.state === "incompatible-next-basemap", l = i?.title ?? "", c = i && i.loadStatus !== "loaded";
     let d;
     const g = this.showTitle && l, p = s, v = g || p, b = this._getThumbnailStyles(o), w = this._getThumbnailStyles(i);
-    return v && (d = t`<div class="overlay">${g ? t`<span class=${r(a("title", "title-wrap"))} title=${l ?? n}>${l}</span>` : null}${p ? t`<calcite-scrim class="overlay-scrim" title=${this.messages.incompatibleSpatialReference ?? n}><calcite-icon icon=exclamation-mark-triangle></calcite-icon></calcite-scrim>` : null}</div>`), t`<div class=${r(a("root", m.widget))}><calcite-button appearance=transparent data-basemap-id=${(i ? i.id : "") ?? n} .disabled=${s} kind=neutral .label=${this.label ?? void 0} @click=${() => void this.toggle()} title=${this.label ?? void 0 ?? n}><div class=${r(a("container", "image-secondary"))}><div class="image" style=${h(b)}></div></div><div class="container"><div class=${r(a("image", c ? "image-loading" : null))} style=${h(w)}>${c || u ? t`<calcite-scrim><span aria-hidden=true class=${r(m.loaderAnimation)} role=presentation></span></calcite-scrim>` : null}</div>${d}</div></calcite-button></div>`;
+    return v && (d = t`<div class="overlay">${g ? t`<span class=${r(a("title", "title-wrap"))} title=${l ?? n}>${l}</span>` : null}${p ? t`<calcite-scrim class="overlay-scrim" title=${this.messages.incompatibleSpatialReference ?? n}><calcite-icon icon=exclamation-mark-triangle></calcite-icon></calcite-scrim>` : null}</div>`), t`<div class=${r(a("root", m.widget))}><calcite-button appearance=transparent data-basemap-id=${(i ? i.id : "") ?? n} .disabled=${s} kind=neutral .label=${this.label ?? void 0} @click=${() => {
+      this.toggle();
+    }} title=${this.label ?? void 0 ?? n}><div class=${r(a("container", "image-secondary"))}><div class="image" style=${h(b)}></div></div><div class="container"><div class=${r(a("image", c ? "image-loading" : null))} style=${h(w)}>${c || u ? t`<calcite-scrim><span aria-hidden=true class=${r(m.loaderAnimation)} role=presentation></span></calcite-scrim>` : null}</div>${d}</div></calcite-button></div>`;
   }
 }
 f("arcgis-basemap-toggle", E);

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

@@ -1,21 +1,18 @@
 /// <reference path="../../index.d.ts" />
 import type Bookmark from "@arcgis/core/webmap/Bookmark.js";
 import type Collection from "@arcgis/core/core/Collection.js";
-import type SceneView from "@arcgis/core/views/SceneView";
-import type MapView from "@arcgis/core/views/MapView";
+import type SceneView from "@arcgis/core/views/SceneView.js";
+import type MapView from "@arcgis/core/views/MapView.js";
 import type { ReadonlyArrayOrCollection } from "@arcgis/core/core/Collection.js";
-import type { ArcgisReferenceElement } from "../../utils/component-utils.js";
-import type { BookmarkOptions, BookmarkEditEvent, BookmarkSelectEvent } from "./types.js";
-import type { HeadingLevel } from "../../support/heading.js";
-import type { IconName } from "../../utils/action-utils.js";
-import type { GoToOverride } from "../support/goTo.js";
+import type { ArcgisReferenceElement, IconName, HeadingLevel, GoToOverride } from "../types.js";
+import type { BookmarkOptions, BookmarkEditEvent, BookmarkSelectEvent, BookmarksState } from "./types.js";
 import type { PublicLitElement as LitElement } from "@arcgis/lumina";
 import type { T9nMeta } from "@arcgis/lumina/controllers";
 
 /**
  * The Bookmarks component allows end users to quickly navigate to a particular area of interest.
- * It displays a list of [bookmarks](https://developers.arcgis.com/javascript/latest/api-reference/esri-webmap-Bookmark.html),
- * which are typically defined inside the [WebMap](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html#bookmarks).
+ * It displays a list of [bookmarks](https://developers.arcgis.com/javascript/latest/references/core/webmap/Bookmark/),
+ * which are typically defined inside the [WebMap](https://developers.arcgis.com/javascript/latest/references/core/WebMap/#bookmarks).
  *
  * Each bookmark may contain the following properties: `name`, `thumbnail`, `viewpoint` (defines rotation, scale, and target geometry), and `timeExtent`.
  * When a bookmark with a timeExtent is selected, the [arcgis-map.timeExtent](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#timeExtent) of the Map will be set to the timeExtent of the selected bookmark.
@@ -25,7 +22,7 @@ import type { T9nMeta } from "@arcgis/lumina/controllers";
  * To enable these features, set the following properties to `true`:
  * [showAddBookmarkButton](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-bookmarks/#showAddBookmarkButton), [showEditBookmarkButton](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-bookmarks/#showEditBookmarkButton), and [dragEnabled](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-bookmarks/#dragEnabled).
  *
- * **Note:** Bookmarks are supported in a 3D [Scene](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/) only if they come from a [WebMap](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html#bookmarks) or are [provided manually](#bookmarks). [Presentation](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Presentation.html) provides a similar experience for [WebScenes](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Presentation.html).
+ * **Note:** Bookmarks are supported in a 3D [Scene](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/) only if they come from a [WebMap](https://developers.arcgis.com/javascript/latest/references/core/WebMap/#bookmarks) or are provided manually from [bookmarks](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-bookmarks/#bookmarks). [Presentation](https://developers.arcgis.com/javascript/latest/references/core/webscene/Presentation/) provides a similar experience for [WebScenes](https://developers.arcgis.com/javascript/latest/references/core/webscene/Presentation/).
  *
  * @since 4.28
  * @see [Sample - Bookmarks component](https://developers.arcgis.com/javascript/latest/sample-code/bookmarks/)
@@ -42,7 +39,7 @@ export abstract class ArcgisBookmarks extends LitElement {
    */
   accessor autoDestroyDisabled: boolean;
   /**
-   * A collection of [Bookmark](https://developers.arcgis.com/javascript/latest/api-reference/esri-webmap-Bookmark.html)s. These are typically defined inside of a [WebMap](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html#bookmarks), but can also be defined manually, as shown in the code snippet below.
+   * A collection of [Bookmark](https://developers.arcgis.com/javascript/latest/references/core/webmap/Bookmark/)s. These are typically defined inside of a [WebMap](https://developers.arcgis.com/javascript/latest/references/core/WebMap/#bookmarks), but can also be defined manually, as shown in the code snippet below.
    *
    * @example
    * ```js
@@ -123,7 +120,7 @@ export abstract class ArcgisBookmarks extends LitElement {
   get defaultEditOptions(): BookmarkOptions;
   set defaultEditOptions(value: Partial<BookmarkOptions>);
   /**
-   * When true, the component is visually withdrawn and cannot be interacted with.
+   * When true, the component is visually withdrawn and cannot receive user interaction.
    *
    * @default false
    */
@@ -214,6 +211,7 @@ export abstract class ArcgisBookmarks extends LitElement {
    */
   accessor messageOverrides: {
       addBookmark?: string | undefined;
+      bookmarkSelected?: string | undefined;
       goToBookmark?: string | undefined;
       includeTimeExtent?: string | undefined;
       noBookmarksHeading?: string | undefined;
@@ -245,6 +243,7 @@ export abstract class ArcgisBookmarks extends LitElement {
   /** @internal */
   protected messages: Partial<{
       addBookmark: string;
+      bookmarkSelected: string;
       goToBookmark: string;
       includeTimeExtent: string;
       noBookmarksHeading: string;
@@ -274,6 +273,7 @@ export abstract class ArcgisBookmarks extends LitElement {
       save: string;
   }> & T9nMeta<{
       addBookmark: string;
+      bookmarkSelected: string;
       goToBookmark: string;
       includeTimeExtent: string;
       noBookmarksHeading: string;
@@ -383,7 +383,7 @@ export abstract class ArcgisBookmarks extends LitElement {
     defaultEditOptions?: Partial<BookmarkOptions>;
   };
   /**
-   * Fires when a [Bookmark](https://developers.arcgis.com/javascript/latest/api-reference/esri-webmap-Bookmark.html) is edited.
+   * Fires when a [Bookmark](https://developers.arcgis.com/javascript/latest/references/core/webmap/Bookmark/) is edited.
    *
    * @since 4.34
    * @example
@@ -397,7 +397,7 @@ export abstract class ArcgisBookmarks extends LitElement {
    */
   readonly arcgisBookmarkEdit: import("@arcgis/lumina").TargetedEvent<this, BookmarkEditEvent>;
   /**
-   * Fires when a [Bookmark](https://developers.arcgis.com/javascript/latest/api-reference/esri-webmap-Bookmark.html) is selected.
+   * Fires when a [Bookmark](https://developers.arcgis.com/javascript/latest/references/core/webmap/Bookmark/) is selected.
    *
    * @since 4.34
    * @example
@@ -432,6 +432,4 @@ export abstract class ArcgisBookmarks extends LitElement {
     arcgisPropertyChange: ArcgisBookmarks["arcgisPropertyChange"]["detail"];
     arcgisReady: ArcgisBookmarks["arcgisReady"]["detail"];
   };
-}
-
-export type BookmarksState = "loading" | "ready";
+}