History

Chi-Hsuan Huang 6832a4b249 Update onboarding task documentation & add back `example` command (#44026 )		2024-01-30 12:05:46 +08:00
..
images	Update onboarding task documentation & add back `example` command (#44026 )	2024-01-30 12:05:46 +08:00
js	Update task list documentation and example (#38245 )	2023-05-18 11:21:53 +08:00
README.md	Update onboarding task documentation & add back `example` command (#44026 )	2024-01-30 12:05:46 +08:00
class-mytask.php	Update task list documentation and example (#38245 )	2023-05-18 11:21:53 +08:00
woocommerce-admin-add-task-example.php	Update onboarding task documentation & add back `example` command (#44026 )	2024-01-30 12:05:46 +08:00

README.md

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