From f8bafc24d57f0727ff4b3e646d3371d06be610d5 Mon Sep 17 00:00:00 2001 From: Hugo Bernier Date: Sat, 30 Oct 2021 23:42:41 -0400 Subject: [PATCH] Added compatibility tags --- samples/react-pnpjsexplorer/README.md | 46 +++++++++++++++++++-------- 1 file changed, 33 insertions(+), 13 deletions(-) diff --git a/samples/react-pnpjsexplorer/README.md b/samples/react-pnpjsexplorer/README.md index df4a7776b..bce1573b1 100644 --- a/samples/react-pnpjsexplorer/README.md +++ b/samples/react-pnpjsexplorer/README.md @@ -1,8 +1,8 @@ -# SPFx web part to Test PnpJS SharePoint Methods +# Test PnPjs SharePoint Methods -This web part will allow SPFx developers to test [PnPjs](https://pnp.github.io/pnpjs/getting-started/) methods and it displays response in JSON viewer to identify properties/attributes returned by method/API. This web part can be used as separate component to test PnP Js methods and know the response returned by a particular method/API. To maximize productivity, we should package and deploy it to a test(developer) site collection which then can be used side by side when we are doing development of SPFx solutions. +This web part will allow SPFx developers to test [PnPjs](https://pnp.github.io/pnpjs/getting-started/) methods and it displays response in JSON viewer to identify properties/attributes returned by method/API. This web part can be used as separate component to test PnPjs methods and know the response returned by a particular method/API. To maximize productivity, we should package and deploy it to a test(developer) site collection which then can be used side by side when we are doing development of SPFx solutions. -Note - As of now it only supports to test Pnp JS method from sp(SharePoint) packages which contains the fluent API used to call the SharePoint rest services. +Note - As of now it only supports to test PnPjs method from sp(SharePoint) packages which contains the fluent API used to call the SharePoint rest services. You can refer to this blog [link](https://siddharthvaghasia.com/2020/08/16/usage-guide-on-spfx-pnpjs-tester-web-part/) for usage guidance on How to use this web part. @@ -10,25 +10,32 @@ You can refer to this blog [link](https://siddharthvaghasia.com/2020/08/16/usage Idea behind this web part -- Most of the SharePoint developers are using PnP JS to develop SPFx solutions. +- Most of the SharePoint developers are using PnPjs to develop SPFx solutions. - During the development, there are times when we wanted to know what properties/attributes will be returned in response - To get these details, we either use console.log to log response or debug the JavaScript and check what properties/attributes are returned etc. -- This web part can be used so that we can quickly test any SharePoint REST API methods using PnP JS. +- This web part can be used so that we can quickly test any SharePoint REST API methods using PnPjs. Feel free to connect on twitter:@siddh_me or twitter:@sanganikunj for any details. ## Notes on Web part -- Web Part to test PnP JS SharePoint package methods +- Web Part to test PnPjs SharePoint package methods - Response will be displayed in a code format. - By default, it will run in context of current site collection. -- Optional option to enter different site collection or sub site url to set PnP JS context to different url(other than current context) +- Optional option to enter different site collection or sub site url to set PnPjs context to different url(other than current context) - Support for Get and Post methods. - Option to see some examples which can be copied and tested just by changing list/libraries/column names. -## Used SharePoint Framework Version +## Compatibility -![SPFx 1.11.0](https://img.shields.io/badge/version-1.11.0-green.svg) +![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) +![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") +![Teams Incompatible](https://img.shields.io/badge/Teams-Incompatible-lightgrey.svg) +![Local Workbench Incompatible](https://img.shields.io/badge/Local%20Workbench-Incompatible-red.svg "The solution requires access to SharePoint resources") +![Hosted Workbench Compatible](https://img.shields.io/badge/Hosted%20Workbench-Compatible-green.svg) ## Applies to @@ -65,8 +72,8 @@ gulp package-solution --ship | Solution | Author(s) | | ----------------- | ---------------------------------------------------------------------------------------------------------------------------------- | -| react-PnPjsTester | [Siddharth Vaghasia](https://www.linkedin.com/in/siddharthvaghasia/) and [Kunj Sangani](https://www.linkedin.com/in/kunj-sangani/) | -| react-PnPjsTester | Abderahman Moujahid| +| react-pnpjsTester | [Siddharth Vaghasia](https://www.linkedin.com/in/siddharthvaghasia/) and [Kunj Sangani](https://www.linkedin.com/in/kunj-sangani/) | +| react-pnpjsTester | [Abderahman Moujahid](https://github.com/Abderahman88)| ## Version history @@ -80,8 +87,21 @@ gulp package-solution --ship **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.** + +## 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. + +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-pnpjsexplorer&authors=@Abderahman88%20@siddharth-vaghasia%20@kunj-sangani&title=react-pnpjsexplorer%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-pnpjsexplorer&authors=@Abderahman88%20@siddharth-vaghasia%20@kunj-sangani&title=react-pnpjsexplorer%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-pnpjsexplorer&authors=@Abderahman88%20@siddharth-vaghasia%20@kunj-sangani&title=react-pnpjsexplorer%20-%20). + For any issue or help, Buzz us on twitter:([siddh_me](https://twitter.com/siddh_me/)) or ([sanganikunj](https://twitter.com/sanganikunj)) -> Sharing is caring! -