woocommerce/woocommerce-blocks

📣 Announcement: New documentation location

The documentation for WooCommerce Blocks has moved to the WooCommerce monorepo.

Please refer to the documentation in the new location as the files in this repository will no longer be updated and the repository will be archived.

WooCommerce Blocks

This is the feature plugin for WooCommerce + the 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.

• WCCOM product page
• User documentation

Table of Contents

• Documentation
  • Code Documentation
• Installing the plugin version
• Installing the development version
• Getting started with block development
• Long-term vision

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

• Blocks - Documentation for specific Blocks.
• Editor Components - Shared components used in WooCommerce blocks for the editor (Gutenberg) UI.
• WooCommerce Blocks Handbook - Documentation for designers and developers on how to extend or contribute to blocks, and how internal developers should handle new releases.
• WooCommerce Blocks Storybook - Contains a list and demo of components used in the plugin.

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 "L0" strategy for version support. What this means is that the plugin will require the most recent version of WordPress. It will also require the most recent version of WooCommerce core at the time of a release. You can read more about this policy here.

1.Ensure you have the latest available versions of WordPress and WooCommerce installed on your site. 2. The plugin version is available on WordPress.org. Download the plugin version here. 3. Activate the plugin.

Installing the development version

1. Ensure you have the latest versions of WordPress and WooCommerce installed on your site.
2. Get a copy of this plugin using the green "Clone or download" button on the right.
3. Make sure you're using Node.js v16.15. If you use a Node version management tool such as nvm or n, you can do so by running nvm use or n auto, respectively.
4. npm install to install the dependencies.
5. composer install to install core dependencies.
6. To compile the code, run any of the following commands
   1. npm run build (production build).
   2. npm run dev (development build).
   3. npm start (development build + watching for changes).
7. Activate the plugin.

The source code is in the assets/ folder, and the compiled code is stored 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:

• InnerBlocks
• apiFetch
• @wordpress/editor
• @wordpress/create-block

Long-term vision

WooCommerce Blocks are the easiest, most flexible way to build your store's user interface and showcase your products.