@ossy/design-system 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 +67 -0
- package/package.json +3 -3
package/README.md
ADDED
|
@@ -0,0 +1,67 @@
|
|
|
1
|
+
# @ossy/design-system
|
|
2
|
+
|
|
3
|
+
React component library for the **Ossy Ecosystem** — themable UI components with support for multiple themes, server-side rendering, and React 19.
|
|
4
|
+
|
|
5
|
+
## Features
|
|
6
|
+
|
|
7
|
+
- **Themable** — Switch themes at runtime with the `useTheme` hook
|
|
8
|
+
- **Multiple themes** — CloudLight, CloudDark, and custom themes from `@ossy/themes`
|
|
9
|
+
- **Server-side rendering** — Works with SSR build tooling
|
|
10
|
+
- **React 19** — Built for React 19+
|
|
11
|
+
|
|
12
|
+
## Installation
|
|
13
|
+
|
|
14
|
+
```bash
|
|
15
|
+
npm install @ossy/design-system @ossy/themes
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
## Quick start
|
|
19
|
+
|
|
20
|
+
Wrap your app in the `Theme` provider and pass a theme from `@ossy/themes`:
|
|
21
|
+
|
|
22
|
+
```jsx
|
|
23
|
+
import React from 'react'
|
|
24
|
+
import { Theme } from '@ossy/design-system'
|
|
25
|
+
import { CloudLight } from '@ossy/themes'
|
|
26
|
+
|
|
27
|
+
export default () => (
|
|
28
|
+
<Theme theme={CloudLight}>
|
|
29
|
+
<YourApp />
|
|
30
|
+
</Theme>
|
|
31
|
+
)
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
For multiple themes with runtime switching:
|
|
35
|
+
|
|
36
|
+
```jsx
|
|
37
|
+
import { Theme } from '@ossy/design-system'
|
|
38
|
+
import { CloudLight, CloudDark } from '@ossy/themes'
|
|
39
|
+
|
|
40
|
+
<Theme
|
|
41
|
+
theme={CloudLight}
|
|
42
|
+
themes={{ light: CloudLight, dark: CloudDark }}
|
|
43
|
+
defaultTheme="light"
|
|
44
|
+
>
|
|
45
|
+
<YourApp />
|
|
46
|
+
</Theme>
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
## Documentation
|
|
50
|
+
|
|
51
|
+
Run Storybook from the monorepo root for full component documentation:
|
|
52
|
+
|
|
53
|
+
```bash
|
|
54
|
+
npm start
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
Browse **Design System** in the sidebar for Layout, Feedback, Navigation, Actions, Display, Inputs, and more.
|
|
58
|
+
|
|
59
|
+
## Peer dependencies
|
|
60
|
+
|
|
61
|
+
- `react` >=19.0.0
|
|
62
|
+
- `react-dom` >=19.0.0
|
|
63
|
+
- `@ossy/themes` for theme definitions
|
|
64
|
+
|
|
65
|
+
## License
|
|
66
|
+
|
|
67
|
+
MIT
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@ossy/design-system",
|
|
3
3
|
"description": "Ossy's design system React component library",
|
|
4
|
-
"version": "0.10.
|
|
4
|
+
"version": "0.10.1",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"source": "src/index.js",
|
|
7
7
|
"module": "build/index.js",
|
|
@@ -28,7 +28,7 @@
|
|
|
28
28
|
]
|
|
29
29
|
},
|
|
30
30
|
"devDependencies": {
|
|
31
|
-
"@ossy/themes": "^0.10.
|
|
31
|
+
"@ossy/themes": "^0.10.1",
|
|
32
32
|
"react-markdown": "^10.1.0",
|
|
33
33
|
"react-syntax-highlighter": "^16.1.0"
|
|
34
34
|
},
|
|
@@ -46,5 +46,5 @@
|
|
|
46
46
|
"/build",
|
|
47
47
|
"README.md"
|
|
48
48
|
],
|
|
49
|
-
"gitHead": "
|
|
49
|
+
"gitHead": "fa8cbcb5f24811e6844c929d7fa7cd1d2544efa7"
|
|
50
50
|
}
|