@neoptocom/neopto-ui 0.2.1 → 0.4.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/CONSUMER_SETUP.md CHANGED
@@ -11,7 +11,7 @@ This component library uses **Tailwind CSS v4 utility classes** directly in the
11
11
  ### Step 1: Install the library
12
12
 
13
13
  ```bash
14
- npm install @victorfbrito/neo-ui-demo
14
+ npm install @neoptocom/neopto-ui
15
15
  ```
16
16
 
17
17
  ### Step 2: Install Tailwind CSS v4
@@ -27,9 +27,9 @@ Create `postcss.config.js` in your project root:
27
27
  ```js
28
28
  export default {
29
29
  plugins: {
30
- '@tailwindcss/postcss': {}
31
- }
32
- }
30
+ "@tailwindcss/postcss": {},
31
+ },
32
+ };
33
33
  ```
34
34
 
35
35
  ### Step 4: Setup your CSS file
@@ -40,22 +40,22 @@ In your main CSS file (e.g., `src/index.css`):
40
40
  @import "tailwindcss";
41
41
 
42
42
  /* 👇 Scan the component library */
43
- @source "../node_modules/@victorfbrito/neo-ui-demo/dist";
43
+ @source "../node_modules/@neoptocom/neopto-ui/dist";
44
44
 
45
45
  /* 👇 Import library tokens and styles */
46
- @import "@victorfbrito/neo-ui-demo/styles";
46
+ @import "@neoptocom/neopto-ui/styles";
47
47
  ```
48
48
 
49
49
  Then import your CSS in `src/main.tsx`:
50
50
 
51
51
  ```tsx
52
- import './index.css'
52
+ import "./index.css";
53
53
  ```
54
54
 
55
55
  ### Step 5: Use the components!
56
56
 
57
57
  ```tsx
58
- import { Button, Input, Typo } from '@victorfbrito/neo-ui-demo';
58
+ import { Button, Input, Typo } from "@neoptocom/neopto-ui";
59
59
 
