React-canvas-sketchpad NPM

React Canvas SketchPad

A simple React component for creating sketches created with React, TypeScript and Vite.

Docs created using Storybook. See them live here

Features

Draw a path
Undo a path (remove it)
Download as PNG
Download as Paths (as JSON)

Install

This package is published to npm

# in your project directory
npm install react-canvas-sketchpad

Usage

import { SketchPad } from "react-canvas-sketchpad";

function App() {
  return <SketchPad />;
}

The SketchPad component supports the following props via the exported interface SketchPadProps:

interface SketchPadProps = {
  // size of the canvas element in pixels
  size?: number;
  styles: React.HTMLAttributes<HTMLCanvasElement>["style"];
  // canvas context scale
  scale?: [number, number];
  // hiding/showing UI elements
  controls: {
    undo?: boolean; // undo button
    clear?: boolean; // clear button
    exportToPng?: boolean; // export to PNG
    exportJson?: boolean; // export paths to JSON
  }
};

The default to the following values:

  size: 400,
  styles: { backgroundColor: "white", boxShadow: "0px 0px 10px 2px black" },
  scale: [1, 1],
  controls: { undo: true, exportJson: true, exportToPng: true, clear: true },