woocommerce/plugins/woocommerce-admin/docs/examples/extensions
Joshua T Flowers 8f836c292f Create task list APIs (https://github.com/woocommerce/woocommerce-admin/pull/7577)
* Add endpoint to hide task lists

* Migrate old setup task list hidden option

* Use option to store all hidden lists

* Add getter for deprecated options

* Migrate old task list options

* Move task lists into separate class

* Add TaskList class for individual task list control

* Update hidden checks to use TaskList api

* Update docs for hidden lists

* Update use of should_show_tasks to check for visible task lists

* Remove hide endpoint to reduce scope on PR

* Fix up failing tests

* Fix up rebase

* Add back in should_show_tasks with deprecation notice

* Add delay between payment tests
2021-09-02 17:40:02 -04:00
..
add-abbreviated-notification Add `slotFill` to Abbreviated Notification panel (https://github.com/woocommerce/woocommerce-admin/pull/7091) 2021-06-11 10:37:21 -03:00
add-navigation-items Remove hardcoded dependencies from examples. (https://github.com/woocommerce/woocommerce-admin/pull/6542) 2021-03-24 11:10:32 +13:00
add-report Remove hardcoded dependencies from examples. (https://github.com/woocommerce/woocommerce-admin/pull/6542) 2021-03-24 11:10:32 +13:00
add-task Create task list APIs (https://github.com/woocommerce/woocommerce-admin/pull/7577) 2021-09-02 17:40:02 -04:00
dashboard-section Revert Card component removal (https://github.com/woocommerce/woocommerce-admin/pull/7167) 2021-06-11 14:26:02 +08:00
important-admin-notice Remove hardcoded dependencies from examples. (https://github.com/woocommerce/woocommerce-admin/pull/6542) 2021-03-24 11:10:32 +13:00
sql-modification Remove hardcoded dependencies from examples. (https://github.com/woocommerce/woocommerce-admin/pull/6542) 2021-03-24 11:10:32 +13:00
table-column Remove hardcoded dependencies from examples. (https://github.com/woocommerce/woocommerce-admin/pull/6542) 2021-03-24 11:10:32 +13:00
README.md Fix typo in README (https://github.com/woocommerce/woocommerce-admin/pull/6183) 2021-02-02 08:25:14 +08:00
examples.config.js Remove hardcoded dependencies from examples. (https://github.com/woocommerce/woocommerce-admin/pull/6542) 2021-03-24 11:10:32 +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.