woocommerce/plugins/woocommerce-blocks/docs/README.md

WooCommerce Blocks Handbook

Table of Contents

• Contributors
• Internal developers
• Third-party developers
• Designers
• Developer Resources
  • Tools
  • Articles
  • Tutorials

The WooCommerce Blocks Handbook provides documentation for designers and developers on how to extend or contribute to blocks, and how internal developers should handle new releases.

Contributors

Want to contribute to the WooCommerce Blocks plugin? The following documents offer information that can help you get started.

• Contributing
  • Getting Started
  • Coding Guidelines
  • Block Script Assets
  • CSS Build System
  • JavaScript Build System
  • JavaScript Testing
  • Storybook & Components

Internal developers

Are you an internal developer? The following documents offer information about the different blocks, the Block Client APIs, the Store API, the templates and the testing process.

• Blocks
  • Stock Reservation during Checkout
  • Features Flags and Experimental interfaces
• Block Data
  • Collections Store
  • Query State Store
  • Schema Store
• Block Client APIs
  • Checkout API interface
  • Checkout Flow and Events
  • Notices
• Data store
  • Validation
• Editor Components
  • SearchListControl
  • Tag
  • TextToolbarButton
• Icons
• Store API (REST API)
• Storybook
• Templates
  • BlockTemplateController.php
  • ClassicTemplate.php
  • Classic Template Block
• Testing
  • When to employ end to end testing
  • Smoke Testing
  • Cart and Checkout Testing
    • General Flow
    • Editor
    • Shipping
    • Payments
    • Items
    • Taxes
    • Coupons
    • Compatibility
  • Releases
• Translations
  • Translation basics
  • Translations in PHP files
  • Translations in JS/TS files
  • Translations in FSE templates
  • Translations for lazy-loaded components
  • Translation loading
  • Translation management

Third-party developers

Are you a third-party developer? The following documents explain how to extend the WooCommerce Blocks plugin with your custom extension.

• Extensibility
  • Hooks
    • Actions
    • Filters
  • REST API
    • Exposing your data in the Store API
    • Available endpoints to extend with ExtendSchema
    • Adding an endpoint to ExtendSchema
    • Available Formatters
    • Updating the cart with the Store API
  • Checkout Payment Methods
    • Checkout Flow and Events
    • Payment Method Integration
    • Filtering Payment Methods
  • Checkout Blocks
    • IntegrationInterface
    • Available Filters
    • Slots and Fills
    • Available Slot Fills
    • DOM Events
    • Blocks Registry
    • Components
    • Filter Registry
    • Slot and Fill
    • Utilities

Designers

Are you a designer? The following documents explain how to apply design-changes to the WooCommerce Blocks plugin.

• Theming
  • Filter blocks
  • Cart and Checkout
  • Class names update in 4.6.0
  • Class names update in 3.4.0
  • Class names update in 3.3.0
  • Class names update in 2.8.0
  • Product grid blocks style update in 2.7.0

Developer Resources

Tools

• @woocommerce/extend-cart-checkout-block This is a template to be used with @wordpress/create-block to create a WooCommerce Blocks extension starting point. It also showcases how to use some extensibility points, e.g. registering an inner block in the Checkout Block, applying filters to certain texts such as the place order button, using Slot/Fill and how to change the behaviour of the Store API.

Articles

The following posts from developer.woocommerce.com provide deeper insights into the WooCommerce Blocks development.

• Store API is now considered stable
• Available Extensibility Interfaces for The Cart and Checkout Blocks
• How The Checkout Block Processes An Order
• New @wordpress/data stores in WooCommerce Blocks

Tutorials

The following tutorials from developer.woocommerce.com help you with extending the WooCommerce Blocks plugin.

• Hiding Shipping and Payment Options in the Cart and Checkout Blocks
• Integrating your Payment Method with Cart and Checkout Blocks
• Exposing Payment Options in the Checkout Block

---

We're hiring! Come work with us!

🐞 Found a mistake, or have a suggestion? Leave feedback about this document here.