# dumb-bem

> Simple BEM react components generator

Latest version **3.2.0** (published 2016-12-07) · MIT license · 0 weekly downloads

## Install

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

## 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 | 3.2.0 |
| Published | 2016-12-07 |
| First published | 2016-02-13 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Alexander Gudulin |
| Maintainers | agudulin |
| Keywords | react, bem |

## Links

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

## Dependencies (1)

- [classnames](https://npm.io/package/classnames.md) ^2.2.3

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 3.2.0 (latest) — 2016-12-07
- 3.1.1 — 2016-11-29
- 3.1.0 — 2016-11-29
- 3.0.2 — 2016-11-17
- 3.0.1 — 2016-10-17
- 3.0.0 — 2016-10-07
- 2.0.1 — 2016-09-28
- 2.0.0 — 2016-09-28
- 1.1.1 — 2016-09-01
- 1.1.0 — 2016-04-21
- 1.0.0 — 2016-04-14
- 0.2.0 — 2016-03-22
- 0.1.1 — 2016-03-04
- 0.1.0 — 2016-02-17
- 0.0.1 — 2016-02-13

## README

# Dumb BEM

**Dumb BEM** is a simple BEM class name [transformation](https://github.com/robinpokorny/transform-props-with) for React components.

[![npm](https://img.shields.io/npm/v/dumb-bem.svg?style=flat-square)](https://www.npmjs.com/package/dumb-bem)
[![Build Status](https://img.shields.io/travis/agudulin/dumb-bem/master.svg?style=flat-square)](https://travis-ci.org/agudulin/dumb-bem)
[![license](https://img.shields.io/npm/l/dumb-bem.svg?style=flat-square)](https://github.com/agudulin/dumb-bem/blob/master/license)
[![js-standard-style](https://img.shields.io/badge/code%20style-standard-lightgrey.svg?style=flat-square)](http://standardjs.com/)
[![Managed by Yarn](https://img.shields.io/badge/managed%20by-Yarn-2C8EBB.svg?style=flat-square)](https://yarnpkg.com/)
[![Developed at Wimdu](https://img.shields.io/badge/developed%20at-Wimdu-FCAF16.svg?style=flat-square)](http://tech.wimdu.com/)

## Install

```sh
npm install --save dumb-bem
```

## Usage

```js
import dumbBem from 'dumb-bem'
import tx from 'transform-props-with'

const dumbHeader = dumbBem('header')
const Header = tx(dumbHeader)('div')
const HeaderTitle = tx([{ element: 'title' }, dumbHeader])('h1')

ReactDOM.render(
  <Header modifier='landing'>
    <HeaderTitle>Lorem Ipsum</HeaderTitle>
  </Header>
, node)
// Would render:
// <div className='header header--landing'>
//   <h1 className='header__title'>
//     Lorem Ipsum
//   </h1>
// </div>
```

## API
### `dumbBem(block, options={})`

#### Arguments

  - `block` (*String*): name of the base block.
  - `options` (*Object*): Override default options.
    - [`plugins`] \(*Array*):
    array of plugins for modifying class names.

      Plugin is an object with two properties:
        - `maker` (*function*)
        Maker function takes `block` and `props` as arguments and should return anything suitable for [classnames](https://www.npmjs.com/package/classnames) input. E.g. [it can be a string, array of string or object](https://github.com/JedWatson/classnames#usage).
        - [`propsToRemove`] \(*Array*)
        An array of properties which are used in the plugin but should not be injected into the corresponding DOM element in the end.

      See also [built-in makers](docs/plugins.md).

#### Returns

A function which takes `props` object as a parameter, transforms `className` prop on execution and returns back changed props object.

```js
(props) => ({
  ...props,
  className: classNameModifiedByMakers
})
```

#### Examples

**Use built-in maker function**

```js
import dumbBem from 'dumb-bem'
import { makeStates } from 'dumb-bem/lib/plugins'
import tx from 'transform-props-with'

const dumbList = dumbBem('list', { plugins: [makeStates] })
const List = tx(dumbList)('ul')
const ListItem = tx([{ element: 'item' }, dumbList])('li')

ReactDOM.render(
  <List>
    <ListItem active={true}>Item 1</ListItem>
    <ListItem disabled={true}>Item 2</ListItem>
    <ListItem hidden={true}>Item 3</ListItem>
    <ListItem loading={true}>Item 4</ListItem>
  </List>
, node)

// Would render:
// <ul class='list'>
//   <li class='list__item is-active'>Item 1</li>
//   <li class='list__item is-disabled'>Item 2</li>
//   <li class='list__item is-hidden'>Item 3</li>
//   <li class='list__item is-loading'>Item 4</li>
// </ul>
```

**Use custom maker function**

```js
import dumbBem from 'dumb-bem'
import tx from 'transform-props-with'

const colorModifierPlugin = {
  maker: (block, props) => {
    if (props.color) {
      return `${block}--${props.color}`
    }
  },
  propsToRemove: ['color']
}

const dumbList = dumbBem('list', { plugins: [colorModifierPlugin] })
const List = tx(dumbList)('ul')
const ListItem = tx([{ element: 'item' }, dumbList])('li')

ReactDOM.render(
  <List>
    <ListItem color='black'>Item 1</ListItem>
    <ListItem color='white'>Item 2</ListItem>
  </List>
, node)

// Would render:
// <ul class='list'>
//   <li class='list__item list__item--black'>Item 1</li>
//   <li class='list__item list__item--white'>Item 2</li>
// </ul>
```

### [Built-in Plugins](docs/plugins.md)


## License

MIT © [Alexander Gudulin](http://gudulin.com)

[travis-url]: https://travis-ci.org/agudulin/dumb-bem
[travis-image]: https://travis-ci.org/agudulin/dumb-bem.svg?branch=master

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