babel-plugin-react-auto-props

English | 中文

What's this?

This is a babel plugin which auto adds props to your React Component based on your component type.

// what we write
<div>
    <Button>Click me</Button>
    <p>Hello world</p>
</div>

// ⚙⚙⚙⚙⚙⚙⚙⚙⚙⚙⚙

// what we get after compile
<div>
    <Button className="my-button">Click me</Button>
    <p 
        style={
            color: 'grey',
            fontSize: 15,
        }
    >
        Hello world
    </p>
</div>

How can I use it?

Firstly, install it from npm:

npm install -D babel-plugin-react-auto-props

Secondly, use it in you babel config:

// babel.config.js
const plugins = [
    // ...your other babel plugins
    [
        'babel-plugin-react-auto-props',
        {
            Button: {
                className: 'my-button',
            },
            p: {
                style: {
                    color: 'grey',
                    fontSize: 15,
                },
            },
        },
    ],
]

That's it.

What's the result of the plugin

Given the following React element

let element = (
    <div>
        <Button>Click me</Button>
        <p>Hello world</p>
    </div>
)

We will get:

var element = _react.default.createElement(
    'div',
    null,
    _react.default.createElement(
        Button,
        _defineProperty(
            {
                className: 'my-button',
            },
            'className',
            'my-button',
        ),
        'Click me',
    ),
    _react.default.createElement(
        'p',
        _defineProperty(
            {
                style: {
                    color: 'grey',
                    fontSize: 15,
                },
            },
            'style',
            {
                color: 'grey',
                fontSize: 15,
            },
        ),
        'Hello world',
    ),
)

Should I use it?

This is an experimental project, and auto add props to React Component is anti-pattern. You should consider to use Specialization in production. However, it's all up to you.

License

MIT

✨🍰✨