Newer Version Available

This content describes an older version of this product. View Latest

aura:renderIf

aura:renderIf renders the content within the tag if the isTrue attribute evaluates to true.

Only consider using aura:renderIf if you expect to show the components for both the true and false states, and it would require a server round trip to instantiate the components that aren't initially rendered. Otherwise, use aura:if as it only creates and renders the markup in its body or the else attribute.

Attribute Name Type Description
else Component[] The markup to render when isTrue evaluates to false. Set this attribute using the aura:set tag.
isTrue String Required. An expression that determines whether the content is displayed. If it evaluates to true, the content is displayed.

Example

This snippet of markup uses the <aura:renderIf> tag to conditionally display an edit button.

1swfobject.registerObject("clippy.example_markup", "9");
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17<aura:attribute name="edit" type="Boolean" default="true">
18<aura:renderIf isTrue="{!v.edit}">
19    <ui:button label="Edit"/>
20    <aura:set attribute="else">
21        You can’t edit this.
22        <!-- Imagine some components here that need to be created on the server -->
23    </aura:set>
24</aura:renderIf>

If the edit attribute is set to true, a ui:button displays. Otherwise, the text in the else attribute displays.

We recommend using aura:if instead if the else attribute is rarely displayed or if it doesn’t include components that need to be created on the server.