seed-hr v0.0.3

seed-hr

HR component pack for Seed!

Install

npm install seed-hr --save

Documentation

Check out our 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-hr');

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

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

// Packs
@import "pack/seed-hr/_index";

Options

The following variables can be found in _config.scss

// Namespaces
$seed-hr-namespace: "c-hr" !default;

// Config
$seed-hr-include-hr-selector: true !default;

// The above configuration determines this private variable
$__seed-hr-class: ".#{$seed-hr-image-namespace}";
// Include the image selector (Default)
@if $seed-hr-include-hr-selector == true {
  $__seed-hr-class: ".#{$seed-hr-namespace}, hr";
}

// Styles
$seed-hr-border-color: #eee !default;
$seed-hr-border-size: 1px !default;
$seed-hr-border-style: solid !default;
$seed-hr-margin: 20px 0 !default;