Dialogs

Native dialogs, a searchable picker, and modal web views. All work from pages, scripts, and background scripts. On pages they return Promises. In scripts, dialogs block until answered, but the picker and modal web views don't; see their sections.

Dialogs

const choice = await muxy.dialog.confirm({
  title: "Delete branch?",
  message: "This can't be undone.",
  buttons: ["Delete", "Cancel"],
  default: "Delete",
  cancel: "Cancel",
});   // the clicked button's label, or null for the cancel button

await muxy.dialog.alert({ title: "Done", message: "All tests passed" });
const name = await muxy.dialog.prompt({ title: "Branch name", placeholder: "feature-x" });
const folder = await muxy.dialog.pickFolder({ title: "Choose a folder" });

• confirm takes up to three buttons. prompt and pickFolder resolve to null when cancelled.
• One dialog per extension at a time. Text is limited to 2,000 characters.

Picker

A command-palette style list to choose from.

const item = await muxy.modal.open({
  placeholder: "Pick a branch",
  items: [{ id: "main", title: "main", subtitle: "default" }, { id: "dev", title: "dev" }],
});   // the chosen item, or null

• items can be an array, or a function that receives emit to stream items in batches.
• onQuery(query, emit) reloads items as the user types, for searches against a large or remote source.
• emptyLabel and noMatchLabel set the empty-state text.
• In scripts and background scripts, modal.open returns right away; pass onSelect(item) to get the choice.
• Up to 100,000 items.

Modal web views

A centered page for a custom form or flow. Needs panels:write.

const result = await muxy.modal.openWebview({
  entry: "dialogs/new-item.html",
  width: 480,
  height: 320,
  data: { kind: "note" },
});

Inside the modal page:

await muxy.modal.submitWebview({ title: "My note" });   // resolves openWebview with this
await muxy.modal.closeWebview();                         // resolves it with null

The size is kept within 120–900 × 120–760, and results up to 256 KiB. Clicking outside closes the modal unless dismissOnOutsideClick is false. A command can open one directly with the openModal action.