WebComponents/Avatar~AvatarElement()

Gestion de la balise bnum-avatar.

new AvatarElement()

La balise bnum-avatar permet de charger l'avatar de l'utilisateur en cours ou d'un utilisateur du bnum. Le chargement des avatars se fait après le chargement de la page. On peut néanmoins le forcer avec le data `data-forceload`. Les évènements sont api:imgload et api:imgloaderror. Liste des data : data-email => email de l'utilisateur dont on souhaite l'avatar. Si indéfini, se sera l'utilisateur en cours. (Optionnel) data-force-size => taille de l'objet, en pourcentage. (Optionnel) data-f100 => Equivalent de `data-force-size=100` data-forceload => Force le chargement de l'image
Tutorials:

Extends

Members

readonly $ :external:jQuery

Cet element en jQuery
Overrides:

package _email :string

Email qui permettra de retrouver l'avatar de l'utilisateur

package _force :string|number|null

Taille (de 0 à 100) de la balise. Si null, ça sera le css qui s'en chargera.
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.
Overrides:
See:

onimgload :BnumEvent:.<module:WebComponents/Avatar~OnImageLoadCallback:>

Action à faire lorsque l'image est chargée.

onimgloaderror :BnumEvent:.<module:WebComponents/Avatar~OnImageNotLoadCallback:>

Action à faire lorsque l'image n'a pas réussie à être chargée.

static, readonly IsLoaded :boolean

Si la page a été chargé et les avatars aussi.

Methods

package _get_style_force() → {string}

Récupère le block de style lié au forcage de la taille
Returns:
string

package _on_error() → {module:WebComponents/Avatar~AvatarElement}

Est appelé lorsque l'image ne se charge pas

package _on_load() → {module:WebComponents/Avatar~AvatarElement}

Appelé lorsque l'image est chargée.

protected _p_main()

Est appelé par le navigateur.
Overrides:

protected _p_start_construct() → {ShadowRoot|this}

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

addClass(…classes) → {this}

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

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.
Overrides:
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
Overrides:

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.
Overrides:

destroy() → {this}

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

disable(param0opt)

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

disconnectedCallback()

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

hasClass(className) → {boolean}

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

removeClass(className) → {this}

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

shadowEnabled() → {boolean}

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

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é.
Overrides:

toButton(node)

Parameters:
Name Type Description
node HTMLElement
Overrides:

update_img()

Met la bonne url à l'image.

static Create(param0) → {module:WebComponents/Avatar~AvatarElement}

Parameters:
Name Type Description
param0 *