60
60
  function App() {
61
61
  return (
@@ -76,13 +76,13 @@ Toggle dark mode by adding/removing the `dark` class to your root element:
76
76
 
77
77
  ```tsx
78
78
  // Enable dark mode
79
- document.documentElement.classList.add('dark');
79
+ document.documentElement.classList.add("dark");
80
80
 
81
81
  // Disable dark mode
82
- document.documentElement.classList.remove('dark');
82
+ document.documentElement.classList.remove("dark");
83
83
 
84
84
  // Toggle
85
- document.documentElement.classList.toggle('dark');
85
+ document.documentElement.classList.toggle("dark");
86
86
  ```
87
87
 
88
88
  ---
@@ -90,7 +90,7 @@ document.documentElement.classList.toggle('dark');
90
90
  ## 🎨 Available Components
91
91
 
92
92
  - `Button` - Interactive buttons with variants
93
- - `Input` - Text input fields
93
+ - `Input` - Text input fields
94
94
  - `Typo` - Typography with design tokens
95
95
  - `Avatar` & `AvatarGroup` - User avatars
96
96
  - `Autocomplete` - Autocomplete input
@@ -109,7 +109,8 @@ document.documentElement.classList.toggle('dark');
109
109
  **Problem:** Components render but look unstyled.
110
110
 
111
111
  **Solution:** Make sure you:
112
- 1. ✅ Imported the library CSS: `import '@victorfbrito/neo-ui-demo/styles'`
112
+
113
+ 1. ✅ Imported the library CSS: `import '@neoptocom/neopto-ui/styles'`
113
114
  2. ✅ Added the library path to `tailwind.config.js` content array
114
115
  3. ✅ Have Tailwind CSS installed and configured
115
116
 
@@ -123,5 +124,4 @@ document.documentElement.classList.toggle('dark');
123
124
 
124
125
  ## 📚 Full Documentation
125
126
 
126
- Visit the [Storybook documentation](https://victorfbrito.github.io/neo-ui-demo/) for interactive examples and API documentation.
127
-
127
+ Visit the [Storybook documentation](https://neoptocom.github.io/neopto-ui/storybook-static) for interactive examples and API documentation.
package/README.md CHANGED
@@ -18,7 +18,7 @@ A modern React component library built with Tailwind CSS v4 and TypeScript. Feat
18
18
  ### Step 1: Install the library
19
19
 
20
20
  ```bash
21
- npm install @victorfbrito/neo-ui-demo
21
+ npm install @neoptocom/neopto-ui
22
22
  ```
23
23
 
24
24
  ### Step 2: Install Tailwind CSS v4
@@ -34,9 +34,9 @@ Create `postcss.config.js` in your project root:
34
34
  ```js
35
35
  export default {
36
36
  plugins: {
37
- '@tailwindcss/postcss': {}
38
- }
39
- }
37
+ "@tailwindcss/postcss": {},
38
+ },
39
+ };
40
40
  ```
41
41
 
42
42
  ### Step 4: Setup your CSS file
@@ -47,16 +47,16 @@ In your main CSS file (e.g., `src/index.css`):
47
47
  @import "tailwindcss";
48
48
 
49
49
  /* 👇 Scan the component library */
50
- @source "../node_modules/@victorfbrito/neo-ui-demo/dist";
50
+ @source "../node_modules/@neoptocom/neopto-ui/dist";
51
51
 
52
52
  /* 👇 Import library styles */
53
- @import "@victorfbrito/neo-ui-demo/styles";
53
+ @import "@neoptocom/neopto-ui/styles";
54
54
  ```
55
55
 
56
56
  Then import this CSS in your `src/main.tsx`:
57
57
 
58
58
  ```tsx
59
- import './index.css'
59
+ import "./index.css";
60
60
  ```
61
61
 
62
62
  ## 🎨 Usage
@@ -64,7 +64,7 @@ import './index.css'
64
64
  ### Basic Example
65
65
 
66
66
  ```tsx
67
- import { Button, Input, Typo } from '@victorfbrito/neo-ui-demo';
67
+ import { Button, Input, Typo } from "@neoptocom/neopto-ui";
68
68
 
69
69
  function App() {
70
70
  return (
@@ -81,10 +81,10 @@ function App() {
81
81
 
82
82
  ```tsx
83
83
  // Enable dark mode
84
- document.documentElement.classList.add('dark');
84
+ document.documentElement.classList.add("dark");
85
85
 
86
86
  // Toggle dark mode
87
- document.documentElement.classList.toggle('dark');
87
+ document.documentElement.classList.toggle("dark");
88
88
  ```
89
89
 
90
90
  ## Why Tailwind CSS v4 is Required
@@ -96,47 +96,52 @@ This library uses **Tailwind CSS v4** utility classes directly in components (e.
96
96
  ## 🧩 Components
97
97
 
98
98
  ### Button
99
+
99
100
  ```tsx
100
- import { Button } from '@your-username/my-ui-lib';
101
+ import { Button } from "@neoptocom/neopto-ui";
101
102
 
102
103
  <Button variant="primary" size="md">
103
104
  Click me
104
- </Button>
105
+ </Button>;
105
106
  ```
106
107
 
107
108
  ### Input
109
+
108
110
  ```tsx
109
- import { Input } from '@your-username/my-ui-lib';
111
+ import { Input } from "@neoptocom/neopto-ui";
110
112
 
111
- <Input placeholder="Enter text" size="md" />
113
+ <Input placeholder="Enter text" size="md" />;
112
114
  ```
113
115
 
114
116
  ### Typography
117
+
115
118
  ```tsx
116
- import { Typo } from '@your-username/my-ui-lib';
119
+ import { Typo } from "@neoptocom/neopto-ui";
117
120
 
118
121
  <Typo variant="headline-lg" bold="semibold">
119
122
  Heading Text
120
- </Typo>
123
+ </Typo>;
121
124
  ```
122
125
 
123
126
  ### Avatar
127
+
124
128
  ```tsx
125
- import { Avatar, AvatarGroup } from '@your-username/my-ui-lib';
129
+ import { Avatar, AvatarGroup } from "@neoptocom/neopto-ui";
126
130
 
127
131
  <AvatarGroup max={3}>
128
132
  <Avatar name="John Doe" src="/avatar.jpg" />
129
133
  <Avatar name="Jane Smith" />
130
- </AvatarGroup>
134
+ </AvatarGroup>;
131
135
  ```
132
136
 
133
137
  ### Autocomplete
138
+
134
139
  ```tsx
135
- import { Autocomplete } from '@your-username/my-ui-lib';
140
+ import { Autocomplete } from "@neoptocom/neopto-ui";
136
141
 
137
142
  const options = [
138
143
  { label: "Option 1", value: "1" },
139
- { label: "Option 2", value: "2" }
144
+ { label: "Option 2", value: "2" },
140
145
  ];
141
146
 
142
147
  <Autocomplete
@@ -144,7 +149,7 @@ const options = [
144
149
  options={options}
145
150
  selectedOption={selected}
146
151
  onSelect={setSelected}
147
- />
152
+ />;
148
153
  ```
149
154
 
150
155
  ## 🎨 Design Tokens
@@ -160,7 +165,8 @@ The library uses a comprehensive design token system:
160
165
 
161
166
  ## 📚 Documentation
162
167
 
163
- Visit our [Storybook documentation](https://your-username.github.io/my-ui-lib) for:
168
+ Visit our [Storybook documentation](https://neoptocom.github.io/neopto-ui/storybook-static) for:
169
+
164
170
  - Interactive component playground
165
171
  - Design system guidelines
166
172
  - Usage examples
@@ -183,4 +189,4 @@ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file
183
189
  - Built with [React](https://reactjs.org/)
184
190
  - Styled with [Tailwind CSS](https://tailwindcss.com/)
185
191
  - Documented with [Storybook](https://storybook.js.org/)
186
- - Bundled with [tsup](https://tsup.egoist.sh/)
192
+ - Bundled with [tsup](https://tsup.egoist.sh/)