Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 | 1x 1x 1x 422x 422x 417x 37x 386x 84x 413x 45x 422x 422x 422x 422x 422x 9x 413x 422x 422x 422x 422x 401x 422x 426x 426x 426x 426x 389x 389x 344x 344x 344x 45x 426x 426x 426x 426x 426x 63x 63x 181x 181x 102x 181x 181x 181x 181x 490x 490x 416x 1x 1x 1x 1x 1x 10x 47x 47x 7x 7x 1x 1x 1x 1x | /* global $ */
const util = require( './util' ),
// Cached regex to split keys for `delegate`.
delegateEventSplitter = /^(\S+)\s*(.*)$/;
let idCounter = 0;
/**
* Generate a unique integer id (unique within the entire client session).
* Useful for temporary DOM ids.
*
* @private
* @param {string} prefix Prefix to be used when generating the id.
* @return {string}
*/
function uniqueId( prefix ) {
const id = ( ++idCounter ).toString();
return prefix ? prefix + id : id;
}
/**
* Describes a component for rendering.
*
* Should be extended using extend().
*
* When options contains el property, this.$el in the constructed object
* will be set to the corresponding jQuery object. Otherwise, this.$el
* will be an empty div.
*
* When extended using extend(), if the extended prototype contains
* template property, this.$el will be filled with rendered template (with
* options parameter used as template data).
*
* template property can be a string which will be passed to mw.template.compile()
* or an object that has a render() function which accepts an object with
* template data as its argument (similarly to an object created by
* mw.template.compile()).
*
* You can also define a defaults property which should be an object
* containing default values for the template (if they're not present in
* the options parameter).
*
* If this.$el is not a jQuery object bound to existing DOM element, the
* view can be attached to an element using appendTo(), prependTo(),
* insertBefore(), insertAfter() proxy functions.
*
* append(), prepend(), before(), after() can be used to modify $el. on()
* can be used to bind events.
*
* You can also use declarative DOM events binding by specifying an `events`
* map on the class. The keys will be 'event selector' and the value can be
* either the name of a method to call, or a function. All methods and
* functions will be executed on the context of the View.
*
* Inspired from Backbone.js
* https://github.com/jashkenas/backbone/blob/master/backbone.js#L1128
*
* Example:
* ```js
* var
* MyComponent = View.extend( {
* edit: function ( ev ) {
* //...
* },
* save: function ( ev ) {
* //...
* }
* } ),
* instance = new MyComponent({
* events: {
* 'mousedown .title': 'edit',
* 'click .button': 'save',
* 'click .open': function(e) { ... }
* }
* });
* ```
*
* Example:
* ```js
* var View, section;
* function Section( options ) {
* var defaultOptions = {
* events: {
* // ...
* }
* }
* View.call( this, util.extends( {}, defaultOptions, options ) );
* }
* View = require( './View' );
* class Section extends View {
* get template() {
* return mw.template.compile( "<h2>{{title}}</h2>" ),
* }
* }
* section = new Section( { title: 'Test', text: 'Test section body' } );
* section.appendTo( 'body' );
* ```
*
* @mixes OO.EventEmitter
*/
class View {
/**
* @param {Object} options Object passed to the constructor.
* @param {Object.<string, string>} [options.events]
*/
constructor( options ) {
this.initialize( options );
}
/**
* @property {Object}
* Specifies the template used in render().
*/
get template() {
return undefined;
}
/**
* Specifies partials (sub-templates) for the main template. Example:
*
* @example
* // example content for the "some" template (sub-template will be
* // inserted where {{>content}} is):
* // <h1>Heading</h1>
* // {{>content}}
*
* class SomeView extends View {
* get template() { return util.template( '<source-code>' ) }
* get templatePartials() { return { content: util.template( '<source-code>' ) } }
* }
*
* @property {Object}
*/
get templatePartials() {
return {};
}
/**
* A set of default options that are merged with options passed into the initialize
* function.
*
* @property {Object} defaults Default options hash.
* @property {jQuery.Object|string} [defaults.el] jQuery selector to use for rendering.
* @property {boolean} [defaults.skipTemplateRender] Whether to enhance views already in
* DOM. When enabled, the template is disabled so that it is not rendered in the DOM.
* Use in conjunction with View::defaults.$el to associate the View with an existing
* already rendered element in the DOM.
*/
get defaults() {
return {};
}
/**
* Name of tag that contains the rendered template
*
* @property {string} tagName
*/
get tagName() {
return this.options.tagName || 'div';
}
/**
* Tells the View to ignore tagName and className when constructing the element
* and to rely solely on the template
*
* @property {boolean} isTemplateMode
*/
get isTemplateMode() {
return false;
}
/**
* Run once during construction to set up the View
*
* @param {Object} options Object passed to the constructor.
* @param {Object.<string, string>} [options.events]
*/
initialize( options ) {
OO.EventEmitter.call( this );
options = util.extend( {}, this.defaults, options );
this.options = options;
// Assign a unique id for dom events binding/unbinding
this.cid = uniqueId( 'view' );
if ( options.el ) {
// Note the element may not be in the document so must use global jQuery here
this.$el = $( options.el );
} else {
this.$el = this.parseHTML( '<' + this.tagName + '>' );
}
// Make sure the element is ready to be manipulated
Eif ( this.$el.length ) {
this._postInitialize( options );
} else {
util.docReady( () => {
// Note the element may not be in the document so must use global jQuery here
this.$el = $( options.el );
this._postInitialize( options );
} );
}
}
/**
* Called when this.$el is ready.
*
* @private
* @param {Object} props
*/
_postInitialize( props ) {
// eslint-disable-next-line mediawiki/class-doc
this.$el.addClass( props.className );
// border-box will be added provided this flag is not set
if ( props.isBorderBox !== false ) {
this.$el.addClass( 'view-border-box' );
}
this.render( {} );
}
/**
* Function called before the view is rendered. Can be redefined in
* objects that extend View.
*/
preRender() {
}
/**
* Function called after the view is rendered. Can be redefined in
* objects that extend View.
*/
postRender() {
}
/**
* Fill this.$el with template rendered using data if template is set.
*
* @param {Object} data Template data. Will be merged into the view's
* options
* @chainable
*/
render( data ) {
let $el, html;
util.extend( this.options, data );
this.preRender();
this.undelegateEvents();
if ( this.template && !this.options.skipTemplateRender ) {
html = this.template.render( this.options, this.templatePartials );
if ( this.isTemplateMode ) {
$el = $( html );
this.$el.replaceWith( $el );
this.$el = $el;
} else {
this.$el.html( html );
}
}
this.postRender();
this.delegateEvents();
return this;
}
/**
* Set callbacks for events.
*
* `this.options.events` is a hash of pairs:
*
* ```
* { 'event selector': 'callback' }
*
* {
* 'mousedown .title': 'edit',
* 'click .button': 'save',
* 'click .open': function(e) { ... }
* }
* ```
*
* Callbacks will be bound to the view, with `this` set properly.
* Uses event delegation for efficiency.
* Omitting the selector binds the event to `this.el`.
*
* @param {Object} events Optionally set this events instead of the ones on this.
*/
delegateEvents( events ) {
let match, key, method;
events = events || this.options.events;
if ( events ) {
// Remove current events before re-binding them
this.undelegateEvents();
for ( key in events ) {
method = events[key];
// If the method is a string name of this.method, get it
if ( typeof method !== 'function' ) {
method = this[events[key]];
}
Eif ( method ) {
// Extract event and selector from the key
match = key.match( delegateEventSplitter );
this.delegate( match[1], match[2], method.bind( this ) );
}
}
}
}
/**
* Add a single event listener to the view's element (or a child element
* using `selector`). This only works for delegate-able events: not `focus`
* or `blur`.
*
* @param {string} eventName
* @param {string} selector
* @param {Function} listener
*/
delegate( eventName, selector, listener ) {
this.$el.on( eventName + '.delegateEvents' + this.cid, selector,
listener );
}
/**
* Clears all callbacks previously bound to the view by `delegateEvents`.
* You usually don't need to use this, but may wish to if you have multiple
* views attached to the same DOM element.
*/
undelegateEvents() {
Eif ( this.$el ) {
this.$el.off( '.delegateEvents' + this.cid );
}
}
/**
* A finer-grained `undelegateEvents` for removing a single delegated event.
* `selector` and `listener` are both optional.
*
* @param {string} eventName
* @param {string} selector
* @param {Function} listener
*/
undelegate( eventName, selector, listener ) {
this.$el.off( eventName + '.delegateEvents' + this.cid, selector,
listener );
}
/**
* See parseHTML method of util singleton
*
* @param {string} html to turn into a jQuery object.
* @return {jQuery.Object}
*/
parseHTML( html ) {
// document is explicitly passed due to a bug we found in Safari 11.1.2 where failure
// to use document resulted in an element without access to the documentElement
// this should be redundant, but no problem in being explicit (T214451).
return util.parseHTML( html, document );
}
/**
* Generates a view with children
*
* @param {Object} options
* @param {jQuery.Element[]} children
* @return {View}
*/
static make( options = {}, children = [] ) {
const view = new View( options );
children.forEach( ( $child ) => view.append( $child ) );
return view;
}
}
OO.mixinClass( View, OO.EventEmitter );
/**
* @memberof View
* @instance
* @function append
* @param {...(string|Node|Node[]|jQuery)} contents
* @return {View}
*/
/**
* @memberof View
* @instance
* @function append
* @param {function(number, string): string|Node|Node[]|jQuery} contents
* @return {View}
*/
/**
* @memberof View
* @instance
* @function prepend
* @param {...(string|Node|Node[]|jQuery)} contents
* @return {View}
*/
/**
* @memberof View
* @instance
* @function prepend
* @param {function(number, string): string|Node|Node[]|jQuery} contents
* @return {View}
*/
/**
* @memberof View
* @instance
* @function appendTo
* @param {string|Node|Node[]|jQuery} target
* @return {View}
*/
/**
* @memberof View
* @instance
* @function prependTo
* @param {string|Node|Node[]|jQuery} target
* @return {View}
*/
/**
* @memberof View
* @instance
* @function after
* @param {...(string|Node|Node[]|jQuery)} contents
* @return {View}
*/
/**
* @memberof View
* @instance
* @function after
* @param {function(number, string): string|Node|Node[]|jQuery} contents
* @return {View}
*/
/**
* @memberof View
* @instance
* @functiontion before
* @param {...(string|Node|Node[]|jQuery)} contents
* @return {View}
*/
/**
* @memberof View
* @instance
* @function before
* @param {function(number, string): string|Node|Node[]|jQuery} contents
* @return {View}
*/
/**
* @memberof View
* @instance
* @property {jQuery.Object} $el
*/
/**
* @memberof View
* @instance
* @function insertAfter
* @param {string|Node|Node[]|jQuery} target
* @return {View}
*/
/**
* @memberof View
* @instance
* @function insertBefore
* @param {string|Node|Node[]|jQuery} target
* @return {View}
*/
/**
* @memberof View
* @instance
* @function remove
* @param {string} [selector]
* @return {View}
*/
/**
* @memberof View
* @instance
* @function detach
* @param {string} [selector]
* @return {View}
*/
[
'append',
'prepend',
'appendTo',
'prependTo',
'after',
'before',
'insertAfter',
'insertBefore',
'remove',
'detach'
].forEach( ( prop ) => {
View.prototype[prop] = function () {
this.$el[prop].apply( this.$el, arguments );
return this;
};
} );
/**
* ES5 compatible version of class for backwards compatibility
*
* @deprecated 1.44
* @param {Object} options
* @ignore
*/
function ClassES5( options ) {
mw.log.warn( '[1.44] Extending View class constructor is deprecated. Please use View.make' );
this.initialize( options );
}
ClassES5.prototype = View.prototype;
ClassES5.make = View.make;
View.ClassES5 = ClassES5;
module.exports = View;
|