-
Notifications
You must be signed in to change notification settings - Fork 42
example form record editor
github-actions[bot] edited this page Sep 22, 2026
·
1 revision
Use the standard component loader described in the component reference. This example is client-side form handling; authorization and persistence still belong on the server.
<os-form submit-label="Save" show-reset="false">
<os-text-field name="title" label="Title" required></os-text-field>
<os-switch name="pinned" label="Pinned"></os-switch>
<os-range-field name="progress" label="Progress" min="0" max="100"></os-range-field>
<os-color-field name="color" label="Color"></os-color-field>
<os-tag-input name="tags" label="Tags" creatable removable></os-tag-input>
</os-form>import type { OsForm, OsTagInput } from 'openstation';
const form = host.querySelector<OsForm>('os-form')!;
const tags = host.querySelector<OsTagInput>('os-tag-input')!;
form.setValues({ title: 'Ship app', pinned: true, progress: '65',
color: '#cc3344', tags: [{ label: 'release' }] });
// Tags are controlled: the app owns add/remove policy (such as deduplication).
tags.addEventListener('os-tag-add', (event) => {
const { tag } = (event as CustomEvent).detail;
tags.value = [...tags.value.filter((item) => item.label !== tag.label), tag];
});
tags.addEventListener('os-tag-remove', (event) => {
const { tag } = (event as CustomEvent).detail;
tags.value = tags.value.filter((item) => item.label !== tag.label);
});
form.addEventListener('os-form-submit', async (event) => {
const { values } = (event as CustomEvent).detail;
form.setBusy(true);
form.setError(null);
try {
// saveRecord is your authenticated persistence function.
await saveRecord({ ...values, progress: Number(values.progress) });
} catch (error) {
form.setError(error instanceof Error ? error.message : String(error));
} finally {
form.setBusy(false);
}
});Use setValues() to load another record or clear a new-record form.
reset() restores mount-time defaults; it does not revert server data or clear an
app's selected record ID. If using the Reset button in an editor, handle
os-form-reset to keep selection state consistent, or hide it and supply a New action.
This wiki is generated from the docs/ directory — edits made here are overwritten by the next sync.
To change a page, open a pull request against docs/.
Guides
- Development guide
- Releasing openstation
- Agents security model
- API Index
- The App Framework — a window in one PHP file
- Architecture
- Bridge protocol — wiring overview
- <os-*> component reference
- Data model — where OpenStation keeps its data
- Native Desktop Host — Experimental
- Desktop themes
- Dock customization — two registries, one mental model
- The event-driven framework
- Files on the Desktop
- Folder sharing
- Getting Started
- Hooks Reference
- Icons
- JavaScript Reference
- The Living Tree — algorithm definition
- Window-scoped MIO
- Mio
- Mobile — the phone layer
- Multisite
- Native Windows & Framework Interop
- OpenStation Network
- Plugin compatibility layer
- Progressive Web App (PWA)
- Station Home
- Using openstation from your own plugin
- Workspaces
Migration notes
- Migration: built-in activity channels move to the os/ namespace
- Migration — Code Blue becomes an App Framework app
- Migration — AI comment scoring leaves core
- Migration: window, wallpaper and widget bundles load on demand
- Migration — Posts, Pages, Users, User Edit, Plugins and Comments become App Framework apps
- Migration — the navigation model
- Migration — OpenStation Preferences becomes an App Framework app
- Performance settings move to Extended options
- Presence storage migration
- Migration — the Recycle Bin becomes an App Framework app
- Migration — the shell boots from its own screen
- Migration — Station Home becomes an App Framework app
- Migration: a native window's tabs move to the window chrome
- Migration — WP Explorer becomes the my-wordpress app
- Migration — WordPress package globals are no longer ambient
More
All examples
- AI Agents — extend and invoke from a plugin
- wp.os.ai.ask() — programmatic AI Copilot
- Tune the AI model config
- App layout recipes
- Open a child window its owner can't cover
- Style a specific admin page inside the iframe
- Code Blue — register your plugin's log file
- Open a file in the Code editor (deep-link from any window)
- Connect to a window — title-bar button + iframe pub/sub
- Content changes — live-refresh every window listing your type
- Custom window chrome (Experimental)
- Register a custom unfocused-window effect
- Example: render a data table
- Real file storage — react to uploads, gate policy, share from PHP
- React to a window being set free onto the real desktop
- Cross-window devtools — instrumentation primitives
- Add a dock item with a badge
- Decorate the dock without forking the renderer
- Replace the dock rail entirely
- Retune the Drafts widget's AI writing assistant
- Edit a record with one form values map
- Gate OpenStation by role
- Iframe-initiated window opens
- Build a feed reader without the bookkeeping
- Inject data into openStationConfig
- Render a list without losing clicks — renderKeyedList()
- Example: layout primitives (body → panel → row → col)
- Use <os-*> components from a plugin that ships as a zip
- Restyle and drive Mio
- Repairable form edits with MIO
- Register a window companion
- Pin your app to the phone tab bar, and react to the mode
- Add an action that works on a whole selection
- WP Explorer — custom post types and their folder
- WP Explorer — add a column to the list view
- Add an action button to a WP Explorer preview pane
- Example: native Posts window
- Example: native window with tabs
- Native windows
- Customize note → post conversion
- Send a notification
- OAuth relay — connect to an external service
- Ship a window as an .os.php app
- OS-file drop
- <os-flyout> — window-scoped sliding card
- Plugins window — extras
- Track who's around — wp.os.presence
- Example: progress bar
- PWA install — surface your own button
- React to window events
- Example: extend the Trash
- Register a slash-command
- Register a desktop theme from a plugin
- Register a game
- Example: register a desktop icon (Jorvy)
- Register a wallpaper
- Register a widget
- Related entities — extend the title bar's "Related" menu
- The native-window render ctx
- Revisions in their own window — extend or redirect "View revisions"
- Programmatic folder sharing
- Share state across multi-bundle plugins — wp.os.createSharedStore()
- Example: loading spinner
- Add an opt-in card to Station Home
- Observe stored-file cleanup failures
- Accept drops on your desktop icon
- Give a tile two icons, one per state
- Add a row to a window's ⋯ menu
- Example: window activity & the status ring
- Window controls
- Subscribe to window lifecycle events
- Window links — relate windows and restyle the ties (Experimental)
- Window loading state — spinner overlay & ready signal
- Show a banner at the top of a window
- Pulse a window's icon — Window.requestAttention()
- Register a custom window reveal
- Window slots
- Window themes
- Native window with bundle-bound config
- Place something where the user can reach it — wp.os.workArea
- Ship a workspace template