woocommerce/plugins/woocommerce-admin/client/header
Paul Sealock b3bde09814 Merge pull request woocommerce/woocommerce-admin#2444 from woocommerce/update/route-handling
Route handling: Remove hash in favor of path parameter
2019-07-03 13:16:04 +12:00
..
activity-panel Merge pull request woocommerce/woocommerce-admin#2444 from woocommerce/update/route-handling 2019-07-03 13:16:04 +12:00
README.md Update text domain. (https://github.com/woocommerce/woocommerce-admin/pull/1795) 2019-03-13 11:14:02 -06:00
index.js WC_Admin_Loader/PHP Refactor + Method to publish core ready features (https://github.com/woocommerce/woocommerce-admin/pull/1863) 2019-04-11 14:31:31 -04:00
style.scss Fix Activity Panel being overlapped by editor toolbar (https://github.com/woocommerce/woocommerce-admin/pull/2446) 2019-06-18 11:33:39 +02:00

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. The Header component used in each section automatically fills into the "header" slot defined in <Layout />. We're using react-slot-fill to avoid a duplicated div wrapper from Gutenberg's implementation.

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.