VN-Designer Entwickler-Dokumentation
15

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 typeFeld im PanelWert im TemplateWert im LESSEintrag
input type="text" (auch jeder unbekannte Typ)TextfeldTextText in Anführungszeichentext, Andere Typen
textareamehrzeiliges TextfeldText mit ZeilenumbrüchenText in Anführungszeichentextarea
input type="checkbox"Schaltertrue oder falsetrue oder falsecheckbox
input type="color"FarbwählerText #rrggbbFarbecolor
input type="range"Schieber mit ZahlenfeldText ("4")Zahlrange
select mit optionAuswahllisteText (value der Option)Text in Anführungszeichenselect und option
input type="image"BildfeldText (Bildadresse)Text in Anführungszeichenimage
fieldset mit image, color, videoHintergrund-WidgetObjekt { type, value, parallax }@bg-type, @bg-value, @bg-parallaxfieldset, Hintergrund-Variablen
input type="video" (nur im fieldset)Video als dritte Art des Widgetsbg.value.url@bg-valuevideo
headerÜberschrift einer Gruppe––header
Textfelder mit den Namen videoFile, videoFile2, subtitleFileTextfeld mit „Datei wählen…“TextTextDatei- und Videofelder

Attribute der Eingabefelder#

AttributGilt fürBedeutungEintrag
namealle FelderName des Werts: JavaScript-Bezeichner und LESS-Variable @name; Buchstaben, Ziffern, Unterstrich, beginnt mit Buchstabename
titlealle FelderBeschriftung im Panel (ohne: der Name)title
valuetext, color, range, image, Widget-EingabenVorgabewertvalue, Vorgabewerte
checkedcheckboxVorgabe „an“checked
min, max, steprangeBereich und Schrittweite (0, 100, 1)min, max, step
rowstextareaHöhe 2 bis 30 (Standard 5)rows
selectedoption, Widget-EingabenVorgabe der Auswahl bzw. der Hintergrundartselected
parallaxinput type="image" im fieldsetParallax-Schalter vorab anfieldset
conditionheader, Felder, fieldsetFeld nur zeigen, solange der Ausdruck nicht genau false ergibtcondition
inlinerangewird nicht ausgewertetinline
type="background"fieldsetwird 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#

NameWertWirkungEintrag
vn-ifAusdruckentfernt das Element bei genau falsevn-if
vn-strict-ifSchalteralle vn-if des Blocks entfernen bei jedem falschen Wertvn-strict-if
vn-classObjekt, Liste oder TextKlassen bedingt hinzufügenvn-class
vn-styleObjektInline-Stile bedingt setzen (keine --variablen)vn-style
vn-theme-styleKlassenKlassen der Theme-Einstellungen ergänzenvn-theme-style
Klasse vn-overlay mit opacity, bg-colorZahl 0 bis 1, FarbeAbdunklungsfläche (position:absolute; inset:0)vn-overlay
vn-buttons, vn-menuSchalterMarker für das Ziel von vn-theme-stylevn-buttons, vn-menu
vn-video, data-vn-video-emptySchalterVideo-Behälter mit Adressfeld im Panelvn-video, Video-Behälter vn-video
vn-article, data-multilineSchalterListe (oder div) als ein Textfeld mit Zeilen-Eingabevn-article, Listenfelder
data-vn-iconSchalterElement als änderbares Symbol kennzeichnendata-vn-icon, Symbole
vn-parametersBlockEingabefelder (wird nicht ausgegeben)vn-parameters

Ausdrücke und Auswertungsreihenfolge: Ausdrücke. Ältere Namen (mbr-…): Ältere Schreibweisen.

Weitere Markierungen, die ein Autor schreibt#

