SharePoint Framework Client-Side Web Part Samples & Tutorial Materials
This repository contains community samples that demonstrate different usage patterns for the SharePoint Framework client-side web parts.
We do welcome community contributions to the samples folder in this repository for demonstrating different use cases with SharePoint Framework. Notice that if you use 3rd party libraries, please make sure that library license allows distributions of it as part of your sample.
Have issues or questions?
Please use following logic on submitting your questions or issues to right location to ensure that they are noticed and addressed as soon as possible.
- You have general question or challenge with SPFx - use sp-dev-docs repository issue list.
- You have issue on specific web part or sample - use issue list in this repository.
- Overview of the SharePoint Framework
- SharePoint Framework development tools and libraries
- SharePoint Framework Reference
- Visual Studio Extension for SharePoint Framework projects
Using the samples
To build and start using these projects, you'll need to clone and build the projects.
Clone this repository by executing the following command in your console:
git clone https://github.com/SharePoint/sp-dev-fx-webparts.git
Navigate to the cloned repository folder which should be the same as the repository name:
To access the samples use the following command, where you replace
sample-folder-name with the name of the sample you want to access.
cd samples cd sample-folder-name
and for the tutorials, use the following command:
Now run the following command to install the npm packages:
This will install the required npm packages and dependencies to build and run the client-side project.
Once the npm packages are installed, run the following command to preview your web parts in SharePoint Workbench:
These samples are direct from the feature teams, SharePoint PnP core team (http://aka.ms/SharePointPnP) or shared by the community. We welcome your input on issues and suggestions for new samples. We do also welcome community contributions around the client-side web parts. If there's any questions around that, just let us know.
Please have a look on our Contribution Guidance before submitting your pull requests, so that we can get your contribution processed as fast as possible. Thx.
Sharing is caring!