AngularJS - Create a directive that uses ng-model

Question

I am trying to create a directive that would create an input field with the same ng-model as the element that creates the directive   Here s what I came up with so far   HTML   lt  doctype html gt   lt html ng-app  plunker   gt   lt head gt     lt meta charset  utf-8  gt     lt title gt AngularJS Plunker lt  title gt     lt link rel  stylesheet  href  style css  gt     lt script gt document write   lt base href       document location         gt     lt  script gt     lt script src  https   ajax googleapis com ajax libs jquery 1 8 3 jquery min js  gt  lt  script gt     lt script src  https   ajax googleapis com ajax libs angularjs 1 0 2 angular js  gt  lt  script gt     lt script src  app js  gt  lt  script gt   lt  head gt   lt body ng-controller  MainCtrl  gt    This scope value  lt input ng-model  name  gt     lt my-directive ng-model  name  gt  lt  my-directive gt   lt  body gt   lt  html gt    JavaScript  var app   angular module  plunker         app controller  MainCtrl   function  scope       scope name    Felipe        app directive  myDirective   function  compile      return       restrict   E       scope          ngModel                 template    lt div class  some  gt  lt label for    id    gt   label   lt  label gt             lt input id    id    ng-model  value  gt  lt  div gt        replace  true      require   ngModel       link  function  scope  elem  attr  ctrl           scope label   attr ngModel         scope id   attr ngModel        console debug attr ngModel         console debug  scope  parent  eval attr ngModel          var textField      input   elem           attr  ng-model   attr ngModel           val  scope  parent  eval attr ngModel            compile textField   scope  parent                    However  I am not confident this is the right way to handle this scenario  and there is a bug that my control is not getting initialized with the value of the ng-model target field   Here s a Plunker of the code above  http   plnkr co edit IvrDbJ  What s the correct way of handling this   EDIT  After removing the ng-model  value  from the template  this seems to be working fine  However  I will keep this question open because I want to double check this is the right way of doing this

User · Answer

You only need ng-model when you need to access the model s  viewValue or  modelValue  See NgModelController  And in that case  you would use require    ngModel    For the rest  see Roys answer

User · Answer

I took a combo of all answers  and now have two ways of doing this with the ng-model attribute    With a new scope which copies ngModel With the same scope which does a compile on link    x000D   x000D  var app   angular module  model        x000D   x000D  app controller  MainCtrl   function  scope    x000D     scope name    Felipe   x000D     scope label    The Label   x000D      x000D   x000D  app directive  myDirectiveWithScope   function     x000D    return   x000D      restrict   E   x000D      scope    x000D        ngModel       x000D         x000D         Notice how label isn t copied x000D      template    lt div class  some  gt  lt label gt   label     lt input ng-model  ngModel  gt  lt  label gt  lt  div gt    x000D      replace  true x000D       x000D      x000D  app directive  myDirectiveWithChildScope   function  compile    x000D    return   x000D      restrict   E   x000D      scope  true  x000D         Notice how label is visible in the scope x000D      template    lt div class  some  gt  lt label gt   label     lt input gt  lt  label gt  lt  div gt    x000D      replace  true  x000D      link  function   scope  element    x000D           element will be the div which gets the ng-model on the original directive x000D        var model   element attr  ng-model    x000D           input  element  attr  ng-model   model   x000D        return  compile element   scope   x000D        x000D       x000D      x000D  app directive  myDirectiveWithoutScope   function  compile    x000D    return   x000D      restrict   E   x000D      template    lt div class  some  gt  lt label gt    parent label     lt input gt  lt  label gt  lt  div gt    x000D      replace  true  x000D      link  function   scope  element    x000D           element will be the div which gets the ng-model on the original directive x000D        var model   element attr  ng-model    x000D        return  compile    input  element  attr  ng-model   model    scope   x000D        x000D       x000D      x000D  app directive  myReplacedDirectiveIsolate   function  compile    x000D    return   x000D      restrict   E   x000D      scope      x000D      template    lt input class  some  gt    x000D      replace  true x000D       x000D      x000D  app directive  myReplacedDirectiveChild   function  compile    x000D    return   x000D      restrict   E   x000D      scope  true  x000D      template    lt input class  some  gt    x000D      replace  true x000D       x000D      x000D  app directive  myReplacedDirective   function  compile    x000D    return   x000D      restrict   E   x000D      template    lt input class  some  gt    x000D      replace  true x000D       x000D      x000D   some   x000D    border  1px solid  cacaca  x000D    padding  10px  x000D    x000D   lt script src  https   ajax googleapis com ajax libs jquery 2 1 1 jquery min js  gt  lt  script gt  x000D   lt script src  https   ajax googleapis com ajax libs angularjs 1 2 0 angular min js  gt  lt  script gt  x000D   lt div ng-app  model  ng-controller  MainCtrl  gt  x000D    This scope value  lt input ng-model  name  gt   label     label    x000D     lt ul gt  x000D       lt li gt With new isolate scope  label from parent   x000D         lt my-directive-with-scope ng-model  name  gt  lt  my-directive-with-scope gt  x000D       lt  li gt  x000D       lt li gt With new child scope  x000D         lt my-directive-with-child-scope ng-model  name  gt  lt  my-directive-with-child-scope gt  x000D       lt  li gt  x000D       lt li gt Same scope  x000D         lt my-directive-without-scope ng-model  name  gt  lt  my-directive-without-scope gt  x000D       lt  li gt  x000D       lt li gt Replaced element  isolate scope  x000D         lt my-replaced-directive-isolate ng-model  name  gt  lt  my-replaced-directive-isolate gt  x000D       lt  li gt  x000D       lt li gt Replaced element  child scope  x000D         lt my-replaced-directive-child ng-model  name  gt  lt  my-replaced-directive-child gt  x000D       lt  li gt  x000D       lt li gt Replaced element  same scope  x000D         lt my-replaced-directive ng-model  name  gt  lt  my-replaced-directive gt  x000D       lt  li gt  x000D     lt  ul gt  x000D     lt p gt Try typing in the child scope ones  they copy the value into the child scope which breaks the link with the parent scope  x000D     lt p gt Also notice how removing jQuery makes it so only the new-isolate-scope version works  x000D     lt p gt Finally  note that the replace isolate scope only works in AngularJS  gt  1 2 0 x000D   lt  div gt  x000D   x000D   x000D    I m not sure I like the compiling at link time  However  if you re just replacing the element with another you don t need to do that   All in all I prefer the first one  Simply set scope to  ngModel      and set ng-model  ngModel  where you want it in your template   Update  I inlined the code snippet and updated it for Angular v1 2  Turns out that isolate scope is still best  especially when not using jQuery  So it boils down to    Are you replacing a single element  Just replace it  leave the scope alone  but note that replace is deprecated for v2 0   app directive  myReplacedDirective   function  compile      return       restrict   E       template    lt input class  some  gt        replace  true           Otherwise use this   app directive  myDirectiveWithScope   function       return       restrict   E       scope          ngModel                  template    lt div class  some  gt  lt input ng-model  ngModel  gt  lt  div gt

