@sntxindu/ui 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 ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 Syntax Industries, Inc.
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,145 @@
1
+ # @syntax-industries/ui
2
+
3
+ Enterprise-grade React UI component library built with Radix UI and Tailwind CSS.
4
+
5
+ ## Installation
6
+
7
+ ```bash
8
+ npm install @syntax-industries/ui
9
+ # or
10
+ yarn add @syntax-industries/ui
11
+ # or
12
+ pnpm add @syntax-industries/ui
13
+ ```
14
+
15
+ ## Peer Dependencies
16
+
17
+ Make sure you have the following installed:
18
+
19
+ ```bash
20
+ npm install react react-dom tailwindcss
21
+ ```
22
+
23
+ ## Setup
24
+
25
+ ### 1. Import the CSS
26
+
27
+ In your main application file (e.g., `_app.tsx` or `layout.tsx`):
28
+
29
+ ```tsx
30
+ import '@syntax-industries/ui/styles.css'
31
+ ```
32
+
33
+ ### 2. Configure Tailwind
34
+
35
+ Add the component library to your `tailwind.config.js`:
36
+
37
+ ```js
38
+ module.exports = {
39
+ content: [
40
+ './app/**/*.{js,ts,jsx,tsx,mdx}',
41
+ './pages/**/*.{js,ts,jsx,tsx,mdx}',
42
+ './components/**/*.{js,ts,jsx,tsx,mdx}',
43
+ './node_modules/@syntax-industries/ui/dist/**/*.{js,mjs}',
44
+ ],
45
+ // ... rest of your config
46
+ }
47
+ ```
48
+
49
+ ## Usage
50
+
51
+ ### Import Components
52
+
53
+ ```tsx
54
+ import { Button, Card, Badge } from '@syntax-industries/ui'
55
+
56
+ function App() {
57
+ return (
58
+ <Card>
59
+ <CardHeader>
60
+ <CardTitle>Welcome</CardTitle>
61
+ <CardDescription>Get started with Syntax Industries UI</CardDescription>
62
+ </CardHeader>
63
+ <CardContent>
64
+ <p>Your content here</p>
65
+ </CardContent>
66
+ <CardFooter>
67
+ <Button>Get Started</Button>
68
+ <Badge>New</Badge>
69
+ </CardFooter>
70
+ </Card>
71
+ )
72
+ }
73
+ ```
74
+
75
+ ### Individual Component Imports
76
+
77
+ For better tree-shaking, you can import components individually:
78
+
79
+ ```tsx
80
+ import { Button } from '@syntax-industries/ui/components/button'
81
+ import { Card } from '@syntax-industries/ui/components/card'
82
+ ```
83
+
84
+ ## Available Components
85
+
86
+ - **Buttons**: `Button`, `ButtonGroup`
87
+ - **Cards**: `Card`, `CardHeader`, `CardTitle`, `CardDescription`, `CardContent`, `CardFooter`
88
+ - **Forms**: `Input`, `Textarea`, `Select`, `Checkbox`, `RadioGroup`, `Switch`, `Slider`, `Label`
89
+ - **Feedback**: `Alert`, `Badge`, `Progress`, `Spinner`, `Skeleton`, `Tooltip`
90
+ - **Navigation**: `Breadcrumb`, `Pagination`, `Tabs`, `Accordion`
91
+ - **Overlays**: `Dialog`, `Sheet`, `Popover`, `HoverCard`, `DropdownMenu`, `ContextMenu`
92
+ - **Data Display**: `Table`, `Avatar`, `Calendar`, `ScrollArea`
93
+ - **Layout**: `Separator`, `Collapsible`, `ResizablePanel`
94
+ - **Controls**: `Toggle`, `ToggleGroup`, `Combobox`, `Command`
95
+ - **Typography**: `Kbd`
96
+
97
+ ## Theming
98
+
99
+ The components use CSS variables for theming. You can customize the theme in your global CSS:
100
+
101
+ ```css
102
+ :root {
103
+ --primary: 222.2 47.4% 11.2%;
104
+ --primary-foreground: 210 40% 98%;
105
+ --secondary: 210 40% 96.1%;
106
+ --secondary-foreground: 222.2 47.4% 11.2%;
107
+ /* ... other variables */
108
+ }
109
+
110
+ .dark {
111
+ --primary: 210 40% 98%;
112
+ --primary-foreground: 222.2 47.4% 11.2%;
113
+ /* ... other variables */
114
+ }
115
+ ```
116
+
117
+ ## Component Customization
118
+
119
+ All components accept a `className` prop for custom styling:
120
+
121
+ ```tsx
122
+ <Button className="custom-class">
123
+ Custom Styled Button
124
+ </Button>
125
+ ```
126
+
127
+ ## TypeScript Support
128
+
129
+ Full TypeScript support with type definitions included.
130
+
131
+ ```tsx
132
+ import type { ButtonProps } from '@syntax-industries/ui'
133
+
134
+ const MyButton: React.FC<ButtonProps> = (props) => {
135
+ return <Button {...props} />
136
+ }
137
+ ```
138
+
139
+ ## License
140
+
141
+ MIT © Syntax Industries, Inc.
142
+
143
+ ## Support
144
+
145
+ For issues and feature requests, please visit our [GitHub repository](https://github.com/syntax-industries/ui).