mediawiki-skins-MinervaNeue/resources/skins.minerva.newusers/init.js
jdlrobson 5cb46fe9d2 Hygiene: Minerva owns PointerOverlay
The only usage is inside Minerva so we will move this module here.

Change-Id: If6859f0c8f855c6b116b254c58a6814f54b7c36d
2017-10-30 18:00:02 +00:00

83 lines
3 KiB
JavaScript

/* This code currently handles two different editing tutorials/CTAs:
EditTutorial - When an editor registers via the edit page action, upon returning to the
page, show a blue guider prompting them to continue editing. You can replicate this by
appending article_action=signup-edit to the URL of an editable page whilst logged in.
LeftNavEditTutorial - When an editor registers via the left navigation menu, upon
returning to the page, show a blue tutorial in 50% of cases prompting them to try
editing. You can replicate this by appending campaign=leftNavSignup to the URL of an
editable page whilst logged in, although you must be in test group A to see the CTA.
*/
( function ( M, $ ) {
var PointerOverlay = M.require( 'skins.minerva.newusers/PointerOverlay' ),
skin = M.require( 'skins.minerva.scripts/skin' ),
mainMenu = M.require( 'skins.minerva.scripts.top/mainMenu' ),
util = M.require( 'mobile.startup/util' ),
escapeHash = util.escapeHash,
inEditor = window.location.hash.indexOf( '#editor/' ) > -1,
hash = window.location.hash,
editOverlay, target, $target, href;
/**
* Whether or not the user should see the leftNav guider
* @ignore
* @return {boolean}
*/
function shouldShowLeftNavEditTutorial() {
return mw.util.getParamValue( 'campaign' ) === 'leftNavSignup' &&
mw.config.get( 'wgNamespaceNumber' ) === 0 && !inEditor;
}
/**
* If the user came from an edit button signup, show guider.
* @ignore
* @return {boolean}
*/
function shouldShowTutorial() {
var shouldShowEditTutorial = mw.util.getParamValue( 'article_action' ) === 'signup-edit' && !inEditor;
return shouldShowEditTutorial || shouldShowLeftNavEditTutorial();
}
if ( hash && hash.indexOf( '/' ) === -1 ) {
target = escapeHash( hash ) + ' ~ .edit-page';
} else {
target = '#ca-edit .edit-page';
}
// Note the element might have a new ID if the wikitext was changed so check it exists
if ( $( target ).length > 0 && shouldShowTutorial() ) {
if ( shouldShowLeftNavEditTutorial() ) {
// Append the funnel name to the edit link's url
$target = $( target );
href = $target.attr( 'href' );
$target.attr( 'href', href + '/leftNavSignup' );
}
editOverlay = new PointerOverlay( {
target: target,
skin: skin,
isTutorial: true,
className: 'slide active editing',
appendToElement: '#mw-mf-page-center',
summary: mw.msg( 'mobile-frontend-editor-tutorial-summary', mw.config.get( 'wgTitle' ) ),
confirmMsg: mw.msg( 'mobile-frontend-editor-tutorial-confirm' ),
cancelMsg: mw.msg( 'mobile-frontend-editor-tutorial-cancel' )
} );
mainMenu.on( 'open', function () {
editOverlay.hide();
} );
editOverlay.show();
$( '#ca-edit' ).on( 'mousedown', $.proxy( editOverlay, 'hide' ) );
// Initialize the 'Start editing' button
editOverlay.$( '.actionable' ).on( 'click', function () {
// Hide the tutorial
editOverlay.hide();
// Load the editing interface by changing the URL hash
window.location.href = $( target ).attr( 'href' );
} );
}
}( mw.mobileFrontend, jQuery ) );