mediawiki-extensions-Visual.../modules/ve-mw/preinit/ve.init.mw.ProgressBarWidget.js
Bartosz Dziewoński 3f0f302577 Enforce that some files must not use the ve global
Previously, the ve-mw/init/ directory contained two kinds of files:
those that were used when initializing VE, and those that may be
loaded even if VE is not going to be initialized at all. The latter
kind must not use the `ve` global variable.

After moving those files to ve-mw/preinit/ we can enforce this with
.eslintrc.json in that directory. This would have prevented T228684.

(Technically they merely must not use `ve.init`, and may use `ve`,
but that's harder to enforce. We should instead move the few non-init
methods out of `ve`: now, track, trackSubscribe, trackSubscribeAll).

Also, group some files under ve-mw/init/: targets/ now (only)
contains ve.init.mw.Target and its subclasses, apiresponsecache/
now contains ve.init.mw.ApiResponseCache and its subclasses.

Bug: T228684
Change-Id: I945249a27f6a0fa10a432d5c5dc57bc7e0461fd8
2019-10-10 15:15:40 +00:00

55 lines
1.5 KiB
JavaScript

/*!
* VisualEditor progress bar widget
*
* @copyright 2011-2019 VisualEditor Team and others; see AUTHORS.txt
* @license The MIT License (MIT); see LICENSE.txt
*/
mw.libs.ve = mw.libs.ve || {};
/**
* Progress bar widget
*
* This widget can be used to show a progress bar
* while VE libraries are still loading.
*
* It has a similar API to OO.ui.ProgressBarWidget, but is designed to
* be loaded before any core VE code or dependencies, e.g. OOUI.
*
* @class
* @constructor
*/
mw.libs.ve.ProgressBarWidget = function VeUiMwProgressBarWidget() {
this.progressStep = 0;
this.progressSteps = [
// [ percentage, delay ]
[ 30, 3000 ],
[ 70, 2000 ],
[ 100, 1000 ]
];
// Stylesheets might not have processed yet, so manually set starting width to 0
this.$bar = $( '<div>' ).addClass( 've-init-mw-progressBarWidget-bar' ).css( 'width', 0 );
this.$element = $( '<div>' ).addClass( 've-init-mw-progressBarWidget' ).append( this.$bar );
};
mw.libs.ve.ProgressBarWidget.prototype.setLoadingProgress = function ( target, duration ) {
var $bar = this.$bar.stop();
$bar.css( 'transition', 'width ' + duration + 'ms ease-in' );
setTimeout( function () {
$bar.css( 'width', target + '%' );
} );
};
mw.libs.ve.ProgressBarWidget.prototype.incrementLoadingProgress = function () {
var step = this.progressSteps[ this.progressStep ];
if ( step ) {
this.setLoadingProgress( step[ 0 ], step[ 1 ] );
this.progressStep++;
}
};
mw.libs.ve.ProgressBarWidget.prototype.clearLoading = function () {
this.progressStep = 0;
this.setLoadingProgress( 0, 0 );
};