UI Prompt Field
Creates one field definition that can later be shown inside a prompt dialog. Use kind to limit the block to TEXT, NUMBER, MULTILINE, CHECKBOX, SELECT, FILE, FOLDER, PROJECT_ITEM_REF, PROJECT_BIN_REF, SEQUENCE_CLIP_REF, or LABEL items. Use options for selectable field kinds such as dropdowns. If defaultValue is set, the prompt field starts with that value. Set required to prevent the form from being submitted without a value.
Inputs
| Input | Required | Value Kind | Types | Enum Values |
|---|---|---|---|---|
kind | yes | expression | enum-string | TEXT, NUMBER, MULTILINE, CHECKBOX, SELECT, FILE, FOLDER, PROJECT_ITEM_REF, PROJECT_BIN_REF, SEQUENCE_CLIP_REF, LABEL |
label | yes | expression | string | — |
var | no | expression | variable-name | — |
required | no | expression | boolean | — |
options | no | expression | array | — |
defaultValue | no | expression | string, number, boolean, reference, array | — |
Notes
No additional notes are available yet.
See Also
- Building Prompt Dialogs: Explains how
UI Prompt FieldandUI Prompt Formwork together to build custom dialogs. - UI Prompt Form: Shows a dialog built from one or more
UI Prompt Fielddefinitions.
Examples
Build A Prompt Dialog
Shows how to build a multi-field dialog from several `UI Prompt Field` values and one `UI Prompt Form` block.
Topics: dialogs, user input
Source: patterns/ex-ui-build-prompt-form.json
Export Sequence Markers To SRT
Prompts for the subtitle text source first, then exports active-sequence markers to an `.srt` file while skipping empty resolved text and zero-duration markers.
Topics: markers, subtitles, SRT export, save dialogs, marker comments
Source: recipes/ex-markers-export-active-sequence-to-srt.json
Export Sequence Markers To YouTube Chapter Text
Prompts for the chapter title source and output mode, then exports active-sequence markers as YouTube chapter lines to the clipboard or a `.txt` file while skipping empty resolved text.
Topics: markers, YouTube chapters, text export, clipboard workflows, save dialogs, marker comments
Source: recipes/ex-markers-export-active-sequence-to-youtube-chapter-text.json