d728d38219
* integrate with new asset data registration (php side) - includes back-compatibility. * update js configuration and implement settings alias - this aliases `@woocommerce/wc-admin-settings` to the settings api exposed via blocks (either the blocks plugin or core) and all the settings provided via the server. - Adds fallback for back-compat if `wc.wcSettings` is not available in the environment (fallsback to `wcSettings`). * initial pass to update all wcSettings direct usage to the new api - this is just an initial pass, more can be done in separate pulls. * missed one spot for adding new filter implementation * fix incorrect jest config * Avoid unnecessary assignment and directly return. * Remove unnecessary defaults * Fix inline comment text case. Co-Authored-By: Albert Juhé Lluveras <contact@albertjuhe.com> * Remove unnecessary inline comment. * use @todo instead of TODO Co-Authored-By: Albert Juhé Lluveras <contact@albertjuhe.com> * fix incorrect reference in webpack config. * add missing import and slightly delay dependency injection for scripts * update get-setting and set-setting callbacks * disable lint rule for console.error on dev doc builds |
||
|---|---|---|
| .. | ||
| categories | ||
| coupons | ||
| customers | ||
| downloads | ||
| orders | ||
| products | ||
| revenue | ||
| stock | ||
| taxes | ||
| README.md | ||
| index.js | ||
| style.scss | ||
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 woocommerce-admin, by hooking into the reports filter, woocommerce_admin_reports_list. For example:
addFilter( 'woocommerce_admin_reports_list', 'analytics/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/exampletitle(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 thereportfrom the path, which should matchreportin the page object.
Note: Adding your page to woocommerce_admin_reports_list does not add the item to the admin menu, you'll need to do that in PHP with the woocommerce_admin_report_menu_items filter.