woocommerce/plugins/woocommerce-admin/docs/examples/extensions
Joshua T Flowers 5f8db47c16 Add payment gateway suggestion docs and example extensions (https://github.com/woocommerce/woocommerce-admin/pull/7966)
* Remove dated doc references

* Clean up slotfill and install script docs

* Add filter to suggestion specs

* Register example gateways

* Mock gateway installation and activation

* Add simple gateway

* Update gateway IDs

* Add slot filled gateway

* Add slot fill for slot filled gateway

* Allow gateway to be enabled and marked as configured if already enabled

* Add changelog entry

* Add quick start blurb to markdown file

* Remove duplicate JS registration and add default export

* Add payment settings save hook
2021-12-03 15:13:05 -05: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 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 Remove hardcoded dependencies from examples. (https://github.com/woocommerce/woocommerce-admin/pull/6542) 2021-03-24 11:10:32 +13:00
add-task Update add task extension example (https://github.com/woocommerce/woocommerce-admin/pull/7809) 2021-10-27 15:03:27 -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
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
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.