Skip to content

Latest commit

 

History

History
100 lines (71 loc) · 2.56 KB

README.md

File metadata and controls

100 lines (71 loc) · 2.56 KB
Raw

romaine

React OpenCV Manipulation and Image Narration & Editing

Example

git clone https://github.com/DanielBailey-web/romaine;
cd romaine;
yarn install;
yarn dev;

Under Construction

This package is very much a work in progress with new minor versions (with potentially breaking changes with every update).

Versioning

Currently minor changes will be breaking until a stable 1.0.0 release. Semantic versioning will be used post stable release.

Quick Features

  • Image Cropping
  • Perspective Cropping
  • Image Rotation
  • Image Quality
  • SSR Support with Next

Romaine Input Props

Parameter Type Description Default Context Alternative
angle number Turn angle for rotation tool 90 setAngle(90)

Note:

Changing props triggers the Context Alternative, which can cause an un-needed render of some components. To avoid this you can use the context alternative yourself.

Monorepo

Romaine is now a monorepo! This makes setting up the development environment much easier! Just clone the master branch to get started!

Contributing

Contributors are welcome, just create a pull request.

todo

Meta

  1. Create a minified production build
  2. Create a code sandbox demo
  3. Basic use case (completed, see romaine-components)
  4. History
    1. Reinitialize (completed)
    2. Undo (completed)
    3. Redo
  5. Layers
  6. Tests
    1. Add Jest
    2. Add tests starting with util
  7. Switch state management from context to redux

OpenCV Implementations

  1. Cropping
    1. Perspective (completed)
    2. Regular
      1. Crop the image (completed)
      2. Lock aspect ratio
      3. Basic border recognition (completed)
  2. Filters
    1. Grey scale
    2. Brightness
    3. Hue
    4. Retro
    5. Pop-art
  3. Rotation
    1. Allow for image roration (currently working with 90 degree increments)
    2. Change angle of rotation
      1. Update Function from useRomaine (completed)
      2. Prop for Romaine (completed) <Romaine angle={90}>
  4. Zooming
    1. Zoom in and out of the image (creating transparent padding around the image)

Usability

  1. Make cropper be able to be moved via drag

Upcoming Breaking Changes

  1. Planning on changing locations of context functions for cleaner destructuring (0.8.0)

Special Thanks

@Giacomocerquone publisher of react-perspective-cropper (MIT)

@opencv creaters of computer vision software this package relies on (3-clause BSD)