[MediaWiki-commits] [Gerrit] Hygiene: Refactor PageActionOverlay as PointerOverlay - change (mediawiki...MobileFrontend)
jenkins-bot has submitted this change and it was merged. Change subject: Hygiene: Refactor PageActionOverlay as PointerOverlay .. Hygiene: Refactor PageActionOverlay as PointerOverlay Changes: * Document pointer overlay * Allow appendToElement to be passed as an option (this will allow us in future to append to things outside content) * Now extends Overlay rather than ContentOverlay since we want to use pointers in the left navigation menu Change-Id: I4db95647d7d97d50f3d9afb48aaa0223feda2074 --- M includes/Resources.php R resources/mobile.contentOverlays/PointerOverlay.hogan R resources/mobile.contentOverlays/PointerOverlay.js M resources/mobile.contentOverlays/tutorials.less M resources/mobile.newusers/init.js M resources/skins.minerva.tablet.beta.styles/common.less 6 files changed, 43 insertions(+), 21 deletions(-) Approvals: Bmansurov: Looks good to me, approved jenkins-bot: Verified diff --git a/includes/Resources.php b/includes/Resources.php index 31d9b04..4f305b0 100644 --- a/includes/Resources.php +++ b/includes/Resources.php @@ -1026,10 +1026,10 @@ 'resources/mobile.contentOverlays/tutorials.less', ), 'scripts' => array( - 'resources/mobile.contentOverlays/PageActionOverlay.js', + 'resources/mobile.contentOverlays/PointerOverlay.js', ), 'templates' => array( - 'PageActionOverlay.hogan' => 'resources/mobile.contentOverlays/PageActionOverlay.hogan', + 'PointerOverlay.hogan' => 'resources/mobile.contentOverlays/PointerOverlay.hogan', ), ), diff --git a/resources/mobile.contentOverlays/PageActionOverlay.hogan b/resources/mobile.contentOverlays/PointerOverlay.hogan similarity index 100% rename from resources/mobile.contentOverlays/PageActionOverlay.hogan rename to resources/mobile.contentOverlays/PointerOverlay.hogan diff --git a/resources/mobile.contentOverlays/PageActionOverlay.js b/resources/mobile.contentOverlays/PointerOverlay.js similarity index 60% rename from resources/mobile.contentOverlays/PageActionOverlay.js rename to resources/mobile.contentOverlays/PointerOverlay.js index 9c3b806..e64f92c 100644 --- a/resources/mobile.contentOverlays/PageActionOverlay.js +++ b/resources/mobile.contentOverlays/PointerOverlay.js @@ -1,25 +1,49 @@ ( function ( M, $ ) { - var ContentOverlay = M.require( 'ContentOverlay' ), - context = M.require( 'context' ), - PageActionOverlay; + var PointerOverlay, + Overlay = M.require( 'Overlay' ); /** * Page overlay prompting a user for given action -* @class PageActionOverlay -* @extends ContentOverlay +* @class PointerOverlay +* @extends Overlay */ - PageActionOverlay = ContentOverlay.extend( { - className: 'overlay content-overlay tutorial-overlay', - template: mw.template.get( 'mobile.contentOverlays', 'PageActionOverlay.hogan' ), + PointerOverlay = Overlay.extend( { + className: 'overlay pointer-overlay tutorial-overlay', + /** +* @inheritdoc +*/ + fullScreen: false, + /** +* @inheritdoc +*/ + closeOnContentTap: true, + template: mw.template.get( 'mobile.contentOverlays', 'PointerOverlay.hogan' ), /** * @inheritdoc * @cfg {Object} defaults Default options hash. * @cfg {Skin} defaults.skin class +* @cfg {String} defaults.summary Message describing thing being pointed to. * @cfg {String} defaults.cancelMsg Cancel message. +* @cfg {String} defaults.appendToElement Where pointer overlay should be appended to. +* @cfg {String} defaults.target jQuery selector to point tutorial at +* @cfg {String} [defaults.confirmMsg] Label for a confirm message. */ defaults: { skin: undefined, - cancelMsg: mw.msg( 'cancel' ) + summary: undefined, + cancelMsg: mw.msg( 'cancel' ), + appendToElement: undefined, + target: undefined, + confirmMsg: undefined + }, + /** +* @inheritdoc +*/ + initialize: function ( options ) { + // FIXME: This should not have a default fallback. This is a non-optional parameter. + // Remove when all existing uses in Gather have been updated. + this.appendToElement = options.appendToElement || '#mw-mf-page-ce
[MediaWiki-commits] [Gerrit] Hygiene: Refactor PageActionOverlay as PointerOverlay - change (mediawiki...MobileFrontend)
Jdlrobson has uploaded a new change for review. https://gerrit.wikimedia.org/r/221807 Change subject: Hygiene: Refactor PageActionOverlay as PointerOverlay .. Hygiene: Refactor PageActionOverlay as PointerOverlay Changes: * Document pointer overlay * Allow appendToElement to be passed as an option (this will allow us in future to append to things outside content) * Now extends Overlay rather than ContentOverlay since we want to use pointers in the left navigation menu Change-Id: I4db95647d7d97d50f3d9afb48aaa0223feda2074 --- M includes/Resources.php R resources/mobile.contentOverlays/PointerOverlay.hogan R resources/mobile.contentOverlays/PointerOverlay.js M resources/mobile.contentOverlays/tutorials.less M resources/mobile.newusers/init.js M resources/skins.minerva.tablet.beta.styles/common.less 6 files changed, 40 insertions(+), 20 deletions(-) git pull ssh://gerrit.wikimedia.org:29418/mediawiki/extensions/MobileFrontend refs/changes/07/221807/1 diff --git a/includes/Resources.php b/includes/Resources.php index 1e72aaa..a61ef91 100644 --- a/includes/Resources.php +++ b/includes/Resources.php @@ -1039,10 +1039,10 @@ 'resources/mobile.contentOverlays/tutorials.less', ), 'scripts' => array( - 'resources/mobile.contentOverlays/PageActionOverlay.js', + 'resources/mobile.contentOverlays/PointerOverlay.js', ), 'templates' => array( - 'PageActionOverlay.hogan' => 'resources/mobile.contentOverlays/PageActionOverlay.hogan', + 'PointerOverlay.hogan' => 'resources/mobile.contentOverlays/PointerOverlay.hogan', ), ), diff --git a/resources/mobile.contentOverlays/PageActionOverlay.hogan b/resources/mobile.contentOverlays/PointerOverlay.hogan similarity index 100% rename from resources/mobile.contentOverlays/PageActionOverlay.hogan rename to resources/mobile.contentOverlays/PointerOverlay.hogan diff --git a/resources/mobile.contentOverlays/PageActionOverlay.js b/resources/mobile.contentOverlays/PointerOverlay.js similarity index 63% rename from resources/mobile.contentOverlays/PageActionOverlay.js rename to resources/mobile.contentOverlays/PointerOverlay.js index 9c3b806..40eb2dc 100644 --- a/resources/mobile.contentOverlays/PageActionOverlay.js +++ b/resources/mobile.contentOverlays/PointerOverlay.js @@ -1,25 +1,47 @@ ( function ( M, $ ) { - var ContentOverlay = M.require( 'ContentOverlay' ), - context = M.require( 'context' ), + var Overlay = M.require( 'Overlay' ), PageActionOverlay; /** * Page overlay prompting a user for given action -* @class PageActionOverlay -* @extends ContentOverlay +* @class PointerOverlay +* @extends Overlay */ - PageActionOverlay = ContentOverlay.extend( { - className: 'overlay content-overlay tutorial-overlay', - template: mw.template.get( 'mobile.contentOverlays', 'PageActionOverlay.hogan' ), + PointerOverlay = Overlay.extend( { + className: 'overlay pointer-overlay tutorial-overlay', + /** +* @inheritdoc +*/ + fullScreen: false, + /** +* @inheritdoc +*/ + closeOnContentTap: true, + template: mw.template.get( 'mobile.contentOverlays', 'PointerOverlay.hogan' ), /** * @inheritdoc * @cfg {Object} defaults Default options hash. * @cfg {Skin} defaults.skin class +* @cfg {String} defaults.summary Message describing thing being pointed to. * @cfg {String} defaults.cancelMsg Cancel message. +* @cfg {String} defaults.appendToElement Where pointer overlay should be appended to. +* @cfg {String} default.target jQuery selector to point tutorial at +* @cfg {String} [defaults.confirmMsg] Label for a confirm message. */ defaults: { skin: undefined, - cancelMsg: mw.msg( 'cancel' ) + summary: undefined, + cancelMsg: mw.msg( 'cancel' ), + appendToElement: undefined, + target: undefined, + confirmMsg: undefined + }, + /** +* @inheritdoc +*/ + initialize: function ( options ) { + this.appendToElement = options.appendToElement || '#mw-mf-page-center'; + Overlay.prototype.initialize.apply( this, arguments ); }, /** * @inheritdoc @@ -32,7 +54,