Steve-Dee-Designs
/
woocommerce
mirror of https://github.com/woocommerce/woocommerce.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
woocommerce/plugins/woocommerce-admin/docs/examples/extensions
History
Sam Seay c07a5d77a6 Remove the deprecated Card component (https://github.com/woocommerce/woocommerce-admin/pull/7114) 2021-06-04 07:43:56 +12: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 Remove hardcoded dependencies from examples. (https://github.com/woocommerce/woocommerce-admin/pull/6542) 2021-03-24 11:10:32 +13:00
dashboard-section Remove the deprecated Card component (https://github.com/woocommerce/woocommerce-admin/pull/7114) 2021-06-04 07:43:56 +12: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.