Host Modules
-
- runtime:ui
+
+ runtime:window
Windows, Dialogs, Menus
diff --git a/site/src/components/Footer.astro b/site/src/components/Footer.astro
index 852c5e8..3b2c5fd 100644
--- a/site/src/components/Footer.astro
+++ b/site/src/components/Footer.astro
@@ -1,10 +1,10 @@
---
const links = {
docs: [
- { label: 'Getting Started', href: '/getting-started/' },
- { label: 'Architecture', href: '/architecture/' },
- { label: 'API Reference', href: '/api/runtime-ui/' },
- { label: 'Manifest', href: '/api/manifest/' },
+ { label: 'Getting Started', href: '/docs/getting-started/' },
+ { label: 'Architecture', href: '/docs/architecture/' },
+ { label: 'API Reference', href: '/docs/api/runtime-window/' },
+ { label: 'Manifest', href: '/docs/api/manifest/' },
],
community: [
{ label: 'GitHub', href: 'https://github.com/LayerDynamics/forge' },
diff --git a/site/src/components/Hero.astro b/site/src/components/Hero.astro
index 0e49cba..a7536b9 100644
--- a/site/src/components/Hero.astro
+++ b/site/src/components/Hero.astro
@@ -13,7 +13,7 @@
diff --git a/site/src/content/docs/api/runtime-ui.md b/site/src/content/docs/api/runtime-ui.md
deleted file mode 100644
index fb43d8c..0000000
--- a/site/src/content/docs/api/runtime-ui.md
+++ /dev/null
@@ -1,435 +0,0 @@
----
-title: "runtime:ui (Deprecated)"
-description: This module has been consolidated into runtime:window.
-slug: docs/api/runtime-ui
----
-
-> **⚠️ Deprecated**: The `runtime:ui` module has been consolidated into [`runtime:window`](/docs/api/runtime-window). All functionality documented below is now available through `runtime:window`.
-
-Please use [`runtime:window`](/docs/api/runtime-window) for window operations, dialogs, menus, and system tray functionality. For inter-process communication, see [`runtime:ipc`](/docs/api/runtime-ipc).
-
----
-
-## Migration Guide
-
-Replace your imports:
-
-```typescript
-// Old (deprecated)
-import { openWindow, dialog, setAppMenu, createTray } from "runtime:ui";
-
-// New
-import { createWindow, dialog, menu, tray } from "runtime:window";
-```
-
-The APIs remain largely the same, with some namespace changes:
-- `openWindow()` → `createWindow()`
-- `setAppMenu()` → `menu.setAppMenu()`
-- `showContextMenu()` → `menu.showContextMenu()`
-- `onMenu()` → `menu.onMenu()`
-- `createTray()` → `tray.create()`
-- `destroyTray()` → `tray.destroy()`
-
----
-
-## Legacy Documentation
-
-The following documents the legacy `runtime:ui` API for reference. **Use [`runtime:window`](/docs/api/runtime-window) for new code.**
-
-## Basic Window Operations
-
-### openWindow(options?)
-
-Create a new window with basic options:
-
-```typescript
-import { openWindow } from "runtime:ui";
-
-const win = await openWindow({
- url: "app://index.html",
- width: 800,
- height: 600,
- title: "My Window",
-});
-
-console.log("Window ID:", win.id);
-```
-
-**Options:**
-
-```typescript
-interface OpenWindowOptions {
- /** URL to load (default: "app://index.html") */
- url?: string;
- /** Window width in pixels */
- width?: number;
- /** Window height in pixels */
- height?: number;
- /** Window title */
- title?: string;
- /** Whether window can be resized */
- resizable?: boolean;
- /** Show window decorations */
- decorations?: boolean;
- /** IPC channel allowlist */
- channels?: string[];
-}
-```
-
-**Returns:** `Promise
`
-
-```typescript
-interface WindowHandle {
- readonly id: string;
- setTitle(title: string): Promise;
- close(): Promise;
-}
-```
-
-### closeWindow(windowId)
-
-Close a window by ID:
-
-```typescript
-import { closeWindow } from "runtime:ui";
-
-await closeWindow("window-123");
-```
-
-### setWindowTitle(windowId, title)
-
-Set a window's title:
-
-```typescript
-import { setWindowTitle } from "runtime:ui";
-
-await setWindowTitle("window-123", "New Title");
-```
-
----
-
-## Dialogs
-
-### dialog.open(options?)
-
-Show a file open dialog. Returns selected paths or `null` if cancelled:
-
-```typescript
-import { dialog } from "runtime:ui";
-
-const files = await dialog.open({
- title: "Select Images",
- filters: [
- { name: "Images", extensions: ["png", "jpg", "gif"] }
- ],
- multiple: true,
-});
-
-if (files) {
- console.log("Selected:", files);
-}
-```
-
-### dialog.save(options?)
-
-Show a save file dialog. Returns the path or `null` if cancelled:
-
-```typescript
-import { dialog } from "runtime:ui";
-
-const path = await dialog.save({
- title: "Save Document",
- defaultPath: "document.txt",
- filters: [
- { name: "Text Files", extensions: ["txt"] }
- ],
-});
-
-if (path) {
- console.log("Save to:", path);
-}
-```
-
-### FileDialogOptions
-
-```typescript
-interface FileDialogOptions {
- title?: string;
- defaultPath?: string;
- filters?: FileFilter[];
- multiple?: boolean;
- directory?: boolean;
-}
-
-interface FileFilter {
- name: string;
- extensions: string[];
-}
-```
-
-### dialog.message(options)
-
-Show a message dialog. Returns the index of the clicked button:
-
-```typescript
-import { dialog } from "runtime:ui";
-
-const result = await dialog.message({
- title: "Confirm",
- message: "Are you sure?",
- kind: "warning",
-});
-```
-
-### Convenience Dialogs
-
-```typescript
-import { dialog } from "runtime:ui";
-
-// Alert dialog
-await dialog.alert("Operation completed!");
-
-// Confirm dialog (returns boolean)
-const confirmed = await dialog.confirm("Delete this file?");
-
-// Error dialog
-await dialog.error("Something went wrong!");
-
-// Warning dialog
-await dialog.warning("This action cannot be undone!");
-```
-
----
-
-## Menus
-
-### setAppMenu(items)
-
-Set the application menu bar:
-
-```typescript
-import { setAppMenu } from "runtime:ui";
-
-await setAppMenu([
- {
- label: "File",
- submenu: [
- { id: "new", label: "New", accelerator: "CmdOrCtrl+N" },
- { id: "open", label: "Open...", accelerator: "CmdOrCtrl+O" },
- { type: "separator" },
- { id: "quit", label: "Quit", accelerator: "CmdOrCtrl+Q" },
- ],
- },
- {
- label: "Edit",
- submenu: [
- { id: "undo", label: "Undo", accelerator: "CmdOrCtrl+Z" },
- { id: "redo", label: "Redo", accelerator: "CmdOrCtrl+Shift+Z" },
- ],
- },
-]);
-```
-
-### showContextMenu(items, windowId?)
-
-Show a context menu at the cursor position:
-
-```typescript
-import { showContextMenu } from "runtime:ui";
-
-const selected = await showContextMenu([
- { id: "cut", label: "Cut" },
- { id: "copy", label: "Copy" },
- { id: "paste", label: "Paste" },
-]);
-
-if (selected) {
- console.log("Selected:", selected);
-}
-```
-
-### onMenu(callback)
-
-Register a callback for menu events. Returns an unsubscribe function:
-
-```typescript
-import { onMenu } from "runtime:ui";
-
-const unsubscribe = onMenu((event) => {
- console.log(`Menu clicked: ${event.itemId}`);
-
- switch (event.itemId) {
- case "new":
- createNewDocument();
- break;
- case "quit":
- Deno.exit(0);
- break;
- }
-});
-
-// Later: unsubscribe();
-```
-
-### menuEvents()
-
-Async iterator for menu events:
-
-```typescript
-import { menuEvents } from "runtime:ui";
-
-for await (const event of menuEvents()) {
- console.log(`Menu: ${event.menuId}, Item: ${event.itemId}`);
-}
-```
-
-### MenuItem
-
-```typescript
-interface MenuItem {
- id?: string;
- label: string;
- accelerator?: string;
- enabled?: boolean;
- checked?: boolean;
- submenu?: MenuItem[];
- type?: "normal" | "checkbox" | "separator";
-}
-```
-
-### MenuEvent
-
-```typescript
-interface MenuEvent {
- menuId: string;
- itemId: string;
- label: string;
-}
-```
-
----
-
-## System Tray
-
-### createTray(options?)
-
-Create a system tray icon:
-
-```typescript
-import { createTray } from "runtime:ui";
-
-const trayIcon = await createTray({
- icon: "./assets/tray-icon.png",
- tooltip: "My App",
- menu: [
- { id: "show", label: "Show Window" },
- { type: "separator" },
- { id: "quit", label: "Quit" },
- ],
-});
-```
-
-### TrayHandle
-
-```typescript
-interface TrayHandle {
- readonly id: string;
- update(options: TrayOptions): Promise;
- destroy(): Promise;
-}
-```
-
-Update tray properties:
-
-```typescript
-await trayIcon.update({
- tooltip: "New Status",
- menu: [
- { id: "status", label: "Status: Online", enabled: false },
- { type: "separator" },
- { id: "quit", label: "Quit" },
- ],
-});
-```
-
-Destroy the tray:
-
-```typescript
-await trayIcon.destroy();
-```
-
-### destroyTray(trayId)
-
-Destroy a tray by ID:
-
-```typescript
-import { destroyTray } from "runtime:ui";
-
-await destroyTray("my-tray-id");
-```
-
-### TrayOptions
-
-```typescript
-interface TrayOptions {
- icon?: string;
- tooltip?: string;
- menu?: MenuItem[];
-}
-```
-
----
-
-## Complete Example
-
-```typescript
-import { openWindow, dialog, onMenu, createTray } from "runtime:ui";
-import { sendToWindow, onChannel } from "runtime:ipc";
-
-// Create main window
-const win = await openWindow({
- title: "My Application",
- width: 1024,
- height: 768,
-});
-
-// Set up application menu
-await setAppMenu([
- {
- label: "File",
- submenu: [
- { id: "open", label: "Open...", accelerator: "CmdOrCtrl+O" },
- { type: "separator" },
- { id: "quit", label: "Quit", accelerator: "CmdOrCtrl+Q" },
- ],
- },
-]);
-
-// Handle menu events
-onMenu(async (event) => {
- if (event.itemId === "open") {
- const files = await dialog.open({
- filters: [{ name: "Documents", extensions: ["txt", "md"] }],
- });
- if (files) {
- await sendToWindow(win.id, "file-opened", { path: files[0] });
- }
- } else if (event.itemId === "quit") {
- Deno.exit(0);
- }
-});
-
-// Create system tray
-const trayIcon = await createTray({
- tooltip: "My Application",
- menu: [
- { id: "show", label: "Show Window" },
- { id: "quit", label: "Quit" },
- ],
-});
-
-// Handle IPC from renderer
-onChannel("ready", (payload, windowId) => {
- console.log(`Window ${windowId} is ready`);
-});
-```
diff --git a/site/src/content/docs/api/runtime-updater.md b/site/src/content/docs/api/runtime-updater.md
index 55dbe5a..4970ab4 100644
--- a/site/src/content/docs/api/runtime-updater.md
+++ b/site/src/content/docs/api/runtime-updater.md
@@ -824,7 +824,7 @@ onError("verify", (error) => {
```typescript
import { configure, check, formatBytes } from "runtime:updater";
-import { showDialog } from "runtime:ui";
+import { dialog } from "runtime:window";
async function checkForUpdatesOnStartup() {
try {
@@ -835,15 +835,14 @@ async function checkForUpdatesOnStartup() {
const update = await check();
if (update) {
- const response = await showDialog({
- type: "question",
+ const button = await dialog.message({
+ kind: "info",
title: "Update Available",
- message: `Version ${update.version} is available. Would you like to download it?`,
- detail: update.release_notes || `Download size: ${formatBytes(update.size_bytes)}`,
+ message: `Version ${update.version} is available (${formatBytes(update.size_bytes)}). Would you like to download it?`,
buttons: ["Download", "Later"],
});
- if (response.button === 0) {
+ if (button === 0) {
// User clicked "Download"
openUpdateWindow();
}