@dso-toolkit/core 54.2.1 → 55.0.0

package/dist/types/components/map-controls/map-controls.d.ts

@@ -3,9 +3,25 @@ import { MapControlsToggleEvent } from "./map-controls.interfaces";
 export declare class MapControls {
   #private;
   private panelTitle;
+  /**
+   * To show and hide the Map Controls.
+   */
   open: boolean;
+  /**
+   * To disable the zoom controls:
+   *
+   * * `in`: Disable zoom in button.
+   * * `out`: Disable zoom out button.
+   * * `both`: Disable zoom in and zoom out.
+   */
   disableZoom?: "in" | "out" | "both";
+  /**
+   * Emitted when the user activates the zoom in button.
+   */
   dsoZoomIn: EventEmitter<MouseEvent>;
+  /**
+   * Emitted when the user activates the zoom out button.
+   */
   dsoZoomOut: EventEmitter<MouseEvent>;
   /**
    * emits when the panel opens or closes.
@@ -16,6 +32,12 @@ export declare class MapControls {
   dsoToggle: EventEmitter<MapControlsToggleEvent>;
   hideContent: boolean;
   watchOpen(open: boolean): void;
+  /**
+   * Emitted when the visibility is toggled.
+   *
+   * Can be used to recalculate map widths or reposition center when the Map Controls opens or closes.
+   * @param e
+   */
   toggleVisibility(e: MouseEvent | KeyboardEvent): Promise<void>;
   render(): any;
 }

package/dist/types/components/map-controls/map-controls.interfaces.d.ts

