woocommerce/plugins/woocommerce-admin/docs/examples/extensions
Christopher Allford b7931409f2
Migrate From Nx to Turborepo (#33079)
This replaces all `nx` commands with `turbo` commands and removes Nx from the repository. All of the `project.json` files have been removed and any commands that broke with Turborepo have been adjusted.
2022-06-09 14:40:07 -07:00
..
add-abbreviated-notification Cleanup Loader.php and move it to Internal namespace (https://github.com/woocommerce/woocommerce-admin/pull/8416) 2022-03-09 10:04:34 -04:00
add-navigation-items Fixing an unwanted page refresh when using Woo Navigation (https://github.com/woocommerce/woocommerce-admin/pull/7615) 2021-09-15 09:42:54 -07:00
add-report Cleanup Loader.php and move it to Internal namespace (https://github.com/woocommerce/woocommerce-admin/pull/8416) 2022-03-09 10:04:34 -04:00
add-task Separate onboarding concerns into separate classes (https://github.com/woocommerce/woocommerce-admin/pull/8280) 2022-03-17 17:10:43 -03:00
dashboard-section Cleanup Loader.php and move it to Internal namespace (https://github.com/woocommerce/woocommerce-admin/pull/8416) 2022-03-09 10:04:34 -04:00
important-admin-notice Cleanup Loader.php and move it to Internal namespace (https://github.com/woocommerce/woocommerce-admin/pull/8416) 2022-03-09 10:04:34 -04:00
payment-gateway-suggestions Add payment gateway suggestion docs and example extensions (https://github.com/woocommerce/woocommerce-admin/pull/7966) 2021-12-03 15:13:05 -05:00
simple-inbox-note Add Inbox Note example code to docs (https://github.com/woocommerce/woocommerce-admin/pull/8019) 2021-12-10 12:52:03 +08:00
sql-modification Cleanup Loader.php and move it to Internal namespace (https://github.com/woocommerce/woocommerce-admin/pull/8416) 2022-03-09 10:04:34 -04:00
table-column Cleanup Loader.php and move it to Internal namespace (https://github.com/woocommerce/woocommerce-admin/pull/8416) 2022-03-09 10:04:34 -04:00
README.md Migrate From Nx to Turborepo (#33079) 2022-06-09 14:40:07 -07:00
examples.config.js Fix admin extensions webpack config 2022-04-14 13:49:51 +08:00

README.md

WooCommerce Admin Extension Examples

Examples for extending WooCommerce Admin

Directions

Install dependencies, if you haven't already.

pnpm install

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

WC_EXT=<example> pnpm example --filter=@woocommerce/admin-library

Include the output plugin in your .wp-env.json and .wp-env.override.json and restart the WordPress instance. 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.