@jahed/bem

Functions for using BEM in CSS.

Stats

StarsIssuesVersionUpdatedCreatedSize
@jahed/bem
601.2.12a year ago4 years agoMinified + gzip package size for @jahed/bem in KB

Readme

@jahed/bem

Travis npm Patreon Liberapay

Functions for using BEM in CSS and CSS Modules.

Installation

# NPM
npm install @jahed/bem

# Yarn
yarn add @jahed/bem

Usage

import { bem } from '@jahed/bem'

const className = ".MyElement .MyElement--color--red .MyElement--active"
// same as
const className = bem('MyElement', {
  color: 'red',
  active: true,
  disabled: false
})

For more thorough examples, see the tests and blog posts linked above.

API

For complete API documentation, see the documentation website.

bem(block: string, modifiers: object<string, (boolean|number|string)?>): string

Generates BEM-compliant class names for the given block (or element) with modifiers.

Examples


bemModule(cssModuleLocals): bem

Generates a bem-compliant function which maps the resulting class names to the given cssModuleLocals map.

Examples


join(...string): string

Joins the given strings with a whitespace ( ), filtering any falsy values (such as undefined, null, false, '').

Examples


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.