opus-react 0.2.3

package/README.md

@@ -0,0 +1,81 @@
+# opus-react
+
+React component library for the Opus design system.
+
+## Install
+
+```bash
+npm install opus-react
+```
+
+Peer dependencies:
+
+```bash
+npm install react react-dom
+# Optional, for 3D model components:
+npm install three
+```
+
+## Setup
+
+Import theme tokens and component styles, then wrap your app with `OpusThemeProvider`:
+
+```tsx
+import "opus-react/styles.css";
+import "opus-react/index.css";
+import { OpusThemeProvider, Button, TextField } from "opus-react";
+
+export function App() {
+  return (
+    <OpusThemeProvider theme="dark">
+      <div data-theme="dark">
+        <Button variant="primary">Save</Button>
+      </div>
+    </OpusThemeProvider>
+  );
+}
+```
+
+Set `data-theme="light"` or `data-theme="dark"` on a container (or `document.documentElement`) so CSS variables resolve.
+
+## Next.js
+
+Add to `next.config.ts`:
+
+```ts
+const nextConfig = {
+  transpilePackages: ["opus-react"],
+};
+```
+
+## Accent colour
+
+```tsx
+import { AccentColorPicker, createAccentStyle } from "opus-react";
+
+<div style={createAccentStyle("#8f6cff")} data-theme="dark">
+  ...
+</div>
+```
+
+## Publish
+
+From the monorepo root:
+
+```bash
+npm run build:lib
+npm publish -w opus-react --access public
+```
+
+Set the package `name` in `packages/opus-react/package.json` to your scoped name (for example `@your-org/opus-react`) before publishing.
+
+## What's included
+
+- Form fields (text, select, chip input, colour picker, etc.)
+- Overlays (modal, drawer, dialog, popover, toast)
+- Content (card, table, data grid, tabs, accordion)
+- Navigation (sidebar, mega menu, top navigation)
+- Charts, gauges, and dashboard widgets
+- `AccentColorPicker`, `IconPicker`, `CatalogIcon`
+
+Documentation site shells, control preview tooling, and generated usage code are **not** published in this package.