/sass-config-manager

A dot-syntax configuration (Map) library for Sass (mixin / function).

Primary LanguageCSSMIT LicenseMIT

sass-config-manager

Author devDependency Status npm Bower Software License

Master

Build Status

Bits and Pieces:

  • npm: Well... it's a Node.js package manager
  • Grunt: Automates common tasks: test, build, clean
  • Bower: Package manager for browser dependencies
  • Hound: Hound comments on style violations in GitHub pull requests

Getting Started:

  1. You need to have npm installed (it comes with node)
  2. Clone this repository: git clone git@github.com:sass-projects/sass-config-manager.git
  3. Install dependencies: npm install

Install

npm install
grunt

Change log

Please see CHANGELOG for more information what has changed recently.

Testing

grunt test

How to

Usage

If you like to use sass-config-mangers global variable, set

$config-manger-variables: global;

before you include sass-config-manger.

Include this library. If you use bower @import 'bower_components/sass-config-manager/sass/_sass-config-manager.scss'; or @import 'node_modules/sass-config-manager/sass/_sass-config-manager.scss';

Set default settings

// Default configuration settings
// Passing true to the 3rd parameter,
// the value is assigned to the configuration path as the default
@include config-set('color.black', #000, true);
@include config-set('color.white', #fff, true);
@include config-set('single-key', red, true);

// or assign values to a configuration path by using Map
@include config-set('color', (black: #000, white: #fff), true);

Get your settings

body {
    color: config-get('color.black');  // #000
    background-color: config-get('color.white');  // #fff
}

Compatibility

// Variables
$color-black: #000 !default;
$color-white-bg: #fff !default;

$color: (
    fg: $color-black,
    bg: $color-white-bg
) !default;

// config-set()
@include config-set('color', $color, true);

body {
    color: config-get('color.fg');  // #666666
    background-color: config-get('color.bg');  // white
}

Contributing

Please see CONTRIBUTING for details.

Credits

License

The MIT License (MIT). Please see License File for more information.