From 4175377aaff9401f8b6c6f62ece71706ecb7f4ce Mon Sep 17 00:00:00 2001 From: Misko Hevery Date: Thu, 1 Aug 2013 16:01:41 -0700 Subject: [PATCH] docs(compile/tplrt): description for compile/tplrt error Closes #3459 --- docs/content/error/compile/tplrt.ngdoc | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/docs/content/error/compile/tplrt.ngdoc b/docs/content/error/compile/tplrt.ngdoc index 4afd88cd20f9..78fe16b1b667 100644 --- a/docs/content/error/compile/tplrt.ngdoc +++ b/docs/content/error/compile/tplrt.ngdoc @@ -2,3 +2,29 @@ @name $compile:tplrt @fullName Invalid Template Root @description + +When a directive is declared with `template` (or `templateUrl`) and `replace` mode on, the template must have exactly one root element. +Otherwise the replacement operation would result in a single element being replaced with multiple elements or nodes, which is unsupported and not commonly needed in practice. + + +For example a directive with definition: +``` +myModule.directive('myDirective', function factory() { + return { + ... + replace: true, + templateUrl: 'someUrl' + ... + } +}); +``` + +And a template provided at URL `someUrl`. The template must be an html fragment that has only a single root element, like the `div` element in this template: +``` +
Hello World!
+``` + +An an invalid template to be used with this directive is one that defines multiple root nodes or elements. For example: +``` +Hello World! +```