Директива AngularJS с опциями по умолчанию

Я только начинаю с 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.

Ответы

Ответ 1

Вы можете использовать функцию 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

Используйте флаг =? для свойства в блоке области действия директивы.

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

Ответ 3

Я использую AngularJS v1.5.10 и обнаружил, что preLink компиляции preLink работает достаточно хорошо для установки значений атрибутов по умолчанию.

Просто напоминание:

  • 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: ...
  }
});