javascript Diretiva Angular com opções padrão




angular title (3)

Estou usando o AngularJS v1.5.10 e descobri que a função de compilação preLink funciona bem para configurar valores de atributo padrão.

Apenas um lembrete:

  • attrs contém os valores brutos do atributo DOM que são sempre undefined ou strings.
  • scope contém (entre outras coisas) os valores do atributo DOM analisados ​​de acordo com a especificação de escopo isolada fornecida ( = / < / @ / etc.).

Snippet abreviado:

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

Eu estou apenas começando com angularjs e estou trabalhando na conversão de alguns plugins antigos do JQuery para diretivas Angular. Gostaria de definir um conjunto de opções padrão para minha diretiva (element), que pode ser substituída especificando o valor da opção em um atributo.

Eu dei uma olhada na maneira como os outros fizeram isso, e na biblioteca angular-ui o ui.bootstrap.pagination parece fazer algo similar.

Primeiro todas as opções padrão são definidas em um objeto constante:

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

Em seguida, uma função do utilitário getAttributeValue é anexada ao controlador de diretriz:

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

Finalmente, isso é usado na função de vinculação para ler em atributos como

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

Isso parece ser uma configuração bastante complicada para algo tão padrão quanto querer substituir um conjunto de valores padrão. Existem outras maneiras de fazer isso que são comuns? Ou é normal sempre definir uma função de utilidade como getAttributeValue e analisar as opções dessa maneira? Estou interessado em descobrir que estratégias diferentes as pessoas têm para essa tarefa comum.

Além disso, como bônus, não estou claro por que o parâmetro interpolate é necessário.


Answer #1

Use o =? sinalizador para a propriedade no bloco de escopo da diretiva.

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

Answer #2

Você pode usar a função de compile - leia atributos se eles não estiverem configurados - preencha-os com os valores padrão.

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




default-value