e41441f83e
* Add hook reference README * update hook reference * better * changelog * add pr number * remove example * add desc * add stats * jsdoc REPORTS_FILTER * Category configs * configs * data * dashboard * dashboard charts * save * save * save * done with filters * Add scope to slotFill docs * data * add all slotfills * data * Fix error when scope is not present, and make use of typedef imports * Move chart and filter jsdoc definitions to the reports index file * Update hook reference data.json * Make use of import for filter typedef and address some typos Co-authored-by: Lourens Schep <lourensschep@gmail.com> |
||
|---|---|---|
| .. | ||
| test | ||
| README.md | ||
| index.js | ||
| style.scss | ||
| utils.js | ||
README.md
Header
A basic component for the app header. The header outputs breadcrumbs via the sections prop (required) and access to the activity panel. It also sets the document title.
How to use:
import Header from 'header';
render: function() {
return (
<Header
sections={ [
[ '/analytics', __( 'Analytics', 'woocommerce-admin' ) ],
__( 'Report Title', 'woocommerce-admin' ),
] }
/>
);
}
Props
sections(required): Used to generate breadcrumbs. Accepts a single items or an array of items. To make an item a link, wrap it in an array with a relative link (example:[ '/analytics', __( 'Analytics', 'woocommerce-admin' ) ]).isEmbedded: Boolean describing if the header is embedded on an existing wp-admin page. False if rendered as part of a full react page.
Activity Panel
This component contains the Activity Panel. This is shown on every page and is rendered as part of the header.