在AngularJS中添加指令中的指令

时间:2013-10-07 11:44:42

标签: javascript angularjs model-view-controller mvvm angularjs-directive

我正在尝试构建一个指令来处理向其声明的元素添加更多指令。 例如,我想构建一个指令,负责添加datepickerdatepicker-languageng-required="true"

如果我尝试添加这些属性然后使用$compile我显然会生成一个无限循环,所以我正在检查是否已经添加了所需的属性:

angular.module('app')
  .directive('superDirective', function ($compile, $injector) {
    return {
      restrict: 'A',
      replace: true,
      link: function compile(scope, element, attrs) {
        if (element.attr('datepicker')) { // check
          return;
        }
        element.attr('datepicker', 'someValue');
        element.attr('datepicker-language', 'en');
        // some more
        $compile(element)(scope);
      }
    };
  });

当然,如果我没有$compile元素,那么将设​​置属性,但不会引导该指令。

这种方法是正确的还是我做错了?有没有更好的方法来实现相同的行为?

UDPATE :鉴于$compile是实现此目的的唯一方法,有没有办法跳过第一个编译传递(该元素可能包含多个子元素)?也许可以设置terminal:true

UPDATE 2 :我已经尝试将指令放入select元素中,并且正如预期的那样,编译运行两次,这意味着预期的{{1}数量的两倍}第

7 个答案:

答案 0 :(得分:258)

如果您在单个DOM元素上有多个指令,那么 它们应用的顺序很重要,您可以使用priority属性来订购它们 应用。更高的数字首先运行。如果您未指定,则默认优先级为0.

