0be5642d3a
Co-authored-by: Renovate Bot <bot@renovateapp.com> |
||
|---|---|---|
| .. | ||
| .github | ||
| .sources | ||
| assets | ||
| bin | ||
| docs | ||
| src | ||
| storybook | ||
| tests | ||
| .editorconfig | ||
| .env | ||
| .eslintignore | ||
| .eslintrc.js | ||
| .gitattributes | ||
| .gitignore | ||
| .nvmrc | ||
| .prettierrc | ||
| .stylelintrc.json | ||
| .travis.yml | ||
| README.md | ||
| babel.config.js | ||
| composer.json | ||
| composer.lock | ||
| docker-compose.yml | ||
| globals.d.ts | ||
| package-lock.json | ||
| package.json | ||
| phpcs.xml | ||
| phpunit.xml.dist | ||
| postcss.config.js | ||
| readme.txt | ||
| renovate.json | ||
| tsconfig.json | ||
| webpack.config.js | ||
| woocommerce-gutenberg-products-block.php | ||
README.md
WooCommerce Product Blocks
This is the feature plugin for WooCommerce + Gutenberg. This plugin serves as a space to iterate and explore new Blocks and updates to existing blocks for WooCommerce, and how WooCommerce might work with the block editor.
Use this plugin if you want access to the bleeding edge of available blocks for WooCommerce. However, stable blocks are bundled into WooCommerce, and can be added from the "WooCommerce" section in the block inserter.
Table of Contents
- Documentation
- Installing the plugin version
- Installing the development version
- Getting started with block development
- Vision for the Feature
Documentation
To find out more about the blocks and how to use them, check out the documentation on WooCommerce.com.
If you want to see what we're working on for future versions, or want to help out, read on.
Code Documentation
Contributing
Installing the plugin version
We release a new version of WooCommerce Blocks onto WordPress.org every few weeks, which can be used as an easier way to preview the features.
Note: The plugin follows a policy of supporting the "L2" strategy for version support. What this means is that the plugin will support the most recent two minor versions of WordPress, and the most recent two minor versions of WooCommerce core at the time of a release.
That means if the latest version of WooCommerce is 4.3 at the time of a release, then our minimum version requirements for WooCommerce core would be 4.1+.
We recommend you always keep WordPress and WooCommerce core up to date in order to ensure your store is running with the most recent fixes and enhancements to help your store be successful.
- Make sure you have WordPress 5.2+ and WooCommerce 4.0+
- The plugin version is available on WordPress.org. Download the plugin version here.
- Activate the plugin.
Installing the development version
- Make sure you have WordPress 5.2+ and WooCommerce 4.0+
- Get a copy of this plugin using the green "Clone or download" button on the right.
npm installto install the dependencies.composer installto install core dependencies.npm run build(build once) ornpm start(keep watching for changes) to compile the code.- Activate the plugin.
The source code is in the assets/ folder and the compiled code is built into build/.
Getting started with block development
Run through the "Writing Your First Block Type" tutorial for a quick course in block-building.
For deeper dive, try looking at the core blocks code, or see what components are available.
To begin contributing to the WooCommerce Blocks plugin, see our getting started guide and developer handbook.
Other useful docs to explore:
Vision for the Feature
Users should be able to insert a variety of products from their store (specific products, products in a category, with assorted layouts and visual styles, etc.) into their post content using a simple and powerful visual editor.