# seed-breakpoints

> Breakpoints mixin pack for Seed

Latest version **0.4.1** (published 2017-05-26) · MIT license · 0 weekly downloads

## Install

```sh
npm install seed-breakpoints
pnpm add seed-breakpoints
yarn add seed-breakpoints
bun add seed-breakpoints
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.4.1 |
| Published | 2017-05-26 |
| First published | 2016-06-23 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=4 |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Maintainers | itsjonq |
| Keywords | bem, breakpoints, css, dash, design, functional, itcss, modular, oocss, responsive, performance, seed, seed-pack, scss |

## Links

- npm: https://www.npmjs.com/package/seed-breakpoints
- Repository: https://github.com/helpscout/seed-breakpoints
- Issues: https://github.com/helpscout/seed-breakpoints/issues
- npm.io page: https://npm.io/package/seed-breakpoints

## Dependencies (1)

- [seed-props](https://npm.io/package/seed-props.md) 0.3.1

## Alternatives

- [style-dictionary](https://npm.io/package/style-dictionary.md) — 2.0M weekly downloads
- [postcss-merge-idents](https://npm.io/package/postcss-merge-idents.md) — 1.7M weekly downloads
- [@fontsource/noto-sans](https://npm.io/package/@fontsource/noto-sans.md) — 93.0K weekly downloads
- [uglifycss](https://npm.io/package/uglifycss.md) — 71.6K weekly downloads
- [mat4-interpolate](https://npm.io/package/mat4-interpolate.md) — 23.3K weekly downloads

## Recent versions

- 0.4.1 (latest) — 2017-05-26
- 0.4.0 — 2016-09-28
- 0.3.2 — 2016-08-11
- 0.3.1 — 2016-07-25
- 0.3.0 — 2016-07-17
- 0.2.1 — 2016-07-14
- 0.2.0 — 2016-07-13
- 0.1.4 — 2016-07-11
- 0.1.2 — 2016-07-08
- 0.1.1 — 2016-07-08
- 0.1.0 — 2016-07-07
- 0.0.3 — 2016-07-07
- 0.0.2 — 2016-06-23
- 0.0.1 — 2016-06-23

## README

# seed-breakpoints [![Build Status](https://travis-ci.org/helpscout/seed-breakpoints.svg?branch=master)](https://travis-ci.org/helpscout/seed-breakpoints) [![npm version](https://badge.fury.io/js/seed-breakpoints.svg)](https://badge.fury.io/js/seed-breakpoints) [![Dependencies](https://david-dm.org/helpscout/seed-breakpoints.svg)](https://david-dm.org/helpscout/seed-breakpoints)

Breakpoints (media query) mixin pack for [Seed](https://github.com/helpscout/seed)!

Breakpoints was inspired by the mixins in [Bootstrap V4](https://github.com/twbs/bootstrap/tree/v4-dev). However, it has been enhanced and modified to fit Seed's needs and code organizational structure.


## Install
```
npm install seed-breakpoints --save
```


## Documentation

Check out our **[documentation of this pack](http://developer.helpscout.net/seed/packs/seed-breakpoints/)**.


## Basic Usage

This seed pack needs to be imported into your sass pipeline. Below is an example using Gulp:

```javascript
var gulp = require('gulp');
var sass = require('gulp-sass');
var seedBreakpoints = require('seed-breakpoints');

gulp.task('sass', function () {
  return gulp.src('./sass/**/*.scss')
    .pipe(sass({
      includePaths: [
        seedBreakpoints
      ]
    }))
    .pipe(gulp.dest('./css'));
});
```

Once that is setup, simply `@import` *seed-breakpoints* as needed in your `.scss` file:

```sass
// Packs
@import "pack/seed-breakpoints/_index";
```

## Options

The following variables can be found in [`_config.scss`](https://github.com/helpscout/seed-breakpoints/blob/master/scss/pack/_config.scss)

```sass
// Namespaces
$seed-breakpoints-at-namespace: \@ !default;

// Breakpoints
$seed-breakpoints: (
  xs: 0,
  sm: 544px,
  md: 768px,
  lg: 992px
) !default;

```


## Important updates

#### July 17, 2016

**[Updates breakpoint namespace to @ symbol](https://github.com/helpscout/seed-breakpoints/pull/9)**

This change was made to better follow the ITCSS naming conventions for [responsive classes](http://csswizardry.com/2015/08/bemit-taking-the-bem-naming-convention-a-step-further/).

The compiled stylesheet (`.css`) will show the classes like:
`.class\@sm { ... }`

However, your markup can just be:
`<div class="class@sm">...</div>`

From this version forward, scss code utilizing the breakpoint mixins will now have altered (default) compiled responsive classes.
If you prefer using the older `--at-size` convention (or establish your own personal conventions), you can modify the new `$seed-breakpoints-at-namespace` variable.

---
_Source: https://npm.io/package/seed-breakpoints · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._