seed-flexy

Flex object pack for Seed

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
seed-flexy
110.3.47 years ago8 years agoMinified + gzip package size for seed-flexy in KB

Readme

seed-flexy Build Status npm version Dependencies
Flex object pack for Seed!

Install

npm install seed-flexy --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-flexy');

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

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

Options

The following variables can be found in _config.scss
// Namespaces
$seed-flexy-namespace: "o-flexy" !default;
$seed-flexy-inline-item-namespace: #{$seed-flexy-namespace}__inline-item !default;
$seed-flexy-item-namespace: #{$seed-flexy-namespace}__item !default;
$seed-flexy-block-namespace: #{$seed-flexy-namespace}__block !default;
$seed-flexy-gap-namespace: #{$seed-flexy-namespace}--gap !default;

// Alignment
$seed-flexy-alignment: (
  top: flex-start,
  middle: center,
  bottom: flex-end,
  stretch: stretch
) !default;

// Gap
$seed-flexy-gap-sizes: (
  xs: 4px,
  sm: 8px,
  md: 12px,
  lg: 16px,
  xl: 20px,
) !default;