dxw/govpress-blocks

Reusable custom blocks for WordPress

dev-main 2022-08-08 12:25 UTC

README

A library of reusable blocks for use in GovPress projects.

How to use

  1. Install the package in your theme:
    composer require dxw/govpress-blocks
    
  2. Use the factory to create the blocks you want to use, and pass them any configuration, e.g. To create a card block with default config:
    \Dxw\GovPressBlocks\Factory::create('card');
    
    To create a card block that renders a custom template:
    \Dxw\GovPressBlocks\Factory::create('card', [
      'template' => '\the\full\path\to\your\custom\template.php`
    ]);
    
    For dxw projects, the recommended approach is to add this code to your theme's app/di.php, if the theme uses Iguana.
  3. If you want to use the default styles for a block, import them into your main SASS file like so (where the final name in the path is the block type):
    @import 'vendor/dxw/govpress-blocks/assets/scss/blocks/card'
    

The available blocks are documented below.

Blocks

Card

\Dxw\GovPressBLocks\Factory::create('card', array $config)

Config options:

[
    'template' => string $theFullPathToYourCustomCardTemplate
]

Sass:

@import 'vendor/dxw/govpress-blocks/assets/scss/blocks/card'