@cmpd/compound

This is the pre-release version of compound. Use at your own caution.

Preface

compound is a fork of tldraw from the point at which it was still licensed under Apache 2.0.

The intention for this library simply put, is to continue to build upon the existing foundations and architecture, enhancing its capabilities where possible, but more importantly refining it further to provide a streamlined API and primitive for react applications in need of a whiteboarding component or interactive canvas.

The other mission of this library is to continue to offer a completely free for commercial use tool.

You can use compound to create a drop-in whiteboard for your product or as the foundation on which to build your own canvas applications.

Installation

yarn add @cmpd/compound | npm install @cmpd/compound

Then start the local development server.

yarn dev | npm run dev

Usage

An extremely minimal usage (without props) would look like this:

import { Compound } from '@cmpd/compound'
import '@cmpd/compound/compound.css'

export default function App() {
	return (
		<div style={{ position: fixed; inset: 0px; }}>
			<Compound />
		</div>
	)
}

See the examples folder for more examples or check them out soon on examples.cmpd.space

License

The source code in this repository is licensed under Apache-2.0.