Skip to content

projetoeureka/react-drawing-board

 
 

Repository files navigation

React Drawing board

Browser drawing board created with canvas and React.

Fork-specific instructions

The built files are commited in the repository. So if you change a file in the src folder, be sure to run npm run build so that that the corresponding file in the lib folder is changed as well.

Preview

preview

Features

A browser-ready efficient drawing board.

  • Support for drawing strokes, shapes, texts and images.
  • Built-in support for both redo and clear.
  • Easily zoom or pan the board content.
  • Ability to save screenshot.
  • Ability to be used as a Pictionary board for long distance communication.
  • Working for mobile users.

Installation

In NPM

React Drawing board uses a CMD so you can use it in NPM as well. npm install this package and

const DrawingBoard = require('react-drawing-board');

Basic Use

Basic

<DrawingBoard />

As A Pictionary

const Demo: React.FC = () => {
  const [operations, setOperations] = useState<Operation[]>([]);

  return (
    <DrawingBoard
      userId="user1" // identify for different players.
      operations={operations}
      onChange={(newOperation, afterOperation) => {
        console.log(`TODO: send ${newOperation}`);
        setOperations(afterOperation);
      }}
    />
  )
}

Props

Props Description Type Default
userId(optional) identify for operation source string uuid.v4()
locale(optional) 'en-US', 'zh-CN', 'tr-TR' string navigator.language
operations(optional) operations on drawing board Operation[] undefined
onChange(optional) called when user draw some operations (newOperaton: Operation, operationsAfter: Operation[]) => void undefined
onSave(image) called when user click save button for saving current view (image: { canvas: HTMLCanvasElement, dataUrl: string }) => void undefined
style(optional) element style CSSProperties undefined
className(optional) element classname string undefined
toolbarPlacement(optional) the position of toolbar 'top' or 'left' or 'right' 'top'
viewMatrix(optional) control the current perspective undefined
onViewMatrixChange(optional) (viewMatrix: ViewMatrix) => void undefined

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 55.6%
  • TypeScript 37.3%
  • CSS 3.7%
  • Less 3.2%
  • EJS 0.2%