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

2.3 KiB

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.

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

Used SharePoint Framework Version

SPFx 1.11.0

Applies to

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