Lightning · Salesforce

Creating a Modal Dialog box using Lightning Design System – Lightning Component

Hi All,
I was trying to build a modal dialog box in lightning component and it took me some time to figure out how to use svg tag and use it in Lightning component.

In this blog, I will try to create a Account List Lightning Component which will have a new Account create button.The new button will open a form dialog box which will contain the Account fields.On the click of Save the Account record will be created.

Attached is the screen of the Lightning App once you complete this tutorial.

AccountList

ModalDialog

Let’s first create a lightning component which shows a list of accounts

AccountListController.apxc :

public class AccountListController {

@AuraEnabled
public static list<Account> getAccountlist(){

return [Select id, Name,Industry,Phone from Account Order by CreatedDate desc limit 10];

}

@AuraEnabled
public static void getAccountupdatedlist(Account newAcc){

insert newAcc ;
}

}

Next Step is to get the Lightning design system.You can download the latest version from https://www.lightningdesignsystem.com/resources/downloads and upload it as a static resource.

Now, first lets create a reusuable Lightning component so that we can use svg tags to show images.You can follow salesforce trailhead to create this. (https://developer.salesforce.com/trailhead/en/project/slds-lightning-components-workshop/slds-lc-4)

svg.cmp

<aura:component >
<aura:attribute name="class" type="String" description="CSS classname for the SVG element" />
<aura:attribute name="xlinkHref" type="String" description="SLDS icon path. Ex: /assets/icons/utility-sprite/svg/symbols.svg#download" />
<aura:attribute name="ariaHidden" type="String" default="true" description="aria-hidden true or false. defaults to true" />
</aura:component>

svgRenderer.js

({
render: function(component, helper) {
//grab attributes from the component markup
var classname = component.get("v.class");
var xlinkhref = component.get("v.xlinkHref");
var ariaHidden = component.get("v.ariaHidden");

//return an svg element w/ the attributes
var svg = document.createElementNS("http://www.w3.org/2000/svg", "svg");
svg.setAttribute('class', classname);
svg.setAttribute('aria-hidden', ariaHidden);
svg.innerHTML = '<use xlink:href="'+xlinkhref+'"></use>';
return svg;
}
})

The next step will be to create a component to show the list of Accounts. We can use the reusuable svg component to add any images to the component by just passing the class and xlinkHref attribute in the component.

AccountListComponent.cmp

<aura:component controller="AccountListController">
<ltng:require styles="/resource/SLDS/assets/styles/salesforce-lightning-design-system.min.css"/>
<aura:attribute name="accountlist" type="Account[]"/>
<aura:handler name="init" value="{!this}" action="{!c.getAccountlst}"/>
<table class="slds-table slds-table--bordered" style="width: 80%;border-right: 1px solid #d8dde6;border-left: 1px solid #d8dde6;margin-left: 2%;">
<thead>
<tr class="slds-text-heading--label">
<th class="slds-cell-shrink" scope="col"></th>
<th class="slds-truncate" scope="col">
<span class="slds-truncate">Account Name</span></th>
<th scope="col">
<span class="slds-truncate">Industry</span></th>
<th scope="col">
<span class="slds-truncate">Phone</span></th>
</tr>
</thead>
<tbody>
<aura:iteration items="{!v.accountlist}" var="acc">
<tr class="slds-hint-parent">
<th data-label="acc-name" role="row">
<c:svg class="slds-icon slds-icon-text-default"
xlinkHref="/resource/SLDS/assets/icons/standard-sprite/svg/symbols.svg#account"
/></th>
<th data-label="acc-name" role="row">
<a href="#" class="slds-truncate">{!acc.Name}</a></th>
<td data-label="industry">
<a href="#" class="slds-truncate">{!acc.Industry}</a></td>
<td data-label="industry">
<a href="#" class="slds-truncate">{!acc.Phone}</a></td>
</tr>
</aura:iteration></tbody>
</table>
</aura:component>

The controller of the component calls an aura method and sets the accountlist attribute which is being used to show the accounts.

AccountListComponentController.js

({
getAccountlst : function(component, event, helper) {

var action = component.get("c.getAccountlist");

action.setCallback(this, function(a) {
if (a.getState() === "SUCCESS") {
component.set("v.accountlist", a.getReturnValue());
} else if (a.getState() === "ERROR") {
$A.log("Errors", a.getError());
}
});

$A.enqueueAction(action);
}
})

This is a very basic component which only shows the last 10 created accounts.Lets create a header component.

AccountListHeader.cmp

<aura:component >
<div class="slds-page-header" role="banner">
<div class="slds-grid">
<div class="slds-col slds-has-flexi-truncate">
<h1 class="slds-text-heading--medium slds-truncate" title="All Accounts">Accounts</h1>
</div>
<div class="slds-col slds-no-flex slds-align-bottom">
<div class="slds-button-group">
<button class="slds-button slds-button--neutral" onclick="{!c.showModal}">Add Account</button>
</div>
</div>
</div>
<p class="slds-text-body--small slds-m-top--x-small">10 items, ordered by recently created</p>

</div>
</aura:component>

The controller of component is used for the new Account button which is adding a style to the modal dialog box(explained below).

AccountListHeaderController.js
({
showModal : function(component, event, helper) {
document.getElementById("backGroundSectionId").style.display = "block";
document.getElementById("newAccountSectionId").style.display = "block";
}
})
 The next step is to create the modal dialog lightning component.By default I have added a style(diplay :none;) to the div so that it's hidden by default.On the click of new Account button it calls a javascript button which changes the style of the div.

AccountCreateComponent.cmp

<aura:component controller="AccountListController">
<aura:attribute name="newAccount" type="Account"
default="{ 'sobjectType': 'Account',
'Name': '',
'Industry': '',
'Phone': ''
}"/>
<div aria-hidden="false" id="newAccountSectionId" role="dialog" class="slds-modal slds-modal--large slds-fade-in-open" style="display:none;">
<div class="slds-modal__container">
<div class="slds-modal__header">
<h2 class="slds-text-heading--medium">New Account</h2>
<button class="slds-button slds-button--icon-inverse slds-modal__close" onclick="{!c.showModalBox}">
<c:svg class="slds-button__icon slds-button__icon--large"
xlinkHref="/resource/SLDS/assets/icons/action-sprite/svg/symbols.svg#close"
ariaHidden="true"
/>
<span class="slds-assistive-text">Close</span>
</button>
</div>
<div class="slds-modal__content">
<div>
<div class="slds-form-element">
<div class="slds-form-element__control">
<ui:inputText aura:id="accname" label="Account Name"
class="slds-input"
labelClass="slds-form-element__label"
value="{!v.newAccount.Name}"
required="true"/>
</div>
</div>
<div class="slds-form-element">
<div class="slds-form-element__control">
<ui:inputText aura:id="accname" label="Industry"
class="slds-input"
labelClass="slds-form-element__label"
value="{!v.newAccount.Industry}"
required="true"/>
</div>
</div>
<div class="slds-form-element">
<div class="slds-form-element__control">
<ui:inputText aura:id="accname" label="Phone"
class="slds-input"
labelClass="slds-form-element__label"
value="{!v.newAccount.Phone}"
required="true"/>
</div>
</div>
</div>
</div>
<div class="slds-modal__footer">
<div class="slds-x-small-buttons--horizontal">
<button class="slds-button slds-button--neutral" onclick="{!c.showModalBox}" >Cancel</button>
<button class="slds-button slds-button--neutral slds-button--brand" onclick="{!c.saveAccount}">Save</button>
</div>
</div>
</div>
</div>
<div class="slds-backdrop slds-backdrop--open" id="backGroundSectionId" style="display:none;"></div>
</aura:component>

