sp-dev-fx-webparts/samples/react-image-editor
Hugo Bernier 8e6bd1404b Added web part to every sample 2024-04-18 01:51:29 -04:00
..
.devcontainer added remaining containers 2022-02-16 21:47:07 -05:00
assets Added web part to every sample 2024-04-18 01:51:29 -04:00
config
src
.editorconfig
.gitignore
.yo-rc.json
README.md Updated links to devprogram 2024-02-06 11:16:44 -05:00
gulpfile.js
package-lock.json
package.json
tsconfig.json
tslint.json

README.md

https://aka.ms/m365/devprogramhttps://aka.ms/m365/devprogramhttps://aka.ms/m365/devprogramhttps://aka.ms/m365/devprogram--- page_type: sample products:

  • office-sp languages:
  • javascript
  • typescript extensions: contentType: samples technologies:
    • SharePoint Framework platforms:
    • React createdDate: 3/17/2021 12:00:00 AM

React Image Editor

Summary

This solution contains an SPFx web part that shows an HTML Image Editor based on canvas and Office UI Fabric.

Key features of the Editor

  • Resize
  • Crop
  • Flip
  • Rotate
  • Scale
  • Filter (Grayscale / Sepia)
  • Redo / Undo
  • Histoy of Actions

The Placeholder and FilePicker are components from the sp-dev-fx-controls-react

react-image-editor in action

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.4.0 Node.js v6 SharePoint 2019 | Online Teams No: Not designed for Microsoft Teams Workbench Local | Hosted Compatible with Remote Containers

References to office-ui-fabric-react version 5.x because of SharePoint 2019 Support

Applies to

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

Prerequisites

SharePoint Online or SharePoint 2019

Contributors

Thanks to celum and cubido to allow to share this code.

Version history

Version Date Comments
1.0.0.0 Mar 17, 2021 Initial release

Minimal Path to Awesome

  • Clone this repository
  • Ensure that you are at the solution folder
  • in the command-line run:
    • npm install
    • edit config\serve.json set "initialPage": "https://{tenant}.sharepoint.com/_layouts/15/workbench.aspx"
    • gulp serve

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

Usage

  • PNP Placeholder control if not Configured
  • PNP WebPartTitle control (toggle Show/Hide in property pane)
  • PNP FilePicker control to pick Images (is mocked on local workbench)
  • Office UI Fabric

Video

Building an advanced SPFx Image Editor web part

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 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 while 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.

References

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.