JavaScript Core Library

The Patterns and Practices JavaScript Core Library was created to help developers by simplifying common operations within SharePoint and the 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/sppnp for getting latest information around the whole SharePoint Patterns and Practices (PnP) initiative.

Special Message on the Future of sp-pnp-js

What

We have created a new repo that will continue the work started with sp-pnp-js and encourage you to begin migrating your existing projects, and for new projects using these libraries. Please review the transtion guide to help with your migration.

Why

This move does a few things that will benefit everyone long term. Breaking up the single package into multiple gives developers the ability to control which pieces are brought into their projects. As well it gives us the oppotunity to grow without a single .js file growing. It also serves as an opportunity to update our tooling, packaging, and releases to better align with evolving industry norms. Finally, by grouping things within the @pnp scope it is easy to identify packages published by the SharePoint Patterns and Practices team.

Timeline

Between now and July 2018 we will maintain both libraries in parallel. Meaning code added to one will in most cases be put into the other. There will be some exceptions where features are only added to the new libraries, but we will make every effort to minimize differences during this time.

After July 2018 we will only update, maintain, and release the @pnp scoped libraries. sp-pnp-js will remain on npm so you can continue to install it for existing projects, and the repo will remain as a reference. No existing projects will break due to this move.

We understand this is a disruption, but by giving many months notice we hope it will provide sufficient time to adjust and migrate any existing projects. As always we welcome feedback and questions.

Get Started

NPM

Add the npm package to your project

npm install sp-pnp-js --save

Bower

Add the package from bower

bower install sp-pnp-js

Wiki

Please see the wiki for detailed guides on getting started both using and contributing to the library. The Developer Guide is a great place to get started.

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 an active Gitter community dedicated to this library, please join the conversation to ask questions. If you find an issue with the library, please report it.

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 opencode@microsoft.com 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.