react-drawing-board-level

0.1.1 • Public • Published

React Drawing board

Browser drawing board created with canvas and React.

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.

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' or 'zh-CN' 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
style(optional) element style CSSProperties undefined
className(optional) element classname string undefined
toolbarPlacement(optional) the position of toolbar 'top' or 'left' or 'right' 'top'

Readme

Keywords

none

Package Sidebar

Install

npm i react-drawing-board-level

Weekly Downloads

1

Version

0.1.1

License

MIT

Unpacked Size

106 kB

Total Files

42

Last publish

Collaborators

  • vijay-test