Implementing SharePoint Operations Using React.js - Part Two

Introduction

 

In this article, you will see how React JavaScript plugins can be plugged in to SharePoint pages for rendering the data.

 

In my previous article, I explained about the basic terminology required for implementing React JavaScript logic on SharePoint pages.

• Implementing SharePoint Operations Using React.js - Part One

Note

 

The core logic is implemented inside the class. The class can be created in two ways:

• React traditionally provides React.createClass method to create the component classes.
• Recently updated React JS version allows us to create the classes, using the React.Component method supported, using ES6 modules.

These two methods differ in implementation approaches. In this article, I will create the components, using ES6 modules.

 

Steps Involved

 

Upload the necessary plugins onto SharePoint site libraries. Instead of the local copies, the plugins can be directly accessed from cdn sites.

 

Create the content editor Webpart manually on the site. The custom Web parts can also be used. Inside the Web part, refer to the plugins explicitly.

<script src="https://unpkg.com/react@latest/dist/react.js"></script>
<script src="https://unpkg.com/react-dom@latest/dist/react-dom.js"></script>
<script src="https://unpkg.com/[email protected]/babel.min.js"></script>

Add the root HTML tag for appending the content, using JSX.

<div id="listInformation"></div>

JSX content is written inside the script tag, which is of the type text/babel. Babel plugin helps the code to be executed on the Browsers.

 

Create the class with custom name, using React.Component method.

 

Class should contain a constructor, which has super() method declared. Set the state container with the necessary variables. In this sample, list name, descriptions, template ID and items count are stored.

constructor(){
     super();
     this.state = {
         listInfo: {listName: '',listDescription: '', templateId:0, itemCount: 0}
     }
 }

Since the data needs to be rendered on the page load, one of the life cycle methods is used to retrieve the list information and set it into the state variables. In this sample, the data is retrieved asynchronously. Thus, componentDidMount method is used. The custom function is created for retrieving the list information. 

GetListInfo(){
    var reactHandler = this;

    var request = new XMLHttpRequest();
    request.open('GET', "/_api/web/lists/getbytitle('TestList')", true);
    request.setRequestHeader('Content-Type', 'application/json; charset=UTF-8');

    //this callback gets called when the server responds to the ajax call
    request.onreadystatechange = function(){
        if (request.readyState === 4 && request.status === 200){
            var returnedJson = JSON.parse(request.responseText);

            reactHandler.setState({
                listInfo:
                {
                    listName: returnedJson.Title,
                    listDescription: returnedJson.Description,
                    templateId: returnedJson.BaseTemplate,
                    itemCount: returnedJson.ItemCount
                }
            });
        }
        else if (request.readyState === 4 && request.status !== 200){
            console.log('Error in retrieving data!');
        }
    };
    request.send();
}

Note

Event handlers can also be used instead of the method shown above, if the data retrieval is based on the user action.

 

The render method displays the data. HTML is inserted into this method. The state variables are referred to in this method to display the necessary information.

render(){
    return(
    <div>
        <h2>{this.state.listInfo.listName} List Information:</h2>
        <p>{this.state.listInfo.listDescription}</p>
        <p>Template : {this.state.listInfo.templateId}</p>
        <p>Total Items: {this.state.listInfo.itemCount}</p>
    </div>
    );
}

The render method is called to render the component data.

ReactDOM.render(<ListJS />, document.getElementById('listInformation'));

The code snippet given below shows the entire logic to retrieve the list information.

<script src="https://unpkg.com/react@latest/dist/react.js"></script>
<script src="https://unpkg.com/react-dom@latest/dist/react-dom.js"></script>
<script src="https://unpkg.com/[email protected]/babel.min.js"></script>

<div id="listInformation"></div>
<script type="text/babel">

    class ListJS extends React.Component{
        constructor(){
            super();
            this.state = {
                listInfo: {listName: '',listDescription: '', templateId:0, itemCount: 0}
            }
        }
        componentDidMount() {
            // Custom function to retrieve the list info
            this.GetListInfo();
        }

        GetListInfo(){
            var reactHandler = this;

            var request = new XMLHttpRequest();
            request.open('GET', "/_api/web/lists/getbytitle('TestList')", true);
            request.setRequestHeader('Content-Type', 'application/json; charset=UTF-8');

            //this callback gets called when the server responds to the ajax call
            request.onreadystatechange = function(){
                if (request.readyState === 4 && request.status === 200){
                    var returnedJson = JSON.parse(request.responseText);

                    reactHandler.setState({
                        listInfo:
                        {
                            listName: returnedJson.Title,
                            listDescription: returnedJson.Description,
                            templateId: returnedJson.BaseTemplate,
                            itemCount: returnedJson.ItemCount
                        }
                    });
                }
                else if (request.readyState === 4 && request.status !== 200){
                    console.log('Error in retrieving data!');
                }
            };
            request.send();
        }

        render(){
            return(
            <div>
                <h2>{this.state.listInfo.listName} List Information:</h2>
                <p>{this.state.listInfo.listDescription}</p>
                <p>Template : {this.state.listInfo.templateId}</p>
                <p>Total Items: {this.state.listInfo.itemCount}</p>
            </div>
            );
        }

    }

    ReactDOM.render(<ListJS />, document.getElementById('listInformation'));
</script>

The snapshot given below shows the Webpart, which shows the list information, using the logic stated above.

 
Summary

 

Thus, you have learned implementing the basic SharePoint list detail retrieval information, using React JavaScript plugins.