back to resources
Embed Lightning Component in the Navigation Bar of an App
November 29 2021 • 25 min read

BUSINESS CHALLENGE

Standard Salesforce apps like Sales have Multiple Navigation items like Accounts and Opportunities. We can personalize the Navigation bar of an App and add or remove items, but we cannot add or remove Custom App Pages in the Personalize your nav bar option.

We can add the Custom App Page to an apps navigation bar using the Lightning App Builder.

To explain this we create a Hello World Lightning web Component and place it on the App Page which will then be added to the navigation bar of an App. 

screenshot 651

STEPS TO ADD AN APP PAGE TO THE APPS NAVIGATION BAR

  1. Create a Lightning Web Component using VS Code
  2. Create a new App Page and add the Lightning Web Component to the Page
  3. Activate the Page and add it to Navigation Bar of an App

1. CREATE A LIGHTNING WEB COMPONENT USING VS CODE

1.1 CREATE A PROJECT

  1. Open VS Code, Select Ctrl + Shift + P in Windows or Cmd + Shift + P in Mac to open the Command Palette.

  2. Search for SFDX: Create Project and Select it.

  3. Select Standard project template, enter the project name, hit enter and choose the folder in your system to save the project.

1.2 CREATE A LIGHTINING WEB COMPONENT

  1. Open Command Palette, Search for SFDX: Create Lightning Web Component and Select it.

  2. Enter the desired file name and hit enter.

  3. For Enter desired directory, select the default option.

  4. You will see a screen with the helloWorld folder and its files under lwc folder on the left.

  5. Click on helloWorld.html file and paste the following code and Save the file.

    <template>
        <lightning-card title="HelloWorld" icon-name="custom:custom14">
          <div class="slds-m-around_medium">
            <p>Hello, {greeting}!</p>
            <lightning-input label="Name" value={greeting} onchange={changeHandler}></lightning-input>
          </div>
        </lightning-card>
    </template>
  6. Click on the helloWorld.js file and paste the following code and Save the file.

    import { LightningElement } from 'lwc';
    export default class HelloWorld extends LightningElement {
      greeting = 'World';
      changeHandler(event) {
        this.greeting = event.target.value;
      }
    }
  7. Click on the helloWorld.js-meta.xml and paste the following code and Save the file.

    <?xml version="1.0" encoding="UTF-8"?>
    <LightningComponentBundle xmlns="http://soap.sforce.com/2006/04/metadata" fqn="helloWorld">
      <apiVersion>45.0</apiVersion>
      <isExposed>true</isExposed>
      <targets>
        <target>lightning__AppPage</target>
        <target>lightning__RecordPage</target>
        <target>lightning__HomePage</target>
      </targets>
    </LightningComponentBundle>

1.3 CONNECT TO THE ORG AND DEPLOY THE LIGHTNING WEB COMPONENT

  1. Open Command Palette and Search for SFDX: Authorize an Org and Select it.

  2. Choose your Org type and if it is Custom, paste your Orgs login URL in the next step.

  3. For Org alias, hit enter for a default alias or type a new alias.

  4. On hitting enter you will be taken to the Salesforce Login Page in a browser.

  5. Enter the Credentials and Login.

  6. Head back to VSCode and you will see the notification SFDX: Authorize an Org successfully ran.

  7. Now right click on the folder helloworld folder which is on the left pane and click SFDX: Deploy Source to Org.

  8. You should see the notification SFDX: Deploy source to Org successfully ran shortly.

    dcao21

2. CREATE A NEW APP PAGE AND ADD THE LIGHTNING WEB COMPONENT TO THAT PAGE

  1. From Setup, Search for Lightning App builder and Select it.

  2. Click on New.

  3. Select App page and click Next.

  4. Label the New Lightning Page. The Label entered here will be the name of the New Tab.

  5. You will see several options to choose for the page appearance, Here we will choose One Region because we are adding only one component.

  6. Click Finish.

  7. On the left pane where you see a list of Components scroll down till you see Custom Components. Now Drag and Drop the helloWorld Component we created, onto the page.

    NOTE

    You can add either an Aura Component or a Lightning Web Component here.

  8. Now Click Save on the top right corner.

  9. You should see a popup with the message Page Saved.

3. ACTIVATE THE PAGE AND ADD IT TO NAVIGATION BAR OF AN APP

  1. Now Activate this page to make it Visible to Users.

  2. On Clicking Activate, You will see more Activation Settings.

  3. Under Page Settings Tab, You can choose to Activate the Page for All Users or System Administrators Only.

  4. You can also change the icon of your lightning app page by clicking Change… beside the icon.

  5. Next, Click on the Lightning Experience Tab.

  6. On the Left Pane, you will see all the apps in your Org.

  7. Select an app to which you would like to add this page as a tab on the Navigation bar.

  8. On the right pane, Click on the button Add page to app to add the page.

  9. On Adding the Page, It will display all the Navigation items available on that App.

  10. You can see your App Page in the Available items and rearrange your Page in the order you require.

    NOTE

    If you accidentally added the page to another app, you can just remove the app page from the app by clicking on the Remove page at the top of the right pane.

  11. Click Save at the right bottom of the popup to finish activation.

  12. Now head back to the App you added the Page to and Verify if it’s visible.

  13. If you want to Remove the page after activation, Go to Setup → Tabs

  14. Under the Lightning Page Tabs section, you can see the Created Tabs.

  15. Under Action, Click Del to Delete the Page from the App.

WRAPPING IT UP

In this Blog, we have explained how to Embed a Lightning Web Component into an App page using Lightning App builder and add it as a Tab to the Navigation bar of an App.

Leave a Comment

Your email address will not be published

© 2022 Digital Biz Tech