在指令中自定义模板

IT技术 javascript angularjs
2021-03-04 22:11:22

我有一个使用 Bootstrap 标记的表单,如下所示:

<form class="form-horizontal">
  <fieldset>
    <legend>Legend text</legend>
    <div class="control-group">
      <label class="control-label" for="nameInput">Name</label>
      <div class="controls">
        <input type="text" class="input-xlarge" id="nameInput">
        <p class="help-block">Supporting help text</p>
      </div>
    </div>
  </fieldset>
</form>

那里有很多样板代码,我想将它们简化为一个新指令 - 表单输入,如下所示:

<form-input label="Name" form-id="nameInput"></form-input>

产生:

   <div class="control-group">
      <label class="control-label" for="nameInput">Name</label>
      <div class="controls">
        <input type="text" class="input-xlarge" id="nameInput">
      </div>
    </div>

我通过一个简单的模板进行了这么多工作。

angular.module('formComponents', [])
    .directive('formInput', function() {
        return {
            restrict: 'E',
            scope: {
                label: 'bind',
                formId: 'bind'
            },
            template:   '<div class="control-group">' +
                            '<label class="control-label" for="{{formId}}">{{label}}</label>' +
                            '<div class="controls">' +
                                '<input type="text" class="input-xlarge" id="{{formId}}" name="{{formId}}">' +
                            '</div>' +
                        '</div>'

        }
    })

然而,当我开始添加更高级的功能时,我陷入了困境。

如何支持模板中的默认值?

我想将“type”参数公开为我的指令的可选属性,例如:

<form-input label="Password" form-id="password" type="password"/></form-input>
<form-input label="Email address" form-id="emailAddress" type="email" /></form-input>

但是,如果没有指定任何内容,我想默认为"text". 我该如何支持?

如何根据属性的存在/不存在自定义模板?

我还希望能够支持“必需”属性(如果存在)。例如:

<form-input label="Email address" form-id="emailAddress" type="email" required/></form-input>

如果required指令中存在,我想将它添加到<input />输出中生成的,否则忽略它。我不确定如何实现这一目标。

我怀疑这些要求可能已经超出了一个简单的模板,必须开始使用预编译阶段,但我不知道从哪里开始。

4个回答
angular.module('formComponents', [])
  .directive('formInput', function() {
    return {
        restrict: 'E',
        compile: function(element, attrs) {
            var type = attrs.type || 'text';
            var required = attrs.hasOwnProperty('required') ? "required='required'" : "";
            var htmlText = '<div class="control-group">' +
                '<label class="control-label" for="' + attrs.formId + '">' + attrs.label + '</label>' +
                    '<div class="controls">' +
                    '<input type="' + type + '" class="input-xlarge" id="' + attrs.formId + '" name="' + attrs.formId + '" ' + required + '>' +
                    '</div>' +
                '</div>';
            element.replaceWith(htmlText);
        }
    };
})
如果htmlText包含 ng-transclude 指令,则这不起作用
2021-04-19 22:11:22
这有点晚了,但是如果htmlText您在ng-click某处添加了一个,唯一的修改是替换element.replaceWith(htmlText)element.replaceWith($compile(htmlText))?
2021-04-24 22:11:22
@Misko,你提到要摆脱范围。为什么?我有一个指令,当与隔离范围一起使用时它不会编译。
2021-05-03 22:11:22
不幸的是,我发现表单验证似乎不适用于此,$error插入的输入上的标志永远不会设置。我必须在指令的链接属性中执行此操作:$compile(htmlText)(scope,function(_el){ element.replaceWith(_el); });以便表单的控制器识别其新形成的存在并将其包含在验证中。我无法让它在指令的 compile 属性中工作。
2021-05-04 22:11:22
好的,现在是 2015 年,我很确定在脚本中手动生成标记有一些非常错误的地方
2021-05-13 22:11:22

尝试使用 Misko 提出的解决方案,但在我的情况下,一些需要合并到我的模板 html 中的属性本身就是指令。

不幸的是,并非生成的模板引用的所有指令都能正常工作。我没有足够的时间深入研究 angular 代码并找出根本原因,但找到了一个可能有用的解决方法。

