breakouts 0.5.4 → 0.5.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
@@ -112,6 +112,73 @@ $space-scale: (
112
112
 
113
113
  ---
114
114
 
115
+ ## 🎨 Color Utilities
116
+
117
+ Breakouts ships with a small base palette exposed as CSS variables and a few utility classes.
118
+
119
+ ### Base colors (CSS variables)
120
+
121
+ The following tokens are always available:
122
+
123
+ - `--color-background`
124
+ - `--color-surface`
125
+ - `--color-text`
126
+ - `--color-muted`
127
+ - `--color-primary`
128
+ - `--color-secondary`
129
+ - `--color-accent`
130
+ - `--color-neutral-100`
131
+ - `--color-neutral-200`
132
+ - `--color-neutral-300`
133
+ - `--color-neutral-400`
134
+ - `--color-neutral-500`
135
+ - `--color-neutral-600`
136
+ - `--color-neutral-700`
137
+ - `--color-neutral-800`
138
+ - `--color-neutral-900`
139
+
140
+ ### Utility classes
141
+
142
+ #### Background colors
143
+
144
+ | Class | Description |
145
+ |----------------|--------------------------------------|
146
+ | `.bg-surface` | `background-color: var(--color-surface)` |
147
+ | `.bg-primary` | `background-color: var(--color-primary)` |
148
+ | `.bg-secondary` | `background-color: var(--color-secondary)` |
149
+ | `.bg-accent` | `background-color: var(--color-accent)` |
150
+
151
+ #### Text colors
152
+
153
+ | Class | Description |
154
+ |-------------------|-------------------------------------------|
155
+ | `.text-primary` | `color: var(--color-primary)` |
156
+ | `.text-secondary` | `color: var(--color-secondary)` |
157
+ | `.text-accent` | `color: var(--color-accent)` |
158
+ | `.text-surface` | `color: var(--color-surface)` |
159
+ | `.text-muted` | `color: var(--color-muted)` |
160
+ | `.text-neutral-100`| `color: var(--color-neutral-100)` |
161
+ | `.text-neutral-200`| `color: var(--color-neutral-200)` |
162
+ | `.text-neutral-300`| `color: var(--color-neutral-300)` |
163
+ | `.text-neutral-400`| `color: var(--color-neutral-400)` |
164
+ | `.text-neutral-500`| `color: var(--color-neutral-500)` |
165
+ | `.text-neutral-600`| `color: var(--color-neutral-600)` |
166
+ | `.text-neutral-700`| `color: var(--color-neutral-700)` |
167
+ | `.text-neutral-800`| `color: var(--color-neutral-800)` |
168
+ | `.text-neutral-900`| `color: var(--color-neutral-900)` |
169
+
170
+ Example:
171
+
172
+ ```html
173
+ <div class="bg-surface p-4">
174
+ <h3 class="text-primary">Primary title</h3>
175
+ <p class="text-muted">Muted paragraph text</p>
176
+ <p class="text-neutral-700">Neutral text</p>
177
+ </div>
178
+ ```
179
+
180
+ ---
181
+
115
182
  ## 📍 Position Utilities
116
183
 
117
184
  | Class | Description |
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "breakouts",
3
- "version": "0.5.4",
3
+ "version": "0.5.6",
4
4
  "description": "A personal SCSS/CSS layout utility framework.",
5
5
  "main": "dist/breakouts.css",
6
6
  "files": [
@@ -8,7 +8,7 @@ $primary: #ecb838 !default;
8
8
  $secondary: #ab4073 !default;
9
9
  $accent: #196484 !default;
10
10
 
11
- @forward 'breakouts/src/theme/variables' with (
11
+ @forward '../base/variables' with (
12
12
  $color-primary: $primary,
13
13
  $color-primary-dark: darken($primary, 15%),
14
14
  $color-primary-light: lighten($primary, 15%),
@@ -22,8 +22,8 @@ $accent: #196484 !default;
22
22
  $color-accent-light: lighten($accent, 15%),
23
23
  );
24
24
 
25
- @use 'breakouts/src/theme/variables' as *;
26
- @forward 'breakouts/src/theme/colors';
27
- @forward 'breakouts/src/base/reset';
28
- @forward 'breakouts/src/base/typography';
29
- @forward 'breakouts/src/base/layout';
25
+ @use '../base/variables' as *;
26
+ @forward '../base/colors';
27
+ @forward '../base/reset';
28
+ @forward '../base/typography';
29
+ @forward '../base/layout';
@@ -10,7 +10,7 @@ $accent: #E94057 !default;
10
10
  $muted: #FFE5B4 !default;
11
11
  $background: #4F2F4C !default;
12
12
 
13
- @forward 'breakouts/src/theme/variables' with (
13
+ @forward '../base/variables' with (
14
14
  $color-primary: $primary,
15
15
  $color-primary-dark: darken($primary, 15%),
16
16
  $color-primary-light: lighten($primary, 15%),
@@ -32,8 +32,8 @@ $background: #4F2F4C !default;
32
32
  $color-background-light: lighten($background, 5%)
33
33
  );
34
34
 
35
- @use 'breakouts/src/theme/variables' as *;
36
- @forward 'breakouts/src/theme/colors';
37
- @forward 'breakouts/src/base/reset';
38
- @forward 'breakouts/src/base/typography';
39
- @forward 'breakouts/src/base/layout';
35
+ @use '../base/variables' as *;
36
+ @forward '../base/colors';
37
+ @forward '../base/reset';
38
+ @forward '../base/typography';
39
+ @forward '../base/layout';