woocommerce/plugins/woocommerce-blocks/assets/js/blocks
Albert Juhé Lluveras ddd272867e Create renderFrontend utils function (https://github.com/woocommerce/woocommerce-blocks/pull/954)
* Create renderFrontend utils function

* Avoid unnecessary variable assignment
2019-09-09 15:25:22 +02:00
..
featured-category Rename ApiErrorPlaceholder to ErrorPlaceholder (https://github.com/woocommerce/woocommerce-blocks/pull/955) 2019-09-09 14:04:54 +02:00
featured-product Rename ApiErrorPlaceholder to ErrorPlaceholder (https://github.com/woocommerce/woocommerce-blocks/pull/955) 2019-09-09 14:04:54 +02:00
handpicked-products Reformat files with new tabwidth (https://github.com/woocommerce/woocommerce-blocks/pull/953) 2019-09-09 12:52:48 +02:00
product-best-sellers Reformat files with new tabwidth (https://github.com/woocommerce/woocommerce-blocks/pull/953) 2019-09-09 12:52:48 +02:00
product-categories Create renderFrontend utils function (https://github.com/woocommerce/woocommerce-blocks/pull/954) 2019-09-09 15:25:22 +02:00
product-category Reformat files with new tabwidth (https://github.com/woocommerce/woocommerce-blocks/pull/953) 2019-09-09 12:52:48 +02:00
product-new Reformat files with new tabwidth (https://github.com/woocommerce/woocommerce-blocks/pull/953) 2019-09-09 12:52:48 +02:00
product-on-sale Reformat files with new tabwidth (https://github.com/woocommerce/woocommerce-blocks/pull/953) 2019-09-09 12:52:48 +02:00
product-search Reformat files with new tabwidth (https://github.com/woocommerce/woocommerce-blocks/pull/953) 2019-09-09 12:52:48 +02:00
product-tag Reformat files with new tabwidth (https://github.com/woocommerce/woocommerce-blocks/pull/953) 2019-09-09 12:52:48 +02:00
product-top-rated Reformat files with new tabwidth (https://github.com/woocommerce/woocommerce-blocks/pull/953) 2019-09-09 12:52:48 +02:00
products-by-attribute Reformat files with new tabwidth (https://github.com/woocommerce/woocommerce-blocks/pull/953) 2019-09-09 12:52:48 +02:00
reviews Create renderFrontend utils function (https://github.com/woocommerce/woocommerce-blocks/pull/954) 2019-09-09 15:25:22 +02:00
README.md Update and add documentation in READMEs (https://github.com/woocommerce/woocommerce-blocks/pull/551) 2019-05-09 10:45:09 -04:00

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.

Saving

Usually blocks can be converted to HTML in the save function, so that what's saved into the database is the same HTML that's rendered on the frontend. Our blocks are different since they need to show the latest products and reflect any changes to products.

The grid blocks are saved as shortcodes using getShortcode, but the Featured Product block is considered a "dynamic block", so we use PHP to build that each time the post is loaded on the frontend. The code for that is set up when the block is registered in PHP, and lives in WGPB_Block_Featured_Product.