honeymoose
/
sp-dev-fx-webparts
mirror of https://github.com/pnp/sp-dev-fx-webparts.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
sp-dev-fx-webparts/templates/README-template.md

11 KiB
Raw Blame History

Title of the sample

Summary

Short summary on functionality and used technologies.

Example of a good preview

Also a good preview

Not so good

Compatibility

SPFx 1.14 Node.js v14 | v12 Compatible with SharePoint Online Does not work with SharePoint 2019 Does not work with SharePoint 2016 (Feature Pack 2) Local Workbench Unsupported Hosted Workbench Compatible Compatible with Remote Containers

If using SPFx 1.12.1, update the SPFx and Node.js tags accordingly: SPFx 1.12.1 Node.js v14 | v12 | v10

If using an older version of SPFx, update the SPFx and Node.js compatibility tag accordingly:

SPFx 1.11 SPFx 1.11 Node.js v10

SPFx 1.10 SPFx 1.10 Node.js v10 | v8

SPFx 1.4.1 SPFx 1.4.1 Node.js v6 | v8

If you built this sample specifically for SharePoint 2016, or SharePoint 2019 support, update the SharePoint compatibility tag accordingly: Works with SharePoint 2019 Work with SharePoint 2016 (Feature Pack 2)

If you know your web part only works on the hosted workbench, you can use this for the workbench compatibility tag: Local Workbench Incompatible

Otherwise: Local Workbench Compatible

If your web part needs permissions before working in the hosted workbench, let people know; Hosted Workbench (Requires permissions))

or: Hosted Workbench Partially)

Otherwise: Hosted Workbench Compatible

If you specifically built and tested this web part to work with Teams, use this for the Teams compatibility tag: Teams Yes: Designed for Microsoft Teams And if you know for sure that it is NOT compatible with Teams, use this: Teams No: Not designed for Microsoft Teams

Don't worry if you're unsure about the compatibility matrix above. We'll verify it when we approve the PR. -->

Applies to

Get your own free development tenant by subscribing to Microsoft 365 developer program

Solution

Solution Author(s)
folder name Author Name (@yourtwitterhandle), Company

Version history

Version Date Comments
1.1 November 1, 2022 Update comment
1.0 October 29, 2022 Initial release

Prerequisites

Minimal path to awesome

  • Clone this repository (or download this solution as a .ZIP file then unzip it)
  • From your command line, change your current directory to the directory containing this sample (YOUR-SOLUTION-NAME, located under samples)
  • in the command line run:
    • npm install
    • gulp serve

This sample can also be opened with VS Code Remote Development. Visit https://aka.ms/spfx-devcontainer for further instructions.

Features

Description of the web part with possible additional details than in short summary. This Web Part illustrates the following concepts on top of the SharePoint Framework:

  • topic 1
  • topic 2
  • topic 3

Help

We do not support samples, but this community is always willing to help, and we want to improve these samples. We use GitHub to track issues, which makes it easy for community members to volunteer their time and help resolve issues.

If you're having issues building the solution, please run spfx doctor from within the solution folder to diagnose incompatibility issues with your environment.

You can try looking at issues related to this sample to see if anybody else is having the same issues.

You can also try looking at discussions related to this sample and see what the community is saying.

If you encounter any issues using this sample, create a new issue.

For questions regarding this sample, create a new question.

Finally, if you have an idea for improvement, make a suggestion.

Disclaimer

THIS CODE IS PROVIDED AS IS WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING ANY IMPLIED WARRANTIES OF FITNESS FOR A PARTICULAR PURPOSE, MERCHANTABILITY, OR NON-INFRINGEMENT.