AngularJS-创建使用ng-model的指令


294

我正在尝试创建一个指令,该指令将创建与创建指令的元素具有相同ng-model的输入字段。

到目前为止,这是我想到的:

的HTML

<!doctype html>
<html ng-app="plunker" >
<head>
  <meta charset="utf-8">
  <title>AngularJS Plunker</title>
  <link rel="stylesheet" href="style.css">
  <script>document.write("<base href=\"" + document.location + "\" />");</script>
  <script src="https://ajax.googleapis.com/ajax/libs/jquery/1.8.3/jquery.min.js"></script>
  <script src="https://ajax.googleapis.com/ajax/libs/angularjs/1.0.2/angular.js"></script>
  <script src="app.js"></script>
</head>
<body ng-controller="MainCtrl">
  This scope value <input ng-model="name">
  <my-directive ng-model="name"></my-directive>
</body>
</html>

的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: '<div class="some"><label for="{{id}}">{{label}}</label>' +
      '<input id="{{id}}" ng-model="value"></div>',
    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);
    }
  };
});

但是,我不确定这是处理这种情况的正确方法,并且存在一个错误,即我的控件未使用ng-model target字段的值初始化。

这是上面代码的简称:http ://plnkr.co/edit/IvrDbJ

处理此问题的正确方法是什么?

编辑ng-model="value"从模板中删除后,这似乎工作正常。但是,我将继续公开这个问题,因为我想再次确认这是正确的方法。


1
如果删除scope并将其设置为scope: false怎么办?ng-model在这种情况下如何绑定?
Saeed Neamati

Answers:


210

编辑:这个答案是旧的,可​​能已经过时。只是抬起头,这样就不会使人们误入歧途。我不再使用Angular,因此无法进行改进。


这实际上是相当不错的逻辑,但是您可以稍微简化一下。

指示

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: '<div class="some">' +
      '<input ng-model="myDirectiveVar"></div>',
    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与指令

<body ng-controller="MainCtrl">
  This scope value <input ng-model="name">
  <my-directive my-directive-var="name"></my-directive>
</body>

的CSS

.some {
  border: 1px solid #cacaca;
  padding: 10px;
}

您可以在此Plunker上看到它的实际效果

这是我看到的:

  • 我了解您为什么要使用“ ng-model”,但在您的情况下没有必要。ng-model用于将现有 html元素与范围中的值链接。由于您自己创建指令,因此要创建“新” html元素,因此不需要ng-model。

编辑正如Mark在其评论中提到的那样,没有理由您不能使用ng-model,只是为了遵守约定。

  • 通过在指令中显式创建一个作用域(“隔离”作用域),该指令的作用域无法访问父作用域上的“名称”变量(这就是我想使用ng-model的原因)。
  • 我从指令中删除了ngModel,并将其替换为可以更改为任何名称的自定义名称。
  • 使一切仍然有效的是在范围内使用'='。在“ scope”标题下签出docs docs

通常,如果您希望指令中的值始终映射到父范围中的值,则指令应使用隔离范围(正确执行)并使用'='类型范围。


18
+1,但我不确定我是否同意“ ng-model是将现有HTML元素与作用域中的值链接”这样的语句。contenteditableAngular文档中的两个指令示例- 表单页面NgModelController页面 -都使用ng-model。ngModelController页面说,此控制器“仅打算由其他指令扩展”。
Mark Rajcok

33
我不确定为什么这个答案的评价如此之高,因为它没有完成最初的问题-使用ngModel。是的,可以通过将状态放在父控制器中来避免使用ngModel,但这是以两个控制器紧密绑定且无法独立使用/重用它们为代价的。这就像使用全局变量,而不是在两个组件之间设置侦听器-从技术上讲,它可能更简单,但在大多数情况下并不是一个好的解决方案。
Pat Niemeyer 2014年

我要补充一点,如果他想依赖于父控制器,则无论如何都要给它注入'require:^ parent'-这样他就可以使依赖项显式和可选(如果需要)。
Pat Niemeyer 2014年

3
@Jeroen我认为它的主要好处是与传递模型的其他地方保持一致hg-model(而不是IMO的耦合问题)。这样,无论是a <input>还是自定义指令,数据上下文始终使用ng-model ,从而简化了HTML编写器的认知开销。也就是说,它节省了HTML编写者不必找出my-directive-var每个指令的名称的含义,尤其是因为没有自动完成功能可以帮助您。
zai chang 2015年

2
嗯...好...但是现在这不再适用于ng-model-optionsng模型或其他任何ng模型了,对吗?
乔治·莫尔

68

我结合了所有答案,现在有两种使用ng-model属性的方法:

  • 具有复制ngModel的新作用域
  • 具有在链接上进行编译的相同作用域

