Updated sample.json, readme, and manifest

This commit is contained in:
Hugo Bernier 2021-10-31 02:33:47 -04:00
parent eb67d0e68d
commit 50f9873eb0
3 changed files with 77 additions and 11 deletions

View File

@ -1,4 +1,4 @@
# react-star-ratings # Star Ratings
## Summary ## Summary
@ -10,9 +10,12 @@ This web part demonstrates *Star Ratings* capablities to SharePoint News. The "R
![SPFx 1.12.1](https://img.shields.io/badge/SPFx-1.12.1-green.svg) ![SPFx 1.12.1](https://img.shields.io/badge/SPFx-1.12.1-green.svg)
![Node.js LTS v14 | LTS v12 | LTS v10](https://img.shields.io/badge/Node.js-LTS%20v14%20%7C%20LTS%20v12%20%7C%20LTS%20v10-green.svg) ![Node.js LTS v14 | LTS v12 | LTS v10](https://img.shields.io/badge/Node.js-LTS%20v14%20%7C%20LTS%20v12%20%7C%20LTS%20v10-green.svg)
![SharePoint Online](https://img.shields.io/badge/SharePoint-Online-yellow.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg)
![Teams N/A: Untested with Microsoft Teams](https://img.shields.io/badge/Teams-N%2FA-lightgrey.svg "Untested with Microsoft Teams") ![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")
![Workbench Hosted](https://img.shields.io/badge/Workbench-Hosted-green.svg) ![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 Incompatible](https://img.shields.io/badge/Local%20Workbench-Incompatible-red.svg "This solution requires the ratings feature from SharePoint Online")
![Hosted Workbench Compatible](https://img.shields.io/badge/Hosted%20Workbench-Compatible-green.svg)
## Prerequisites ## Prerequisites
@ -24,18 +27,18 @@ Enable-PnPFeature -Identity 915c240e-a6cc-49b8-8b2c-0bff8b553ed3
2. Update "Rating settings". 2. Update "Rating settings".
- Click **\[⚙\]** - **\[Site contents\]**. - Select **⚙** - **Site contents**.
- Click **\[Site Pages\]** - **\[︙\]** - **\[Settings\]**. - Select **Site Pages** - **︙** - **Settings**.
- Click **\[Rating settings\]**. - Select **Rating settings**.
- Update values. - Update values.
- Rating Settings: **Yes** - **Rating Settings**: Select **Yes**
- Which voting/rating experience you would like to enable for this list?: **Star Ratings** - **Which voting/rating experience you would like to enable for this list?**: Select **Star Ratings**
## Solution ## Solution
Solution|Author(s) Solution|Author(s)
--------|--------- --------|---------
react-star-ratings | Takashi Shinohara (@karamem0) react-star-ratings | [Takashi Shinohara](https://github.com/karamem0) ([@karamem0](https://twitter.com/karamem0))
## Version history ## Version history
@ -43,6 +46,19 @@ Version|Date|Comments
-------|----|-------- -------|----|--------
1.0|October 7, 2021|Initial release 1.0|October 7, 2021|Initial release
## 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.**
## 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 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&template=bug-report.yml&sample=react-star-ratings&authors=@karamem0&title=react-star-ratings%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%3Abug-suspected&template=question.yml&sample=react-star-ratings&authors=@karamem0&title=react-star-ratings%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%3Abug-suspected&template=suggestion.yml&sample=react-star-ratings&authors=@karamem0&title=react-star-ratings%20-%20).
<img src="https://telemetry.sharepointpnp.com/sp-dev-fx-webparts/samples/react-star-ratings" />

View File

@ -0,0 +1,50 @@
[
{
"name": "pnp-sp-dev-spfx-web-parts-react-star-ratings",
"source": "pnp",
"title": "Star Ratings",
"shortDescription": "Demonstrates Star Ratings capablities to SharePoint News.",
"url": "https://github.com/pnp/sp-dev-fx-webparts/tree/main/samples/react-star-ratings",
"longDescription": [
"This web part demonstrates Star Ratings capablities to SharePoint News. The Ratings site collection feature provides Likes and Star Ratings, but SharePoint News provides only provides Likes. This web part can get or set ratings of the current page."
],
"creationDateTime": "2021-10-07",
"updateDateTime": "2021-10-07",
"products": [
"SharePoint",
"Office"
],
"metadata": [
{
"key": "CLIENT-SIDE-DEV",
"value": "React"
},
{
"key": "SPFX-VERSION",
"value": "1.12.1"
}
],
"thumbnails": [
{
"type": "image",
"order": 100,
"url": "https://github.com/pnp/sp-dev-fx-webparts/raw/main/samples/react-star-ratings/assets/react-star-ratings.png",
"alt": "Web part in action"
}
],
"authors": [
{
"gitHubAccount": "karamem0",
"pictureUrl": "https://github.com/karamem0.png",
"name": "Takashi Shinohara"
}
],
"references": [
{
"name": "Build your first SharePoint client-side web part",
"description": "Client-side web parts are client-side components that run in the context of a SharePoint page. Client-side web parts can be deployed to SharePoint environments that support the SharePoint Framework. You can also use modern JavaScript web frameworks, tools, and libraries to build them.",
"url": "https://docs.microsoft.com/en-us/sharepoint/dev/spfx/web-parts/get-started/build-a-hello-world-web-part"
}
]
}
]

View File

@ -23,7 +23,7 @@
"default": "Ratings" "default": "Ratings"
}, },
"description": { "description": {
"default": "Youn can rate site pages." "default": "You can rate site pages."
}, },
"officeFabricIconFontName": "FavoriteStar", "officeFabricIconFontName": "FavoriteStar",
"properties": { "properties": {