jquery.byteLimit: Expose trimValueForByteLength as trimByteLength
authorTimo Tijhof <krinklemail@gmail.com>
Wed, 26 Aug 2015 17:06:52 +0000 (19:06 +0200)
committerTimo Tijhof <krinklemail@gmail.com>
Wed, 26 Aug 2015 17:06:52 +0000 (19:06 +0200)
Follows-up 6b79105034, which exposed this private function as a
subproperty of a prototype member, but the JSDuck comment still
treated it as private.

Expose it as proper static method instead.

Change-Id: I1e25ee595ac367a9ae24a325efab2942a37835d9

resources/src/jquery/jquery.byteLimit.js
resources/src/mediawiki.widgets/mw.widgets.TitleInputWidget.js

index e2315d2..afff463 100644 (file)
         * "fobo", not "foba". Basically emulating the native maxlength by
         * reconstructing where the insertion occurred.
         *
-        * @private
+        * @static
         * @param {string} safeVal Known value that was previously returned by this
         * function, if none, pass empty string.
         * @param {string} newVal New value that may have to be trimmed down.
         * @param {number} byteLimit Number of bytes the value may be in size.
-        * @param {Function} [fn] See jQuery.byteLimit.
+        * @param {Function} [fn] See jQuery#byteLimit.
         * @return {Object}
         * @return {string} return.newVal
         * @return {boolean} return.trimmed
         */
-       function trimValueForByteLength( safeVal, newVal, byteLimit, fn ) {
+       $.trimByteLength = function ( safeVal, newVal, byteLimit, fn ) {
                var startMatches, endMatches, matchesLen, inpParts,
                        oldVal = safeVal;
 
@@ -92,7 +92,7 @@
                        newVal: newVal,
                        trimmed: true
                };
-       }
+       };
 
        var eventKeys = [
                'keyup.byteLimit',
                        // See http://www.w3.org/TR/DOM-Level-3-Events/#events-keyboard-event-order for
                        // the order and characteristics of the key events.
                        $el.on( eventKeys, function () {
-                               var res = trimValueForByteLength(
+                               var res = $.trimByteLength(
                                        prevSafeVal,
                                        this.value,
                                        elLimit,
                                        this.value = res.newVal;
                                }
                                // Always adjust prevSafeVal to reflect the input value. Not doing this could cause
-                               // trimValueForByteLength to compare the new value to an empty string instead of the
+                               // trimByteLength to compare the new value to an empty string instead of the
                                // old value, resulting in trimming always from the end (bug 40850).
                                prevSafeVal = res.newVal;
                        } );
                } );
        };
 
-       $.fn.byteLimit.trimValueForByteLength = trimValueForByteLength;
-
        /**
         * @class jQuery
         * @mixins jQuery.plugin.byteLimit
index 3697a1c..cf4d788 100644 (file)
        mw.widgets.TitleInputWidget.prototype.cleanUpValue = function ( value ) {
                var widget = this;
                value = mw.widgets.TitleInputWidget.parent.prototype.cleanUpValue.call( this, value );
-               return $.fn.byteLimit.trimValueForByteLength( this.value, value, this.maxLength, function ( value ) {
+               return $.trimByteLength( this.value, value, this.maxLength, function ( value ) {
                        var title = widget.getTitle( value );
                        return title ? title.getMain() : value;
                } ).newVal;