sp-dev-fx-webparts/samples/react-news-extension
Hugo Bernier 1bc45d2ad7 Added container, sample.json, nvmrc 2023-10-17 11:23:45 -04:00
..
.devcontainer Added container, sample.json, nvmrc 2023-10-17 11:23:45 -04:00
assets Added container, sample.json, nvmrc 2023-10-17 11:23:45 -04:00
config react-news-extension sample added 2023-10-04 21:22:21 +01:00
fast-serve react-news-extension sample added 2023-10-04 21:22:21 +01:00
src Added container, sample.json, nvmrc 2023-10-17 11:23:45 -04:00
teams react-news-extension sample added 2023-10-04 21:22:21 +01:00
.eslintrc.js react-news-extension sample added 2023-10-04 21:22:21 +01:00
.gitignore react-news-extension sample added 2023-10-04 21:22:21 +01:00
.npmignore react-news-extension sample added 2023-10-04 21:22:21 +01:00
.nvmrc Added container, sample.json, nvmrc 2023-10-17 11:23:45 -04:00
.yo-rc.json react-news-extension sample added 2023-10-04 21:22:21 +01:00
README.md Added container, sample.json, nvmrc 2023-10-17 11:23:45 -04:00
gulpfile.js Added container, sample.json, nvmrc 2023-10-17 11:23:45 -04:00
package-lock.json react-news-extension sample added 2023-10-04 21:22:21 +01:00
package.json react-news-extension sample added 2023-10-04 21:22:21 +01:00
tsconfig.json react-news-extension sample added 2023-10-04 21:22:21 +01:00

README.md

Targeted News using Microsoft Graph Open Extension

Summary

This sample contains two SPFx web parts:

User preferences web part

This web part allows users to save their preferences in the Microsoft Graph Open Extension. This means that users can access their preferences from any device or application that uses the Microsoft Graph.

Curated news web part

This web part allows users to view news topics they care about based on the selected preferences. This is a great way to help users stay informed about the topics that are most important to them.

Targeted news web part User preferences web part Targeted news using Microsoft Graph Open Extension

Compatibility

⚠️ 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.

SPFx 1.17.4 Node.js v16.18.1 Compatible with SharePoint Online Does not work with SharePoint 2019 Does not work with SharePoint 2016 (Feature Pack 2) Teams Incompatible Local Workbench Incompatible Hosted Workbench Compatible Compatible with Remote Containers

Applies to

Get your own free development tenant by subscribing to Microsoft 365 developer program

Prerequisites

Access to a SharePoint online site with various tenant users granted access to various site resources directly, via AAD groups and via SharePoint groups.

User Preferences web part configurations

  1. Provide name for Microsoft Graph Open Extension

  2. Provide Term Set ID for terms you would like to use for user preferences

User preferences web part

Targeted news web part configurations

  1. Provide name for Microsoft Graph Open Extension.

  2. Provide Search managed property which you want to use to filter results. For example department or topic, etc.

User preferences web part

Contributors

Version history

Version Date Comments
1.0.0 October 04, 2023 Initial release

Minimal Path to Awesome

  1. Clone this repository
  2. From your command line, change your current directory to the directory containing this sample (react-news-extension, located under samples)
  3. In the command line run:
  `npm install`
  `gulp bundle`
  `gulp package-solution`
  1. Deploy the package to your app catalog
  2. Approve the following API permission request from the SharePoint admin
      {
        "resource": "Microsoft Graph",
        "scope": "User.ReadWrite"
      }
  1. In the command-line run:
  gulp serve --nobrowser
  1. Open the hosted workbench on a SharePoint site - i.e. https://tenant.sharepoint.com/site/sitename/_layouts/workbench.aspx
  2. Configure user preferences and targeted news web parts as per above configurations

Features

  • User preferences web part allows users to save their preferences in the Microsoft Graph Open Extension. This means that users can access their preferences from any device or application that uses the Microsoft Graph.

  • This web part allows users to view news topics they care about based on the selected preferences. This is a great way to help users stay informed about the topics that are most important to them.

Help

We do not support samples, but 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 from within the solution folder to diagnose incompatibility issues with your environment.

You can try looking at issues related to this sample to see if anybody else is having the same issues.

You can also try looking at discussions related to this sample and see what the community is saying.

If you encounter any issues using this sample, create a new issue.

For questions regarding this sample, create a new question.

Finally, if you have an idea for improvement, make a suggestion.

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.