Skip to content

Commit

Permalink
Updated readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
@mattvox
mattvox committed Jun 15, 2018
1 parent 9899db6 commit e596a8f
Showing 1 changed file with 10 additions and 10 deletions.
20 changes: 10 additions & 10 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -130,18 +130,18 @@ Brickworks layout components are configured through props. It aims to make avail
| `maxWidth` | | number / string | set the maximum width |
| `minHeight` | | number / string | set the minimum height |
| `maxHeight` | | number / string | set the maximum height |
| `textAlign` | | enum | set the text alignment <br> enums: `left` `right` `center` `justify` `initial` `inherit` |
| `textAlign` | | enum | set the text alignment <br>`left` `right` `center` `justify` `initial` `inherit` |

## `<Grid />`

Grid is a container component, typically managing a combination of rows and columns.

| Prop | Default | Type | Description |
| -------------- | --------- | ---------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `flow` | `inherit` | enum | shorthand for flex-direction and flex-wrap, which define the container's axes<br>enums: `row` `row-reverse` `column` `column-reverse` `nowrap` `wrap` `wrap-reverse` `row nowrap` `row wrap` `row wrap-reverse` `row-reverse nowrap` `row-reverse wrap` `row-reverse wrap-reverse` `column nowrap` `column wrap` `column wrap-reverse` `column-reverse nowrap` `column-reverse wrap` `column-reverse wrap-reverse` `initial` `inherit` |
| `justify` | `inherit` | enum | sets alignment of items along the main axis<br>enums: `flex-start` `flex-end` `center` `space-around` `space-between` `space-evenly` `initial` `inherit` |
| `alignContent` | `inherit` | enum | sets alignment of the container's lines along the cross-axis<br>enums: `flex-start` `flex-end` `center` `space-around` `space-between` `stretch` `initial` `inherit` |
| `alignItems` | `inherit` | enum | sets alignment of items along the cross-axis<br>enums: `flex-start` `flex-end` `center` `baseline` `stretch` `initial` `inherit` |
| `flow` | `inherit` | enum | shorthand for flex-direction and flex-wrap, which define the container's axes<br> `row` `row-reverse` `column` `column-reverse` `nowrap` `wrap` `wrap-reverse` `row nowrap` `row wrap` `row wrap-reverse` `row-reverse nowrap` `row-reverse wrap` `row-reverse wrap-reverse` `column nowrap` `column wrap` `column wrap-reverse` `column-reverse nowrap` `column-reverse wrap` `column-reverse wrap-reverse` `initial` `inherit` |
| `justify` | `inherit` | enum | sets alignment of items along the main axis<br> `flex-start` `flex-end` `center` `space-around` `space-between` `space-evenly` `initial` `inherit` |
| `alignContent` | `inherit` | enum | sets alignment of the container's lines along the cross-axis<br> `flex-start` `flex-end` `center` `space-around` `space-between` `stretch` `initial` `inherit` |
| `alignItems` | `inherit` | enum | sets alignment of items along the cross-axis<br> `flex-start` `flex-end` `center` `baseline` `stretch` `initial` `inherit` |
| `padded` | `1em` | bool / number / string | A grid can be padded, which creates equally spaced gutters both horizontally and vertically. `padded` can be used simply as a boolean to apply the default padding, or as a number or string which is a valid css value with a unit, i.e. `'20px'`, `'1.5rem'` |
| `colFlex` | | number / array | sets the flex value for its child columns. |
| `columns` | | number | A grid can specify its column count. |
Expand All @@ -158,10 +158,10 @@ Row is both a container component and an item component, typically used to manag

| Prop | Default | Type | Description |
| -------------- | --------- | ---------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `flow` | `inherit` | enum | shorthand for flex-direction and flex-wrap, which define the container's axes<br>enums: `row` `row-reverse` `column` `column-reverse` `nowrap` `wrap` `wrap-reverse` `row nowrap` `row wrap` `row wrap-reverse` `row-reverse nowrap` `row-reverse wrap` `row-reverse wrap-reverse` `column nowrap` `column wrap` `column wrap-reverse` `column-reverse nowrap` `column-reverse wrap` `column-reverse wrap-reverse` `initial` `inherit` |
| `justify` | `inherit` | enum | sets alignment of items along the main axis<br>enums: `flex-start` `flex-end` `center` `space-around` `space-between` `space-evenly` `initial` `inherit` |
| `alignContent` | `inherit` | enum | sets alignment of the container's lines along the cross-axis<br>enums: `flex-start` `flex-end` `center` `space-around` `space-between` `stretch` `initial` `inherit` |
| `alignItems` | `inherit` | enum | sets alignment of items along the cross-axis<br>enums: `flex-start` `flex-end` `center` `baseline` `stretch` `initial` `inherit` |
| `flow` | `inherit` | enum | shorthand for flex-direction and flex-wrap, which define the container's axes<br> `row` `row-reverse` `column` `column-reverse` `nowrap` `wrap` `wrap-reverse` `row nowrap` `row wrap` `row wrap-reverse` `row-reverse nowrap` `row-reverse wrap` `row-reverse wrap-reverse` `column nowrap` `column wrap` `column wrap-reverse` `column-reverse nowrap` `column-reverse wrap` `column-reverse wrap-reverse` `initial` `inherit` |
| `justify` | `inherit` | enum | sets alignment of items along the main axis<br> `flex-start` `flex-end` `center` `space-around` `space-between` `space-evenly` `initial` `inherit` |
| `alignContent` | `inherit` | enum | sets alignment of the container's lines along the cross-axis<br> `flex-start` `flex-end` `center` `space-around` `space-between` `stretch` `initial` `inherit` |
| `alignItems` | `inherit` | enum | sets alignment of items along the cross-axis<br> `flex-start` `flex-end` `center` `baseline` `stretch` `initial` `inherit` |
| `padded` | `1em` | bool / number / string | A row can be padded, which creates equally spaced gutters both horizontally and vertically. `padded` can be used simply as a boolean to apply the default padding, or as a number or string which is a valid css value with a unit, i.e. `'20px'`, `'1.5rem'` |
| `colFlex` | | number / array | sets the flex value for its child columns. |
| `columns` | | number | A row can specify its column count. |
Expand All @@ -180,7 +180,7 @@ Col is an item component, typically used to wrap content inside a grid or row.
| Prop | Default | Type | Description |
| ----------- | ---------- | -------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `flex` | `0 1 auto` | number / array | sets the flex property, which is shorthand for grow, shrink, and basis. Can simply accept a number, which sets the grow value, or an array containing grow and shrink, or all three values. Omitted values will fall back to their defaults |
| `alignSelf` | | enum | overrides the vertical alignment set by align-items in the parent container for a single element<br>enums: `auto`, `flex-start`, `flex-end`, `center`, `baseline`, `stretch`, `initial`, `inherit` |
| `alignSelf` | | enum | overrides the vertical alignment set by align-items in the parent container for a single element<br> `auto`, `flex-start`, `flex-end`, `center`, `baseline`, `stretch`, `initial`, `inherit` |
| `order` | `0` | number | sets the order in which the row will appear |

## License
Expand Down

0 comments on commit e596a8f

Please sign in to comment.