@@ -1,4 +1,3 @@
-export declare const transitionDuration = 300;
 export interface MapControlsToggleEvent {
   originalEvent?: MouseEvent | KeyboardEvent;
   open: boolean;

package/dist/types/components/map-overlays/map-overlays.d.ts

@@ -1,15 +1,21 @@
 import { EventEmitter, ComponentInterface } from "../../stencil-public-runtime";
 import { Overlay, OverlayChangeEvent } from "./map-overlays.interfaces";
-import { SelectableChangeEvent } from "../selectable/selectable.interfaces";
 export declare class MapOverlays implements ComponentInterface {
-  previousOverlays: Overlay[] | undefined;
-  selectableRefs: {
-    [id: number]: HTMLDsoSelectableElement;
-  };
+  private previousOverlays;
+  private selectableRefs;
+  /**
+   * To group the overlays together. Generally the default value suffices.
+   */
   group: string;
+  /**
+   * The overlays.
+   */
   overlays: Overlay[];
+  /**
+   * Emitted when the user selects a different overlay.
+   */
   dsoToggleOverlay: EventEmitter<OverlayChangeEvent>;
-  overlayChangeHandler(overlay: Overlay, e: CustomEvent<SelectableChangeEvent>): void;
+  private overlayChangeHandler;
   componentDidRender(): void;
   render(): any;
 }

package/dist/types/components/modal/modal.d.ts

@@ -5,20 +5,32 @@ export declare class Modal implements ComponentInterface {
   private trap?;
   private dialogElement?;
   private modalElement?;
-  host: HTMLElement;
+  host: HTMLDsoModalElement;
   ariaId: string;
   hasFooter?: boolean;
+  /**
+   * The title of the Modal.
+   */
   modalTitle?: string;
-  /** the role for the modal `dialog` | `alert` | `alertdialog` defaults to `dialog` */
+  /**
+   * the role for the modal `dialog` | `alert` | `alertdialog`.
+   */
   role: string | null;
-  /** when `false` the close button in the header will not be rendered. Defaults to `true` */
+  /**
+   * when `false` the close button in the header will not be rendered. Defaults to `true`.
+   */
   showCloseButton: boolean;
-  /** Selector used to query the element which will be focused when the component instantiated. When undefined the modal focuses the first button.dso-primary in the modal footer. If no button can be found the close button is focused.*/
+  /**
+   * Selector used to query the element which will be focused when the component instantiated. When undefined the modal focuses the first button.dso-primary in the modal footer. If no button can be found the close button is focused.
+   */
   initialFocus?: string;
   /**
    * Function that returns the element to focus on Modal close. Return `false` for no focus restore.
    */
   returnFocus?: (nodeFocusedBeforeActivation: HTMLElement | SVGElement) => FocusTargetValueOrFalse;
+  /**
+   * Emitted when the user wants to close the Modal.
+   */
   dsoClose: EventEmitter<DsoModalCloseEvent>;
   componentWillLoad(): void;
   componentDidLoad(): void;

package/dist/types/components/modal/modal.interfaces.d.ts

@@ -1,8 +1,8 @@
 export interface DsoModalCloseEvent {
   originalEvent?: MouseEvent;
 }
-export declare type ModalRole = "dialog" | "alert" | "alertdialog";
-export declare type AllowedModalContentTypes = HTMLElement | DocumentFragment | string;
+export type ModalRole = "dialog" | "alert" | "alertdialog";
+export type AllowedModalContentTypes = HTMLElement | DocumentFragment | string;
 export interface ModalContent {
   title?: string;
   body: AllowedModalContentTypes;

package/dist/types/components/ozon-content/ozon-content.d.ts

@@ -26,13 +26,16 @@ export declare class OzonContent implements ComponentInterface {
    */
   interactive: "sub" | "" | boolean;
   state: OzonContentNodeState;
+  /**
+   * Emitted when `<a>` is clicked.
+   */
   dsoAnchorClick: EventEmitter<OzonContentAnchorClick>;
   /**
    * These events are only emitted when the component is `interactive`.
    */
   dsoClick: EventEmitter<OzonContentClick>;
-  host: HTMLElement;
+  host: HTMLDsoOzonContentElement;
   private mapper;
-  handleHostOnClick(e: UIEvent): void;
+  private handleHostOnClick;
   render(): JSX.Element;
 }

package/dist/types/components/pagination/pagination.d.ts

@@ -4,7 +4,7 @@ import { PaginationSelectPageEvent } from "./pagination.interfaces";
 export declare class Pagination implements ComponentInterface {
   private sizePositionsMap;
   private responsiveElement?;
-  host: HTMLElement;
+  host: HTMLDsoPaginationElement;
   availablePositions?: number;
   /**
    * Total pages
@@ -26,7 +26,7 @@ export declare class Pagination implements ComponentInterface {
    * Listens to the dsoSizeChange event on Responsive Element
    */
   sizeChangeHandler(event: CustomEvent<ResponsiveElementSize>): void;
-  clickHandler(e: MouseEvent, page: number): void;
+  private clickHandler;
   componentDidLoad(): void;
   render(): any;
   private getAvailablePositions;

package/dist/types/components/progress-bar/progress-bar.d.ts

@@ -1,6 +1,15 @@
 export declare class ProgressBar {
+  /**
+   * The current progress. Should be between `min` and `max`.
+   */
   progress: number;
+  /**
+   * From where progress is made.
+   */
   min: number;
+  /**
+   * When the operation completes.
+   */
   max: number;
   render(): any;
 }

package/dist/types/components/progress-indicator/progress-indicator.d.ts

@@ -1,6 +1,17 @@
 export declare class Progressindicator {
-  label?: string;
+  /**
+   * The label of the Progress Indicator.
+   */
+  label: string;
+  /**
+   * The size (width) of the Progress Indicator.
+   *
+   * If no size is set, falls back to `small`.
+   */
   size?: "small" | "medium" | "large";
+  /**
+   * Set for bloatier Progress Indicator.
+   */
   block?: boolean;
   render(): any;
 }

package/dist/types/components/responsive-element/responsive-element.d.ts

@@ -3,10 +3,16 @@ import { ResponsiveElementSize } from "./responsive-element.interfaces";
 export declare class ResponsiveElement implements ComponentInterface {
   sizeAlias: ResponsiveElementSize;
   sizeWidth: number;
+  /**
+   * Emitted when size has changed
+   */
   dsoSizeChange: EventEmitter<ResponsiveElementSize>;
+  /**
+   * The current size
+   */
   getSize(): Promise<ResponsiveElementSize>;
-  observer: ResizeObserver;
-  host: HTMLElement;
+  private observer;
+  host: HTMLDsoResponsiveElementElement;
   componentWillLoad(): void;
   disconnectedCallback(): void;
   render(): any;

package/dist/types/components/responsive-element/responsive-element.interfaces.d.ts

@@ -1,4 +1,4 @@
-export declare type ResponsiveElementSize = "small" | "medium" | "large";
+export type ResponsiveElementSize = "small" | "medium" | "large";
 export interface ElementSize {
   width: number;
   alias: ResponsiveElementSize;

package/dist/types/components/scrollable/scrollable.d.ts

@@ -2,15 +2,16 @@ import { EventEmitter } from "../../stencil-public-runtime";
 import { DsoScrollEndEvent, ScrollPosition } from "./scrollable.interfaces";
 export declare class Scrollable {
   private mutationObserver;
-  scrollContainerDiv?: HTMLDivElement;
-  host: HTMLElement;
+  private scrollContainerDiv?;
+  private shadowContainerDiv?;
+  host: HTMLDsoScrollableElement;
   /**
    * Event emitted when the scrollbar has reached top or bottom.
    */
   dsoScrollEnd: EventEmitter<DsoScrollEndEvent>;
   scrollPosition: ScrollPosition;
   /**
-   * Internal method. Do not use.
+   * @internal
    */
   _setScrollState(): Promise<void>;
   private get slottedElements();

package/dist/types/components/scrollable/scrollable.interfaces.d.ts

@@ -1,4 +1,4 @@
-export declare type ScrollPosition = "noScroll" | "top" | "bottom" | "middle";
+export type ScrollPosition = "noScroll" | "top" | "bottom" | "middle";
 export interface DsoScrollEndEvent {
   scrollEnd: "top" | "bottom";
 }

package/dist/types/components/selectable/selectable.d.ts

@@ -1,21 +1,72 @@
 import { EventEmitter } from "../../stencil-public-runtime";
 import { SelectableChangeEvent } from "./selectable.interfaces";
 export declare class Selectable {
+  /**
+   * Type of Selectable.
+   *
+   * `checkbox`: Multiple options
+   * `radio`: Single option.
+   */
   type: "checkbox" | "radio";
+  /**
+   * To set `<input id>` attribute for external references.
+   */
   identifier?: string;
+  /**
+   * Name of the Selectable. Can be used to group Selectables.
+   */
   name?: string;
+  /**
+   * The value of the Selectable.
+   */
   value: string;
+  /**
+   * Set to true of the current value is not valid.
+   */
   invalid?: boolean;
+  /**
+   * To link this control to an element that describes it.
+   */
   describedById?: string;
+  /**
+   * To link this control to an element that labels it.
+   */
   labelledById?: string;
+  /**
+   * To disable the Selectable.
+   */
   disabled?: boolean;
+  /**
+   * To mark the Selectable as required.
+   */
   required?: boolean;
+  /**
+   * Mark the Selectable as checked
+   */
   checked?: boolean;
+  /**
+   * An indeterminate state is neither true or false. It means the answer is somewhere in between.
+   *
+   * Can be used to indicate child Selectables that are a mix of checked and unchecked.
+   */
   indeterminate?: boolean;
+  /**
+   * Set to true if the Info should not be toggled and always visible.
+   */
   infoFixed?: boolean;
+  /**
+   * Emitted when the user checks or unchecks the Selectable.
+   */
   dsoChange: EventEmitter<SelectableChangeEvent>;
-  host: HTMLElement;
+  host: HTMLDsoSelectableElement;
   infoActive: boolean;
+  keyboardFocus: boolean;
+  /**
+   * Method to toggle the Info. Is set to `active` when passed.
+   *
+   * If `active` is not passed, Info is toggled to opposite value.
+   * @param active
+   */
   toggleInfo(active?: boolean): Promise<void>;
   private mutationObserver?;
   private fallbackIdentifier;

package/dist/types/components/slide-toggle/slide-toggle.d.ts

@@ -2,15 +2,30 @@ import { ComponentInterface, EventEmitter } from "../../stencil-public-runtime";
 import { SlideToggleActiveEvent } from "./slide-toggle.interfaces";
 export declare class SlideToggle implements ComponentInterface {
   private host;
+  /**
+   * Set to true if Slide Toggle is checked.
+   */
   checked: boolean;
+  /**
+   * Disables the Slide Toggle, preventing it from checking/unchecking and therefor not emitting any events.
+   */
   disabled: boolean;
-  /** When provided the `<button>` will be labelled with `aria-label`. For a visible label provide a `<span>` inside the component */
+  /**
+   * When provided the `<button>` will be labelled with `aria-label`. For a visible label provide a `<span>` inside the component.
+   */
   accessibleLabel?: string;
-  /** Provide the `id` of the element that labels this element. this property sets the `aria-labelledby` on the switch button */
+  /**
+   * Provide the `id` of the element that labels this element. this property sets the `aria-labelledby` on the switch button.
+   */
   labelledbyId?: string;
   hasVisibleLabel?: boolean;
-  /** Provide an `id` for the `<button>`. Useful for placing your to place your own `<label for="id">` */
+  /**
+   * Provide an `id` for the `<button>`. Useful for placing your to place your own `<label for="id">`.
+   */
   identifier: string;
+  /**
+   * Emitted when user checks or unchecks the Slide Toggle.
+   */
   dsoActiveChange: EventEmitter<SlideToggleActiveEvent>;
   private handleSwitch;
   componentWillLoad(): void;

package/dist/types/components/table/table.d.ts

@@ -1,19 +1,22 @@
 import { ComponentInterface } from "../../stencil-public-runtime";
-import { TableInterface } from "./table.interfaces";
-export declare class Table implements ComponentInterface, TableInterface {
+export declare class Table implements ComponentInterface {
   private resizeObserver?;
   private focusTrapElement?;
   private buttonElement?;
   private trap?;
   private labelledbyId;
-  host: HTMLElement;
-  /** Prevents the table being opened in a modal. */
+  host: HTMLDsoTableElement;
+  /**
+   * Prevents the table being opened in a modal.
+   */
   noModal: boolean;
-  /** Indicates whether the table is currently horizontally scrollable */
+  /**
+   * Indicates whether the table is currently horizontally scrollable.
+   */
   isResponsive: boolean;
   modalActive: boolean;
   placeholderHeight?: number;
-  startResponsiveBehavior(): void;
+  private startResponsiveBehavior;
   componentWillLoad(): void;
   componentDidLoad(): void;
   componentDidRender(): void;

package/dist/types/components/toggletip/toggletip.d.ts

@@ -1,15 +1,27 @@
 export declare class Toggletip {
-  host: HTMLElement;
+  host: HTMLDsoToggletipElement;
   active: boolean;
+  /**
+   * Toggletip label.
+   */
   label: string;
+  /**
+   * Toggletip position.
+   */
   position: "top" | "right" | "bottom" | "left";
+  /**
+   * Set to true for small Toggletip.
+   */
   small?: boolean;
+  /**
+   * Set to true for secondary Toggletip.
+   */
   secondary?: boolean;
-  infoButton?: HTMLDsoInfoButtonElement;
-  click: () => void;
-  open: () => void;
-  close: () => void;
-  focusOutListener: (event: FocusEvent) => void;
-  keyDownListener: (event: KeyboardEvent) => void;
+  private infoButton?;
+  private click;
+  private open;
+  private close;
+  private focusOutListener;
+  private keyDownListener;
   render(): any;
 }

package/dist/types/components/tooltip/tooltip.d.ts

@@ -38,18 +38,18 @@ export declare class Tooltip {
   deactivate(): Promise<void>;
   watchPosition(): void;
   watchStrategy(): void;
-  setStrategy(): void;
+  private setStrategy;
   watchActive(): void;
   private element;
   private popper;
   private callbacks;
   private onMouseLeave;
   private hidden;
-  listenClick(e: MouseEvent): void;
+  private listenClick;
   componentDidLoad(): void;
   disconnectedCallback(): void;
   componentDidRender(): void;
-  keyDownListener: (event: KeyboardEvent) => void;
+  private keyDownListener;
   render(): any;
   private deactivatePopper;
   private activatePopper;

package/dist/types/components/tree-view/tree-view.d.ts

@@ -36,7 +36,7 @@ export declare class TreeView implements ComponentInterface {
    * @returns Whether the item was found.
    */
   focusItem(path: TreeViewItem[]): Promise<boolean>;
-  keyDownListener: (event: KeyboardEvent) => void;
+  private keyDownListener;
   itemClick: (event: MouseEvent, ancestors: TreeViewItem[], item: TreeViewItem) => void;
   private static setFocus;
   private static moveFocus;

package/dist/types/components/viewer-grid/viewer-grid.d.ts

@@ -1,10 +1,15 @@
 import { EventEmitter } from "../../stencil-public-runtime";
-import { FocusTrap } from "focus-trap";
 import { FilterpanelEvent, MainSize, ViewerGridChangeSizeEvent } from "./viewer-grid.interfaces";
 export declare class ViewerGrid {
   private sizeLabelMap;
   private mapPanel?;
+  /**
+   * Set to true when filterpanel should show.
+   */
   filterpanelOpen: boolean;
+  /**
+   * Set to true when overlay should show.
+   */
   overlayOpen: boolean;
   /**
    * Size of the main content panel when component loads. Changing this attribute afterwards has no effect.
@@ -13,28 +18,40 @@ export declare class ViewerGrid {
    */
   initialMainSize?: MainSize;
   mainSize: MainSize;
+  /**
+   * Emitted when user wants to close the overlay.
+   */
   dsoCloseOverlay: EventEmitter<MouseEvent | KeyboardEvent>;
+  /**
+   * Emitted when user cancels filterpanel.
+   */
   dsoFilterpanelCancel: EventEmitter<FilterpanelEvent>;
+  /**
+   * Emitted when user applies filterpanel options.
+   */
   dsoFilterpanelApply: EventEmitter<FilterpanelEvent>;
+  /**
+   * Emitted before and after main size animation. Inspect `detail` property for more information.
+   */
   dsoMainSizeChange: EventEmitter<ViewerGridChangeSizeEvent>;
-  host: HTMLElement;
-  filterpanel: HTMLElement | undefined;
-  filterpanelSlot: HTMLElement | null;
-  filterpanelFocustrap: FocusTrap | undefined;
-  overlay: HTMLDivElement | undefined;
-  overlaySlot: HTMLDivElement | null;
-  overlayFocustrap: FocusTrap | undefined;
+  host: HTMLDsoViewerGridElement;
+  private filterpanel;
+  private filterpanelSlot;
+  private filterpanelFocustrap;
+  private overlay;
+  private overlaySlot;
+  private overlayFocustrap;
   mainSizeWatcher(currentSize: MainSize, previousSize: MainSize): void;
-  shrinkMain: () => void;
-  expandMain: () => void;
-  updateFocusTrap(): void;
-  keyDownListener: (event: KeyboardEvent) => void;
+  private shrinkMain;
+  private expandMain;
+  private updateFocusTrap;
+  private keyDownListener;
   connectedCallback(): void;
   componentDidLoad(): void;
   componentWillLoad(): void;
   componentDidUpdate(): void;
   disconnectedCallback(): void;
-  handleFilterpanelApply(mouseEvent: MouseEvent): void;
-  handleFilterpanelCancel(mouseEvent: MouseEvent): void;
+  private handleFilterpanelApply;
+  private handleFilterpanelCancel;
   render(): any;
 }

package/dist/types/components/viewer-grid/viewer-grid.interfaces.d.ts

@@ -9,7 +9,7 @@ export interface ViewerGridChangeSizeEvent {
 export interface FilterpanelEvent {
   originalEvent: MouseEvent;
 }
-export declare type MainSize = "small" | "medium" | "large";
-export declare type LabelSizeMap = {
+export type MainSize = "small" | "medium" | "large";
+export type LabelSizeMap = {
   [key in MainSize]: string;
 };