Fields

Import the builders from @micacms/core. Each builder gives plain data, so the editor can read the model from .mica/schema.json. An item without a version exists since 0.2.0.

Options of every field

The build stops on an option that is not in these tables, for example a typo. A field with an option from a newer @micacms/astro is read-only in an older Mica until you upgrade it.

The builders

Defaults and empty values

A default fills the field of a new entry, and of a singleton that has no file yet. It never fills a value that is missing in a stored entry: such a value is empty, null, false or [], and your templates must handle it. So a changed default does not change the stored entries, and a cleared field stays cleared.

Values that the model does not have

A save keeps a key in index.json and a .mdoc file that the model does not declare, for example content for a field that a newer model adds. Your templates do not get them, and npx mica check warns about them. To delete them, see Change the model. A key in a list row without _key is not kept, because such a row has no identity when the order changes.

The slug of a collection

The first slug() among the fields of a collection is the entry's slug. It is also the name of the entry's folder, so it is never empty. A second slug() among the same fields stops the build. A slug() in an object or in a singleton is an ordinary value, for example one URL for each language.

Where an entry is stored

Each entry is a folder <slug>/ with index.json, the .mdoc files and the entry's media, and each singleton is a folder <name>/ with the same files. See Content model.

Each rich-text field has its own .mdoc file, named by the field's path: body.mdoc, seo.intro.mdoc. In a repeater(), each row with rich text has a key, _key, in index.json, and the file names the row by its key: sections.k3f9a2.body.mdoc. Then a new order of the rows changes only index.json. Mica writes the key; do not change it. Your templates do not get it.

Collections and singletons

import { collection, defineSite, singleton, slug, text } from "@micacms/core";

export const site = defineSite({
  root: "./content",
  collections: {
    news: collection({ label: "News", fields: { title: text({ required: true }), slug: slug({ from: "title" }) } }),
  },
  singletons: {
    settings: singleton({ label: "Website", fields: { tagline: text() } }),
  },
});

singleton() takes label, description and fields. defineSite() takes root, collections and singletons.