react-prop-matrix

Render something using every possible combination of props

Install

yarn add react-prop-matrix

Example

import PropMatrix from 'react-prop-matrix';

let options = {
  background: ['red', 'green', 'blue'],
  children: ['Hello', 'World'],
};

<PropMatrix options={options}>
  {props => <Button {...props}>}
</PropMatrix>

Will generate:

<React.Fragment>
  <Button background="red" children="Hello"/>
  <Button background="green" children="Hello"/>
  <Button background="blue" children="Hello"/>

  <Button background="red" children="World"/>
  <Button background="green" children="World"/>
  <Button background="blue" children="World"/>
</React.Fragment>

With Filters

import PropMatrix from 'react-prop-matrix';

let options = {
  background: ['red', 'green', 'blue'],
  children: ['Hello', 'World'],
};

let filters = {
  background: ['red', 'green'],
  children: ['Hello'],
};

<Matrix filters={filters} options={options}>
  {props => <Button {...props}>}
</Matrix>

Will generate:

<React.Fragment>
  <Button background="red" children="Hello"/>
  <Button background="green" children="Hello"/>
</React.Fragment>

API

<PropMatrix/>

props.options

An object of props containing arrays with possible values.

<PropMatrix
  options={{
    background: ['red', 'blue', 'green'],
    children: ['Hello', 'World'],
  }}/>

props.filters

Optionally filter the generated matrix to only include items that have matching props. An empty array will match all items.

<PropMatrix
  filters={{
    background: ['red', 'blue'],
    children: ['Hello'],
  }}/>

props.children

A function that gets called for each item in the generated matrix and returns React elements.

<PropMatrix
  children={props => (
    <Component {...props}/>
  )}/>

Note: If you want to pass an array as a prop, you still need to nest it inside an options array. { items: [[1, 2], [3, 4]] }