
PageBuilder

You build a page from sections on the Sections tab in MODX. Autosave writes the draft. Save on the MODX resource validates fields and publishes sections to the site. The standard resource Content field is not used for sections. On the storefront, the PageBuilder snippet renders the blocks.
The sidebar covers installation, the editor, frontend output, Pro, the developer section, and separate lists of field types and sections. Start here: Quick start.
Features
Resource editor
On the Sections tab: table or compact editorial list (default from pagebuilder_resource_view_mode, toggle in the toolbar). Add from the catalog, drag to reorder, Alt+↑/↓, duplicate, copy sections from another page. In the editorial list you enable and disable sections on each row. Deleted sections go to the page trash. Edit content in the Properties modal inspector. While the inspector is open for a newly added section, autosave pauses: Cancel rolls the draft back to the state before the add. Visibility rules (context, UTM) open via Visibility when the system setting is enabled. Draft preview in a drawer via a signed link. Undo/redo in the current session. Before publish (Save resource) the editor validates required fields.
Draft and publish
Autosave writes the draft only. Save on the MODX resource: validate → draft → publish to published_json. Unpublish clears the published version; the draft remains. On save the server compares revision numbers to avoid overwriting concurrent edits.
Free: sections and fields
11 built-in types: hero, richtext, gallery, faq, cta, cards, contact, stats, testimonials, image, spacer. In the control panel (Blocks) filter types with All / From package / Mine chips, bulk-hide presets, and set custom catalog previews instead of schematic images. 31 field types in Free and 20 in Pro (51 total): text, richtext, repeater, migx, file, select, and more. With pagebuilder_responsive_editor_enabled, the inspector shows per-device value tabs.
PageBuilder Pro
Global library (Shared blocks): pull from another page (Link | Copy), write-through for linked sections, page templates, section event journal (View/Restore). Examples tab in the catalog (Examples toggle / pagebuilder_catalog_examples_enabled). Agent API for scripts and agents. Basket in the control panel restores deleted sections and table rows across resources. Pro catalog: features, video, team, tabs, maps, forms, quiz, miniShop3 commerce blocks. 20 more field types: gallery, map, relation, table, embeddedTable, and more.
Resource tables
The Tables tab stores large row sets in the database: filters, CSV/JSON import, bulk delete. On the storefront, PageBuilderTableRows outputs rows. The data_table section (Pro) embeds a small table in section JSON.
UTM and contexts
Set the UTM registry in the control panel. Visibility rules (context, UTM, Pro conditions) open via Visibility in the inspector when pagebuilder_inspector_visibility_enabled is on. Snippets PageBuilderUtmSession and PageBuilderUtmUrl help on landing pages. Fields support the {{utm:key}} placeholder.
Collections and control panel
With collections_enabled, resource tabs (sections, tables, iframe, and more) are configured in the control panel. Components → PageBuilder lists resources with sections and section types.
Snippets, Public API, and events
PageBuilder outputs section HTML, PageBuilderResource returns sections from another resource, PageBuilderSitemap builds an XML sitemap. Public API serves published sections as JSON for headless frontends (api.php). pbOn* events let plugins hook save, publish, render, and section type registration. See workflow, cmp, pro.
System requirements
| Requirement | Value |
|---|---|
| MODX Revolution | 3.0.3+ |
| PHP | 8.2+ |
| VueTools | 1.1.2+ (manager editor) |
| pdoTools | 3.0+ (Fenom in section chunks) |
| miniShop3 | optional, for Pro catalog sections |
Packages
| Extra | Version | Contents |
|---|---|---|
pagebuilder | 1.0.10-beta | Free: core, sections, control panel, snippets, MIGX, responsive, Save = publish, type filter and custom previews |
pagebuilderpro | 1.0.10-beta | Pro: requires pagebuilder ≥ 1.0.10, quiz, library pull, page templates, section journal |
MODX namespace: pagebuilder.
Quick links
| Need | Document |
|---|---|
| Feature overview | Key features |
| Install and build the first page | Quick start |
All pagebuilder_* keys | System settings |
| Draft, publish, basket | Workflow |
| Blocks, UTM, Collections, Pro basket | Control panel |
Permissions, pbOn* events, data model | Manager and events |
| Template, preview, snippet cache | Frontend output |
| CSS tokens and section BEM | Design system |
| JSON for headless | Public API |
| Snippets and parameters | Snippets |
| Pro, basket, examples | PageBuilder Pro |
| Scripts and agents | Agent API |
| Custom sections and extensions | Developer |
| 51 inspector field types | Field type reference |
| 35 built-in blocks | Section catalog |
| Common issues | FAQ |
Entry points
| URL / path | Purpose |
|---|---|
Component pagebuilder → index | Resource catalog with sections, section types (Pro) |
assets/components/pagebuilder/connector.php | MGR API (VueTools) |
assets/components/pagebuilder/preview.php | Draft preview in iframe |
assets/components/pagebuilder/api.php | Public API: published sections JSON (headless) |
Snippet [[!PageBuilder]] | Published section HTML on the site |
Permissions
| Permission | Purpose |
|---|---|
pagebuilder_view | Sections tab, catalog, preview token |
pagebuilder_save | Draft save and publish (fallback: save_document) |
pagebuilder_manage_types | Control panel section types (no fallback to view) |
Access to a specific resource is also checked by the MODX policy (view, save).