我不确定我是否喜欢在链接时进行编译。但是,如果只是将元素替换为另一个元素,则不需要这样做。

总而言之,我更喜欢第一个。只需将范围{ngModel:"="}设置为ng-model="ngModel",并在模板中设置所需位置即可。

更新:我内联了代码片段,并针对Angular v1.2对其进行了更新。事实证明,隔离范围仍然是最佳的,尤其是在不使用jQuery时。因此归结为:

  • 您是否要替换单个元素:只需替换它,不理会范围,但请注意,v2.0不推荐使用replace:

    app.directive('myReplacedDirective', function($compile) {
      return {
        restrict: 'E',
        template: '<input class="some">',
        replace: true
      };
    });
  • 否则使用此:

    app.directive('myDirectiveWithScope', function() {
      return {
        restrict: 'E',
        scope: {
          ngModel: '=',
        },
        template: '<div class="some"><input ng-model="ngModel"></div>'
      };
    });

1
我用所有三种作用域以及模板的子元素或模板的根元素更新了插件。
w00t 2013年

1
太好了,但是您实际上如何使它成为可选的?我正在为UI库创建一个textbox指令,并且我希望模型是可选的,这意味着如果未设置ngModel,文本框仍然可以使用。
尼克·拉德福德

1
@NickRadford只需检查ngModel是否在$ scope上定义,如果没有定义,就不要使用它吗?
w00t 2013年

1
ng-model在隔离范围内重用会不会有任何问题或额外的开销?
Jeff Ling

2
@jeffling不确定,但我不这么认为。复制ngModel非常轻巧,隔离范围限制了曝光。
w00t

52

它并不那么复杂:在命令中,使用别名: scope:{alias:'=ngModel'}

.directive('dateselect', function () {
return {
    restrict: 'E',
    transclude: true,
    scope:{
        bindModel:'=ngModel'
    },
    template:'<input ng-model="bindModel"/>'
}

在您的html中,照常使用

<dateselect ng-model="birthday"></dateselect>

1
当处理诸如Kendo UI之类的库时,这要容易得多。谢谢!
bytebender

30

仅在需要访问模型的$ viewValue或$ modelValue时才需要ng-model。参见NgModelController。在这种情况下,您可以使用require: '^ngModel'

有关其他内容,请参见Roys答案


2
即使您不需要$ viewValue或$ modelValue,ng-model也很有用。即使您只想要ng-model的数据绑定功能(如@kolrie的示例),它也很有用。
Mark Rajcok

1
并且^只有当ng-model应用于父元素时,才应存在
georgiosd

18

这是一个有点晚的答案,但是我发现了关于的很棒的帖子NgModelController,我认为这正是您想要的。

TL; DR-您可以使用require: 'ngModel'然后添加NgModelController到链接功能:

link: function(scope, iElement, iAttrs, ngModelCtrl) {
  //TODO
}

这样,无需黑客-您正在使用Angular的内置 ng-model


2

我不会通过属性设置ngmodel,您可以在模板中直接指定它:

template: '<div class="some"><label>{{label}}</label><input data-ng-model="ngModel"></div>',

朋克http : //plnkr.co/edit/9vtmnw?p=preview


0

从Angular 1.5开始,可以使用Components。组件是随时可以解决的问题。

<myComponent data-ng-model="$ctrl.result"></myComponent>

app.component("myComponent", {
    templateUrl: "yourTemplate.html",
    controller: YourController,
    bindings: {
        ngModel: "="
    }
});

在YourController内,您需要做的是:

this.ngModel = "x"; //$scope.$apply("$ctrl.ngModel"); if needed

我发现的是,如果确实使用“ =”而不是“ <”,那么它会起作用,否则这是使用组件的最佳实践。我不确定这个答案的“ inside YourController”部分是什么意思,这不是要在组件内部设置ngModel吗?
Marc Stober '02

1
@MarcStober使用“ inside YourController”,我只想表明ngModel可以用作getter和setter。在此示例中,$ ctrl.result将变为“ x”。
Niels Steenbeek

好。我认为重要的另一部分是,您也可以在控制器模板中执行此操作input ng-model="$ctrl.ngModel",它还将与$ ctrl.result同步。
Marc Stober

0

创建隔离范围是不可取的。我会避免使用scope属性,而是这样做。scope:true可为您提供新的子范围,但不能隔离。然后使用解析将局部作用域变量指向用户提供给ngModel属性的同一对象。

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);
        }
    };
}]);
By using our site, you acknowledge that you have read and understand our Cookie Policy and Privacy Policy.
Licensed under cc by-sa 3.0 with attribution required.