MarkierungOrtWirkungEintrag
data-bg-videoWurzelelementAdresse eines Hintergrundvideosdata-bg-video, Video-Hintergrund
data-vn-editor-onlybeliebiges Elementnur im Editor sichtbar, im Export entferntMarker data-vn-editor-only
data-vn-popup-closeElement im Popupschließt das PopupSchließen aus dem Inhalt
data-vn-consent-categoryiframe, scriptsperrt bis zur Zustimmung zu functional, statistics oder marketingdata-vn-consent-category, Automatisches Sperren
data-vn-cookie-settingsaöffnet die Cookie-EinstellungenCookie-Einstellungen öffnen
data-vn-anim, data-vn-anim-tText, BildAnimation (setzt das Werkzeug VN Animation)data-vn-anim und data-vn-anim-t, Animationen
data-vn-drag, -x, -y, -sizeBild einer SzeneEbene per Maus ziehbar, mit Feldnamen für Lage und GrößeEbenen ziehen
Klasse vn-zoom, vn-nozoom; data-vn-skip, -caption, -full, -group, -badgeBild, BehälterLightboxMarkierungen
Klasse vn-ic, vn-ic-svg; data-vn-svg, data-vn-svg-modeSymbol im Textänderbares Textsymbol, eigenes SVGSymbole im Text
Klasse vn-tip, vn-tip-plain; data-vn-tip-html, -bg, -fg, -triggerWort im TextTooltipTooltips auf Wörtern
Klasse notranslateElementvom VN Übersetzer ausnehmenAusnahmen markieren
li.vn-submenu, a.vn-submenu-toggle, ul.vn-submenu-listMenüseitlich aufklappendes UntermenüUntermenü
Klasse vn-bgvid, vn-bgvid-el, vn-bgvid-poster …Baustein „Video-Hintergrund“Hero mit HintergrundvideoDer Baustein Video-Hintergrund
data-position="top"<script type="text/x-vn-php">PHP-Code an den DateianfangVerhältnis zum Code-Editor, Einbacken
type="text/x-vn-php"scriptgeschü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).

MarkierungGesetzt anEintrag
data-vn-text-id="tN"bearbeitbaren Textendata-vn-text-id
data-vn-image-key="feld"Bildfeld-Bildern und Wurzel mit WidgetBildfeld
data-vn-free-image-id="fiN"festen BildernFreies Bild
data-vn-button-id="btnN", data-vn-btn-extra-classesa.btna.btn
data-vn-icon-id="iconN", data-vn-icon-extra-classesSymbolendata-vn-icon
data-vn-nav-iconSymbol vor/hinter einem MenüpunktSymbol vor dem Menüpunkt
data-vn-cms-block, data-vn-cms, data-vn-cms-img, data-vn-cms-linkExport mit CMSMarkierungen im fertigen HTML
data-vn-cc-src, data-vn-cc-category, Klasse vn-cc-gategesperrte Einbettungen im ExportAutomatisches Sperren
data-vn-sform-ready, data-vnfr-pending, data-vnfr-rendered, data-vntabelle-readyFormular- und Tabellen-SkripteDas form-Element, Der Form-Renderer-Block, VN Tabelle

Markierungen von Formularen, PDF, Suche, Tabelle#

MarkierungWirkungEintrag
form.vn-sform-form, div.vn-sform-field[data-type], .vn-sform-label, div.vn-sform-hp, a[data-vn-sform-submit], .vn-sform-statusstatisches FormularGrundgerüst, Feldtypen
data-recipient, data-subject, data-success, data-thankyou, data-mailerEinstellungen am formDas form-Element
style="--span:N"Feldbreite (12 Spalten)Raster
data-vn-captcha-q, -answer, -token, data-vn-copytosenderSicherheitsabfrage, Kopie an AbsenderMathe-Sicherheitsabfrage, Kopie an den Absender
section.vn-formrender, .vnfr-data[data-…], .vnfr-outForm-Renderer-BlockDer Form-Renderer-Block
iframe[data-vn-pdf-src]PDF-BetrachterPDF
data-vntabelle-root, th[data-vnsort], td[data-label]VN TabelleVN Tabelle
section.vn-search, .vns-data[data-…]VN SucheSuche
video.vn-video-el mit data-start, -end, -rate, -volume, -viewplay, -exclusive, -lazy, -playerselbst gehostetes VideoSelbst gehostetes Video
vn-galerie-host, .vn-gal-wrap, .vn-gal-grid …VN GalerieGalerie

