ngModel (directive)

Improve this Doc View Source ngModel

directive in module ng

The ngModel directive binds an input,select, textarea (or custom form control) to a property on the scope using NgModelController, which is created and exposed by this directive.

ngModel is responsible for:

Binding the view into the model, which other directives such as input, textarea or select require.
Providing validation behavior (i.e. required, number, email, url).
Keeping the state of the control (valid/invalid, dirty/pristine, touched/untouched, validation errors).
Setting related css classes on the element (ng-valid, ng-invalid, ng-dirty, ng-pristine, ng-touched, ng-untouched) including animations.
Registering the control with its parent form-

Note: ngModel will try to bind to the property given by evaluating the expression on the current scope- If the property doesn't already exist on this scope, it will be created implicitly and added to the scope-

For best practices on using ngModel, see:

Understanding Scopes

For basic examples, how to use ngModel, see:

input
- text
- checkbox
- radio
- number
- email
- url
- date
- datetime-local
- time
- month
- week
select
textarea

CSS classes

The following CSS classes are added and removed on the associated input/select/textarea element depending on the validity of the model.

ng-valid: the model is valid
ng-invalid: the model is invalid
ng-valid-[key]: for each valid key added by $setValidity
ng-invalid-[key]: for each invalid key added by $setValidity
ng-pristine: the control hasn't been interacted with yet
ng-dirty: the control has been interacted with
ng-touched: the control has been blurred
ng-untouched: the control hasn't been blurred
ng-pending: any $asyncValidators are unfulfilled

Keep in mind that ngAnimate can detect each of these classes when added and removed.

Animation Hooks

Animations within models are triggered when any of the associated CSS classes are added and removed on the input element which is attached to the model. These classes are: .ng-pristine, .ng-dirty, .ng-invalid and .ng-valid as well as any other validations that are performed on the model itself. The animations that are triggered within ngModel are similar to how they work in ngClass and animations can be hooked into using CSS transitions, keyframes as well as JS animations.

The following example shows a simple way to utilize CSS transitions to style an input element that has been rendered as invalid after it has been validated:

//be sure to include ngAnimate as a module to hook into more
//advanced animations
.my-input {
  transition:0.5s linear all;
  background: white;
}
.my-input.ng-invalid {
  background: red;
  color:white;
}

Directive Info

This directive executes at priority level 1.

Usage

as attribute:
```
<input>
...
</input>
```

Binding to a getter/setter

Sometimes it's helpful to bind ngModel to a getter/setter function. A getter/setter is a function that returns a representation of the model when called with zero arguments, and sets the internal state of a model when called with an argument. It's sometimes useful to use this for models that have an internal representation that's different than what the model exposes to the view.

Best Practice: It's best to keep getters fast because Angular is likely to call them more frequently than other parts of your code.

You use this behavior by adding ng-model-options="{ getterSetter: true }" to an element that has ng-model attached to it. You can also add ng-model-options="{ getterSetter: true }" to a <form>, which will enable this behavior for all <input>s within it. See ngModelOptions for more.

The following example shows how to use ngModel with a getter/setter:

© 2010–2016 Google, Inc.
Licensed under the Creative Commons Attribution License 4.0.
https://code.angularjs.org/1.3.20/docs/api/ng/directive/ngModel