@ossy/connected-components 0.10.0 → 0.10.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +66 -0
- package/package.json +2 -2
package/README.md
ADDED
|
@@ -0,0 +1,66 @@
|
|
|
1
|
+
# @ossy/connected-components
|
|
2
|
+
|
|
3
|
+
CMS-connected React components for the Ossy Ecosystem. The `App` component provides routing, theming, workspace context, and SDK integration in a single wrapper.
|
|
4
|
+
|
|
5
|
+
## Installation
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm install @ossy/connected-components @ossy/design-system @ossy/themes @ossy/router-react @ossy/sdk @ossy/sdk-react
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## When to use
|
|
12
|
+
|
|
13
|
+
- **@ossy/cli** — Fastest path: run `npx @ossy/cli dev` with `src/*.page.jsx` and `src/config.js`
|
|
14
|
+
- **@ossy/connected-components** — Custom setups (Next.js, Vite, Remix): use the `App` component with your own bundler and server
|
|
15
|
+
|
|
16
|
+
## Quick start
|
|
17
|
+
|
|
18
|
+
```jsx
|
|
19
|
+
import { App } from '@ossy/connected-components'
|
|
20
|
+
import { CloudLight } from '@ossy/themes'
|
|
21
|
+
|
|
22
|
+
export default () => (
|
|
23
|
+
<App
|
|
24
|
+
workspaceId="your-workspace-id"
|
|
25
|
+
theme={CloudLight}
|
|
26
|
+
pages={[
|
|
27
|
+
{ id: 'home', path: '/', element: <HomePage /> },
|
|
28
|
+
{ id: 'about', path: '/about', element: <AboutPage /> },
|
|
29
|
+
]}
|
|
30
|
+
/>
|
|
31
|
+
)
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
## Configuration
|
|
35
|
+
|
|
36
|
+
| Prop | Description |
|
|
37
|
+
|------|-------------|
|
|
38
|
+
| `workspaceId` | Your workspace identifier |
|
|
39
|
+
| `theme` | Theme object (e.g. `CloudLight`, `CloudDark`) |
|
|
40
|
+
| `themes` | Multiple themes for switching via `useTheme` |
|
|
41
|
+
| `pages` | Array of `{ id, path, element }` page configs |
|
|
42
|
+
| `apiUrl` | Optional API base URL |
|
|
43
|
+
| `devMode` | Enables theme editor when `true` |
|
|
44
|
+
|
|
45
|
+
## Documentation
|
|
46
|
+
|
|
47
|
+
See **App — Getting Started** in Storybook for detailed setup with `@ossy/cli` and custom bundlers:
|
|
48
|
+
|
|
49
|
+
```bash
|
|
50
|
+
npm start
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
## Peer dependencies
|
|
54
|
+
|
|
55
|
+
- `react` >=19.0.0
|
|
56
|
+
- `@ossy/design-system` >=0.5.0
|
|
57
|
+
- `@ossy/pages` >=0.5.0
|
|
58
|
+
- `@ossy/router` >=0.5.0
|
|
59
|
+
- `@ossy/router-react` >=0.5.0
|
|
60
|
+
- `@ossy/sdk` >=0.5.0
|
|
61
|
+
- `@ossy/sdk-react` >=0.5.0
|
|
62
|
+
- `@ossy/themes` >=0.5.0
|
|
63
|
+
|
|
64
|
+
## License
|
|
65
|
+
|
|
66
|
+
MIT
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@ossy/connected-components",
|
|
3
|
-
"version": "0.10.
|
|
3
|
+
"version": "0.10.1",
|
|
4
4
|
"repository": {
|
|
5
5
|
"type": "git",
|
|
6
6
|
"url": "git+https://github.com/ossy-se/packages.git"
|
|
@@ -56,5 +56,5 @@
|
|
|
56
56
|
"/build",
|
|
57
57
|
"README.md"
|
|
58
58
|
],
|
|
59
|
-
"gitHead": "
|
|
59
|
+
"gitHead": "fa8cbcb5f24811e6844c929d7fa7cd1d2544efa7"
|
|
60
60
|
}
|