Fixed typo for Loader file, Added step-by-step instructions how to set up poll, added image for webpart preview

2024-03-17 01:38:36 +05:30 · 2024-03-17 01:38:36 +05:30 · be833e2450
parent caf8c85b35
commit be833e2450
8 changed files with 22702 additions and 15309 deletions
--- a/samples/react-poll/README.md
+++ b/samples/react-poll/README.md
@ -1,93 +1,319 @@
+
  
+
 # React Poll

+  
+
+  
+
 ## Summary

-This web part allow User to add New Poll Questions and their options. End users can submit his/her response to the poll. After Submission, user can see all responses count with Bar chart.
  
+
+  
+
+This web part allow User to add New Poll Questions and their options. End users can submit his/her response to the poll. After Submission, user can see all responses count with Bar chart.
+
+  
+
 ![React-Poll](./assets/react-poll.gif)

-**Following are some of the features of this component.**  

- These 2  lists will be provisioned automatically with necessary columns.
+![Webpart - 1 ](./assets/wp1.png)
+
+![Webpart - 2 ](./assets/wp2.png)
+  
+
+  
+
+**Following are some of the features of this component.**
+
+  
+
+  
+
+- These 2 lists will be provisioned automatically with necessary columns.
+
+  
+
 - Poll Questions : User can add New poll question and their options. Also, user can set to keep it active or not.
-  ![Poll Questions](./assets/poll-questions.png)
+
+  
+
+![Poll Questions](./assets/poll-questions.png)
+
+  
+
+  

 - Poll Answers: This list will hold all Answers give by End users with his/her email id.
-    ![Poll Answers](./assets/poll-answers.png)
+
  
+
+![Poll Answers](./assets/poll-answers.png)
+
+  
+
 - Poll response can be viewed via Bar chart.
- Easy to configure.
+
  
+
+- Easy to configure.
+
+  
+
 ## Compatibility

-| :warning: Important          |
+  
+
+  
+
+| :warning: Important |
+
+  
+
 |:---------------------------|
+
+  
+
 | Every SPFx version is optimally compatible with specific versions of Node.js. In order to be able to build this sample, you need to ensure that the version of Node on your workstation matches one of the versions listed in this section. This sample will not work on a different version of Node.|
-|Refer to <https://aka.ms/spfx-matrix> for more information on SPFx compatibility.   |
+
+  
+
+|Refer to <https://aka.ms/spfx-matrix> for more information on SPFx compatibility. |
+
+  
+
+  

 This sample is optimally compatible with the following environment configuration:

