666d8e4a3b
* Move labels loading logic into a lib * Move lib/labels into lib/async-requests * Implement tabular data filtering * Allow searching for string in report tables * Add table filtering to customers table * Get ids from searched string to populate the table * Fix autocompleter keyboard interactions * Improve props naming * Cleanup report customers data store * Prevent an edge case issue that might not update the selectedOptions when directily modifying the URL * Fix wrong selected autocompleter option * Add missing translation domain * Move searchItemsByString to wc-api/items/utils.js * Avoid autocompleter results appearing when there was no search string * Alphabetically order 'allowFreeTextSearch' prop * Reset selected table rows when directly modifying the URL * Simplify props destructuring * Undo customers data store change * Simplify isProductDetailsView expression * Improve order * Merge getOrders and getItems |
||
|---|---|---|
| .. | ||
| 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 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/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-reports-list does not add the item to the admin menu, you'll need to do that in PHP with wc_admin_register_page.