docs.modx.pro

English

Русский

English

Русский

Appearance

  1. Extras
  2. PageBuilder
  3. Getting started

Quick start ​

1. Install dependencies and the package ​

RequirementVersion
MODX Revolution3.0.3+
PHP8.2+
VueTools1.1.2+
pdoTools3.0+
PageBuilder (Free)1.0.1-beta
PageBuilder Pro1.0.1-beta, requires pagebuilder ≥ 1.0.1

PageBuilder (Free) and PageBuilder Pro install from modstore.pro. Without the provider, install fails with Package provider not found.

  1. Connect ModStore.
  2. Install VueTools and pdoTools if they are not on the site yet.
  3. Extras → Installer → Download Extras — find PageBuilder (Free) or PageBuilder Pro → Download → Install.
  4. Settings → Clear cache. Packages should list namespace pagebuilder.

Pro

Install PageBuilder Pro only: MODX pulls Free core (pagebuilder) automatically. You do not need a separate Free install.

Catalog: modstore.pro.

2. Grant permissions ​

Under Users → User groups, add to the editor policy:

  • pagebuilder_view
  • pagebuilder_save

For section types in the CMP: pagebuilder_manage_types.

3. Enable the Sections tab ​

The tab is off by default. In System settings → namespace pagebuilder:

KeyValue
pagebuilder_resource_tab_enabled1
pagebuilder_resource_tab_parentsempty = all resources, or parent IDs comma-separated

Tab position: pagebuilder_resource_tab_index (0 first, -1 last).

Sections tab on a resource

Details: System settings.

4. Add output to the template ​

In the page template or resource content field:

modx
[[!PageBuilder]]
fenom
{'!PageBuilder' | snippet}

The snippet renders published sections for the current resource. Drafts are not shown on the site.

5. Build the page in the manager ​

  1. Open the resource → Sections tab.
  2. Add a section (e.g. Hero) and fill fields.
  3. Click Save (draft).
  4. Click Publish. The same layout appears on the site.

With pagebuilder_fake_enabled = 1, the inspector shows a Fake button that fills fields with demo data for a quick layout check.

Draft preview without publishing: Preview in the tab (token via preview.php).

6. Check the frontend ​

Open the resource on the site. Section HTML should appear. By default pagebuilder-sections.css is registered (pagebuilder_load_frontend_css).

If the block is empty:

  • sections were not published
  • the snippet lacks access to the resource
  • the template caches the call without !. Use [[!PageBuilder]]

Next steps ​