-
Notifications
You must be signed in to change notification settings - Fork 41
example react to window events
github-actions[bot] edited this page Aug 25, 2026
·
2 revisions
Log every window open/close/focus, and re-focus a specific window if the user opens a conflicting one.
<?php
/**
* Plugin Name: Desktop Window Logger
*/
defined( 'ABSPATH' ) || exit;
add_action( 'openstation_mode_init', function () {
wp_enqueue_script(
'desktop-window-logger',
plugin_dir_url( __FILE__ ) . 'logger.js',
array(),
'1.0.0',
true
);
} );document.addEventListener( 'os-init', function () {
console.log( 'desktop ready' );
document.addEventListener( 'os-window-opened', ( e ) => {
console.log( 'opened', e.detail );
} );
document.addEventListener( 'os-window-closed', ( e ) => {
console.log( 'closed', e.detail );
} );
document.addEventListener( 'os-window-focused', ( e ) => {
console.log( 'focused', e.detail );
} );
} );document.addEventListener( 'os-window-focused', function ( e ) {
if ( e.detail.windowId !== 'edit-php' ) {
return;
}
// Open a companion analytics window if it's not already up.
const mgr = window.wp.os.windowManager;
if ( ! mgr.getById( 'my-ext-analytics' ) ) {
mgr.open( {
id: 'my-ext-analytics',
url: '/wp-admin/admin.php?page=my-analytics',
title: 'Analytics',
icon: 'dashicons-chart-bar',
} );
}
} );- Listeners attached on
documentcontinue to fire as long as OpenStation is up. No cleanup needed unless your plugin deactivates in-place. -
os-initis dispatched once. If your code loads after it has already fired, attach directly; thewindow.wp.osAPI is already there by then. -
os-window-changedis experimental and chatty (geometry + state). Prefer the individualopened/closed/focusedevents for external integrations.
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
- Architecture
- Bridge protocol — wiring overview
- <os-*> component reference
- 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
- Mio
- Native Windows & Framework Interop
- Plugin compatibility layer
- Progressive Web App (PWA)
- Station Home
- Using openstation from your own plugin
Migration notes
- Migration: built-in activity channels move to the os/ namespace
- Migration: window, wallpaper and widget bundles load on demand
- Migration — the navigation model
- Migration: a native window's tabs move to the window chrome
All examples
- AI Agents — extend and invoke from a plugin
- wp.os.ai.ask() — programmatic AI Copilot
- Tune the AI model config
- Custom arrange-menu action
- 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
- 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
- Add an action that works on a whole selection
- WP Explorer — custom post types and their folder
- 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
- 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
- Programmatic folder sharing
- Share state across multi-bundle plugins — wp.os.createSharedStore()
- Example: loading spinner
- Add an opt-in card to Station Home
- 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