import type Accessor from "../../core/Accessor.js";

export interface BookmarksVisibleElementsProperties extends Partial<Pick<BookmarksVisibleElements, "addBookmarkButton" | "closeButton" | "collapseButton" | "editBookmarkButton" | "filter" | "flow" | "heading" | "thumbnail" | "time">> {}

/**
 * The visible elements that are displayed within the widget.
 * This provides the ability to turn individual elements of the widget's display on/off.
 *
 * ![bookmarks-visibleElements](https://developers.arcgis.com/javascript/latest/assets/img/apiref/widgets/bookmarks-visibleElements.png)
 */
export default abstract class BookmarksVisibleElements extends Accessor {
  /**
   * _Since 4.29._ Indicates whether the button to add a new bookmark displays.
   *
   * @default false
   */
  accessor addBookmarkButton: boolean;
  /**
   * _Since 4.29._ Indicates whether to display a close button at the top of the widget.
   *
   * @default false
   */
  accessor closeButton: boolean;
  /**
   * _Since 4.29._ Indicates whether to display a collapse button at the top of the widget.
   *
   * @default false
   */
  accessor collapseButton: boolean;
  /**
   * _Since 4.29._ Indicates whether the button to edit a bookmark displays.
   *
   * @default false
   */
  accessor editBookmarkButton: boolean;
  /**
   * _Since 4.29._ Indicates whether the bookmarks filter displays.
   *
   * @default false
   */
  accessor filter: boolean;
  /**
   * _Since 4.29._ Determines whether the widget 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 widget will be displayed within its original flow component if set to `true`. The flow component will be omitted from the widget if set to `false`. To place the widget into an existing Calcite flow component, set this property to `false`.
   *
   * @default true
   */
  accessor flow: boolean;
  /**
   * _Since 4.29._ Indicates whether to display the widget heading. The heading text is "Bookmarks".
   *
   * @default false
   */
  accessor heading: boolean;
  /**
   * _Since 4.13._ Indicates whether the thumbnail associated with the bookmark displays.
   *
   * @default true
   */
  accessor thumbnail: boolean;
  /**
   * _Since 4.22._ Indicates whether the time (`h:m:s`) is displayed alongside the date if the bookmark has a [time extent](https://developers.arcgis.com/javascript/latest/api-reference/esri-webmap-Bookmark.html#timeExtent) defined.
   *
   * @default true
   */
  accessor time: boolean;
}