Skip to content

Latest commit

 

History

History
133 lines (98 loc) · 7.11 KB

README-template.md

File metadata and controls

133 lines (98 loc) · 7.11 KB

title of the sample

Use the human-friendly title here. No need to repeat the words React, SPFx, extension or SharePoint unless it is absolutely necessary. The name of the sample should already provide that information. GOOD 👍: Kitten Video Injection BAD 👎: react-command-kittenvideoinjection SPFx Kitten Videos Command Extension for SharePoint using React

DELETE THIS PARAGRAPH BEFORE SUBMITTING

Summary

Short summary on functionality and used technologies.

picture of the extension in action

Please provide a high-quality screenshot of your extension below. It should be stored in a folder called assets. If possible, use a resolution of 1920x1080. If your extension requires the user to configure it, please use a screenshot of the extension as it appears after it has been configured. You can add as many screen shots as you'd like to help users understand your extension without having to download it and install it. DELETE THIS PARAGRAPH BEFORE SUBMITTING

Compatibility

SPFx 1.13.1 Node.js LTS v14 | LTS v12 | LTS v10 Compatible with SharePoint Online Does not work with SharePoint 2019 Does not work with SharePoint 2016 (Feature Pack 2) Local Workbench Unsupported Hosted Workbench Incompatible

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

If using SPFx 1.12.1, update the SPFx and Node.js tags accordingly: SPFx 1.12.1 Node.js LTS v14 | LTS v12 | LTS 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 LTS 10.x

SPFx 1.4.1 SPFx 1.4.1 Node.js LTS 6.x | LTS 8.x

DELETE THIS PARAGRAPH BEFORE SUBMITTING

Applies to

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 (@yourtwitterhandle), Company

Version history

Version Date Comments
1.1 August 10, 2022 Update comment
1.0 June 29, 2022 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 extension with possible additional details than in short summary. This extension illustrates the following concepts:

  • topic 1
  • topic 2
  • topic 3

Debug URL for testing

Here's a debug URL for testing around this sample.

?loadSPFX=true&debugManifestsFile=https://localhost:4321/temp/manifests.js&customActions={"7c5a85c1-8b1e-4370-8198-642908faee60":{"location":"ClientSideExtension.ApplicationCustomizer","properties":{"testMessage":"Hello as property!"}}}

Update based on your manifest id for easy testing of the sample Note that better pictures and documentation will increase the sample usage and the value you are providing for others. Thanks for your submissions inadvance! 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.

Help

We do not support samples, but we 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.

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 while 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.