Virtual whiteboard for sketching hand-drawn like diagrams
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
DDDDD12138 4c5408263c
chore: Correct Typos in Code Comments (#8268)
1 year ago
.codesandbox chore: update required node version to 18 (#6837) 2 years ago
.github ci: upgrade gh actions checkout and setup-node to v4 (#8168) 1 year ago
.husky build: temporarily disable pre-commit (#6132) 3 years ago
dev-docs Fix : exportToCanvas() doc example (#8127) 1 year ago
examples/excalidraw build: enable consistent type imports eslint rule (#7992) 2 years ago
excalidraw-app chore: Correct Typos in Code Comments (#8268) 1 year ago
firebase-project fix: update `storage.rules` (#5020) 4 years ago
packages chore: Correct Typos in Code Comments (#8268) 1 year ago
public fix: fix twitter og image (#8050) 2 years ago
scripts build: create ESM build for utils package 🥳 (#7500) 2 years ago
.dockerignore fix: docker build of Excalidraw app (#7430) 2 years ago
.editorconfig
.env.development fix: log allowed events (#8224) 1 year ago
.env.production fix: messed up env variable (#8231) 1 year ago
.eslintignore build: decouple package deps and introduce yarn workspaces (#7415) 2 years ago
.eslintrc.json build: enable consistent type imports eslint rule (#7992) 2 years ago
.gitattributes
.gitignore build: create ESM build for utils package 🥳 (#7500) 2 years ago
.lintstagedrc.js
.npmrc feat: color picker redesign (#6216) 3 years ago
.nvmrc chore: update required node version to 18 (#6837) 2 years ago
.prettierignore
.watchmanconfig
CONTRIBUTING.md docs: migrating dev docs to docusaurus :) (#6073) 3 years ago
Dockerfile fix: docker build of Excalidraw app (#7430) 2 years ago
LICENSE
README.md docs: add steps for local development (#7449) 2 years ago
crowdin.yml build: decouple package deps and introduce yarn workspaces (#7415) 2 years ago
docker-compose.yml
package.json build: specify `packageManager` field (#8010) 2 years ago
setupTests.ts feat: add system mode to the theme selector (#7853) 2 years ago
tsconfig.json docs: add next js with app router example (#7552) 2 years ago
vercel.json fix: host font assets from root (#7548) 2 years ago
vitest.config.mts chore: Add lcov coverage output to vitest (#7987) 2 years ago
yarn.lock feat: upgrade mermaid-to-excalidraw to v1.1.0 (#8226) 1 year ago

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