woocommerce/plugins/woocommerce-admin/client/analytics/report
Robert Elliott e38284eb96 Merge pull request woocommerce/woocommerce-admin#381 from woocommerce/add/chart-legend-order
Chart Component: remove chart legend ordering for layout=standard and color scales
2018-09-10 16:04:36 +02:00
..
orders Search: move selected from state to props 2018-09-04 12:02:40 +12:00
products Component – Filters: Add "comparison" card (https://github.com/woocommerce/woocommerce-admin/pull/368) 2018-09-10 09:59:14 -04:00
revenue only sort on totals for layout=comparison & add dateParser prop for date formatting 2018-09-10 14:57:36 +02:00
README.md Extensions: Add filter to allow third-party registration of reports (https://github.com/woocommerce/woocommerce-admin/pull/298) 2018-08-20 17:24:17 -04:00
index.js Remove test code/examples and disable the inbox activity panel. (https://github.com/woocommerce/woocommerce-admin/pull/355) 2018-09-05 14:52:48 -04:00
style.scss Add loading indicators, error state, and EmptyContent to the revenue report. (#347, woocommerce/woocommerce-admin#348) 2018-09-05 12:45:49 -04:00

README.md

Reports

The core reports offered by WooCommerce live in this folder. The Header is added automatically by the parent Report component, each individual component should contain just the report contents.

Extending Reports

New reports can be added by third-parties without altering wc-admin, by hooking into the reports filter, woocommerce-reports-list. For example:

addFilter( 'woocommerce-reports-list', 'wc-example/my-report', pages => {
	return [
		...pages,
		{
			report: 'example',
			title: 'My Example Extension',
			component: Report,
		},
	];
} );

Each report is defined by an object containing report, title, component.

  • report (string): The path used to show the report, ex: /analytics/example
  • title (string): The title shown in the breadcrumbs & document title.
  • component (react component): The component containing the report content- everything on the page under the breadcrumbs header.

The component will get the following props:

  • query (object): The query string for the current view, can be used to paginate reports, or sort/filter report data.
  • path (string): The exact path for this view.
  • pathMatch (string): The route matched for this view, should always be /analytics/:report.
  • params (object): This will contain the report from the path, which should match report in the page object.

Note: Adding your page to woocommerce-reports-list does not add the item to the admin menu, you'll need to do that in PHP with wc_admin_register_page.