Getting Started With Host Web Data From PnP JS Library In The SharePoint Hosted Add-In

This article will share with you the steps to create a simple SharePoint Hosted Add-in using Napa tool, with the help of PnP JavaScript Library in SharePoint Online, to access the data from Host web.

SharePoint Add-In
is an independent component used for including a new functionality or expanding the old functionality to  SharePoint. The SharePoint Add-In can access data and use components between two webs, called Host web and Add-In web.

  • Host Web: A SharePoint site used to install the SharePoint Add-In. 

  • Add-In Web: A special child web site that is created during the installation of Add-In and all the components mentioned in Add-In are deployed to the web.
The example from this article uses a PnP JavaScript Library to access the Lists available in Host web and shows the Host web title from the SharePoint Online.

To access data from Add-In web, refer to the link below:

Prerequisites

  • Developer Site Collection
  • Napa Add-In tool or Visual Studio
  • PnP, fetch, and e6-promise JS files

Getting start with SharePoint Add-In

  • Navigate to Developer Site Collection and then, to the Site Contents page.
  • Click “Napa” Office 365 Development Tools link or Tile from Site Content Page. This will open a Napa tool in a new window.
  • The Napa tool will list out the existing created Add-Ins. From the same page, click “Add New Project” tile.

    New Project

  • That’ll redirect us to Add-In create page. There, we have different options to select the Add-In type.

  • Select “SharePoint Add-in” type and enter the project name as “pnpSharePointhostwebTest” for the add-in application in the “Project name” textbox. Then, click “Create” button.
    Create

  • In the Add-in application, select “Properties” icon to update the properties of the Add-in.

  • Modify the project title as a user friendly name. For example, enter “PnP SharePoint Host Web Testing application”. Leave the other fields as default. Then, click “Apply” button that is available at the bottom of the page, under left navigation.

    Apply

  • We need to set the permissions to the add-in in order to access the data from Host web. For that, in the properties page, select “Permissions” in left navigation.

  • In our example, we are going to read only web information and lists available from the web. So, the Read permission is enough for the web object. So, set the Web permission to “Read”.

    permission

  • Remove the  not-required JavaScript file references from the Default.aspx page. In our example, we will remove the jquery, sp.js and sp.runtime JS files.

    code

  • Add the required files (pnp.min.js, fetch.js and es6-promise.js) to the Scripts folder.

    Scripts

  • After uploading the files, open Default.aspx page and add the below JavaScript file reference lines within PlaceHolderAdditionalPageHead content place holder.
    1. <script type="text/javascript" src="../scripts/fetch.js"></script>   
    2. <script type="text/javascript" src="../scripts/es6-promise.js"></script>   
    3. <script type="text/javascript" src="../scripts/pnp.min.js"></script>  
  • Now, open “App.js” file and remove all the lines and add the below lines:
    1. 'use strict';  
    2.   
    3. function pnpReady() {  
    4.     var addinweb = getUrlParamByName("SPAppWebUrl");  
    5.     var hostweb = getUrlParamByName("SPHostUrl");  
    6.     //Retrieve Host Web Title and collection of Lists from the current web  
    7.     $pnp.sp.crossDomainWeb(addinweb, hostweb).expand("Lists").select("Title,Lists").get().then(function(result) {  
    8.         var contetTypeInfo = "<strong>Lists from website: " + result.Title + "</strong><br/>";  
    9.         for (var i = 0; i < result.Lists.length; i++) {  
    10.             contetTypeInfo += "Name: " + result.Lists[i].Title + "<br/>ID:" + result.Lists[i].Id + "<br/><br/>";  
    11.         }  
    12.         document.getElementById("message").innerHTML = contetTypeInfo;  
    13.     }).catch(function(err) {  
    14.         alert(err);  
    15.     });  
    16. }  
    17. //Call the PnP method after the page load  
    18. document.addEventListener('DOMContentLoaded'function() {  
    19.     pnpReady();  
    20. });  
    21. //To retrieve the parameter value from query string in URL  
    22. function getUrlParamByName(name) {  
    23.     name = name.replace(/[\[]/, "\\[").replace(/[\]]/, "\\]");  
    24.     var regex = new RegExp("[\\?&]" + name + "=([^&#]*)");  
    25.     var results = regex.exec(location.search);  
    26.     return results === null ? "" : decodeURIComponent(results[1].replace(/\+/g, " "));  
    27. }  
  • After adding the lines, the app.js file will look like the following:

    app.js

    To use the same code in an On-Premise environment, add the below snippet to ensure the response should have retrieved in JSON format.
    1. $pnp.setup({  
    2.     headers: {  
    3.         "Accept""application/json; odata=verbose"  
    4.     }  
    5. });  

The code in this example shows the Host Website’s Title and populates the lists (ID and Title) available on the web. 

Output

Output

Conclusion

From this article, we learned how to create a SharePoint add-in to access the information from Host web, using PnP JavaScript Library in SharePoint Online.

Similar Articles