d36511479e
* 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 |
||
|---|---|---|
| .. | ||
| animation-slider | ||
| calendar | ||
| card | ||
| chart | ||
| count | ||
| dropdown-button | ||
| ellipsis-menu | ||
| filters | ||
| flag | ||
| gravatar | ||
| higher-order/use-filters | ||
| link | ||
| order-status | ||
| pagination | ||
| product-image | ||
| rating | ||
| search | ||
| segmented-selection | ||
| split-button | ||
| summary | ||
| table | ||
| tag | ||
| README.md | ||
| index.js | ||
README.md
Components
This folder contains the WooCommerce-created components. These are exported onto a global, wc.components, for general use.
How to use:
For any files not imported into components/index.js (analytics/*, layout/*, dashboard/*, etc), we can use import { Card, etc … } from @woocommerce/components.
For any component/* files, we should import from component-specific paths, not from component/index.js, to prevent circular dependencies. See components/card/index.js for an example.
import { Card, Link } from '@woocommerce/components';
render: function() {
return (
<Card title="Card demo">
Card content with an <Link href="/">example link.</Link>
</Card>
);
}
For external development
External developers will need to enqueue the components library, wc-components, and then can access them from the global.
const { Card, Link } = wc.components;
render: function() {
return (
<Card title="Card demo">
Card content with an <Link href="/">example link.</Link>
</Card>
);
}