From a2bc1bad6b83bd9cbeef33b69daeeb465657978c Mon Sep 17 00:00:00 2001 From: Vince Speelman Date: Sun, 24 Jun 2018 09:52:56 -0400 Subject: [PATCH] add props table to cartesian docs add a props table that enumerates each prop that the Cartesian component can take. --- docs/Cartesian.md | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) diff --git a/docs/Cartesian.md b/docs/Cartesian.md index 124eceee..eab9f841 100644 --- a/docs/Cartesian.md +++ b/docs/Cartesian.md @@ -1,14 +1,19 @@ - # Cartesian Display the cartesian product of component props ![](images/cartesian.png) +| _Prop_ | _type_ | _default_ | _description_ | +| --------- | ------ | ----------- | -------------------------------------------------------- | +| component | Node | `undefined` | The component to apply the cartesian product to | +| container | Node | `Fragment` | A component to wrap the `component` prop in, for display | +| children | Array | `undefined` | each child you'd like as a part of the product | + ```jsx -import React from 'react' -import { Cartesian } from '@compositor/kit' -import Button from '../src/Button' +import React from 'react'; +import { Cartesian } from '@compositor/kit'; +import Button from '../src/Button'; export default props => ( ( bg={['blue', 'pink', 'tomato', 'purple']} children={['Hello, world!', 'Beep']} /> -) +); ```