woocommerce/plugins/woocommerce-admin/client/header
Joshua T Flowers 198e3fb7ce Add navigation container tests (https://github.com/woocommerce/woocommerce-admin/pull/6464)
* Add changelog and testing instructions

* Set active level when matching a new item

* Add navigation container tests

* Add testing instructions and changelog

* Update testing instructions

* Fix up missing changelog entries after rebase

* Add in missing menu items from useSelect in tests
2021-03-05 09:35:53 -05:00
..
activity-panel add preview site btn in personalize store task (https://github.com/woocommerce/woocommerce-admin/pull/6513) 2021-03-04 18:37:18 -08:00
test Add navigation container tests (https://github.com/woocommerce/woocommerce-admin/pull/6464) 2021-03-05 09:35:53 -05:00
README.md Allow each page to specify their breadcrumbs without having to render the Header component (https://github.com/woocommerce/woocommerce-admin/pull/2491) 2019-07-05 09:15:49 +01:00
index.js Add a back button to the Header when the task list is displayed. (https://github.com/woocommerce/woocommerce-admin/pull/6397) 2021-03-03 13:05:08 +13:00
style.scss Add a back button to the Header when the task list is displayed. (https://github.com/woocommerce/woocommerce-admin/pull/6397) 2021-03-03 13:05:08 +13: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.

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.