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

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

@@ -1,14 +1,18 @@
-/// <reference types="@arcgis/core/interfaces.d.ts" />
 /// <reference path="../../index.d.ts" />
-import { default as BookmarksViewModel } from './BookmarksViewModel.js';
-import { JsxNode, PublicLitElement as LitElement, TargetedEvent } from '@arcgis/lumina';
-import { Use } from '@arcgis/lumina/controllers';
-import { HeadingLevel } from '../../support/heading';
-import { ArcgisReferenceElement } from '../../utils/component-utils';
-import { BookmarkOptions, BookmarkEditEvent, BookmarkSelectEvent } from './types';
-import { IconName } from '../../utils/action-utils';
+/// <reference types="@arcgis/core/interfaces.d.ts" />
+import type MapView from "@arcgis/core/views/MapView.js";
+import type SceneView from "@arcgis/core/views/SceneView.js";
+import type Collection from "@arcgis/core/core/Collection.js";
+import type Bookmark from "@arcgis/core/webmap/Bookmark.js";
+import type { PublicLitElement as LitElement } from "@arcgis/lumina/PublicLitElement";
+import type { HeadingLevel } from "../../support/heading.js";
+import type { ArcgisReferenceElement } from "../../utils/component-utils.js";
+import type { BookmarkOptions, BookmarkEditEvent, BookmarkSelectEvent } from "./types.js";
+import type { IconName } from "../../utils/action-utils.js";
+import type { T9nMeta } from "@arcgis/lumina/controllers";
+import type { GoToOverride } from "../support/goTo.js";
+import type { BookmarksViewModelState } from "./BookmarksViewModel.js";
 
-declare const useBookmarksViewModel: (component: LitElement & Pick<BookmarksViewModel, never> & import('../../controllers/useViewModel').ViewModelControllerUses<BookmarksViewModel>) => BookmarksViewModel;
 /**
  * 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),
@@ -24,328 +28,411 @@ declare const useBookmarksViewModel: (component: LitElement & Pick<BookmarksView
  *
  * **Note:** Bookmarks are supported in a 3D [Scene](https://developers.arcgis.com/javascript/latest/references/map-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).
  *
- * [Read more...](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-bookmarks/)
- *
  * @since 4.28
  * @see [Sample - Bookmarks component](https://developers.arcgis.com/javascript/latest/sample-code/bookmarks/)
  */