编辑:讨论结束后,这是完整的解决方案。关键是删除属性element.removeAttr("common-things");,还有element.removeAttr("data-common-things");(如果用户在html中指定data-common-things

angular.module('app')
  .directive('commonThings', function ($compile) {
    return {
      restrict: 'A',
      replace: false, 
      terminal: true, //this setting is important, see explanation below
      priority: 1000, //this setting is important, see explanation below
      compile: function compile(element, attrs) {
        element.attr('tooltip', '{{dt()}}');
        element.attr('tooltip-placement', 'bottom');
        element.removeAttr("common-things"); //remove the attribute to avoid indefinite loop
        element.removeAttr("data-common-things"); //also remove the same attribute with data- prefix in case users specify data-common-things in the html

        return {
          pre: function preLink(scope, iElement, iAttrs, controller) {  },
          post: function postLink(scope, iElement, iAttrs, controller) {  
            $compile(iElement)(scope);
          }
        };
      }
    };
  });

可以在http://plnkr.co/edit/Q13bUt?p=preview

找到工作人员

或者:

angular.module('app')
  .directive('commonThings', function ($compile) {
    return {
      restrict: 'A',
      replace: false,
      terminal: true,
      priority: 1000,
      link: function link(scope,element, attrs) {
        element.attr('tooltip', '{{dt()}}');
        element.attr('tooltip-placement', 'bottom');
        element.removeAttr("common-things"); //remove the attribute to avoid indefinite loop
        element.removeAttr("data-common-things"); //also remove the same attribute with data- prefix in case users specify data-common-things in the html

        $compile(element)(scope);
      }
    };
  });

DEMO

解释为什么我们必须设置terminal: truepriority: 1000(高数字):

当DOM准备就绪时,angular会遍历DOM以识别所有已注册的指令,并根据priority 逐个编译指令(如果这些指令位于同一元素)。我们将自定义指令的优先级设置为较大的数字以确保它将被编译为第一个并且使用terminal: true,其他指令将在被跳过之后编译。

当编译我们的自定义指令时,它将通过添加指令并删除自身来修改元素,并使用$ compile服务来编译所有指令(包括那些被跳过的指令)

如果我们没有设置terminal:truepriority: 1000,则有可能在我们的自定义指令之前编译某些指令。当我们的自定义指令使用$ compile来编译element =>再次编译已编译的指令。这将导致不可预测的行为,特别是如果在我们的自定义指令之前编译的指令已经转换了DOM。

有关优先级和终端的更多信息,请查看How to understand the `terminal` of directive?

同样修改模板的指令示例是ng-repeat(优先级= 1000),编译ng-repeat时,ng-repeat 在其他模板元素之前复制模板元素指令得到应用

感谢@ Izhaki的评论,以下是对ngRepeat源代码的引用:https://github.com/angular/angular.js/blob/master/src/ng/directive/ngRepeat.js

答案 1 :(得分:10)

您只需使用简单的模板标记即可实现所有这些功能。有关示例,请参阅http://jsfiddle.net/m4ve9/。请注意,我实际上不需要超指令定义的编译或链接属性。

在编译过程中,Angular会在编译之前提取模板值,因此您可以在那里附加任何其他指令,Angular会为您处理它。

如果这是一个需要保留原始内部内容的超级指令,您可以使用transclude : true并将内部替换为<ng-transclude></ng-transclude>

希望有所帮助,如果有什么不清楚,请告诉我

亚历

答案 2 :(得分:6)

这是一个将需要动态添加的指令移入视图并添加一些可选(基本)条件逻辑的解决方案。这使得指令保持干净,没有硬编码逻辑。

该指令采用一组对象,每个对象包含要添加的指令的名称和传递给它的值(如果有的话)。

我很难想到像这样的指令的用例,直到我认为添加一些只根据某些条件添加指令的条件逻辑可能是有用的(尽管下面的答案仍然是设计的)。我添加了一个可选的if属性,该属性应该包含一个bool值,表达式或函数(例如在控制器中定义),用于确定是否应该添加该指令。

我还使用attrs.$attr.dynamicDirectives来获取用于添加指令的确切属性声明(例如data-dynamic-directivedynamic-directive),而无需硬编码字符串值进行检查。

Plunker Demo

&#13;
&#13;
angular.module('plunker', ['ui.bootstrap'])
    .controller('DatepickerDemoCtrl', ['$scope',
        function($scope) {
            $scope.dt = function() {
                return new Date();
            };
            $scope.selects = [1, 2, 3, 4];
            $scope.el = 2;

            // For use with our dynamic-directive
            $scope.selectIsRequired = true;
            $scope.addTooltip = function() {
                return true;
            };
        }
    ])
    .directive('dynamicDirectives', ['$compile',
        function($compile) {
            
             var addDirectiveToElement = function(scope, element, dir) {
                var propName;
                if (dir.if) {
                    propName = Object.keys(dir)[1];
                    var addDirective = scope.$eval(dir.if);
                    if (addDirective) {
                        element.attr(propName, dir[propName]);
                    }
                } else { // No condition, just add directive
                    propName = Object.keys(dir)[0];
                    element.attr(propName, dir[propName]);
                }
            };
            
            var linker = function(scope, element, attrs) {
                var directives = scope.$eval(attrs.dynamicDirectives);
        
                if (!directives || !angular.isArray(directives)) {
                    return $compile(element)(scope);
                }
               
                // Add all directives in the array
                angular.forEach(directives, function(dir){
                    addDirectiveToElement(scope, element, dir);
                });
                
                // Remove attribute used to add this directive
                element.removeAttr(attrs.$attr.dynamicDirectives);
                // Compile element to run other directives
                $compile(element)(scope);
            };
        
            return {
                priority: 1001, // Run before other directives e.g.  ng-repeat
                terminal: true, // Stop other directives running
                link: linker
            };
        }
    ]);
&#13;
<!doctype html>
<html ng-app="plunker">

<head>
    <script src="//code.angularjs.org/1.2.20/angular.js"></script>
    <script src="//angular-ui.github.io/bootstrap/ui-bootstrap-tpls-0.6.0.js"></script>
    <script src="example.js"></script>
    <link href="//netdna.bootstrapcdn.com/twitter-bootstrap/2.3.1/css/bootstrap-combined.min.css" rel="stylesheet">
</head>

<body>

    <div data-ng-controller="DatepickerDemoCtrl">

        <select data-ng-options="s for s in selects" data-ng-model="el" 
            data-dynamic-directives="[
                { 'if' : 'selectIsRequired', 'ng-required' : '{{selectIsRequired}}' },
                { 'tooltip-placement' : 'bottom' },
                { 'if' : 'addTooltip()', 'tooltip' : '{{ dt() }}' }
            ]">
            <option value=""></option>
        </select>

    </div>
