Download the PHP package giantpeach/blocks without Composer
On this page you can find all versions of the php package giantpeach/blocks. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package blocks
giantpeach/blocks
2.0
2.0 introduces an improved Block class to make life simpler. As a result, it is not backwards compatible with blocks created using the 1.0 version of the package.
Updates include:
- Less boilerplate code
- You no longer need a
__construct()method in your blocks, instead you can use themount()method for any property assignments you need to do - The
display()method has been removed, block rendering is now all handled by the parent class
- You no longer need a
get_image_field('field_name')helper method to return an image ID from an ACF field regardless of the ACF return value- optional
$twigViewand$phpViewproperties to allow you to specify a different view file for your block
Using the wp create-block command will now scaffold a block using the 2.0 version of the package, but upgrading existing blocks will require some manual changes. Fortunately, the old Block class is still available under the Giantpeach\Schnapps\Blocks\Compatability namespace, so you don't need to migrate all your blocks at once.
To upgrade an existing block to 2.0 you will need to:
- move any existing
__construct()anddisplay()code into themount()method - remove the
display()method - update the block.json acf.renderCallback to point to the new block render function:
"Giantpeach\\Schnapps\\Theme\\Blocks\\Blocks::renderBlock"
Description
This package aims to simplify block creation and usage in Wordpress. It is designed and included as part of the Peach Schnapps Framework.
It can be used independently, but is designed to work with the other packages in the framework.
Updates and changes to this package are dictated by the projects we work on and their needs, they may not necessarily be backwards compatible.
Installation
composer require giantpeach/blocks
Usage
The package consists of a couple of classes that can be extended to create custom blocks.
The Block class provides a number of methods to simplify block creation and usage and hides away the complexity (block registration, template loading etc) so your extended class can focus on the block's functionality.
The Blocks class handles the actual registration of all your blocks and the traits they use. Typically, you would extend this class in your theme and add your blocks to it.
Quickstart
Once you've extended the Blocks class it registers a WP CLI command to create new blocks. You can use this to create a new block:
wp giantpeach create-block MyBlock [--prose] [--spacing]
This command will scaffold a new block within your theme, including the block controller class, the block json and the twig template.
Optionally you can specify whether the block should use the Prose or Spacing traits.
Traits
The package includes a number of traits that can be used to add functionality to your blocks. These are:
Prose- adds aproseand creates a few ACF fields for use with the Block to modifyprosestylesSpacing- addsspacingclasses to the block wrapper and creates a few ACF fields for use with the Block to modifyspacingstyles. Thespacingclasses are based on the Tailwind CSS spacing classes, and can be overwritten on theBlockby setting the$blockSpacingarray.
Additional Classes
The package also include a few additional classes that can be helpful to use with your blocks:
Classes- a class to handle the creation of classes for use with your blocks. This class is used to create classes for theproseandspacingtraits, but can also be used to create classes for any other purpose.Style- a class to handle inline styles for use with your blocks. Style tags will automatically be added to the head of the document.
License
This package is open source and is licensed under the MIT License.
