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`