带有默认选项的Angular指令

时间:2013-09-13 10:51:13

标签: javascript angularjs angularjs-directive options default-value

我刚开始使用angularjs,我正在努力将一些旧的JQuery插件转换为Angular指令。我想为my(element)指令定义一组默认选项,可以通过在属性中指定选项值来覆盖它。

我已经看过其他人这样做的方式了,在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参数。

3 个答案:

答案 0 :(得分:252)

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

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';
      }
    }
  });

答案 1 :(得分:106)

您可以使用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; }
    },
        ...
  }
});

答案 2 :(得分:1)

我使用的是AngularJS v1.5.10,发现preLink compile function在设置默认属性值方面工作得很好。

提醒一下:

  • attrs保留 raw DOM属性值,该属性值始终为undefined或字符串。
  • scope根据提供的隔离范围规范(= / < / {{1} } /等)。

摘要片段:

@