@ceed/cds 1.24.0 → 1.24.1-next.2
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 +51 -0
- package/package.json +16 -12
package/README.md
ADDED
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
# @ceed/cds
|
|
2
|
+
|
|
3
|
+
Client Design System - A React component library for Ecube Labs client applications.
|
|
4
|
+
|
|
5
|
+
## Installation
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm install @ceed/cds
|
|
9
|
+
# or
|
|
10
|
+
yarn add @ceed/cds
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
### Peer Dependencies
|
|
14
|
+
|
|
15
|
+
`@ceed/cds` requires the following peer dependencies to be installed in your app.
|
|
16
|
+
You can skip any packages that are already installed.
|
|
17
|
+
|
|
18
|
+
```bash
|
|
19
|
+
npm install @emotion/react @emotion/styled @mui/joy framer-motion
|
|
20
|
+
# If using icon components:
|
|
21
|
+
npm install @mui/icons-material
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
| Package | Required | Note |
|
|
25
|
+
|---|---|---|
|
|
26
|
+
| `@emotion/react` | Yes | MUI Joy rendering engine |
|
|
27
|
+
| `@emotion/styled` | Yes | MUI Joy styling engine |
|
|
28
|
+
| `@mui/joy` | Yes | Design system foundation (includes ThemeProvider) |
|
|
29
|
+
| `framer-motion` | Yes | Animation components |
|
|
30
|
+
| `@mui/icons-material` | Optional | Only needed for icon-based components |
|
|
31
|
+
|
|
32
|
+
## Usage
|
|
33
|
+
|
|
34
|
+
### With Bundler (Vite, Webpack, etc.)
|
|
35
|
+
|
|
36
|
+
```tsx
|
|
37
|
+
import { Button, ThemeProvider } from '@ceed/cds';
|
|
38
|
+
|
|
39
|
+
function App() {
|
|
40
|
+
return (
|
|
41
|
+
<ThemeProvider>
|
|
42
|
+
<Button variant="solid">Click me</Button>
|
|
43
|
+
</ThemeProvider>
|
|
44
|
+
);
|
|
45
|
+
}
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
## Documentation
|
|
49
|
+
|
|
50
|
+
- [Storybook](https://main--66da7aaaf87fb0b864d6afca.chromatic.com)
|
|
51
|
+
- [Confluence](https://ecubelabs.atlassian.net/wiki/spaces/HP/pages/3256123430/Design+System)
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@ceed/cds",
|
|
3
|
-
"version": "1.24.
|
|
3
|
+
"version": "1.24.1-next.2",
|
|
4
4
|
"main": "dist/index.cjs",
|
|
5
5
|
"module": "dist/index.js",
|
|
6
6
|
"types": "dist/index.d.ts",
|
|
@@ -29,7 +29,6 @@
|
|
|
29
29
|
],
|
|
30
30
|
"exports": {
|
|
31
31
|
".": {
|
|
32
|
-
"browser": "./dist/index.browser.js",
|
|
33
32
|
"import": "./dist/index.js",
|
|
34
33
|
"require": "./dist/index.cjs"
|
|
35
34
|
},
|
|
@@ -41,19 +40,23 @@
|
|
|
41
40
|
"sideEffects": false,
|
|
42
41
|
"license": "MIT",
|
|
43
42
|
"peerDependencies": {
|
|
44
|
-
"react": "^
|
|
45
|
-
"
|
|
43
|
+
"@emotion/react": "^11.5.0",
|
|
44
|
+
"@emotion/styled": "^11.3.0",
|
|
45
|
+
"@mui/icons-material": "^6.1.0",
|
|
46
|
+
"@mui/joy": ">=5.0.0-beta.32 <6.0.0-0",
|
|
47
|
+
"framer-motion": "^11.0.3",
|
|
48
|
+
"react": "^17.0.0 || ^18.0.0 || ^19.0.0",
|
|
49
|
+
"react-dom": "^17.0.0 || ^18.0.0 || ^19.0.0"
|
|
50
|
+
},
|
|
51
|
+
"peerDependenciesMeta": {
|
|
52
|
+
"@mui/icons-material": {
|
|
53
|
+
"optional": true
|
|
54
|
+
}
|
|
46
55
|
},
|
|
47
56
|
"dependencies": {
|
|
48
57
|
"@atlaskit/pragmatic-drag-and-drop": "^1.2.1",
|
|
49
|
-
"@
|
|
50
|
-
"@emotion/styled": "^11.11.0",
|
|
51
|
-
"@mui/base": "5.0.0-beta.40",
|
|
52
|
-
"@mui/icons-material": "^6.1.0",
|
|
53
|
-
"@mui/joy": "^5.0.0-beta.32",
|
|
58
|
+
"@babel/runtime": "^7.23.9",
|
|
54
59
|
"@tanstack/react-virtual": "^3.4.0",
|
|
55
|
-
"framer-motion": "^11.0.3",
|
|
56
|
-
"intl-messageformat": "^10.0.0",
|
|
57
60
|
"react-imask": "^7.5.0",
|
|
58
61
|
"react-markdown": "^9.0.1",
|
|
59
62
|
"react-number-format": "^5.0.0",
|
|
@@ -100,5 +103,6 @@
|
|
|
100
103
|
"type": "git",
|
|
101
104
|
"url": "git+ssh://git@github.com/Ecube-Labs/hds.git"
|
|
102
105
|
},
|
|
103
|
-
"packageManager": "yarn@4.1.0"
|
|
106
|
+
"packageManager": "yarn@4.1.0",
|
|
107
|
+
"stableVersion": "1.0.0"
|
|
104
108
|
}
|