mirror of
https://gerrit.wikimedia.org/r/mediawiki/skins/MinervaNeue
synced 2024-12-01 01:06:31 +00:00
Merge "Cleanup NotificationBadge and notification overlay creation"
This commit is contained in:
jenkins-bot
Gerrit Code Review
commit
e7c497bda7
|
|
@ -8,136 +8,57 @@
|
|||
notificationIcon = new Icon( {
|
||||
name: 'notifications',
|
||||
glyphPrefix: 'minerva'
|
||||
} ),
|
||||
icons = mobile.icons;
|
||||
} );
|
||||
|
||||
/**
|
||||
* A notification button for communicating with an NotificationOverlay
|
||||
* A notification button for displaying a notifications overlay
|
||||
* @class NotificationButton
|
||||
* @extends View
|
||||
* @param {Object} options Configuration options
|
||||
* @param {string} options.notificationIconClass e.g. mw-ui-icon for icon
|
||||
* @param {boolean} options.hasUnseenNotifications whether the user has unseen notifications
|
||||
* @param {number} options.notificationCountRaw number of unread notifications
|
||||
* @param {string} options.title tooltip for badge
|
||||
* @param {string} options.url to see all notifications
|
||||
* @param {boolean} options.hasNotifications whether the user has unseen notifications
|
||||
* @param {Function} options.onClick handler for when the badge is clicked
|
||||
* @memberof NotificationBadge
|
||||
* @instance
|
||||
*/
|
||||
function NotificationBadge( options ) {
|
||||
var $el,
|
||||
var $el, $notificationAnchor,
|
||||
count = options.notificationCountRaw || 0,
|
||||
el = options.el;
|
||||
|
||||
if ( el ) {
|
||||
// Learn properties based on current element
|
||||
$el = $( el );
|
||||
options.hasUnseenNotifications = $el.find( '.notification-unseen' ).length;
|
||||
options.hasUnseenNotifications = $el.find( '.notification-unseen' ).length > 0;
|
||||
options.hasNotifications = options.hasUnseenNotifications;
|
||||
options.title = $el.find( 'a' ).attr( 'title' );
|
||||
options.url = $el.find( 'a' ).attr( 'href' );
|
||||
$notificationAnchor = $el.find( 'a' );
|
||||
options.title = $notificationAnchor.attr( 'title' );
|
||||
options.url = $notificationAnchor.attr( 'href' );
|
||||
count = Number( $el.find( 'span' ).data( 'notification-count' ) );
|
||||
}
|
||||
View.call( this,
|
||||
util.extend( options, {
|
||||
util.extend( {
|
||||
notificationIconClass: notificationIcon.getClassName(),
|
||||
hasNotifications: false,
|
||||
hasUnseenNotifications: false,
|
||||
notificationCountRaw: 0
|
||||
}, options, {
|
||||
isBorderBox: false
|
||||
} )
|
||||
);
|
||||
this.url = options.url;
|
||||
this._bindOverlayManager();
|
||||
this.setCount( count );
|
||||
if ( options.onClick ) {
|
||||
this.$el.on( 'click', options.onClick );
|
||||
}
|
||||
}
|
||||
|
||||
mfExtend( NotificationBadge, View, {
|
||||
/**
|
||||
* @cfg {object} defaults Default options hash.
|
||||
* @cfg {string} defaults.notificationIconClass e.g. mw-ui-icon for icon
|
||||
* @cfg {string} defaults.loadingIconHtml for spinner
|
||||
* @cfg {boolean} defaults.hasUnseenNotifications whether the user has unseen notifications
|
||||
* @cfg {number} defaults.notificationCountRaw number of unread notifications
|
||||
* @memberof NotificationBadge
|
||||
* @instance
|
||||
*/
|
||||
defaults: {
|
||||
notificationIconClass: notificationIcon.getClassName(),
|
||||
loadingIconHtml: icons.spinner().toHtmlString(),
|
||||
hasNotifications: false,
|
||||
hasUnseenNotifications: false,
|
||||
notificationCountRaw: 0
|
||||
},
|
||||
/**
|
||||
* Loads a ResourceLoader module script. Shows ajax loader whilst loading.
|
||||
* @method
|
||||
* @private
|
||||
* @memberof NotificationBadge
|
||||
* @instance
|
||||
* @param {string} moduleName Name of a module to fetch
|
||||
* @return {JQuery.Promise}
|
||||
*/
|
||||
_loadModuleScript: function ( moduleName ) {
|
||||
var self = this;
|
||||
|
||||
this.$el.html( this.options.loadingIconHtml );
|
||||
return mw.loader.using( moduleName ).then( function () {
|
||||
// trigger a re-render once one to remove loading icon
|
||||
self.render();
|
||||
} );
|
||||
},
|
||||
/**
|
||||
* Load the notification overlay.
|
||||
* @method
|
||||
* @private
|
||||
* @memberof NotificationBadge
|
||||
* @instance
|
||||
* @uses NotificationsOverlay
|
||||
* @return {JQuery.Deferred} with an instance of NotificationsOverlay
|
||||
*/
|
||||
_loadNotificationOverlay: function () {
|
||||
var self = this;
|
||||
|
||||
return this._loadModuleScript( 'mobile.notifications.overlay' ).then( function () {
|
||||
var NotificationsOverlay =
|
||||
M.require( 'mobile.notifications.overlay/NotificationsOverlay' ); // resource-modules-disable-line
|
||||
return new NotificationsOverlay( {
|
||||
badge: self
|
||||
} );
|
||||
} );
|
||||
},
|
||||
/**
|
||||
* Sets up routes in overlay manager and click behaviour for NotificationBadge
|
||||
* This is not unit tested as it's behaviour is covered by browser tests.
|
||||
* @memberof NotificationBadge
|
||||
* @instance
|
||||
* @private
|
||||
*/
|
||||
_bindOverlayManager: function () {
|
||||
var self = this,
|
||||
mainMenu = this.options.mainMenu;
|
||||
|
||||
this.$el.on( 'click', this.onClickBadge.bind( this ) );
|
||||
this.options.overlayManager.add( /^\/notifications$/, function () {
|
||||
return self._loadNotificationOverlay().then( function ( overlay ) {
|
||||
// eslint-disable-next-line jquery/no-global-selector
|
||||
var $pageCenter = $( '#mw-mf-page-center' );
|
||||
|
||||
mainMenu.openNavigationDrawer( 'secondary' );
|
||||
overlay.on( 'hide', function () {
|
||||
mainMenu.closeNavigationDrawers();
|
||||
$pageCenter.off( '.secondary' );
|
||||
} );
|
||||
|
||||
$pageCenter.one( 'click.secondary', function () {
|
||||
self.options.router.back();
|
||||
} );
|
||||
return overlay;
|
||||
} );
|
||||
} );
|
||||
},
|
||||
template: mw.template.get( 'skins.minerva.notifications.badge', 'badge.hogan' ),
|
||||
/**
|
||||
* Click handler for clicking on the badge
|
||||
* @memberof NotificationBadge
|
||||
* @instance
|
||||
* @return {boolean}
|
||||
*/
|
||||
onClickBadge: function () {
|
||||
this.options.router.navigate( '#/notifications' );
|
||||
// Important that we also prevent propagation to avoid interference with events that may
|
||||
// be binded on #mw-mf-page-center that close overlay
|
||||
return false;
|
||||
},
|
||||
/**
|
||||
* Update the notification count
|
||||
* @memberof NotificationBadge
|
||||
|
|
|
|||
|
|
@ -3,23 +3,47 @@
|
|||
* with the Toast notifications defined by common/toast.js.
|
||||
*/
|
||||
( function ( M ) {
|
||||
var mainMenu = M.require( 'skins.minerva.scripts/mainMenu' ),
|
||||
var badge,
|
||||
mainMenu = M.require( 'skins.minerva.scripts/mainMenu' ),
|
||||
router = require( 'mediawiki.router' ),
|
||||
mobile = M.require( 'mobile.startup' ),
|
||||
util = mobile.util,
|
||||
NotificationBadge = M.require( 'skins.minerva.notifications/NotificationBadge' ),
|
||||
overlayManager = M.require( 'skins.minerva.scripts/overlayManager' ),
|
||||
initialized = false;
|
||||
|
||||
function showNotificationOverlay() {
|
||||
// eslint-disable-next-line jquery/no-global-selector
|
||||
var $pageCenter = $( '#mw-mf-page-center' ),
|
||||
overlay = mobile.notifications.overlay( badge.setCount.bind( badge ),
|
||||
badge.markAsSeen.bind( badge ) );
|
||||
mainMenu.openNavigationDrawer( 'secondary' );
|
||||
overlay.on( 'hide', function () {
|
||||
mainMenu.closeNavigationDrawers();
|
||||
$pageCenter.off( '.secondary' );
|
||||
} );
|
||||
|
||||
$pageCenter.one( 'click.secondary', function () {
|
||||
router.back();
|
||||
} );
|
||||
return overlay;
|
||||
}
|
||||
|
||||
// Once the DOM is loaded hijack the notifications button to display an overlay rather
|
||||
// than linking to Special:Notifications.
|
||||
$( function () {
|
||||
// eslint-disable-next-line no-new
|
||||
new NotificationBadge( {
|
||||
overlayManager: overlayManager,
|
||||
router: router,
|
||||
mainMenu: mainMenu,
|
||||
util.docReady( function () {
|
||||
badge = new NotificationBadge( {
|
||||
onClick: function () {
|
||||
router.navigate( '#/notifications' );
|
||||
// Important that we also prevent propagation to avoid interference
|
||||
// with events that may
|
||||
// be binded on #mw-mf-page-center that close overlay
|
||||
return false;
|
||||
},
|
||||
// eslint-disable-next-line jquery/no-global-selector
|
||||
el: $( '#secondary-button.user-button' ).parent()
|
||||
} );
|
||||
overlayManager.add( /^\/notifications$/, showNotificationOverlay );
|
||||
|
||||
/**
|
||||
* Adds a filter button to the UI inside notificationsInboxWidget
|
||||
|
|
|
|||
Loading…
Reference in a new issue