Skip to content
Strife Docs

Reference Fields

Hint

The Hint field displays a collapsible help block inside the editor to guide content authors. It is a UI-only element, it does not store data in the database and does not require a propertyName.

Settings

Unlike other fields, the Hint field does not store a value and therefore does not use a propertyName. The settings below configure what the hint displays and where it appears in the editor.

OptionDescription
Icon
The icon displayed next to the label. Pick any icon name from the Icons reference.
Label
The header text shown next to the icon.
Collapsed text
A short summary shown when the hint is collapsed. Limited to two lines in the UI.
Expanded text
The full body of the hint shown when expanded.
Tab group
Scopes the hint to one or more tabs in the template. If left empty, the hint appears at the top level.

Define with JSON

When defining templates using JSON, this field is represented using:

  • Component Name: str-hint
  • Type: hint
  • Reference ID: str-hint|hint
JSON
{
  ...
  "editor": {
    "name": "str-hint",
    "type": "hint",
    "attributes": {
      "icon": "info",                //Icon name — see Icons reference
      "label": "Content Hint",
      "collapsedText": "A short summary shown when collapsed.",
      "expandedText": "The full body of the hint, shown when the user expands the block.",
      "tabGroup": ["tabGroup-content"]  //Array of "<tabGroupPropertyName>-<tabValue>" strings
    }
  },
  ...
}
Note:

Because the Hint field does not store data, omit propertyName, label, description, and all other base settings that apply to data-storing fields.

Live preview

The Hint field is UI-only and contributes nothing to document data. It has no live preview output.