在指令中自定义模板


98

我有一个使用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,如下所示:

<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"。我该如何支持?

如何根据属性的存在/不存在来定制模板?

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

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

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

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


我是唯一一个看到房间里的大象的人吗:)->如果type是通过绑定动态设置的,例如。type="{{ $ctrl.myForm.myField.type}}"?我检查了下面的所有方法,找不到在这种情况下可以使用的任何解决方案。看起来像模板函数将看到 属性的文字值,例如。tAttr['type'] == '{{ $ctrl.myForm.myField.type }}'代替tAttr['type'] == 'password'。我很困惑。
Dimitry K,

Answers:


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

6
这有点晚了,但是如果htmlText您在ng-click某个地方添加了,唯一的修改就是替换element.replaceWith(htmlText)element.replaceWith($compile(htmlText))吗?
jclancy

@Misko,您提到要摆脱范围。为什么?我有一个指令,当与隔离范围一起使用时不会编译。
Syam

1
如果htmlText包含ng-transclude指令,则此方法不起作用
Alp 2014年

3
不幸的是,我发现表单验证似乎与此不兼容,$error插入输入上的标志永远都不会被设置。我必须在指令的link属性中执行此操作:$compile(htmlText)(scope,function(_el){ element.replaceWith(_el); });为了使窗体的控制器识别其新形成的存在并将其包括在验​​证中。我无法在指令的compile属性中使用它。
meconroy 2014年

5
好的,现在已经是2015年了,我可以肯定的是,在脚本中手动生成标记确实存在一些错误。
BorisOkunskiy 2015年

38

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

不幸的是,并非最终模板所引用的所有指令都能正常工作。我没有足够的时间来研究角度代码并找出根本原因,但是找到了一种解决方法,这可能会有所帮助。

解决方案是将创建模板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解决了我的问题
joshcomley 2014年

谢谢,这也为我工作。想要包装指令以应用一些默认属性。
马丁诺斯2015年

2
谢谢,我什至不知道模板接受了功能!
乔恩·斯诺

2
这不是解决方法。这是OP的正确答案。指令/组件模板函数的确切目的是根据元素的属性有条件地制作模板。您不应该为此使用compile。Angular团队大力鼓励这种编码风格(不使用compile函数)。
jose.angel.jimenez

这应该是正确的答案,即使我不知道模板也需要一个功能:)
NeverGiveUp161 '18

5

不幸的是,以上答案并不奏效。特别是,编译阶段无法访问范围,因此您不能基于动态属性自定义字段。使用链接阶段似乎提供了最大的灵活性(就异步创建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));
      }
    }
  }
})

我创建了要点,其中包含更完整的代码和方法的补充


好的方法。不幸的是,当与ngTransclude一起使用时,出现以下错误:Error: [ngTransclude:orphan] Illegal use of ngTransclude directive in the template! No parent directive that requires a transclusion found.
Alp

为什么不将隔离范围与'field:“ =”一起使用?
IttayD

很好,谢谢!不幸的是,您的书面方法是离线的:(
Michiel

要点和写作都是固定的环节。
宾基

4

这就是我最终使用的内容。

我是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>

10
更好的解决方案是:(1)使用编译函数而不是链接函数并在那里进行替换。由于您要自定义模板,因此无法在您的情况下使用该模板。(2)摆脱范围:
Misko Hevery 2012年

@MiskoHevery感谢您的反馈-您介意在这里解释为什么偏爱编译函数而不是链接函数吗?
马蒂·皮特

4
我认为这是来自docs.angularjs.org/guide/directive的答案:“出于性能原因,可以在指令实例之间共享的任何操作(例如,转换模板DOM)都应移至compile函数。”
Mark Rajcok 2012年

@Marty您仍然能够将自定义输入之一绑定到模型吗?(即<form-input ng-model="appName" label="Application Name" form-id="appName" required/></form-input>
乔纳森·威尔逊

1
@MartyPitt,来自O'Reilly的“ AngularJS”书:“因此,我们进入了compile处理模板转换的阶段,link另一个阶段则涉及修改视图中的数据。沿着这些思路,两者之间的主要区别在于compilelink在指令的功能是compile函数处理转换模板本身,和link功能处理决策模型和视图之间的动态连接。正是在这个第二阶段是示波器连接到编译link功能,并且该指令变成实况通过数据绑定“
朱利安
By using our site, you acknowledge that you have read and understand our Cookie Policy and Privacy Policy.
Licensed under cc by-sa 3.0 with attribution required.