Aurora Utilities

Sass and JavaScript utilities for all your front end projects.

Features

This package is collection of helpful Sass and JavaScript utilities that keep you focused on building new features instead of recreating the wheel over and over.

The Sass and JavaScript included in this package only output what you use, so there is no need to worry adding bloat to your project.

Sass

Aurora Utilities comes bundled with a set of helpful Sass functions and mixins that makes writing styles a breeze.

JavaScript

Coming soon

Installation

Add Aurora Utilities as a project dependency:

npm install --save-dev aurora-utilities

Sass Usage

1. For Sass use, you'll need to add Aurora Utilities to your node-sass includePaths:

   Webpack example using sass-loader:

   {
     loader: 'sass-loader',
     options: {
       includePaths: [
         'node_modules/aurora-utilities/sass',
         'node_modules/sanitize.scss'
       ],
       sourceMap: true
     }
   }

   Grunt example using grunt-sass:

   sass: {
     options: {
       outputStyle: 'expanded',
       sourceMap: true,
       includePaths: [
         'node_modules/aurora-utilities/sass',
         'node_modules/sanitize.scss'
       ]
     }
   }

   Gulp example using gulp-sass:

   gulp.task('sass', function() {
     return gulp.
       .pipe(sass( {
         includePaths: [
           'node_modules/aurora-utilities/sass',
           'node_modules/sanitize.scss'
         ]
       }))
   });

2. Import aurora-utilities into your main sass file:

   @import 'aurora-utilities';

3. Use the bundled functions and mixins as required:

   .link {
     @include link($primary, $accent);
     @include decorative-link('\u007');
   }