Variflow Builder Changelog
Changelog
1.0.0 (unreleased)
The first release. Editors build pages from parts you write; every design choice they make is one of the site's design tokens.
For developers
- Parts (Parts): section shells, components (containers, query components, picked
entries) and patterns, each a JSON schema with an EE partial in
system/user/templates/<site>/_sections/. Appearance is tokens only: schemes, token groups (a control may offer several groups), component variants and the grid's containers. Fields can be text, rich text, links, images with alt text, selects, toggles, numbers and picked entries, and can show only when another field has a value (showWhen). Strict: unknown keys are errors. variflow:builder:verify(Verifying parts) checks every part against its schema and the live token build, with file and line for each problem.--json,--strictand--site; exit 0, 1 or 2, for deploy scripts. Builder › Parts shows the same in the control panel.- Edit parts in the control panel (Parts):
a section's or component's template and settings in EE's code editor, with Check (the same
checks as verify, with the line of each problem) and a save that's refused on errors or when the
files changed on disk since they were opened. New part (blank or a copy), revisions with
compare and restore, and delete for parts no page uses. EE's template partial permissions decide
who can;
$config['variflow_builder_cp_editing'] = 'n'turns it off on a server deployed from version control. - Space above and Space below on every component (Parts):
editors pick a step from the site's spacing scale for one item, or keep Standard (the
site's own spacing). Output as an inline margin on the component's outer element; stored as
appearance, so checks, locks, the licence and Tokens' usage cover it.
"spacing": falseleaves them out of a component;$config['variflow_builder_spacing']picks another group or turns them off. - The editor's canvas runs add-on and module tags (
{exp:…}) when it redraws a section after a change, as the page does. Before, a part using one showed its raw tag until the page reloaded. - A part whose settings aren't valid JSON now says why ("Syntax error") instead of "No error".
- The Variflow Builder field (Pages) stores a page as a tree of your parts (JSON, never HTML) and checks it on save: nesting, fit, required fields, values against the live build, locks, and the field's settings (allowed shells and patterns, open sections, the default section, depth, column dividers, detaching, and When the page has problems: refuse, save drafts only, or save and warn). Revisions work as for any field.
- Rendering:
{my_field}, its loop,:outlineand:total_sections. Partials get the node's fields, appearance,{vfb:attrs},{vfb:container},{vfb:narrow},{vfb:span}and more; layouts render with Variflow Tokens' layout attributes (data-vf-layout,data-vf-order,--vf-span). Query components and picked entries loop through{vfb:entries}, one query each, with Structure permalinks. A node that no longer validates renders nothing and is logged. EE'sgenerate:templatesoutputs the field's tag. - Bring your own CSS (guide): the hooks Builder and Tokens give your stylesheet, a working cascade-layer order, and setup notes for plain CSS, Tailwind, UnoCSS, daisyUI, Bootstrap, Bulma, Foundation and Open Props.
- Saved patterns: members with the Save patterns permission save a section, or items in
a column, as a pattern from the editor; Builder › Patterns manages them, and
variflow:builder:export-patternwrites one to a file for version control.variflow:builder:usage --entry=<id>lists the pages that pick an entry. - Builder pages are a Variflow Tokens content source: usage, the build guard, renames, remaps and Undo cover the tokens they use.
Licensing
- EE's add-on licensing, with a 14-day trial: a production site without a valid licence works
fully for 14 days from the first time Builder sees the problem, with a banner counting down for
members who can act on it. After that, page layout locks: editors can still edit and save
text, links, images and picked entries, but sections, layouts and components can't be added,
moved or removed, appearance and tokens can't change, and Save as pattern, Builder › Patterns
edits and
variflow:builder:export-patternstop. Front-end pages, template tags, Live Preview, verify and every control panel page never stop. Builder's trial is its own, separate from Variflow Tokens'. See Licensing. - The guide is online at gobison.digital/documentation/variflow/builder.
For editors (Editing pages)
-
Image fields show a thumbnail and the file's name. Drop an image file on the field (or on the item in the live page) to upload it into the File Manager, or use Upload, Choose file or From Assets (Variflow's logos and other files, which then follow the Assets page). Alt text shows the file's description it falls back to, and Decorative marks an image screen readers should skip. A file's name is never used as alt text.
-
The page editor opens full screen over the publish form: a Library of what the field allows (components, patterns and your design tokens), the live page in the centre (your own templates through EE's Live Preview, at desktop, tablet and phone width) or Plan (the page as an outline), and an inspector with Variflow Tokens' pickers. EE's own Save saves the page.
-
Edit on the page: click to select, edit marked text and images in place, drag items and tokens to where they fit (only valid places are offered), resize a layout's columns with its dividers, and set On phones: Last column first. Undo and redo, 100 steps.
-
Patterns: start a page from the most-used section patterns; locked and structured copies offer only what their pattern allows; detach a copy where the field allows it.
-
Publish checks: saving as published lists the page's problems first (empty columns and sections, missing required text, unavailable picked entries, text too long) with one-click fixes you can undo, and advice on images without alt text.
-
Switching entries off. A picked entry that's closed, scheduled or expired is left off the page and isn't a problem: saving goes ahead and it shows again when reopened. The editor names it with a quiet note. Only a deleted pick, or one in another channel or site, is a problem.
-
Everything works from the keyboard, with screen-reader announcements, in both CP themes.
Requirements: ExpressionEngine 7.3 or later, PHP 8.2 or later, and Variflow Tokens 1.3 or later with a live build. Builder refuses to install without them and says why, including when Tokens' files are new enough but its update hasn't run.
Earlier 0.1.0 previews were never released. A site that ran one updates to 1.0.0 through EE's add-on update, with nothing to change in its pages or parts.