带有默认选项的AngularJS指令


145

我只是从angularjs开始,并且正在努力将一些旧的JQuery插件转换为Angular指令。我想为我的(元素)指令定义一组默认选项,可以通过在属性中指定选项值来覆盖这些默认选项。

我一直在寻找其他人这样做的方式,并且在angular-ui库中ui.bootstrap.pagination似乎做了类似的事情。

首先,所有默认选项都在常量对象中定义:

.constant('paginationConfig', {
  itemsPerPage: 10,
  boundaryLinks: false,
  ...
})

然后,将getAttributeValue实用程序功能附加到指令控制器:

this.getAttributeValue = function(attribute, defaultValue, interpolate) {
    return (angular.isDefined(attribute) ?
            (interpolate ? $interpolate(attribute)($scope.$parent) :
                           $scope.$parent.$eval(attribute)) : defaultValue);
};

最后,在链接函数中使用它来读入属性

.directive('pagination', ['$parse', 'paginationConfig', function($parse, config) {
    ...
    controller: 'PaginationController',
    link: function(scope, element, attrs, paginationCtrl) {
        var boundaryLinks = paginationCtrl.getAttributeValue(attrs.boundaryLinks,  config.boundaryLinks);
        var firstText = paginationCtrl.getAttributeValue(attrs.firstText, config.firstText, true);
        ...
    }
});

对于一些想要替换一组默认值的标准设置来说,这似乎是一个相当复杂的设置。还有其他通用的方法吗?还是总是getAttributeValue以这种方式定义实用程序功能(例如和分析选项)是正常的吗?我有兴趣找出人们对于这项共同任务有哪些不同的策略。

另外,作为奖励,我不清楚为什么interpolate需要该参数。

Answers:


108

您可以使用compile函数-如果未设置属性,则读取属性-用默认值填充属性。

.directive('pagination', ['$parse', 'paginationConfig', function($parse, config) {
    ...
    controller: 'PaginationController',
    compile: function(element, attrs){
       if (!attrs.attrOne) { attrs.attrOne = 'default value'; }
       if (!attrs.attrTwo) { attrs.attrTwo = 42; }
    },
        ...
  }
});

1
谢谢!那么,对于为什么ui.bootstrap.pagination事情会以更复杂的方式产生任何想法呢?认为如果使用compile函数,以后所做的任何属性更改都不会反映出来,但这似乎不正确,因为在此阶段仅设置了默认值。猜猜这里必须进行一些权衡。
肯·查菲尔德

3
@KenChatfield中的compile您无法读取属性,应该对其进行插值以获得值(包含表达式)。但是,如果您只想检查属性是否为空-它将在没有任何权衡的情况下起作用(在插值属性将包含带有表达式的字符串之前)。
OZ_

1
太棒了!非常感谢您的明确解释。对于将来的读者,尽管与原始问题相切,但为了解释示例中的“插值”参数的作用,ui.bootstrap.pagination我发现了这个非常有用的示例:jsfiddle.net/EGfgH
Ken Chatfield

非常感谢您的解决方案。请注意,如果您需要link选项,仍可以选项中返回一个函数compiledoc在这里
mneute

4
请记住,属性需要值,就像它们从模板传递一样。如果您要传递数组fe,则应attributes.foo = '["one", "two", "three"]'改为attributes.foo = ["one", "two", "three"]
Dominik Ehrenberg

263

使用=?标志的指令范围块的属性。

angular.module('myApp',[])
  .directive('myDirective', function(){
    return {
      template: 'hello {{name}}',
      scope: {
        // use the =? to denote the property as optional
        name: '=?'
      },
      controller: function($scope){
        // check if it was defined.  If not - set a default
        $scope.name = angular.isDefined($scope.name) ? $scope.name : 'default name';
      }
    }
  });

4
=?自1.1.x起可用
Michael Radionov

34
如果您的属性可以接受truefalse作为值,则(我认为)您想使用eg $scope.hasName = angular.isDefined($scope.hasName) ? $scope.hasName : false;代替。
Paul D. Waite,2014年

22
注意:它仅适用于双向绑定,例如=?,但不适用于单向绑定@?
Justus Romijn 2014年

20
也只能在模板中完成:template:'hello {{name || \'默认名称\'}}'
直到2014年

4
是否应在控制器或link功能中设置默认值?根据我的理解,在期间进行分配link应该避免$scope.$apply()循环,不是吗?
奥古斯丁·里丁格

1

我正在使用AngularJS v1.5.10并找到了preLinkcompile函数在设置默认属性值时效果很好。

只是提醒:

  • attrs保存原始 DOM属性值,该值始终为undefined或字符串。
  • scope成立(除其他外)的DOM属性值解析按照所提供的分离范围规范(=/ </ @/等)。

简短摘要:

.directive('myCustomToggle', function () {
  return {
    restrict: 'E',
    replace: true,
    require: 'ngModel',
    transclude: true,
    scope: {
      ngModel: '=',
      ngModelOptions: '<?',
      ngTrueValue: '<?',
      ngFalseValue: '<?',
    },
    link: {
      pre: function preLink(scope, element, attrs, ctrl) {
        // defaults for optional attributes
        scope.ngTrueValue = attrs.ngTrueValue !== undefined
          ? scope.ngTrueValue
          : true;
        scope.ngFalseValue = attrs.ngFalseValue !== undefined
          ? scope.ngFalseValue
          : false;
        scope.ngModelOptions = attrs.ngModelOptions !== undefined
          ? scope.ngModelOptions
          : {};
      },
      post: function postLink(scope, element, attrs, ctrl) {
        ...
        function updateModel(disable) {
          // flip model value
          var newValue = disable
            ? scope.ngFalseValue
            : scope.ngTrueValue;
          // assign it to the view
          ctrl.$setViewValue(newValue);
          ctrl.$render();
        }
        ...
    },
    template: ...
  }
});
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.