Go to file
David Luzar b5d7f5b4ba
feat: rewrite d2c to not require token (#8269)
2024-08-20 18:06:22 +02:00
.codesandbox chore: update required node version to 18 (#6837) 2023-07-31 23:47:41 +02:00
.github test: skip test.yml in PRs (#8330) 2024-08-06 16:04:04 +02:00
.husky
dev-docs feat: split `gridSize` from enabled state & support custom `gridStep` (#8364) 2024-08-14 14:59:14 +02:00
examples/excalidraw fix: CVE-2023-45133 (#7988) 2024-08-02 14:44:38 +02:00
excalidraw-app feat: rewrite d2c to not require token (#8269) 2024-08-20 18:06:22 +02:00
firebase-project
packages feat: rewrite d2c to not require token (#8269) 2024-08-20 18:06:22 +02:00
public feat: introduce font picker (#8012) 2024-07-25 18:55:55 +02:00
scripts fix: Docker build in CI (#8312) 2024-08-06 13:21:20 +02:00
.dockerignore fix: Docker build in CI (#8312) 2024-08-06 13:21:20 +02:00
.editorconfig
.env.development fix: log allowed events (#8224) 2024-07-09 12:16:14 +02:00
.env.production fix: messed up env variable (#8231) 2024-07-11 14:33:35 +02:00
.eslintignore build: add example apps `public` and vite `dev-dist` to eslintignore (#8326) 2024-08-05 23:43:48 +02:00
.eslintrc.json build: enable consistent type imports eslint rule (#7992) 2024-05-08 14:21:50 +05:30
.gitattributes
.gitignore build: create ESM build for utils package 🥳 (#7500) 2024-02-28 19:33:47 +05:30
.lintstagedrc.js
.npmrc feat: color picker redesign (#6216) 2023-05-18 16:06:27 +02:00
.nvmrc chore: update required node version to 18 (#6837) 2023-07-31 23:47:41 +02:00
.prettierignore
.watchmanconfig
CONTRIBUTING.md docs: migrating dev docs to docusaurus :) (#6073) 2023-02-01 19:57:54 +05:30
Dockerfile fix: Docker build in CI (#8312) 2024-08-06 13:21:20 +02:00
LICENSE
README.md docs: add steps for local development (#7449) 2023-12-16 19:18:35 +01:00
crowdin.yml build: decouple package deps and introduce yarn workspaces (#7415) 2023-12-12 11:32:51 +05:30
docker-compose.yml
package.json build: add `rm:build`, `rm:node_modules` & `clean-install` scripts (#8323) 2024-08-05 23:37:33 +02:00
setupTests.ts fix: missing `act()` in flowchart tests (#8354) 2024-08-09 17:27:02 +02:00
tsconfig.json docs: add next js with app router example (#7552) 2024-01-24 17:07:54 +05:30
vercel.json feat: multiple fonts fallbacks (#8286) 2024-07-30 10:34:40 +02:00
vitest.config.mts fix: Docker build in CI (#8312) 2024-08-06 13:21:20 +02:00
yarn.lock chore: bump `@testing-library/react` `12.1.5` -> `16.0.0` (#8322) 2024-08-06 15:17:42 +02:00

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