How to use `replace` of directive definition?

Question

In this document: http://docs.angularjs.org/guide/directive , it says that there is a replace configuration for directives:

template - replace the current element with the contents of the HTML. The replacement process migrates all of the attributes / classes from the old element to the new one. See the Creating Components section below for more information.

javascript code

app.directive('myd1', function(){
  return {
    template: '<span>directive template1</span>',
    replace: true
  }
});

app.directive('myd2', function(){
  return {
    template: '<span>directive template2</span>',
    replace: false
  }
});

html code

<div myd1>
  original content should be replaced
</div>
<div myd2>
  original content should NOT be replaced
</div>

But the final page is looking like:

directive template1
directive template2

It seems the replace doesn't work. Do I miss anything?

Live demo: http://plnkr.co/edit/rGIgmjO81X2UxJohL4HM?p=preview

Jim Aho · Accepted Answer · 2014-04-04 20:07:30Z

180

You are getting confused with transclude: true, which would append the inner content.

replace: true means that the content of the directive template will replace the element that the directive is declared on, in this case the <div myd1> tag.

http://plnkr.co/edit/k9qSx15fhSZRMwgAIMP4?p=preview

For example without replace:true

<div myd1><span class="replaced" myd1="">directive template1</span></div>

and with replace:true

<span class="replaced" myd1="">directive template1</span>

As you can see in the latter example, the div tag is indeed replaced.

edited Apr 4, 2014 at 20:07

Jim Aho

12.5k19 gold badges63 silver badges99 bronze badges

answered Mar 8, 2013 at 3:49

checketts

15.3k11 gold badges60 silver badges85 bronze badges

Sign up to request clarification or add additional context in comments.

CMCDragonkai Over a year ago

What about transclude: 'element'. It seems to do the same thing as replace: 'true' when using ng-transclude.

Neil Over a year ago

Is replace: false, the same as not using replace at all?

checketts Over a year ago

@Neil Yes. Leaving it off is the same as false

Robert Over a year ago

replace is now deprecated

cirovladimir Over a year ago

@Robert does 'replace' would have a replacement or is it gone for good?

Ryan O'Neill · Accepted Answer · 2013-03-08 03:51:27Z

12

As the documentation states, 'replace' determines whether the current element is replaced by the directive. The other option is whether it is just added to as a child basically. If you look at the source of your plnkr, notice that for the second directive where replace is false that the div tag is still there. For the first directive it is not.

First result:

<span myd1="">directive template1</span>

Second result:

<div myd2=""><span>directive template2</span></div>

answered Mar 8, 2013 at 3:51

Ryan O'Neill

3,75725 silver badges27 bronze badges

Comments

user3454062 · Accepted Answer · 2014-06-06 06:42:42Z

5

Replace [True | False (default)]

Effect

1.  Replace the directive element.

Dependency:

1. When replace: true, the template or templateUrl must be required.

answered Jun 6, 2014 at 6:42

user3454062

1712 silver badges1 bronze badge

Comments

Konstantin Isaev · Accepted Answer · 2014-05-25 16:13:34Z

0

Also i got this error if i had the comment in tn top level of template among with the actual root element.

<!-- Just a commented out stuff -->
<div>test of {{value}}</div>

answered May 25, 2014 at 16:13

Konstantin Isaev

6628 silver badges15 bronze badges

Collectives™ on Stack Overflow

How to use `replace` of directive definition?

4 Answers 4

Comments

Comments

Comments

Linked

Hot Network Questions

Collectives™ on Stack Overflow

4 Answers 4

8 Comments

Comments

Comments

Comments

Linked

Related