https://github.com/chooyan-eng/draw_your_image

A Flutter package for drawing picture with fingers.
https://github.com/chooyan-eng/draw_your_image

android flutter ios package

Last synced: 4 days ago
JSON representation

A Flutter package for drawing picture with fingers.

• Host: GitHub
• URL: https://github.com/chooyan-eng/draw_your_image
• Owner: chooyan-eng
• License: apache-2.0
• Created: 2021-03-30T12:55:11.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2021-12-20T16:01:57.000Z (almost 3 years ago)
• Last Synced: 2024-08-01T12:24:29.074Z (3 months ago)
• Topics: android, flutter, ios, package
• Language: Dart
• Homepage: https://pub.dev/packages/draw_your_image
• Size: 1.46 MB
• Stars: 11
• Watchers: 2
• Forks: 6
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# draw_your_image

draw_your_image is a Flutter package for drawing picture with fingers.

# Demo

![Demo](https://github.com/chooyan-eng/draw_your_image/raw/main/assets/draw_sample.gif)

# Features

- Configuration of any __background color__

- Configuration of any __stroke colors__

- Configuration of __stroke width__

- __Undo / Redo__

- __Clear__ all strokes

- Erasor mode

- __Convert canvas to image data__ with PNG format

# Note

Though this package is available with a couple of features, it's still under development. Any feedbacks or bug reports, and off course Pull Requests, are welcome. Feel free to visit the GitHub repository below.

[https://github.com/chooyan-eng/draw_your_image](https://github.com/chooyan-eng/draw_your_image)

# Usage

## Basic

### Draw

The very first step for draw_your_image is to place `Draw` widget at anywhere you want in the widget tree.

```dart

final _controller = DrawController();

@override

Widget build(BuildContext context) {

  return Draw(

    controller: _controller,

    backgroundColor: Colors.blue.shade50,

    strokeColor: Colors.red,

    strokeWidth: 8,

    isErasing: false,

    onConvertImage: (imageData) {

      // do something with imageData

    }

  );

}

```

`Draw` widget would display a simple canvas which users can draw whatever they want with given `strokeColor` and `strokeWidth`.

`isErasing` is a flag for erasing drawn strokes. If `true`, new strokes will erase drawn strokes.

If you wish to change colors or width, you can simply call `setState()` in your `StatefulWidgets` and change properties to pass to `Draw`. Off course other state management systems are available.

For `undo()`, `redo()` or other actions, pass instance of `DrawController` and pass it to `controller` property. See `DrawController` section below for detail.

### DrawController

`DrawController` provides interfaces to control canvas. Below are provided methods

- `undo()` will undo the last stroke. It returns `false` if no stroke can be performed.

- `redo()` will redo the last performed undo stroke. It returns `false` if no stroke can be performed.

- `clear()` will clear all the strokes. This action can be undo with `undo()`.

- `convertToImage()` will convert current canvas to image data with png format. You can obtain converted data via `onConvertImage` callback of `Draw`.