jongacnik / kirby-fields-block

Kirby block preview plugin to directly render block fields
MIT License
109 stars 5 forks source link

Kirby Fields Block

Kirby block preview plugin to directly render block fields, allowing for inline editing.

Usage

Block definition

When creating a custom block in your blueprints, pass preview: fields to utilize this plugin

blockname:
  name: Block Name
  preview: fields # required
  wysiwyg: true # recommended
  fields:
    text:
      label: Text
      type: text

Setting wysiwyg: true prevents drawer from automatically opening when creating a new block.

Disable block title

You can disable the block title bar by passing label: false

blockname:
  name: Block Name
  preview: fields
  wysiwyg: true 
  label: false # disables block title bar
  fields:
    text:
      label: Text
      type: text
Example

Collapse/Expand block

You can collapse or expand the block preview by clicking on the arrow icon or double clicking the block title bar.

Notes

Installation

composer require jg/kirby-fields-block
Other installation methods ### Download Download and copy this repository to `/site/plugins/kirby-fields-block`. ### Git submodule ``` git submodule add https://github.com/jongacnik/kirby-fields-block.git site/plugins/kirby-fields-block ```