sp-dev-fx-webparts/samples/README-template.md

# title of the sample

> When naming your sample, try to give it a friendly name that describes what it does. Avoid using terms like SharePoint and Web Part -- because that's what all the samples in this repo is all about. Also, don't use React, JavaScript, etc. in your sample title -- unless that's what the sample is about.

## 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


![picture of the web part in action](assets/preview.png)

## Used SharePoint Framework Version

![SPFx 1.11.0](https://img.shields.io/badge/version-1.11.0-green.svg)

## Applies to

* [SharePoint Framework](https://docs.microsoft.com/sharepoint/dev/spfx/sharepoint-framework-overview)
* [Office 365 tenant](https://docs.microsoft.com/sharepoint/dev/spfx/set-up-your-development-environment)

> Update accordingly as needed.

## Prerequisites

> Any special pre-requisites?

## Solution

Solution|Author(s)
--------|---------
folder name | Author details

## Version history

Version|Date|Comments
-------|----|--------
1.1|September 2, 2025|Update comment
1.0|August 29, 2025|Initial release

## 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.**

---

## Minimal Path to Awesome

* Clone this repository
* in the command line run:
  * `npm install`
  * `gulp serve`

> Include any additional steps as needed.

## 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

<img src="https://telemetry.sharepointpnp.com/sp-dev-fx-webparts/samples/readme-template" />
Updated Contribution guidelines and included readme-template for future samples. 2016-09-14 07:35:13 -04:00			`# title of the sample`

Update README-template.md 2020-11-08 22:51:22 -05:00			`> When naming your sample, try to give it a friendly name that describes what it does. Avoid using terms like SharePoint and Web Part -- because that's what all the samples in this repo is all about. Also, don't use React, JavaScript, etc. in your sample title -- unless that's what the sample is about.`

Updated Contribution guidelines and included readme-template for future samples. 2016-09-14 07:35:13 -04:00			`## Summary`
Adding missing telemetry images for readme files 2019-04-15 05:49:10 -04:00
Updated Contribution guidelines and included readme-template for future samples. 2016-09-14 07:35:13 -04:00			`Short summary on functionality and used technologies.`

Update README-template.md 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`.
Update README-template.md 2020-10-01 22:49:04 -04:00			`> If possible, use a resolution of 1920x1080.`
Update README-template.md 2020-10-01 22:46:42 -04: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.`
			`> 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`


			`![picture of the web part in action](assets/preview.png)`
Updated Contribution guidelines and included readme-template for future samples. 2016-09-14 07:35:13 -04:00
Adding missing telemetry images for readme files 2019-04-15 05:49:10 -04:00			`## Used SharePoint Framework Version`

Update README-template.md 2020-11-08 22:51:22 -05:00			`![SPFx 1.11.0](https://img.shields.io/badge/version-1.11.0-green.svg)`
Sample showing how to provision SharePoint assets using feature framework 2017-02-27 09:24:31 -05:00
Updated Contribution guidelines and included readme-template for future samples. 2016-09-14 07:35:13 -04:00			`## Applies to`

URL dev.office.com to docs.microsoft.com 2020-06-09 03:09:22 -04:00			`* [SharePoint Framework](https://docs.microsoft.com/sharepoint/dev/spfx/sharepoint-framework-overview)`
			`* [Office 365 tenant](https://docs.microsoft.com/sharepoint/dev/spfx/set-up-your-development-environment)`
Updated Contribution guidelines and included readme-template for future samples. 2016-09-14 07:35:13 -04:00
			`> Update accordingly as needed.`

			`## Prerequisites`
Adding missing telemetry images for readme files 2019-04-15 05:49:10 -04:00
Updated Contribution guidelines and included readme-template for future samples. 2016-09-14 07:35:13 -04:00			`> Any special pre-requisites?`

			`## Solution`

			`Solution\|Author(s)`
			`--------\|---------`
			`folder name \| Author details`

			`## Version history`

			`Version\|Date\|Comments`
			`-------\|----\|--------`
			`1.1\|September 2, 2025\|Update comment`
			`1.0\|August 29, 2025\|Initial release`

			`## Disclaimer`
Adding missing telemetry images for readme files 2019-04-15 05:49:10 -04:00
Updated Contribution guidelines and included readme-template for future samples. 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`

Adding missing telemetry images for readme files 2019-04-15 05:49:10 -04:00			`* Clone this repository`
			`* in the command line run:`
			* `npm install`
			* `gulp serve`
Updated Contribution guidelines and included readme-template for future samples. 2016-09-14 07:35:13 -04:00
			`> Include any additional steps as needed.`

			`## Features`
Adding missing telemetry images for readme files 2019-04-15 05:49:10 -04:00
Updated Contribution guidelines and included readme-template for future samples. 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:`

Adding missing telemetry images for readme files 2019-04-15 05:49:10 -04:00			`* topic 1`
			`* topic 2`
			`* topic 3`
Updated Contribution guidelines and included readme-template for future samples. 2016-09-14 07:35:13 -04:00
Update README-template.md Updated template to 1.10 2020-04-11 23:51:27 -04:00			`<img src="https://telemetry.sharepointpnp.com/sp-dev-fx-webparts/samples/readme-template" />`