c8ef0fb3af
* WIP: experimenting with strategy pattern for block registration * Add TemplateChangeDetector to BlocksRegistrationManager * Handle blocks registration * Fix issue causing blocks to be registered multiple times * Allow register/unregister blocks when on pages or posts * Add BlockRegistrationStrategy logic * Fix import error * Add doc comments for BlockRegistrationManager class * Add doc comments to TemplateChangeDetector class * Fix eslint errors * Import domReady from @wordpress/dom-ready * Prevent error when using blockName for registerBlockType function * Add e2e tests to check for block availability in different contexts * Add e2e tests to cover block availability on different contexts |
||
---|---|---|
.. | ||
active-filters | ||
attribute-filter | ||
breadcrumbs | ||
cart | ||
cart-checkout-shared | ||
catalog-sorting | ||
checkout | ||
classic-shortcode | ||
classic-template | ||
collection-filters | ||
customer-account | ||
featured-items | ||
filter-wrapper | ||
handpicked-products | ||
migration-products-to-product-collection | ||
mini-cart | ||
order-confirmation | ||
page-content-wrapper | ||
price-filter | ||
product-best-sellers | ||
product-categories | ||
product-category | ||
product-collection | ||
product-gallery | ||
product-new | ||
product-on-sale | ||
product-query | ||
product-results-count | ||
product-search | ||
product-tag | ||
product-template | ||
product-top-rated | ||
products | ||
products-by-attribute | ||
rating-filter | ||
reviews | ||
shared/styles | ||
single-product | ||
stock-filter | ||
store-notices | ||
README.md |
README.md
Blocks
Our blocks are generally made up of up to 4 files:
|- block.js
|- editor.scss
|- index.js
|- style.scss
The only required file is index.js
, this sets up the block using registerBlockType
. Each block has edit and save functions.
The scss files are split so that things in style
are added to the editor and frontend, while styles in editor
are only added to the editor. Most of our blocks should use core components that won't need CSS though.
Editing
A simple edit function can live in index.js
, but most blocks are a little more complicated, so the edit function instead returns a Block component, which lives in block.js
. By using a component, we can use React lifecycle methods to fetch data or save state.
The Newest Products block is a good example to read over, this is a simple block that fetches the products and renders them using the ProductPreview component.
We include settings in the sidebar, called the Inspector in gutenberg. See an example of this.
Other blocks have the concept of an "edit state", like when you need to pick a product in the Featured Product block, or pick a category in the Products by Category block.