Настройка шаблона в директиве

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>'

        }
    })

Однако когда я прихожу, чтобы добавить более продвинутые функции, я застреваю.

Как я могу поддерживать значения по умолчанию в шаблоне?

Я хотел бы указать параметр "тип" как необязательный атрибут в моей директиве, например:

<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

Ответы:

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);
        }
    };
})
Misko Hevery
источник
6
Это немного поздно, но если htmlTextвы добавили ng-clickгде - то, что только модификация будет заменить element.replaceWith(htmlText)с element.replaceWith($compile(htmlText))?
jclancy 04
@Misko, вы упомянули, чтобы избавиться от области видимости. Зачем? У меня есть директива, которая не компилируется при использовании с изолированной областью видимости.
Syam
1
это не работает, если htmlTextсодержит директиву ng-transclude
Alp
3
К сожалению, я обнаружил, что проверка формы, похоже, не работает с этим, $errorфлаги на вставленном вводе никогда не устанавливаются. Мне пришлось сделать это в свойстве ссылки директивы: $compile(htmlText)(scope,function(_el){ element.replaceWith(_el); });для того, чтобы контроллер формы распознал его вновь созданное существование и включил его в проверку. Я не мог заставить его работать в свойстве компиляции директивы.
meconroy
5
Хорошо, сейчас 2015 год, и я почти уверен, что с созданием разметки в скриптах вручную что-то не так .
Борис Окунский
38

Пытался использовать решение, предложенное 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-щелчком в шаблоне
joshcomley
Спасибо, у меня это тоже сработало. Хотел обернуть директиву для применения некоторых атрибутов по умолчанию.
martinoss 03
2
Спасибо, я даже не знал, что шаблон принимает функцию!
Джон Сноу
2
Это не обходной путь. Это правильный ответ на ОП. Условное создание шаблона в зависимости от атрибутов элемента - это точная цель функции шаблона директивы / компонента. Вы не должны использовать для этого компиляцию. Команда Angular сильно поощряет этот стиль кодирования (без использования функции компиляции).
jose.angel.jimenez 08
Это должен быть правильный ответ, даже если я не знал, что шаблон выполняет функцию :)
NeverGiveUp161
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 03
Очень мило спасибо! К сожалению, ваш письменный подход недоступен :(
Майкл
И суть, и рецензия - мертвые ссылки.
binki
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) избавьтесь от размаха:
Миско Хевери
@MiskoHevery Спасибо за отзыв - не могли бы вы объяснить, почему здесь функция компиляции предпочтительнее функции ссылки?
Марти Питт
4
Я думаю, что это ответ из docs.angularjs.org/guide/directive : «Любая операция, которая может совместно использоваться экземплярами директив [например, преобразование DOM шаблона], должна быть перенесена в функцию компиляции по соображениям производительности».
Марк Райкок,
@Marty Вы все еще можете привязать один из ваших пользовательских входов к модели? (т.е. <form-input ng-model="appName" label="Application Name" form-id="appName" required/></form-input>)
Джонатан Уилсон
1
@MartyPitt Из книги О'Рейли «AngularJS»: «Итак, у нас есть compileфаза, которая имеет дело с преобразованием шаблона, и linkфаза, которая имеет дело с изменением данных в представлении. По этим строкам основное различие между compileи linkфункции в директивах заключается в том, что compileфункции имеют дело с преобразованием самого шаблона, а linkфункции имеют дело с созданием динамической связи между моделью и представлением. Именно на этом втором этапе области видимости прикрепляются к скомпилированным linkфункциям, и директива становится действующей через привязку данных "
Джулиан