</body>

</html>
&#13;
&#13;
&#13;

答案 3 :(得分:3)

我想添加我的解决方案,因为接受的解决方案并不适合我。

我需要添加一个指令,但也要保留我的元素。

在这个例子中,我向元素添加了一个简单的ng-style指令。为了防止无限的编译循环并允许我保留我的指令,我在重新编译元素之前添加了一个检查以查看我添加的内容是否存在。

angular.module('some.directive', [])
.directive('someDirective', ['$compile',function($compile){
    return {
        priority: 1001,
        controller: ['$scope', '$element', '$attrs', '$transclude' ,function($scope, $element, $attrs, $transclude) {

            // controller code here

        }],
        compile: function(element, attributes){
            var compile = false;

            //check to see if the target directive was already added
            if(!element.attr('ng-style')){
                //add the target directive
                element.attr('ng-style', "{'width':'200px'}");
                compile = true;
            }
            return {
                pre: function preLink(scope, iElement, iAttrs, controller) {  },
                post: function postLink(scope, iElement, iAttrs, controller) {
                    if(compile){
                        $compile(iElement)(scope);
                    }
                }
            };
        }
    };
}]);

答案 4 :(得分:1)

尝试将状态存储在元素本身的属性中,例如superDirectiveStatus="true"

例如:

angular.module('app')
  .directive('superDirective', function ($compile, $injector) {
    return {
      restrict: 'A',
      replace: true,
      link: function compile(scope, element, attrs) {
        if (element.attr('datepicker')) { // check
          return;
        }
        var status = element.attr('superDirectiveStatus');
        if( status !== "true" ){
             element.attr('datepicker', 'someValue');
             element.attr('datepicker-language', 'en');
             // some more
             element.attr('superDirectiveStatus','true');
             $compile(element)(scope);

        }

      }
    };
  });

我希望这会对你有所帮助。

答案 5 :(得分:1)

从1.3.x变为1.4.x。

在Angular 1.3.x中,这有效:

var dir: ng.IDirective = {
    restrict: "A",
    require: ["select", "ngModel"],
    compile: compile,
};

function compile(tElement: ng.IAugmentedJQuery, tAttrs, transclude) {
    tElement.append("<option value=''>--- Kein ---</option>");

    return function postLink(scope: DirectiveScope, element: ng.IAugmentedJQuery, attributes: ng.IAttributes) {
        attributes["ngOptions"] = "a.ID as a.Bezeichnung for a in akademischetitel";
        scope.akademischetitel = AkademischerTitel.query();
    }
}

现在在Angular 1.4.x中我们必须这样做:

var dir: ng.IDirective = {
    restrict: "A",
    compile: compile,
    terminal: true,
    priority: 10,
};

function compile(tElement: ng.IAugmentedJQuery, tAttrs, transclude) {
    tElement.append("<option value=''>--- Kein ---</option>");
    tElement.removeAttr("tq-akademischer-titel-select");
    tElement.attr("ng-options", "a.ID as a.Bezeichnung for a in akademischetitel");

    return function postLink(scope: DirectiveScope, element: ng.IAugmentedJQuery, attributes: ng.IAttributes) {

        $compile(element)(scope);
        scope.akademischetitel = AkademischerTitel.query();
    }
}

(从接受的答案:来自Khanh TO的https://stackoverflow.com/a/19228302/605586)。

答案 6 :(得分:0)

在某些情况下可以使用的简单解决方案是创建和$编译包装器,然后将原始元素附加到它。

像...一样的东西。

link: function(scope, elem, attr){
    var wrapper = angular.element('<div tooltip></div>');
    elem.before(wrapper);
    $compile(wrapper)(scope);
    wrapper.append(elem);
}

此解决方案的优点是不会重新编译原始元素,从而使事情变得简单。

如果任何添加的指令require任何原始元素的指令或者原始元素具有绝对定位,那么这将不起作用。