abstract WebComponents/Base~HtmlCustomTag(paramopt)

Classse de base pour les Webcomposants.

new abstract HtmlCustomTag(paramopt)

Le shadow-dom est complètement optionnel et doit être voulu par "data-shadow=true". Si le shadow dom est activé, c'est le composant qui doit gérer son style et son affichage. Contient diverses fonctions utiles, les webcomposants doivent hériter de cette classe.
Parameters:
Name Type Attributes Default Description
param Object <optional>
{} Paramètres optionnes pour les enfants de cette classe.
Properties
Name Type Attributes Default Description
mode module:WebComponents/Base~EWebComponentMode <optional>
EWebComponentMode.span Mode du composant, cad son type d'affichage par défaut.
See:

Extends

  • HTMLElement

Members

readonly $ :external:jQuery

Cet element en jQuery
Element sur lequel on doit ajouter des nodes enfants. Si le shadow dom est activé, ils seront ajoutés au shadow root, sinon à ce composant.
See:

protected, static, nullable _p_text_callback :LocalizationCallback

Callback servant à traduire un texte.

Methods

protected _p_main() → {this}

Doit être surchargée par les classe fille. C'est ici que les instructions de setup doivent être mises.
Returns:
this - Chaîne

protected _p_start_construct() → {ShadowRoot|this}

Créer un shadoroot si le shadow dom est activé. Sinon, renvoie `this`.
Returns:
ShadowRoot | this

addClass(…classes) → {this}

Ajoute une ou plusieurs classe(s).
Parameters:
Name Type Attributes Description
classes string <repeatable>
Classe(s) à ajouter.
Returns:
this - Chaîne

connectedCallback()

Est appelé par le navigateur lorsque le composant est affiché. Gère dans un premier temps le mode puis appèle le setup enfant.
See:
  • _p_main

createText(text) → {Text}

Créer une node de texte
Parameters:
Name Type Description
text string Texte à mettre dans la node.
Returns:
Text

data(key, valueopt, nullable) → {module:WebComponents/Base~HtmlCustomTag|any}

Récupère une donnée "data" de l'élement. Si la valeur n'est pas défini, retourne la valeur du "data".
Parameters:
Name Type Attributes Default Description
key string Clé de la data
value any <optional>
<nullable>
null Valeur de la donnée. Si null, retourne la donnée.

destroy() → {this}

Libère les données.
Returns:
this - Chaîne

disable(param0opt)

Parameters:
Name Type Attributes Default Description
param0 Object <optional>
{}
Properties
Name Type Attributes Default Description
node HTMLElement <optional>
<nullable>
null
Returns:

disconnectedCallback()

Est appelé lorsque le composant est détruit. Permet de libérer des données.
See:
  • destroy

hasClass(className) → {boolean}

Vérfie si l'élement à une certaine classe.
Parameters:
Name Type Description
className string Classe à tester
Returns:
boolean

removeClass(className) → {this}

Supprime une classe de l'élément
Parameters:
Name Type Description
className string Classe à supprimer
Returns:
this - Chaîne

shadowEnabled() → {boolean}

Vérifie si le shadow-dom est activé ou non.
Returns:
boolean

text(text) → {string}

Récupère un texte via une fonction de localisation, si elle existe.
Parameters:
Name Type Description
text string Texte à afficher/à traduire
Returns:
string - Si la fonction de localisation n'existe pas, le texte initial sera renvoyé.

toButton(node)

Parameters:
Name Type Description
node HTMLElement

static SetTextCallback(callback)

Assigne la fonction de callback pour l'application.
Parameters:
Name Type Description
callback LocalizationCallback Fonction qui sert à traduire un texte, le texte peut être un mot clé.