33c5b41e3f
* align code styles with the same configuration as Woo-Blocks * initial pass of reformat-files * applies manual fixes to various new linting errors surfaced by the configuration change. * Fix state mutation in image-upload * remove unused pre-commit-hook.js * requestAnimationFrame -> window.requestAnimationFrame * wc-api eslint changes * eslint fixes on client/lib and client/settings * client/header eslint changes * fixes for client/dashboard part 1 * fixes client/dashboard part 2 of 2 * client/analytics part 1 * client/analytics continued * client/analytics, last batch * rename __mock__ directory * pass in useEffect, useState from React component or function * remove '+' from sprintf string argument * use ref instead of findDOMNode * reformat and repaply package.json changes * install deps before running linter in Travis * useGetCountryStateAutofill * counryStateAutofill * countryStateAutofill Co-authored-by: Paul Sealock <psealock@gmail.com> |
||
---|---|---|
.. | ||
activity-panel | ||
test | ||
README.md | ||
index.js | ||
style.scss |
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.