Documentation développeur VN-Designer
15

Référence rapide

Tableaux compacts à consulter : types de saisie et attributs, directives et marqueurs, espaces réservés et variables, attributs de l'élément racine, fichiers du paquet, manifest.json, toutes les fonctions ctx et les bibliothèques sous vendor/, chacun avec un lien vers l'entrée détaillée.

Types de saisie#

Tous les types se trouvent dans le bloc <vn-parameters> (chapitre Champs de saisie). Ce qui ne figure pas dans le tableau devient un champ de texte d'une seule ligne.

Balise et typeChamp dans le panneauValeur dans le modèleValeur dans le LESSEntrée
input type="text" (aussi tout type inconnu)champ de textetextetexte entre guillemetstext, Autres types
textareachamp de texte multilignetexte avec sauts de lignetexte entre guillemetstextarea
input type="checkbox"interrupteurtrue ou falsetrue ou falsecheckbox
input type="color"sélecteur de couleurtexte #rrggbbcouleurcolor
input type="range"curseur avec champ numériquetexte ("4")nombrerange
select avec optionliste de choixtexte (value de l'option)texte entre guillemetsselect et option
input type="image"champ d'imagetexte (adresse de l'image)texte entre guillemetsimage
fieldset avec image, color, videowidget d'arrière-planobjet { type, value, parallax }@bg-type, @bg-value, @bg-parallaxfieldset (widget d'arrière-plan), Variables d'arrière-plan
input type="video" (seulement dans le fieldset)vidéo comme troisième type du widgetbg.value.url@bg-valuevideo
headertitre d'un groupe––header
Champs de texte nommés videoFile, videoFile2, subtitleFilechamp de texte avec « Choisir un fichier… »textetexteChamps de fichier et de vidéo

Attributs des champs de saisie#

