泡泡通知

From mediawiki.org
This page is a translated version of the page Bubble notifications and the translation is 100% complete.
一个泡泡通知的例子

泡泡通知是作为MediaWiki的一部分开发的JavaScript系统,用于在网页上显示通知。

功能

  • 多项通知: 它可以同时显示多项通知。 每一个通知都可以各自关闭。
  • 自动关闭: 每一个通知显示一段时间之后就可以自行隐藏不见。 它是默认启用的,但是在需要时使用这个系统的独立特性可以选择关闭特定的通知。
  • 标签: 一个通知可以被给予一个名称(或标签) 当一个新的通知以相同名称创建时,旧的那个将会被新的通知取代。 这可以让旧的、不完整的或重复的通知(示例)不可见,从而提升用户体验。

API

泡泡通知的加入点是mw.notify()方法。 一些例子:

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.

格式為:mw.notify(message, options),可用參數有:

  • autoHide – 布尔值,决定通知是会在显示之后自动隐藏还是一直保留。
  • autoHideSeconds – 自动隐藏通知的显示秒数。
  • tag – 可选字符串。 如果通知带有tag,那么只会显示一条带有相同tag的通知。 如果在已经有此tag时再用相同tag显示新通知,那么旧通知就会消失,新通知会出现在旧通知的相同位置。
  • title – 可选项,通知的标题。 在内容上方显示,通常是粗体。
  • type – 可选字符串,用于指定消息的样式,例如: 'info', 'warn', 'error', 'success'.
  • visibleTimeout – 布尔值,用于指定自动隐藏的计时,是按照用户实际看到此页面的时间,还是按照真实的时间。


参见

代碼維護