解决方案是将创建模板 html 的代码从编译移动到模板函数。基于上述代码的示例:

    angular.module('formComponents', [])
  .directive('formInput', function() {
    return {
        restrict: 'E',
        template: function(element, attrs) {
           var type = attrs.type || 'text';
            var required = attrs.hasOwnProperty('required') ? "required='required'" : "";
            var htmlText = '<div class="control-group">' +
                '<label class="control-label" for="' + attrs.formId + '">' + attrs.label + '</label>' +
                    '<div class="controls">' +
                    '<input type="' + type + '" class="input-xlarge" id="' + attrs.formId + '" name="' + attrs.formId + '" ' + required + '>' +
                    '</div>' +
                '</div>';
             return htmlText;
        }
        compile: function(element, attrs)
        {
           //do whatever else is necessary
        }
    }
})
这解决了我在模板中嵌入 ng-click 的问题
2021-04-18 22:11:22
谢谢,这对我也有用。想要包装一个指令来应用一些默认属性。
2021-04-18 22:11:22
这不是解决方法。这是OP的正确答案。根据元素的属性有条件地制作模板是指令/组件模板功能的确切目的。你不应该为此使用 compile 。Angular 团队非常鼓励这种编码风格(不使用 compile 函数)。
2021-04-23 22:11:22
这应该是正确的答案,即使我不知道模板需要一个函数:)
2021-05-13 22:11:22
谢谢,我什至不知道模板接受了一个函数!
2021-05-14 22:11:22

不幸的是,上述答案并不完全有效。特别是,编译阶段无法访问范围,因此您无法根据动态属性自定义字段。使用链接阶段似乎提供了最大的灵活性(在异步创建 dom 等方面)以下方法解决了这个问题:

<!-- Usage: -->
<form>
  <form-field ng-model="formModel[field.attr]" field="field" ng-repeat="field in fields">
</form>
// directive
angular.module('app')
.directive('formField', function($compile, $parse) {
  return { 
    restrict: 'E', 
    compile: function(element, attrs) {
      var fieldGetter = $parse(attrs.field);

      return function (scope, element, attrs) {
        var template, field, id;
        field = fieldGetter(scope);
        template = '..your dom structure here...'
        element.replaceWith($compile(template)(scope));
      }
    }
  }
})

我创建了一个要点有更完整的代码和书面记录的方式。

要点和文章都是死链接。
2021-04-17 22:11:22
不错的方法。不幸的是,当与 ngTransclude 一起使用时,我收到以下错误:Error: [ngTransclude:orphan] Illegal use of ngTransclude directive in the template! No parent directive that requires a transclusion found.
2021-04-18 22:11:22
为什么不使用带有“字段:”=“”的隔离范围?
2021-04-29 22:11:22
非常好,谢谢!不幸的是,您的书面方法是离线的:(
2021-05-08 22:11:22

这是我最终使用的。

我对 AngularJS 很陌生,所以很想看到更好的/替代解决方案。

angular.module('formComponents', [])
    .directive('formInput', function() {
        return {
            restrict: 'E',
            scope: {},
            link: function(scope, element, attrs)
            {
                var type = attrs.type || 'text';
                var required = attrs.hasOwnProperty('required') ? "required='required'" : "";
                var htmlText = '<div class="control-group">' +
                    '<label class="control-label" for="' + attrs.formId + '">' + attrs.label + '</label>' +
                        '<div class="controls">' +
                        '<input type="' + type + '" class="input-xlarge" id="' + attrs.formId + '" name="' + attrs.formId + '" ' + required + '>' +
                        '</div>' +
                    '</div>';
                element.html(htmlText);
            }
        }
    })

用法示例:

<form-input label="Application Name" form-id="appName" required/></form-input>
<form-input type="email" label="Email address" form-id="emailAddress" required/></form-input>
<form-input type="password" label="Password" form-id="password" /></form-input>
@MiskoHevery 感谢您的反馈——您介意解释一下为什么编译函数比链接函数更受欢迎吗?
2021-04-21 22:11:22
@Marty 您是否仍然能够将您的自定义输入之一绑定到模型?(即。<form-input ng-model="appName" label="Application Name" form-id="appName" required/></form-input>
2021-04-21 22:11:22
我认为这是来自docs.angularjs.org/guide/directive的答案:“出于性能原因,任何可以在指令实例之间共享的操作 [例如,转换模板 DOM] 都应该移到编译函数中。”
2021-04-28 22:11:22
更好的解决方案是: (1) 使用编译函数而不是链接函数并在那里进行替换。该模板不适用于您的情况,因为您想对其进行自定义。(2) 摆脱作用域:
2021-04-30 22:11:22
@MartyPitt 来自 O'Reilly 的“AngularJS”一书中:“所以我们有compile处理模板转换的link阶段处理视图中数据修改的阶段。沿着这些思路,指令中的函数compilelink函数是compile函数处理模板本身的转换,link函数处理模型和视图之间的动态连接。在第二阶段,作用域附加到已编译的link函数上,指令通过数据绑定变为活动状态
2021-05-08 22:11:22