Skip to content
Strife Docs

Reference Field Reference

fields.paragraph()

Multi-line plain-text input. Same editor component as html, but stores plain text instead of HTML.

Multi-line plain-text field ("Paragraph" in the Studio field reference). Maps to editor { name: 'str-textarea', type: 'text' } — the same component as fields.html() but with type: 'text', so the stored value is a plain string rather than HTML.

Example

TypeScript
fields.paragraph({
  label: 'Summary',
  localizable: true,
  placeholder: 'One or two sentences…',
})

Options

OptionTypeRequiredDescription
label
string
Yes
Label shown to editors in Strife Studio.
description
string
No
Tooltip shown to editors.
localizable
boolean
No
When true, output is Record<string, string> instead of string.
searchable
boolean
No
Include in the team's search index.
filterable
boolean
No
Allow filtering content lists by this value.
protected
boolean
No
Restrict editing to users with the appropriate permission.
propertyName
string
No
Override the stored property name.
placeholder
string | null
No
Hint text shown in the empty textarea.
spellcheck
boolean
No
Enable/disable browser spellcheck.

Output type

string, or Record<string, string> when localizable: true.

See also

  • Paragraph — the same editor, documented from the Strife Studio UI side.