Skip to content
Strife Docs

Reference Field Reference

fields.imageGroup()

Multiple named image slots in one field. Not localizable in v1.

Multi-image group. Maps to editor { name: 'str-image-group', type: 'image-group' }. Output is the canonical ImageGroup from @strifeapp/types — a slot-name-keyed map of Image, one entry per slot defined in medias.

Example

TypeScript
fields.imageGroup({
  label: 'Hero media',
  medias: [
    { name: 'desktop', width: 1920, height: 1080 },
    { name: 'mobile', width: 750, height: 1000 },
  ],
})

Options

OptionTypeRequiredDescription
label
string
Yes
Label shown to editors in Strife Studio.
medias
{ name: string; width: number; height: number }[]
Yes
The named media slots — one entry per asset the group expects.
description
string
No
Tooltip shown to editors.
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.
paddingColor
string | null
No
Background color used when padding to fit target dimensions.
paddingAlpha
number | null
No
Padding background opacity.
hideAlt
boolean
No
Hide the alt-text input in the editor.
Note:

Image groups are not localizable in v1 — slot definitions are global across locales, and there's no localizable option. If you need per-locale image variants, repeat the group on a localizable parent, or use multiple fields.image() fields instead.

Output type

ImageGroup (slot name → Image).

See also

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