带有默认选项的 AngularJS 指令

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

我已经看了看周围的方式，其他人已经这样做，在 角度库的 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参数。

87995 次浏览
小开
最佳答案

如果没有设置函数读取属性，可以使用 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; }
},
...
}
});
小开

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

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

我正在使用 AngularJS v1.5.10，发现 preLink编译函数在设置默认属性值方面非常有效。

提醒一下:

  • attrs保存 生的 DOM 属性值，它们总是 undefined或字符串。
  • 根据提供的隔离范围规范(=/</@/etc) ，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: ...
}
});

提交答案