sp-dev-fx-webparts

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.

SharePoint client-side web parts are controls that appear inside a SharePoint page but run locally in the browser. They’re the building blocks of pages that appear on a SharePoint site. You can build client-side web parts using modern script development tools and the SharePoint workbench (a development test surface), and you can deploy your client-side web parts to classic web part pages in Office 365 tenants. In addition to plain JavaScript projects, you can build web parts alongside common scripting frameworks, such as AngularJS and React. For example, you can use React along with components from Office UI Fabric React to quickly create experiences based on the same components used in Office 365.

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.

Additional resources

• Overview of the SharePoint Framework
• SharePoint Framework development tools and libraries
• Getting Started

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/pnp/sp-dev-fx-webparts.git

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

cd sp-dev-fx-webparts

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

Ensure that you are using the right version of node for the solution. You can do so by consulting the README.md file in the sample folder you are interested in. You will see a node version recommendation; you can also consult the SPFx Compatibility Matrix at https://aka.ms/spfx-matrix to find the supported versions of node for the version of SPFx used by the sample.

The sample folder may also contain a .nvmrc file, which is a version specifier that can be used with a node version manager such as nvm or nvs, ensure that you are using the right version of node for the project.

To switch to the correct version of node using nvm, run the following command in the folder containing the .nvmrc file:

nvm use

If using nvs, run the following command in the folder containing the .nvmrc file:

nvs use

Once the correct version of node is in use, 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.

Once the npm packages are installed, run the following command to preview your web parts in SharePoint Workbench:

gulp serve

Join the community calls

Stay up to date with the latest Copilot, Microsoft 365, and Power Platform topics by joining our weekly community calls. Everyone is welcome. Come to learn, ask questions, and connect with the community.

View the call schedule and download the recurring invites so you don’t miss an upcoming call.

Authors

This repository’s contributors are all community members who volunteered their time to share code samples. Work is done as an open source community project, with each sample contained in their own solution.

Contributions

These samples are direct from the feature teams, SharePoint PnP core team (http://aka.ms/m365pnp) 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 you have any questions, 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.

Code of Conduct

This repository 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!