Field snippet

Version: Free.

Why this type

The editor picks a snippet name. The site calls it dynamically, for example [[!{$snippet.name}]]. A chunk is included with chunk, not with this field.

When to use

• Section delegates render to snippet
• Editor picks from allowed snippets list
• Wrapper around legacy MODX snippet

Tips

Partial template include is chunk. Snippet params are separate fields or static in chunk.

Similar types

• chunk for Fenom include
• combo optionsSource modSnippet

Schema

{
  "name": "snippet",
  "type": "snippet",
  "label": "Snippet",
  "tab": "Content",
  "width": 100,
  "active": true
}

Value

Object { name }.

Section data

Key snippet in the section data:

{
  "snippet": {
    "name": "pbHero"
  }
}

Chunk example

modx

[[!snippetName]]

fenom

{('!' ~ $snippet.name) | snippet}

Common properties

For fields with name that are stored in the section data:

Key	Type	Role	CMP
tab	string	Group subtitle in the inspector	yes
width	25–100	Field width as % of the row (flex)	yes
description	string	Hint under the label	yes
default	any	Initial value for a new section	yes
active	bool	false hides the field in the inspector	yes
required	bool	Required on publish (draft still saves)	yes

See fields overview.

See also

• Field types reference
• Fields overview
• Pro in manager