Field gallery

Version: Pro.

Why this type

Several photos in one field. Each photo has its own alt text and caption. After save, the file gets a URL, width, and height, the same as image. The type is in PageBuilder Pro.

When to use

• Several photos in one section, without a separate carousel
• Product screenshots
• Photos for a portfolio grid

Tips

One photo is easier with image. In the chunk, loop the array and use the photo URL: {$slide.url}.

Similar types

• image for one file
• repeater with an image field when you need your own row schema. Available in Free

Schema

{
  "name": "shots",
  "type": "gallery",
  "label": "Gallery",
  "groups": true,
  "tab": "Content",
  "width": 100,
  "active": true
}

Value

Array of media objects (images, video, PDF, and more).

Section data

Key shots in the section data: array of media objects after enrich:

{
  "shots": [
    {
      "url": "assets/images/hero.jpg",
      "id": 12,
      "path": "assets/images/",
      "filename": "hero.jpg",
      "extension": "jpg",
      "name": "hero",
      "title": "hero.jpg",
      "width": 1920,
      "height": 1080,
      "size": 245760,
      "type": "image",
      "description": "Frame caption",
      "preview": "assets/images/hero.jpg",
      "groups": [
        "main",
        "slider"
      ]
    },
    {
      "url": "assets/files/catalog.pdf",
      "id": 34,
      "path": "assets/files/",
      "filename": "catalog.pdf",
      "extension": "pdf",
      "name": "catalog",
      "title": "catalog.pdf",
      "size": 1048576,
      "type": "pdf",
      "groups": "docs"
    }
  ]
}

• groups: string or array when enabled in the field schema.

Chunk example

modx

{foreach $shots as $image}
[[$pagebuilder_partial_image?
  &image=`{$image}`
  &alt=`{$image.title}`
  &class=`pb-gallery__media`
]]
{/foreach}

fenom

{foreach $shots as $image}
  {include 'pagebuilder_partial_image' image=$image alt=$image.title class='pb-gallery__media'}
{/foreach}

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: groups: true: groups on gallery items.

See fields overview.

See also

• Field types reference
• Fields overview
• Pro in manager