Virtual whiteboard for sketching hand-drawn like diagrams
 
 
 
 
Go to file
Ryan Di d99e4a23ca
feat: use stats panel to crop ()
* feat: use stats panel to crop

* fix: test flake

---------

Co-authored-by: dwelle <5153846+dwelle@users.noreply.github.com>
.codesandbox chore: update required node version to 18 ()
.github fix: usage of `node12 which is deprecated` ()
.husky build: temporarily disable pre-commit ()
dev-docs feat: in canvas links between shapes ()
examples/excalidraw fix: Comic Shanns issues, new fonts structure ()
excalidraw-app feat: in canvas links between shapes ()
firebase-project fix: update `storage.rules` ()
packages feat: use stats panel to crop ()
public fix: remove manifest.json ()
scripts fix: Comic Shanns issues, new fonts structure ()
.dockerignore fix: Docker build in CI ()
.editorconfig
.env.development build: set PWA flag in dev to false ()
.env.production fix: load env vars correctly and set debug and linter flags to false explicitly in prod mode ()
.eslintignore feat: canvas search ()
.eslintrc.json build: enable consistent type imports eslint rule ()
.gitattributes
.gitignore build: create ESM build for utils package 🥳 ()
.lintstagedrc.js
.npmrc feat: color picker redesign ()
.nvmrc chore: update required node version to 18 ()
.prettierignore
.watchmanconfig
CONTRIBUTING.md docs: migrating dev docs to docusaurus :) ()
Dockerfile fix: Docker build in CI ()
LICENSE
README.md fix: update old blog links & add canonical url ()
crowdin.yml build: decouple package deps and introduce yarn workspaces ()
docker-compose.yml
package.json fix: cleanup scripts and support upto node 22 ()
setupTests.ts feat: image cropping ()
tsconfig.json docs: add next js with app router example ()
vercel.json feat: multiple fonts fallbacks ()
vitest.config.mts feat: self-hosting existing google fonts ()
yarn.lock feat: in canvas links between shapes ()

README.md

Excalidraw

Excalidraw Editor | Blog | Documentation | Excalidraw+

An open source virtual hand-drawn style whiteboard.
Collaborative and end-to-end encrypted.


Excalidraw is released under the MIT license. npm downloads/month PRs welcome! Chat on Discord Follow Excalidraw on Twitter

Product showcase

Create beautiful hand-drawn like diagrams, wireframes, or whatever you like.

Features

The Excalidraw editor (npm package) supports:

  • 💯 Free & open-source.
  • 🎨 Infinite, canvas-based whiteboard.
  • ✍️ Hand-drawn like style.
  • 🌓 Dark mode.
  • 🏗️ Customizable.
  • 📷 Image support.
  • 😀 Shape libraries support.
  • 👅 Localization (i18n) support.
  • 🖼️ Export to PNG, SVG & clipboard.
  • 💾 Open format - export drawings as an .excalidraw json file.
  • ⚒️ Wide range of tools - rectangle, circle, diamond, arrow, line, free-draw, eraser...
  • ➡️ Arrow-binding & labeled arrows.
  • 🔙 Undo / Redo.
  • 🔍 Zoom and panning support.

Excalidraw.com

The app hosted at excalidraw.com is a minimal showcase of what you can build with Excalidraw. Its source code is part of this repository as well, and the app features:

  • 📡 PWA support (works offline).
  • 🤼 Real-time collaboration.
  • 🔒 End-to-end encryption.
  • 💾 Local-first support (autosaves to the browser).
  • 🔗 Shareable links (export to a readonly link you can share with others).

We'll be adding these features as drop-in plugins for the npm package in the future.

Quick start

Note: following instructions are for installing the Excalidraw npm package when integrating Excalidraw into your own app. To run the repository locally for development, please refer to our Development Guide.

npm install react react-dom @excalidraw/excalidraw

or via yarn

yarn add react react-dom @excalidraw/excalidraw

Check out our documentation for more details!

Contributing

Integrations

Who's integrating Excalidraw

Google CloudMetaCodeSandboxObsidian ExcalidrawReplitSliteNotionHackerRank • and many others

Sponsors & support

If you like the project, you can become a sponsor at Open Collective or use Excalidraw+.

Thank you for supporting Excalidraw

Last but not least, we're thankful to these companies for offering their services for free:

Vercel Sentry Crowdin