Retrieve SharePoint List Items Using SharePoint Framework Development Model

In this article, you will understand how to retrieve SharePoint List Items, using SharePoint Framework Development Model.

SharePoint Framework is the new development model and a lot of work has been going on with it in the past year. It went to General Availability on Feb 23, 2017. It is a page and Web part model which provides full support for client-side SharePoint development, easy integration with SharePoint data, and support for an open source tooling. With SharePoint Framework, you can use modern Web technologies and the tools in your preferred development environment to build productive experiences and apps in SharePoint.

In the previous article, we saw how to set up the development environment for SharePoint Framework. We have seen how to create and deploy the first client Web part, using SharePoint Framework here.

Create SharePoint Framework Web part project

In this article, we will be creating a client Web part, which will be retrieving the list items from SharePoint List (EmployeeList) and will display it in the tabular form in the client Web part, as shown below.

SharePoint

Before moving forward, ensure that SharePoint Framework development environment is ready.

SharePoint

Spin up Node.js command prompt, using which we will be creating the Web part project structure.

SharePoint

We can create the directory, where we will be adding the solution, using the command given below.

md GetSharePointListItems

Let’s move to the newly created working directory, using the command.

cd GetSharePointListItems

SharePoint

We will then create the client Web part by running the Yeoman SharePoint Generator.

yo @microsoft/sharepoint

SharePoint

This will display the prompt, which we will have to fill up, so as to proceed with the project creation.

  • What is your solution name? : Set it to ‘GetSPListItems’.

On pressing enter, we will be asked to chose the working folder for the project.

SharePoint

  • Where do you want to place your files- Use current folder.
  • What framework would you like to start with- Select “No javaScript web framework” for the time being, as this is a sample Web part.
  • What is your Webpart name- We will specify it as ‘GetSPListItems’ and press Enter
  • What is your Webpart description- We will specify it as this Webpart will retrieve the list items from SharePoint list and display in a table.

    SharePoint

Yeoman has started working on the scaffolding of the project. It will install the required dependencies and scaffold the solution files for the ‘GetListItems’ Web part, which will take some time to complete. Once completed, we will get a congratulations message.

SharePoint

Test the Web part locally

In order to test the client Web part, we can build and run it on the local Web Server, where we are developing the Web part. SharePoint Framework development uses HTTPS endpoint by default. Since a default certificate is not configured for the local development environment, our Browser will report a certificate error. SharePoint Framework tool chain comes with a developer certificate, which we can install for testing the client Web parts locally. From the current Web part directory, run the command given below.

gulp trust-dev-cert

SharePoint

Now, let’s preview the Web part by running the gulp serve command.

SharePoint

This command will execute a series of gulp tasks and will create a Node-based HTTPS Server at 'localhost:4321'. It will then open the Browser and display the client Web part.

SharePoint

This indicates that the project structure is set up correctly. We will now open up the solution in Visual Studio Code to add the logic to retrieve the list items from SharePoint and display it as a table in this page.

SharePoint

To stop Gulp from listening to the process, we can press ‘Control + C’ . This will terminate the Gulp Serve command and stop the Server.

Edit the web part

Now let’s try to edit the web part and add more functionality to it. To do that navigate to “src\webparts\getSpListItems” location.

SharePoint

In the left pane of Visual Studio Code, we can see the project structure. The bulk of the logic resides within the GetSPListItemsWebPart.ts file. Let’s add the code to retrieve SharePoint list items from the Employee List within this TypeScript file.

SharePoint

Define List Model

Since we want to retrieve an Employee list items data, we will be creating list model with SharePoint list fields in the GetListItemsWebPart.TS file, as shown below. Place it above the ‘GetSpListItemsWebPart’ class. 

  1. export interface ISPLists {  
  2.     value: ISPList[];  
  3.   }  
  4.   export interface ISPList {  
  5.     EmployeeId: string;  
  6.     EmployeeName: string;  
  7.     Experience: string;  
  8.     Location: string;  
  9.   }    

