sp-dev-fx-webparts/samples/react-avatar/README.md

3.6 KiB

Avatar Editor

Summary

This is a sample web part that helps user create their avatar and save as profile picture. User can even download their avatar as PNG file. This web part can be useful in Intranet to help user create their avatar and save it as profile picture.

directory

Features

  • Avatar Generator from multiple options available
  • Set Avatar as Profile Picture.
  • Download Avatar as PNG file.

Compatibility

SPFx 1.11.1 Node.js v10 Compatible with SharePoint Online Does not work with SharePoint 2019 Does not work with SharePoint 2016 (Feature Pack 2) Local Workbench Compatible Hosted Workbench Compatible Compatible with Remote Containers

Applies to

Prerequisites

  • SharePoint Online tenant
  • You have to provide permission in SharePoint admin for accessing Graph API on behalf of your solution. We can do it before deployment as proactive steps, or after deployment. You can refer to steps about how to do this post-deployment. You have to use API Access Page of SharePoint admin and add below permission for our use case.
 "webApiPermissionRequests": [
      {
        "resource": "Microsoft Graph",
        "scope": "User.ReadWrite"
      }
    ]

Concepts

This Web Part illustrates the following concepts on top of the SharePoint Framework:

  • Using react framework in SPFx web part
  • Calling Graph API my Photo to store the image in SPFx web part
  • Usage of Material UI Tab and Dialog
  • Usage of avataaars

Web Part Properties

Property Type Required comments
Web Part Title Text no

Solution

The web part Use avataaars library for creating avatars and MS Graph with User.ReadWrite and User.ReadWriteAll for saving avatar as current users Profile Picture.FileSaver for downloading avatar image as png file.

Solution Author(s)
react Avatar Kunj Sangani

Version history

Version Date Comments
1.0.0 August 1, 2020 Initial release
1.0.1 October 20, 2020 Update to SPFx 1.11.0

Minimal Path to Awesome

  • Clone this repository
  • in the command line run:
    • npm install
    • gulp build
    • gulp bundle --ship
    • gulp package-solution --ship
    • Add to AppCatalog and deploy

This sample can also be opened with VS Code Remote Development. Visit https://aka.ms/spfx-devcontainer for further instructions.

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.