From d4e2709cedf445fc4c0b7ba30a836f70e03f95d4 Mon Sep 17 00:00:00 2001 From: Hugo Bernier Date: Mon, 3 May 2021 21:32:35 -0400 Subject: [PATCH] Updated readme and sample.json --- samples/README-template.md | 36 +++++++------ .../README.md | 45 ++++++++++------ .../assets/sample.json | 51 +++++++++++++++++++ .../RemoteEventReceiverManagerWebPart.ts | 3 +- 4 files changed, 103 insertions(+), 32 deletions(-) create mode 100644 samples/react-remote-event-receiver-manager/assets/sample.json diff --git a/samples/README-template.md b/samples/README-template.md index 14e24a875..e2ded7e1d 100644 --- a/samples/README-template.md +++ b/samples/README-template.md @@ -10,7 +10,6 @@ > > DELETE THIS PARAGRAPH BEFORE SUBMITTING - ## Summary Short summary on functionality and used technologies. @@ -60,15 +59,6 @@ Short summary on functionality and used technologies. > Update accordingly as needed. > DELETE THIS PARAGRAPH BEFORE SUBMITTING -## 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 - - ## Solution > We use this section to recognize and promote your contributions. Please provide one author per line -- even if you worked together on it. @@ -89,11 +79,13 @@ Version|Date|Comments 1.1|September 2, 2021|Update comment 1.0|August 29, 2021|Initial release -## Disclaimer +## Prerequisites -**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.** - ---- +> 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 @@ -117,4 +109,18 @@ This Web Part illustrates the following concepts on top of the SharePoint Framew > 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). + + \ No newline at end of file diff --git a/samples/react-remote-event-receiver-manager/README.md b/samples/react-remote-event-receiver-manager/README.md index 5b5ffcde5..434e045f6 100644 --- a/samples/react-remote-event-receiver-manager/README.md +++ b/samples/react-remote-event-receiver-manager/README.md @@ -1,19 +1,24 @@ -# Birthdays +# Remote Event Receiver Manager ## Summary -A very simple webpart that let's you add and delete remote event receivers to lists, the need came about due to remote event receivers not functioning properly when added with app only authentication and PnP.Powershell now only using that. -![Remote event reciver manager webpart](./assets/video.gif) +A very simple web part that lets you add and delete remote event receivers to lists, the need came about due to remote event receivers not functioning properly when added with app only authentication and PnP.Powershell now only using that. -## Used SharePoint Framework Version -![1.11.0](https://img.shields.io/badge/version-1.11.0-green.svg) +![Remote event receiver manager web part](./assets/video.gif) + +## Compatibility + +![SPFx 1.11](https://img.shields.io/badge/SPFx-1.11.0-green.svg) +![Node.js LTS 10.x](https://img.shields.io/badge/Node.js-LTS%2010.x-green.svg) +![SharePoint Online](https://img.shields.io/badge/SharePoint-Online-yellow.svg) +![Teams N/A: Untested with Microsoft Teams](https://img.shields.io/badge/Teams-N%2FA-lightgrey.svg "Untested with Microsoft Teams") +![Workbench Hosted: Does not work with local workbench](https://img.shields.io/badge/Workbench-Hosted-yellow.svg "Does not work with local workbench") ## 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) - ## Prerequisites None @@ -22,7 +27,7 @@ None Solution|Author(s) --------|--------- -react remote event receiver manager |Dan Toft +react remote event receiver manager | [Dan Toft](https://github.com/Tanddant) ([@tanddant](https://twitter.com/tanddant)) ## Version history @@ -30,11 +35,6 @@ Version|Date|Comments -------|----|-------- 1.0.0|May 3, 2021|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 - please follow all the steps. - Clone this repository @@ -43,9 +43,24 @@ Version|Date|Comments - `gulp build` - `gulp bundle --ship` - `gulp package-solution --ship` - - `Add and Deploy Package to AppCatalog ` - - + - Add and deploy package to AppCatalog ## Features + - See, add, and delete remote event receivers from a list + +## 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=react-remote-event-receiver-manager&authors=@Tanddant&title=react-remote-event-receiver-manager%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=react-remote-event-receiver-manager&authors=@Tanddant&title=react-remote-event-receiver-manager%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=react-remote-event-receiver-manager&authors=@Tanddant&title=react-remote-event-receiver-manager%20-%20). + + diff --git a/samples/react-remote-event-receiver-manager/assets/sample.json b/samples/react-remote-event-receiver-manager/assets/sample.json new file mode 100644 index 000000000..036f4f18f --- /dev/null +++ b/samples/react-remote-event-receiver-manager/assets/sample.json @@ -0,0 +1,51 @@ +[ + { + "name": "pnp-sp-dev-spfx-web-parts-react-remote-event-receiver-manager", + "source": "pnp", + "title": "Remote Event Receiver Manager", + "shortDescription": "Lets you add and delete remote event receivers to lists", + "url": "https://github.com/pnp/sp-dev-fx-webparts/tree/main/samples/react-remote-event-receiver-manager", + "longDescription": [ + "A very simple web part that lets you add and delete remote event receivers to lists, the need came about due to remote event receivers not functioning properly when added with app only authentication and PnP.Powershell now only using that." + ], + "creationDateTime": "2021-05-03", + "updateDateTime": "2021-05-03", + "products": [ + "SharePoint", + "Office" + ], + "metadata": [ + { + "key": "CLIENT-SIDE-DEV", + "value": "React" + }, + { + "key": "SPFX-VERSION", + "value": "1.11.0" + } + ], + "thumbnails": [ + { + "type": "image", + "order": 100, + "url": "https://github.com/pnp/sp-dev-fx-webparts/raw/main/samples/react-remote-event-receiver-manager/assets/video.gif", + "alt": "Word Game" + } + ], + "authors": [ + { + "gitHubAccount": "Tanddant", + "company": "", + "pictureUrl": "https://github.com/Tanddant.png", + "name": "Dan Toft" + } + ], + "references": [ + { + "name": "Build your first SharePoint client-side web part", + "description": "Client-side web parts are client-side components that run in the context of a SharePoint page. Client-side web parts can be deployed to SharePoint environments that support the SharePoint Framework. You can also use modern JavaScript web frameworks, tools, and libraries to build them.", + "url": "https://docs.microsoft.com/en-us/sharepoint/dev/spfx/web-parts/get-started/build-a-hello-world-web-part" + } + ] + } +] diff --git a/samples/react-remote-event-receiver-manager/src/webparts/remoteEventReceiverManager/RemoteEventReceiverManagerWebPart.ts b/samples/react-remote-event-receiver-manager/src/webparts/remoteEventReceiverManager/RemoteEventReceiverManagerWebPart.ts index c388c1b93..be76f4112 100644 --- a/samples/react-remote-event-receiver-manager/src/webparts/remoteEventReceiverManager/RemoteEventReceiverManagerWebPart.ts +++ b/samples/react-remote-event-receiver-manager/src/webparts/remoteEventReceiverManager/RemoteEventReceiverManagerWebPart.ts @@ -2,8 +2,7 @@ import * as React from 'react'; import * as ReactDom from 'react-dom'; import { Version } from '@microsoft/sp-core-library'; import { - IPropertyPaneConfiguration, - PropertyPaneTextField + IPropertyPaneConfiguration } from '@microsoft/sp-property-pane'; import { BaseClientSideWebPart } from '@microsoft/sp-webpart-base';