breakouts 0.0.1 → 0.0.2
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 +21 -0
- package/README.md +65 -0
- package/package.json +1 -1
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2025 Cantilux
|
|
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
|
|
13
|
+
all 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
|
|
20
|
+
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
|
|
21
|
+
IN THE SOFTWARE.
|
package/README.md
CHANGED
|
@@ -0,0 +1,65 @@
|
|
|
1
|
+
# ✨ Breakouts
|
|
2
|
+
|
|
3
|
+
**Breakouts** is a minimal and extensible SCSS/CSS utility framework for modern layout systems.
|
|
4
|
+
|
|
5
|
+
It provides utilities for containers, full-bleed sections, breakout content, and grid layouts with named lines — built for flexibility and responsiveness, whether you're building a landing page, a blog, or a full-scale web app.
|
|
6
|
+
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
## 🚀 Installation
|
|
10
|
+
|
|
11
|
+
### via npm
|
|
12
|
+
|
|
13
|
+
```bash
|
|
14
|
+
npm install breakouts
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
## 📦 Framework Structure
|
|
18
|
+
|
|
19
|
+
Breakouts includes a small set of layout-focused utility classes to help you build responsive and consistent page structures.
|
|
20
|
+
|
|
21
|
+
| Class | Purpose |
|
|
22
|
+
|----------------|---------------------------------------------------------------------------|
|
|
23
|
+
| `.container` | Creates a centered layout wrapper with a max-width and responsive padding |
|
|
24
|
+
| `.full-bleed` | Stretches content edge-to-edge across the viewport |
|
|
25
|
+
| `.breakout` | Expands content outside the container’s padding without going full-bleed |
|
|
26
|
+
| `.grid` | Defines a named-line CSS grid with `main` and `full` layout regions |
|
|
27
|
+
| `.grid--full` | Forces children of `.grid` to span the entire width (`full` region) |
|
|
28
|
+
|
|
29
|
+
## 🛠️ Development
|
|
30
|
+
|
|
31
|
+
To build or modify Breakouts locally, follow these steps:
|
|
32
|
+
|
|
33
|
+
1. Install dependencies:
|
|
34
|
+
|
|
35
|
+
```bash
|
|
36
|
+
npm install
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
2. Build the CSS files:
|
|
40
|
+
|
|
41
|
+
```bash
|
|
42
|
+
npm run build
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
This will generate two files in the dist/ folder:
|
|
46
|
+
|
|
47
|
+
breakouts.css: the expanded, human-readable version (ideal for development)
|
|
48
|
+
|
|
49
|
+
breakouts.min.css: the minified version (ideal for production)
|
|
50
|
+
|
|
51
|
+
You can customize or extend the framework by editing the SCSS source files located in the src/ directory. The entry point is:
|
|
52
|
+
|
|
53
|
+
```bash
|
|
54
|
+
src/_index.scss
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
The build process uses Dart Sass under the hood.
|
|
58
|
+
|
|
59
|
+
## 📄 License
|
|
60
|
+
|
|
61
|
+
This project is licensed under the [MIT License](LICENSE).
|
|
62
|
+
|
|
63
|
+
You are free to use, modify, distribute, and even sell this framework in personal or commercial projects — just include the original license and copyright.
|
|
64
|
+
|
|
65
|
+
> © 2025 Cantilux
|