Notifikační bubliny

Bublinová upozornění je systém JavaScript vyvinutý jako součást MediaWiki pro zobrazování upozornění na webové stránce.

Ukázkový příklad, jak fungují notifikační bubliny

Funkce

• Několik upozornění: Dokáže zobrazit více notifikací (upozornění) současně. Každé může být samostatně uzavřeno.
• Automatické zavírání: Oznámení lze nakonfigurovat tak, aby se po krátké době automaticky zavřelo. To je ve výchozím nastavení povoleno, ale jednotlivé funkce používající tento systém se mohou rozhodnout, že jej v případě potřeby pro konkrétní upozornění deaktivují.
• Označování: Oznámení lze volitelně pojmenovat (nebo "tag"). Když je vytvořeno nové oznámení se stejným názvem jako starší, které je stále aktivní, starší je nahrazeno novým. To umožňuje lepší uživatelský dojem tam, kde by jinak byla viditelná stará, neúplná nebo duplicitní oznámení ([příklady použití https://www.w3.org/TR/notifications/#tags-example])

API

Vstupním bodem pro bublinová upozornění je metoda mw.notify(). Příklady použití:

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.

Formát je: mw.notify(message, options), dostupné možnosti jsou:

• autoHide – Logická hodnota udávající, zda má být oznámení po zobrazení automaticky skryto nebo zda má přetrvávat.
• autoHideSeconds – Počet sekund pro časový limit automatického skrytí oznámení.
• tag – Volitelný řetězec. Když je oznámení označeno, zobrazí se pouze jedna zpráva s tímto štítkem. Pokus o zobrazení nového oznámení se stejným štítkem, jaký se již zobrazuje, způsobí, že se druhé oznámení zavře a toto nové oznámení se otevře na stejném místě jako předchozí oznámení.
• title – Volitelný název pro oznámení. Zobrazí se nad obsahem, obvykle tučně.
• type – Volitelný řetězec pro typ zprávy použité pro styling: Příklady: 'info', 'warn', 'error', 'success'.
• visibleTimeout – Logická hodnota udávající, zda časový limit automatického skrytí má být založen na době, kdy byla stránka viditelná pro uživatele, nebo zda má používat čas nástěnných hodin.

Související odkazy

• Dokumentace API: mw.notify

Správce kódu

• Spravováno Unknown or Unassigned^{[‍Maintainers page]}.
• Nástroj pro sledování problémů: Phabricator MediaWiki-Interface (nahlášení problému)