Please add some more documentation

xclud / flutter_crop

Crop any widget/image in Android, iOS, Web and Desktop with fancy and customizable UI, in pure Dart code.

https://pub.dev/packages/crop

MIT License

259 stars 84 forks source link

Please add some more documentation #61

Closed escamoteur closed 3 years ago

escamoteur commented 3 years ago

Hi,

your Cropping widget looks awesome and exactly what I need. Unfortunately I'm absolutely not clear on how I really have to use it.

What is the helper good for?
How is the intended workflow with this widget?
Do I have to handle gestures myself and use the controller accordingly to zoom / pan?
If I want to cut a smaller area from my image, do I have to zoom in and pan so that the area that I want fills the whole Crop widget?

I really would be greateful for some pointers.

xclud commented 3 years ago

@escamoteur Thank you for the feedback. My intention is to provide a documentation with version 1.0.0. Meanwhile, is the example project helpful? Do you have any questions?

escamoteur commented 3 years ago

I tried to make sense of the example project but didn't fully understand it. See my questions above. If you could give a short explanation it would be great

xclud commented 3 years ago

helper is used to display something on screen, but not on the final cropped image. You can use this for grids, golden ratios, focus indicators and so on.
This is a very general question. Please be specific.
The gestures are handled automatically. The widget is interactive. To disable the gestures set interactive: false in Crop constructor.
The end user can use the gestures to zoom in [and out]. The latest version supports rotation with gestures as well.

escamoteur commented 3 years ago

Ah, I now know why I did not understand it. I only tried it yesterday on Desktop where zooming with the mouse wheel isn't supported yet, so I also could not really pan.

In now ttried the Web demo on my phone and it made sense. Will try to add a listener for the mouse wheel and try again.

xclud commented 3 years ago

This is a great feekback. Mouse gestures must be added to the package.

escamoteur commented 3 years ago

I managed it https://youtu.be/7WBgibXb_oQ

xclud commented 3 years ago

I am happy you did it on 20:45 xD And thank you for demoing this package. I appreciate if you refactor parts of your codes and contribute. You are a good teacher BTW.

escamoteur commented 3 years ago

Thanks, I'll try but I have so much to do with my own packages at the moment