@deepgram/styles 0.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/LICENSE ADDED
@@ -0,0 +1,22 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2025 Deepgram
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.
22
+
package/README.md ADDED
@@ -0,0 +1,147 @@
1
+ # @deepgram/styles
2
+
3
+ A Tailwind-based design system and styles library for Deepgram design system and demos.
4
+
5
+ ## Installation
6
+
7
+ ```bash
8
+ npm install @deepgram/styles
9
+ # or
10
+ pnpm add @deepgram/styles
11
+ # or
12
+ yarn add @deepgram/styles
13
+ ```
14
+
15
+ ## Usage
16
+
17
+ ### Basic Usage (Pre-built CSS)
18
+
19
+ Import the pre-built, minified CSS in your application:
20
+
21
+ ```javascript
22
+ import '@deepgram/styles';
23
+ ```
24
+
25
+ Or in HTML:
26
+
27
+ ```html
28
+ <link rel="stylesheet" href="node_modules/@deepgram/styles/dist/deepgram.css">
29
+ ```
30
+
31
+ ### Expanded CSS (Non-minified)
32
+
33
+ For development or easier debugging:
34
+
35
+ ```javascript
36
+ import '@deepgram/styles/expanded';
37
+ ```
38
+
39
+ ### Using with Tailwind CSS
40
+
41
+ If you're using Tailwind CSS in your project, you can extend your configuration with the Deepgram theme:
42
+
43
+ ```javascript
44
+ // tailwind.config.js
45
+ const deepgramConfig = require('@deepgram/styles/tailwind-config');
46
+
47
+ module.exports = {
48
+ presets: [deepgramConfig],
49
+ content: [
50
+ './src/**/*.{html,js,ts,jsx,tsx}',
51
+ // your content paths
52
+ ],
53
+ // your customizations
54
+ };
55
+ ```
56
+
57
+ ### Importing Source Files
58
+
59
+ To customize and build the styles yourself:
60
+
61
+ ```css
62
+ @import '@deepgram/styles/source';
63
+ ```
64
+
65
+ ## Available Components
66
+
67
+ The library provides a comprehensive set of Tailwind-based components:
68
+
69
+ ### Layout
70
+ - `.dg-app-header` - Application header with navigation
71
+ - `.dg-hero` - Hero section for main content
72
+ - `.dg-two-column-layout` - Responsive two-column grid
73
+ - `.dg-container` - Centered content container
74
+ - `.dg-grid-{2,3,4}` - Responsive grid layouts
75
+
76
+ ### Components
77
+ - `.dg-panel` - Content panel with border
78
+ - `.dg-panel-elevated` - Panel with shadow
79
+ - `.dg-card` - Interactive card component
80
+ - `.dg-selection-list` - Vertical selection list
81
+ - `.dg-selection-item` - Selectable list item
82
+ - `.dg-drop-zone` - File drop zone
83
+ - `.dg-result-display` - Content display area
84
+
85
+ ### Buttons
86
+ - `.dg-button-primary` - Primary action button
87
+ - `.dg-button-secondary` - Secondary action button
88
+ - `.dg-button-outline` - Outline button
89
+
90
+ ### Forms
91
+ - `.dg-input` - Text input field
92
+ - `.dg-textarea` - Multi-line text area
93
+ - `.dg-select` - Select dropdown
94
+ - `.dg-checkbox` - Checkbox input
95
+
96
+ ### Utilities
97
+ - `.dg-badge-{success,warning,error,info}` - Status badges
98
+ - `.dg-spinner` - Loading spinner
99
+ - `.dg-divider` - Section divider
100
+ - `.text-gradient` - Text with gradient effect
101
+ - `.scrollbar-thin` - Thin scrollbar styling
102
+
103
+ ## Theme Colors
104
+
105
+ The library includes Deepgram brand colors:
106
+
107
+ - **Primary**: Spring Green (#13ef93)
108
+ - **Accent**: Lavender Blue (#5c68d4)
109
+ - **Dark Mode**: Professional dark theme
110
+ - **Light Mode**: Clean light theme (toggle with `.light-mode` class on body)
111
+
112
+ ## Dark/Light Mode
113
+
114
+ Dark mode is the default. To enable light mode:
115
+
116
+ ```javascript
117
+ document.body.classList.add('light-mode');
118
+ ```
119
+
120
+ To toggle:
121
+
122
+ ```javascript
123
+ document.body.classList.toggle('light-mode');
124
+ ```
125
+
126
+ ## Responsive Design
127
+
128
+ All components are mobile-first and responsive:
129
+
130
+ - Mobile: Single column layouts
131
+ - Tablet (md): Two column layouts
132
+ - Desktop (lg): Multi-column layouts
133
+
134
+ ## Browser Support
135
+
136
+ - Modern browsers (Chrome, Firefox, Safari, Edge)
137
+ - CSS Grid and Flexbox support required
138
+ - CSS Custom Properties (CSS Variables) support required
139
+
140
+ ## License
141
+
142
+ MIT
143
+
144
+ ## Contributing
145
+
146
+ See the [main repository](https://github.com/deepgram/starter-uis) for contribution guidelines.
147
+