VN-Designer Developer Documentation
VN-Designer

Building blocks, themes and extensions

The reference for every syntax, attribute and interface you need to build your own blocks, themes and extensions for VN-Designer. Each element has its own entry with syntax, values and an example.

Start here →

All chapters

01Overview and first blockWhat a block is, how a block folder is structured, a first block of your own in ten minutes (folder, package, import, test), the most important terms and an overview of all chapters.02The template (template.html)Structure of template.html: root element and its attributes, placeholders {{…}} with expressions and helper functions, images and links, Bootstrap, site-wide blocks and what happens in the editor and in the export.03Input fields (vn-parameters)The <vn-parameters> block in the template: groups, every input type with an example, the background widget, attributes, conditions (condition), default values, naming rules and a complete parameter block.04Directives and markersvn-if, vn-class, vn-style, vn-strict-if, vn-theme-style, vn-overlay, vn-buttons, vn-menu, vn-video, vn-article, data-vn-icon and other attributes in the template, the rules for expressions and a list of the older notations.05Block styles (style.less)How style.less is compiled: variables from the properties, background variables, conditions, scoping by instance class, CSS layers and precedence in the editor and the export, base font size, buttons and links, theme CSS versus block CSS.06Directly Editable ContentWhat can be edited with a click in the canvas (text, images, icons, buttons, menus, links), how the block author marks, triggers or prevents this in the template, and how CMS and popup features attach to the block.07Scripts in blocks and themesHow a block ships JavaScript, how it detects the editor, what the editor does with scripts, how cookie consent and privacy are connected, which libraries are shipped under vendor/, and which pitfalls exist.08FormsThe static form (vn-sform) with all its markers, the shared PHP sending (mailer.php, config.php, recipients.php, SMTP), spam protection, and the VN Form Editor with the Form Renderer (field types, rules, saving, embedding).09Backgrounds, media and tool blocksBackground widget (image, color, video, parallax, overlay), video background and video container, self-hosted video, lightbox, gallery, PDF viewer, search, blog, animations and translator – each with the markers the block author sets and what the program makes of them.10Packages and themes (.vndext)Structure of a package file (.vndext) with blocks and theme files, params.json, site-wide blocks, import rules, theme CSS and a complete mini theme as an example.11Builder and user blocksHow the block builder turns rows, columns and elements into a template and LESS, which data model is stored, how user blocks and .vndext files are made from your own blocks, and how this relates to the code editor.12Extensions (.vndtool)Package layout and manifest.json of a tool extension, lifecycle, tool windows, the complete program interface ctx, PHP server parts, building, gallery upload, security rules and a complete Hello extension.13Export and PublishingWhat happens when exporting to the publish/ folder, how pages, CSS, runtime files and extension contributions are produced, how preview and FTP upload work, which privacy rules apply and what authors can influence.14Pitfalls and checklistTick-off checklists to work through before publishing a block, a theme or an extension, and a table of all pitfalls described in the chapters (symptom, cause, solution) with links to the detail entries.15Quick referenceCompact lookup tables: input types and attributes, directives and markers, placeholders and variables, root attributes, package files, manifest.json, all ctx functions and the libraries under vendor/, each with a link to the detail entry.