woocommerce/plugins/woocommerce-blocks/assets/js/blocks
Mike Jolley c7b608a3d0 Introduce a new Products by Tag(s) block (https://github.com/woocommerce/woocommerce-blocks/pull/554)
* Introduced WGPB_Extend_Core class to modify shortcodes and API requests of core

* Require the new class

* WC_REST_Blocks_Products_Controller_V2 to override the wc-blocks API to support new tags properties

* Register new products by tag block type

* Modify utils to support tags and tag_operators

* Add ProductTagControl to handle tag searching

* Add the actual products by tag block

* Set limitTags to 100

* Create Package class and use in main plugin file

* Move and refactor library class - split asset methods into new Assets class.

* Add jetpack autoloader dependency

* fix tests

* Update from master

* AbstractBlock class for general block registration

* remove test autoloader so tests do not break

* Create AbstractProductGrid

* FeaturedProduct

* HandpickedProducts

* ProductBestSellers

* ProductCategory

* ProductNew

* ProductOnSale

* ProductTopRated

* ProductsByAttribute

* Remove old base and render functions

* Allow non-dynamic blocks and register category block

* Fix products-by-attribute due to wrong naming

* Remove no dev

* test phpunit dir

* Update testing framework

* Update with new abstract classes and build in API

* Undo edit to attribute block

* Move edit mode

* No need to support shortcodes

* correct linting errors

* Update tests/bootstrap.php

Co-Authored-By: Albert Juhé Lluveras <aljullu@gmail.com>

* Update code comment to make more sense.

* Correct test package

* docblock

* Fix cancel button class

* Fix classname schema

* Set loading state so spinner is shown

* Add placeholder element when no tags are selected

* No tags placeholder

* Update rest endpoints
2019-07-09 14:42:22 +01:00
..
featured-category Introduce a new Products by Tag(s) block (https://github.com/woocommerce/woocommerce-blocks/pull/554) 2019-07-09 14:42:22 +01:00
featured-product Introduce a new Products by Tag(s) block (https://github.com/woocommerce/woocommerce-blocks/pull/554) 2019-07-09 14:42:22 +01:00
handpicked-products Add button alignment option to product grid blocks (https://github.com/woocommerce/woocommerce-blocks/pull/606) 2019-06-27 12:13:02 +01:00
product-best-sellers Add button alignment option to product grid blocks (https://github.com/woocommerce/woocommerce-blocks/pull/606) 2019-06-27 12:13:02 +01:00
product-categories Add placeholder when no categories exist to list (https://github.com/woocommerce/woocommerce-blocks/pull/678) 2019-07-04 16:05:59 +01:00
product-category Merge branch 'experiment/cancel-button' 2019-06-27 12:22:07 +01:00
product-new Add button alignment option to product grid blocks (https://github.com/woocommerce/woocommerce-blocks/pull/606) 2019-06-27 12:13:02 +01:00
product-on-sale Add button alignment option to product grid blocks (https://github.com/woocommerce/woocommerce-blocks/pull/606) 2019-06-27 12:13:02 +01:00
product-tag Introduce a new Products by Tag(s) block (https://github.com/woocommerce/woocommerce-blocks/pull/554) 2019-07-09 14:42:22 +01:00
product-top-rated Add button alignment option to product grid blocks (https://github.com/woocommerce/woocommerce-blocks/pull/606) 2019-06-27 12:13:02 +01:00
products-by-attribute Abstract block refactor (https://github.com/woocommerce/woocommerce-blocks/pull/656) 2019-07-01 15:26:06 +01: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.