woocommerce/plugins/woocommerce-blocks/assets/js/blocks
Mike Jolley 09aa20d0d3 Introduce Atomic Add to Cart Block (https://github.com/woocommerce/woocommerce-blocks/pull/2705)
* Form/button stucture

* Use registerBlockComponent

* Context for add to cart form

* Working cart button

* Tidy up button component

* Add todos

* Revert reg block

* Hide stock indicator if not purchasable

* Hide terms if empty

* Add url and type to API

* Skip default category from term response

* Rename form element

* Form for product types

* Tidy up context provider and expand todos

* No longer using qty icon

* Update todos

* Correct text domain

* registerExperimentalBlockType

* Duplicate method

* Remove prevent default

* Update docblock

* Description for button code
2020-06-17 10:52:03 +01:00
..
active-filters Make filter font sizes named (https://github.com/woocommerce/woocommerce-blocks/pull/2594) 2020-06-01 06:45:40 +02:00
attribute-filter Use named font sizes instead of values in px (https://github.com/woocommerce/woocommerce-blocks/pull/2533) 2020-05-29 12:16:33 +02:00
cart-checkout Fix Cart and Checkout sidebar styling issues (https://github.com/woocommerce/woocommerce-blocks/pull/2694) 2020-06-12 14:07:02 +02:00
featured-category Update placeholder styles (https://github.com/woocommerce/woocommerce-blocks/pull/2456) 2020-05-28 12:20:47 +02:00
featured-product Update placeholder styles (https://github.com/woocommerce/woocommerce-blocks/pull/2456) 2020-05-28 12:20:47 +02:00
handpicked-products Update placeholder styles (https://github.com/woocommerce/woocommerce-blocks/pull/2456) 2020-05-28 12:20:47 +02:00
price-filter Use named font sizes instead of values in px (https://github.com/woocommerce/woocommerce-blocks/pull/2533) 2020-05-29 12:16:33 +02:00
product-best-sellers Update wp.editor references, bump min version support (https://github.com/woocommerce/woocommerce-blocks/pull/2434) 2020-05-13 08:31:49 +12:00
product-categories Fix Product Categories List align attribute (https://github.com/woocommerce/woocommerce-blocks/pull/2700) 2020-06-16 13:18:04 +02:00
product-category Update placeholder styles (https://github.com/woocommerce/woocommerce-blocks/pull/2456) 2020-05-28 12:20:47 +02:00
product-new Update wp.editor references, bump min version support (https://github.com/woocommerce/woocommerce-blocks/pull/2434) 2020-05-13 08:31:49 +12:00
product-on-sale Update wp.editor references, bump min version support (https://github.com/woocommerce/woocommerce-blocks/pull/2434) 2020-05-13 08:31:49 +12:00
product-search Use named font sizes instead of values in px (https://github.com/woocommerce/woocommerce-blocks/pull/2533) 2020-05-29 12:16:33 +02:00
product-tag Update placeholder styles (https://github.com/woocommerce/woocommerce-blocks/pull/2456) 2020-05-28 12:20:47 +02:00
product-top-rated Update wp.editor references, bump min version support (https://github.com/woocommerce/woocommerce-blocks/pull/2434) 2020-05-13 08:31:49 +12:00
products Add Inner Block Rendering and Atomic Block Styles (https://github.com/woocommerce/woocommerce-blocks/pull/2607) 2020-06-05 13:18:16 +01:00
products-by-attribute Update placeholder styles (https://github.com/woocommerce/woocommerce-blocks/pull/2456) 2020-05-28 12:20:47 +02:00
reviews Update placeholder styles (https://github.com/woocommerce/woocommerce-blocks/pull/2456) 2020-05-28 12:20:47 +02:00
single-product Introduce Atomic Add to Cart Block (https://github.com/woocommerce/woocommerce-blocks/pull/2705) 2020-06-17 10:52:03 +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.