helpscout / seed-table

Table component pack for Seed

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

seed-table Build Status npm version dependencies Status

Table component pack for Seed!

Install

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

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

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

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

Options

The following variables can be found in _config.scss

// Namespaces
$seed-table-namespace: c-table !default;

// Configs
$seed-table-background-color-hover: #F1F3F5 !default;
$seed-table-background-color-striped: #F9FAFA !default;
$seed-table-border-color: #E3E8EB !default;
$seed-table-border-width: 1px !default;
$seed-table-th-border-width: 1px !default;

$seed-table-padding-sizes: (
  md: 12px,
  sm: 8px,
  xs: 4px
) !default;

About

Table component pack for Seed

License:MIT License


Languages

Language:CSS 45.2%Language:JavaScript 28.8%Language:HTML 26.0%