# seed-border

> Border theme pack for Seed

Latest version **0.0.10** (published 2017-02-02) · MIT license · 0 weekly downloads

## Install

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

## 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.0.10 |
| Published | 2017-02-02 |
| First published | 2016-07-20 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=4 |
| Dependencies | 3 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Maintainers | itsjonq |
| Keywords | bem, border, css, design, functional, itcss, modular, oocss, performance, seed, seed-pack, scss |

## Links

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

## Dependencies (3)

- [seed-publish](https://npm.io/package/seed-publish.md) 0.0.4
- [sass-pathfinder](https://npm.io/package/sass-pathfinder.md) 0.0.5
- [seed-breakpoints](https://npm.io/package/seed-breakpoints.md) ^0.4.0

## 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.0.10 (latest) — 2017-02-02
- 0.0.9 — 2016-12-23
- 0.0.8 — 2016-10-28
- 0.0.7 — 2016-09-28
- 0.0.6 — 2016-09-08
- 0.0.5 — 2016-08-24
- 0.0.4 — 2016-08-05
- 0.0.3 — 2016-07-22
- 0.0.2 — 2016-07-20
- 0.0.1 — 2016-07-20

## README

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

Border theme pack for [Seed](https://github.com/helpscout/seed)!


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


## Documentation

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


## Basic Usage

### SCSS
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 pack = require('seed-border');

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

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

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

## Options

The following variables can be found in `_config.scss`

```sass
// Namespaces
$seed-border-namespace: "t-bdr" !default;
$seed-border-radius-namespace: "#{$seed-border-namespace}-r" !default;

// Defaults
$seed-border-color: #eee !default;
$seed-border-radius: 3px !default;
$seed-border-size: 1px !default;
$seed-border-style: solid !default;

// Important (Typical convention for utility purposes)
$seed-border-use-important: true !default;

// Directions
$seed-border-directions: (
  all: false,
  top: "t",
  right: "r",
  bottom: "b",
  left: "l",
  none: false,
) !default;

$seed-border-radius-sizes: (
  0: 0px,
  1: 1px,
  2: 2px,
  3: 3px,
  4: 4px,
  circle: 50%,
  pill: 9999px,
) !default;

// Base variable
$seed-border: $seed-border-size $seed-border-style $seed-border-color !default;
```

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