@crossangle-org/cs-ui 0.0.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 +47 -0
- package/dist/cs-ui.css +4371 -0
- package/dist/index.cjs.js +94174 -0
- package/dist/index.cjs.js.map +1 -0
- package/dist/index.d.ts +604 -0
- package/dist/index.es.js +94141 -0
- package/dist/index.es.js.map +1 -0
- package/package.json +101 -0
package/README.md
ADDED
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
# @crossangle-org/cs-ui
|
|
2
|
+
|
|
3
|
+
Common React UI Component Library for Xangle Services.
|
|
4
|
+
Built on Shadcn UI and Tailwind CSS v4, providing an accessible and customizable design system.
|
|
5
|
+
|
|
6
|
+
## Installation
|
|
7
|
+
|
|
8
|
+
```bash
|
|
9
|
+
npm install @crossangle-org/cs-ui
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
## Setup
|
|
13
|
+
|
|
14
|
+
This library uses Tailwind CSS v4 styling. Import the stylesheet in your project's root file (e.g., `App.tsx`, `layout.tsx`, `index.tsx`).
|
|
15
|
+
|
|
16
|
+
```tsx
|
|
17
|
+
import '@crossangle-org/cs-ui/globals.css';
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
## Peer Dependencies
|
|
21
|
+
|
|
22
|
+
Ensure the following packages are installed in your project:
|
|
23
|
+
|
|
24
|
+
- `react` >= 18
|
|
25
|
+
- `react-dom` >= 18
|
|
26
|
+
- `tailwindcss` >= 4
|
|
27
|
+
|
|
28
|
+
## Usage
|
|
29
|
+
|
|
30
|
+
Import components directly:
|
|
31
|
+
|
|
32
|
+
```tsx
|
|
33
|
+
import { CsButton, CsInput } from '@crossangle-org/cs-ui';
|
|
34
|
+
|
|
35
|
+
function Example() {
|
|
36
|
+
return (
|
|
37
|
+
<div className="flex gap-4 p-4">
|
|
38
|
+
<CsInput placeholder="Type something..." />
|
|
39
|
+
<CsButton variant="primary">Submit</CsButton>
|
|
40
|
+
</div>
|
|
41
|
+
);
|
|
42
|
+
}
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
## Documentation & Preview
|
|
46
|
+
|
|
47
|
+
- **Hosted Storybook**: [https://storybook.xangle.io](https://storybook.xangle.io)
|