mediawiki-extensions-Echo/modules/ui/mw.echo.ui.ToggleReadCircleButtonWidget.js
Ed Sanders 3abe6b77bd Make mark as read/unread buttons properly focusable
Bug: T258710
Change-Id: I1ed9d386083d94bf6b5696bb71385169c0ccb807
2020-07-23 15:27:01 +01:00

59 lines
1.8 KiB
JavaScript

( function () {
/**
* A button showing a circle that represents either 'mark as read' or 'mark as unread' states.
*
* @class
* @extends OO.ui.ButtonWidget
*
* @constructor
* @param {Object} [config] Configuration options
* @cfg {boolean} [markAsRead=true] Display mark as read state. If false, the button displays
* mark as unread state.
*/
mw.echo.ui.ToggleReadCircleButtonWidget = function MwEchoUiToggleReadCircleButtonWidget( config ) {
config = config || {};
// Parent constructor
mw.echo.ui.ToggleReadCircleButtonWidget.super.call( this, $.extend( {
invisibleLabel: true,
// Set a dummy icon so we get focus styles
icon: '_'
}, config ) );
this.$circle = $( '<div>' )
.addClass( 'mw-echo-ui-toggleReadCircleButtonWidget-circle' );
this.$button.append( this.$circle );
this.toggleState( config.markAsRead === undefined ? true : !!config.markAsRead );
this.$element
.addClass( 'mw-echo-ui-toggleReadCircleButtonWidget' );
};
/* Initialization */
OO.inheritClass( mw.echo.ui.ToggleReadCircleButtonWidget, OO.ui.ButtonWidget );
/* Methods */
/**
* Toggle the state of the button from 'mark as read' to 'mark as unread'
* and vice versa.
*
* @param {boolean} [isMarkAsRead] The state is mark as read
*/
mw.echo.ui.ToggleReadCircleButtonWidget.prototype.toggleState = function ( isMarkAsRead ) {
var label;
isMarkAsRead = isMarkAsRead === undefined ? !this.markAsRead : !!isMarkAsRead;
this.markAsRead = isMarkAsRead;
this.$circle.toggleClass( 'mw-echo-ui-toggleReadCircleButtonWidget-circle-unread', !this.markAsRead );
label = this.markAsRead ?
mw.msg( 'echo-notification-markasread' ) :
mw.msg( 'echo-notification-markasunread' );
this.setLabel( label );
this.setTitle( label );
};
}() );