dc5304823b
* add new woocommerce/eslint-plugin * implement eslint-plugin (switch scripts to use wp-scripts etc) * various linting fixes * more lint fixes * improve fix script * more eslint fixes * more eslint fixes * temporary convert rules to warnings until they are all handled * linting fixes * update package-lock.json * remove duplicates * remove unnecessary `@wordpress/dependency-group` rule config * add docs and adjust rules * prettier fix * fix merge artifact * convert more rules to warnings * change order to reflect importance * install babel-preset-default * remove unnecessary configuration for babel * fix dependency group rule and test * fix test * handle collapsible whitespace * add react testing library eslint plugin * linter errors * Add back in prettierrc * package-lock update * js lint fix with --fix * disable whitespace in translation * package-lock update * make eslint actual dependency, not peer dependency * pin eslint to v7 * I don't know why, but its working * fix lint js 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.