Statamic Blueprint
A Statamic Blueprint
| Type | object |
|---|---|
| File match |
**/resources/blueprints/**/*.yml
**/resources/blueprints/**/*.yaml
|
| Schema URL | https://catalog.lintel.tools/schemas/schemastore/statamic-blueprint/latest.json |
| Source | https://raw.githubusercontent.com/Konafets/statamic-blueprint-validation/main/statamic.blueprint.schema.json |
Validate with Lintel
npx @lintel/lintel checkProperties
At its most basic, a blueprint has tabs. A tab has a handle, a display name, and an array of sections. Since Statamic 4
At its most basic, a blueprint has sections. A section has a handle, a display name, and an array of fields. Until Statamic 3
One of
Definitions
Here you define the fields of this section.
This fieldtype is used to manage key: value array data in the right situation.
The label shown above the field.
The icon
Shown under the field's display label, like this very text. Markdown is supported.
Where the instructions should be positioned relative to the field. Options: Above or Below.
Controls whether the field should be shown in control panel listings.
Control whether or not this field is required.
The validation rules for that field
The assets fieldtype is used to manage and relate files with your entries.
Bard is our recommended fieldtype for creating long form content from the control panel.
Enable to always show the "Add Set" button.
Sets are configurable blocks of fields that can be inserted anywhere in your Bard content.
Choose which buttons to show in the toolbar.
Choose which asset container to use for this field.
Save HTML instead of structured data. This simplifies but limits control of your template markup.
Choose which style of toolbar you prefer.
Set rel="noopener" on all links.
Set rel="noreferrer" on all links.
Set target="_blank" on all links.
Entries from these collections will be available in the link selector. Leaving this empty will make all entries available.
Show estimated reading time at the bottom of the field.
Enable to toggle into fullscreen mode.
Allow Source Mode
Enable Input Rules
Enables Markdown-style shortcuts when typing content.
The label shown above the field.
Shown under the field's display label, like this very text. Markdown is supported.
Where the instructions should be positioned relative to the field. Options: Above or Below.
Controls whether the field should be shown in control panel listings.
Control whether or not this field is required.
The validation rules for that field
The button group fieldtype is a multiple choice input where you only get one choice.
Set the array keys and their optional labels.
Set the default value.
The checkboxes fieldtype is a multiple choice input.
If your content involves code snippets, this is the fieldtype for you.
Choose your preferred theme.
Choose language for syntax highlighting.
Set your preferred type of indentation.
Set your preferred indentation size (in spaces).
Choose preferred set of keyboard shortcuts.
Show Line Numbers
Enable Line Wrapping
This fieldtype is used to view and select from a list of Collections.
This fieldtype is a highly configurable color picker with simple and advanced UI modes, support for alpha channel, rgba, hsla, hsva, and more.
Pre-define colors that can be selected from a list. Supports all color mode formats.
Choose between a classic and a simpler nano (mini) theme. Default: classic.
Disables the alpha slider, preventing adjustments to opacity.
Set which color mode you wish to be the default. Default: hex.
Choose which color modes you want to enable in the UI. Available choices: hex, rgba, hsla, hsva, and cmyk. Default: hex.
Work with dates, times, and ranges with a variety of user interface options that make you really enjoy basically just picking numbers from a table.
Show multiple months at one time, in columns and rows. Default: 1.
Set the earliest selectable date in YYYY-MM-DD format.
How the date should be stored, using the PHP date format. Default: 'Y-m-d' or 'Y-m-d H:m'
Enable to stretch the calendar out like Stretch Armstrong, using the maximum amount of available horizontal space. Default: false
Always show the calendar instead of the text input and dropdown UI. Default: false.
Choose between single or range. Range mode disables the time picker. Default: single.
Show multiple months at one time, in columns and rows. Default: 1.
Enable/disable the timepicker. Default: false.
Makes the time field visible and non-dismissible. Default: false.
The Form fieldtype is gives your users a way to pick a form to include along with the current entry.
The group fieldtype is a simple container that holds additional fields you would like grouped visually as well as under a parent key.
A list of fields within the group.
The grid fieldtype is a meta fieldtype, a fieldtype that serves as a container for more fieldtypes.
A list of fields, each of which create their own column.
The Grid is displayed as a table by default. If you have a large number of columns it can get pretty crowded. Choose stacked mode to group rows similar to Replicator. When Sneak Peek is enabled, Grids automatically toggle into stacked mode.
The minimum number of required rows.
The maximum number of rows allowed. Once reached the Add Row button will disappear.
The Add Row button's label.
The minimum number of required rows.
If you've ever wanted to add a little HTML to your blueprint, this is the way to do it.
Store whatever HTML you want — it's up to you.
Importing Fieldsets. They serve to create reusable sets of fields, just like v2.
The integer fieldtype is a text-style input that only accepts integers (numbers) and has increment and decrement controls.
For when you want to create a link to a URL or entry, this fieldtype is here for you.
For when you want to manage a simple YAML list, this fieldtype is here for you.
Write Markdown with the help of formatting buttons, assets integration, fullscreen mode, a Markdown cheatsheet, and HTML preview mode.
Set the name of an asset container to enable browsing, uploading, and inserting assets.
If true, navigation within the asset browser will be disabled. Your users will be restricted to specified the container and folder. Default: false.
Automatically convert line breaks to
tags. Default: true.
Automatically links any URLs in the text. Default: false.
Escapes inline HTML markup. For example,
Automatically convert straight quotes into curly quotes, dashes into en/em-dashes, and other similar text transformations. Default: false.
Enable Antlers parsing in this field's content.
Set the default value.
The radio fieldtype is a multiple choice input where you only get one choice.
Sets of key/value pairs define the values and labels of the radio options.
Show the radio buttons next to each other in a row instead of stacked vertically. Default: false
Range fields let the user choose a numeric value which must be no less than a given value, and no more than another.
The minimum size between values.
The minimum, left-most value.
The maximum, right-most value.
Set the default value.
The Replicator is a meta fieldtype giving you the ability to define sets of fields that you can dynamically piece together in whatever order and arrangement you imagine.
The revealer is a simple button that reveals conditional fields without saving any additional data.
Give your users a list of options to choose from.
A set of key/value pairs that define the values and labels. If you don't define the keys, the value and label will be the same.
Allow deselecting any chosen option and making null a possible value. Default: false.
Set the default option key. Default: none.
Allow multiple selections. Default: false.
Enable search with suggestions by typing in the select box. Default: true.
Use a "tag" style UI when selecting multiples. Default: false.
Add newly created options to the list. Default: false.
This fieldtype gives you a way to create flexible tabular data.
Users can enter “taggable” values, which are formatted automatically into a YAML list format.
This is generally used as a "system" field to control an entry's template.
The original time field from the set of Kiefer Sutherland's hit drama "24".
A nice little toggle switch generally used to manage settings-type variables.
The User Group fieldtype gives your users a way to pick one or more User Groups to attach to the current entry.
The User Role fieldtype gives your users a way to pick one or more User Groups to attach to the current entry.
The most common use for the Users fieldtype is to set the "author" for entries, but it's not the only use.
This field is a code fieldtype that gets saved as YAML instead of a string.
The label shown above the field.
The icon
Shown under the field's display label, like this very text. Markdown is supported.
Where the instructions should be positioned relative to the field. Options: Above or Below.
Controls whether the field should be shown in control panel listings.
Control whether or not this field is required.
The validation rules for that field
Enable Antlers parsing in this field's content.