web-dev-qa-db-ja.com

デフォルトのオプションを持つAngularJSディレクティブ

Anglejsから始めて、いくつかの古いJQueryプラグインをAngularディレクティブに変換する作業をしています。 （要素）ディレクティブの一連のデフォルトオプションを定義したいのですが、属性でオプション値を指定することでオーバーライドできます。

私は他の人がこれを行った方法を見て回っていましたが、 angular-ui ライブラリでは i.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パラメーターが必要な理由がわかりません。

javascriptangularjsangularjs-directiveoptionsdefault-value
141
Ken Chatfield

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

ディレクティブのスコープブロックのプロパティに=?フラグを使用します。

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

私はAngularJS v1.5.10を使用していますが、 preLink compile function がデフォルトの属性値の設定にかなり適していることがわかりました。

ただのリマインダー：

  • attrsは、rawDOM属性値を保持します。これは常にundefinedまたは文字列です。
  • scopeは、（特に）提供された分離スコープ仕様（=/</@ /など）に従ってDOM属性値parsedを保持します。

要約スニペット：

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