Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(Card): add component descriptions #429

Merged
merged 1 commit into from
Aug 24, 2016
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions src/views/Card/Card.js
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,9 @@ import CardGroup from './CardGroup'
import CardHeader from './CardHeader'
import CardMeta from './CardMeta'

/**
* A card displays site content in a manner similar to a playing card
*/
function Card(props) {
const {
centered,
Expand Down
3 changes: 3 additions & 0 deletions src/views/Card/CardContent.js
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,9 @@ import CardDescription from './CardDescription'
import CardHeader from './CardHeader'
import CardMeta from './CardMeta'

/**
* A card can contain blocks of content or extra content meant to be formatted separately from the main content
*/
function CardContent(props) {
const { className, children, description, extra, header, meta } = props
const classes = cx(
Expand Down
3 changes: 3 additions & 0 deletions src/views/Card/CardDescription.js
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,9 @@ import {
META,
} from '../../lib'

/**
* A card can contain a description with one or more paragraphs
*/
function CardDescription(props) {
const { className, children, content } = props
const classes = cx(className, 'description')
Expand Down
3 changes: 3 additions & 0 deletions src/views/Card/CardHeader.js
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,9 @@ import {
META,
} from '../../lib'

/**
* A card can contain a header
*/
function CardHeader(props) {
const { className, children, content } = props
const classes = cx(className, 'header')
Expand Down
3 changes: 3 additions & 0 deletions src/views/Card/CardMeta.js
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,9 @@ import {
META,
} from '../../lib'

/**
* A card can contain content metadata
*/
function CardMeta(props) {
const { className, children, content } = props
const classes = cx(className, 'meta')
Expand Down