Fixed readme file

This commit is contained in:
Hugo Bernier 2020-12-17 00:06:13 -05:00
parent 3812eb20a6
commit e3658663d7
2 changed files with 19 additions and 6 deletions

View File

@ -2,13 +2,22 @@
## Summary
This is an application that supports Feedback through a web part that can be used directly on a Modern Sharepoint Site page. This webpart can be added to any site page or article. This allows users to send categorized feedback via email to users in the "Feedback Owners" group.
This is an application that supports Feedback through a web part that can be used directly on a Modern SharePoint Site page. This web part can be added to any site page or article. This allows users to send categorized feedback via email to users in the "Feedback Owners" group.
![Feedback](./assets/feedbackwebpart.gif)
## Used SharePoint Framework Version
## Compatibility
![SPFx 1.11](https://img.shields.io/badge/SPFx-1.11-green.svg)
![Node.js LTS 10.x](https://img.shields.io/badge/Node.js-LTS%2010.x-green.svg)
![SharePoint Online](https://img.shields.io/badge/SharePoint-Online-red.svg)
![Teams N/A](https://img.shields.io/badge/Teams-N%2FA-lightgrey.svg)
![Workbench Not supported](https://img.shields.io/badge/Workbench-Not%20Supported-lightgrey.svg)
![1.11.0](https://img.shields.io/badge/version-1.11.0-green.svg)
## Applies to
@ -19,6 +28,7 @@ This is an application that supports Feedback through a web part that can be use
* Office 365 subscription with SharePoint Online
* SharePoint Framework [development environment](https://docs.microsoft.com/sharepoint/dev/spfx/set-up-your-development-environment) set up
* "Feedback Owners" SharePoint group (see below)
## Solution
@ -46,21 +56,24 @@ Version|Date|Comments
* in the command line run:
* `npm install`
* `gulp serve`
* Add "Feedback Owners" Sharepoint group. This is where you'll add all users who should receive this feedback.
* Add "Feedback Owners" SharePoint group. This is where you'll add all users who should receive this feedback.
* Run one of the following custom commands to clean, build, bundle and package the solution.
* If you want to be able to debug using your local code using gulp serve
`gulp package`
* Navigate to the output `feedback-webpart.sppkg` (found in the `/sharepoint/solution` folder)
* Upload it to an application catalog (either a tenant or site collection one)
* In your site collection go to **Site Contents** and click **New** > **App**
* Find and add the **Feedback Application** App
* Find and add the **Feedback Application** App
* wait for it to finish installing and activating features on the **Site Contents** page
* Go to a site page like home, edit the page and find and add the **Feedback** web part
* If you deployed a shippable (SharePoint Online) version you don't need to do anything else
* If you deployed a debug (http://localhost:4321) version you'll need to ensure gulp serve is running
## Features
This sample illustrates the following concepts:
- Used [@pnp/polyfill-ie11](https://pnp.github.io/pnpjs/concepts/polyfill/)
- Used [PnP](https://pnp.github.io/pnpjs/) for communication with SharePoint.
- Used [@pnp/logging](https://pnp.github.io/pnpjs/logging/)
<img src="https://telemetry.sharepointpnp.com/sp-dev-fx-webparts/samples/react-feedback" />

View File

@ -108,7 +108,7 @@ export const Container: React.FunctionComponent<IContainerProps> = props => {
newDefaultCategory = DropdownOptions.Options.find(o => o.key === props.selectedCategory);
}
if (props.listitemid == null){
console.log("List item ID is null. Please run this on a site page.")
console.log("List item ID is null. Please run this on a site page.");
}
feedbackService.sendEmailToOwnerGroup(txtValue, props.listitemid, (newDefaultCategory) ? newDefaultCategory.text : categoryValue, props.currentUser.displayName, props.currentUser.email);
dismissPanel();