Skip to content

Commit

Permalink
Small changes in card readme
Browse files Browse the repository at this point in the history
  • Loading branch information
javivelasco committed Nov 29, 2015
1 parent ca48169 commit f2738a0
Showing 1 changed file with 22 additions and 28 deletions.
50 changes: 22 additions & 28 deletions components/card/readme.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# Card

A [card](https://www.google.com/design/spec/components/cards.html) is a piece of paper with unique related data that serves as an entry point to more detailed information. For example, a card could contain a photo, text, and a link about a single subject.
A [Card](https://www.google.com/design/spec/components/cards.html) is a piece of paper with unique related data that serves as an entry point to more detailed information. For example, a card could contain a photo, text, and a link about a single subject.

Cards are composed of multiple subcomponents in React Toolbox. You can combine each of the subcomponents to create all different Material Design Cards given in the spec.

<!-- example -->
```jsx
Expand Down Expand Up @@ -36,7 +38,8 @@ return <TestCards />;

<!--component-docgen-start-->

## Card `<Card/>`
## Card

The base card component. This acts as the main card container
that all subcomponents are placed within.

Expand All @@ -47,23 +50,23 @@ that all subcomponents are placed within.
| `className` | `string` | | Additional class(es) for custom styling. |
| `raised` | `bool` | | Increases the shadow depth to appear elevated. |

------------------------------------------------------------------

## CardActions `<CardActions/>`
This component is used as a container for supplemental
card actions. Supplemental actions within the card are
explicitly called out using icons, text, and UI controls,
typically placed at the bottom of the card.
## CardTitle
A versatile title block that can be used in
various places on the card, including the media
area. This component can also display an avatar next
to the title content.

### Properties
| Name | Type | Default | Description |
|:-----|:-----|:-----|:-----|
| `children` | `any` | | Children to pass through the component. |
| `avatar` | `union`(`string`,`element`) | | |
| `children` | `union`(`string`,`element`,`array`) | | Children to pass through the component. |
| `className` | `string` | | Additional class(es) for custom styling. |
| `subtitle` | `string` | | |
| `title` | `string` | | |

------------------------------------------------------------------
## CardMedia

## CardMedia `<CardMedia/>`
Used for displaying media such as images or videos
on a card. Can also be used with a solid background
color instead of an image.
Expand All @@ -78,9 +81,7 @@ color instead of an image.
| `contentOverlay` | `bool` | | Creates a dark overlay underneath the child components. |
| `image` | `union`(`string`,`element`) | | Can be used instead of children. Accepts an element or a URL string. |

------------------------------------------------------------------

## CardText `<CardText/>`
## CardText
Basic card content container. Good for
small descriptions or other supplementary text.

Expand All @@ -90,22 +91,15 @@ small descriptions or other supplementary text.
| `children` | `any` | | Children to pass through the component. |
| `className` | `string` | | Additional class(es) for custom styling. |

------------------------------------------------------------------
## CardActions

## CardTitle `<CardTitle/>`
A versatile title block that can be used in
various places on the card, including the media
area. This component can also display an avatar next
to the title content.
This component is used as a container for supplemental
card actions. Supplemental actions within the card are
explicitly called out using icons, text, and UI controls,
typically placed at the bottom of the card.

### Properties
| Name | Type | Default | Description |
|:-----|:-----|:-----|:-----|
| `avatar` | `union`(`string`,`element`) | | |
| `children` | `union`(`string`,`element`,`array`) | | Children to pass through the component. |
| `children` | `any` | | Children to pass through the component. |
| `className` | `string` | | Additional class(es) for custom styling. |
| `subtitle` | `string` | | |
| `title` | `string` | | |

------------------------------------------------------------------

0 comments on commit f2738a0

Please sign in to comment.