PHPackages                             hksagentur/kirby-schema - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Utility & Helpers](/categories/utility)
4. /
5. hksagentur/kirby-schema

ActiveKirby-plugin[Utility & Helpers](/categories/utility)

hksagentur/kirby-schema
=======================

Frequently used data structures for the Kirby panel

1.40.3(1mo ago)0813↑330.8%ISCPHPPHP >=8.2.0CI passing

Since Mar 5Pushed 2d ago1 watchersCompare

[ Source](https://github.com/hksagentur/kirby-schema)[ Packagist](https://packagist.org/packages/hksagentur/kirby-schema)[ RSS](/packages/hksagentur-kirby-schema/feed)WikiDiscussions main Synced 3w ago

READMEChangelog (10)Dependencies (6)Versions (75)Used By (0)

Kirby Schema
============

[](#kirby-schema)

Frequently used data structures for [Kirby CMS](https://getkirby.com).

Requirements
------------

[](#requirements)

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

Installation
------------

[](#installation)

### Composer

[](#composer)

```
composer require hksagentur/kirby-schema
```

### Download

[](#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
-----

[](#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.

If you only want to use a blueprint without extending it, you can let the plugin generate aliases for you:

```