neon-ui-lib 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/LICENSE +21 -0
- package/README.md +77 -0
- package/package.json +65 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 ektadubey3
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,77 @@
|
|
|
1
|
+
# Neon UI
|
|
2
|
+
|
|
3
|
+
A React, TypeScript, Vite, and Storybook starter for a product-focused frontend design system.
|
|
4
|
+
|
|
5
|
+
## What Is Included
|
|
6
|
+
|
|
7
|
+
- Design tokens in TypeScript and CSS custom properties.
|
|
8
|
+
- Global CSS primitives for focus, typography, surfaces, borders, and radius.
|
|
9
|
+
- Typed React components with Storybook stories:
|
|
10
|
+
- `Button`
|
|
11
|
+
- `IconButton`
|
|
12
|
+
- `TextField`
|
|
13
|
+
- `Checkbox`
|
|
14
|
+
- `Switch`
|
|
15
|
+
- `Select`
|
|
16
|
+
- `Tabs`
|
|
17
|
+
- `Badge`
|
|
18
|
+
- `Card`
|
|
19
|
+
- `Dialog`
|
|
20
|
+
- `Tooltip`
|
|
21
|
+
- Storybook accessibility addon wiring.
|
|
22
|
+
- Library build setup with Vite and declaration output.
|
|
23
|
+
|
|
24
|
+
## Setup
|
|
25
|
+
|
|
26
|
+
```bash
|
|
27
|
+
npm install
|
|
28
|
+
npm run storybook
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
Build the package:
|
|
32
|
+
|
|
33
|
+
```bash
|
|
34
|
+
npm run build
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
Use components:
|
|
38
|
+
|
|
39
|
+
```tsx
|
|
40
|
+
import { Button, TextField } from "@neon-ui";
|
|
41
|
+
|
|
42
|
+
export function AccountForm() {
|
|
43
|
+
return (
|
|
44
|
+
<form>
|
|
45
|
+
<TextField label="Email" placeholder="name@company.com" />
|
|
46
|
+
<Button type="submit">Save changes</Button>
|
|
47
|
+
</form>
|
|
48
|
+
);
|
|
49
|
+
}
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
## Token Usage
|
|
53
|
+
|
|
54
|
+
Use CSS custom properties in app styles:
|
|
55
|
+
|
|
56
|
+
```css
|
|
57
|
+
.panel {
|
|
58
|
+
background: var(--ds-color-surface);
|
|
59
|
+
border: 1px solid var(--ds-color-border);
|
|
60
|
+
border-radius: var(--ds-radius-lg);
|
|
61
|
+
}
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
Use TypeScript tokens when generating charts, themes, or config:
|
|
65
|
+
|
|
66
|
+
```ts
|
|
67
|
+
import { tokens } from "@neon-ui";
|
|
68
|
+
|
|
69
|
+
const focusColor = tokens.color.focus;
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
## Recommended Next Steps
|
|
73
|
+
|
|
74
|
+
1. Replace `@neon-ui` with your package scope.
|
|
75
|
+
2. Add your brand palette and typography decisions in `src/tokens/tokens.ts` and `src/styles.css`.
|
|
76
|
+
3. Add visual regression testing once the component API stabilizes.
|
|
77
|
+
4. Publish Storybook with CI so designers and engineers share one component reference.
|
package/package.json
ADDED
|
@@ -0,0 +1,65 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "neon-ui-lib",
|
|
3
|
+
"version": "1.0.0",
|
|
4
|
+
"description": "Neon UI is a library which provides production-oriented React components, CSS custom properties, and TypeScript tokens for frontend teams building product interfaces.",
|
|
5
|
+
"keywords": [
|
|
6
|
+
"ui",
|
|
7
|
+
"component-library",
|
|
8
|
+
"design-system"
|
|
9
|
+
],
|
|
10
|
+
"homepage": "https://github.com/ektadubey3/neon-ui#readme",
|
|
11
|
+
"bugs": {
|
|
12
|
+
"url": "https://github.com/ektadubey3/neon-ui/issues"
|
|
13
|
+
},
|
|
14
|
+
"repository": {
|
|
15
|
+
"type": "git",
|
|
16
|
+
"url": "git+https://github.com/ektadubey3/neon-ui.git"
|
|
17
|
+
},
|
|
18
|
+
"license": "ISC",
|
|
19
|
+
"author": "Ekta Dubey",
|
|
20
|
+
"type": "module",
|
|
21
|
+
"exports": {
|
|
22
|
+
".": {
|
|
23
|
+
"types": "./dist/index.d.ts",
|
|
24
|
+
"import": "./dist/index.js",
|
|
25
|
+
"require": "./dist/index.cjs"
|
|
26
|
+
},
|
|
27
|
+
"./styles.css": "./dist/style.css"
|
|
28
|
+
},
|
|
29
|
+
"main": "./dist/index.cjs",
|
|
30
|
+
"types": "./dist/index.d.ts",
|
|
31
|
+
"files": [
|
|
32
|
+
"dist"
|
|
33
|
+
],
|
|
34
|
+
"scripts": {
|
|
35
|
+
"dev": "storybook dev -p 6006",
|
|
36
|
+
"storybook": "storybook dev -p 6006",
|
|
37
|
+
"build": "tsc && vite build",
|
|
38
|
+
"build-storybook": "storybook build",
|
|
39
|
+
"typecheck": "tsc --noEmit"
|
|
40
|
+
},
|
|
41
|
+
"dependencies": {
|
|
42
|
+
"clsx": "^2.1.1",
|
|
43
|
+
"lucide-react": "^0.468.0"
|
|
44
|
+
},
|
|
45
|
+
"devDependencies": {
|
|
46
|
+
"@storybook/addon-a11y": "^8.4.7",
|
|
47
|
+
"@storybook/addon-essentials": "^8.4.7",
|
|
48
|
+
"@storybook/addon-interactions": "^8.4.7",
|
|
49
|
+
"@storybook/blocks": "^8.4.7",
|
|
50
|
+
"@storybook/react": "^8.4.7",
|
|
51
|
+
"@storybook/react-vite": "^8.4.7",
|
|
52
|
+
"@types/react": "^18.3.12",
|
|
53
|
+
"@types/react-dom": "^18.3.1",
|
|
54
|
+
"@vitejs/plugin-react": "^4.3.4",
|
|
55
|
+
"storybook": "^8.4.7",
|
|
56
|
+
"typescript": "^5.7.2",
|
|
57
|
+
"vite": "^6.0.3",
|
|
58
|
+
"vite-plugin-dts": "^4.3.0"
|
|
59
|
+
},
|
|
60
|
+
"peerDependencies": {
|
|
61
|
+
"react": "^18.2.0 || ^19.0.0",
|
|
62
|
+
"react-dom": "^18.2.0 || ^19.0.0"
|
|
63
|
+
},
|
|
64
|
+
"module": "./dist/index.js"
|
|
65
|
+
}
|