inuit.settings.defaults

1.0.4 • Public • Published

inuitcss.settings.defaults

Views Build Status Dependency Status NPM version Code Climate Test Coverage

NPM

The inuitcss defaults module contains a few variables and settings that are required for using any of the rest of the framework.

Usage

$ npm install --save-dev inuit.settings.defaults

The inuit.settings.defaults module returns a function that, itself, returns an object literal with the following default values:

{
    "inuit": {
        "baseFontSize": 16,
        "baseLineHeight": 24,
        "baseTextColor": "#333",
        "baseBackgroundColor": "#fff",
        "namespace": null,
        "baseSpacingUnit": 24,
        "baseSpacingUnitSmall": 12,
        "baseSpacingUnitLarge": 48
    }
}

Optionally, you can override the first 5 settings by providing your overrides to the function call, like so:

var inuit = require('inuit.settings.defaults')({
    inuit: {
        baseFontSize: 18,
        baseLineHeight: 22,
        baseTextColor: '#000',
        baseBackgroundColor: '#e5e5e5',
        namespace: 'foo'
    }
});

This would result in the following settings:

{
    "inuit": {
        "baseFontSize": 18,
        "baseLineHeight": 22,
        "baseTextColor": "#000",
        "baseBackgroundColor": "#e5e5e5",
        "namespace": "foo",
        "baseSpacingUnit": 22,
        "baseSpacingUnitSmall": 11,
        "baseSpacingUnitLarge": 44
    }
}

The last 3 settings are not overridable, as they are based on baseLineHeight. These will be generated for you.

Package Sidebar

Install

npm i inuit.settings.defaults

Weekly Downloads

6

Version

1.0.4

License

MIT

Last publish

Collaborators

  • jedmao