2020-11-08 22:53:29 -05:00
# Title of the sample
2016-09-14 07:35:13 -04:00
2020-11-08 22:53:29 -05:00
> This is how you want the sample to appear in the samples browser.
> When naming your sample, try to give it a friendly name that describes what it does. Avoid using terms like `SharePoint` and `WebPart` -- because that's what all the samples in this repo is all about. Also, don't use `React`, `Angular`, `JavaScript`, etc. in your sample title -- unless that's what the sample is about.
2021-01-23 13:50:11 -05:00
> GOOD 👍:
> Kitten Videos
> BAD 👎:
> react-kittenvideos
> SPFx Kitten Videos Web Part for SharePoint using React
>
> DELETE THIS PARAGRAPH BEFORE SUBMITTING
2020-11-08 22:51:22 -05:00
2016-09-14 07:35:13 -04:00
## Summary
2019-04-15 05:49:10 -04:00
2016-09-14 07:35:13 -04:00
Short summary on functionality and used technologies.
2020-10-01 22:46:42 -04:00
> Please provide a high-quality screenshot of your web parts below. It should be stored in a folder called `assets`.
2020-10-01 22:49:04 -04:00
> If possible, use a resolution of 1920x1080.
2020-11-08 22:53:29 -05:00
> If your web part uses a placeholder screen and requires the user to configure it, please use a screenshot of the web part as it appears **after** it has been configured.
2020-10-01 22:46:42 -04:00
> You can add as many screen shots as you'd like to help users understand your web part without having to download it and install it.
> DELETE THIS PARAGRAPH BEFORE SUBMITTING
2016-09-14 07:35:13 -04:00
2021-01-23 13:50:11 -05:00
## Compatibility
2021-01-23 13:52:21 -05:00
2021-01-23 13:50:11 -05:00
> Don't worry if you're unsure about the compatibility matrix above. We'll verify it when we approve the PR.
>
> If using an older version of SPFx, update the SPFx compatibility tag accordingly:
> 
>
> Here's the Node.js compatibility tag for SPFx 1.4.1:
> 
>
> If you built this sample specifically for SharePoint 2016, or SharePoint 2019 support, update the SharePoint compatibility tag accordingly:
> 
> 
> If you know your web part only works on the hosted workbench, you can use this for the workbench compatibility tag:
2021-01-23 13:52:21 -05:00
> 
2021-01-23 13:50:11 -05:00
>
> If you specifically built and tested this web part to work with Teams, use this for the Teams compatibility tag:
2021-01-23 13:52:21 -05:00
> 
2021-01-23 13:50:11 -05:00
> And if you know for sure that it is NOT compatible with Teams, use this:
2021-01-23 13:52:21 -05:00
> 
2021-01-23 13:50:11 -05:00
>
> DELETE THIS PARAGRAPH BEFORE SUBMITTING
2017-02-27 09:24:31 -05:00
2016-09-14 07:35:13 -04:00
## Applies to
2020-06-09 03:09:22 -04:00
* [SharePoint Framework ](https://docs.microsoft.com/sharepoint/dev/spfx/sharepoint-framework-overview )
2021-01-24 10:25:36 -05:00
* [Microsoft 365 tenant ](https://docs.microsoft.com/sharepoint/dev/spfx/set-up-your-development-environment )
2016-09-14 07:35:13 -04:00
> Update accordingly as needed.
2021-01-23 13:50:11 -05:00
> DELETE THIS PARAGRAPH BEFORE SUBMITTING
2016-09-14 07:35:13 -04:00
## Prerequisites
2019-04-15 05:49:10 -04:00
2021-01-23 13:50:11 -05:00
> Any special pre-requisites? Include any lists, permissions, offerings to the demo gods, or whatever else needs to be done for this web part to work.
> DELETE THIS PARAGRAPH BEFORE SUBMITTING
2016-09-14 07:35:13 -04:00
## Solution
Solution|Author(s)
--------|---------
folder name | Author details
## Version history
Version|Date|Comments
-------|----|--------
2021-01-23 13:50:11 -05:00
1.1|September 2, 2021|Update comment
1.0|August 29, 2021|Initial release
2016-09-14 07:35:13 -04:00
## Disclaimer
2019-04-15 05:49:10 -04:00
2016-09-14 07:35:13 -04:00
**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.**
---
## Minimal Path to Awesome
2019-04-15 05:49:10 -04:00
* Clone this repository
* in the command line run:
* `npm install`
* `gulp serve`
2016-09-14 07:35:13 -04:00
> Include any additional steps as needed.
2021-01-23 13:50:11 -05:00
> DELETE THIS PARAGRAPH BEFORE SUBMITTING
2016-09-14 07:35:13 -04:00
## Features
2019-04-15 05:49:10 -04:00
2016-09-14 07:35:13 -04:00
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:
2019-04-15 05:49:10 -04:00
* topic 1
* topic 2
* topic 3
2016-09-14 07:35:13 -04:00
2021-01-23 13:50:11 -05:00
> Note that better pictures and documentation will increase the sample usage and the value you are providing for others. Thanks for your submissions in advance! You rock ❤.
> DELETE THIS PARAGRAPH BEFORE SUBMITTING
2020-04-11 23:51:27 -04:00
< img src = "https://telemetry.sharepointpnp.com/sp-dev-fx-webparts/samples/readme-template" / >
