sass-breakpoint-maps

A minimal Sass library for decluttering your media queries using Sass maps and CSS custom properties

About

sass-breakpoint-maps allows you to define all css properties that should respond to one or more breakpoints in a single, concise Sass Map.

After calling a single mixin they can be referenced as regular CSS custom properties throughout your entire project.

Installation

npm i sass-breakpoint-maps

Import into your Sass file with:

// your path may be different
@use '../node_modules/sass-breakpoint-maps' as sbpm;

Usage

Define a Sass map containing your project's breakpoints, both the map and breakpoint names can be changed freely:

@use 'sass:map';

$breakpoints: (
  tablet: 1060px,
  desktop: 870px
);

Define a Sass map containing the custom properties and their desired values at the breakpoints, as well as a base value (in this case regular):

@use 'sass:map';

$custom-properties: (
  margin-top: (
    regular: 1rem,
    tablet: 2rem,
    desktop: 3rem
  ),
  padding-top: (
    regular: 2rem,
    desktop: 1rem
  ),
  grid-gap: (
    regular: 7px,
    desktop: 10%
  )
);

Call the create-breakpoints mixin within your application's :root tags:

:root {
  @include sbpm.create-breakpoints($custom-properties, $breakpoints);
}

You can then reference your custom properties like usual:

.foo {
  margin-top: var(--margin-top);
}

Configuring create-breakpoints

Argument	Type	Optional	Default
$custom-properties	sass:map	false	--
$breakpoints	sass:map	false	--
$mobile-first	boolean	true	true
$base-name	string	true	regular

Media Queries are set up mobile first by default (using min-width), this can be overridden in the mixin:

:root {
  @include sbpm.create-breakpoints($custom-properties, $breakpoints, $mobile-first: false);
}

regular is the default name for the base value, but can also be changed when calling the mixin:

$custom-properties: (
  margin-top: (
    m: 1rem,
    l: 2rem,
    s: .5rem
  ),
  padding-top: (
    m: 2rem,
    s: 1rem
  ),
  grid-gap: (
    m: 7px,
    l: 10%
  )
);

:root {
  @include sbpm.create-breakpoints($custom-properties, $breakpoints, $base-name: m);
}