From 159648f48bfc4ed219dadfa2ec615f3af7dd58a4 Mon Sep 17 00:00:00 2001 From: Harsha Vardhini Date: Fri, 12 Jun 2020 17:58:38 +0530 Subject: [PATCH 1/3] Update README.md --- samples/react-webpartdetails/README.md | 27 ++++++++++++++++++++++++-- 1 file changed, 25 insertions(+), 2 deletions(-) diff --git a/samples/react-webpartdetails/README.md b/samples/react-webpartdetails/README.md index 1b700e019..daa4b5f9b 100644 --- a/samples/react-webpartdetails/README.md +++ b/samples/react-webpartdetails/README.md @@ -1,6 +1,29 @@ -## getallwebpart +### React Webpart Details +## Summary +The web part illustrates how to get all the webpart present in a page,bind them in a multiselect dropdown. +On selecting the webpart title from the dropdown, it will be hidden. You can use this sample to as per the requirement. -This is where you include your WebPart documentation. +![React webpart Details](./assets/webpartDetails.png) + +## Used SharePoint Framework Version +SPFx 1.10.0 + +## Applies to + +* [SharePoint Framework](https://docs.microsoft.com/en-us/sharepoint/dev/spfx/sharepoint-framework-overview) + +## Solution + +Solution|Author(s) +--------|--------- +React-webpartdetails| Harsha Vardhini ([@harshagracy](https://twitter.com/harshagracy) / [Harsha's Blog](https://harshagracy.com/)) + + +## Version history + +Version|Date|Comments +-------|----|-------- +1.0|June 12, 2020|Initial release ### Building the code From 04926c4704d5e13e754483902e44b602e0ff7f8e Mon Sep 17 00:00:00 2001 From: Harsha Vardhini Date: Fri, 12 Jun 2020 18:04:27 +0530 Subject: [PATCH 2/3] Update README.md --- samples/react-webpartdetails/README.md | 30 ++++++-------------------- 1 file changed, 7 insertions(+), 23 deletions(-) diff --git a/samples/react-webpartdetails/README.md b/samples/react-webpartdetails/README.md index daa4b5f9b..4fe5239f7 100644 --- a/samples/react-webpartdetails/README.md +++ b/samples/react-webpartdetails/README.md @@ -1,10 +1,10 @@ ### React Webpart Details ## Summary -The web part illustrates how to get all the webpart present in a page,bind them in a multiselect dropdown. +The web part illustrates how to get all the webpart present in the current page,bind them in a multiselect dropdown. On selecting the webpart title from the dropdown, it will be hidden. You can use this sample to as per the requirement. ![React webpart Details](./assets/webpartDetails.png) - +Note: This sample will not work in workbench as it loads the webpart from current page and will not work for workbench.aspx. To test locally, build the development package (using `gulp bundle` and `gulp package-solution`) and test it using `gulp serve`. ## Used SharePoint Framework Version SPFx 1.10.0 @@ -25,25 +25,9 @@ Version|Date|Comments -------|----|-------- 1.0|June 12, 2020|Initial release -### Building the code +## Minimal Path to Awesome -```bash -git clone the repo -npm i -npm i -g gulp -gulp -``` - -This package produces the following: - -* lib/* - intermediate-stage commonjs build artifacts -* dist/* - the bundled script, along with other resources -* deploy/* - all resources which should be uploaded to a CDN. - -### Build options - -gulp clean - TODO -gulp test - TODO -gulp serve - TODO -gulp bundle - TODO -gulp package-solution - TODO +- Clone this repository +- in the command line run: + - `npm install` + - `gulp serve` From 142edd397195084af75b878247a1cba73387b151 Mon Sep 17 00:00:00 2001 From: Hugo Bernier Date: Fri, 12 Jun 2020 21:57:26 -0400 Subject: [PATCH 3/3] Fixed README --- samples/react-webpartdetails/README.md | 20 +++++++++++++++----- 1 file changed, 15 insertions(+), 5 deletions(-) diff --git a/samples/react-webpartdetails/README.md b/samples/react-webpartdetails/README.md index 4fe5239f7..dda3bfe6e 100644 --- a/samples/react-webpartdetails/README.md +++ b/samples/react-webpartdetails/README.md @@ -1,11 +1,18 @@ ### React Webpart Details -## Summary -The web part illustrates how to get all the webpart present in the current page,bind them in a multiselect dropdown. -On selecting the webpart title from the dropdown, it will be hidden. You can use this sample to as per the requirement. -![React webpart Details](./assets/webpartDetails.png) -Note: This sample will not work in workbench as it loads the webpart from current page and will not work for workbench.aspx. To test locally, build the development package (using `gulp bundle` and `gulp package-solution`) and test it using `gulp serve`. +## Summary + +The web part illustrates how to get all the web part present in the current page, bind them in a multi-select dropdown. + +On selecting the web part title from the dropdown, it will be hidden. You can use this sample to as per the requirement. + +![React web part Details](./assets/webpartDetails.png) +Note: This sample will not work in workbench as it loads the web part from current page and will not work for workbench.aspx. To test locally, build the development package (using `gulp bundle` and `gulp package-solution`) and test it using `gulp serve`. + ## Used SharePoint Framework Version + +![1.10.0](https://img.shields.io/badge/version-1.10.0-green.svg) + SPFx 1.10.0 ## Applies to @@ -31,3 +38,6 @@ Version|Date|Comments - in the command line run: - `npm install` - `gulp serve` + + +