wikimedia/mediawiki-skins-Vector
1
0
Fork 0
mirror of https://gerrit.wikimedia.org/r/mediawiki/skins/Vector.git synced 2024-11-30 18:35:44 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add a URL parameter to edit links in the sticky header

Browse source 
Briefly add it onto the originals when the click is being proxied so
that VE can pick up on it.

Bug: T309364
Change-Id: I871494b6e783018b1433f294e09b0d53dded6c3d
This commit is contained in:
David Lynch 2022-06-15 02:48:06 -05:00
parent def2a366bc
commit 734902811a
1 changed files with 46 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

46
resources/skins.vector.es6/stickyHeader.js
View file

@ -5,6 +5,7 @@ const
initSearchToggle = require( './searchToggle.js' ),
STICKY_HEADER_ID = 'vector-sticky-header',
STICKY_HEADER_APPENDED_ID = '-sticky-header',
STICKY_HEADER_APPENDED_PARAM = [ 'wvprov', 'sticky-header' ],
STICKY_HEADER_VISIBLE_CLASS = 'vector-sticky-header-visible',
STICKY_HEADER_USER_MENU_CONTAINER_CLASS = 'vector-sticky-header-icon-end',
FIRST_HEADING_ID = 'firstHeading',
@ -71,6 +72,44 @@ function suffixStickyAttribute( node, attribute ) {
}
}
/**
* Suffixes the href attribute of a node with a value that indicates it
* relates to the sticky header to support tracking instrumentation.
*
* Distinct from suffixStickyAttribute as it's intended to support followed
* links recording their origin.
*
* @param {Element} node
*/
function suffixStickyHref( node ) {
/* eslint-disable compat/compat */
// @ts-ignore
const url = new URL( node.href );
if ( url && !url.searchParams.has( STICKY_HEADER_APPENDED_PARAM[ 0 ] ) ) {
url.searchParams.append(
STICKY_HEADER_APPENDED_PARAM[ 0 ], STICKY_HEADER_APPENDED_PARAM[ 1 ]
);
// @ts-ignore
node.href = url.toString();
}
/* eslint-enable compat/compat */
}
/**
* Undoes the effect of suffixStickyHref
*
* @param {Element} node
*/
function unsuffixStickyHref( node ) {
/* eslint-disable compat/compat */
// @ts-ignore
const url = new URL( node.href );
url.searchParams.delete( STICKY_HEADER_APPENDED_PARAM[ 0 ] );
// @ts-ignore
node.href = url.toString();
/* eslint-enable compat/compat */
}
/**
* Makes a node trackable by our click tracking instrumentation.
*
@ -223,16 +262,20 @@ function prepareEditIcons(
removeNode( wikitextSticky );
removeNode( primaryEditSticky );
copyButtonAttributes( primaryEdit, protectedSticky );
suffixStickyHref( protectedSticky );
} else {
removeNode( protectedSticky );
copyButtonAttributes( primaryEdit, primaryEditSticky );
suffixStickyHref( primaryEditSticky );
primaryEditSticky.addEventListener( 'click', function ( ev ) {
const target = ev.target;
const $ve = $( primaryEdit );
if ( target && $ve.length ) {
const event = $.Event( 'click' );
suffixStickyHref( $ve[ 0 ] );
$ve.trigger( event );
unsuffixStickyHref( $ve[ 0 ] );
// The link has been progressively enhanced.
if ( event.isDefaultPrevented() ) {
disableStickyHeader();
@ -242,13 +285,16 @@ function prepareEditIcons(
} );
if ( secondaryEdit ) {
copyButtonAttributes( secondaryEdit, wikitextSticky );
suffixStickyHref( wikitextSticky );
wikitextSticky.addEventListener( 'click', function ( ev ) {
const target = ev.target;
if ( target ) {
const $edit = $( secondaryEdit );
if ( $edit.length ) {
const event = $.Event( 'click' );
suffixStickyHref( $edit[ 0 ] );
$edit.trigger( event );
unsuffixStickyHref( $edit[ 0 ] );
// The link has been progressively enhanced.
if ( event.isDefaultPrevented() ) {
disableStickyHeader();