diff --git a/samples/README-template.md b/samples/README-template.md index 08fc6952d..d1d9dd96c 100644 --- a/samples/README-template.md +++ b/samples/README-template.md @@ -1,24 +1,28 @@ # 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 + ![picture of the web part in action](assets/preview.png) @@ -32,58 +36,70 @@ Short summary on functionality and used technologies. ![Local Workbench Unsupported](https://img.shields.io/badge/Local%20Workbench-Unsupported-red.svg "Local workbench is no longer available as of SPFx 1.13 and above") ![Hosted Workbench Compatible](https://img.shields.io/badge/Hosted%20Workbench-Compatible-green.svg) -> 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](https://img.shields.io/badge/SPFx-1.12.1-green.svg) -> ![Node.js v14 | v12 | v10](https://img.shields.io/badge/Node.js-v14%20%7C%20v12%20%7C%20v10-green.svg) -> -> If using an older version of SPFx, update the SPFx and Node.js compatibility tag accordingly: -> SPFx 1.11 -> ![SPFx 1.11](https://img.shields.io/badge/SPFx-1.11.0-green.svg) -> ![Node.js v10](https://img.shields.io/badge/Node.js-v10-green.svg) -> -> SPFx 1.10 -> ![SPFx 1.10](https://img.shields.io/badge/SPFx-1.10.0-green.svg) -> ![Node.js v10 | v8](https://img.shields.io/badge/Node.js-v10%20%7C%20v8-green.svg) -> -> SPFx 1.4.1 -> ![SPFx 1.4.1](https://img.shields.io/badge/SPFx-1.4.1-green.svg) -> ![Node.js v6 | v8](https://img.shields.io/badge/Node.js-LTS%206.x%20%7C%20v8-green.svg) -> -> If you built this sample specifically for SharePoint 2016, or SharePoint 2019 support, update the SharePoint compatibility tag accordingly: -> ![Works with SharePoint 2019](https://img.shields.io/badge/SharePoint%20Server%202019-Compatible-green.svg) -> ![Work with SharePoint 2016 (Feature Pack 2)](https://img.shields.io/badge/SharePoint%20Server%202016%20(Feature%20Pack%202)-Compatible-green.svg) -> If you know your web part only works on the hosted workbench, you can use this for the workbench compatibility tag: -> ![Local Workbench Incompatible](https://img.shields.io/badge/Local%20Workbench-Incompatible-red.svg "The solution requires access to XXX") -> ![Hosted Workbench Compatible](https://img.shields.io/badge/Hosted%20Workbench-Compatible-green.svg) -> -> Otherwise: -> > ![Local Workbench Compatible](https://img.shields.io/badge/Local%20Workbench-Compatible-green.svg) -> -> If you specifically built and tested this web part to work with Teams, use this for the Teams compatibility tag: -> ![Teams Yes: Designed for Microsoft Teams](https://img.shields.io/badge/Teams-Yes-green.svg "Designed for Microsoft Teams") -> And if you know for sure that it is NOT compatible with Teams, use this: -> ![Teams No: Not designed for Microsoft Teams](https://img.shields.io/badge/Teams-No-red.svg "Not designed for Microsoft Teams") -> -> 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 + Solution|Author(s) --------|--------- @@ -98,22 +114,33 @@ Version|Date|Comments ## 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. @@ -123,11 +150,15 @@ This Web Part illustrates the following concepts on top of the SharePoint Framew * 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 + + We do not support samples, but 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. If you're having issues building the solution, please run [spfx doctor](https://pnp.github.io/cli-microsoft365/cmd/spfx/spfx-doctor/) from within the solution folder to diagnose incompatibility issues with your environment. @@ -154,3 +205,4 @@ For questions regarding this sample, [create a new question](https://github.com/ 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). + diff --git a/samples/js-workbench-customizer/README.md b/samples/js-workbench-customizer/README.md index 4fb29ba41..6858c8742 100644 --- a/samples/js-workbench-customizer/README.md +++ b/samples/js-workbench-customizer/README.md @@ -34,8 +34,6 @@ Alternatively, you can add the output files for the web part to a custom SPFx pr ![Local Workbench Compatible](https://img.shields.io/badge/Local%20Workbench-Compatible-green.svg) ![Hosted Workbench Compatible](https://img.shields.io/badge/Hosted%20Workbench-Compatible-green.svg) - - ## Applies to * [SharePoint Framework](https://docs.microsoft.com/sharepoint/dev/spfx/sharepoint-framework-overview) @@ -49,7 +47,7 @@ Alternatively, you can add the output files for the web part to a custom SPFx pr Solution|Author(s) --------|--------- -workbench-customizer|Joel Rodrigues +workbench-customizer|[Joel Rodrigues](https://github.com/joelfmrodrigues) ## Version history @@ -69,6 +67,9 @@ Version|Date|Comments * `npm install` * `gulp serve` +## Video + +[![Workbench customizer for improved debugging experience](./assets/video-thumbnail.jpg)](https://www.youtube.com/watch?v=u1Bnb7yn3_w "Workbench customizer for improved debugging experience") ## Disclaimer @@ -76,10 +77,13 @@ Version|Date|Comments ## 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. +We do not support samples, but 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. -If you're having issues building the solution, please run [spfx doctor](https://pnp.github.io/cli-microsoft365/cmd/spfx/spfx-doctor/) from -within the solution folder to diagnose incompatibility issues with your environment. +If you're having issues building the solution, please run [spfx doctor](https://pnp.github.io/cli-microsoft365/cmd/spfx/spfx-doctor/) from within the solution folder to diagnose incompatibility issues with your environment. + +You can try looking at [issues related to this sample](https://github.com/pnp/sp-dev-fx-webparts/issues?q=label%3Ajs-workbench-customizer) to see if anybody else is having the same issues. + +You can also try looking at [discussions related to this sample](https://github.com/pnp/sp-dev-fx-webparts/discussions?discussions_q=label%3Ajs-workbench-customizer) and see what the community is saying. 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=js-workbench-customizer&authors=@joelfmrodrigues&title=js-workbench-customizer%20-%20). diff --git a/samples/js-workbench-customizer/assets/video-thumbnail.jpg b/samples/js-workbench-customizer/assets/video-thumbnail.jpg new file mode 100644 index 000000000..79867708a Binary files /dev/null and b/samples/js-workbench-customizer/assets/video-thumbnail.jpg differ diff --git a/samples/react-dynamics-crm-api/README.md b/samples/react-dynamics-crm-api/README.md index 16e9f62b4..76dab30f5 100644 --- a/samples/react-dynamics-crm-api/README.md +++ b/samples/react-dynamics-crm-api/README.md @@ -7,7 +7,6 @@ This sample shows how to consume Dynamics CRM API using AadTokenProvider class. ## Compatibility - ![SPFx 1.10](https://img.shields.io/badge/SPFx-1.10.0-green.svg) ![Node.js v10 | v8](https://img.shields.io/badge/Node.js-v10%20%7C%20v8-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) @@ -62,7 +61,9 @@ This sample illustrates the following concepts on top of the SharePoint Framewor > **NOTE:** This sample will not work in the local workbench. +## Video +[![Calling Dynamics 365 CRM APIs from SharePoint](./assets/video-thumbnail.jpg)](https://www.youtube.com/watch?v=VXzYc6cfjuI "Calling Dynamics 365 CRM APIs from SharePoint") ## 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.** diff --git a/samples/react-dynamics-crm-api/assets/video-thumbnail.jpg b/samples/react-dynamics-crm-api/assets/video-thumbnail.jpg new file mode 100644 index 000000000..366a2270f Binary files /dev/null and b/samples/react-dynamics-crm-api/assets/video-thumbnail.jpg differ diff --git a/samples/react-pnpjs-project-online/README.md b/samples/react-pnpjs-project-online/README.md index 786e4615d..d76102047 100644 --- a/samples/react-pnpjs-project-online/README.md +++ b/samples/react-pnpjs-project-online/README.md @@ -9,9 +9,16 @@ Custom PnPjs module: [pnpjs-project-online-package](https://www.npmjs.com/packag ![Demo](./assets/Preview.gif) -## Used SharePoint Framework Version -![drop](https://img.shields.io/badge/SPFx-1.8.2-green.svg) +## Compatibility + +![SPFx 1.8.2](https://img.shields.io/badge/SPFx-1.8.2-green.svg) +![Node.js v10 | v8](https://img.shields.io/badge/Node.js-v10%20%7C%20v8-green.svg) +![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) +![Does not work with SharePoint 2019](https://img.shields.io/badge/SharePoint%20Server%202019-Incompatible-red.svg "SharePoint Server 2019 requires SPFx 1.4.1 or lower") +![Does not work with SharePoint 2016 (Feature Pack 2)](https://img.shields.io/badge/SharePoint%20Server%202016%20(Feature%20Pack%202)-Incompatible-red.svg "SharePoint Server 2016 Feature Pack 2 requires SPFx 1.1") +![Local Workbench Incompatible](https://img.shields.io/badge/Local%20Workbench-Incompatible-red.svg "Needs access to user's context") +![Hosted Workbench Compatible](https://img.shields.io/badge/Hosted%20Workbench-Compatible-green.svg) ## Applies to @@ -29,7 +36,7 @@ Custom PnPjs module: [pnpjs-project-online-package](https://www.npmjs.com/packag | Solution | Author(s) | | -------------------------- | -------------- | -| react-pnpjs-project-online | Joel Rodrigues | +| react-pnpjs-project-online | [Joel Rodrigues](https://github.com/joelfmrodrigues) | ## Version history @@ -37,12 +44,6 @@ Custom PnPjs module: [pnpjs-project-online-package](https://www.npmjs.com/packag | ------- | ---------------- | --------------- | | 1.0 | December 4, 2019 | 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 @@ -56,4 +57,22 @@ This Web Part illustrates the following concepts on top of the SharePoint Framew -Using PnPjs with a custom package to interact with Project Online REST API + +## Help + +We do not support samples, but 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. + +If you're having issues building the solution, please run [spfx doctor](https://pnp.github.io/cli-microsoft365/cmd/spfx/spfx-doctor/) from within the solution folder to diagnose incompatibility issues with your environment. + +You can try looking at [issues related to this sample](https://github.com/pnp/sp-dev-fx-webparts/issues?q=label%3Areact-pnpjs-project-online) to see if anybody else is having the same issues. + +You can also try looking at [discussions related to this sample](https://github.com/pnp/sp-dev-fx-webparts/discussions?discussions_q=label%3Areact-pnpjs-project-online) and see what the community is saying. + +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-pnpjs-project-online&authors=@joelfmrodrigues&title=react-pnpjs-project-online%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-pnpjs-project-online&authors=@joelfmrodrigues&title=react-pnpjs-project-online%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-pnpjs-project-online&authors=@joelfmrodrigues&title=react-pnpjs-project-online%20-%20). + + diff --git a/samples/react-smart-profile-photo-editor/README.md b/samples/react-smart-profile-photo-editor/README.md index 53bd17251..e59747532 100644 --- a/samples/react-smart-profile-photo-editor/README.md +++ b/samples/react-smart-profile-photo-editor/README.md @@ -15,15 +15,13 @@ Uses [Azure Cognitive Services](https://azure.microsoft.com/en-us/services/cogni ![Does not work with SharePoint 2016 (Feature Pack 2)](https://img.shields.io/badge/SharePoint%20Server%202016%20(Feature%20Pack%202)-Incompatible-red.svg "SharePoint Server 2016 Feature Pack 2 requires SPFx 1.1") ![Teams Incompatible](https://img.shields.io/badge/Teams-Incompatible-lightgrey.svg) ![Local Workbench Incompatible](https://img.shields.io/badge/Local%20Workbench-Incompatible-red.svg "This solution requires access to the storage entity, which is only available on hosted pages") -![Hosted Workbench Compatible](https://img.shields.io/badge/Hosted%20Workbench-Compatible-green.svg) - +![Hosted Workbench (configuration required)](https://img.shields.io/badge/Hosted%20Workbench-Compatible%20(configuration%20required)-yellow.svg "You'll need a key and endpoint to Azure Cognitive Services in the entity storage") ## Applies to * [SharePoint Framework](https:/dev.office.com/sharepoint) * [Office 365 tenant](https://dev.office.com/sharepoint/docs/spfx/set-up-your-development-environment) - ## Prerequisites This sample requires an [**Azure Cognitive Services**](https://azure.microsoft.com/en-us/services/cognitive-services/) resource instance in order to analyze submitted photographs. @@ -73,12 +71,6 @@ Version|Date|Comments 1.0|October 15, 2019|Initial release 1.1|August 12, 2020| Upgraded to SPFx 1.11; Added placeholder, markdown control, and property pane controls for API key and endpoint -## 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 @@ -96,4 +88,31 @@ This web part demonstrates the following concepts: * Retrieving settings from the SharePoint Online tenant properties * Using Azure Cognitive Services +## Video + +[![Photo ID Web Part using Azure Cognitive Services](./assets/video-thumbnail.jpg)](https://www.youtube.com/watch?v=FQITfL_EfaU "Photo ID Web Part using Azure Cognitive Services") +--> + +## 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 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. + +If you're having issues building the solution, please run [spfx doctor](https://pnp.github.io/cli-microsoft365/cmd/spfx/spfx-doctor/) from within the solution folder to diagnose incompatibility issues with your environment. + +You can try looking at [issues related to this sample](https://github.com/pnp/sp-dev-fx-webparts/issues?q=label%3Areact-smart-profile-photo-editor) to see if anybody else is having the same issues. + +You can also try looking at [discussions related to this sample](https://github.com/pnp/sp-dev-fx-webparts/discussions?discussions_q=label%3Areact-smart-profile-photo-editor) and see what the community is saying. + +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-smart-profile-photo-editor&authors=@hugoabernier&title=react-smart-profile-photo-editor%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-smart-profile-photo-editor&authors=@hugoabernier&title=react-smart-profile-photo-editor%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-smart-profile-photo-editor&authors=@hugoabernier&title=react-smart-profile-photo-editor%20-%20). + + + diff --git a/samples/react-smart-profile-photo-editor/assets/video-thumbnail.jpg b/samples/react-smart-profile-photo-editor/assets/video-thumbnail.jpg new file mode 100644 index 000000000..db1ec081f Binary files /dev/null and b/samples/react-smart-profile-photo-editor/assets/video-thumbnail.jpg differ diff --git a/samples/react-visio/README.md b/samples/react-visio/README.md index bc23b3449..1783948fd 100644 --- a/samples/react-visio/README.md +++ b/samples/react-visio/README.md @@ -31,7 +31,7 @@ This sample shows how the [Visio JavaScript APIs](https://docs.microsoft.com/off | Solution | Author(s) | | ----------- | -------------- | -| react-visio | Joel Rodrigues | +| react-visio | [Joel Rodrigues](https://github.com/joelfmrodrigues) | ## Version history @@ -69,10 +69,14 @@ This Web Part illustrates the following concepts on top of the SharePoint Framew ## 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. +We do not support samples, but 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. If you're having issues building the solution, please run [spfx doctor](https://pnp.github.io/cli-microsoft365/cmd/spfx/spfx-doctor/) from within the solution folder to diagnose incompatibility issues with your environment. +You can try looking at [issues related to this sample](https://github.com/pnp/sp-dev-fx-webparts/issues?q=label%3Areact-visio) to see if anybody else is having the same issues. + +You can also try looking at [discussions related to this sample](https://github.com/pnp/sp-dev-fx-webparts/discussions?discussions_q=label%3Areact-visio) and see what the community is saying. + 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-visio&authors=@joelfmrodrigues&title=react-visio%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-visio&authors=@joelfmrodrigues&title=react-visio%20-%20).