User · Answer

I wouldn t set the ngmodel via an attribute  you can specify it right in the template   template    lt div class  some  gt  lt label gt   label   lt  label gt  lt input data-ng-model  ngModel  gt  lt  div gt      plunker  http   plnkr co edit 9vtmnw p preview

User · Answer

EDIT  This answer is old and likely out of date   Just a heads up so it doesn t lead folks astray   I no longer use Angular so I m not in a good position to make improvements     It s actually pretty good logic but you can simplify things a bit   Directive  var app   angular module  plunker         app controller  MainCtrl   function  scope       scope model     name   World        scope name    Felipe        app directive  myDirective   function  compile      return       restrict   AE     attribute or element     scope          myDirectiveVar              bindAttr                 template    lt div class  some  gt             lt input ng-model  myDirectiveVar  gt  lt  div gt        replace  true        require   ngModel       link  function  scope  elem  attr  ctrl          console debug  scope           var textField      input   elem  attr  ng-model    myDirectiveVar              compile textField   scope  parent                    Html with directive   lt body ng-controller  MainCtrl  gt    This scope value  lt input ng-model  name  gt     lt my-directive my-directive-var  name  gt  lt  my-directive gt   lt  body gt    CSS   some     border  1px solid  cacaca    padding  10px      You can see it in action with this Plunker   Here s what I see    I understand why you want to use  ng-model  but in your case it s not necessary   ng-model is to link existing html elements with a value in the scope   Since you re creating a directive yourself you re creating a  new  html element  so you don t need ng-model    EDIT As mentioned by Mark in his comment  there s no reason that you can t use ng-model  just to keep with convention    By explicitly creating a scope in your directive  an  isolated  scope   the directive s scope cannot access the  name  variable on the parent scope  which is why  I think  you wanted to use ng-model   I removed ngModel from your directive and replaced it with a custom name that you can change to whatever  The thing that makes it all still work is that     sign in the scope   Checkout the docs  docs under the  scope  header    In general  your directives should use the isolated scope  which you did correctly  and use the     type scope if you want a value in your directive to always map to a value in the parent scope

User · Answer

it  s not so complicated  in your dirctive  use an alias  scope  alias   ngModel     directive  dateselect   function      return       restrict   E       transclude  true      scope           bindModel   ngModel             template   lt input ng-model  bindModel   gt       in your html  use as normal   lt dateselect ng-model  birthday  gt  lt  dateselect gt

User · Answer

This is a little late answer  but I found this awesome post about NgModelController  which I think is exactly what you were looking for    TL DR - you can use require   ngModel  and then add NgModelController to your linking function   link  function scope  iElement  iAttrs  ngModelCtrl        TODO     This way  no hacks needed - you are using Angular s built-in ng-model

User · Answer

Creating an isolate scope is undesirable  I would avoid using the scope attribute and do something like this  scope true gives you a new child scope but not isolate  Then use parse to point a local scope variable to the same object the user has supplied to the ngModel attribute   app directive  myDir      parse   function   parse        return           restrict   EA           scope  true          link  function  scope  elem  attrs                if  attrs ngModel   return               var model    parse attrs ngModel               scope model   model scope

User · Answer

Since Angular 1 5 it s possible to use Components  Components are the-way-to-go and solves this problem easy    lt myComponent data-ng-model   ctrl result  gt  lt  myComponent gt   app component  myComponent         templateUrl   yourTemplate html       controller  YourController      bindings            ngModel                  Inside YourController all you need to do is   this ngModel    x      scope  apply   ctrl ngModel    if needed

[angularjs] AngularJS - Create a directive that uses ng-model

Examples related to angularjs

Examples related to directive