https://github.com/pixel-open/kirby-customizable-layout

A plugin for Kirby CMS to add a customizable layout fields
https://github.com/pixel-open/kirby-customizable-layout

Last synced: 4 months ago
JSON representation

A plugin for Kirby CMS to add a customizable layout fields

• Host: GitHub
• URL: https://github.com/pixel-open/kirby-customizable-layout
• Owner: Pixel-Open
• Created: 2023-10-04T14:00:26.000Z (over 2 years ago)
• Default Branch: develop
• Last Pushed: 2024-07-01T08:59:23.000Z (almost 2 years ago)
• Last Synced: 2025-04-28T08:08:08.418Z (about 1 year ago)
• Language: PHP
• Homepage:
• Size: 53.7 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: changelogs.md

Awesome Lists containing this project

README

          
# Kirby Customizable Layout plugin

![GitHub release (with filter)](https://img.shields.io/github/v/release/Pixel-Open/kirby-customizable-layout?style=for-the-badge)

[![Dependency](https://img.shields.io/badge/kirby-4.x-cca000.svg?style=for-the-badge)](https://getkirby.com/)

A plugin for [Kirby CMS](http://getkirby.com) to add a customizable layout fields

## Commercial Usage

This plugin is free

## Installation

### Download

[Download the files](https://github.com/Pixel-Open/kirby-customizable-layout/releases) and place them inside `site/plugins/kirby-customizable-layout`.

### Composer

```

composer require pixelopen/kirby-customizable-layout

```

### Git Submodule

You can add the plugin as a Git submodule.

    $ cd your/project/root

    $ git submodule add https://github.com/Pixel-Open/kirby-customizable-layout.git site/plugins/kirby-customizable-layout

    $ git submodule update --init --recursive

    $ git commit -am "Add Kirby Customizable Layout plugin"

Run these commands to update the plugin:

    $ cd your/project/root

    $ git submodule foreach git checkout master

    $ git submodule foreach git pull

    $ git commit -am "Update submodules"

    $ git submodule update --init --recursive

## Options

To add a customizable layout field in your blueprint, you only have to extend `fields/customizable-layout`

For now, you need to add the fieldsets `block-settings` with the following lines in your `/site/config/config.php`:

```php

return [

    'blocks' => [

        'fieldsets' => [

            'custom' => [

                'label' => 'Custom blocks',

                'type' => 'group',

                'fieldsets' => [

                    'block-settings',

                    // Other global custom blocks

                ]

            ],

          'kirby' => [

                'label' => 'Kirby blocks',

                'type' => 'group',

                'fieldsets' => [

                    'heading',

                    'text',

                    'list',

                    'quote',

                    'image',

                    'video',

                    'code',

                    'markdown'

                ]

            ]

        ]

    ]

];

```

You can also add your own fieldsets when you extend the fields, to add the `block-settings` block and all the other block you want to use.

Dont forget to call the snippet in the page where you use the plugin.

```php

 $page->layout()))?>

```

The plugin work with color field from Kirby 4, you must create a new fields with your custom colors at `/site/blueprints/fields/color.yml`:

```yml

type: color

mode: options

options:

  color1: "#color1"

  color2: "#color2"

  color3: "#color3"

  color4: "#color4"

  color5: "#color5"

```