| name | mini-apps |
| description | Guide for building custom interactive web apps ("mini apps") displayed in browser tabs — scaffolding, iframe constraints, bidirectional messaging with the sandbox, and iteration workflows. |
Mini Apps
Mini apps are custom interactive web apps that render in dedicated stagewise browser tabs. Useful for dashboards, visualizations, forms, interactive tools, and any UI that benefits from rich HTML/CSS/JS beyond plain text.
Apps Directory (apps/)
The apps/ mount is always available with full read-write permissions. Each app lives in its own subfolder with index.html as the required entry point. Optional sibling assets (styles.css, script.js, images, etc.) are resolved via relative references.
apps/{appId}/
index.html ← entry point (required)
styles.css ← optional
script.js ← optional
Writing App Files
Create and edit app files (index.html, styles.css, script.js), then open or reload via the sandbox with await API.openApp("appId", { title: 'Readable title' }).
Iframe Constraints
- Renders inside a dedicated browser tab with normal Stagewise browser chrome.
- The app itself is sandboxed in an
app:// iframe inside a trusted stagewise://internal/preview/{appId} shell.
- Design responsively. Always include responsive base styles and a viewport meta tag.
Opening Apps (Sandbox)
Use API.openApp(appId, opts?) from the sandbox. The sandbox is used only for opening apps and communicating with them.
