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.
 
 
 
Hamir Mahal 6e0ee89ee4
fix: usage of `node12 which is deprecated` (#8791)
1 year ago
.codesandbox chore: update required node version to 18 (#6837) 2 years ago
.github fix: usage of `node12 which is deprecated` (#8791) 1 year ago
.husky build: temporarily disable pre-commit (#6132) 3 years ago
dev-docs feat: add first-class support for CJK (#8530) 1 year ago
examples/excalidraw fix: Comic Shanns issues, new fonts structure (#8641) 1 year ago
excalidraw-app build: add a flag VITE_APP_ENABLE_PWA for enabling pwa in dev environment (#8784) 1 year ago
firebase-project fix: update `storage.rules` (#5020) 4 years ago
packages feat: update blog url (#8767) 1 year ago
public fix: remove manifest.json (#8783) 1 year ago
scripts fix: Comic Shanns issues, new fonts structure (#8641) 1 year ago
.dockerignore fix: Docker build in CI (#8312) 1 year ago
.editorconfig
.env.development build: set PWA flag in dev to false (#8788) 1 year ago
.env.production fix: load env vars correctly and set debug and linter flags to false explicitly in prod mode (#8770) 1 year ago
.eslintignore feat: canvas search (#8438) 1 year 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 Keep errors, elements and comments consistent (#2340) 5 years ago
.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 in CI (#8312) 1 year 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 chore: Update action versions and docker build (#3065) 5 years ago
package.json chore: support upto node 22.x.x (#8755) 1 year ago
setupTests.ts feat: image cropping (#8613) 1 year ago
tsconfig.json docs: add next js with app router example (#7552) 2 years ago
vercel.json feat: multiple fonts fallbacks (#8286) 1 year ago
vitest.config.mts feat: self-hosting existing google fonts (#8540) 1 year ago
yarn.lock feat: added sitemap & fixed robot txt (#8699) 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