Skip to main content

UI Prompt Field

Category: User Interface UI Prompt Field block screenshot

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

InputRequiredValue KindTypesEnum Values
kindyesexpressionenum-stringTEXT, NUMBER, MULTILINE, CHECKBOX, SELECT, FILE, FOLDER, PROJECT_ITEM_REF, PROJECT_BIN_REF, SEQUENCE_CLIP_REF, LABEL
labelyesexpressionstring
varnoexpressionvariable-name
requirednoexpressionboolean
optionsnoexpressionarray
defaultValuenoexpressionstring, number, boolean, reference, array

Notes

No additional notes are available yet.

See Also

  • Building Prompt Dialogs: Explains how UI Prompt Field and UI Prompt Form work together to build custom dialogs.
  • UI Prompt Form: Shows a dialog built from one or more UI Prompt Field definitions.

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.

kind: Pattern · format: runtime-dsl · validation: MCP fixture

Topics: dialogs, user input

Source: patterns/ex-ui-build-prompt-form.json

Download 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.

kind: Recipe · format: persisted-document · validation: Schema only

Topics: markers, subtitles, SRT export, save dialogs, marker comments

Source: recipes/ex-markers-export-active-sequence-to-srt.json

Download 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.

kind: Recipe · format: persisted-document · validation: Schema only

Topics: markers, YouTube chapters, text export, clipboard workflows, save dialogs, marker comments

Source: recipes/ex-markers-export-active-sequence-to-youtube-chapter-text.json

Download JSON