Field relation

Version: Pro.

Why this type

Pick a record in a search window instead of typing an id. Search uses searchAction, for miniShop3 and for your own connectors. The data stores id and pagetitle, not the whole resource.

When to use

• Link to About page or MS3 product
• One related resource in section
• Internal link with readable title in chunk

Tips

Multiple resources use multirelation. XPDO class id without modal is combo.

Similar types

• multirelation for resource lists
• resourcelist alias of same picker UX

Schema

{
  "name": "product",
  "type": "relation",
  "label": "Product",
  "searchAction": "mgr/ms3/products/search",
  "tab": "Content",
  "width": 100,
  "active": true
}

Value

Object { id, pagetitle, … }.

Section data

Key product in the section data (picker stores only the selection):

{
  "product": {
    "id": 42,
    "pagetitle": "About us"
  }
}

• Manager search may show uri and context_key, but data stores id and pagetitle.

Chunk example

modx

<span class="related">[[+product.pagetitle]]</span>

fenom

{if $product.id}
  <span class="related">{$product.pagetitle|pb_text}</span>
{/if}

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

• Also: searchAction for a custom connector (e.g. ms3).

See fields overview.

See also

• Field types reference
• Fields overview
• Pro in manager