Fields

A field is a partial of the module, in admin/fields/, declaring one key of the front matter to the CMS. Collections, blocks and config files list their fields by name: title, text_markdown, featured_image… An object field, such as hero or address, lists the fields it holds the same way.

Change the fields of an object

admin.fields.<name>.fields replaces the fields an object holds, wherever the object is used. Here the hero keeps a title and a text, and its image only a file and an alternative text:

admin:
  fields:
    hero:
      fields:
        - title
        - text_markdown
        - image:
            fields:
              - image_src
              - image_alt

A field of the list takes its own settings next to its name, as image does here.

The fields of a collection, of a block and of a config file change the same way, see Collections, Blocks and The fields of a config file.

Options of a select field

options replaces the values a select field offers. It works on every select field, not only grid and theme: align, breakpoints, direction, layout, offset, scrollsnap, vertical_align…

admin:
  fields:
    align:
      options: [start, center]

Written next to the field in a fields list, the options apply to that list only:

admin:
  blocks:
    cta:
      fields:
        - title
        - ui:
            - theme: { options: [light, dark] }

The languages and the countries offer the whole ISO lists, which come from the theme. options narrows them down the same way:

admin:
  fields:
    country_code:
      options: [FR, BE, CH, LU]

Markdown editor

The markdown fields below read their editor settings from params, so a project can enlarge the editor, open the raw markdown or change the toolbar without overriding the field.

admin:
  fields:
    text_markdown:
      minimal: false
      modes: "['rich_text', 'raw']"
      buttons: "['bold', 'italic', 'link', 'bulleted-list', 'numbered-list']"

• minimal: true keeps the editor compact: Sveltia CMS caps it at 240 px and scrolls past that, Decap CMS shrinks it to the smallest height. false lets it grow with the content.
• modes: rich_text, raw, or both. With both, the toolbar shows a switch, and the editor opens in the first mode listed.
• buttons: the formatting buttons of the rich text toolbar. See the Sveltia CMS and Decap CMS documentation for the names.
• editor_components: the components the editor can insert. body offers them all by default, the CMS’s own image and code-block plus the enabled shortcodes. Set, a field offers only the ones listed, so name the shortcodes too: "['button']" drops the image and the code block and keeps the button shortcode, "[]" removes them all.

Collapse blocks

The blocks of an entry arrive unfolded. Fold them to their summary, so a long page reads as a list of sections:

admin:
  fields:
    blocks:
      collapsed: true

Default map position

The location field opens on Paris. Move it with a GeoJSON point, longitude first, then latitude:

admin:
  widgets:
    map:
      default: '{"type": "Point", "coordinates": [4.8357, 45.7640]}'

Media folder of a field

An image field uploads to the folder of its collection, or else to the global one, see Setup. Give a field folders and a size limit of its own under the name it is saved as:

admin:
  fields:
    poster:
      media:
        media_folder: /assets/images/posters
        public_folder: /images/posters
        max_file_size: 300000

The name is the key of the front matter: poster for the poster of a video, image for the SEO image, src for the file of every image object. The folders are not written when the global media_folder or public_folder is set to false.

The fields of a config file

Each file of the config collection ships its own set of fields. admin.files.<name>.fields replaces that set, without touching the files list, so changing the fields of one file no longer means restating every other:

admin:
  files:
    footer:
      fields: [newsletter, cta, blocks]
    seo:
      fields: [title, description, image_seo]

Available on every file of the module but schema and blocks, and on a file of your own. Left undefined, each keeps the fields the module declares:

A title built from other fields

New in v2 Only available with Sveltia CMS

title_page reads a compute template and hands it to the compute widget. Left undefined, it stays the regular text input, which is also what a project running any other CMS gets.

The persons collection does this by default: a person is named after their first and last name, so the page title is derived rather than asked for, and never typed twice.

admin:
  collections:
    persons:
      fields:
        - draft
        - title_page: { i18n: duplicate, compute: '{{fields.firstname}} {{fields.lastname}}' }
        - firstname
        - lastname
        - body

New fields

Other additions: blocks on the persons and products collections, firstname and lastname on persons, a file input for form fields, and an optional format on the datetime widget for Decap and Sveltia storage.

Renamed and changed fields

If you relied on the stepped weight select, the previous behaviour is preserved in a separate field:

A country typed in before stays on the page as long as the address has no country_code.

Create a field

Add a file named after the field to the fields directory. It sets the label and the key of the field, and calls the widget of its type:

layouts/
└── _partials/
    └── admin/
        └── fields/
            └── subtitle.yml

{{- $args := dict
  "label" (i18n "admin.fields.subtitle.label")
  "name" "subtitle"
  -}}
{{ partial "admin/widgets/string.js" $args }}

The label comes from the i18n files of the project, admin.fields.subtitle.label. Then list the field by name where it should appear: in the fields of a collection, of a block or of an object.

An object field

An object lists its own fields, and lets the params change them through GetFields. Here the address field of the module:

{{- $pin := cond (or (eq site.Params.admin.cms "decapcms") (eq site.Params.admin.cms "sveltiacms")) "location" "coordinates" -}}
{{- $fields := slice
  "street"
  "zipcode"
  "city"
  "country_code"
  $pin -}}

{{- /* This line lets the params change the fields */ -}}
{{- $fields = partial "admin/func/GetFields.html" (dict "field" . "fields" $fields) -}}

{{- $args := dict
  "label" (i18n "admin.fields.address.label")
  "name" "address"
  "collapsed" true
  "fields" $fields
  -}}

{{ partial "admin/widgets/object.js" $args }}

A file named after a field of the module replaces it.