@uni-design-system/uni-react 2.0.2 → 2.0.4

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.
Files changed (2) hide show
  1. package/README.md +49 -0
  2. package/package.json +3 -3
package/README.md ADDED
@@ -0,0 +1,49 @@
1
+ <p align="center">
2
+ <a href="https://uni-design-system.github.io/uni/" target="_blank">
3
+ <img src="https://github.com/uni-design-system/uni-react/raw/v0.0.17/.github/uni-logo.png" alt="UNI Design System">
4
+ </a>
5
+ </p>
6
+
7
+ <p align="center">
8
+ UNI React is a themed based component library built atop of the UNI Design System Core Concepts.
9
+ <p>
10
+
11
+ <p align="center">
12
+ <a href="https://uni-design-system.github.io/uni/docs/react/"><strong>Browse the React component library &rarr;</strong></a>
13
+ </p>
14
+
15
+ # @uni-design-system/uni-react
16
+
17
+ The official **React** implementation of the Uni Design System. This library features highly interactive, accessible, and performant components styled cleanly using tokens from our core engine.
18
+
19
+ ## 📦 Installation
20
+
21
+ ```bash
22
+ npm install @uni-design-system/uni-react @uni-design-system/uni-core
23
+ ```
24
+
25
+ ## 🏁 Getting Started
26
+
27
+ Ensure you wrap or initialize your application layout to handle tokens from `@uni-design-system/uni-core` if needed, then import and drop components directly into your TSX:
28
+
29
+ ```tsx
30
+ import React from 'react';
31
+ import { Button } from '@uni-design-system/uni-react';
32
+
33
+ export const MyComponent = () => {
34
+ return (
35
+ <Button
36
+ type="primary"
37
+ onClick={() => console.log('Clicked!')}
38
+ >
39
+ Click Me
40
+ </Button>
41
+ );
42
+ };
43
+ ```
44
+
45
+ ## 🛠️ Architecture Profile
46
+ - **Framework Support:** React `>=18`
47
+ - **Pre-bundled Internals:** Complex third-party layout engines (like `@dnd-kit` and `framer-motion`) are completely compiled *inside* this package to simplify your build trees.
48
+ - **Peer Dependencies:** React and `@uni-design-system/uni-core` are kept external to maintain minimal, lightweight bundle weights.
49
+ ```
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@uni-design-system/uni-react",
3
- "version": "2.0.2",
3
+ "version": "2.0.4",
4
4
  "repository": {
5
5
  "type": "git",
6
6
  "url": "https://github.com/uni-design-system/uni",
@@ -26,7 +26,7 @@
26
26
  "dist"
27
27
  ],
28
28
  "peerDependencies": {
29
- "@uni-design-system/uni-core": ">=2.0.2",
29
+ "@uni-design-system/uni-core": ">=2.0.4",
30
30
  "react": ">=18"
31
31
  },
32
32
  "dependencies": {
@@ -59,7 +59,7 @@
59
59
  "vite-plugin-dts": "^4.5.4",
60
60
  "vitest": "^4.1.5",
61
61
  "@uni-design-system/tsconfig": "0.0.0",
62
- "@uni-design-system/uni-core": "2.0.2"
62
+ "@uni-design-system/uni-core": "2.0.4"
63
63
  },
64
64
  "scripts": {
65
65
  "dev": "vite build --watch",