๐Ÿ“ Breakouts Framework

A minimal, modular SCSS/CSS layout and utility framework built for clarity and rapid layout composition.

๐Ÿš€ Installation

npm install breakouts
# or
bun add breakouts

๐Ÿ›  Usage

SCSS with @use

@use 'breakouts' as *;

Import CSS

<link rel="stylesheet" href="/node_modules/breakouts/dist/breakouts.css" />

๐Ÿงฑ Features

๐ŸŽจ Prebuilt Themes

โœ๏ธ Utilities

Text

Left aligned

Center aligned

Right aligned

Uppercase text

Bold text

Spacing

Margin 4
Padding 4
Margin X3 Y2

๐Ÿ“ Layout

.container centers the content and limits its width.

.full-bleed spans the entire viewport width.

Full
Feature
Popout
Content

๐Ÿ”ค Typography

Heading 1

Heading 2

Heading 3

Paragraph text with a link.

๐ŸŽจ Color Utilities

bg-primary
bg-secondary
bg-accent
bg-muted
bg-surface
background

๐ŸŒ— Dark Mode

You can use <html class="dark"> to enable dark mode. The toggle button above will also switch themes live.

๐Ÿงช Customize

Use @use ... with (...) to override default variables.

@use 'breakouts' with (
  $color-primary: #d1ff4a,
  $color-accent: #8a2be2
);

๐Ÿ’ก Extend

Import only what you need or create custom modules.

@use 'breakouts/base/typography';
@use 'breakouts/utilities/spacing';