MelTemplate~MelTemplate(destructuredopt)

Permet de générer du html en javascript à partir d'un template.

new MelTemplate(destructuredopt)
Roundcube-plugins-Mel/plugins/mel_metapage/js/lib/html/JsHtml/MelTemplate.js, line 14

Parameters:
Name Type Attributes Default Description
destructured Object <optional>
 {}
Properties
Name Type Attributes Default Description
templateSelector string <optional>
 '' Selecteur du template à traiter
data Object <optional>
 {} Liste de données à injecter dans le template sous la forme { key: value, key1: value1}
events Array:.<TemplateEvent:> <optional>
 [] Tableau d'événements à injecter dans le template sous la forme [ { target: target, type: type, listener: listener }, { target: target1, type: type1, listener: listener1 } ] avec target = selecteur
htmlContents Object <optional>
 {} Liste de html à injecter dans le template sous la forme { selector: html, selector1: html1}
regex RegExp <optional>
 /%%(\w*)%%/g Regex à utiliser pour remplacer les données dans le template
Tutorials:
  • Tutorial: js-template

Methods

package () → {HTMLElement}
Roundcube-plugins-Mel/plugins/mel_metapage/js/lib/html/JsHtml/MelTemplate.js, line 163

Génération d'un Node à partir du template et des données
Returns:
HTMLElement - Element généré pour le template, encapsulé dans un div

addData(key, value) → {module:MelTemplate~MelTemplate}
Roundcube-plugins-Mel/plugins/mel_metapage/js/lib/html/JsHtml/MelTemplate.js, line 117

Ajoute une nouvelle donnée à remplacer
Parameters:
Name Type Description
key string
value string
Returns:
module:MelTemplate~MelTemplate

addEvent(targetSelector, type, listener) → {module:MelTemplate~MelTemplate}
Roundcube-plugins-Mel/plugins/mel_metapage/js/lib/html/JsHtml/MelTemplate.js, line 88

Ajoute un événement dans le template
Parameters:
Name Type Description
targetSelector string Selecteur de l'élément sur lequel ajouter l'event
type string Type d'événement à écouter
listener function Callback à appeler lors de l'événement
Returns:
module:MelTemplate~MelTemplate

addHtml(selector, html) → {module:MelTemplate~MelTemplate}
Roundcube-plugins-Mel/plugins/mel_metapage/js/lib/html/JsHtml/MelTemplate.js, line 151

Ajoute du html dans un élément du template
Parameters:
Name Type Description
selector string Selecteur de l'élément dans lequel ajouter le html
html * Html à ajouter au format String, Node, NodeList, Object ou Array
Returns:
module:MelTemplate~MelTemplate

render() → {NodeListOf:.<ChildNode:>}
Roundcube-plugins-Mel/plugins/mel_metapage/js/lib/html/JsHtml/MelTemplate.js, line 196

Retourne le résultat du template traité au format NodeList
Returns:
NodeListOf:.<ChildNode:> - Liste des éléments générés

renderHtml() → {string}
Roundcube-plugins-Mel/plugins/mel_metapage/js/lib/html/JsHtml/MelTemplate.js, line 205

Retourne le résultat du template traité au format HTML
Returns:
string - Résultat du template traité au format HTML

setData(data) → {module:MelTemplate~MelTemplate}
Roundcube-plugins-Mel/plugins/mel_metapage/js/lib/html/JsHtml/MelTemplate.js, line 128

Défini une liste de données à remplacer
Parameters:
Name Type Description
data Object Liste de données à injecter dans le template sous la forme { key: value, key1: value1}
Returns:
module:MelTemplate~MelTemplate

setEvents(events) → {module:MelTemplate~MelTemplate}
Roundcube-plugins-Mel/plugins/mel_metapage/js/lib/html/JsHtml/MelTemplate.js, line 105

Défini une liste d'événements dans le template
Parameters:
Name Type Description
events Array:.<module:module:MelTemplate~MelTemplate~TemplateEvent:> Tableau d'événements à injecter dans le template sous la forme [ { target: target, type: type, listener: listener }, { target: target1, type: type1, listener: listener1 } ] avec target = selecteur
Returns:
module:MelTemplate~MelTemplate

setTemplateSelector(templateSelector) → {module:MelTemplate~MelTemplate}
Roundcube-plugins-Mel/plugins/mel_metapage/js/lib/html/JsHtml/MelTemplate.js, line 139

Défini le selecteur du template à traiter
Parameters:
Name Type Description
templateSelector string
Returns:
module:MelTemplate~MelTemplate