Create Mock HTTPClient to test data locally

In order to test the list item retrieval in the local workbench, we will create a mock store, which returns mock Employee list data. We will create a new file inside ‘src\webparts\ getSpListItems’ folder named MockHttpClient.ts, as shown below.

SharePoint

We will then copy the code given below into MockHttpClient.ts, as shown below. 

  1. import { ISPList } from './GetSpListItemsWebPart';  
  2.   
  3. export default class MockHttpClient {  
  4.     private static _items: ISPList[] = [{ EmployeeId: 'E123', EmployeeName: 'John', Experience: 'SharePoint',Location: 'India' },];  
  5.     public static get(restUrl: string, options?: any): Promise<ISPList[]> {  
  6.       return new Promise<ISPList[]>((resolve) => {  
  7.             resolve(MockHttpClient._items);  
  8.         });  
  9.     }  
  10. }  

SharePoint

We can now use the MockHttpClient class in the ‘GetSPListItems’ class. Let’s import the ‘MockHttpClient’ module by going to the GetSpLitItemsWebPart.ts and pasting the line given below just after “import { IGetSpListItemsWebPartProps } from './IGetSpListItemsWebPartProps';” 

  1. import MockHttpClient from './MockHttpClient';   

We will also add the mock list item retrieval method within the ‘GetSpListItemsWebPart’ class. 

  1. private _getMockListData(): Promise<ISPLists> {  
  2.     return MockHttpClient.get(this.context.pageContext.web.absoluteUrl).then(() => {  
  3.         const listData: ISPLists = {  
  4.             value:  
  5.             [  
  6.                 { EmployeeId: 'E123', EmployeeName: 'John', Experience: 'SharePoint',Location: 'India' },  
  7.                  { EmployeeId: 'E567', EmployeeName: 'Martin', Experience: '.NET',Location: 'Qatar' },  
  8.                 { EmployeeId: 'E367', EmployeeName: 'Luke', Experience: 'JAVA',Location: 'UK' }  
  9.             ]  
  10.             };  
  11.         return listData;  
  12.     }) as Promise<ISPLists>;  
  13. }   

Retrieve SharePoint List Items

SharePoint Framework has the helper class spHttpClient, which can be utilized to call REST API requests against SharePoint. We will use REST API: “/_api/web/lists/GetByTitle('EmployeeList')/Items” to get the list items from SharePoint List.

To use ‘spHttpClient’, we will first have to import it from the ‘@microsoft/sp-http’ module. We will import this module by placing the line given below after the mockHttpClient import code -“import MockHttpClient from './MockHttpClient';” 

  1. import {  
  2.   SPHttpClient  
  3. } from '@microsoft/sp-http';   

We will be then adding the method given below to get SharePoint list items, using REST API within the ‘GetSpListItemsWebPart’ class. 

  1. private _getListData(): Promise<ISPLists> {  
  2. return this.context.spHttpClient.get(this.context.pageContext.web.absoluteUrl + `/_api/web/lists/GetByTitle('EmployeeList')/Items`, SPHttpClient.configurations.v1)  
  3.     .then((response: Response) => {   
  4.       debugger;  
  5.       return response.json();  
  6.     });  
  7. }   

Render the List Items

Once we run the gulp serve command, we can test the Web part in SharePoint Workbench in the local environment or using SharePoint Online Context. SharePoint Framework uses ‘EnvironmentType’ module to identify the environment, where the Web part is executed.

In order to implement this, we will import ‘Environment’ and the ‘EnvironmentType’ modules from the @microsoft/sp-core-library bundle by placing it at the top of the GetSpListItemsWebpart.ts file. 

  1. import {  
  2.   Environment,  
  3.   EnvironmentType  
  4. } from '@microsoft/sp-core-library';   

