5c8cfbc03f
* Extend docs to report components * Improve inline documentation in some files * Update doc files * Undo unnecessary doc changes * Remove unnecessary line breaks in sidebar * Rename 'Client components' to 'Analytics components' * Minor docs fixes * Rename toc contents to toc sections * Update endpoint props doc to add an example and more information * Fix outdated comment * Fix merge error |
||
|---|---|---|
| .. | ||
| README.md | ||
| animation-slider.md | ||
| calendar.md | ||
| card.md | ||
| chart.md | ||
| count.md | ||
| dropdown-button.md | ||
| ellipsis-menu.md | ||
| empty-content.md | ||
| filters.md | ||
| flag.md | ||
| gravatar.md | ||
| image-asset.md | ||
| link.md | ||
| order-status.md | ||
| pagination.md | ||
| product-image.md | ||
| rating.md | ||
| search.md | ||
| section-header.md | ||
| section.md | ||
| segmented-selection.md | ||
| split-button.md | ||
| summary.md | ||
| table.md | ||
| tag.md | ||
| text-control-with-affixes.md | ||
| view-more-list.md | ||
README.md
Package 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>
);
}