Interface ToggleOverlay

It opens an overlay if it is not already opened or closes it if it is already opened.

interface ToggleOverlay {
    destination: Board;
    relativeTo?: Shape;
    position?:
        | "center"
        | "manual"
        | "top-left"
        | "top-right"
        | "top-center"
        | "bottom-left"
        | "bottom-right"
        | "bottom-center";
    manualPositionLocation?: Point;
    closeWhenClickOutside?: boolean;
    addBackgroundOverlay?: boolean;
    animation?: Animation;
    type: "toggle-overlay";
}

Hierarchy (view full)

Properties

destination relativeTo? position? manualPositionLocation? closeWhenClickOutside? addBackgroundOverlay? animation? type

Properties

Readonlydestination

destination: Board

Overlay board that will be opened.

Optional ReadonlyrelativeTo

relativeTo?: Shape

Base shape to which the overlay will be positioned taking constraints into account.

Optional Readonlyposition

position?:
    | "center"
    | "manual"
    | "top-left"
    | "top-right"
    | "top-center"
    | "bottom-left"
    | "bottom-right"
    | "bottom-center"

Positioning of the overlay.

Optional ReadonlymanualPositionLocation

manualPositionLocation?: Point

For position = 'manual' the location of the overlay.

Optional ReadonlycloseWhenClickOutside

closeWhenClickOutside?: boolean

When true the overlay will be closed when clicking outside

Optional ReadonlyaddBackgroundOverlay

addBackgroundOverlay?: boolean

When true a background will be added to the overlay.

Optional Readonlyanimation

animation?: Animation

Animation displayed with this interaction.

Readonlytype

type

The action type

Settings

Member Visibility

On This Page

Properties