We will then check Environment.type value and if it is equal to Environment.Local, the MockHttpClient method, which returns dummy data which will be called else the method that calls REST API is able to retrieve SharePoint list items will be called. 

  1. private _renderListAsync(): void {  
  2.       
  3.     if (Environment.type === EnvironmentType.Local) {  
  4.       this._getMockListData().then((response) => {  
  5.         this._renderList(response.value);  
  6.       });  
  7.     }  
  8.      else {  
  9.        this._getListData()  
  10.       .then((response) => {  
  11.         this._renderList(response.value);  
  12.       });  
  13.    }  
  14. }   

Finally, we will add the method given below, which will create HTML table out of the retrieved SharePoint list items. 

  1. private _renderList(items: ISPList[]): void {  
  2.   let html: string = '<table class="TFtable" border=1 width=100% style="border-collapse: collapse;">';  
  3.   html += `<th>EmployeeId</th><th>EmployeeName</th><th>Experience</th><th>Location</th>`;  
  4.   items.forEach((item: ISPList) => {  
  5.     html += `  
  6.          <tr>  
  7.         <td>${item.EmployeeId}</td>  
  8.         <td>${item.EmployeeName}</td>  
  9.         <td>${item.Experience}</td>  
  10.         <td>${item.Location}</td>  
  11.         </tr>  
  12.         `;  
  13.   });  
  14.   html += `</table>`;  
  15.   const listContainer: Element = this.domElement.querySelector('#spListContainer');  
  16.   listContainer.innerHTML = html;  
  17. }   

To enable rendering of the list items given above, we will replace Render method in the ‘GetSpListItemsWebPart’ class with the code given below. 

  1.  public render(): void {  
  2.      this.domElement.innerHTML = `  
  3.      <div class="${styles.helloWorld}">  
  4.   <div class="${styles.container}">  
  5.     <div class="ms-Grid-row ms-bgColor-themeDark ms-fontColor-white ${styles.row}">  
  6.       <div class="ms-Grid-col ms-u-lg10 ms-u-xl8 ms-u-xlPush2 ms-u-lgPush1">  
  7.         <span class="ms-font-xl ms-fontColor-white" style="font-size:28px">Welcome to SharePoint Framework Development</span>  
  8.           
  9.         <p class="ms-font-l ms-fontColor-white" style="text-align: center">Demo : Retrieve Employee Data from SharePoint List</p>  
  10.       </div>  
  11.     </div>  
  12.     <div class="ms-Grid-row ms-bgColor-themeDark ms-fontColor-white ${styles.row}">  
  13.     <div style="background-color:Black;color:white;text-align: center;font-weight: bold;font-size:18px;">Employee Details</div>  
  14.     <br>  
  15. <div id="spListContainer" />  
  16.     </div>  
  17.   </div>  
  18. </div>`;  
  19. this._renderListAsync();  
  20.   }   

Test the Web part in local SharePoint Workbench

Now,  we will see the output generated in the local SharePoint Workbench.

SharePoint

Since the environment is local, the mock data has been used to generate the table, as shown below.

SharePoint

Thus, we have successfully tested the client Web part locally.

Test the Web part in SharePoint Online

Now, let’s test the Web part in SharePoint Workbench available in SharePoint Online. This time, the EnvironmentType check will evaluate to SharePoint and REST API endpoint method will be called to retrieve the list items from SharePoint list. SharePoint Online list EmployeesList to which we are trying to connect, using REST API is given below.

SharePoint

Once we have login in to SharePoint Online, we can invoke the workbench by appending the text ‘_layouts/15/workbench.aspx’ to SharePoint Online URL. As we can see below, the items have been successfully retrieved, using REST API and the data has been built into HTML table in the client Web part.

SharePoint

We can further modify the CSS by making changes in the ‘GetSpListItems.module.scss’ file.

SharePoint

I have zipped the entire solution and attached it along with the article. Feel free to work on it.

Summary

Thus, we have successfully retrieved the list items from SharePoint List ‘EmployeeList’, using REST endpoint and have displayed it in tabular form in SharePoint Framework Client Web part.