This repository contains the samples that demonstrate different usage patterns for the SharePoint Framework extensions.
Note: The SharePoint Framework Extensions are currently in preview and is subject to change. SharePoint Framework extensions are not currently supported for use in production environments. You can use only client-side web parts in production.
SharePoint extensions 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 extensions using modern script development tools and you can deploy your extensions to modern pages in Office 365 tenants. In addition to plain JavaScript projects, you can build extensions 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 natively.
- SharePoint Framework Extensions (preview)
- Overview of the SharePoint Framework
- SharePoint Framework development tools and libraries
- SharePoint Framework Reference
- Visual Studio Extension for SharePoint Framework projects
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-extensions.git
Navigate to the cloned repository folder which should be the same as the repository name:
cd sp-dev-fx-extensions
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:
cd tutorials
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 start nodejs to host your extension and preview that in the SharePoint Online pages:
gulp serve
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 extensions. 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!