helpscout / seed-video

Responsive video component for Seed

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

seed-video Build Status npm version

Responsive video component pack for Seed!

Install

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

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

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

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

Options

The following variables can be found in _config.scss

// Namespaces
$seed-video-namespace: "c-video" !default;
$seed-video-embed-namespace: "#{$seed-video-namespace}__embed" !default;

// Config
$seed-video-background-color: #eee !default;
// Pass in ratios for w:h
$seed-video-sizes: (
  u-wide: (
    width: 21,
    height: 9
  ),
  // Golden ratio (16:10)
  gr: (
    width: 16,
    height: 10
  ),
  wide: (
    width: 16,
    height: 9
  ),
  sd: (
    width: 4,
    height: 3
  )
) !default;

About

Responsive video component for Seed

License:MIT License


Languages

Language:JavaScript 45.4%Language:CSS 40.7%Language:HTML 13.9%