image-sketchpad

Image Sketchpad (responsive)

Draw on any image inside your desktop or mobile browser.

• Get image with drawing as base64 string or download it directly (original or browser sized)
• Get sketches as JSON data
  • Load the sketches by the JSON
  • Load by method or data-sketchpad-json attribute
• Set options like line width or color
• Responsive: draw on the image and resize the browser. If the image resizes your sketch will do too. Also JSON data considered the image ratio so you can draw on a tiny image version (css resized!) and load the JSON data on a bigger version of the image.

---

1. Demo
2. Install
3. Usage
   1. Browser: VanillaJS
4. Documentation
   1. Sketchpad Options
   2. Sketchpad Methods after init
5. ToDo

---

Demo

You can try a working example online: DEMO

Install

npm install image-sketchpad --save

# yarn add image-sketchpad

Usage

I have included different files for different usages

Browser: VanillaJS

First include the JS file at the bottom of your html page

    <script src="image-sketchpad.min.js"></script>
  </body>
</html>

Second initialize the sketchpad and bind it to an image

    <img src="..." id="Image" />

    <script src="image-sketchpad.min.js"></script>
    <script>
        var img = document.getElementById('Image');
        var sketchpadOptions = {};
        var sketchPad = ImageSketchpad(img, sketchpadOptions);
    </script>
  </body>
</html>

That's it!

Documentation

• HTML Version
• Markdown Version

Sketchpad Options

Available Options

Sketchpad Methods after init

Methods

ToDo

• Test with some kind like electron
• Write e2e tests

Inspired by

responsive-sketchpad - I made a complete rewrite but got the inspiration from this nice npm package.

Changelog

1.1.0 (2022-03-02)

Full Changelog