woocommerce/plugins/woocommerce-admin/docs/examples/extensions
Fernando dc02c47499 Home Screen - Small refactor to tasks extensibility (https://github.com/woocommerce/woocommerce-admin/pull/5833)
* Added unregister extended task

This commit adds a method to unregister extended task when the plugin is deactivated

* Refactored task lists handling

This commit refactors the task lists handling

* Added default task type

This commit adds a default task type

* Fixed method comment

* Moved method to group objects to lib

This commit moves method to group objects to `lib`

* Refactored getUngroupedTasks method

Co-authored-by: Fernando Marichal <contacto@fernandomarichal.com>
2020-12-10 23:29:45 -03:00
..
add-navigation-items Try: Register plugins under separate navigation menu (https://github.com/woocommerce/woocommerce-admin/pull/5513) 2020-11-05 09:00:04 -05:00
add-report Fix usage of "package" tag in file headers (https://github.com/woocommerce/woocommerce-admin/pull/4940) 2020-08-11 16:18:47 -03:00
add-task Home Screen - Small refactor to tasks extensibility (https://github.com/woocommerce/woocommerce-admin/pull/5833) 2020-12-10 23:29:45 -03:00
dashboard-section Fix usage of "package" tag in file headers (https://github.com/woocommerce/woocommerce-admin/pull/4940) 2020-08-11 16:18:47 -03:00
important-admin-notice Fix usage of "package" tag in file headers (https://github.com/woocommerce/woocommerce-admin/pull/4940) 2020-08-11 16:18:47 -03:00
sql-modification Fix usage of "package" tag in file headers (https://github.com/woocommerce/woocommerce-admin/pull/4940) 2020-08-11 16:18:47 -03:00
table-column Use filtered headers array in onColumnsChange callback. (https://github.com/woocommerce/woocommerce-admin/pull/4964) 2020-08-14 12:14:04 -04:00
README.md AssetDataRegistry: update SQL example (https://github.com/woocommerce/woocommerce-admin/pull/3418) 2019-12-17 07:16:46 +13:00
examples.config.js Align WooCommerce javascript code standards/linting/styles with WordPress core. (https://github.com/woocommerce/woocommerce-admin/pull/3674) 2020-02-14 15:23:21 +13: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.
  • sql-modification - An example of how to modify SQL statements.