breakouts 0.1.3 → 0.1.4
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 +26 -7
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -49,13 +49,22 @@ bun add breakouts
|
|
|
49
49
|
|
|
50
50
|
---
|
|
51
51
|
|
|
52
|
-
##
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
|
57
|
-
|
|
58
|
-
|
|
|
52
|
+
## 📦 Framework Structure
|
|
53
|
+
|
|
54
|
+
Breakouts includes a small set of layout-focused utility classes to help you build responsive and consistent page structures.
|
|
55
|
+
|
|
56
|
+
| Class | Purpose |
|
|
57
|
+
|----------------|---------------------------------------------------------------------------|
|
|
58
|
+
| `.container` | Creates a centered layout wrapper with a max-width and responsive padding |
|
|
59
|
+
| `.full-bleed` | Stretches content edge-to-edge across the viewport |
|
|
60
|
+
| `.breakout` | Expands content outside the container’s padding without going full-bleed |
|
|
61
|
+
| `.grid` | Defines a named-line CSS grid with `main` and `full` layout regions |
|
|
62
|
+
| `.grid--full` | Forces children of `.grid` to span the entire width (`full` region) |
|
|
63
|
+
| `.breakouts-grid` | A more advanced named-line grid layout using CSS variables |
|
|
64
|
+
| `.content` | Places content in the main centered column within `.breakouts-grid` |
|
|
65
|
+
| `.popout` | Slightly outside the `.content` width for medium breakout |
|
|
66
|
+
| `.feature` | Wider area used for highlighting visual components |
|
|
67
|
+
| `.full` | Full-width layout spanning the entire grid |
|
|
59
68
|
|
|
60
69
|
---
|
|
61
70
|
|
|
@@ -156,6 +165,16 @@ Or create a custom theme:
|
|
|
156
165
|
|
|
157
166
|
---
|
|
158
167
|
|
|
168
|
+
## 🎨 Prebuilt Themes
|
|
169
|
+
|
|
170
|
+
| Theme Name | Description | Import Path |
|
|
171
|
+
|----------------|----------------------------------------------------------------|----------------------------------------|
|
|
172
|
+
| **Chupa Pop** | Bold and colorful palette inspired by candy tones | `@use 'breakouts/theme/chupa-pop'` |
|
|
173
|
+
| **Medical** | Calm, healthcare-inspired palette with blues and greens | `@use 'breakouts/theme/medical'` |
|
|
174
|
+
| **Tootsie Pop**| Retro and playful candy-themed palette | `@use 'breakouts/theme/tootsie-pop'` |
|
|
175
|
+
|
|
176
|
+
---
|
|
177
|
+
|
|
159
178
|
## 💡 Extend Breakouts
|
|
160
179
|
|
|
161
180
|
You can write your own mixins or import individual parts:
|