Class: OverlayController

Controls UI overlays for the canvases, including dialogs and tasks.

Properties

Property	Modifier	Type
events	readonly	Events<OverlayControllerEvents>

Accessors

openedDialog

get openedDialog(): undefined | OpenedDialog

Currently open dialog.

Returns undefined if no dialog is opened.

Returns

undefined | OpenedDialog

Defined in

editor/overlayController.tsx:112

Methods

hideDialog()

hideDialog(): void

Closes currently open dialog if any is active.

Returns

void

See

showDialog

Defined in

editor/overlayController.tsx:349

---

showDialog()

showDialog(params): void

Shows on-canvas dialog anchored to the target element or link.

Parameters

Parameter	Type	Description
params	object	‐
params.content	ReactElement<any, string | JSXElementConstructor<any>>	Dialog content.
params.dialogType?	OverlayDialogType	Well-known dialog type to check later if a specific dialog is currently open.
params.holdSelection?	boolean	Whether to prevent selection changes while dialog is open. Default false
params.onClose?	() => void	Callback which is called when dialog is closed for any reason (e.g. when another dialog is opened).
params.style	DialogStyleProps	Dialog style, placement and sizing options.
params.target?	Element | Link	Element or link to anchor dialog to.

Returns

void

See

hideDialog

Defined in

editor/overlayController.tsx:268

---

showSpinnerWhile()

showSpinnerWhile(operation): void

Creates a task via startTask for the operation defined by a Promise.

Parameters

Parameter	Type
operation	Promise<unknown>

Returns

void

See

startTask

Defined in

editor/overlayController.tsx:207

---

startTask()

startTask(params): OverlayTask

Starts a new foreground task which blocks canvas interaction and displays a loading indicator until the task has ended.

If multiple tasks are started at any given time, an indicator will be shown while at least one of them is still active.

Parameters

Parameter	Type	Description
params	object	‐
params.delay?	number	Delay in milliseconds before displaying loading indicator to avoid showing it in case the task ends quickly. Default 0
params.title?	string	Task title to display.

Returns

OverlayTask

Defined in

editor/overlayController.tsx:152