mirror of
https://github.com/pnp/sp-dev-fx-webparts.git
synced 2025-02-18 19:07:12 +00:00
126 lines
6.6 KiB
Markdown
126 lines
6.6 KiB
Markdown
# Title of the sample
|
|
|
|
> 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.
|
|
> GOOD 👍:
|
|
> Kitten Videos
|
|
> BAD 👎:
|
|
> react-kittenvideos
|
|
> SPFx Kitten Videos Web Part for SharePoint using React
|
|
>
|
|
> DELETE THIS PARAGRAPH BEFORE SUBMITTING
|
|
|
|
## Summary
|
|
|
|
Short summary on functionality and used technologies.
|
|
|
|
> Please provide a high-quality screenshot of your web parts below. It should be stored in a folder called `assets`.
|
|
> If possible, use a resolution of 1920x1080.
|
|
> 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.
|
|
> 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
|
|
|
|
|
|
|
|
## Compatibility
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
> 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:
|
|
> 
|
|
>
|
|
> If you specifically built and tested this web part to work with Teams, use this for the Teams compatibility tag:
|
|
> 
|
|
> And if you know for sure that it is NOT compatible with Teams, use this:
|
|
> 
|
|
>
|
|
> DELETE THIS PARAGRAPH BEFORE SUBMITTING
|
|
|
|
## Applies to
|
|
|
|
* [SharePoint Framework](https://docs.microsoft.com/sharepoint/dev/spfx/sharepoint-framework-overview)
|
|
* [Microsoft 365 tenant](https://docs.microsoft.com/sharepoint/dev/spfx/set-up-your-development-environment)
|
|
|
|
> Update accordingly as needed.
|
|
> DELETE THIS PARAGRAPH BEFORE SUBMITTING
|
|
|
|
## Solution
|
|
|
|
> We use this section to recognize and promote your contributions. Please provide one author per line -- even if you worked together on it.
|
|
> We'll only use the info you provided here. Make sure to include your full name, not just your GitHub username.
|
|
> Provide a link to your GitHub profile to help others find more cool things you have done.
|
|
> If you provide a link to your Twitter profile, we'll promote your contribution on social media.
|
|
>
|
|
> DELETE THE TEXT ABOVE BEFORE SUBMITTING
|
|
|
|
Solution|Author(s)
|
|
--------|---------
|
|
folder name | [Author Name](LinkToYourGitHubProfile) ([@yourtwitterhandle](https://twitter.com/yourtwitterhandle)), Company
|
|
|
|
## Version history
|
|
|
|
Version|Date|Comments
|
|
-------|----|--------
|
|
1.1|September 2, 2021|Update comment
|
|
1.0|August 29, 2021|Initial release
|
|
|
|
## Prerequisites
|
|
|
|
> 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.
|
|
>
|
|
> Please describe the steps to configure the pre-requisites. Feel free to add screen shots, but make sure that there is a text description of the steps to perform.
|
|
>
|
|
> DELETE THE TEXT ABOVE BEFORE SUBMITTING
|
|
|
|
## Minimal Path to Awesome
|
|
|
|
* Clone this repository
|
|
* in the command line run:
|
|
* `npm install`
|
|
* `gulp serve`
|
|
|
|
> Include any additional steps as needed.
|
|
> DELETE THIS PARAGRAPH BEFORE SUBMITTING
|
|
|
|
## 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
|
|
|
|
> 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
|
|
|
|
## 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.**
|
|
|
|
## Support
|
|
|
|
We do not support samples, but we do use GitHub to track issues and constantly want to improve these samples.
|
|
|
|
If you encounter any issues while using this sample, [create a new issue](https://github.com/pnp/sp-dev-fx-webparts/issues/new?assignees=&labels=Needs%3A+Triage+%3Amag%3A%2Ctype%3Abug-suspected&template=bug-report.yml&sample=YOUR-SOLUTION-NAME&authors=@YOURGITHUBUSERNAME&title=YOUR-SOLUTION-NAME%20-%20).
|
|
|
|
For questions regarding this sample, [create a new question](https://github.com/pnp/sp-dev-fx-webparts/issues/new?assignees=&labels=Needs%3A+Triage+%3Amag%3A%2Ctype%3Abug-suspected&template=question.yml&sample=YOUR-SOLUTION-NAME&authors=@YOURGITHUBUSERNAME&title=YOUR-SOLUTION-NAME%20-%20).
|
|
|
|
Finally, if you have an idea for improvement, [make a suggestion](https://github.com/pnp/sp-dev-fx-webparts/issues/new?assignees=&labels=Needs%3A+Triage+%3Amag%3A%2Ctype%3Abug-suspected&template=suggestion.yml&sample=YOUR-SOLUTION-NAME&authors=@YOURGITHUBUSERNAME&title=YOUR-SOLUTION-NAME%20-%20).
|
|
|
|
<img src="https://telemetry.sharepointpnp.com/sp-dev-fx-webparts/samples/YOUR-SOLUTION-NAME" /> |