woocommerce/plugins/woocommerce-admin/docs/examples/extensions/add-task/README.md

1.1 KiB

WooCommerce Onboarding Tasks - Adding Custom Tasks Example

This example demonstrates how to add a custom task to the onboarding wizard.

Please refer to the Onboarding Tasks documentation for more information.

Usage

Run the following command to build the example plugin:

WC_EXT=add-task pnpm --filter=@woocommerce/admin-library example

After running the command above, you should see an add-task plugin folder in the project's plugins/ directory. Once activating the plugin, you should see a new task in the onboarding wizard:

Screenshot of the onboarding wizard with the custom task

You can make changes to the example plugin in the plugins/woocommerce-admin/docs/examples/extensions/add-task directory. To watch for changes in the example plugin and rebuild it automatically, run the following command:

WC_EXT=add-task pnpm --filter=@woocommerce/admin-library example --watch