@neoaxis/nectar-react 0.1.1 → 0.1.2
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 +18 -22
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -7,7 +7,7 @@ Built on [Radix UI](https://www.radix-ui.com/) primitives with full accessibilit
|
|
|
7
7
|
## Installation
|
|
8
8
|
|
|
9
9
|
```sh
|
|
10
|
-
npm install @neoaxis/nectar-react
|
|
10
|
+
npm install @neoaxis/nectar-react
|
|
11
11
|
```
|
|
12
12
|
|
|
13
13
|
## Setup
|
|
@@ -15,49 +15,45 @@ npm install @neoaxis/nectar-react @neoaxis/nectar-tokens
|
|
|
15
15
|
Import the stylesheet and wrap your application with `NectarProvider`:
|
|
16
16
|
|
|
17
17
|
```tsx
|
|
18
|
-
import "@neoaxis/nectar-react/style.css"
|
|
19
|
-
import { NectarProvider } from "@neoaxis/nectar-react"
|
|
18
|
+
import "@neoaxis/nectar-react/style.css"
|
|
19
|
+
import { NectarProvider } from "@neoaxis/nectar-react"
|
|
20
20
|
|
|
21
21
|
function App() {
|
|
22
|
-
return
|
|
23
|
-
<NectarProvider>
|
|
24
|
-
{/* your app */}
|
|
25
|
-
</NectarProvider>
|
|
26
|
-
);
|
|
22
|
+
return <NectarProvider>{/* your app */}</NectarProvider>
|
|
27
23
|
}
|
|
28
24
|
```
|
|
29
25
|
|
|
30
26
|
## Components
|
|
31
27
|
|
|
32
|
-
| Category
|
|
33
|
-
|
|
34
|
-
| **Actions**
|
|
35
|
-
| **Feedback**
|
|
36
|
-
| **Form**
|
|
37
|
-
| **Layout**
|
|
38
|
-
| **Overlay**
|
|
39
|
-
| **Primitives** | `Heading`, `Text`, `Icon`, `Hotkey`, `SectionTitle`
|
|
28
|
+
| Category | Components |
|
|
29
|
+
| -------------- | -------------------------------------------------------------------------- |
|
|
30
|
+
| **Actions** | `Button` |
|
|
31
|
+
| **Feedback** | `Progress` |
|
|
32
|
+
| **Form** | `Form`, `FormFieldText`, `FormFieldSelect`, `FormFieldSwitch`, `FormGroup` |
|
|
33
|
+
| **Layout** | `List`, `SidebarAccordion`, `Toolbar` |
|
|
34
|
+
| **Overlay** | `ContextMenu`, `Popover`, `Tooltip` |
|
|
35
|
+
| **Primitives** | `Heading`, `Text`, `Icon`, `Hotkey`, `SectionTitle` |
|
|
40
36
|
|
|
41
37
|
## Usage example
|
|
42
38
|
|
|
43
39
|
```tsx
|
|
44
|
-
import { Button, Tooltip } from "@neoaxis/nectar-react"
|
|
40
|
+
import { Button, Tooltip } from "@neoaxis/nectar-react"
|
|
45
41
|
|
|
46
42
|
function Example() {
|
|
47
43
|
return (
|
|
48
44
|
<Tooltip content="Save changes">
|
|
49
45
|
<Button>Save</Button>
|
|
50
46
|
</Tooltip>
|
|
51
|
-
)
|
|
47
|
+
)
|
|
52
48
|
}
|
|
53
49
|
```
|
|
54
50
|
|
|
55
51
|
## Peer dependencies
|
|
56
52
|
|
|
57
|
-
| Package
|
|
58
|
-
|
|
59
|
-
| `react`
|
|
60
|
-
| `react-dom` | 19.x
|
|
53
|
+
| Package | Version |
|
|
54
|
+
| ----------- | ------- |
|
|
55
|
+
| `react` | 19.x |
|
|
56
|
+
| `react-dom` | 19.x |
|
|
61
57
|
|
|
62
58
|
## Development
|
|
63
59
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@neoaxis/nectar-react",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.2",
|
|
4
4
|
"type": "module",
|
|
5
5
|
"main": "./dist/nectar.js",
|
|
6
6
|
"module": "./dist/nectar.js",
|
|
@@ -14,7 +14,7 @@
|
|
|
14
14
|
"types": "./dist/tokens.d.ts",
|
|
15
15
|
"import": "./dist/tokens.js"
|
|
16
16
|
},
|
|
17
|
-
"./style.css": "./dist
|
|
17
|
+
"./style.css": "./dist/nectar-react.css"
|
|
18
18
|
},
|
|
19
19
|
"files": [
|
|
20
20
|
"dist"
|