Grid & Editor Architecture

Frontend Grid

Layout configuration settings for a shortcode are accessible via GridItemInterface using the getLayoutConfiguration() method. It returns a LayoutConfigurationInterface with a dedicated method per device size — getSmallMobileConfiguration(), getMobileConfiguration(), getTabletConfiguration(), getLaptopConfiguration(), getDesktopConfiguration(), and getLargeDesktopConfiguration(). Each returns a DeviceLayoutConfigurationInterface exposing getOffset(): ?int, getWidth(): ?int, and isHidden(): ?bool (all nullable). GridItemInterface lives in OxidEsales\VisualCmsModule\Grid\DTO (src/Grid/DTO/); LayoutConfigurationInterface and DeviceLayoutConfigurationInterface in OxidEsales\VisualCmsModule\Grid\Layout\DTO (src/Grid/Layout/DTO/).

Custom Grid System

Attention

The custom grid system settings are deprecated and will be removed in a future version. Use the per-device class pattern settings under Extensions ‣ Modules ‣ Visual CMS ‣ Settings ‣ Frontend Grid instead.

The deprecated settings — blCustomGridFramework, sGridColPrefix, sGridOffsetPrefix, sGridRow, and blGridWordNumbers — provided a simple prefix-based mechanism for custom grids, where a column class was assembled by concatenating a prefix (e.g. col-sm-) with a numeric size.

The replacement is a set of per-device module settings accessed through FrontendLayoutSettingsInterface (OxidEsales\VisualCmsModule\Grid\Layout\Settings\FrontendLayoutSettingsInterface, src/Grid/Layout/Settings/). Instead of a single prefix, each device size (small-mobile, mobile, tablet, laptop, desktop, large-desktop) has separate configurable class patterns for column size, offset, and visibility, giving full control over the generated calculatedClasses variable without the limitations of the prefix approach. For even greater control, the interface can be implemented directly and registered as a service to replace the default.

Editor Architecture

With Visual CMS 10, part of the editor’s browser code was converted to TypeScript. It is structured around services — TypeScript classes that encapsulate specific functionality and can be composed together.

Dependency injection between these services is handled by tsyringe, a lightweight IoC container for TypeScript. It allows services to declare their dependencies through constructor injection and have them resolved automatically at runtime.

With Visual CMS 12 this conversion was extended across the editor. grid.js became Grid.ts, VisualEditor.js became VisualEditor.ts (its plugins are collected via @injectAll and its grid event listeners were extracted into a dedicated VisualEditorGridListeners class), while the template.js and panel.js modules were split into sets of typed TypeScript services. The former editor.js bridge module was removed; the visual editor and its helpers are now obtained through dependency injection instead.

Build tooling

The editor and storefront assets are built with Vite 8 (TypeScript transformed by oxc via rolldown, SCSS compiled in the same pipeline, static vendor assets copied via vite-plugin-static-copy). Building the frontend requires Node 22.13+ (or 24+) and npm 11.19.1+ — see the module’s README for the exact toolchain.