Schnellreferenz
Kompakte Tabellen zum Nachschlagen: Eingabetypen und Attribute, Direktiven und Markierungen, Platzhalter und Variablen, Wurzelattribute, Paketdateien, manifest.json, alle ctx-Funktionen und die Bibliotheken unter vendor/, jeweils mit Link zum Detail-Eintrag.
Eingabetypen#
Alle Typen stehen im Block <vn-parameters> (Kapitel Eingabefelder). Was nicht in der Tabelle steht, wird ein einzeiliges Textfeld.
Tag und type | Feld im Panel | Wert im Template | Wert im LESS | Eintrag |
|---|---|---|---|---|
input type="text" (auch jeder unbekannte Typ) | Textfeld | Text | Text in Anführungszeichen | text, Andere Typen |
textarea | mehrzeiliges Textfeld | Text mit Zeilenumbrüchen | Text in Anführungszeichen | textarea |
input type="checkbox" | Schalter | true oder false | true oder false | checkbox |
input type="color" | Farbwähler | Text #rrggbb | Farbe | color |
input type="range" | Schieber mit Zahlenfeld | Text ("4") | Zahl | range |
select mit option | Auswahlliste | Text (value der Option) | Text in Anführungszeichen | select und option |
input type="image" | Bildfeld | Text (Bildadresse) | Text in Anführungszeichen | image |
fieldset mit image, color, video | Hintergrund-Widget | Objekt { type, value, parallax } | @bg-type, @bg-value, @bg-parallax | fieldset, Hintergrund-Variablen |
input type="video" (nur im fieldset) | Video als dritte Art des Widgets | bg.value.url | @bg-value | video |
header | Überschrift einer Gruppe | – | – | header |
Textfelder mit den Namen videoFile, videoFile2, subtitleFile | Textfeld mit „Datei wählen…“ | Text | Text | Datei- und Videofelder |
Attribute der Eingabefelder#
| Attribut | Gilt für | Bedeutung | Eintrag |
|---|---|---|---|
name | alle Felder | Name des Werts: JavaScript-Bezeichner und LESS-Variable @name; Buchstaben, Ziffern, Unterstrich, beginnt mit Buchstabe | name |
title | alle Felder | Beschriftung im Panel (ohne: der Name) | title |
value | text, color, range, image, Widget-Eingaben | Vorgabewert | value, Vorgabewerte |
checked | checkbox | Vorgabe „an“ | checked |
min, max, step | range | Bereich und Schrittweite (0, 100, 1) | min, max, step |
rows | textarea | Höhe 2 bis 30 (Standard 5) | rows |
selected | option, Widget-Eingaben | Vorgabe der Auswahl bzw. der Hintergrundart | selected |
parallax | input type="image" im fieldset | Parallax-Schalter vorab an | fieldset |
condition | header, Felder, fieldset | Feld nur zeigen, solange der Ausdruck nicht genau false ergibt | condition |
inline | range | wird nicht ausgewertet | inline |
type="background" | fieldset | wird nicht gelesen (Schreibkonvention) | fieldset |
Reservierte Namen mit Unterstrich am Anfang und die automatischen Bereiche des Panels: Automatische Bereiche. Automatische Overlay-Felder (overlay, overlayColor, overlayOpacity): Automatische Overlay-Felder.
Direktiven und Markierungen im Template#
Direktiven#
| Name | Wert | Wirkung | Eintrag |
|---|---|---|---|
vn-if | Ausdruck | entfernt das Element bei genau false | vn-if |
vn-strict-if | Schalter | alle vn-if des Blocks entfernen bei jedem falschen Wert | vn-strict-if |
vn-class | Objekt, Liste oder Text | Klassen bedingt hinzufügen | vn-class |
vn-style | Objekt | Inline-Stile bedingt setzen (keine --variablen) | vn-style |
vn-theme-style | Klassen | Klassen der Theme-Einstellungen ergänzen | vn-theme-style |
Klasse vn-overlay mit opacity, bg-color | Zahl 0 bis 1, Farbe | Abdunklungsfläche (position:absolute; inset:0) | vn-overlay |
vn-buttons, vn-menu | Schalter | Marker für das Ziel von vn-theme-style | vn-buttons, vn-menu |
vn-video, data-vn-video-empty | Schalter | Video-Behälter mit Adressfeld im Panel | vn-video, Video-Behälter vn-video |
vn-article, data-multiline | Schalter | Liste (oder div) als ein Textfeld mit Zeilen-Eingabe | vn-article, Listenfelder |
data-vn-icon | Schalter | Element als änderbares Symbol kennzeichnen | data-vn-icon, Symbole |
vn-parameters | Block | Eingabefelder (wird nicht ausgegeben) | vn-parameters |
Ausdrücke und Auswertungsreihenfolge: Ausdrücke. Ältere Namen (mbr-…): Ältere Schreibweisen.
Weitere Markierungen, die ein Autor schreibt#
| Markierung | Ort | Wirkung | Eintrag |
|---|---|---|---|
data-bg-video | Wurzelelement | Adresse eines Hintergrundvideos | data-bg-video, Video-Hintergrund |
data-vn-editor-only | beliebiges Element | nur im Editor sichtbar, im Export entfernt | Marker data-vn-editor-only |
data-vn-popup-close | Element im Popup | schließt das Popup | Schließen aus dem Inhalt |
data-vn-consent-category | iframe, script | sperrt bis zur Zustimmung zu functional, statistics oder marketing | data-vn-consent-category, Automatisches Sperren |
data-vn-cookie-settings | a | öffnet die Cookie-Einstellungen | Cookie-Einstellungen öffnen |
data-vn-anim, data-vn-anim-t | Text, Bild | Animation (setzt das Werkzeug VN Animation) | data-vn-anim und data-vn-anim-t, Animationen |
data-vn-drag, -x, -y, -size | Bild einer Szene | Ebene per Maus ziehbar, mit Feldnamen für Lage und Größe | Ebenen ziehen |
Klasse vn-zoom, vn-nozoom; data-vn-skip, -caption, -full, -group, -badge | Bild, Behälter | Lightbox | Markierungen |
Klasse vn-ic, vn-ic-svg; data-vn-svg, data-vn-svg-mode | Symbol im Text | änderbares Textsymbol, eigenes SVG | Symbole im Text |
Klasse vn-tip, vn-tip-plain; data-vn-tip-html, -bg, -fg, -trigger | Wort im Text | Tooltip | Tooltips auf Wörtern |
Klasse notranslate | Element | vom VN Übersetzer ausnehmen | Ausnahmen markieren |
li.vn-submenu, a.vn-submenu-toggle, ul.vn-submenu-list | Menü | seitlich aufklappendes Untermenü | Untermenü |
Klasse vn-bgvid, vn-bgvid-el, vn-bgvid-poster … | Baustein „Video-Hintergrund“ | Hero mit Hintergrundvideo | Der Baustein Video-Hintergrund |
data-position="top" | <script type="text/x-vn-php"> | PHP-Code an den Dateianfang | Verhältnis zum Code-Editor, Einbacken |
type="text/x-vn-php" | script | geschützter PHP-Code (Export setzt ihn roh ein) | Geschützter PHP-Code im Text, Wie der Block das PHP einbindet |
Vom Programm gesetzte Markierungen#
Schreiben Sie diese nicht selbst; sie erscheinen im gespeicherten Template und verschwinden im Export (Vom Programm gesetzte Markierungen).
| Markierung | Gesetzt an | Eintrag |
|---|---|---|
data-vn-text-id="tN" | bearbeitbaren Texten | data-vn-text-id |
data-vn-image-key="feld" | Bildfeld-Bildern und Wurzel mit Widget | Bildfeld |
data-vn-free-image-id="fiN" | festen Bildern | Freies Bild |
data-vn-button-id="btnN", data-vn-btn-extra-classes | a.btn | a.btn |
data-vn-icon-id="iconN", data-vn-icon-extra-classes | Symbolen | data-vn-icon |
data-vn-nav-icon | Symbol vor/hinter einem Menüpunkt | Symbol vor dem Menüpunkt |
data-vn-cms-block, data-vn-cms, data-vn-cms-img, data-vn-cms-link | Export mit CMS | Markierungen im fertigen HTML |
data-vn-cc-src, data-vn-cc-category, Klasse vn-cc-gate | gesperrte Einbettungen im Export | Automatisches Sperren |
data-vn-sform-ready, data-vnfr-pending, data-vnfr-rendered, data-vntabelle-ready | Formular- und Tabellen-Skripte | Das form-Element, Der Form-Renderer-Block, VN Tabelle |
Markierungen von Formularen, PDF, Suche, Tabelle#
| Markierung | Wirkung | Eintrag |
|---|---|---|
form.vn-sform-form, div.vn-sform-field[data-type], .vn-sform-label, div.vn-sform-hp, a[data-vn-sform-submit], .vn-sform-status | statisches Formular | Grundgerüst, Feldtypen |
data-recipient, data-subject, data-success, data-thankyou, data-mailer | Einstellungen am form | Das form-Element |
style="--span:N" | Feldbreite (12 Spalten) | Raster |
data-vn-captcha-q, -answer, -token, data-vn-copytosender | Sicherheitsabfrage, Kopie an Absender | Mathe-Sicherheitsabfrage, Kopie an den Absender |
section.vn-formrender, .vnfr-data[data-…], .vnfr-out | Form-Renderer-Block | Der Form-Renderer-Block |
iframe[data-vn-pdf-src] | PDF-Betrachter | |
data-vntabelle-root, th[data-vnsort], td[data-label] | VN Tabelle | VN Tabelle |
section.vn-search, .vns-data[data-…] | VN Suche | Suche |
video.vn-video-el mit data-start, -end, -rate, -volume, -viewplay, -exclusive, -lazy, -player | selbst gehostetes Video | Selbst gehostetes Video |
vn-galerie-host, .vn-gal-wrap, .vn-gal-grid … | VN Galerie | Galerie |
Platzhalter und Variablen#
| Form | Ort | Ergebnis | Eintrag |
|---|---|---|---|
{{name}} | Template (Text, Attribute, Skript, Stil) | Wert des Felds, unmaskiert als HTML | {{name}} |
{{ausdruck}} | Template | Ergebnis eines JavaScript-Ausdrucks; Fehler ergibt leeren Text | Ausdrücke |
{{bg.type}}, {{bg.value}}, {{bg.value.url}}, {{bg.parallax}} | Template | Felder des Hintergrund-Widgets | Objektfelder |
{{vn-id}} | Template (auch im Skript) | Kennung der Instanz (blk-… oder Anker-ID) | {{vn-id}} |
{{vnEnc(text)}} | Template, Bedingungen | encodeURIComponent für data--Attribute | vnEnc, Text-Daten in Attributen |
{{vnEmbed(adresse)}} | Template | YouTube/Vimeo-Adresse zur Einbett-Adresse | vnEmbed |
{{…}} in a.btn | Template | bleibt wörtlich stehen | Platzhalter in Buttons |
@name | style.less | Wert des Felds als LESS-Variable | Variablen |
@bg-type, @bg-value, @bg-parallax | style.less | Hintergrund-Variablen (nur mit Widget) | Hintergrund-Variablen |
@primaryColor, @mainFont, @display1Size … | style.less | Theme-Variablen mit Vorgaben | Theme-Variablen |
~"@{name}", e(@name) | style.less | Text ohne Anführungszeichen ausgeben | Werte als Text ausgeben |
{{secret:NAME}}, {{secret-php:NAME}} | Dateien eines Export-Beitrags | Geheimnis einsetzen (secret-php maskiert \, " und ab Version 1.3.100 auch $) | secrets |
{{mbr-id}} | ältere Pakete | wie {{vn-id}} | Ältere Schreibweisen |
Attribute am Wurzelelement#
| Attribut | Wirkung | Eintrag |
|---|---|---|
global | seitenweiter Block (nur am allerersten Element) | global |
once | Gruppe des seitenweiten Blocks (menu, footers, eigener Name); ein neuer Block ersetzt den alten | once |
plugins | Plugin-Ordner eines Bootstrap-4-Themes | plugins |
data-bs-version | kennzeichnet Bootstrap-5-Bausteine | data-bs-version |
data-bg-video | Adresse des Hintergrundvideos | data-bg-video |
vn-strict-if | strenge vn-if im ganzen Block | vn-strict-if |
id, class | bleiben erhalten; Instanzklasse vn-imp-<alias>-<Kennung> kommt hinzu | id und class, Bezeichner |
group, always-top, not-draggable, position-absolute, data-app-selector, data-app-placeholder, data-toolbar | werden nicht ausgewertet | group, Nicht ausgewertete Attribute |
Paketdateien und params.json#
Dateien im ZIP#
| Datei | Pflicht | Bedeutung | Eintrag |
|---|---|---|---|
params.json | ja | Name, Alias, Liste der Bausteine | params.json |
components/<name>/template.html | ja | Markup und <vn-parameters> | template.html |
components/<name>/style.less (oder style.css) | nein | Stil des Bausteins | style.less oder style.css |
components/<name>/thumb.png | nein | Vorschau in der Auswahl | thumb.png |
components/_images/ | nein | gemeinsame Bilder, Verweis ../_images/<datei> | components/_images |
plugins/theme/css/style.css, fonts/style.css, weitere plugins/**/*.css | nein | Theme-CSS (einmal pro Projekt) | Welche Dateien geladen werden |
thumbnail.jpg | nein | Vorschau in der Online-Galerie | thumbnail.jpg |
plugins/ (JavaScript) | nein | nur bei Bootstrap-4-Themes | plugins/ und fonts/, Bootstrap-Modus |
Felder der params.json#
| Feld | Bedeutung | Eintrag |
|---|---|---|
name | Anzeigename des Pakets | params.json |
alias | Kennung des Pakets; bildet Alias und Klasse | params.json, Bezeichner |
title | bestimmt die Kennung des Theme-CSS | Nur einmal pro Projekt |
components[].path | Ordner des Bausteins (Pflicht) | params.json |
components[]._title, _group | Anzeigename, Gruppe | params.json |
components[]._once | nur Anzeige „· site-weit“ | params.json |
theme.settings[] (var, type, default, title, set) | Theme-Variablen für LESS | Theme-Eigenschaften |
theme.customLESS | LESS-Datei, deren CSS ans Theme-CSS kommt | Theme-Eigenschaften |
appScript | Paket mit appScript ohne components wird abgelehnt | params.json |
manifest.json einer Erweiterung#
| Feld | Bedeutung | Eintrag |
|---|---|---|
id | Pflicht; 2 bis 48 Zeichen; nie ändern | manifest.json |
name, name_<sprache> | Name der Kachel | manifest.json |
description, description_<sprache> | Beschreibung | manifest.json |
version | Anzeige und Update-Vergleich | manifest.json |
icon | Kürzel im Symbol der Kachel | manifest.json |
author | Autor | manifest.json |
main | Programmdatei (Standard tool.js) | manifest.json, tool.js |
Weitere Dateien einer Erweiterung: Paketaufbau (payload.js, dom.js, style.css, *.vndext, thumbnail.jpg).
Programm-Schnittstelle ctx#
Alle Einträge im Kapitel Erweiterungen.
| Eintrag | Kurzbeschreibung | Eintrag |
|---|---|---|
ctx.projectDir | Ordner des geöffneten Projekts oder null | Die Schnittstelle ctx |
ctx.getPages(), ctx.getGlobalBlocks() | Seiten und seitenweite Blöcke (Arbeitsobjekte, nur lesen) | Die Schnittstelle ctx |
ctx.switchToPage(id) | zur Seite wechseln | Die Schnittstelle ctx |
ctx.askConfirm(text) | Bestätigungsdialog, liefert true/false | ctx.askConfirm |
ctx.openToolWindow(titel, element, opts) | Werkzeugfenster öffnen | ctx.openToolWindow |
ctx.closeToolWindow() | Werkzeugfenster schließen | ctx.closeToolWindow |
ctx.extension | { id, version, baseUrl } der Erweiterung | Die Schnittstelle ctx |
ctx.project.getInfo() | Kopie der Projektdaten | getInfo |
ctx.project.buildFiles() | fertige Seiten im Speicher bauen | buildFiles |
ctx.project.updatePage(id, patch) | Felder einer Seite ändern | updatePage |
ctx.project.updateSite(patch) | Website-Einstellungen ändern | updateSite |
ctx.project.getGlobalHtml(), setGlobalHtml(patch) | Globale HTML-Einfügungen | getGlobalHtml und setGlobalHtml |
ctx.project.listImages(), setImageAlt(…) | Bilder mit Alt-Text lesen und setzen | listImages und setImageAlt |
ctx.project.assetSizes(pfade) | Dateigrößen unter assets/ und publish/ | assetSizes |
ctx.project.addPage(opts) | Seite mit einem HTML-Block anlegen | addPage |
ctx.project.newEmptyPage(opts) | leere Seite anlegen und dorthin wechseln | newEmptyPage |
ctx.project.findInBlocks(muster) | Muster im HTML und CSS aller Blöcke suchen | findInBlocks |
ctx.project.selectBlock(…), showPage(id), canvas() | Block wählen, Seite zeigen, Arbeitsfläche lesen | selectBlock und showPage |
ctx.project.colorUsage(), replaceColors(map, opts) | einstellbare Farben listen und ersetzen | colorUsage und replaceColors |
ctx.project.settings.get(), set(obj) | Einstellungen der Erweiterung im Projekt | settings |
ctx.project.exportContribution.get(), set(obj) | Beitrag zum Export (head, bodyEnd, files) | exportContribution |
ctx.project.secrets.set(name, wert), names() | Geheimnisse im Programm-Profil | secrets |
ctx.project.ai.providers(), ask(…), openSettings(), speechProvider(), transcribe(…) | KI-Zugänge nutzen | ctx.project.ai |
ctx.blocks.importPackage(buffer, opts) | Baustein-Paket importieren und einfügen | importPackage |
ctx.blocks.importToLibrary(buffer) | Paket in die Bibliothek legen | importToLibrary |
ctx.blocks.findByAlias(alias), setValues(id, patch) | Blöcke eines Bausteins finden, Werte setzen | findByAlias und setValues |
ctx.blocks.describe(id), selected(), pageBlocks() | Eigenschaften und Blöcke beschreiben | describe, selected, pageBlocks |
ctx.blocks.catalog(), addFromCatalog(key, opts) | einfügbare Bausteine listen und einfügen | catalog und addFromCatalog |
ctx.blocks.texts.list(), set(einträge) | bearbeitbare Texte lesen und schreiben | ctx.blocks.texts |
ctx.blocks.images.list(), set(einträge) | Bildplätze lesen und setzen | ctx.blocks.images |
ctx.blocks.addBlock, findGalleries, updateGallery, anim.* | Schnittstellen der eingebauten Werkzeuge | Weitere Einträge von ctx.blocks |
window.vnDesigner.* | Programm-Brücke (saveAsset, listAssetImages, openExternal, loadSmtpConfig, netCheckUrl …) | Die Schnittstelle ctx |
Bibliotheken unter vendor/#
Der Export kopiert nur, was die Seiten verwenden (Mitgelieferte Bibliotheken, Laufzeit-Dateien).
| Bibliothek | Ordner | Auslöser im Export | Eintrag |
|---|---|---|---|
| Bootstrap 5.0.1 (CSS und Bundle-JS) | vendor/bootstrap.min.css, vendor/bootstrap.bundle.min.js | immer (außer Bootstrap-Modus „aus dem Theme“) | Bootstrap 5.0.1 und Bootstrap Icons |
| Bootstrap Icons | vendor/bootstrap-icons/ | immer | Bootstrap 5.0.1 und Bootstrap Icons |
| Flaggen | vendor/flags | als Projektdateien unter assets/ | Eigene SVG-Symbole und Flaggen |
| jQuery 3.5.1 | vendor/jquery.min.js | nur Bootstrap-Modus „aus dem Theme“ | jQuery und Theme-Plugins |
| VN Lightbox | vendor/vn-lightbox/ | Seiteneinstellung | VN Lightbox, Lightbox |
| VN Cookie-Consent | vendor/vn-cookie-consent/ | Seiteneinstellung | VN Cookie-Consent, Cookie-Consent und Datenschutz |
| VN Popup | vendor/vn-popup/ | Seite enthält ein Popup | VN Popup, Popup |
| VN CMS | vendor/vn-cms/ | Seite enthält einen CMS-Block | VN CMS, CMS |
| VN Untermenü | vendor/vn-submenu/ | li.vn-submenu im HTML | VN Untermenü |
| VN Tooltip | vendor/vn-tooltip/ | span.vn-tip im HTML | VN Tooltip |
| VN Video | vendor/vn-video/ | video.vn-video-el im HTML | Selbst gehostetes Video |
| VN Hintergrundvideo | vendor/vn-bgvideo/ | data-bg-video mit Wert oder .vn-bgvid | Video-Hintergrund |
| VN Übersetzer | vendor/vn-translate/ | Seiteneinstellung | VN Übersetzer, Übersetzer |
| VN WhatsApp | vendor/vn-whatsapp/ | Seiteneinstellung (mit Nummer) | VN WhatsApp |
| VN Formular, Form Renderer | vendor/vn-sform/, vendor/vn-formrender/ | form.vn-sform-form oder Form-Renderer-Block | Formulare, Export-Verhalten |
| VN PDF-Betrachter (PDF.js 3.11.174) | vendor/vn-pdf-viewer/ | Block mit Betrachter-Adresse | |
| VN Suche, VN Blog | vendor/vn-search/, vendor/vn-blog/ | jeweilige Blöcke | Suche, Blog |
| jszip, less, CodeMirror | vendor/ | nur im Editor, nie im Export | Mitgelieferte Bibliotheken |
Laufzeit-Schnittstellen der Seite: window.vnCookieConsent mit getConsent(), openSettings(), labelGates() (Eigene Sperre im Block); Ereignisse vn-cc-activated (Eigene Sperre im Block) und vn-cc-consent (Ereignis vn-cc-consent); VNPopup.open(id), close(id), isOpen() (JavaScript-Schnittstelle VNPopup).
Block-Werte und Overrides#
| Name | Bedeutung | Eintrag |
|---|---|---|
block.values[<feld>] | Werte der Eingabefelder | Wie Werte ins Template und ins LESS gelangen |
block.anchorId, block.popup, block.cms | Anker-ID, Popup- und CMS-Einstellungen | Automatische Bereiche, Einstellungen, Einschalten |
_textScalePct, _textWidthPct, _textOffsetYPx | Regler für Textgröße, -breite, -position | Größe, Breite und Position pro Block |
_menuFontPx, _brandFontPx, _togglerColor, _ddBg, _ddText, _ddHoverBg, _ddHoverText | Regler eines Menü-Blocks | Regler eines Menü-Blocks |
_videoUrl<i>, _videoAuto<i>, _videoLoop<i> | Video-Adresse, Autostart, Wiederholen je vn-video-Behälter | Video-Behälter vn-video |
textOverrides, textTagOverrides, textLinkOverrides, textAlignOverrides | Änderungen an Texten | Überblick |
buttonOverrides, iconOverrides, navIconOverrides | Änderungen an Buttons und Symbolen | Werte eines Buttons, Werte eines Symbols |
imageOverrides, imageLinkOverrides, imageAltOverrides, animOverrides | Änderungen an Bildern und Animationen | Alt-Text, Titel und Link, Animationen |
schemaEntry.builder, schemaEntry.freeSurface | Datenmodell von Baukasten und Freier Fläche | Das gespeicherte Datenmodell, Freie Fläche |