f3bd3e6a09
* install directory-named-webpack-plugin * create new plugin for fallback legacy imports * implement webpack configuration for fallback legacy imports and legacy builds Note: legacy builds are currently disabled, we can enable by just commenting out when we need them. * removed unused webpack plugin experimented with in earlier iteration * prettier fixes * add legacy folder with readme for explanation * add some info on legacy builds to `CONTRIBUTING.md` * refactor imports to use new aliases * fix link in doc * update jest test config for new aliases * use native string.startsWith instead of custom function * reformat file for spacing/code style * add slash to alias * clean up webpack config and make things more dry * update indent style for json files to be tab not spaces - adjusts editorconfig rules - reformat jest.config.json * simplify conditional |
||
|---|---|---|
| .. | ||
| featured-category | ||
| featured-product | ||
| handpicked-products | ||
| product-best-sellers | ||
| product-categories | ||
| product-category | ||
| product-new | ||
| product-on-sale | ||
| product-search | ||
| product-tag | ||
| product-top-rated | ||
| products-by-attribute | ||
| reviews | ||
| 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.
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.