25 lines
1.1 KiB
Markdown
25 lines
1.1 KiB
Markdown
|
# 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](../../../features/onboarding-tasks.md) for more information.
|
||
|
|
|
||
|
|
## Usage
|
||
|
|
|
||
|
|
Run the following command to build the example plugin:
|
||
|
|
|
||
|
|
```bash
|
||
|
|
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:
|
||
|
|
|
||
|
|
<!-- markdownlint-disable-next-line no-inline-html -->
|
||
|
|
<img src="./images/task-example.png" width="500px" alt="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:
|
||
|
|
|
||
|
|
```bash
|
||
|
|
WC_EXT=add-task pnpm --filter=@woocommerce/admin-library example --watch
|
||
|
|
```
|