JSPM

  • Created
  • Published
  • Downloads 22847
  • Score
    100M100P100Q207284F
  • License MPL-2.0

BEM React ClassName

Package Exports

  • @bem-react/classname

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@bem-react/classname) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

ClassName · npm (scoped) npm bundle size (minified + gzip)

Tiny helper for building CSS classes with BEM methodology.

Install

npm i -S @bem-react/classname

Usage

import { cn } from '@bem-react/classname';

const cat = cn('Cat');

cat(); // Cat
cat({ size: 'm' }); // Cat_size_m
cat('Tail'); // Cat-Tail
cat('Tail', { length: 'small' }); // Cat-Tail_length_small

const dogPaw = cn('Dog', 'Paw');

dogPaw(); // Dog-Paw
dogPaw({ color: 'black', exists: true }); // Dog-Paw_color_black Dog-Paw_exists

Configure

By default classname uses React naming preset. But it's possible to use any.

import { configure } from '@bem-react/classname';
import { origin } from '@bem/sdk.naming.presets';

const cn = configure(origin);

cn('block', 'elem')({ theme: 'default' }); // block__elem_theme_default