api.ui

Milliseconds before it leaves on its own; 0 keeps it until dismissed.

One button beside the text, for a notice that is really a question — the update check's "Download". Pressing it dismisses the toast as well as running this.

Return false (or a promise of it) to keep the dialog open.

Close after run; default true.

Fill body (an empty <div> inside the dialog); return a cleanup if you need one.

Footer buttons, left to right; a single Close when omitted.

Ctrl+V anywhere in the dialog (while it is the topmost one). Files come from the clipboard's items — a screenshot pastes as one image/png file — and text is the plain-text part, so a copied image URL arrives here too.

Something dropped onto the dialog body.

Escape normally closes the dialog. Answer true to keep it open for this press — when the key was meant for something inside the dialog that handles Escape itself (a code editor dismissing its own popups), judged by the element it landed on.

Whether the dialog is still on screen.

Change the title strip's text.

In CSS pixels; 260 by default. The panel is as tall as its content, up to the map's height.

Fill body (an empty <div> inside the panel); return a cleanup if you need one.

The panel closed, whichever way.

Map pixels. Kept inside the map while a button is held, as the built-in brushes do.

The tile under the pointer.

False once the pointer has left the map with no button held.

Whether the primary button is held.

Canvas pixels per tile.

A map pixel's x on the canvas.

The tiles on screen.

Shown in the viewport's HUD and the status bar while the tool runs.

After the name: "drag to draw a line".

CSS cursor over the map; "crosshair" by default.

Every pointer move over the map, button held or not, and once with inMap: false when it leaves.

Esc or a right-click. Return true to keep the tool running (you cancelled a gesture of your own); otherwise it stops.

Draw over the map, after everything else, each time the viewport repaints.

The tool is no longer running, for whatever reason (once).

Repaint the viewport — and so call draw — now. Cheap; call it from onMove.

Shown in View ▸ Overlays and the Layers panel. Unique per plugin.

Start visible; true by default. What the user last set for this name wins for the session.

Where the picture goes in the paint pass; "terrain" by default.

Draw in canvas pixels through view, each time the viewport repaints while visible.

The pointer over the map while the overlay is visible, on every layer and while a map tool runs; null once when it leaves. Call handle.redraw() here to move a hover mark. A press sets down but is never captured for you.

The overlay was shown or hidden, by the user in the chrome or by your handle.

Repaint the viewport — and so call draw — now.

Take the overlay out of the chrome for good; isVisible is false from then on.

Shown in the viewport's HUD while the user picks; also the status line.

accept for the file input, e.g. "image/*" or ".png,.jpg".

The primary button; OK by default.

Paint the primary button as a destructive action.

A multi-line field.

Show a Cancel button; cancelled() answers true once it is pressed.

How far along (0…1), and optionally a line under the bar.

True once the user pressed Cancel or closed the panel. Poll it inside a loop.

The same answer as a signal, for work that takes one: aborted when the user cancels, so fetch(url, { signal }) and anything built on AbortSignal stop with the panel. Never aborted by done().

A radio button instead; give the group a name.

Dimmed text at the end of the row.

A number in the row's gutter, as the editor's own lists show indices.

Which row starts selected.

Maximum height in pixels; the list scrolls past it.

A two-column grid of labelled fields.

A titled box (a fieldset with a legend, as the dialogs use).

Small dimmed explanatory text.