react-bem-classes v1.1.0

react-bem-classes

Use React components with BEM class naming convention.

Installation

npm install react-bem-classes --save-dev

Usage

import React from 'react';
import 'bem' from 'react-bem-classes';


@bem({
  block: "list",  // name of your block
  modifiers: ['size', 'isOpened'] // list of modifiers available through props
})
class List extends React.Component{

  render(){

    return(
      <div className={this.block()}>  // <div class="list"></div>
        <div className={this.element('item')}></div>  //  <div class="list__item"></div>
      </div>
    )
  }
}

export default List;

Modifiers

Methods this.block and this.elements may accept an additional parameter — an object of modifiers

• this.block(modifiers)

• this.element(elementName, modifiers)

Example

this.block({
  type: 'myType',
  isActive: true 
}) // returns 'list list--type-myType list--isActive'

Modifiers through props

You can pass modifiers as props when using your component

@bem({
  block: "list",  // name of your block
  modifiers: ['size', 'isOpened'] // list of modifiers available through props
})
class List extends React.Component{

  render(){

    return(
      <div className={this.block()}>
        //...
      </div>
    )
  }
}

class MyApp extends React.Component{

  render(){
    return <List size="large" isOpened /> 
  }
  
  // renders <div class="list list--size-large list--isOpened">...</div>

}

Both element and block

Every component can be a block and an element of another block at the same time.

@bem({
  block: 'user'
})
class User extends React.Component{
  render(){
    return(
      <div className={this.block()}>
      </div>
    )
  }
}

@bem({
  block: 'list'
})
class List extends React.Component{

  render(){
    <div className={this.block()}>
      <User className={this.element('item')} />
    </div>
  }
  /* renders 
    <div class="list">
      <div className="list__item user">
    </div> 
  */ 
  
}