# bem-builder

> A simple helper to build complex BEM class names. 675b gzipped, no dependencies.

Latest version **1.0.2** (published 2017-06-12) · MIT license · 0 weekly downloads

## Install

```sh
npm install bem-builder
pnpm add bem-builder
yarn add bem-builder
bun add bem-builder
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.2 |
| Published | 2017-06-12 |
| First published | 2017-02-09 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Sebastian Gräf |
| Maintainers | sebastiangraef |

## Links

- npm: https://www.npmjs.com/package/bem-builder
- Repository: https://github.com/sebastiangraef/bem-builder
- Homepage: https://github.com/sebastiangraef/bem-builder#readme
- Issues: https://github.com/sebastiangraef/bem-builder/issues
- npm.io page: https://npm.io/package/bem-builder

## Recent versions

- 1.0.2 (latest) — 2017-06-12
- 1.0.1 — 2017-06-12
- 1.0.0 — 2017-02-10
- 0.0.8 — 2017-02-10
- 0.0.7 — 2017-02-10
- 0.0.6 — 2017-02-10
- 0.0.5 — 2017-02-09
- 0.0.4 — 2017-02-09
- 0.0.3 — 2017-02-09
- 0.0.2 — 2017-02-09
- 0.0.1 — 2017-02-09

## README

# bem-builder

A simple helper to build complex BEM class names. 675b gzipped, no dependencies.

## Installation

```
npm install bem-builder --save
```

## Usage

```javascript
import bem from 'bem-builder';

bem((b, e, m, mix) => {
  b('block');
  e('element');
  m(true, 'modifier1');
  m('modifier2');
  m(false, 'modifier3');
  mix('mix1');
  mix('mix2');
})
```
returns:

```
block__element block__element--modifier1 block__element--modifier2 mix1 mix2
```

The BEM function takes an optional config object as a second parameter.

### Config object

The following default values can be overwritten:

```javascript
{
  elementSep: '__', // Element seperator
  modifierSep: '--', // Modifier seperator
}
```

### React example

```javascript
class Component extends React.Component {
  static propTypes = {
    exampleBool: React.PropTypes.bool,
    exampleNumber: React.PropTypes.number,
  };

  render() {
    const className = bem((b, e, m) => {
      b('block');
      e('element');
      m(this.props.exampleBool, 'modifier1');
      m(this.props.exampleNumber === 42, 'modifier2');
    });

    return (
      <div className={className}>
      </div>
    );
  }
}
```

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

---
_Source: https://npm.io/package/bem-builder · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
