seed-overflow

Overflow utility pack for Seed

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
seed-overflow
0.0.36 years ago6 years agoMinified + gzip package size for seed-overflow in KB

Readme

seed-overflow Build Status npm version dependencies Status
Overflow utility pack for Seed!
File size
Minified | Gzipped ---|--- 3.2 KB | 435 B

Install

npm install seed-overflow --save

Documentation

Check out our styleguide for documentation of this pack.

Basic Usage

SCSS

This seed pack needs to be imported into your sass pipeline. Below is an example using Gulp:
var gulp = require('gulp');
var sass = require('gulp-sass');
var pack = require('seed-overflow');

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

Once that is setup, simply @import seed-overflow as needed in your .scss file:
// Packs
@import "pack/seed-overflow/_index";

Options

The following variables can be found in _config.scss
// Namespaces
$seed-overflow-namespace: "u-overflow" !default;

// Overflow
$seed-overflow: (
  visible: visible,
  hidden: hidden,
  scroll: scroll,
  auto: auto,
  x-visible: visible,
  x-hidden: hidden,
  x-scroll: scroll,
  x-auto: auto,
  y-visible: visible,
  y-hidden: hidden,
  y-scroll: scroll,
  y-auto: auto
) !default;