Field Reference

This section documents every fields.* builder exported by @strifeapp/schema — the code-first counterpart to Fields, which documents the same editors from Strife Studio's UI. Use this section when you're writing a Schema and want the complete option set for a specific builder; use the Studio Fields reference when you're looking at a template built by hand in Strife Studio and want to know what an editor does.

Each page follows the same shape: a minimal example, the full options table (sourced directly from the builder's TypeScript signature), the inferred output type, and any notes worth knowing — including a few places where the code-first builder's options don't (yet) cover everything the underlying Strife Studio editor supports.

Common options

Every builder takes label (required) and, unless noted on its own page, most also accept:

A few builders are exceptions to this common set — hint and tabs are structural/UI-only and skip most of it, and serp skips searchable/filterable. Each page's own table is the source of truth; don't assume every option on this page applies everywhere.

localizable is available on exactly these ten builders: text, paragraph, number, date, slug, html, image, link, serp, and chapters. Every other builder either doesn't expose it (a boolean or a selected option isn't the kind of value that varies by locale) or is structural (hint, tabs).

Turning localizable on for a field with content

You can turn localizable on for a field that already holds content, with strife push or in Strife Studio's template designer. The content is kept. Changing the flag rewrites no documents: it creates no drafts, no unpublished changes and no versions.

A value stored before the flag was turned on is a shared value. It is the value of every locale of the document, on your site and in Studio, until someone gives one locale its own value:

• Editing one locale splits the value. That locale gets the new value, and every other locale the document has keeps a copy of the old one. This holds for every way of editing: Studio, the MCP server and the API.
• Publishing some locales publishes their new values. The other locales keep the old shared value on the site.
• Discarding a locale whose published value is still shared gives that locale the shared value back.
• AI translation (creating a language version, or translating changed fields) uses a shared text value as the source text. Only the target locale gets the translation. The other locales keep the shared value.

Which stored values already have a value per locale

For a localizable field, Strife reads the stored value like this:

"Anything else" includes strings, numbers, arrays, chapters, a reference such as { "id": "pages/1" }, and an object with a key that isn't a locale code, such as { "id": "…", "alt": "…" }. It also includes an object whose keys look like locale codes when none of them is configured. An image group with media named og, or sm, md and lg, is a shared value and shows on every locale. So is a leftover { "de": "Hallo" } after de was removed from the team. An object such as { "sv": "Hej", "de": "Hallo" } still has one value per locale after de is removed, because sv is configured.

Update the content index first

Your site reads shared values correctly only from a content index built from @strifeapp/strife 1.24.0 or later. Upgrade the package and run strife push, which redeploys Content/ByUrl. An older index shows a shared text or number on the team's default locale only, and a shared object, array or chapters list on no locale at all. Studio shows the shared value on every locale either way.

Until every content index on the team is updated, Studio warns when a field is turned localizable: it shows "Template saved with a warning" after the save, and the warning names the fields and the content indexes that need updating. The change is saved either way.

Turning localizable off

Turning localizable off deletes nothing either. A field that still holds a value per locale reads as the default locale's value, or as the first stored value when the default locale has none. The per-locale values stay stored, so turning the flag back on before anyone edits the field brings them back.

All builders