98 lines
6.1 KiB
Markdown
98 lines
6.1 KiB
Markdown
# Feedback
|
|
|
|
## Summary
|
|
|
|
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.
|
|
|
|
|
|
|
|
## Compatibility
|
|
|
|
| :warning: Important |
|
|
|:---------------------------|
|
|
| Every SPFx version is only compatible with specific version(s) of Node.js. In order to be able to build this sample, please 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. |
|
|
|
|
|
|
|
|
|
|
|
|
-Incompatible-red.svg "SharePoint Server 2016 Feature Pack 2 requires SPFx 1.1")
|
|
|
|
|
|
|
|
|
|
|
|
## 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)
|
|
|
|
## 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
|
|
* **Feedback Owners** SharePoint group (see below)
|
|
|
|
## Contributors
|
|
|
|
* [Perry Kankam](https://github.com/perr124)
|
|
* [Abderahman Moujahid](https://github.com/Abderahman88)
|
|
|
|
## Version history
|
|
|
|
Version|Date|Comments
|
|
-------|----|--------
|
|
1.0.0|December 15, 2020|Initial release
|
|
1.0.1|March 3, 2021|Fix undefined listItem
|
|
|
|
## Minimal Path to Awesome
|
|
|
|
*To really get the full experience go to the workbench on a SharePoint Site [Your site url]/_layouts/15/workbench.aspx and that's where the magic will happen but this requires that you deploy and activate features to provision the required SharePoint assets*
|
|
|
|
> 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 for further instructions.
|
|
|
|
* Clone this repository
|
|
* 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.
|
|
* 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
|
|
* 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/)
|
|
|
|
|
|
## 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.
|
|
|
|
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-feedback&template=bug-report.yml&sample=react-feedback&authors=@perr124%20@Abderahman88&title=react-feedback%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-feedback&template=question.yml&sample=react-feedback&authors=@perr124%20@Abderahman88&title=react-feedback%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-feedback&template=question.yml&sample=react-feedback&authors=@perr124%20@Abderahman88&title=react-feedback%20-%20).
|
|
|
|
## 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.**
|
|
|
|
|
|
<img src="https://m365-visitor-stats.azurewebsites.net/sp-dev-fx-webparts/samples/react-feedback" />
|