Skip to content
This repository was archived by the owner on Apr 12, 2024. It is now read-only.

fix(ngModel): minimize jank when toggling CSS classes during validation #9263

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 48 additions & 1 deletion src/ng/directive/input.js
Original file line number Diff line number Diff line change
Expand Up @@ -2056,6 +2056,7 @@ var NgModelController = ['$scope', '$exceptionHandler', '$attrs', '$element', '$
var viewValue = ctrl.$$lastCommittedViewValue;
var modelValue = viewValue;
var parserValid = isUndefined(modelValue) ? undefined : true;
var flushPendingClassChanges = schedulePendingClassChanges($scope, ctrl, $element, $animate);

if (parserValid) {
for(var i = 0; i < ctrl.$parsers.length; i++) {
Expand Down Expand Up @@ -2092,6 +2093,8 @@ var NgModelController = ['$scope', '$exceptionHandler', '$attrs', '$element', '$
ctrl.$$writeModelToScope();
}
}

flushPendingClassChanges();
};

this.$$writeModelToScope = function() {
Expand Down Expand Up @@ -2197,7 +2200,7 @@ var NgModelController = ['$scope', '$exceptionHandler', '$attrs', '$element', '$
// TODO(perf): why not move this to the action fn?
if (modelValue !== ctrl.$modelValue) {
ctrl.$modelValue = modelValue;

var flushPendingClassChanges = schedulePendingClassChanges($scope, ctrl, $element, $animate);
var formatters = ctrl.$formatters,
idx = formatters.length;

Expand All @@ -2211,13 +2214,45 @@ var NgModelController = ['$scope', '$exceptionHandler', '$attrs', '$element', '$

ctrl.$$runValidators(undefined, modelValue, viewValue, noop);
}
flushPendingClassChanges();
}

return modelValue;
});
}];


function schedulePendingClassChanges(scope, ctrl, element, animate) {
if (!ctrl.$$pendingClassChanges) {
ctrl.$$pendingClassChanges = {};

if (scope.$$phase || scope.$root.$$phase) {
scope.$$postDigest(flushPendingClassChangesImmediately);
} else {
return flushPendingClassChangesImmediately;
}
}
return noop;

function flushPendingClassChangesImmediately() {
flushPendingClassChanges(animate, element, ctrl.$$pendingClassChanges);
ctrl.$$pendingClassChanges = null;
}
}


function flushPendingClassChanges($animate, element, pendingChanges) {
var keys = Object.keys(pendingChanges);

for (var i=0, ii = keys.length; i < ii; ++i) {
var key = keys[i];
var value = pendingChanges[key];
if (value < 0) $animate.removeClass(element, key);
else if (value > 0) $animate.addClass(element, key);
}
}


/**
* @ngdoc directive
* @name ngModel
Expand Down Expand Up @@ -3037,6 +3072,18 @@ function addSetValidityMethod(context) {
}

function cachedToggleClass(className, switchValue) {
var pendingChanges = ctrl.$$pendingClassChanges;
if (pendingChanges) {
if (switchValue) {
pendingChanges[className] = 1;
classCache[className] = true;
} else {
pendingChanges[className] = -1;
classCache[className] = false;
}
return;
}

if (switchValue && !classCache[className]) {
$animate.addClass($element, className);
classCache[className] = true;
Expand Down
45 changes: 45 additions & 0 deletions test/ng/directive/inputSpec.js
Original file line number Diff line number Diff line change
Expand Up @@ -892,6 +892,51 @@ describe('NgModelController', function() {
dealoc(element);
}));


it('should minimize janky setting of classes during $validate() and ngModelWatch', inject(function($animate, $compile, $rootScope) {
var addClass = $animate.addClass;
var removeClass = $animate.removeClass;
var addClassCallCount = 0;
var removeClassCallCount = 0;
var input;
$animate.addClass = function(element, className) {
// Don't worry about classes that the input already has.
if (input && element[0] === input[0] && (' ' + element.attr('class') + ' ').indexOf(' ' + className + ' ') < 0) {
++addClassCallCount;
}
return addClass.call($animate, element, className);
};

$animate.removeClass = function(element, className) {
// Don't worry about classes that the input doesn't have.
if (input && element[0] === input[0] && (' ' + element.attr('class') + ' ').indexOf(' ' + className + ' ') !== -1) {
++removeClassCallCount;
}
return removeClass.call($animate, element, className);
};

dealoc(element);

$rootScope.value = "123456789";
element = $compile(
'<form name="form">' +
'<input type="text" ng-model="value" name="alias" ng-maxlength="10">' +
'</form>'
)($rootScope);

var form = $rootScope.form;
input = element.children().eq(0);

$rootScope.$digest();

expect(input).toBeValid();
expect(input).not.toHaveClass('ng-invalid-maxlength');
expect(input).toHaveClass('ng-valid-maxlength');
expect(addClassCallCount).toBe(2);
expect(removeClassCallCount).toBe(0);

dealoc(element);
}));
});
});

Expand Down