@0xsquid/ui 0.2.0 → 1.0.0
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 +1 -56
- package/dist/cjs/index.js +4241 -471
- package/dist/cjs/types/components/index.d.ts +0 -5
- package/dist/cjs/types/index.d.ts +0 -1
- package/dist/cjs/types/providers/SquidConfigProvider.d.ts +1 -0
- package/dist/esm/index.js +4242 -450
- package/dist/esm/types/components/index.d.ts +0 -5
- package/dist/esm/types/index.d.ts +0 -1
- package/dist/esm/types/providers/SquidConfigProvider.d.ts +1 -0
- package/dist/index.d.ts +1 -217
- package/package.json +3 -6
- package/dist/cjs/types/components/badges/index.d.ts +0 -2
- package/dist/cjs/types/components/controls/index.d.ts +0 -3
- package/dist/cjs/types/components/layout/index.d.ts +0 -8
- package/dist/cjs/types/components/lists/index.d.ts +0 -5
- package/dist/cjs/types/components/typography/index.d.ts +0 -3
- package/dist/cjs/types/providers/index.d.ts +0 -1
- package/dist/esm/types/components/badges/index.d.ts +0 -2
- package/dist/esm/types/components/controls/index.d.ts +0 -3
- package/dist/esm/types/components/layout/index.d.ts +0 -8
- package/dist/esm/types/components/lists/index.d.ts +0 -5
- package/dist/esm/types/components/typography/index.d.ts +0 -3
- package/dist/esm/types/providers/index.d.ts +0 -1
package/README.md
CHANGED
|
@@ -2,36 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
React components library for Squid V2
|
|
4
4
|
|
|
5
|
-
##
|
|
6
|
-
|
|
7
|
-
Install the package:
|
|
8
|
-
|
|
9
|
-
```bash
|
|
10
|
-
yarn add @0xsquid/ui
|
|
11
|
-
```
|
|
12
|
-
|
|
13
|
-
Import styles in your entry point:
|
|
14
|
-
|
|
15
|
-
```jsx
|
|
16
|
-
// src/main.tsx | src/pages/_app.tsx | etc...
|
|
17
|
-
import '@0xsquid/ui/dist/index.css'
|
|
18
|
-
```
|
|
19
|
-
|
|
20
|
-
Wrap your app with our theme provider `<SquidConfigProvider />` and specify your theme:
|
|
21
|
-
|
|
22
|
-
```jsx
|
|
23
|
-
import { SquidConfigProvider, Button } from '@0xsquid/ui'
|
|
24
|
-
|
|
25
|
-
function App() {
|
|
26
|
-
return (
|
|
27
|
-
<SquidConfigProvider theme={yourTheme}>
|
|
28
|
-
<Button label="Hello world" variant="primary" size="md" />
|
|
29
|
-
</SquidConfigProvider>
|
|
30
|
-
)
|
|
31
|
-
}
|
|
32
|
-
```
|
|
33
|
-
|
|
34
|
-
## Development
|
|
5
|
+
## Getting Started
|
|
35
6
|
|
|
36
7
|
### Install dependencies
|
|
37
8
|
|
|
@@ -44,29 +15,3 @@ yarn install
|
|
|
44
15
|
```bash
|
|
45
16
|
yarn storybook
|
|
46
17
|
```
|
|
47
|
-
|
|
48
|
-
### Build package
|
|
49
|
-
|
|
50
|
-
To build the package using Rollup, run:
|
|
51
|
-
|
|
52
|
-
```bash
|
|
53
|
-
yarn build
|
|
54
|
-
```
|
|
55
|
-
|
|
56
|
-
This command will:
|
|
57
|
-
|
|
58
|
-
1. compile Tailwind CSS classes into `src/styles/compiled-tailwind.css`
|
|
59
|
-
2. bundle source code, along with its type declarations, into the `dist/` folder
|
|
60
|
-
3. copy `src/styles/compiled-tailwind.css` to `dist/index.css`
|
|
61
|
-
|
|
62
|
-
### Lint and format
|
|
63
|
-
|
|
64
|
-
To format and lint the code, run:
|
|
65
|
-
|
|
66
|
-
```bash
|
|
67
|
-
yarn format:fix
|
|
68
|
-
```
|
|
69
|
-
|
|
70
|
-
```bash
|
|
71
|
-
yarn lint:fix
|
|
72
|
-
```
|