Document YAML Schema
Document YAML files define how documents are rendered in the Loopstack Studio interface.
Top-Level Properties
type (optional)
type: documentIdentifies this configuration as a document. Default: document.
description (optional)
description: 'Contains structured meeting notes with action items'tags (optional)
Labels for categorizing and filtering documents:
tags:
- meeting-notes
- processedui
Defines how the document renders in the UI.
UI Widgets
Form Widget
ui:
widgets:
- widget: form
options:
order: [date, summary, participants, actionItems]
properties:
date:
title: Date
summary:
title: Summary
widget: textarea
participants:
title: Participants
collapsed: true
items:
title: Participant
actionItems:
title: Action Items
collapsed: true
items:
title: Action Item
actions:
- type: button
transition: confirm
label: 'Confirm'Form Field Properties
| Property | Type | Description |
|---|---|---|
widget | string | Widget type (see below) |
label | string | Field label |
title | string | Section title |
description | string | Field description |
placeholder | string | Placeholder text |
help | string | Help text below the field |
rows | number | Visible rows (for textarea) |
inline | boolean | Display field inline |
readonly | boolean | Make field read-only |
hidden | boolean | Hide the field |
disabled | boolean | Disable interaction |
collapsed | boolean | Collapse arrays/objects by default |
fixed | boolean | Fixed field |
order | string[] | Display order of nested fields |
enumOptions | array | Options for select/radio widgets |
items | object | UI config for array items |
properties | object | UI config for nested object fields |
Widget Types
| Widget | Description |
|---|---|
text | Single-line text input (default) |
textarea | Multi-line text area |
select | Dropdown select |
radio | Radio button group |
checkbox | Checkbox |
switch | Toggle switch |
slider | Numeric slider |
code-view | Code editor with syntax highlighting |
enumOptions
For select and radio widgets:
language:
title: Language
widget: select
enumOptions:
- label: Python
value: python
- label: JavaScript
value: javascriptOr as simple strings:
enumOptions:
- python
- javascript
- javaActions
Buttons that trigger wait: true transitions:
actions:
- type: button
transition: confirm # Must match the method name
label: 'Confirm'
- type: button
transition: reject
label: 'Reject'Meta Properties
Meta properties are set via the options parameter of this.documentStore.save():
await this.documentStore.save(MyDocument, content, {
id: 'doc-1',
meta: {
hidden: true,
},
});| Property | Type | Description |
|---|---|---|
hidden | boolean | Hide from the UI |
mimeType | string | Content MIME type |
enableAtPlaces | string[] | Places where the document is editable |
hideAtPlaces | string[] | Places where the document is hidden |
invalidate | boolean | Mark document as invalidated |
level | string | Severity level: debug, info, warning, error |
data | any | Arbitrary metadata |
Supported MIME Types
text/plain, text/html, text/markdown, text/css, text/xml, application/json, application/javascript, application/typescript, application/yaml, application/xml
Complete Example
type: document
description: 'Generated code file'
tags:
- code
- generated
ui:
widgets:
- widget: form
options:
order: [filename, description, code]
properties:
filename:
title: File Name
readonly: true
description:
title: Description
readonly: true
widget: textarea
code:
title: Code
widget: code-view
actions:
- type: button
transition: confirm
label: 'Accept'Last updated on