page_type	products	languages	extensions
sample	office-sp	typescript	contentType technologies createdDate samples SharePoint Framework 6/24/2021 10:21:43 AM

SharePoint Framework Reference Samples

Samples targeted to showcase the power of SharePoint Framework in the Microsoft Teams and in Viva Connections. Notice that these are using preview version of the SharePoint Framework 1.13, which in currently planned to get released in mid September.

Legend

All samples are prefixed with the following prefixes to indicate what type of solution they help illustrate. All prefixes have been added in alphabetically order.

• ace: Viva Connections Adaptive Card Extension
• teams: Custom Microsoft Teams manifest for personal apps and teams tabs.

Index

• Company News ACE
• Basic ACE
• Teams Chat ACE
• Covid Self-Attestation Microsoft Teams Personal App
• Executive Room Reservation Reference Microsoft Teams Personal App
• World Clock Microsoft Teams Personal App/Teams Tab
• PnP Contoso Orders

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/spfx-reference-scenarios.git

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

cd spfx-reference-scenarios

To access the samples use the following command, where you replace sample-folder-name with the name of the sample you want to access and sample-source with the folder that contains the sample name ending in -spfx which is the source code.

cd samples
cd sample-folder-name
cd sample-source

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.

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

gulp serve

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 are Microsoft sanctioned reference samples only and we are not accepting pull requests at this time. We absolutely want and welcome community contributions in one of our other samples repos. See Samples & Solutions for more information.

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 opencode@microsoft.com with any additional questions or comments.

Sharing is caring!