diff --git a/samples/react-group-membership-manager/README.md b/samples/react-group-membership-manager/README.md index f6afa6689..85b9f34ac 100644 --- a/samples/react-group-membership-manager/README.md +++ b/samples/react-group-membership-manager/README.md @@ -1,14 +1,21 @@ -# group-membership-manager +# Group Membership Manager ## Summary -Short summary on functionality and used technologies. +This app is an example of managing the membership of a group you own including the owners of the group as well as using FluentUI v9 -[picture of the solution in action, if possible] +![Screenshot](assets/screenshot.png "Screenshot") -## Used SharePoint Framework Version +## Compatibility -![version](https://img.shields.io/badge/version-1.13-green.svg) +![SPFx 1.15](https://img.shields.io/badge/SPFx-1.15-green.svg) +![Node.js v16](https://img.shields.io/badge/Node.js-v16-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") +![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 @@ -17,22 +24,17 @@ Short summary on functionality and used technologies. > Get your own free development tenant by subscribing to [Microsoft 365 developer program](http://aka.ms/o365devprogram) -## Prerequisites - -> Any special pre-requisites? - ## Solution | Solution | Author(s) | | ----------- | ------------------------------------------------------- | -| folder name | Author details (name, company, twitter alias with link) | +| react-group-membership-manager | Nick Brown ([Jisc](https://www.jisc.ac.uk), [@techienickb](https://twitter.com/techienickb)) | ## Version history | Version | Date | Comments | | ------- | ---------------- | --------------- | -| 1.1 | March 10, 2021 | Update comment | -| 1.0 | January 29, 2021 | Initial release | +| 1.0 | August 25, 2022 | Initial release | ## Disclaimer @@ -52,17 +54,14 @@ Short summary on functionality and used technologies. ## Features -Description of the extension that expands upon high-level summary above. +This app uses the Microsoft Graph to get a list of owned groups for the current user. You can then manage the membership of that group from SharePoint/Teams. This extension illustrates the following concepts: -- topic 1 -- topic 2 -- topic 3 +- Using Fluent UI v9 +- Calling the Graph natively from SPFx +- Adding/Removing Members/Owners from AAD groups -> Notice that better pictures and documentation will increase the sample usage and the value you are providing for others. Thanks for your submissions advance. - -> Share your web part with others through Microsoft 365 Patterns and Practices program to get visibility and exposure. More details on the community, open-source projects and other activities from http://aka.ms/m365pnp. ## References @@ -71,3 +70,26 @@ This extension illustrates the following concepts: - [Use Microsoft Graph in your solution](https://docs.microsoft.com/en-us/sharepoint/dev/spfx/web-parts/get-started/using-microsoft-graph-apis) - [Publish SharePoint Framework applications to the Marketplace](https://docs.microsoft.com/en-us/sharepoint/dev/spfx/publish-to-marketplace-overview) - [Microsoft 365 Patterns and Practices](https://aka.ms/m365pnp) - Guidance, tooling, samples and open-source controls for your Microsoft 365 development +- [Fluent UI version 9](https://react.fluentui.dev) - Converged Fluent UI components + +## 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](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-group-membership-manager%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-group-membership-manager) and see what the community is saying. + +If you encounter any issues 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-group-membership-manager&template=bug-report.yml&sample=react-fluentui-9&authors=@techienickb&title=react-fluentui-9%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-group-membership-manager&template=question.yml&sample=react-fluentui-9&authors=@techienickb&title=react-fluentui-9%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-group-membership-manager&template=suggestion.yml&sample=react-fluentui-9&authors=@techienickb&title=react-fluentui-9%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.** + + diff --git a/samples/react-group-membership-manager/assets/screenshot.png b/samples/react-group-membership-manager/assets/screenshot.png new file mode 100644 index 000000000..633768bf9 Binary files /dev/null and b/samples/react-group-membership-manager/assets/screenshot.png differ