AttributS'applique àSignificationEntrée
nametous les champsnom de la valeur : identificateur JavaScript et variable LESS @name ; lettres, chiffres, trait de soulignement, commence par une lettrename
titletous les champslibellé dans le panneau (sans : le nom)title
valuetext, color, range, image, saisies du widgetvaleur par défautvalue, Valeurs par défaut
checkedcheckboxvaleur par défaut « activé »checked
min, max, steprangeplage et pas (0, 100, 1)min, max, step
rowstextareahauteur 2 à 30 (par défaut 5)rows
selectedoption, saisies du widgetvaleur par défaut de la sélection ou du type d'arrière-planselected
parallaxinput type="image" dans le fieldsetinterrupteur de parallaxe activé d'officefieldset (widget d'arrière-plan)
conditionheader, champs, fieldsetn'afficher le champ que tant que l'expression ne donne pas exactement falsecondition
inlinerangen'est pas évaluéinline
type="background"fieldsetn'est pas lu (convention d'écriture)fieldset (widget d'arrière-plan)

Noms réservés avec trait de soulignement au début et sections automatiques du panneau : Sections automatiques. Champs de superposition automatiques (overlay, overlayColor, overlayOpacity) : Champs de superposition automatiques.

Directives et marqueurs dans le modèle#

Directives#

NomValeurEffetEntrée
vn-ifexpressionretire l'élément pour exactement falsevn-if
vn-strict-ifinterrupteurretirer tous les vn-if du bloc pour toute valeur faussevn-strict-if
vn-classobjet, liste ou texteajouter des classes sous conditionvn-class
vn-styleobjetposer des styles en ligne sous condition (pas de --variables)vn-style
vn-theme-styleclassescompléter les classes des propriétés du thèmevn-theme-style
Classe vn-overlay avec opacity, bg-colornombre de 0 à 1, couleursurface d'assombrissement (position:absolute; inset:0)vn-overlay
vn-buttons, vn-menuinterrupteurmarqueur pour la cible de vn-theme-stylevn-buttons, vn-menu
vn-video, data-vn-video-emptyinterrupteurconteneur vidéo avec champ d'adresse dans le panneauvn-video, L'élément vn-video
vn-article, data-multilineinterrupteurliste (ou div) comme un seul champ de texte avec saisie par lignesvn-article, Champs de liste : data-multiline et vn-article
data-vn-iconinterrupteurmarquer l'élément comme icône modifiabledata-vn-icon, data-vn-icon
vn-parametersblocchamps de saisie (n'est pas produit en sortie)vn-parameters

Expressions et ordre d'évaluation : Expressions. Anciens noms (mbr-…) : Anciennes notations.

Autres marqueurs qu'un auteur écrit#

MarqueurEmplacementEffetEntrée
data-bg-videoélément racineadresse d'une vidéo d'arrière-plandata-bg-video, Arrière-plan vidéo
data-vn-editor-onlyn'importe quel élémentvisible seulement dans l'éditeur, retiré dans l'exportMarqueur data-vn-editor-only
data-vn-popup-closeélément dans le popupferme le popupFermer depuis le contenu : data-vn-popup-close
data-vn-consent-categoryiframe, scriptbloque jusqu'au consentement à functional, statistics ou marketingdata-vn-consent-category, Blocage automatique
data-vn-cookie-settingsaouvre les réglages des cookiesOuvrir les réglages des cookies
data-vn-anim, data-vn-anim-ttexte, imageanimation (posée par l'outil VN Animation)data-vn-anim et data-vn-anim-t, Animations : VN Animation
data-vn-drag, -x, -y, -sizeimage d'une scènecalque déplaçable à la souris, avec des noms de champs pour la position et la tailleGlisser des calques : data-vn-drag
Classe vn-zoom, vn-nozoom ; data-vn-skip, -caption, -full, -group, -badgeimage, conteneurLightboxMarqueurs
Classe vn-ic, vn-ic-svg ; data-vn-svg, data-vn-svg-modeicône dans le texteicône de texte modifiable, SVG propreIcônes dans le texte
Classe vn-tip, vn-tip-plain ; data-vn-tip-html, -bg, -fg, -triggermot dans le texteinfo-bulleInfo-bulles sur des mots
Classe notranslateélémentexclure du VN TraducteurMarquer des exceptions
li.vn-submenu, a.vn-submenu-toggle, ul.vn-submenu-listmenusous-menu qui se déploie sur le côtéSous-menu : vn-submenu
Classe vn-bgvid, vn-bgvid-el, vn-bgvid-poster …bloc « Arrière-plan vidéo »hero avec vidéo d'arrière-planLe bloc « Arrière-plan vidéo » (vn-bgvid)
data-position="top"<script type="text/x-vn-php">code PHP au début du fichierRapport avec l’éditeur de code, Intégration des textes et des personnalisations
type="text/x-vn-php"scriptcode PHP protégé (l'export l'insère tel quel)Code PHP protégé dans le texte, Comment le bloc intègre le PHP

Marqueurs posés par le programme#

Ne les écrivez pas vous-même ; ils apparaissent dans le modèle enregistré et disparaissent dans l'export (Marqueurs posés par le programme).

MarqueurPosé surEntrée
data-vn-text-id="tN"textes modifiablesdata-vn-text-id
data-vn-image-key="feld"images de champ d'image et racine avec widgetChamp d’image : data-vn-image-key
data-vn-free-image-id="fiN"images fixesImage libre : data-vn-free-image-id
data-vn-button-id="btnN", data-vn-btn-extra-classesa.btna.btn
data-vn-icon-id="iconN", data-vn-icon-extra-classesicônesdata-vn-icon
data-vn-nav-iconicône devant/derrière un élément de menuIcône devant l’élément de menu
data-vn-cms-block, data-vn-cms, data-vn-cms-img, data-vn-cms-linkexport avec CMSMarquages dans le HTML terminé
data-vn-cc-src, data-vn-cc-category, classe vn-cc-gateintégrations bloquées dans l'exportBlocage automatique
data-vn-sform-ready, data-vnfr-pending, data-vnfr-rendered, data-vntabelle-readyscripts de formulaire et de tableauL'élément form : attributs data, Le bloc Form Renderer, CSV et XLSX en tableau : VN Table

Marqueurs des formulaires, PDF, recherche, tableau#

MarqueurEffetEntrée
form.vn-sform-form, div.vn-sform-field[data-type], .vn-sform-label, div.vn-sform-hp, a[data-vn-sform-submit], .vn-sform-statusformulaire statiqueStructure de base, Types de champs
data-recipient, data-subject, data-success, data-thankyou, data-mailerréglages sur le formL'élément form : attributs data
style="--span:N"largeur du champ (12 colonnes)Grille : --span
data-vn-captcha-q, -answer, -token, data-vn-copytosenderquestion de sécurité, copie à l'expéditeurQuestion de sécurité mathématique, Copie à l'expéditeur
section.vn-formrender, .vnfr-data[data-…], .vnfr-outbloc Form RendererLe bloc Form Renderer
iframe[data-vn-pdf-src]visionneuse PDFPDF
data-vntabelle-root, th[data-vnsort], td[data-label]VN TableCSV et XLSX en tableau : VN Table
section.vn-search, .vns-data[data-…]VN RechercheRecherche : VN Recherche
video.vn-video-el avec data-start, -end, -rate, -volume, -viewplay, -exclusive, -lazy, -playervidéo auto-hébergéeVidéo auto-hébergée : le bloc « Vidéo »
vn-galerie-host, .vn-gal-wrap, .vn-gal-grid …VN GalerieGalerie : VN Galerie

Espaces réservés et variables#

FormeEmplacementRésultatEntrée
{{name}}modèle (texte, attributs, script, style)valeur du champ, sans masquage, comme HTML{{name}}
{{ausdruck}}modèlerésultat d'une expression JavaScript ; une erreur donne un texte videExpressions
{{bg.type}}, {{bg.value}}, {{bg.value.url}}, {{bg.parallax}}modèlechamps du widget d'arrière-planChamps d'objet
{{vn-id}}modèle (aussi dans le script)identifiant de l'instance (blk-… ou ID d'ancre){{vn-id}}
{{vnEnc(text)}}modèle, conditionsencodeURIComponent pour les attributs data-vnEnc(texte), Données de texte dans des attributs : vnEnc
{{vnEmbed(adresse)}}modèleadresse YouTube/Vimeo vers l'adresse d'intégrationvnEmbed(adresse)
{{…}} dans a.btnmodèlereste tel quelEspaces réservés dans les boutons
@namestyle.lessvaleur du champ comme variable LESSVariables issues des propriétés
@bg-type, @bg-value, @bg-parallaxstyle.lessvariables d'arrière-plan (seulement avec widget)Variables d'arrière-plan
@primaryColor, @mainFont, @display1Size …style.lessvariables de thème avec valeurs par défautVariables de thème
~"@{name}", e(@name)style.lessproduire le texte sans guillemetsSortir des valeurs comme texte en CSS
{{secret:NAME}}, {{secret-php:NAME}}fichiers d'une contribution à l'exportinsérer le secret (secret-php masque \, " et, à partir de la version 1.3.100, aussi $)secrets
{{mbr-id}}anciens paquetscomme {{vn-id}}Anciennes notations

Attributs de l'élément racine#

AttributEffetEntrée
globalbloc valable pour tout le site (seulement sur le tout premier élément)global
oncegroupe du bloc valable pour tout le site (menu, footers, nom propre) ; un nouveau bloc remplace l'ancienonce
pluginsdossier de plugins d'un thème Bootstrap 4plugins
data-bs-versionmarque les blocs Bootstrap 5data-bs-version
data-bg-videoadresse de la vidéo d'arrière-plandata-bg-video
vn-strict-ifvn-if stricts dans tout le blocvn-strict-if
id, classsont conservés ; la classe d'instance vn-imp-<alias>-<identifiant> s'y ajouteid et class, Identifiants : alias, étiquette, groupe
group, always-top, not-draggable, position-absolute, data-app-selector, data-app-placeholder, data-toolbarne sont pas évaluésgroup, Attributs non évalués

Fichiers du paquet et params.json#

Fichiers dans le ZIP#

FichierObligatoireSignificationEntrée
params.jsonouinom, alias, liste des blocsparams.json
components/<name>/template.htmlouibalisage et <vn-parameters>template.html
components/<name>/style.less (ou style.css)nonstyle du blocstyle.less ou style.css
components/<name>/thumb.pngnonaperçu dans la sélectionthumb.png
components/_images/nonimages communes, renvoi ../_images/<fichier>components/_images
plugins/theme/css/style.css, fonts/style.css, autres plugins/**/*.cssnonCSS du thème (une fois par projet)Quels fichiers sont chargés
thumbnail.jpgnonaperçu dans la galerie en lignethumbnail.jpg et l'aperçu de la galerie
plugins/ (JavaScript)nonseulement pour les thèmes Bootstrap 4plugins/ et fonts/, Attributs Bootstrap et mode Bootstrap

Champs de params.json#

ChampSignificationEntrée
namenom affiché du paquetparams.json
aliasidentifiant du paquet ; forme l'alias et la classeparams.json, Identifiants : alias, étiquette, groupe
titledétermine l'identifiant du CSS du thèmeUne seule fois par projet
components[].pathdossier du bloc (obligatoire)params.json
components[]._title, _groupnom affiché, groupeparams.json
components[]._onceseulement l'affichage « · à l'échelle du site »params.json
theme.settings[] (var, type, default, title, set)variables de thème pour le LESSPropriétés du thème (params.theme)
theme.customLESSfichier LESS dont le CSS s'ajoute au CSS du thèmePropriétés du thème (params.theme)
appScriptun paquet avec appScript sans components est refuséparams.json

manifest.json d'une extension#

ChampSignificationEntrée
idobligatoire ; 2 à 48 caractères ; ne jamais modifiermanifest.json
name, name_<langue>nom de la tuilemanifest.json
description, description_<langue>descriptionmanifest.json
versionaffichage et comparaison de mise à jourmanifest.json
iconabréviation dans le symbole de la tuilemanifest.json
authorauteurmanifest.json
mainfichier de programme (par défaut tool.js)manifest.json, tool.js

Autres fichiers d'une extension : Structure du paquet (payload.js, dom.js, style.css, *.vndext, thumbnail.jpg).

Interface du programme ctx#

Toutes les entrées se trouvent dans le chapitre Extensions.

EntréeBrève descriptionEntrée
ctx.projectDirdossier du projet ouvert ou nullL'interface ctx
ctx.getPages(), ctx.getGlobalBlocks()pages et blocs valables pour tout le site (objets de travail, lecture seule)L'interface ctx
ctx.switchToPage(id)passer à la pageL'interface ctx
ctx.askConfirm(text)boîte de dialogue de confirmation, renvoie true/falsectx.askConfirm
ctx.openToolWindow(titel, element, opts)ouvrir une fenêtre d'outilctx.openToolWindow
ctx.closeToolWindow()fermer la fenêtre d'outilctx.closeToolWindow
ctx.extension{ id, version, baseUrl } de l'extensionL'interface ctx
ctx.project.getInfo()copie des données du projetgetInfo
ctx.project.buildFiles()construire les pages terminées en mémoirebuildFiles
ctx.project.updatePage(id, patch)modifier des champs d'une pageupdatePage
ctx.project.updateSite(patch)modifier les paramètres du site webupdateSite
ctx.project.getGlobalHtml(), setGlobalHtml(patch)insertions HTML globalesgetGlobalHtml et setGlobalHtml
ctx.project.listImages(), setImageAlt(…)lire et définir les images avec leur texte alternatiflistImages et setImageAlt
ctx.project.assetSizes(pfade)tailles de fichiers sous assets/ et publish/assetSizes
ctx.project.addPage(opts)créer une page avec un bloc HTMLaddPage
ctx.project.newEmptyPage(opts)créer une page vide et y passernewEmptyPage
ctx.project.findInBlocks(muster)chercher un motif dans le HTML et le CSS de tous les blocsfindInBlocks
ctx.project.selectBlock(…), showPage(id), canvas()choisir un bloc, afficher une page, lire la zone de travailselectBlock et showPage
ctx.project.colorUsage(), replaceColors(map, opts)lister et remplacer les couleurs réglablescolorUsage et replaceColors
ctx.project.settings.get(), set(obj)réglages de l'extension dans le projetsettings
ctx.project.exportContribution.get(), set(obj)contribution à l'export (head, bodyEnd, files)exportContribution
ctx.project.secrets.set(name, wert), names()secrets dans le profil du programmesecrets
ctx.project.ai.providers(), ask(…), openSettings(), speechProvider(), transcribe(…)utiliser les accès IActx.project.ai
ctx.blocks.importPackage(buffer, opts)importer et insérer un paquet de blocsimportPackage
ctx.blocks.importToLibrary(buffer)placer un paquet dans la bibliothèqueimportToLibrary
ctx.blocks.findByAlias(alias), setValues(id, patch)trouver les blocs issus d'un bloc de bibliothèque, définir des valeursfindByAlias et setValues
ctx.blocks.describe(id), selected(), pageBlocks()décrire les propriétés et les blocsdescribe, selected, pageBlocks
ctx.blocks.catalog(), addFromCatalog(key, opts)lister et insérer les blocs insérablescatalog et addFromCatalog
ctx.blocks.texts.list(), set(einträge)lire et écrire les textes modifiablesctx.blocks.texts
ctx.blocks.images.list(), set(einträge)lire et définir les emplacements d'imagectx.blocks.images
ctx.blocks.addBlock, findGalleries, updateGallery, anim.*interfaces des outils intégrésAutres entrées de ctx.blocks
window.vnDesigner.*pont du programme (saveAsset, listAssetImages, openExternal, loadSmtpConfig, netCheckUrl …)L'interface ctx

Bibliothèques sous vendor/#

L'export ne copie que ce que les pages utilisent (Bibliothèques fournies, Fichiers d’exécution de vendor/).

BibliothèqueDossierDéclencheur dans l'exportEntrée
Bootstrap 5.0.1 (CSS et JS bundle)vendor/bootstrap.min.css, vendor/bootstrap.bundle.min.jstoujours (sauf mode Bootstrap « depuis le thème »)Bootstrap 5.0.1 et Bootstrap Icons
Bootstrap Iconsvendor/bootstrap-icons/toujoursBootstrap 5.0.1 et Bootstrap Icons
Drapeauxvendor/flagscomme fichiers de projet sous assets/SVG personnalisés et drapeaux
jQuery 3.5.1vendor/jquery.min.jsseulement mode Bootstrap « depuis le thème »jQuery et plugins de thème (mode thème Bootstrap)
VN Lightboxvendor/vn-lightbox/paramètre de la pageVN Lightbox, Lightbox
VN Consentement aux cookiesvendor/vn-cookie-consent/paramètre de la pageVN Consentement aux cookies, Consentement aux cookies et protection des données
VN Popupvendor/vn-popup/la page contient un popupVN Popup, Popup
VN CMSvendor/vn-cms/la page contient un bloc CMSVN CMS, CMS : textes et images sur la page terminée
VN Sous-menuvendor/vn-submenu/li.vn-submenu dans le HTMLVN Sous-menu
VN Tooltipvendor/vn-tooltip/span.vn-tip dans le HTMLVN Tooltip
VN Vidéovendor/vn-video/video.vn-video-el dans le HTMLVidéo auto-hébergée : le bloc « Vidéo »
VN Vidéo d'arrière-planvendor/vn-bgvideo/data-bg-video avec une valeur ou .vn-bgvidArrière-plan vidéo
VN Traducteurvendor/vn-translate/paramètre de la pageVN Traducteur, Traducteur : VN Traducteur
VN WhatsAppvendor/vn-whatsapp/paramètre de la page (avec numéro)VN WhatsApp
VN Formulaire, Form Renderervendor/vn-sform/, vendor/vn-formrender/form.vn-sform-form ou bloc Form RendererVue d'ensemble, Comportement de l'export
VN Visionneuse PDF (PDF.js 3.11.174)vendor/vn-pdf-viewer/bloc avec adresse de visionneusePDF
VN Recherche, VN Blogvendor/vn-search/, vendor/vn-blog/blocs respectifsRecherche : VN Recherche, Blog : VN Blog
jszip, less, CodeMirrorvendor/seulement dans l'éditeur, jamais dans l'exportBibliothèques fournies

Interfaces d'exécution de la page : window.vnCookieConsent avec getConsent(), openSettings(), labelGates() (Blocage propre au bloc (balisage de la barrière)) ; événements vn-cc-activated (Blocage propre au bloc (balisage de la barrière)) et vn-cc-consent (Événement vn-cc-consent) ; VNPopup.open(id), close(id), isOpen() (Interface JavaScript : VNPopup).

Valeurs de bloc et overrides#

NomSignificationEntrée
block.values[<feld>]valeurs des champs de saisieComment les valeurs parviennent au modèle et au LESS
block.anchorId, block.popup, block.cmsID d'ancre, paramètres de popup et de CMSSections automatiques, Paramètres, Activation
_textScalePct, _textWidthPct, _textOffsetYPxcurseurs pour la taille, la largeur et la position du texteTaille, largeur et position par bloc
_menuFontPx, _brandFontPx, _togglerColor, _ddBg, _ddText, _ddHoverBg, _ddHoverTextcurseurs d'un bloc de menuCurseurs d’un bloc de menu
_videoUrl<i>, _videoAuto<i>, _videoLoop<i>adresse vidéo, lecture automatique, répétition par conteneur vn-videoL'élément vn-video
textOverrides, textTagOverrides, textLinkOverrides, textAlignOverridesmodifications des textesVue d’ensemble
buttonOverrides, iconOverrides, navIconOverridesmodifications des boutons et des icônesValeurs d’un bouton, Valeurs d’une icône
imageOverrides, imageLinkOverrides, imageAltOverrides, animOverridesmodifications des images et des animationsTexte alternatif, titre et lien, Animations : VN Animation
schemaEntry.builder, schemaEntry.freeSurfacemodèle de données du constructeur et de la surface libreLe modèle de données enregistré, Surface libre