DialogAPI
Reference — DialogAPI in the Mutka module API.
Interface: DialogAPI
Defined in: types.ts:128
Methods
choose()
choose(options): Promise<string | null>;Defined in: types.ts:134
Show a single-choice list. Resolves with the chosen option's value, or null if cancelled.
Parameters
| Parameter | Type |
|---|---|
options | DialogChooseOptions |
Returns
Promise<string | null>
confirm()
confirm(options): Promise<boolean>;Defined in: types.ts:132
Show a yes/no confirmation dialog. Resolves with true (confirm) or false (cancel).
Parameters
| Parameter | Type |
|---|---|
options | DialogConfirmOptions |
Returns
Promise<boolean>
pickFile()
pickFile(options?): Promise<string | null>;Defined in: types.ts:136
Open a Mutka file browser to pick one file. Resolves with its path, or null if cancelled.
Parameters
| Parameter | Type |
|---|---|
options? | DialogPickFileOptions |
Returns
Promise<string | null>
prompt()
prompt(options): Promise<string | null>;Defined in: types.ts:130
Show a text-input dialog. Resolves with the entered string or null if cancelled.
Parameters
| Parameter | Type |
|---|---|
options | DialogPromptOptions |
Returns
Promise<string | null>