@woocommerce/block-library

WooCommerce Product Blocks

Feature plugin for WooCommerce + Gutenberg. Now that the product blocks have been merged into WooCommerce 3.6, this plugin serves as a space to iterate and explore how else WooCommerce might work with the block editor.

If you're just looking to use these blocks, update to WooCommerce 3.6! The blocks are bundled into WooCommerce, and can be added from the "WooCommerce" section in the block inserter.

If you want to see what we're working on for future versions, or want to help out, read on.

Table of Contents

• Installing the stable version
• Installing the development version
• Getting started with block development
• Contributing
  • About the npm scripts
  • Publishing a release
• Code Documentation
  • Blocks
  • Components

Installing the stable 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.

• Make sure you have WordPress 5.0+ and WooCommerce 3.6+
• The stable version is available on WordPress.org. Download the stable version here.
• Activate the plugin.

Installing the development version

• Make sure you have WordPress 5.0+ and WooCommerce 3.6+
• Get a copy of this plugin using the green "Clone or download" button on the right.
• npm install to install the dependencies.
• npm run build (build once) or npm 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.

Other useful docs to explore:

• InnerBlocks
• apiFetch
• @wordpress/editor

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.