Page Blueprints extend from the default page, and give you the ability to add options. Basically, custom pages can come to life by using page blueprints. With a page blueprint, you can 100% configure the editing form for a page as it appears in the Admin.
If you want to use the default page form, and just add a couple of select boxes for example, you can extend from the default page.
This will use the default page form, and append a text field to the Advanced tab, under the Overrides section:
title: Gallery
extends@:
type: default
context: blueprints://pages
form:
fields:
tabs:
type: tabs
active: 1
fields:
advanced:
fields:
overrides:
fields:
header.an_example_text_field:
type: text
label: Add a number
default: 5
validate:
required: true
type: int
This will instead add a new tab, called Gallery, with some fields in it.
title: Gallery
'@extends':
type: default
context: blueprints://pages
form:
fields:
tabs:
type: tabs
active: 1
fields:
gallery:
type: tab
title: Gallery
fields:
header.an_example_text_field:
type: text
label: Add a number
default: 5
validate:
required: true
type: int
header.an_example_select_box:
type: select
label: Select one of the following
default: one
options:
one: One
two: Two
three: Three
The fields types you can add are listed in Available form fields for use in the admin
It's important that fields use the header.*
structure, so field content is saved to the Page Header when saved.
You can avoid extending from the default form, and create a page form that is completely unique.
For example:
title: Gallery
form:
fields:
tabs:
type: tabs
active: 1
fields:
gallery:
type: tab
title: Gallery
fields:
header.an_example_text_field:
type: text
label: Add a number
default: 5
validate:
required: true
type: int
header.an_example_select_box:
type: select
label: Select one of the following
default: one
options:
one: One
two: Two
three: Three
route:
type: parents
label: PLUGIN_ADMIN.PARENT
classes: fancy
WARNING: route
field has changed in Grav 1.7. Please update your existing blueprints to use the new type: parents
.
When editing pages in Expert mode, the Blueprint is not read, and the page form is the same across all pages. This is because in Expert mode you edit the page fields directly in the Frontmatter field, and there is no need to have a customized presentation.
In order for the Admin Plugin to pick up the blueprints, and thus show the new Page types, you need to put the blueprints in the correct place.
Put them in user/blueprints/pages/
. This is a good place to put them when you simply want your blueprints to be present in your site.
Put them in user/themes/YOURTHEME/blueprints/
. This is best when you also intend to distribute your theme: the theme will provide the page blueprints and it will be easier to use.
If you are using a Gantry5 based theme, the best location is user/data/gantry5/themes/YOURTHEME/blueprints/
, otherwise your files may be lost during a theme update.
Put them in user/plugins/YOURPLUGIN/blueprints/
. This is the place where to put them if you define and add custom pages in the plugin.
Then subscribe to the onGetPageBlueprints
event and add them to Grav. The following example adds the blueprints from the blueprints/
folder.
public static function getSubscribedEvents()
{
return [
'onGetPageBlueprints' => ['onGetPageBlueprints', 0]
];
}
public function onGetPageBlueprints($event)
{
$types = $event->types;
$types->scanBlueprints('plugins://' . $this->name . '/blueprints');
}
Found errors? Think you can improve this documentation? Simply click the Edit link at the top of the page, and then the icon on Github to make your changes.
Powered by Grav + with by Trilby Media.