Giter Club home page Giter Club logo

bemutil's Introduction

bemutil

Simple BEM (Block, Element, Modifier) helper function. Useful for tidying up the mess BEM creates and allows for clean conditional application of modifiers. Suited for use with React and JSX.

Installation

Via NPM:

npm install bemutil

Usage

var BEM = require('bemutil');

// Set up block
var bem = BEM('my-block');

// Output block
bem();
// 'my-block';


// Output element
bem('my-element');
// 'my-block__my-element'


// Output element and modifier
bem('my-element', 'my-modifier');
// 'my-block__my-element my-block__my-element--my-modifier'


// Output multiple modifiers
bem('my-element', {'my-modifier-1': true, 'my-modifier-2': true});
// 'my-block__my-element my-block__my-element--my-modifier-1 my-block__my-element--my-modifier-2'


// Output modifiers to the block
bem(null, {'my-modifier-1': true, 'my-modifier-2': true});
// 'my-block my-block--my-modifier-1 my-block--my-modifier-2'


// Conditionally apply modifiers
// Values can be truthy or falsy, not just true or false
var showMyModifier1 = 0;
var showMyModifier2 = 1;
bem(null, {'my-modifier-1': showMyModifier1, 'my-modifier-2': showMyModifier2});
// 'my-block my-block--my-modifier-2'


// Also useful for generating CSS selectors
var bem = BEM('.my-block');
bem('my-element', 'my-modifier');
// '.my-block__my-element--my-modifier'

bemutil's People

Contributors

jrwebdev avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.