woocommerce/plugins/woocommerce-admin/docs/examples/extensions
Chi-Hsuan Huang 86fc8b62e5 Switch to pnpm (https://github.com/woocommerce/woocommerce-admin/pull/8349)
* Add pnpm-workspace.yaml

* Add missing dependencies & replace file: with workspace:* in
package.json

* Replace "npm" with "pnpm"

* Replace "npx" with "pnpx"

* Remove package-lock.json

* Add pnpm setup action to github workflows

* Update webpack babel exclude path

* Upgrade woo e2e and fix e2e test command

Update e2e.yml

Use pnpm run e2e:docker-up in e2e.yml

* Remove unused docker-compose.yaml

* Replace lerna with pnpm commands

Update publish commands

* Exclude _locutus_shared_bc.js in babel.config.js

* Add .npmrc to set enable-pre-post-scripts=true by default

* Fix storybook babel config

Update babel.config.js

* Add changelog

* Update pnpm-lock.yaml

* Replace pnpx with pnpm exec

* Update pnpm-lock.yaml

* Remove js-tests/package-lock.json

* Fix @woocommerce/tracks -> workspace:*

* Update pnpm-lock.yaml

* Add @woocommerce/experimental to onboarding/package.json

* Add "@woocommerce/component" to onboarding/package.json

* Update pnpm-lock.yaml

* Use || instead of && for "test:watch"

Co-authored-by: RJ <27843274+rjchow@users.noreply.github.com>

* Fix packages/number "clean" command

* Add root: true to .eslintrc.js to enforce it to use the root config file

* Exclude packages/**/node_modules from babel transpiling

* Fix js-tests build config

Co-authored-by: RJ <27843274+rjchow@users.noreply.github.com>
2022-03-04 12:01:16 +08: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
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 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 Switch to pnpm (https://github.com/woocommerce/woocommerce-admin/pull/8349) 2022-03-04 12:01:16 +08:00
examples.config.js Remove unpublished wc-admin-settings package and update getSetting usage (https://github.com/woocommerce/woocommerce-admin/pull/8057) 2022-01-06 08:53:30 -04: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.

pnpm 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.