+  
+
+  
+
 ![SPFx 1.17.1](https://img.shields.io/badge/SPFx-1.17.1-green.svg)
+
+  
+
 ![Node.js v16.13+](https://img.shields.io/badge/Node.js-v16.13+-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 Unsupported](https://img.shields.io/badge/Local%20Workbench-Unsupported-red.svg "Local workbench is no longer available as of SPFx 1.13 and above")
+
+  
+
+![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 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)
+
+  
+
 ![Compatible with Remote Containers](https://img.shields.io/badge/Remote%20Containers-Compatible-green.svg)

+  
+
+  

 ## Applies to

+  
+
+  
+
 - [SharePoint Framework](https://learn.microsoft.com/sharepoint/dev/spfx/sharepoint-framework-overview)
+
+  
+
 - [Microsoft 365 tenant](https://learn.microsoft.com/sharepoint/dev/spfx/set-up-your-development-environment)

+  
+
+  
+
 > Get your own free development tenant by subscribing to [Microsoft 365 developer program](https://aka.ms/m365/devprogram)

+  
+
+  

 ## Prerequisites

+  
+
+  
+
 - Office 365 subscription with SharePoint Online
- SharePoint Framework  [development environment](https://learn.microsoft.com/sharepoint/dev/spfx/set-up-your-development-environment)  set up
+
+  
+
+- SharePoint Framework [development environment](https://learn.microsoft.com/sharepoint/dev/spfx/set-up-your-development-environment) set up
+
+  
+
+  

 ## Contributors

+  
+
+  
+
 - [Harsh Bhavsar](https://github.com/Harsh24491)

+  
+
+  
+
 ## Version history

+  
+
+  
+
 | Version | Date | Comments |

+  
+
+  
+
 | ------- | ---------------- | --------------- |

-| 1.0 | March 02, 2024 | Initial release |
+  
+
+  
+
+| 1.0 | March 16, 2024 | Initial release |
+
+  
+
+  

 ## Minimal Path to Awesome

- Clone this repository (or  [download this solution as a .ZIP file](https://pnp.github.io/download-partial/?url=https://github.com/pnp/sp-dev-fx-webparts/tree/main/samples/react-poll)  then unzip it)
- From your command line, change your current directory to the directory containing this sample (`react-poll`, located under  `samples`)* in the command line run:
-  - `npm install`
-  - `gulp serve`
+  

-> This sample can also be opened with  [VS Code Remote Development](https://code.visualstudio.com/docs/remote/remote-overview). Visit  [https://aka.ms/spfx-devcontainer](https://aka.ms/spfx-devcontainer)  for further instructions.
+  
+
+- Clone this repository (or [download this solution as a .ZIP file](https://pnp.github.io/download-partial/?url=https://github.com/pnp/sp-dev-fx-webparts/tree/main/samples/react-poll) then unzip it)
+
+  
+
+- From your command line, change your current directory to the directory containing this sample (`react-poll`, located under `samples`)* in the command line run:
+
+  
+
+-  `npm install`
+
+  
+
+-  `gulp serve`
+
+  
+
+  
+
+> This sample can also be opened with [VS Code Remote Development](https://code.visualstudio.com/docs/remote/remote-overview). Visit [https://aka.ms/spfx-devcontainer](https://aka.ms/spfx-devcontainer) for further instructions.
+
+  
+
+## How to Set up Poll
+
+  
+
+  
+
+- This solution will provision 2 lists "Poll Questions" and "Poll Answers"
+
+- To set up new Poll navigate to "Poll Questions" from "Site Contents"
+
+- Add new item with these metadata.
+
+-- Question (Mandatory) - Question for the poll
+
+-- Option 1 (Mandatory) - 1st Option for the poll
+
+-- Option 2 (Mandatory) - 2nd Option for the poll
+
+-- Option 3 (Non mandatory) - 3rd Option for the poll
+
+-- Option 4 (Non mandatory) - 4th Option for the poll
+
+-- Is Question Active (Mandatory) - Checkbox to Keep Poll active or not
+
+-- Title (Mandatory) - Title of Poll
+
+![Set up Poll](./assets/add-poll.png)
+
+- P.S. : Only 1 poll with Active will be displayed.
+
+  
+  

 ## 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'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%3A%22sample%3A%20react-pages-hierarchy%22)  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=react-pages-hierarchy)  and see what the community is saying.
+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 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%2Csample%3A%20react-pages-hierarchy&template=bug-report.yml&sample=react-pages-hierarchy&authors=@bogeorge&title=react-pages-hierarchy%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%3Aquestion%2Csample%3A%20react-pages-hierarchy&template=question.yml&sample=react-pages-hierarchy&authors=@bogeorge&title=react-pages-hierarchy%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%3Aenhancement%2Csample%3A%20react-pages-hierarchy&template=question.yml&sample=react-pages-hierarchy&authors=@bogeorge&title=react-pages-hierarchy%20-%20).
+You can try looking at [issues related to this sample](https://github.com/pnp/sp-dev-fx-webparts/issues?q=label%3A%22sample%3A%20react-pages-hierarchy%22) 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=react-pages-hierarchy) 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%2Csample%3A%20react-pages-hierarchy&template=bug-report.yml&sample=react-pages-hierarchy&authors=@bogeorge&title=react-pages-hierarchy%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%3Aquestion%2Csample%3A%20react-pages-hierarchy&template=question.yml&sample=react-pages-hierarchy&authors=@bogeorge&title=react-pages-hierarchy%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%3Aenhancement%2Csample%3A%20react-pages-hierarchy&template=question.yml&sample=react-pages-hierarchy&authors=@bogeorge&title=react-pages-hierarchy%20-%20).
+
+  
+
+  

 ## [](https://github.com/pnp/sp-dev-fx-webparts/tree/main/samples/react-pages-hierarchy#disclaimer)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.**
+  
+
+  
+
+**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.**
--- a/samples/react-poll/assets/add-poll.png
+++ b/samples/react-poll/assets/add-poll.png
--- a/samples/react-poll/assets/wp1.png
+++ b/samples/react-poll/assets/wp1.png
--- a/samples/react-poll/assets/wp2.png
+++ b/samples/react-poll/assets/wp2.png
--- a/samples/react-poll/package-lock.json
+++ b/samples/react-poll/package-lock.json
--- a/samples/react-poll/package.json
+++ b/samples/react-poll/package.json
@ -26,20 +26,20 @@
    "tslib": "2.3.1"
  },
  "devDependencies": {
-    "@microsoft/rush-stack-compiler-4.5": "0.4.0",
-    "@rushstack/eslint-config": "2.5.1",
-    "@microsoft/eslint-plugin-spfx": "1.17.1",
    "@microsoft/eslint-config-spfx": "1.17.1",
+    "@microsoft/eslint-plugin-spfx": "1.17.1",
+    "@microsoft/rush-stack-compiler-4.5": "0.4.0",
    "@microsoft/sp-build-web": "1.17.1",
+    "@microsoft/sp-module-interfaces": "1.17.1",
+    "@rushstack/eslint-config": "2.5.1",
+    "@types/react": "17.0.45",
+    "@types/react-dom": "17.0.17",
    "@types/webpack-env": "~1.15.2",
    "ajv": "^6.12.5",
    "eslint": "8.7.0",
-    "gulp": "4.0.2",
-    "typescript": "4.5.5",
-    "@types/react": "17.0.45",
-    "@types/react-dom": "17.0.17",
    "eslint-plugin-react-hooks": "4.3.0",
-    "@microsoft/sp-module-interfaces": "1.17.1",
-    "spfx-fast-serve-helpers": "~1.17.0"
+    "gulp": "4.0.2",
+    "spfx-fast-serve-helpers": "~1.17.0",
+    "typescript": "4.5.5"
  }
 }
--- a/samples/react-poll/src/webparts/reactPoll/components/Loadder.tsx
+++ b/samples/react-poll/src/webparts/reactPoll/components/Loadder.tsx
--- a/samples/react-poll/src/webparts/reactPoll/components/ReactPoll.tsx
+++ b/samples/react-poll/src/webparts/reactPoll/components/ReactPoll.tsx
@ -13,7 +13,7 @@ import {
  ChartControl,
  ChartType,
 } from "@pnp/spfx-controls-react/lib/ChartControl";
-import { ShimmerLoadder } from "./Loadder";
+import { ShimmerLoadder } from "./Loader";

 const ReactPoll: React.FunctionComponent<IReactPollProps> = (props) => {
  const {
@ -145,7 +145,7 @@ const ReactPoll: React.FunctionComponent<IReactPollProps> = (props) => {
                      <PrimaryButton
                        text="Submit"
                        disabled={
-                          question.selectedOption === null || isSubmitting 
+                          question.selectedOption === undefined || isSubmitting
                        }
                        onClick={() => handleSubmitClick(question)}
                      />