PageBuilder
Visual section builder for MODX 3: draft and publish without overwriting resource content
- MODX 3
- PHP 8.2
- Vue 3
PageBuilder Pro
The pagebuilderpro package extends the free editor and pulls pagebuilder core. Current line: 1.0.17-beta, requires pagebuilder ≥ 1.0.17.
Install Free and Pro from this line together: ProFeatureProvider implements serverContributions() and cmpContributions(). An older Pro without those methods fatals on load.
Pro flags
ProFeatureProvider registers feature flags. The Vue editor reads the list from PageBuilderConfig.capabilities.
| Flag | Purpose |
|---|---|
pro | The pagebuilderpro package is installed |
library | Shared blocks: save/link/insert/edit master, pull from another page, write-through (pb_library_items) |
versions | Section event journal (create/update/copy/remove/enable/disable) + View / Restore |
page-templates | Page templates: ordered empty sections (pb_page_templates, mgr/pagetemplate/*) |
responsive | Separate field values for desktop, tablet, and mobile (text, textarea, url, number, currency, richtext, slug). Names alt, caption, and slug do not get the tabs |
conditions | settings.conditions and evaluator (loggedIn, guest, context, GET, …) |
presets | Examples tab in catalog (hidden when pagebuilder_catalog_examples_enabled = 0) |
i18n-copy | Copy section between contexts |
advanced-fields | 23 field types in the control panel (Pro group in the list). Pro types in total are 27: datasource, form, product, and products are added. Without Pro, 35 Free types are available |
basket | Global basket in control panel (mgr/basket/*) |
utm | New UTM rules and the registry. Already published rules still run in Free |
collections | Resource tabs from the control panel (pb_collections, mgr/collection/*). Also needs pagebuilder_collections_enabled |
datasources | Dynamic list and Filterable grid: providers modx-resources, pagebuilder-tables, minishop3, mgr/datasource/* |
minishop3 | Fields product and products, and storefront sections. The flag is absent until the miniShop3 package is installed |
forms | CMP Forms, form builder, FetchIt, CSRF, honeypot. Email and webhook after commit. Submissions are not stored |
api | Agent API and REST v1 tokens (mgr/resttoken/*, API tokens tab) |
image-crop | Crop for image and gallery fields (mgr/media/crop) |
On the resource tab, pro-resource.min.js adds the Inherit / Library panel. Section history opens from the row menu.
Pro sections
Definitions live in pagebuilderpro/sections/. Chunk: pagebuilderpro_{key}. New types register via plugin on pbOnRegisterSectionDefinitions.
| Group | Example keys |
|---|---|
| General | features, team, tabs |
| Content and conversion | pricing_table, contact_form, quiz, spec_table, how_it_works, case_study, newsletter, accordion |
| Additional | map, contact_map, logos, blog_posts, timeline, portfolio, downloads, locations |
| Datasources and forms | dynamic_list, filterable_grid, form_builder |
| Commerce | products_grid, categories_row, product_spotlight, promo_banner |
Storefront sections require miniShop3 (requires: ["pro", "minishop3"]). Site catalog: Pro sections.
quiz and contact_form sections need FetchIt on the frontend.
Shared blocks
After Save as shared the section on the current page is immediately linked to the new master (libraryLocalFields: []).
| Action | Behavior |
|---|---|
| Catalog → Shared blocks → Insert | Insert linked or copy from master |
| Menu → Pull from another page | mgr/library/pull: Link or Copy mode |
| Local fields checklist | settings.libraryLocalFields in inspector |
| Page save / publish | Write-through synced fields to master on server (pbOnBeforeSave) |
Pull reads the source draft. Link creates or reuses master, sets libraryId on source and inserts linked section on target. Copy adds sections without a link.
On render, master merges with local fields from libraryLocalFields. Without the key in settings, local keys override master. After Library write, HTML cache pagebuilder/* is cleared.
Shared blocks catalog tab is visible even when the list is empty.
Section event journal
Capability versions is a journal of events for one section, not snapshots of the whole page. From row menu: View / Restore (mgr/sectionevents/*). Page-level UI mgr/versions/* is not in the current line.
Page templates
Capability page-templates. Named skeleton: ordered list of section types without content (pb_page_templates).
| Where | What it does |
|---|---|
| CMP → Page templates | CRUD: name, MODX template IDs, type order, default |
| Editor → Save as template | Takes only type / typeVersion from current page |
| Empty outline | "Apply …" buttons for matching templates |
Apply writes draft via mgr/pagetemplate/apply (non-empty draft needs force).
Examples
Examples tab in add catalog: ready blocks with text (capability presets, mgr/presets/list). After insert you can edit fields. Hide without deleting JSON: pagebuilder_catalog_examples_enabled or toggle in CMP Blocks.
The package ships 11 presets (pagebuilderpro/sections/presets/):
| Key | Section type |
|---|---|
hero-centered | hero |
cta-banner | cta |
stats-launch | stats |
features-grid | features |
contact-split | contact_map |
blog-featured-first | blog_posts |
blog-compact-list | blog_posts |
pricing-saas | pricing_table |
pricing-utm | data_table |
products-hero | promo_banner |
quiz-kitchen | quiz |
pricing-utm is a data_table, not a pricing grid. products-hero needs miniShop3. quiz-kitchen needs FetchIt and sets the start label to Начать подбор.
Bundle
The tab is hidden (BUNDLE_ENABLED = false). mgr/bundle/* routes are not registered. A manager call returns Invalid action. Do not promise the tab until the flag is turned on in a release.
Export steps and bundle v1 contents: Control panel → Bundle.
Connector actions (Pro)
All requests are POST to assets/components/pagebuilder/connector.php with action=mgr/..., same as the Vue editor.
| Action | Purpose |
|---|---|
mgr/library/list | Library item list |
mgr/library/save | Save or update item |
mgr/library/remove | Delete item |
mgr/library/adjustusage | Library item usage counter |
mgr/library/pull | Pull sections from another page (link | copy) |
mgr/sectionevents/list | Section event journal |
mgr/sectionevents/get | One journal entry / section snapshot |
mgr/sectionevents/record | Add journal entry (internal / tests) |
mgr/sectionevents/restore | Restore section state from journal |
mgr/pagetemplate/list / get / save / remove | Page template CRUD |
mgr/pagetemplate/apply | Apply template to draft |
mgr/presets/list | Example list for catalog tab |
mgr/basket/* | Global basket in control panel |
mgr/api/page/snapshot / apply | Agent API |
mgr/datasource/* | Datasource preview |
mgr/form/* | CMP Forms |
mgr/bundle/* | Export, dry-run, and import of UI types. Not registered while BUNDLE_ENABLED = false |
mgr/resttoken/* | REST API v1 tokens |
mgr/ms3/products/search | Product search for commerce sections |
mgr/ms3/categories/search | miniShop3 category search (parent in grids and carousels) |