Code Monkey home page Code Monkey logo

rebem's Introduction

maintenance npm travis coverage deps gitter

React ❤️ BEM.

Overview

There are two ways to use rebem — with jsx (a separate babel plugin) and without it (out of the box), like this:

import { Component } from 'react';
import { render } from 'react-dom';
import { BEM } from 'rebem';

class BeepClass extends Component {
    render() {
        return BEM(
            {
                ...this.props,
                block: 'beep',
                tag: 'span',
                mods: {
                    type: 'simple',
                    ...this.props.mods
                }
            },
            this.props.children
        );
    }
}

const Beep = React.createFactory(BeepClass);

class BoopClass extends Component {
    render() {
        return BEM(
            {
                ...this.props,
                block: 'boop'
            },
            Beep(
                {
                    mix: {
                        block: 'boop',
                        elem: 'hello'
                    },
                    mods: {
                        size: 'xl'
                    }
                },
                'hello'
            )
        );
    }
}

const Boop = React.createFactory(BoopClass);

render(
    Boop({
        mods: {
            disabled: true
        }
    }),
    document.body
);
<div class="boop boop_disabled">
    <span class="beep beep_type_simple beep_size_xl boop__hello">hello</div>
</div>

Install

npm i -S rebem

Usage

BEM(props, ...children)

is almost the same as

React.createElement(tag/ReactClass, props, ...children)

but tag and props.className are made from special props:

BEM PropTypes

block

Reference.

BEM({
    block: 'beep'
})
<div class="beep"></div>

elem

Reference.

BEM({
    block: 'beep',
    elem: 'boop'
})
<div class="beep__boop"></div>

mods

Reference.

Simple

BEM({
    block: 'beep',
    mods: {
        foo: 'bar'
    }
})
<div class="beep beep_foo_bar"></div>

Boolean

BEM({
    block: 'beep',
    mods: {
        foo: true,
        bar: false
    }
})
<div class="beep beep_foo"></div>

Element

BEM({
    block: 'beep',
    elem: 'boop',
    mods: {
        foo: 'bar'
    }
})
<div class="beep__boop beep__boop_foo_bar"></div>

mix

Reference.

Simple

BEM({
    block: 'beep',
    mix: {
        block: 'boop',
        elem: 'foo'
    }
})
<div class="beep boop__foo"></div>

Multiple

BEM({
    block: 'beep',
    mix: [
        {
            block: 'boop',
            elem: 'foo'
        },
        {
            block: 'bar',
            elem: 'baz',
            mods: {
                test: true
            }
        }
    ]
})
<div class="beep boop__foo bar__baz bar__baz_test"></div>

tag

div by default.

BEM({
    tag: 'span'
})
<span></span>

className

If className is specified, it will be preserved along with BEM classNames.

BEM({
    block: 'boop',
    className: 'beep'
})
<div class="boop beep"></div>

blockFactory

blockFactory can save you a couple of bytes when you have a lot of BEM-entities in the component:

import React from 'react';
import { render } from 'react-dom';
import { blockFactory } from 'rebem';

const Block = blockFactory('beep');

class Beep extends React.Component {
  render() {
    return Block(this.props,
      Block({ elem: 'hello', mods: { size: 'xl' } },
        'hello'
      ),
      Block({ elem: 'jack', mix: { block: 'man' } },
        'Jack'
      )
    );
  }
}

render(
  React.createElement(Beep),
  document.body
);
<div class="beep">
  <div class="beep__hello beep__hello_size_xl">hello</div>
  <div class="beep__jack man">hello</div>
</div>

React PropTypes

References:

BEM({
    block: 'image',
    tag: 'img',
    src: 'http://funkyimg.com/i/26jtf.gif',
    alt: 'kitten'
})
<img class="image" src="http://funkyimg.com/i/26jtf.gif" alt="kitten"/>

Notes

Environment

process.env.NODE_ENV must be available. For example in webpack you can do this with DefinePlugin:

plugins: [
    new webpack.DefinePlugin({
        'process.env': {
            NODE_ENV: JSON.stringify(process.env.NODE_ENV)
        }
    })
]

rebem's People

Contributors

guria avatar mistadikay avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Forkers

guria bem-react

rebem's Issues

Props in child is empty object

Props from Block in not available in children block:
Parent block:

render() {
    return Block(
        this.props,
        Plan()
    );
}

Children block:

export default class Plans extends Component {
    constructor(props) {
        super(props);

        console.log(this.props); // {}
    }
}

Missing "Where to go now?" section

I just read your Medium article on reBEM and wanted to check it out, only to see that the project is no longer maintained 😭 Oh, well, that's life, and noone can reasonably expect you to put in free work forever.

BUT one thing that might be of use for the many people landing on your repos might be a tiny section dedicated to explaining the current status. For my own interest there are two main points:

  1. why is the project no longer maintained
  2. if it is no longer used by the maintainer, what is the maintainer currently using or recommending to use instead?

Just to be clear, this is purely a request out of self-interest and I am not complaining about the project being maintained. I was just curious as to if you are still using the library, but can no longer be bothered to take on all the work associated with open sourcing it, or if you have stumbled upon A Better Way (tm) 😸 I would assume this would be something most people coming from the Medium article would want to know as well.

Add missing tests

Coverage decreased after v0.12.1, also there should be some more tests for convertToReactType

Fix broken travis build

When running coverage npm script locally on [email protected] everything is fine. On Travis under [email protected] it is breaking with error:

/home/travis/build/yummies/yummies/node_modules/isparta/lib/cli.js:197
    _istanbul.hook.hookRequire(matchFn, transformer, Object.assign({ verbose: opts.verbose }, config.instrumentation.config));
                                                            ^
TypeError: Object.assign is not a function
    at prepareCoverage (/home/travis/build/yummies/yummies/node_modules/isparta/lib/cli.js:197:61)
    at /home/travis/build/yummies/yummies/node_modules/isparta/lib/cli.js:187:7
    at /home/travis/build/yummies/yummies/node_modules/isparta/node_modules/istanbul/lib/util/file-matcher.js:68:16
    at /home/travis/build/yummies/yummies/node_modules/isparta/node_modules/istanbul/node_modules/async/lib/async.js:52:16
    at /home/travis/build/yummies/yummies/node_modules/isparta/node_modules/istanbul/node_modules/async/lib/async.js:363:13
    at /home/travis/build/yummies/yummies/node_modules/isparta/node_modules/istanbul/node_modules/async/lib/async.js:52:16
    at done (/home/travis/build/yummies/yummies/node_modules/isparta/node_modules/istanbul/node_modules/async/lib/async.js:248:21)
    at /home/travis/build/yummies/yummies/node_modules/isparta/node_modules/istanbul/node_modules/async/lib/async.js:44:16
    at /home/travis/build/yummies/yummies/node_modules/isparta/node_modules/istanbul/node_modules/async/lib/async.js:360:17
    at LOOP (fs.js:1529:14)

Router for reBEM

Hello!

What router you prefer to use with reBEM? Is it possible to use React Router with reBEM?

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.