Bubble notifications

Bubble notifications est un système JavaScript développé dans le cadre de MediaWiki pour afficher des notifications sur une page Web.

Un exemple de notification

Fonctionnalités

• Notifications multiples : Il peut afficher plusieurs notifications en même temps. Chacun peut être fermé indépendamment.
• Fermeture automatique : Une notification peut être configurée pour se fermer automatiquement après une courte période. Ceci est activé par défaut, mais les fonctionnalités individuelles utilisant ce système peuvent choisir de le désactiver pour des notifications spécifiques si nécessaire.
• Marquage : Une notification peut éventuellement recevoir un nom (ou « tag »). Lorsqu'une nouvelle notification est créée avec le même nom qu'une notification plus ancienne qui est toujours active, la plus ancienne est remplacée par la nouvelle. Cela permet une expérience utilisateur améliorée où, autrement, des notifications anciennes, incomplètes ou dupliquées seraient visibles (exemples de cas d'utilisation)

API

Le point d'entrée pour les notifications par bulles est la méthode mw.notify(). Quelques exemples :

mw.notify( 'This is a notification.' ); // Send a plaintext notification
mw.notify( mw.message( 'some-message' ) ); // Use an i18n message to send a notification
mw.notify( $( '<span>This is an <u>HTML</u> notification.</span>' ) ); // Send an HTML notification with a jQuery instance (a DOM node also works)

mw.notify( 'Test', { title: 'Title!' } ); // Give the notification a title
mw.notify( 'Test', { autoHide: false } ); // Don't automatically hide the notification
mw.notify( 'Test', { tag: 'foobar' } ); // Send a notification tagged with a tag
mw.notify( 'Test 2', { tag: 'foobar' } ); // This one will replace the previous 'foobar' notification.

Le format est : mw.notify(message, options), les options disponibles sont:

• autoHide – Un booléen indiquant si la notification doit être automatiquement masquée après son affichage ou si elle doit persister.
• autoHideSeconds – Nombre de secondes d'expiration des notifications de masquage automatique.
• tag – Une chaîne facultative. Lorsqu'une notification est balisée, un seul message avec cette balise sera affiché. Essayer d'afficher une nouvelle notification avec la même balise que celle déjà affichée entraînera la fermeture de l'autre notification et l'ouverture de cette nouvelle notification au même endroit que la notification précédente.
• title – Un titre facultatif pour la notification. Sera affiché au-dessus du contenu, généralement en gras.
• type – Une chaîne facultative pour le type du message utilisé pour le style : Exemples : 'info', 'warn', 'error', 'success'.
• visibleTimeout – Un booléen indiquant si le délai d'expiration autoHide doit être basé sur l'heure à laquelle la page était visible pour l'utilisateur ou s'il doit utiliser l'heure de l'horloge murale.

Voir aussi

• Documentation API : mw.notify

Gestion du code

• Maintenu par Unknown or Unassigned^{[‍Maintainers page]}.
• Suivi des problèmes : Phabricator MediaWiki-Interface (rapporter un problème)