hksagentur/kirby-schema

Frequently used data structures for the Kirby panel

Maintainers

Details

github.com/hksagentur/kirby-schema

Source

Issues

Installs: 3

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 1

Forks: 0

Open Issues: 0

Type:kirby-plugin

1.4.1 2025-06-06 13:07 UTC

Requires

Requires (Dev)

Suggests

ISC 9709102a03dc70e58d66cfc200570cb05ad75b5d

This package is auto-updated.

Last update: 2025-06-06 14:03:31 UTC

README

Frequently used data structures for Kirby CMS.

Requirements

Kirby CMS (>=4.0)
PHP (>= 8.3)

Installation

Composer

composer require hksagentur/kirby-schema

Download

Download the project archive and copy the files to the plugin directory of your kirby installation. By default this directory is located at /site/plugins.

Usage

All blueprints provided by the plugin are registered within a custom namespace (@hksagentur/schema). You have to reference or extend these blueprints to take advantage of the provided data structures.

A simple exampe would be to use the navigation blueprint for the site:

# site/blueprints/site.yml
tabs:
  content:
    label: Content
    fields: []
  settings:
    label: Settings
    fields:
      navigation: @hksagentur/schema/fields/navigation

Instead of referencing the provided blueprints directly you can use them as a base and start customizing:

# site/blueprints/site.yml
tabs:
  content:
    label: Content
    fields: []
  settings:
    label: Settings
    fields:
      navigation:
        extends: @hksagentur/schema/fields/navigation
        fields:
          classNames:
            type: text
            label: HTML Classes
          target: false
          rel: false

This applies to all blueprints regardless of their type.

License

ISC License. Please see License File for more information.