braid-ui 1.0.5 → 1.0.6

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 CHANGED
@@ -10,9 +10,18 @@ npm install braid-ui
10
10
 
11
11
  ## Setup
12
12
 
13
- **No additional setup required!** The styles are automatically bundled with the components.
13
+ ### 1. Import the styles
14
14
 
15
- However, if you want to customize the styling, you can configure Tailwind CSS in your project:
15
+ You need to import the CSS styles for the components to display correctly:
16
+
17
+ ```tsx
18
+ // In your main App.tsx or main CSS file
19
+ import 'braid-ui/styles'
20
+ ```
21
+
22
+ ### 2. Configure Tailwind CSS
23
+
24
+ Your project needs Tailwind CSS configured. If you don't have it:
16
25
 
17
26
  ```bash
18
27
  npm install -D tailwindcss postcss autoprefixer
@@ -29,7 +38,48 @@ module.exports = {
29
38
  "./node_modules/braid-ui/dist/**/*.{js,ts,jsx,tsx}", // Add this line
30
39
  ],
31
40
  theme: {
32
- extend: {},
41
+ extend: {
42
+ colors: {
43
+ border: 'hsl(var(--border))',
44
+ input: 'hsl(var(--input))',
45
+ ring: 'hsl(var(--ring))',
46
+ background: 'hsl(var(--background))',
47
+ foreground: 'hsl(var(--foreground))',
48
+ primary: {
49
+ DEFAULT: 'hsl(var(--primary))',
50
+ foreground: 'hsl(var(--primary-foreground))',
51
+ },
52
+ secondary: {
53
+ DEFAULT: 'hsl(var(--secondary))',
54
+ foreground: 'hsl(var(--secondary-foreground))',
55
+ },
56
+ destructive: {
57
+ DEFAULT: 'hsl(var(--destructive))',
58
+ foreground: 'hsl(var(--destructive-foreground))',
59
+ },
60
+ muted: {
61
+ DEFAULT: 'hsl(var(--muted))',
62
+ foreground: 'hsl(var(--muted-foreground))',
63
+ },
64
+ accent: {
65
+ DEFAULT: 'hsl(var(--accent))',
66
+ foreground: 'hsl(var(--accent-foreground))',
67
+ },
68
+ popover: {
69
+ DEFAULT: 'hsl(var(--popover))',
70
+ foreground: 'hsl(var(--popover-foreground))',
71
+ },
72
+ card: {
73
+ DEFAULT: 'hsl(var(--card))',
74
+ foreground: 'hsl(var(--card-foreground))',
75
+ },
76
+ },
77
+ borderRadius: {
78
+ lg: 'var(--radius)',
79
+ md: 'calc(var(--radius) - 2px)',
80
+ sm: 'calc(var(--radius) - 4px)',
81
+ },
82
+ },
33
83
  },
34
84
  plugins: [],
35
85
  }