woocommerce/plugins/woocommerce-admin/client/components/card
Kelly Dwan d36511479e Docs Project: Add documentation parser + inline documentation (https://github.com/woocommerce/woocommerce-admin/pull/336)
* Switch all components to default exports

This ensures we can read all components for documentation generation (plus, standardizing is good)

* Add documentation to component file

* Fix table exports

* Move readme docs into inline docs

Includes updating new props, adding prop shapes

* Add doc-generation scripts to pull exported component docs into folder

* Remove key propType, causing react special-keys warning

* Fix proptype

* Update incorrect comment

* Remove template import, we can just use string concat

* Fix typo, update docs
2018-08-31 13:27:21 -04:00
..
test Add CSS naming conventions following Gutenberg’s standards (https://github.com/woocommerce/woocommerce-admin/pull/99) 2018-06-01 10:35:18 -04:00
README.md Rename js/src to client (https://github.com/woocommerce/woocommerce-admin/pull/38) 2018-05-11 12:13:57 -04:00
index.js Docs Project: Add documentation parser + inline documentation (https://github.com/woocommerce/woocommerce-admin/pull/336) 2018-08-31 13:27:21 -04:00
style.scss update mobile card styles 2018-08-30 16:02:12 -07:00

README.md

Card

A basic card component with a header. The header can contain a title (required), an action (optional), and an EllipsisMenu menu (optional).

How to use:

import Card from 'components/card';

render: function() {
  return (
    <Card title={ "Store Performance" }>
      <p>Your stuff in a Card</p>
    </Card>
  );
}

Props

  • title (required): The title to use for this card.
  • action: One "primary" action for this card, appears in the card header
  • className: You can add classes to the card container.
  • menu: An EllipsisMenu, with filters used to control the content visible in this card