-export declare class ArcgisBookmarks extends LitElement {
-    /**
-     * 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 Bookmarks component will be associated with a map or scene component rather than using the `view` property.
-     */
-    view?: import('@arcgis/core/views/MapView.js').default | import('@arcgis/core/views/SceneView.js').default | 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)
-     */
-    referenceElement?: ArcgisReferenceElement | string;
-    /**
-     * Icon which represents the component.
-     * Typically used when the component is controlled by another component (e.g. by the Expand component).
-     *
-     * @default "bookmark"
-     * @see [Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)
-     */
-    icon: IconName;
-    /**
-     * Indicates whether a component is closed. When `true`, the component will be hidden.
-     *
-     * @default false
-     */
-    closed: boolean;
-    /**
-     * Specifies how new bookmarks will be created if [showAddBookmarkButton](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-bookmarks/#showAddBookmarkButton) is set to `true`.
-     * Can be used to enable or disable taking screenshots or capturing the bookmark's viewpoint based on the current
-     * view when a bookmark is created.
-     *
-     * @example
-     * ```js
-     * const bookmarksElement = document.querySelector("arcgis-bookmarks");
-     * bookmarksElement.showAddBookmarkButton = true;
-     * bookmarksElement.defaultCreateOptions = {
-     *   // whenever a new bookmark is created, a 100x100 px
-     *   // screenshot of the view will be taken and the rotation, scale, and extent
-     *   // of the view will not be set as the viewpoint of the new bookmark
-     *   takeScreenshot: true,
-     *   captureViewpoint: false,
-     *   captureTimeExtent: false, // the time extent will not be saved in the bookmark
-     *   screenshotSettings: {
-     *     width: 100,
-     *     height: 100
-     *   }
-     * };
-     * ```
-     */
-    defaultCreateOptions: BookmarkOptions;
-    /**
-     * Specifies how bookmarks will be edited, if [showEditBookmarkButton](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-bookmarks/#showEditBookmarkButton) is set to `true`.
-     * Can be used to enable or disable taking screenshots or capturing the bookmark's viewpoint based on the current
-     * view when a bookmark is edited.
-     */
-    defaultEditOptions: BookmarkOptions;
-    /**
-     * 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.
-     *
-     * @example
-     * ```js
-     * const bookmarksElement = document.querySelector("arcgis-bookmarks");
-     * // define bookmarks manually
-     * bookmarksElement.bookmarks = [
-     *   new Bookmark({
-     *     name: "Angeles National Forest",
-     *     viewpoint: {
-     *       targetGeometry: {
-     *         type: "extent",
-     *         spatialReference: {
-     *           wkid: 102100
-     *         },
-     *         xmin: -13139131.948889678,
-     *         ymin: 4047767.23531948,
-     *         xmax: -13092887.54677721,
-     *         ymax: 4090610.189673263
-     *       }
-     *     }
-     *   }),
-     *   new Bookmark({
-     *     name: "Crystal Lake",
-     *     viewpoint: {
-     *       targetGeometry: {
-     *         type: "extent",
-     *         spatialReference: {
-     *           wkid: 102100
-     *         },
-     *         xmin: -13125852.551697943,
-     *         ymin: 4066904.1101411926,
-     *         xmax: -13114291.451169826,
-     *         ymax: 4077614.8487296384
-     *       },
-     *       rotation: 90
-     *     }
-     *   })
-     * ];
-     */
-    bookmarks: import('@arcgis/core/core/Collection.js').default<import('@arcgis/core/webmap/Bookmark.js').default>;
-    /**
-     * When true, the component is visually withdrawn and cannot be interacted with.
-     *
-     * @default false
-     */
-    disabled: boolean;
-    /**
-     * Indicates if a Bookmark is able to be dragged in order to update its position in the list.
-     *
-     * @default false
-     * @since 4.29
-     */
-    dragEnabled: boolean;
-    /**
-     * Defines the text used as a placeholder when [showFilter](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-bookmarks/#showFilter) is set to `true`.
-     *
-     * @default ""
-     * @since 4.29
-     */
-    filterPlaceholder: string;
-    /**
-     * Defines the text used to filter the bookmarks when [showFilter](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-bookmarks/#showFilter) is set to `true`.
-     *
-     * @default ""
-     * @since 4.29
-     */
-    filterText: string;
-    /**
-     * Indicates the heading level to use for the message "No bookmarks" when no bookmarks
-     * are available. By default, this message is rendered
-     * as a level 2 heading (e.g. `<h2>No bookmarks</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 [Heading Elements](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/Heading_Elements)
-     * @since 4.34
-     * @example
-     * ```js
-     * // "No bookmarks" will render as an <h3>
-     * bookmarksElement.headingLevel = 3;
-     * ```
-     */
-    headingLevel: HeadingLevel;
-    /**
-     * This function provides the ability to override either the
-     * [MapView goTo()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#goTo) or
-     * [SceneView goTo()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#goTo) methods.
-     *
-     * @see [MapView#goTo()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#goTo)
-     * @see [SceneView#goTo()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#goTo)
-     * @example
-     * // The following snippet uses Search but can be applied to any
-     * // components that support the goToOverride property.
-     * search.goToOverride = function(view, goToParams) {
-     *   goToParams.options = {
-     *     duration: updatedDuration
-     *   };
-     *   return view.goTo(goToParams.target, goToParams.options);
-     * };
-     */
-    goToOverride: import('../support/goTo.js').GoToOverride | undefined;
-    /**
-     * Indicates whether to display the button to add a new bookmark.
-     *
-     * @default false
-     * @since 4.30
-     */
-    showAddBookmarkButton: boolean;
-    /**
-     * Indicates whether to display the close button.
-     *
-     * @default false
-     * @since 4.30
-     */
-    showCloseButton: boolean;
-    /**
-     * Indicates whether to display the collapse button.
-     *
-     * @default false
-     * @since 4.30
-     */
-    showCollapseButton: boolean;
-    /**
-     * Indicates whether to display the button to edit a bookmark.
-     *
-     * @default false
-     * @since 4.30
-     */
-    showEditBookmarkButton: boolean;
-    /**
-     * Indicates whether to display the bookmark filter.
-     *
-     * @default false
-     * @since 4.30
-     */
-    showFilter: boolean;
-    /**
-     * Determines whether the component should be rendered within its built-in [flow component](https://developers.arcgis.com/calcite-design-system/components/flow/).
-     *
-     * @default false
-     * @since 4.30
-     */
-    hideFlow: boolean;
-    /**
-     * Indicates whether to display the heading.
-     *
-     * @default false
-     * @since 4.30
-     */
-    showHeading: boolean;
-    /**
-     * Indicates whether the thumbnail associated with the bookmark is hidden.
-     *
-     * @default false
-     * @since 4.30
-     */
-    hideThumbnail: boolean;
-    /**
-     * Indicates whether the time (`h:m:s`) displayed next to the date is hidden if the bookmark has a time extent defined.
-     *
-     * @default false
-     * @since 4.30
-     */
-    hideTime: boolean;
-    /**
-     * Indicates whether to disable the time capability of the Bookmarks component.
-     *
-     * @default false
-     * @since 4.34
-     */
-    timeDisabled: boolean | 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-bookmarks/#destroy) method when you are done to
-     * prevent memory leaks.
-     *
-     * @default false
-     */
-    autoDestroyDisabled: boolean;
-    /**
-     * Replace localized message strings with your own strings.
-     *
-     * _**Note**: Individual message keys may change between releases._
-     *
-     * @since 4.34
-     */
-    messageOverrides?: typeof this.messages._overrides;
-    /** The component's default label. */
-    label?: string;
-    /**
-     * The current state of the component.
-     *
-     * @default "ready"
-     */
-    readonly state: "ready" | "loading";
-    /** Permanently destroy the component. */
-    destroy(): Promise<void>;
-    /**
-     * Zoom to a specific bookmark.
-     *
-     * @param bookmark
-     * @since 4.34
-     */
-    goTo(bookmark: __esri.Bookmark): Promise<void>;
-    /**
-     * Fires when a [Bookmark](https://developers.arcgis.com/javascript/latest/api-reference/esri-webmap-Bookmark.html) is edited.
-     *
-     * @since 4.34
-     * @example
-     * ```js
-     * // once an edit has been made, enable the "Save Webmap" button
-     * //    to allow the user to save their changes
-     * bookmarksElement.addEventListener("arcgisBookmarkEdit", (event) => {
-     *    saveBtn.disabled = false;
-     * });
-     * ```
-     */
-    readonly arcgisBookmarkEdit: TargetedEvent<this, BookmarkEditEvent>;
-    /**
-     * Fires when a [Bookmark](https://developers.arcgis.com/javascript/latest/api-reference/esri-webmap-Bookmark.html) is selected.
-     *
-     * @since 4.34
-     * @example
-     * ```html
-     * <arcgis-expand expanded>
-     *  <arcgis-bookmarks></arcgis-bookmarks>
-     * </arcgis-expand>
-     *
-     * <script>
-     *   const bookmarksElement = document.querySelector("arcgis-bookmarks");
-     *   const expandElement = document.querySelector("arcgis-expand");
-     *
-     *   // collapses the associated Expand component
-     *   // when a bookmark is selected
-     *   bookmarksElement.addEventListener("arcgisBookmarkSelect", (event) => {
-     *     expandElement.expanded = false;
-     *   });
-     * </script>
-     * ```
-     */
-    readonly arcgisBookmarkSelect: TargetedEvent<this, BookmarkSelectEvent>;
-    /** 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 the component's close button is clicked. */
-    readonly arcgisClose: TargetedEvent<this, void>;
-    private messages;
-    "@eventTypes": {
-        "arcgisBookmarkEdit": ArcgisBookmarks["arcgisBookmarkEdit"]["detail"];
-        "arcgisBookmarkSelect": ArcgisBookmarks["arcgisBookmarkSelect"]["detail"];
-        "arcgisClose": ArcgisBookmarks["arcgisClose"]["detail"];
-        "arcgisPropertyChange": ArcgisBookmarks["arcgisPropertyChange"]["detail"];
-        "arcgisReady": ArcgisBookmarks["arcgisReady"]["detail"];
-    };
-}
-export {};
+export abstract class ArcgisBookmarks 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-bookmarks/#destroy) method when you are done to
+   * prevent memory leaks.
+   *
+   * @default false
+   */
+  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.
+   *
+   * @example
+   * ```js
+   * const bookmarksElement = document.querySelector("arcgis-bookmarks");
+   * // define bookmarks manually
+   * bookmarksElement.bookmarks = [
+   *   new Bookmark({
+   *     name: "Angeles National Forest",
+   *     viewpoint: {
+   *       targetGeometry: {
+   *         type: "extent",
+   *         spatialReference: {
+   *           wkid: 102100
+   *         },
+   *         xmin: -13139131.948889678,
+   *         ymin: 4047767.23531948,
+   *         xmax: -13092887.54677721,
+   *         ymax: 4090610.189673263
+   *       }
+   *     }
+   *   }),
+   *   new Bookmark({
+   *     name: "Crystal Lake",
+   *     viewpoint: {
+   *       targetGeometry: {
+   *         type: "extent",
+   *         spatialReference: {
+   *           wkid: 102100
+   *         },
+   *         xmin: -13125852.551697943,
+   *         ymin: 4066904.1101411926,
+   *         xmax: -13114291.451169826,
+   *         ymax: 4077614.8487296384
+   *       },
+   *       rotation: 90
+   *     }
+   *   })
+   * ];
+   */
+  accessor bookmarks: Collection<Bookmark>;
+  /**
+   * Indicates whether a component is closed. When `true`, the component will be hidden.
+   *
+   * @default false
+   */
+  accessor closed: boolean;
+  /**
+   * Specifies how new bookmarks will be created if [showAddBookmarkButton](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-bookmarks/#showAddBookmarkButton) is set to `true`.
+   * Can be used to enable or disable taking screenshots or capturing the bookmark's viewpoint based on the current
+   * view when a bookmark is created.
+   *
+   * @example
+   * ```js
+   * const bookmarksElement = document.querySelector("arcgis-bookmarks");
+   * bookmarksElement.showAddBookmarkButton = true;
+   * bookmarksElement.defaultCreateOptions = {
+   *   // whenever a new bookmark is created, a 100x100 px
+   *   // screenshot of the view will be taken and the rotation, scale, and extent
+   *   // of the view will not be set as the viewpoint of the new bookmark
+   *   takeScreenshot: true,
+   *   captureViewpoint: false,
+   *   captureTimeExtent: false, // the time extent will not be saved in the bookmark
+   *   screenshotSettings: {
+   *     width: 100,
+   *     height: 100
+   *   }
+   * };
+   * ```
+   */
+  accessor defaultCreateOptions: BookmarkOptions;
+  /**
+   * Specifies how bookmarks will be edited, if [showEditBookmarkButton](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-bookmarks/#showEditBookmarkButton) is set to `true`.
+   * Can be used to enable or disable taking screenshots or capturing the bookmark's viewpoint based on the current
+   * view when a bookmark is edited.
+   */
+  accessor defaultEditOptions: BookmarkOptions;
+  /**
+   * When true, the component is visually withdrawn and cannot be interacted with.
+   *
+   * @default false
+   */
+  accessor disabled: boolean;
+  /**
+   * Indicates if a Bookmark is able to be dragged in order to update its position in the list.
+   *
+   * @default false
+   * @since 4.29
+   */
+  accessor dragEnabled: boolean;
+  /**
+   * Defines the text used as a placeholder when [showFilter](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-bookmarks/#showFilter) is set to `true`.
+   *
+   * @default ""
+   * @since 4.29
+   */
+  accessor filterPlaceholder: string;
+  /**
+   * Defines the text used to filter the bookmarks when [showFilter](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-bookmarks/#showFilter) is set to `true`.
+   *
+   * @default ""
+   * @since 4.29
+   */
+  accessor filterText: string;
+  /**
+   * This function provides the ability to override either the
+   * [MapView goTo()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#goTo) or
+   * [SceneView goTo()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#goTo) methods.
+   *
+   * @see [MapView#goTo()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#goTo)
+   * @see [SceneView#goTo()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#goTo)
+   * @example
+   * // The following snippet uses Search but can be applied to any
+   * // components that support the goToOverride property.
+   * search.goToOverride = function(view, goToParams) {
+   *   goToParams.options = {
+   *     duration: updatedDuration
+   *   };
+   *   return view.goTo(goToParams.target, goToParams.options);
+   * };
+   */
+  accessor goToOverride: GoToOverride | undefined;
+  /**
+   * Indicates the heading level to use for the message "No bookmarks" when no bookmarks
+   * are available. By default, this message is rendered
+   * as a level 2 heading (e.g. `<h2>No bookmarks</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 [Heading Elements](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/Heading_Elements)
+   * @since 4.34
+   * @example
+   * ```js
+   * // "No bookmarks" will render as an <h3>
+   * bookmarksElement.headingLevel = 3;
+   * ```
+   */
+  accessor headingLevel: HeadingLevel;
+  /**
+   * Determines whether the component should be rendered within its built-in [flow component](https://developers.arcgis.com/calcite-design-system/components/flow/).
+   *
+   * @default false
+   * @since 4.30
+   */
+  accessor hideFlow: boolean;
+  /**
+   * Indicates whether the thumbnail associated with the bookmark is hidden.
+   *
+   * @default false
+   * @since 4.30
+   */
+  accessor hideThumbnail: boolean;
+  /**
+   * Indicates whether the time (`h:m:s`) displayed next to the date is hidden if the bookmark has a time extent defined.
+   *
+   * @default false
+   * @since 4.30
+   */
+  accessor hideTime: boolean;
+  /**
+   * Icon which represents the component.
+   * Typically used when the component is controlled by another component (e.g. by the Expand component).
+   *
+   * @default "bookmark"
+   * @see [Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)
+   */
+  accessor icon: IconName;
+  /** The component's default label. */
+  accessor label: string | undefined;
+  /**
+   * Replace localized message strings with your own strings.
+   *
+   * _**Note**: Individual message keys may change between releases._
+   *
+   * @since 4.34
+   */
+  accessor messageOverrides: {
+      addBookmark?: string | undefined;
+      goToBookmark?: string | undefined;
+      includeTimeExtent?: string | undefined;
+      noBookmarksHeading?: string | undefined;
+      noBookmarksDescription?: string | undefined;
+      title?: string | undefined;
+      titlePlaceholder?: string | undefined;
+      invalidTitle?: string | undefined;
+      addingBookmark?: string | undefined;
+      invalidImageUrl?: string | undefined;
+      imageUrlPlaceholder?: string | undefined;
+      imageUrlTooltip?: string | undefined;
+      thumbnail?: string | undefined;
+      screenshot?: string | undefined;
+      updateThumbnail?: string | undefined;
+      none?: string | undefined;
+      url?: string | undefined;
+      timeExtent?: string | undefined;
+      startDate?: string | undefined;
+      endDate?: string | undefined;
+      componentLabel?: string | undefined;
+      add?: string | undefined;
+      untitled?: string | undefined;
+      edit?: string | undefined;
+      loading?: string | undefined;
+      delete?: string | undefined;
+      cancel?: string | undefined;
+      save?: string | undefined;
+  };
+  /** @internal */
+  protected messages: Partial<{
+      addBookmark: string;
+      goToBookmark: string;
+      includeTimeExtent: string;
+      noBookmarksHeading: string;
+      noBookmarksDescription: string;
+      title: string;
+      titlePlaceholder: string;
+      invalidTitle: string;
+      addingBookmark: string;
+      invalidImageUrl: string;
+      imageUrlPlaceholder: string;
+      imageUrlTooltip: string;
+      thumbnail: string;
+      screenshot: string;
+      updateThumbnail: string;
+      none: string;
+      url: string;
+      timeExtent: string;
+      startDate: string;
+      endDate: string;
+      componentLabel: string;
+      add: string;
+      untitled: string;
+      edit: string;
+      loading: string;
+      delete: string;
+      cancel: string;
+      save: string;
+  }> & T9nMeta<{
+      addBookmark: string;
+      goToBookmark: string;
+      includeTimeExtent: string;
+      noBookmarksHeading: string;
+      noBookmarksDescription: string;
+      title: string;
+      titlePlaceholder: string;
+      invalidTitle: string;
+      addingBookmark: string;
+      invalidImageUrl: string;
+      imageUrlPlaceholder: string;
+      imageUrlTooltip: string;
+      thumbnail: string;
+      screenshot: string;
+      updateThumbnail: string;
+      none: string;
+      url: string;
+      timeExtent: string;
+      startDate: string;
+      endDate: string;
+      componentLabel: string;
+      add: string;
+      untitled: string;
+      edit: string;
+      loading: string;
+      delete: string;
+      cancel: string;
+      save: string;
+  }>;
+  /**
+   * 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;
+  /**
+   * Indicates whether to display the button to add a new bookmark.
+   *
+   * @default false
+   * @since 4.30
+   */
+  accessor showAddBookmarkButton: boolean;
+  /**
+   * Indicates whether to display the close button.
+   *
+   * @default false
+   * @since 4.30
+   */
+  accessor showCloseButton: boolean;
+  /**
+   * Indicates whether to display the collapse button.
+   *
+   * @default false
+   * @since 4.30
+   */
+  accessor showCollapseButton: boolean;
+  /**
+   * Indicates whether to display the button to edit a bookmark.
+   *
+   * @default false
+   * @since 4.30
+   */
+  accessor showEditBookmarkButton: boolean;
+  /**
+   * Indicates whether to display the bookmark filter.
+   *
+   * @default false
+   * @since 4.30
+   */
+  accessor showFilter: boolean;
+  /**
+   * Indicates whether to display the heading.
+   *
+   * @default false
+   * @since 4.30
+   */
+  accessor showHeading: boolean;
+  /**
+   * The current state of the component.
+   *
+   * @default "ready"
+   */
+  get state(): BookmarksViewModelState;
+  /**
+   * Indicates whether to disable the time capability of the Bookmarks component.
+   *
+   * @default false
+   * @since 4.34
+   */
+  accessor timeDisabled: boolean | 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 Bookmarks component will be associated with a map or scene component rather than using the `view` property.
+   */
+  accessor view: MapView | SceneView | undefined;
+  /** Permanently destroy the component. */
+  destroy(): Promise<void>;
+  /**
+   * Zoom to a specific bookmark.
+   *
+   * @param bookmark
+   * @since 4.34
+   */
+  goTo(bookmark: __esri.Bookmark): Promise<void>;
+  /**
+   * Fires when a [Bookmark](https://developers.arcgis.com/javascript/latest/api-reference/esri-webmap-Bookmark.html) is edited.
+   *
+   * @since 4.34
+   * @example
+   * ```js
+   * // once an edit has been made, enable the "Save Webmap" button
+   * //    to allow the user to save their changes
+   * bookmarksElement.addEventListener("arcgisBookmarkEdit", (event) => {
+   *    saveBtn.disabled = false;
+   * });
+   * ```
+   */
+  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.
+   *
+   * @since 4.34
+   * @example
+   * ```html
+   * <arcgis-expand expanded>
+   *  <arcgis-bookmarks></arcgis-bookmarks>
+   * </arcgis-expand>
+   *
+   * <script>
+   *   const bookmarksElement = document.querySelector("arcgis-bookmarks");
+   *   const expandElement = document.querySelector("arcgis-expand");
+   *
+   *   // collapses the associated Expand component
+   *   // when a bookmark is selected
+   *   bookmarksElement.addEventListener("arcgisBookmarkSelect", (event) => {
+   *     expandElement.expanded = false;
+   *   });
+   * </script>
+   * ```
+   */
+  readonly arcgisBookmarkSelect: import("@arcgis/lumina").TargetedEvent<this, BookmarkSelectEvent>;
+  /** Emitted when the component's close button is clicked. */
+  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>;
+  readonly "@eventTypes": {
+    arcgisBookmarkEdit: ArcgisBookmarks["arcgisBookmarkEdit"]["detail"];
+    arcgisBookmarkSelect: ArcgisBookmarks["arcgisBookmarkSelect"]["detail"];
+    arcgisClose: ArcgisBookmarks["arcgisClose"]["detail"];
+    arcgisPropertyChange: ArcgisBookmarks["arcgisPropertyChange"]["detail"];
+    arcgisReady: ArcgisBookmarks["arcgisReady"]["detail"];
+  };
+}