@avalanche/object-island

Box off content

Stats

stars 🌟issues ⚠️updated 🛠created 🐣size 🏋️‍♀️
@avalanche/object-island
Minified + gzip package size for @avalanche/object-island in KB

Readme

@avalanche/object-island

Box off content.

Install

npm install @avalanche/object-island --save-dev

Basic usage

// Import the main file.
@import 'node_modules/@avalanche/object-island/scss/index.scss';

Usage with node-sass-magic-importer

Using node-sass (or a plugin for Grunt, gulp or webpack which is using node-sass) in combination with the node-sass-magic-importer custom importer, can make importing CSS dependencies from node_modules a much nicer experience.

// Import the main file.
@import '~@avalanche/object-island';

// Import just the classes you need.
@import '{ .o-island } from ~@avalanche/object-island';

// Not a fan of the "o-" prefix?
@import '{ .o-island as .island } from ~@avalanche/object-island';

Demo

Default spacing size

<div class="o-island">
  Boxed off content.
</div>

X-large spacing size

<div class="o-island o-island--xl">
  XL boxed off content.
</div>

Mixins

@import 'node_modules/@avalanche/object-island/scss/mixins';

// Usage.
.island {
  @include o-island();
}

Settings

/// Default spacing.
/// @type String
$o-island-spacing-default: m !default;

About

Author

Markus Oberlehner
Website: https://markus.oberlehner.net
Twitter: https://twitter.com/MaOberlehner
PayPal.me: https://paypal.me/maoberlehner

License

MIT

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.