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

# WooCommerce Admin Extension Examples

Examples for extending WooCommerce Admin

## Directions

Install dependencies, if you haven't already.

```bash
npm install
```

Build the example extension by running the npm script and passing the example name.

```bash
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.
Example Extensions: create build environment 2019-04-09 00:39:11 +00:00			`# WooCommerce Admin Extension Examples`

			`Examples for extending WooCommerce Admin`

			`## Directions`

			`Install dependencies, if you haven't already.`

			```bash
			`npm install`
			```

			`Build the example extension by running the npm script and passing the example name.`

			```bash
			`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`

show example extension list as list in readme 2019-07-09 17:30:04 +00:00			- `add-report` - Create a "Hello World" report page.
Onboarding: Add task list extensibility and example plugin (https://github.com/woocommerce/woocommerce-admin/pull/3060) * Add task list filter * Add task example plugin 2019-10-21 03:11:21 +00:00			- `add-task` - Create a custom task for the onboarding task list.
show example extension list as list in readme 2019-07-09 17:30:04 +00:00			- `dashboard-section` - Adding a custom "section" to the new dashboard area.
			- `table-column` - An example of how to add column(s) to any report.
AssetDataRegistry: update SQL example (https://github.com/woocommerce/woocommerce-admin/pull/3418) * AssetDataRegistry: update SQL example * add wc-settings as a dependency * better descripiton 2019-12-16 18:16:46 +00:00			- `sql-modification` - An example of how to modify SQL statements.