@vertis-components/components 1.0.0 → 1.0.1
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 +14 -2
- package/USAGE.md +10 -10
- package/package.json +1 -1
- package/scripts/convert-tailwind.js +1 -1
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# @vertis/components
|
|
1
|
+
# @vertis-components/components
|
|
2
2
|
|
|
3
3
|
Production-ready React UI component library with Figma design token integration and Tailwind CSS styling.
|
|
4
4
|
|
|
@@ -14,9 +14,21 @@ Production-ready React UI component library with Figma design token integration
|
|
|
14
14
|
## Installation
|
|
15
15
|
|
|
16
16
|
```bash
|
|
17
|
-
npm install @vertis/components
|
|
17
|
+
npm install @vertis-components/components
|
|
18
18
|
```
|
|
19
19
|
|
|
20
|
+
## Basic usage
|
|
21
|
+
|
|
22
|
+
```tsx
|
|
23
|
+
import { Button } from '@vertis-components/components';
|
|
24
|
+
|
|
25
|
+
function App() {
|
|
26
|
+
return <Button variant="primary">Click me</Button>;
|
|
27
|
+
}
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
For full setup (Tailwind, theme, Figma), see [USAGE.md](./USAGE.md). For live demos and all components, see [Storybook](https://vertis-components.vercel.app/).
|
|
31
|
+
|
|
20
32
|
## Quick Start
|
|
21
33
|
|
|
22
34
|
1. Generate your theme from Figma tokens
|
package/USAGE.md
CHANGED
|
@@ -1,11 +1,11 @@
|
|
|
1
|
-
# @vertis/components - Usage Guide
|
|
1
|
+
# @vertis-components/components - Usage Guide
|
|
2
2
|
|
|
3
3
|
The Vertis Component Library with Figma design token integration.
|
|
4
4
|
|
|
5
5
|
## Installation
|
|
6
6
|
|
|
7
7
|
```bash
|
|
8
|
-
npm install @vertis/components
|
|
8
|
+
npm install @vertis-components/components
|
|
9
9
|
```
|
|
10
10
|
|
|
11
11
|
## Quick Start (3 Steps)
|
|
@@ -55,7 +55,7 @@ This creates:
|
|
|
55
55
|
**Create or update `tailwind.config.js`:**
|
|
56
56
|
|
|
57
57
|
```javascript
|
|
58
|
-
const { loadTheme } = require('@vertis/components/tailwind-helper');
|
|
58
|
+
const { loadTheme } = require('@vertis-components/components/tailwind-helper');
|
|
59
59
|
const theme = loadTheme();
|
|
60
60
|
|
|
61
61
|
module.exports = {
|
|
@@ -66,8 +66,8 @@ module.exports = {
|
|
|
66
66
|
'./app/**/*.{js,ts,jsx,tsx}',
|
|
67
67
|
'./pages/**/*.{js,ts,jsx,tsx}',
|
|
68
68
|
'./components/**/*.{js,ts,jsx,tsx}',
|
|
69
|
-
// Include @vertis/components
|
|
70
|
-
'./node_modules/@vertis/components/dist/**/*.{js,mjs}',
|
|
69
|
+
// Include @vertis-components/components
|
|
70
|
+
'./node_modules/@vertis-components/components/dist/**/*.{js,mjs}',
|
|
71
71
|
],
|
|
72
72
|
|
|
73
73
|
theme: {
|
|
@@ -101,7 +101,7 @@ module.exports = {
|
|
|
101
101
|
**In your main CSS file (e.g., `globals.css` or `app/globals.css`):**
|
|
102
102
|
|
|
103
103
|
```css
|
|
104
|
-
@import '@vertis/components/styles.css';
|
|
104
|
+
@import '@vertis-components/components/styles.css';
|
|
105
105
|
|
|
106
106
|
@tailwind base;
|
|
107
107
|
@tailwind components;
|
|
@@ -113,7 +113,7 @@ module.exports = {
|
|
|
113
113
|
**In your React components:**
|
|
114
114
|
|
|
115
115
|
```tsx
|
|
116
|
-
import { Button, Card, Input, cn } from '@vertis/components';
|
|
116
|
+
import { Button, Card, Input, cn } from '@vertis-components/components';
|
|
117
117
|
|
|
118
118
|
export default function App() {
|
|
119
119
|
return (
|
|
@@ -207,7 +207,7 @@ See the [Storybook documentation](https://vertis-components.vercel.app/) for liv
|
|
|
207
207
|
All components are fully typed. Import types:
|
|
208
208
|
|
|
209
209
|
```tsx
|
|
210
|
-
import type { ButtonProps, CardProps, InputProps } from '@vertis/components';
|
|
210
|
+
import type { ButtonProps, CardProps, InputProps } from '@vertis-components/components';
|
|
211
211
|
```
|
|
212
212
|
|
|
213
213
|
---
|
|
@@ -220,8 +220,8 @@ Run `npx vertis-sync-figma && npx vertis-generate-theme` to generate your theme.
|
|
|
220
220
|
|
|
221
221
|
### Components not styled correctly
|
|
222
222
|
|
|
223
|
-
1. Ensure `@import '@vertis/components/styles.css';` is in your main CSS
|
|
224
|
-
2. Check `tailwind.config.js` includes `./node_modules/@vertis/components/dist/**/*.{js,mjs}` in `content`
|
|
223
|
+
1. Ensure `@import '@vertis-components/components/styles.css';` is in your main CSS
|
|
224
|
+
2. Check `tailwind.config.js` includes `./node_modules/@vertis-components/components/dist/**/*.{js,mjs}` in `content`
|
|
225
225
|
3. Verify `darkMode: 'class'` is set in Tailwind config
|
|
226
226
|
4. Restart your dev server after config changes
|
|
227
227
|
|
package/package.json
CHANGED
|
@@ -285,4 +285,4 @@ console.log(' border-grey-300 dark:border-grey-700');
|
|
|
285
285
|
console.log('\n Dark mode toggle:');
|
|
286
286
|
console.log(' document.documentElement.classList.toggle("dark");');
|
|
287
287
|
console.log('\n Next step: Configure Tailwind to use this theme.');
|
|
288
|
-
console.log(' See the @vertis/components USAGE.md for details.\n');
|
|
288
|
+
console.log(' See the @vertis-components/components USAGE.md for details.\n');
|