The controller of the component consists of two methods.One calls an aura method
to save the new account record.The other to hide the modal dialog by update the display style attribute.

AccountCreateComponentController.js

({
showModalBox : function(component, event, helper) {
document.getElementById("backGroundSectionId").style.display = "none";
document.getElementById("newAccountSectionId").style.display = "none";
},

saveAccount : function(component, event, helper) {

var action = component.get("c.getAccountupdatedlist");
action.setParams({ "newAcc" : component.get("v.newAccount")});

action.setCallback(this, function(a) {
if (a.getState() === "SUCCESS") {
document.getElementById("backGroundSectionId").style.display = "none";
document.getElementById("newAccountSectionId").style.display = "none";
} else if (a.getState() === "ERROR") {
$A.log("Errors", a.getError());
}
});

$A.enqueueAction(action);
}
})

Almost there, the last step is to combine all these 3 components 🙂

AccountListApp.app

<aura:application >
<c:AccountListHeader />
<c:AccountCreateComponent />
<c:AccountListComponent />
</aura:application>
Advertisements

11 thoughts on “Creating a Modal Dialog box using Lightning Design System – Lightning Component

  1. I am getting error while saving controller..the error message is

    ‘expecting a left angle bracket, found ‘&’
    at this line…
    public static list &lt; Account &gt; getAccountlist() {

    ….also a.getState() return string value but it is mentioned as &quot;SUCCESS&quot;
    is this correct also we call method of controller in lightning component by

    var action = component.get(“c.getAccountList”); but here it is mentioed as…
    var action = component.get(&quot;c.getAccountlist&quot;);

    Is this correct??

    Like

  2. Hi Nitish. Good Blog.
    I implement the same functionality in my Org, but I want to rerender newly created account on parent Component Page(AccountListComponent) on save of the Account in modal window.

    Like

    1. Hi Mayukh,
      Thanks for the positive feedback.
      For showing the new account on the parent component page change the saveAccount method to return the newly created accounts and then set the accountlist attribute. That will show the newly created account.

      Like

    1. You can add a visualforce page inside a lightning component using iframe tag. Not a very good practice though. Better to get your visualforce page to lightning component

      Like

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out / Change )

Twitter picture

You are commenting using your Twitter account. Log Out / Change )

Facebook photo

You are commenting using your Facebook account. Log Out / Change )

Google+ photo

You are commenting using your Google+ account. Log Out / Change )

Connecting to %s