Skip to content

Latest commit

 

History

History
108 lines (79 loc) · 2.42 KB

README.md

File metadata and controls

108 lines (79 loc) · 2.42 KB
Raw

Kirby - Panel Group

This is a custom field which can be added to the Kirby CMS to allow grouping of Panel fields. It is a pure astetic customization and has no impact on your actual website. Built for Kirby 2.

Preview

Screenshot

Installation

Manually

To install manually, simply copy the contents of this repository into a site/fields/panelgroup folder inside your Kirby website.

Using The Kirby CLI

You can instal the Panel Group field using the Kirby CLI. Once you have the Kirby CLI installed, simply do:

$ cd your/project/root
$ kirby plugin:install louiswalch/kirby-panel-group

As a Git Submodule

If you are an advanced user and know your way around Git and you already use Git to manage you project, you can make updating this field extension to newer releases a breeze by adding it as a Git submodule.

$ cd your/project/root
$ git submodule add [email protected]:louiswalch/kirby-panel-group.git site/fields/panelgroup

Updating all your Git submodules (eg. the Kirby core modules and any extensions added as submodules) to their latest version, all you need to do is to run these two Git commands.

$ cd your/project/root
$ git submodule foreach --recursive git checkout master
$ git submodule foreach --recursive git pull

Basic Blueprint

You must "start" and "end" your group to tell the Panel which fields are inside the group.

fields:

  title:
    label: Title
    type:  text

  group_start:
    label: My Group
    type: panelgroup
    position: start
  some_title:
    label: Title
    type:  text
  some_text:
    label: Text
    type:  textarea
  group_end:
    type: panelgroup
    position: end

Advanced Blueprint

You can also configure each panel to collapse/expand as accordions. For large pages this cleans up the Kirby Panel interface quite a bit.

fields:

  title:
    label: Title
    type:  text

  group_start:
    label: My Accordion Group
    type: panelgroup
    position: start
    accordion: true
  some_title:
    label: Title
    type:  text
  some_text:
    label: Text
    type:  textarea
  group_end:
    type: panelgroup
    position: end

  group_2_start:
    label: Another Accordion Group
    type: panelgroup
    position: start
    accordion: true
  another_title:
    label: Another Title
    type:  text
  group_2_end:
    type: panelgroup
    position: end