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 type | Champ dans le panneau | Valeur dans le modèle | Valeur dans le LESS | Entrée |
|---|---|---|---|---|
input type="text" (aussi tout type inconnu) | champ de texte | texte | texte entre guillemets | text, Autres types |
textarea | champ de texte multiligne | texte avec sauts de ligne | texte entre guillemets | textarea |
input type="checkbox" | interrupteur | true ou false | true ou false | checkbox |
input type="color" | sélecteur de couleur | texte #rrggbb | couleur | color |
input type="range" | curseur avec champ numérique | texte ("4") | nombre | range |
select avec option | liste de choix | texte (value de l'option) | texte entre guillemets | select et option |
input type="image" | champ d'image | texte (adresse de l'image) | texte entre guillemets | image |
fieldset avec image, color, video | widget d'arrière-plan | objet { type, value, parallax } | @bg-type, @bg-value, @bg-parallax | fieldset (widget d'arrière-plan), Variables d'arrière-plan |
input type="video" (seulement dans le fieldset) | vidéo comme troisième type du widget | bg.value.url | @bg-value | video |
header | titre d'un groupe | – | – | header |
Champs de texte nommés videoFile, videoFile2, subtitleFile | champ de texte avec « Choisir un fichier… » | texte | texte | Champs de fichier et de vidéo |
Attributs des champs de saisie#
| Attribut | S'applique à | Signification | Entrée |
|---|---|---|---|
name | tous les champs | nom de la valeur : identificateur JavaScript et variable LESS @name ; lettres, chiffres, trait de soulignement, commence par une lettre | name |
title | tous les champs | libellé dans le panneau (sans : le nom) | title |
value | text, color, range, image, saisies du widget | valeur par défaut | value, Valeurs par défaut |
checked | checkbox | valeur par défaut « activé » | checked |
min, max, step | range | plage et pas (0, 100, 1) | min, max, step |
rows | textarea | hauteur 2 à 30 (par défaut 5) | rows |
selected | option, saisies du widget | valeur par défaut de la sélection ou du type d'arrière-plan | selected |
parallax | input type="image" dans le fieldset | interrupteur de parallaxe activé d'office | fieldset (widget d'arrière-plan) |
condition | header, champs, fieldset | n'afficher le champ que tant que l'expression ne donne pas exactement false | condition |
inline | range | n'est pas évalué | inline |
type="background" | fieldset | n'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#
| Nom | Valeur | Effet | Entrée |
|---|---|---|---|
vn-if | expression | retire l'élément pour exactement false | vn-if |
vn-strict-if | interrupteur | retirer tous les vn-if du bloc pour toute valeur fausse | vn-strict-if |
vn-class | objet, liste ou texte | ajouter des classes sous condition | vn-class |
vn-style | objet | poser des styles en ligne sous condition (pas de --variables) | vn-style |
vn-theme-style | classes | compléter les classes des propriétés du thème | vn-theme-style |
Classe vn-overlay avec opacity, bg-color | nombre de 0 à 1, couleur | surface d'assombrissement (position:absolute; inset:0) | vn-overlay |
vn-buttons, vn-menu | interrupteur | marqueur pour la cible de vn-theme-style | vn-buttons, vn-menu |
vn-video, data-vn-video-empty | interrupteur | conteneur vidéo avec champ d'adresse dans le panneau | vn-video, L'élément vn-video |
vn-article, data-multiline | interrupteur | liste (ou div) comme un seul champ de texte avec saisie par lignes | vn-article, Champs de liste : data-multiline et vn-article |
data-vn-icon | interrupteur | marquer l'élément comme icône modifiable | data-vn-icon, data-vn-icon |
vn-parameters | bloc | champs 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#
| Marqueur | Emplacement | Effet | Entrée |
|---|---|---|---|
data-bg-video | élément racine | adresse d'une vidéo d'arrière-plan | data-bg-video, Arrière-plan vidéo |
data-vn-editor-only | n'importe quel élément | visible seulement dans l'éditeur, retiré dans l'export | Marqueur data-vn-editor-only |
data-vn-popup-close | élément dans le popup | ferme le popup | Fermer depuis le contenu : data-vn-popup-close |
data-vn-consent-category | iframe, script | bloque jusqu'au consentement à functional, statistics ou marketing | data-vn-consent-category, Blocage automatique |
data-vn-cookie-settings | a | ouvre les réglages des cookies | Ouvrir les réglages des cookies |
data-vn-anim, data-vn-anim-t | texte, image | animation (posée par l'outil VN Animation) | data-vn-anim et data-vn-anim-t, Animations : VN Animation |
data-vn-drag, -x, -y, -size | image d'une scène | calque déplaçable à la souris, avec des noms de champs pour la position et la taille | Glisser des calques : data-vn-drag |
Classe vn-zoom, vn-nozoom ; data-vn-skip, -caption, -full, -group, -badge | image, conteneur | Lightbox | Marqueurs |
Classe vn-ic, vn-ic-svg ; data-vn-svg, data-vn-svg-mode | icône dans le texte | icône de texte modifiable, SVG propre | Icônes dans le texte |
Classe vn-tip, vn-tip-plain ; data-vn-tip-html, -bg, -fg, -trigger | mot dans le texte | info-bulle | Info-bulles sur des mots |
Classe notranslate | élément | exclure du VN Traducteur | Marquer des exceptions |
li.vn-submenu, a.vn-submenu-toggle, ul.vn-submenu-list | menu | sous-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-plan | Le bloc « Arrière-plan vidéo » (vn-bgvid) |
data-position="top" | <script type="text/x-vn-php"> | code PHP au début du fichier | Rapport avec l’éditeur de code, Intégration des textes et des personnalisations |
type="text/x-vn-php" | script | code 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).
| Marqueur | Posé sur | Entrée |
|---|---|---|
data-vn-text-id="tN" | textes modifiables | data-vn-text-id |
data-vn-image-key="feld" | images de champ d'image et racine avec widget | Champ d’image : data-vn-image-key |
data-vn-free-image-id="fiN" | images fixes | Image libre : data-vn-free-image-id |
data-vn-button-id="btnN", data-vn-btn-extra-classes | a.btn | a.btn |
data-vn-icon-id="iconN", data-vn-icon-extra-classes | icônes | data-vn-icon |
data-vn-nav-icon | icône devant/derrière un élément de menu | Icône devant l’élément de menu |
data-vn-cms-block, data-vn-cms, data-vn-cms-img, data-vn-cms-link | export avec CMS | Marquages dans le HTML terminé |
data-vn-cc-src, data-vn-cc-category, classe vn-cc-gate | intégrations bloquées dans l'export | Blocage automatique |
data-vn-sform-ready, data-vnfr-pending, data-vnfr-rendered, data-vntabelle-ready | scripts de formulaire et de tableau | L'élément form : attributs data, Le bloc Form Renderer, CSV et XLSX en tableau : VN Table |
Marqueurs des formulaires, PDF, recherche, tableau#
| Marqueur | Effet | Entré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-status | formulaire statique | Structure de base, Types de champs |
data-recipient, data-subject, data-success, data-thankyou, data-mailer | réglages sur le form | L'élément form : attributs data |
style="--span:N" | largeur du champ (12 colonnes) | Grille : --span |
data-vn-captcha-q, -answer, -token, data-vn-copytosender | question de sécurité, copie à l'expéditeur | Question de sécurité mathématique, Copie à l'expéditeur |
section.vn-formrender, .vnfr-data[data-…], .vnfr-out | bloc Form Renderer | Le bloc Form Renderer |
iframe[data-vn-pdf-src] | visionneuse PDF | |
data-vntabelle-root, th[data-vnsort], td[data-label] | VN Table | CSV et XLSX en tableau : VN Table |
section.vn-search, .vns-data[data-…] | VN Recherche | Recherche : VN Recherche |
video.vn-video-el avec data-start, -end, -rate, -volume, -viewplay, -exclusive, -lazy, -player | vidéo auto-hébergée | Vidéo auto-hébergée : le bloc « Vidéo » |
vn-galerie-host, .vn-gal-wrap, .vn-gal-grid … | VN Galerie | Galerie : VN Galerie |
Espaces réservés et variables#
| Forme | Emplacement | Résultat | Entrée |
|---|---|---|---|
{{name}} | modèle (texte, attributs, script, style) | valeur du champ, sans masquage, comme HTML | {{name}} |
{{ausdruck}} | modèle | résultat d'une expression JavaScript ; une erreur donne un texte vide | Expressions |
{{bg.type}}, {{bg.value}}, {{bg.value.url}}, {{bg.parallax}} | modèle | champs du widget d'arrière-plan | Champs 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, conditions | encodeURIComponent pour les attributs data- | vnEnc(texte), Données de texte dans des attributs : vnEnc |
{{vnEmbed(adresse)}} | modèle | adresse YouTube/Vimeo vers l'adresse d'intégration | vnEmbed(adresse) |
{{…}} dans a.btn | modèle | reste tel quel | Espaces réservés dans les boutons |
@name | style.less | valeur du champ comme variable LESS | Variables issues des propriétés |
@bg-type, @bg-value, @bg-parallax | style.less | variables d'arrière-plan (seulement avec widget) | Variables d'arrière-plan |
@primaryColor, @mainFont, @display1Size … | style.less | variables de thème avec valeurs par défaut | Variables de thème |
~"@{name}", e(@name) | style.less | produire le texte sans guillemets | Sortir des valeurs comme texte en CSS |
{{secret:NAME}}, {{secret-php:NAME}} | fichiers d'une contribution à l'export | insérer le secret (secret-php masque \, " et, à partir de la version 1.3.100, aussi $) | secrets |
{{mbr-id}} | anciens paquets | comme {{vn-id}} | Anciennes notations |
Attributs de l'élément racine#
| Attribut | Effet | Entrée |
|---|---|---|
global | bloc valable pour tout le site (seulement sur le tout premier élément) | global |
once | groupe du bloc valable pour tout le site (menu, footers, nom propre) ; un nouveau bloc remplace l'ancien | once |
plugins | dossier de plugins d'un thème Bootstrap 4 | plugins |
data-bs-version | marque les blocs Bootstrap 5 | data-bs-version |
data-bg-video | adresse de la vidéo d'arrière-plan | data-bg-video |
vn-strict-if | vn-if stricts dans tout le bloc | vn-strict-if |
id, class | sont conservés ; la classe d'instance vn-imp-<alias>-<identifiant> s'y ajoute | id et class, Identifiants : alias, étiquette, groupe |
group, always-top, not-draggable, position-absolute, data-app-selector, data-app-placeholder, data-toolbar | ne sont pas évalués | group, Attributs non évalués |
Fichiers du paquet et params.json#
Fichiers dans le ZIP#
| Fichier | Obligatoire | Signification | Entrée |
|---|---|---|---|
params.json | oui | nom, alias, liste des blocs | params.json |
components/<name>/template.html | oui | balisage et <vn-parameters> | template.html |
components/<name>/style.less (ou style.css) | non | style du bloc | style.less ou style.css |
components/<name>/thumb.png | non | aperçu dans la sélection | thumb.png |
components/_images/ | non | images communes, renvoi ../_images/<fichier> | components/_images |
plugins/theme/css/style.css, fonts/style.css, autres plugins/**/*.css | non | CSS du thème (une fois par projet) | Quels fichiers sont chargés |
thumbnail.jpg | non | aperçu dans la galerie en ligne | thumbnail.jpg et l'aperçu de la galerie |
plugins/ (JavaScript) | non | seulement pour les thèmes Bootstrap 4 | plugins/ et fonts/, Attributs Bootstrap et mode Bootstrap |
Champs de params.json#
| Champ | Signification | Entrée |
|---|---|---|
name | nom affiché du paquet | params.json |
alias | identifiant du paquet ; forme l'alias et la classe | params.json, Identifiants : alias, étiquette, groupe |
title | détermine l'identifiant du CSS du thème | Une seule fois par projet |
components[].path | dossier du bloc (obligatoire) | params.json |
components[]._title, _group | nom affiché, groupe | params.json |
components[]._once | seulement l'affichage « · à l'échelle du site » | params.json |
theme.settings[] (var, type, default, title, set) | variables de thème pour le LESS | Propriétés du thème (params.theme) |
theme.customLESS | fichier LESS dont le CSS s'ajoute au CSS du thème | Propriétés du thème (params.theme) |
appScript | un paquet avec appScript sans components est refusé | params.json |
manifest.json d'une extension#
| Champ | Signification | Entrée |
|---|---|---|
id | obligatoire ; 2 à 48 caractères ; ne jamais modifier | manifest.json |
name, name_<langue> | nom de la tuile | manifest.json |
description, description_<langue> | description | manifest.json |
version | affichage et comparaison de mise à jour | manifest.json |
icon | abréviation dans le symbole de la tuile | manifest.json |
author | auteur | manifest.json |
main | fichier 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ée | Brève description | Entrée |
|---|---|---|
ctx.projectDir | dossier du projet ouvert ou null | L'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 page | L'interface ctx |
ctx.askConfirm(text) | boîte de dialogue de confirmation, renvoie true/false | ctx.askConfirm |
ctx.openToolWindow(titel, element, opts) | ouvrir une fenêtre d'outil | ctx.openToolWindow |
ctx.closeToolWindow() | fermer la fenêtre d'outil | ctx.closeToolWindow |
ctx.extension | { id, version, baseUrl } de l'extension | L'interface ctx |
ctx.project.getInfo() | copie des données du projet | getInfo |
ctx.project.buildFiles() | construire les pages terminées en mémoire | buildFiles |
ctx.project.updatePage(id, patch) | modifier des champs d'une page | updatePage |
ctx.project.updateSite(patch) | modifier les paramètres du site web | updateSite |
ctx.project.getGlobalHtml(), setGlobalHtml(patch) | insertions HTML globales | getGlobalHtml et setGlobalHtml |
ctx.project.listImages(), setImageAlt(…) | lire et définir les images avec leur texte alternatif | listImages 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 HTML | addPage |
ctx.project.newEmptyPage(opts) | créer une page vide et y passer | newEmptyPage |
ctx.project.findInBlocks(muster) | chercher un motif dans le HTML et le CSS de tous les blocs | findInBlocks |
ctx.project.selectBlock(…), showPage(id), canvas() | choisir un bloc, afficher une page, lire la zone de travail | selectBlock et showPage |
ctx.project.colorUsage(), replaceColors(map, opts) | lister et remplacer les couleurs réglables | colorUsage et replaceColors |
ctx.project.settings.get(), set(obj) | réglages de l'extension dans le projet | settings |
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 programme | secrets |
ctx.project.ai.providers(), ask(…), openSettings(), speechProvider(), transcribe(…) | utiliser les accès IA | ctx.project.ai |
ctx.blocks.importPackage(buffer, opts) | importer et insérer un paquet de blocs | importPackage |
ctx.blocks.importToLibrary(buffer) | placer un paquet dans la bibliothèque | importToLibrary |
ctx.blocks.findByAlias(alias), setValues(id, patch) | trouver les blocs issus d'un bloc de bibliothèque, définir des valeurs | findByAlias et setValues |
ctx.blocks.describe(id), selected(), pageBlocks() | décrire les propriétés et les blocs | describe, selected, pageBlocks |
ctx.blocks.catalog(), addFromCatalog(key, opts) | lister et insérer les blocs insérables | catalog et addFromCatalog |
ctx.blocks.texts.list(), set(einträge) | lire et écrire les textes modifiables | ctx.blocks.texts |
ctx.blocks.images.list(), set(einträge) | lire et définir les emplacements d'image | ctx.blocks.images |
ctx.blocks.addBlock, findGalleries, updateGallery, anim.* | interfaces des outils intégrés | Autres 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èque | Dossier | Déclencheur dans l'export | Entrée |
|---|---|---|---|
| Bootstrap 5.0.1 (CSS et JS bundle) | vendor/bootstrap.min.css, vendor/bootstrap.bundle.min.js | toujours (sauf mode Bootstrap « depuis le thème ») | Bootstrap 5.0.1 et Bootstrap Icons |
| Bootstrap Icons | vendor/bootstrap-icons/ | toujours | Bootstrap 5.0.1 et Bootstrap Icons |
| Drapeaux | vendor/flags | comme fichiers de projet sous assets/ | SVG personnalisés et drapeaux |
| jQuery 3.5.1 | vendor/jquery.min.js | seulement mode Bootstrap « depuis le thème » | jQuery et plugins de thème (mode thème Bootstrap) |
| VN Lightbox | vendor/vn-lightbox/ | paramètre de la page | VN Lightbox, Lightbox |
| VN Consentement aux cookies | vendor/vn-cookie-consent/ | paramètre de la page | VN Consentement aux cookies, Consentement aux cookies et protection des données |
| VN Popup | vendor/vn-popup/ | la page contient un popup | VN Popup, Popup |
| VN CMS | vendor/vn-cms/ | la page contient un bloc CMS | VN CMS, CMS : textes et images sur la page terminée |
| VN Sous-menu | vendor/vn-submenu/ | li.vn-submenu dans le HTML | VN Sous-menu |
| VN Tooltip | vendor/vn-tooltip/ | span.vn-tip dans le HTML | VN Tooltip |
| VN Vidéo | vendor/vn-video/ | video.vn-video-el dans le HTML | Vidéo auto-hébergée : le bloc « Vidéo » |
| VN Vidéo d'arrière-plan | vendor/vn-bgvideo/ | data-bg-video avec une valeur ou .vn-bgvid | Arrière-plan vidéo |
| VN Traducteur | vendor/vn-translate/ | paramètre de la page | VN Traducteur, Traducteur : VN Traducteur |
| VN WhatsApp | vendor/vn-whatsapp/ | paramètre de la page (avec numéro) | VN WhatsApp |
| VN Formulaire, Form Renderer | vendor/vn-sform/, vendor/vn-formrender/ | form.vn-sform-form ou bloc Form Renderer | Vue d'ensemble, Comportement de l'export |
| VN Visionneuse PDF (PDF.js 3.11.174) | vendor/vn-pdf-viewer/ | bloc avec adresse de visionneuse | |
| VN Recherche, VN Blog | vendor/vn-search/, vendor/vn-blog/ | blocs respectifs | Recherche : VN Recherche, Blog : VN Blog |
| jszip, less, CodeMirror | vendor/ | seulement dans l'éditeur, jamais dans l'export | Bibliothè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#
| Nom | Signification | Entrée |
|---|---|---|
block.values[<feld>] | valeurs des champs de saisie | Comment les valeurs parviennent au modèle et au LESS |
block.anchorId, block.popup, block.cms | ID d'ancre, paramètres de popup et de CMS | Sections automatiques, Paramètres, Activation |
_textScalePct, _textWidthPct, _textOffsetYPx | curseurs pour la taille, la largeur et la position du texte | Taille, largeur et position par bloc |
_menuFontPx, _brandFontPx, _togglerColor, _ddBg, _ddText, _ddHoverBg, _ddHoverText | curseurs d'un bloc de menu | Curseurs d’un bloc de menu |
_videoUrl<i>, _videoAuto<i>, _videoLoop<i> | adresse vidéo, lecture automatique, répétition par conteneur vn-video | L'élément vn-video |
textOverrides, textTagOverrides, textLinkOverrides, textAlignOverrides | modifications des textes | Vue d’ensemble |
buttonOverrides, iconOverrides, navIconOverrides | modifications des boutons et des icônes | Valeurs d’un bouton, Valeurs d’une icône |
imageOverrides, imageLinkOverrides, imageAltOverrides, animOverrides | modifications des images et des animations | Texte alternatif, titre et lien, Animations : VN Animation |
schemaEntry.builder, schemaEntry.freeSurface | modèle de données du constructeur et de la surface libre | Le modèle de données enregistré, Surface libre |