Skip to main content

Building Prompt Dialogs

UI Prompt Field and UI Prompt Form are meant to be used together.

UI Prompt Field does not show a dialog on its own. It creates one field definition: for example a text field, checkbox, dropdown, file picker, multiple-file picker, or project-item picker. You usually create several of these field definitions first and collect them in a list.

UI Prompt Form is the block that actually opens the dialog. Its fields input expects a list of UI Prompt Field results. When the user confirms the dialog, each field writes its value back into the variable configured on that field.

Typical workflow:

  1. Create one or more UI Prompt Field blocks.
  2. Give each field a label and, if needed, a target variable.
  3. Combine the fields into a list.
  4. Pass that list into UI Prompt Form.
  5. Continue your graph with the variables that the dialog filled in.

Use cancelBehavior on UI Prompt Form to decide what should happen when the user closes the dialog without confirming:

  • STOP: abort the script immediately
  • EMPTY: continue and use empty values
  • DEFAULTS: continue with the configured defaults

For a file field, use FILE when the user should select one file and FILES when the user may select several files. Both kinds accept a types list such as ["srt"] to restrict the native picker to useful file formats. A FILES field writes the selected paths as a list.

When you only need filesystem paths, Open File Dialog, Open Files Dialog, Open Folder Dialog, or Save File Dialog are often the simpler choice. Use UI Prompt Field plus UI Prompt Form when you want file selection and other settings in one dialog.