Platzhalter und Variablen#

FormOrtErgebnisEintrag
{{name}}Template (Text, Attribute, Skript, Stil)Wert des Felds, unmaskiert als HTML{{name}}
{{ausdruck}}TemplateErgebnis eines JavaScript-Ausdrucks; Fehler ergibt leeren TextAusdrücke
{{bg.type}}, {{bg.value}}, {{bg.value.url}}, {{bg.parallax}}TemplateFelder des Hintergrund-WidgetsObjektfelder
{{vn-id}}Template (auch im Skript)Kennung der Instanz (blk-… oder Anker-ID){{vn-id}}
{{vnEnc(text)}}Template, BedingungenencodeURIComponent für data--AttributevnEnc, Text-Daten in Attributen
{{vnEmbed(adresse)}}TemplateYouTube/Vimeo-Adresse zur Einbett-AdressevnEmbed
{{…}} in a.btnTemplatebleibt wörtlich stehenPlatzhalter in Buttons
@namestyle.lessWert des Felds als LESS-VariableVariablen
@bg-type, @bg-value, @bg-parallaxstyle.lessHintergrund-Variablen (nur mit Widget)Hintergrund-Variablen
@primaryColor, @mainFont, @display1Size …style.lessTheme-Variablen mit VorgabenTheme-Variablen
~"@{name}", e(@name)style.lessText ohne Anführungszeichen ausgebenWerte als Text ausgeben
{{secret:NAME}}, {{secret-php:NAME}}Dateien eines Export-BeitragsGeheimnis einsetzen (secret-php maskiert \, " und ab Version 1.3.100 auch $)secrets
{{mbr-id}}ältere Paketewie {{vn-id}}Ältere Schreibweisen

Attribute am Wurzelelement#

AttributWirkungEintrag
globalseitenweiter Block (nur am allerersten Element)global
onceGruppe des seitenweiten Blocks (menu, footers, eigener Name); ein neuer Block ersetzt den altenonce
pluginsPlugin-Ordner eines Bootstrap-4-Themesplugins
data-bs-versionkennzeichnet Bootstrap-5-Bausteinedata-bs-version
data-bg-videoAdresse des Hintergrundvideosdata-bg-video
vn-strict-ifstrenge vn-if im ganzen Blockvn-strict-if
id, classbleiben erhalten; Instanzklasse vn-imp-<alias>-<Kennung> kommt hinzuid und class, Bezeichner
group, always-top, not-draggable, position-absolute, data-app-selector, data-app-placeholder, data-toolbarwerden nicht ausgewertetgroup, Nicht ausgewertete Attribute

Paketdateien und params.json#

Dateien im ZIP#

DateiPflichtBedeutungEintrag
params.jsonjaName, Alias, Liste der Bausteineparams.json
components/<name>/template.htmljaMarkup und <vn-parameters>template.html
components/<name>/style.less (oder style.css)neinStil des Bausteinsstyle.less oder style.css
components/<name>/thumb.pngneinVorschau in der Auswahlthumb.png
components/_images/neingemeinsame Bilder, Verweis ../_images/<datei>components/_images
plugins/theme/css/style.css, fonts/style.css, weitere plugins/**/*.cssneinTheme-CSS (einmal pro Projekt)Welche Dateien geladen werden
thumbnail.jpgneinVorschau in der Online-Galeriethumbnail.jpg
plugins/ (JavaScript)neinnur bei Bootstrap-4-Themesplugins/ und fonts/, Bootstrap-Modus

Felder der params.json#

FeldBedeutungEintrag
nameAnzeigename des Paketsparams.json
aliasKennung des Pakets; bildet Alias und Klasseparams.json, Bezeichner
titlebestimmt die Kennung des Theme-CSSNur einmal pro Projekt
components[].pathOrdner des Bausteins (Pflicht)params.json
components[]._title, _groupAnzeigename, Gruppeparams.json
components[]._oncenur Anzeige „· site-weit“params.json
theme.settings[] (var, type, default, title, set)Theme-Variablen für LESSTheme-Eigenschaften
theme.customLESSLESS-Datei, deren CSS ans Theme-CSS kommtTheme-Eigenschaften
appScriptPaket mit appScript ohne components wird abgelehntparams.json

manifest.json einer Erweiterung#

FeldBedeutungEintrag
idPflicht; 2 bis 48 Zeichen; nie ändernmanifest.json
name, name_<sprache>Name der Kachelmanifest.json
description, description_<sprache>Beschreibungmanifest.json
versionAnzeige und Update-Vergleichmanifest.json
iconKürzel im Symbol der Kachelmanifest.json
authorAutormanifest.json
mainProgrammdatei (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.

EintragKurzbeschreibungEintrag
ctx.projectDirOrdner des geöffneten Projekts oder nullDie Schnittstelle ctx
ctx.getPages(), ctx.getGlobalBlocks()Seiten und seitenweite Blöcke (Arbeitsobjekte, nur lesen)Die Schnittstelle ctx
ctx.switchToPage(id)zur Seite wechselnDie Schnittstelle ctx
ctx.askConfirm(text)Bestätigungsdialog, liefert true/falsectx.askConfirm
ctx.openToolWindow(titel, element, opts)Werkzeugfenster öffnenctx.openToolWindow
ctx.closeToolWindow()Werkzeugfenster schließenctx.closeToolWindow
ctx.extension{ id, version, baseUrl } der ErweiterungDie Schnittstelle ctx
ctx.project.getInfo()Kopie der ProjektdatengetInfo
ctx.project.buildFiles()fertige Seiten im Speicher bauenbuildFiles
ctx.project.updatePage(id, patch)Felder einer Seite ändernupdatePage
ctx.project.updateSite(patch)Website-Einstellungen ändernupdateSite
ctx.project.getGlobalHtml(), setGlobalHtml(patch)Globale HTML-EinfügungengetGlobalHtml und setGlobalHtml
ctx.project.listImages(), setImageAlt(…)Bilder mit Alt-Text lesen und setzenlistImages und setImageAlt
ctx.project.assetSizes(pfade)Dateigrößen unter assets/ und publish/assetSizes
ctx.project.addPage(opts)Seite mit einem HTML-Block anlegenaddPage
ctx.project.newEmptyPage(opts)leere Seite anlegen und dorthin wechselnnewEmptyPage
ctx.project.findInBlocks(muster)Muster im HTML und CSS aller Blöcke suchenfindInBlocks
ctx.project.selectBlock(…), showPage(id), canvas()Block wählen, Seite zeigen, Arbeitsfläche lesenselectBlock und showPage
ctx.project.colorUsage(), replaceColors(map, opts)einstellbare Farben listen und ersetzencolorUsage und replaceColors
ctx.project.settings.get(), set(obj)Einstellungen der Erweiterung im Projektsettings
ctx.project.exportContribution.get(), set(obj)Beitrag zum Export (head, bodyEnd, files)exportContribution
ctx.project.secrets.set(name, wert), names()Geheimnisse im Programm-Profilsecrets
ctx.project.ai.providers(), ask(…), openSettings(), speechProvider(), transcribe(…)KI-Zugänge nutzenctx.project.ai
ctx.blocks.importPackage(buffer, opts)Baustein-Paket importieren und einfügenimportPackage
ctx.blocks.importToLibrary(buffer)Paket in die Bibliothek legenimportToLibrary
ctx.blocks.findByAlias(alias), setValues(id, patch)Blöcke eines Bausteins finden, Werte setzenfindByAlias und setValues
ctx.blocks.describe(id), selected(), pageBlocks()Eigenschaften und Blöcke beschreibendescribe, selected, pageBlocks
ctx.blocks.catalog(), addFromCatalog(key, opts)einfügbare Bausteine listen und einfügencatalog und addFromCatalog
ctx.blocks.texts.list(), set(einträge)bearbeitbare Texte lesen und schreibenctx.blocks.texts
ctx.blocks.images.list(), set(einträge)Bildplätze lesen und setzenctx.blocks.images
ctx.blocks.addBlock, findGalleries, updateGallery, anim.*Schnittstellen der eingebauten WerkzeugeWeitere 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).

BibliothekOrdnerAuslöser im ExportEintrag
Bootstrap 5.0.1 (CSS und Bundle-JS)vendor/bootstrap.min.css, vendor/bootstrap.bundle.min.jsimmer (außer Bootstrap-Modus „aus dem Theme“)Bootstrap 5.0.1 und Bootstrap Icons
Bootstrap Iconsvendor/bootstrap-icons/immerBootstrap 5.0.1 und Bootstrap Icons
Flaggenvendor/flagsals Projektdateien unter assets/Eigene SVG-Symbole und Flaggen
jQuery 3.5.1vendor/jquery.min.jsnur Bootstrap-Modus „aus dem Theme“jQuery und Theme-Plugins
VN Lightboxvendor/vn-lightbox/SeiteneinstellungVN Lightbox, Lightbox
VN Cookie-Consentvendor/vn-cookie-consent/SeiteneinstellungVN Cookie-Consent, Cookie-Consent und Datenschutz
VN Popupvendor/vn-popup/Seite enthält ein PopupVN Popup, Popup
VN CMSvendor/vn-cms/Seite enthält einen CMS-BlockVN CMS, CMS
VN Untermenüvendor/vn-submenu/li.vn-submenu im HTMLVN Untermenü
VN Tooltipvendor/vn-tooltip/span.vn-tip im HTMLVN Tooltip
VN Videovendor/vn-video/video.vn-video-el im HTMLSelbst gehostetes Video
VN Hintergrundvideovendor/vn-bgvideo/data-bg-video mit Wert oder .vn-bgvidVideo-Hintergrund
VN Übersetzervendor/vn-translate/SeiteneinstellungVN Übersetzer, Übersetzer
VN WhatsAppvendor/vn-whatsapp/Seiteneinstellung (mit Nummer)VN WhatsApp
VN Formular, Form Renderervendor/vn-sform/, vendor/vn-formrender/form.vn-sform-form oder Form-Renderer-BlockFormulare, Export-Verhalten
VN PDF-Betrachter (PDF.js 3.11.174)vendor/vn-pdf-viewer/Block mit Betrachter-AdressePDF
VN Suche, VN Blogvendor/vn-search/, vendor/vn-blog/jeweilige BlöckeSuche, Blog
jszip, less, CodeMirrorvendor/nur im Editor, nie im ExportMitgelieferte 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#

NameBedeutungEintrag
block.values[<feld>]Werte der EingabefelderWie Werte ins Template und ins LESS gelangen
block.anchorId, block.popup, block.cmsAnker-ID, Popup- und CMS-EinstellungenAutomatische Bereiche, Einstellungen, Einschalten
_textScalePct, _textWidthPct, _textOffsetYPxRegler für Textgröße, -breite, -positionGröße, Breite und Position pro Block
_menuFontPx, _brandFontPx, _togglerColor, _ddBg, _ddText, _ddHoverBg, _ddHoverTextRegler eines Menü-BlocksRegler eines Menü-Blocks
_videoUrl<i>, _videoAuto<i>, _videoLoop<i>Video-Adresse, Autostart, Wiederholen je vn-video-BehälterVideo-Behälter vn-video
textOverrides, textTagOverrides, textLinkOverrides, textAlignOverridesÄnderungen an TextenÜberblick
buttonOverrides, iconOverrides, navIconOverridesÄnderungen an Buttons und SymbolenWerte eines Buttons, Werte eines Symbols
imageOverrides, imageLinkOverrides, imageAltOverrides, animOverridesÄnderungen an Bildern und AnimationenAlt-Text, Titel und Link, Animationen
schemaEntry.builder, schemaEntry.freeSurfaceDatenmodell von Baukasten und Freier FlächeDas gespeicherte Datenmodell, Freie Fläche