This article provides general information and configuration specifics for building SharePoint add-ins with Kendo UI.
For more information on building SharePoint add-ins with Kendo UI, refer to:
SharePoint add-ins come in two flavors:
- Provider-hosted add-ins—Use external resources to SharePoint and can be built using any web stack (i.e. PHP)
The add-in model enables the incorporation of web technologies that allow for the use of front-end libraries such as Kendo UI.
Kendo UI is a well-suited solution when building SharePoint add-ins because of the following features it provides:
- Easy integration with the SharePoint REST API.
- Built-in themes, including one that matches the Office 365 look and feel.
- Built-in export functionalities to most common office formats, such as Excel, PDF, and image files.
- Widely-recognized accessibility standards like WAI-ARIA, WCAG 2.1, and Section 508.
The proper configuration of the Kendo UI DataSource ensures its proper connection with the SharePoint REST API. The SharePoint endpoints support a variety of serialization formats and make it possible for the Data Source to work with SharePoint data that is stored in document libraries, metadata lists, or user profiles. In this way, the SharePoint service interfaces are consumed by the Data Source when the Data Source performs CRUD data operations.
To configure the Kendo UI Data Source:
- Use the
transportoption. To enable the Data Source to utilize the SharePoint services and perform CRUD operation against them, use
transport. Note that you need to define a model for the Data Source because it drives the serialization plumbing.
- Include the
acceptrequest-header. To inform the receiving endpoint to issue a reply through JSON, include the
acceptrequest-header with the JSON MIME-type specified.
- Define the
data()function is necessary to parse the payload that is returned by the SharePoint REST API due to the presence of the
For more information on the Kendo UI Data Source abstraction, refer to its introductory article.
- Use the URL property of the
readoperation—SharePoint exposes services through the
<server>/<site>/_api/<feature_area>/<resource>URI structure. To load data from the service endpoint, configure the Data Source through the
URLproperty of the
- Set the
createoperation. The DataSource has to use the
POSTrequest method for the
createoperations because the SharePoint services are RESTful. To ensure it is provided to the receiving service, you also need to define a
- Set the
destroyoperations target service endpoints through the
DELETErequest methods respectively. To set the
destroyoperation, configure the