JavaScript Core Component

The Patterns and Practices JavaScript Core Library was created to help developers by simplifying common operations within SharePoint. This is aligned with helping folks transitioning into client side development in support of the upcoming SharePoint Framework. Currently it contains a fluent API for working with the full SharePoint REST API as well as utility and helper functions. This takes the guess work out of creating REST requests, letting developers focus on the what and less on the how.

Please use http://aka.ms/OfficeDevPnP for getting latest information around the whole Office 365 Developer Patterns and Practices program.

Get Started

NPM

Add the npm package to your project

npm install sp-pnp-js --save-dev

Import the root object and start interacting with the SharePoint REST API

import pnp from "sp-pnp-js"
...
pnp.sp.web.select("Title").get().then(() => ...);

Bower

Add the package from bower

bower install sp-pnp-js

API Documentation

Explore the API documentation.

These pages are generated from the source comments as part of each release. We are always looking for help making these resources better. To make updates, edit the comments in the source and submit a PR against the dev branch. We will merge it there and refresh the pages as part of each release. Updates made directly to the gh-pages branch will be overwritten.

Samples Add-In

Checkout a SharePoint hosted Add-In containing samples on using the library from both a SharePoint hosted add-in as well as a script editor web part. This will allow you to execute the samples as well as intract with the API.

Get Help

We have active Yammer and Gitter communities dedicated to this library, please join the conversation to ask questions. If you find an issue with the library, please report it.

Wiki

Please see the wiki for tips on getting started, configuring your development environment, and using the library.

Authors

This project's contributors include Microsoft and community contributors. Work is done as as open source community project.

Code of Conduct

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.

"Sharing is Caring"

Disclaimer

THIS CODE IS PROVIDED AS IS WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING ANY IMPLIED WARRANTIES OF FITNESS FOR A PARTICULAR PURPOSE, MERCHANTABILITY, OR NON-INFRINGEMENT.