@nextui-org/react 0.0.0-dev-v2-20230731130542 → 0.0.0-dev-v2-20230805020011
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 +2 -46
- package/package.json +32 -32
package/README.md
CHANGED
|
@@ -12,9 +12,9 @@
|
|
|
12
12
|
<a href="https://codecov.io/gh/jrgarciadev/nextui">
|
|
13
13
|
<img src="https://codecov.io/gh/jrgarciadev/nextui/branch/main/graph/badge.svg?token=QJF2QKR5N4" alt="codecov badge">
|
|
14
14
|
</a>
|
|
15
|
-
<a href="https://github.com/nextui-org/nextui/actions/workflows/main.yaml">
|
|
15
|
+
<!-- <a href="https://github.com/nextui-org/nextui/actions/workflows/main.yaml">
|
|
16
16
|
<img src="https://github.com/nextui-org/nextui/actions/workflows/main.yaml/badge.svg" alt="CI/CD nextui">
|
|
17
|
-
</a>
|
|
17
|
+
</a> -->
|
|
18
18
|
<a href="https://www.npmjs.com/package/@nextui-org/react">
|
|
19
19
|
<img src="https://img.shields.io/npm/dm/@nextui-org/react.svg?style=flat-round" alt="npm downloads">
|
|
20
20
|
</a>
|
|
@@ -28,8 +28,6 @@
|
|
|
28
28
|
|
|
29
29
|
> **NOTE:** This is a community project, not associated with [Vercel](https://vercel.com), but does get some inspiration from there.
|
|
30
30
|
|
|
31
|
-
> **Warning 🚧:** This project is still in development, it might have bugs and breaking changes so it is not recommended to use it in production.
|
|
32
|
-
|
|
33
31
|
## Getting Started
|
|
34
32
|
|
|
35
33
|
Visit <a aria-label="nextui learn" href="https://nextui.org/learn">https://nextui.org/guide</a> to get started with NextUI.
|
|
@@ -38,48 +36,6 @@ Visit <a aria-label="nextui learn" href="https://nextui.org/learn">https://nextu
|
|
|
38
36
|
|
|
39
37
|
Visit [https://nextui.org/docs](https://nextui.org/docs) to view the full documentation.
|
|
40
38
|
|
|
41
|
-
## Quick Start
|
|
42
|
-
|
|
43
|
-
1. Installation: Inside your React project directory, install NextUI by running either of the following:
|
|
44
|
-
|
|
45
|
-
```bash
|
|
46
|
-
yarn add @nextui-org/react
|
|
47
|
-
# or
|
|
48
|
-
npm i @nextui-org/react
|
|
49
|
-
```
|
|
50
|
-
|
|
51
|
-
2. Setup: For NextUI to work correctly, you need to set up the `NextUIProvider` at the root of your application.
|
|
52
|
-
|
|
53
|
-
Go to the root of your application and do this:
|
|
54
|
-
|
|
55
|
-
```jsx
|
|
56
|
-
import {NextUIProvider} from "@nextui-org/react";
|
|
57
|
-
|
|
58
|
-
const Application = () => (
|
|
59
|
-
<NextUIProvider>
|
|
60
|
-
<AppComponent /> // ---> Your App Component
|
|
61
|
-
</NextUIProvider>
|
|
62
|
-
);
|
|
63
|
-
```
|
|
64
|
-
|
|
65
|
-
3. Using NextUI components: Once NextUI is installed you can use any of the components as follows.
|
|
66
|
-
NextUI uses tree-shaking so the unused modules will not be included in the bundle during the build process and
|
|
67
|
-
each component is exported separately.
|
|
68
|
-
|
|
69
|
-
```jsx
|
|
70
|
-
import {Button} from "@nextui-org/react";
|
|
71
|
-
|
|
72
|
-
const Component = () => <Button>Click me</Button>;
|
|
73
|
-
```
|
|
74
|
-
|
|
75
|
-
4. NextUI allows to manually import components if you need. E.g.
|
|
76
|
-
|
|
77
|
-
```jsx
|
|
78
|
-
import Button from "@nextui-org/react/button";
|
|
79
|
-
|
|
80
|
-
const Component = () => <Button>Click me</Button>;
|
|
81
|
-
```
|
|
82
|
-
|
|
83
39
|
### Community
|
|
84
40
|
|
|
85
41
|
We're excited to see the community adopt NextUI, raise issues, and provide feedback.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@nextui-org/react",
|
|
3
|
-
"version": "0.0.0-dev-v2-
|
|
3
|
+
"version": "0.0.0-dev-v2-20230805020011",
|
|
4
4
|
"description": "🚀 Beautiful and modern React UI library.",
|
|
5
5
|
"author": "Junior Garcia <jrgarciadev@gmail.com>",
|
|
6
6
|
"homepage": "https://nextui.org",
|
|
@@ -31,37 +31,37 @@
|
|
|
31
31
|
},
|
|
32
32
|
"dependencies": {
|
|
33
33
|
"@react-aria/visually-hidden": "^3.8.2",
|
|
34
|
-
"@nextui-org/system": "0.0.0-dev-v2-
|
|
35
|
-
"@nextui-org/theme": "0.0.0-dev-v2-
|
|
36
|
-
"@nextui-org/
|
|
37
|
-
"@nextui-org/avatar": "0.0.0-dev-v2-
|
|
38
|
-
"@nextui-org/
|
|
39
|
-
"@nextui-org/button": "0.0.0-dev-v2-
|
|
40
|
-
"@nextui-org/
|
|
41
|
-
"@nextui-org/
|
|
42
|
-
"@nextui-org/checkbox": "0.0.0-dev-v2-
|
|
43
|
-
"@nextui-org/code": "0.0.0-dev-v2-
|
|
44
|
-
"@nextui-org/link": "0.0.0-dev-v2-
|
|
45
|
-
"@nextui-org/
|
|
46
|
-
"@nextui-org/
|
|
47
|
-
"@nextui-org/
|
|
48
|
-
"@nextui-org/
|
|
49
|
-
"@nextui-org/
|
|
50
|
-
"@nextui-org/
|
|
51
|
-
"@nextui-org/
|
|
52
|
-
"@nextui-org/
|
|
53
|
-
"@nextui-org/input": "0.0.0-dev-v2-
|
|
54
|
-
"@nextui-org/
|
|
55
|
-
"@nextui-org/
|
|
56
|
-
"@nextui-org/
|
|
57
|
-
"@nextui-org/modal": "0.0.0-dev-v2-
|
|
58
|
-
"@nextui-org/
|
|
59
|
-
"@nextui-org/
|
|
60
|
-
"@nextui-org/
|
|
61
|
-
"@nextui-org/divider": "0.0.0-dev-v2-
|
|
62
|
-
"@nextui-org/kbd": "0.0.0-dev-v2-
|
|
63
|
-
"@nextui-org/
|
|
64
|
-
"@nextui-org/
|
|
34
|
+
"@nextui-org/system": "0.0.0-dev-v2-20230805020011",
|
|
35
|
+
"@nextui-org/theme": "0.0.0-dev-v2-20230805020011",
|
|
36
|
+
"@nextui-org/accordion": "0.0.0-dev-v2-20230805020011",
|
|
37
|
+
"@nextui-org/avatar": "0.0.0-dev-v2-20230805020011",
|
|
38
|
+
"@nextui-org/badge": "0.0.0-dev-v2-20230805020011",
|
|
39
|
+
"@nextui-org/button": "0.0.0-dev-v2-20230805020011",
|
|
40
|
+
"@nextui-org/card": "0.0.0-dev-v2-20230805020011",
|
|
41
|
+
"@nextui-org/chip": "0.0.0-dev-v2-20230805020011",
|
|
42
|
+
"@nextui-org/checkbox": "0.0.0-dev-v2-20230805020011",
|
|
43
|
+
"@nextui-org/code": "0.0.0-dev-v2-20230805020011",
|
|
44
|
+
"@nextui-org/link": "0.0.0-dev-v2-20230805020011",
|
|
45
|
+
"@nextui-org/pagination": "0.0.0-dev-v2-20230805020011",
|
|
46
|
+
"@nextui-org/radio": "0.0.0-dev-v2-20230805020011",
|
|
47
|
+
"@nextui-org/snippet": "0.0.0-dev-v2-20230805020011",
|
|
48
|
+
"@nextui-org/spinner": "0.0.0-dev-v2-20230805020011",
|
|
49
|
+
"@nextui-org/switch": "0.0.0-dev-v2-20230805020011",
|
|
50
|
+
"@nextui-org/tooltip": "0.0.0-dev-v2-20230805020011",
|
|
51
|
+
"@nextui-org/user": "0.0.0-dev-v2-20230805020011",
|
|
52
|
+
"@nextui-org/progress": "0.0.0-dev-v2-20230805020011",
|
|
53
|
+
"@nextui-org/input": "0.0.0-dev-v2-20230805020011",
|
|
54
|
+
"@nextui-org/popover": "0.0.0-dev-v2-20230805020011",
|
|
55
|
+
"@nextui-org/dropdown": "0.0.0-dev-v2-20230805020011",
|
|
56
|
+
"@nextui-org/image": "0.0.0-dev-v2-20230805020011",
|
|
57
|
+
"@nextui-org/modal": "0.0.0-dev-v2-20230805020011",
|
|
58
|
+
"@nextui-org/navbar": "0.0.0-dev-v2-20230805020011",
|
|
59
|
+
"@nextui-org/table": "0.0.0-dev-v2-20230805020011",
|
|
60
|
+
"@nextui-org/spacer": "0.0.0-dev-v2-20230805020011",
|
|
61
|
+
"@nextui-org/divider": "0.0.0-dev-v2-20230805020011",
|
|
62
|
+
"@nextui-org/kbd": "0.0.0-dev-v2-20230805020011",
|
|
63
|
+
"@nextui-org/tabs": "0.0.0-dev-v2-20230805020011",
|
|
64
|
+
"@nextui-org/skeleton": "0.0.0-dev-v2-20230805020011"
|
|
65
65
|
},
|
|
66
66
|
"peerDependencies": {
|
|
67
67
|
"react": ">=18",
|