opus-react 0.4.5 → 0.4.7

package/README.md

@@ -2,7 +2,7 @@
 
 **Build modern business applications without rebuilding the foundations.**
 
-Opus is a production-ready, themeable React design system for dashboards, CRM products, internal tools and data-rich workflows. It combines polished visual design with accessible interaction patterns, strong TypeScript support and a broad component catalogue—from form primitives to complete application layouts.
+Opus is a production-ready, themeable React design system for dashboards, CRM products, internal tools, data-rich workflows, and browser-based desktop experiences. It combines polished visual design with accessible interaction patterns, strong TypeScript support and a broad component catalogue—from form primitives to complete application layouts and draggable multi-window workspaces.
 
 [Component catalogue](https://project-opus.netlify.app/documentation/components) · [GitHub](https://github.com/Carl-Fearby/Opus)
 
@@ -22,6 +22,7 @@ Opus is a production-ready, themeable React design system for dashboards, CRM pr
 ## Why Opus
 
 - **Hundreds of composable components** covering forms, content, navigation, overlays, charts, dashboards, media and desktop-style experiences.
+- **Build complete web desktops** with draggable and resizable windows, desktop shortcuts, a responsive dock, minimise/maximise behaviour, focus management, and application-defined window content.
 - **Designed for real application interfaces**, with responsive layouts, resizable panes, rich data views and reusable workflow components.
 - **Themeable by default**, including light and dark modes, CSS design tokens and runtime accent colours.
 - **Accessible and typed**, with keyboard-aware interactions and complete TypeScript definitions.
@@ -220,6 +221,73 @@ import {
 </Columns>;
 ```
 
+### Desktop applications
+
+Create browser-based desktop and workspace experiences from reusable primitives. Opus supplies the shell and interaction model while your application owns every shortcut, dock item, window, and piece of content.
+
+[![Opus browser desktop with draggable application windows, shortcuts, and dock](https://raw.githubusercontent.com/Carl-Fearby/Opus/main/Library/packages/opus-react/assets/npm/desktop.png)](https://project-opus.netlify.app/documentation/components)
+
+- `Desktop` — stateful workspace shell with wallpaper, shortcuts, windows, dock placement, and edge-to-edge mode
+- `DesktopWindow` — draggable, resizable, focus-aware windows with close, minimise, maximise, and restore transitions
+- `DesktopDock` — resizable dock with bottom, left, and right placement plus optional auto-hide
+- `DesktopIcon` — keyboard-accessible, selectable shortcuts with single- or double-click opening
+- `VideoPlayer` — window-ready media playback with responsive controls and ambient blurred video fill
+
+```tsx
+import {
+  Desktop,
+  type DesktopDockItem,
+  type DesktopShortcut,
+  type DesktopWindowItem,
+} from "opus-react";
+
+const shortcuts: DesktopShortcut[] = [
+  { id: "documents", icon: "folder-open", label: "Documents", x: 20, y: 20 },
+  { id: "contacts", icon: "users", label: "Contacts", x: 20, y: 124 },
+];
+
+const dockItems: DesktopDockItem[] = shortcuts.map(({ id, icon, label }) => ({
+  id,
+  icon,
+  label,
+}));
+
+const windows: DesktopWindowItem[] = [
+  {
+    id: "documents",
+    title: "Documents",
+    icon: "folder-open",
+    open: true,
+    rect: { x: 180, y: 64, width: 640, height: 420 },
+    content: <div style={{ padding: 24 }}>Your documents application</div>,
+  },
+  {
+    id: "contacts",
+    title: "Contacts",
+    icon: "users",
+    open: false,
+    rect: { x: 320, y: 120, width: 560, height: 400 },
+    content: <div style={{ padding: 24 }}>Your contacts application</div>,
+  },
+];
+
+export function Workspace() {
+  return (
+    <Desktop
+      dockAutoHide
+      dockItems={dockItems}
+      edgeToEdge
+      onAction={(action, id) => console.log(action, id)}
+      shortcuts={shortcuts}
+      wallpaper="aurora"
+      windows={windows}
+    />
+  );
+}
+```
+
+The same React composition works in a normal web application or inside a desktop wrapper such as Electron—without moving application behaviour into the shell component.
+
 ### Media and 3D
 
 - `Carousel`, `Lightbox`, `ImageThumbnail`, `ImageGallery`
@@ -351,9 +419,18 @@ npm publish -w opus-react --access public
 
 `prepublishOnly` runs the package build automatically. Bump the version in `packages/opus-react/package.json` before publishing.
 
-## Contact
+## Contribute to Opus
+
+We are looking for contributors who want to help improve Opus. Useful contributions range from
+small component refinements, accessibility fixes, tests, examples, and documentation through to
+new primitives, application compositions, dashboard patterns, and desktop features.
+
+You do not need to commit to a large feature. If you would like to get involved, tell us what you
+are interested in and which part of Opus you would like to work on:
 
-Carl Fearby — [carlfearby@me.com](mailto:carlfearby@me.com)
+- Email [carlfearby@me.com](mailto:carlfearby@me.com)
+- WhatsApp [+44 7940 147138](https://wa.me/447940147138)
+- Browse the source, fork the project, or open a pull request at [Carl-Fearby/Opus](https://github.com/Carl-Fearby/Opus)
 
 ## License