History

Joshua T Flowers 8b1e263709 Onboarding: Add task list extensibility and example plugin (https://github.com/woocommerce/woocommerce-admin/pull/3060 ) * Add task list filter * Add task example plugin		2019-10-21 11:11:21 +08:00
..
add-report	Remove defunct filename prefix from remaining files.	2019-08-12 15:06:36 -07:00
add-task	Onboarding: Add task list extensibility and example plugin (https://github.com/woocommerce/woocommerce-admin/pull/3060 )	2019-10-21 11:11:21 +08:00
dashboard-section	Remove defunct filename prefix from remaining files.	2019-08-12 15:06:36 -07:00
table-column	Remove defunct filename prefix from remaining files.	2019-08-12 15:06:36 -07:00
README.md	Onboarding: Add task list extensibility and example plugin (https://github.com/woocommerce/woocommerce-admin/pull/3060 )	2019-10-21 11:11:21 +08:00
examples.config.js	Extensions: Add Dashboard Section	2019-05-23 08:27:59 +12:00

README.md

WooCommerce Admin Extension Examples

Examples for extending WooCommerce Admin

Directions

Install dependencies, if you haven't already.

npm install

Build the example extension by running the npm script and passing the example name.

npm run example -- --ext=<example>

Go to your Wordpress installation's plugins page and activate the plugin. WooCommerce Analytics reports will now reflect the changes made by the example extension.

You can make changes to Javascript and PHP files in the example and see changes reflected upon refresh.

Example Extensions

add-report - Create a "Hello World" report page.
add-task - Create a custom task for the onboarding task list.
dashboard-section - Adding a custom "section" to the new dashboard area.
table-column - An example of how to add column(s) to any report.