This repository contains the samples that demonstrate different usage patterns for the SharePoint Framework library component.

SharePoint Framework library components are shared code, which multiple SharePoint Framework can easily share in the context of the SharePoint or Microsoft TEams. You can build library components using modern script development tools and you can deploy your library components in Office 365 tenants. In addition to plain JavaScript projects, you can also build library components with common scripting frameworks, such as AngularJS and React.

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 library component or sample - use issue list in this repository.

• SharePoint Framework Library Component overview
• SharePoint Framework Library Component tutorial
• SharePoint Framework development tools and libraries
• SharePoint Framework Reference

To build and start using these projects, you'll need to clone and build the projects.

Clone this repo by executing the following command in your console:

git clone https://github.com/SharePoint/sp-dev-fx-library-components.git

Navigate to the cloned repository folder which should be the same as the repository name:

cd sp-dev-fx-library-components

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

Now run the following command to install the npm packages:

npm install

This will install the required npm packages and dependencies to build and run the client-side project.

These samples are direct from the feature teams, SharePoint PnP core team (http://aka.ms/sppnp) or shared by the community. We welcome your input on issues and suggestions for new samples. We do also welcome community contributions around the libraries. 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.

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.

When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

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!