@streamoid/ui 0.1.0 → 0.1.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 +45 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
# @streamoid/ui
|
|
2
|
+
|
|
3
|
+
A comprehensive React UI component library for Streamoid applications.
|
|
4
|
+
|
|
5
|
+
## Installation
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm install @streamoid/ui
|
|
9
|
+
# or
|
|
10
|
+
yarn add @streamoid/ui
|
|
11
|
+
# or
|
|
12
|
+
pnpm add @streamoid/ui
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
**Note:** This package requires `@streamoid/icons` as a peer dependency.
|
|
16
|
+
|
|
17
|
+
## Usage
|
|
18
|
+
|
|
19
|
+
Import components directly:
|
|
20
|
+
|
|
21
|
+
```tsx
|
|
22
|
+
import { ScButton } from "@streamoid/ui";
|
|
23
|
+
import "@streamoid/ui/dist/index.css"; // Don't forget to import styles
|
|
24
|
+
|
|
25
|
+
function App() {
|
|
26
|
+
return (
|
|
27
|
+
<ScButton
|
|
28
|
+
text="Click me"
|
|
29
|
+
variant="primary"
|
|
30
|
+
onClick={() => console.log("Clicked")}
|
|
31
|
+
/>
|
|
32
|
+
);
|
|
33
|
+
}
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
## Features
|
|
37
|
+
|
|
38
|
+
- 50+ Reusable Components
|
|
39
|
+
- TypeScript Support
|
|
40
|
+
- Tailwind CSS Compatible
|
|
41
|
+
- Fully Customizable
|
|
42
|
+
|
|
43
|
+
## License
|
|
44
|
+
|
|
45
|
+
ISC
|