mirror of
https://gerrit.wikimedia.org/r/mediawiki/extensions/Cite
synced 2024-12-18 17:50:43 +00:00
8aa889dbe6
Some wikis such as eswiki and frwiki prefer to hide the square
brackets by default. Adding a selector-friendly DOM element around
the brackets supports this customization.
This makes it possible to hide the brackets with CSS:
.cite-bracket {
display: none;
}
And it also becomes possible to hide the brackets but make them
appear in copy-pasted article content:
.cite-bracket {
font-size: 0;
}
Bug: T370512
Depends-On: I56b52c399d2c76689fdcb0bc7fd50a8c0ced28fd
Change-Id: Id8684ccee2e6725af2c861da20fc31af1067e614
141 lines
3.7 KiB
JavaScript
141 lines
3.7 KiB
JavaScript
'use strict';
|
|
|
|
/*!
|
|
* VisualEditor ContentEditable MWReferenceNode class.
|
|
*
|
|
* @copyright 2011-2018 VisualEditor Team's Cite sub-team and others; see AUTHORS.txt
|
|
* @license MIT
|
|
*/
|
|
|
|
/**
|
|
* ContentEditable MediaWiki reference node.
|
|
*
|
|
* @constructor
|
|
* @extends ve.ce.LeafNode
|
|
* @mixes ve.ce.FocusableNode
|
|
* @param {ve.dm.MWReferenceNode} model Model to observe
|
|
* @param {Object} [config] Configuration options
|
|
*/
|
|
ve.ce.MWReferenceNode = function VeCeMWReferenceNode() {
|
|
// Parent constructor
|
|
ve.ce.MWReferenceNode.super.apply( this, arguments );
|
|
|
|
// Mixin constructors
|
|
ve.ce.FocusableNode.call( this );
|
|
|
|
// DOM changes
|
|
this.$link = $( '<a>' ).attr( 'href', '#' );
|
|
this.$element.addClass( 've-ce-mwReferenceNode mw-ref reference' ).append( this.$link );
|
|
this.$text = $( '<span>' ).addClass( 'mw-reflink-text' );
|
|
this.$link.append( this.$text );
|
|
|
|
this.index = '';
|
|
this.internalList = this.model.getDocument().internalList;
|
|
|
|
// Events
|
|
this.connect( this, {
|
|
setup: 'onSetup',
|
|
teardown: 'onTeardown'
|
|
} );
|
|
this.model.connect( this, { attributeChange: 'onAttributeChange' } );
|
|
|
|
// Initialization
|
|
this.update();
|
|
};
|
|
|
|
/* Inheritance */
|
|
|
|
OO.inheritClass( ve.ce.MWReferenceNode, ve.ce.LeafNode );
|
|
|
|
OO.mixinClass( ve.ce.MWReferenceNode, ve.ce.FocusableNode );
|
|
|
|
/* Static Properties */
|
|
|
|
ve.ce.MWReferenceNode.static.name = 'mwReference';
|
|
|
|
ve.ce.MWReferenceNode.static.tagName = 'sup';
|
|
|
|
ve.ce.MWReferenceNode.static.primaryCommandName = 'reference';
|
|
|
|
/* Methods */
|
|
|
|
/**
|
|
* Handle setup event.
|
|
*/
|
|
ve.ce.MWReferenceNode.prototype.onSetup = function () {
|
|
ve.ce.MWReferenceNode.super.prototype.onSetup.call( this );
|
|
// FIXME: if this is about getIndex, just do it once at a higher level.
|
|
this.internalList.connect( this, { update: 'onInternalListUpdate' } );
|
|
};
|
|
|
|
/**
|
|
* Handle teardown event.
|
|
*/
|
|
ve.ce.MWReferenceNode.prototype.onTeardown = function () {
|
|
// As we are listening to the internal list, we need to make sure
|
|
// we remove the listeners when this object is removed from the document
|
|
this.internalList.disconnect( this );
|
|
|
|
ve.ce.MWReferenceNode.super.prototype.onTeardown.call( this );
|
|
};
|
|
|
|
/**
|
|
* Handle the updating of the InternalList object.
|
|
*
|
|
* This will occur after a document transaction.
|
|
*
|
|
* @param {string[]} groupsChanged A list of groups which have changed in this transaction
|
|
*/
|
|
ve.ce.MWReferenceNode.prototype.onInternalListUpdate = function ( groupsChanged ) {
|
|
// Only update if this group has been changed
|
|
if ( groupsChanged.indexOf( this.model.getAttribute( 'listGroup' ) ) !== -1 ) {
|
|
this.update();
|
|
}
|
|
};
|
|
|
|
/**
|
|
* Handle attribute change events
|
|
*
|
|
* @param {string} key Attribute key
|
|
* @param {string} from Old value
|
|
* @param {string} to New value
|
|
*/
|
|
ve.ce.MWReferenceNode.prototype.onAttributeChange = function ( key ) {
|
|
if ( key === 'placeholder' ) {
|
|
this.update();
|
|
}
|
|
};
|
|
|
|
/**
|
|
* @override
|
|
* @see ve.ce.FocusableNode
|
|
*/
|
|
ve.ce.MWReferenceNode.prototype.executeCommand = function () {
|
|
const items = ve.ui.contextItemFactory.getRelatedItems( [ this.model ] );
|
|
|
|
if ( items.length ) {
|
|
const contextItem = ve.ui.contextItemFactory.lookup( items[ 0 ].name );
|
|
if ( contextItem ) {
|
|
const command = this.getRoot().getSurface().getSurface().commandRegistry
|
|
.lookup( contextItem.static.commandName );
|
|
if ( command ) {
|
|
command.execute( this.focusableSurface.getSurface() );
|
|
}
|
|
}
|
|
}
|
|
};
|
|
|
|
/**
|
|
* Update the rendering
|
|
*/
|
|
ve.ce.MWReferenceNode.prototype.update = function () {
|
|
this.$text.html( this.model.getIndexLabel() );
|
|
this.$link
|
|
.attr( 'data-mw-group', this.model.getGroup() || null );
|
|
this.$element.toggleClass( 've-ce-mwReferenceNode-placeholder', !!this.model.getAttribute( 'placeholder' ) );
|
|
};
|
|
|
|
/* Registration */
|
|
|
|
ve.ce.nodeFactory.register( ve.ce.MWReferenceNode );
|