WMDE-Fisch has uploaded a new change for review. (
https://gerrit.wikimedia.org/r/344358 )
Change subject: Add documentation for new methods
......................................................................
Add documentation for new methods
Also some minor refactoring in the pointer method.
Change-Id: I986036277d2b6e65cbed9f39c81f9f03ad0e9e3c
---
M modules/ext.RevisionSlider.SliderView.js
1 file changed, 34 insertions(+), 3 deletions(-)
git pull ssh://gerrit.wikimedia.org:29418/mediawiki/extensions/RevisionSlider
refs/changes/58/344358/1
diff --git a/modules/ext.RevisionSlider.SliderView.js
b/modules/ext.RevisionSlider.SliderView.js
index 14327e4..5bef724 100644
--- a/modules/ext.RevisionSlider.SliderView.js
+++ b/modules/ext.RevisionSlider.SliderView.js
@@ -111,7 +111,7 @@
this.pointerOlder.getLine().render(),
this.pointerNewer.getLine().render()
);
- this.renderPointers( this.$element, $revisions );
+ this.initPointers( $revisions );
this.$element.find( '.mw-revslider-revision-wrapper'
).on( 'click', null, { view: self, revisionsDom: $revisions },
this.revisionWrapperClickHandler );
@@ -128,6 +128,13 @@
this.diffPage.initOnPopState( this );
},
+ /**
+ * Renders the revisions container and adds the revisions to it
+ *
+ * @param {number} containerWidth
+ * @param {jQuery} $revisions
+ * @return {jQuery} the revisions container
+ */
renderRevisionsContainer: function( containerWidth, $revisions
) {
return $( '<div>' )
.addClass( 'mw-revslider-revisions-container' )
@@ -137,6 +144,12 @@
.append( $revisions );
},
+ /**
+ * Renders the pointer container and adds the pointers to it
+ *
+ * @param {number} containerWidth
+ * @return {jQuery} the pointer container
+ */
renderPointerContainer: function( containerWidth ) {
var pointerContainerPosition = 53,
pointerContainerWidth = containerWidth +
this.revisionWidth - 1,
@@ -158,13 +171,18 @@
.append( this.pointerOlder.getView().render(),
this.pointerNewer.getView().render() );
},
- renderPointers: function( $slider, $revisions ) {
+ /**
+ * Initializes the pointer dragging logic
+ *
+ * @param {jQuery} $revisions
+ */
+ initPointers: function( $revisions ) {
var $pointers,
lastValidLeftPos,
escapePressed = false,
self = this;
- $pointers = $slider.find( '.mw-revslider-pointer' );
+ $pointers = this.$element.find( '.mw-revslider-pointer'
);
$( 'body' ).keydown( function( e ) {
if ( e.which === 27 ) {
@@ -239,6 +257,11 @@
} );
},
+ /**
+ * Renders the help button and renders and adds the popup for
it.
+ *
+ * @return {jQuery} the help button object
+ */
renderHelpButton: function() {
var helpButton, helpPopup;
@@ -268,6 +291,10 @@
return helpButton.$element;
},
+ /**
+ * Renders the backwards arrow, adds the element to the class
attribute
+ * and renders and adds the popup for it.
+ */
renderBackwardArrow: function() {
var backwardArrowPopup;
@@ -300,6 +327,10 @@
$( 'body' ).append( backwardArrowPopup.$element );
},
+ /**
+ * Renders the forwards arrow, adds the element to the class
attribute
+ * and renders and adds the popup for it.
+ */
renderForwardArrow: function() {
var forwardArrowPopup;
--
To view, visit https://gerrit.wikimedia.org/r/344358
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: newchange
Gerrit-Change-Id: I986036277d2b6e65cbed9f39c81f9f03ad0e9e3c
Gerrit-PatchSet: 1
Gerrit-Project: mediawiki/extensions/RevisionSlider
Gerrit-Branch: master
Gerrit-Owner: WMDE-Fisch <[email protected]>
_______________________________________________
MediaWiki-commits mailing list
[email protected]
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
