OpeningDesign fork

This is OpeningDesign's fork of excalidraw/excalidraw, maintained to carry editor changes needed by SketchSpace — a self-hosted, collaborative, multi-page redlining tool for AEC, used to mark up evolving construction documents.

Work lives on the SketchSpace branch, which is this fork's default. master is kept as an untouched mirror of upstream, so git log master..SketchSpace is exactly what we have changed.

Where this is heading

Excalidraw is an excellent drawing surface; the AEC work happens around it. Changes here are the ones that have to live inside the editor:

• Input and ergonomics for drafting — e.g. an opt-in mouse-wheel zoom preference, so the wheel behaves the way it does in CAD.
• Multi-page and sheet-set support, since a drawing set is many sheets and upstream has deferred pages in favour of Excalidraw+ scenes.
• Anchoring annotations to model data, so a redline can hang off an IFC GlobalId and survive a drawing being regenerated from the model.
• openBIM interoperability — Bonsai sheet layouts, IFC, and BCF as the exchange format for markup.

Relationship to upstream

We are not trying to land everything upstream; this fork exists so the work can move at the pace the AEC use case needs. Individual changes may still be offered where they are generally useful — the wheel-zoom preference is open as excalidraw#12051.

Please file Excalidraw bugs and feature requests upstream, not here. Issues in this repo should be about the SketchSpace-specific changes above.

See NOTES.md for lessons from working inside the editor and the roadmap for this fork.

Everything below is upstream's README, unchanged.

---

Excalidraw Editor | Blog | Documentation | Excalidraw+

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

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.

Use npm or yarn to install the package.

npm install react react-dom @excalidraw/excalidraw
# or
yarn add react react-dom @excalidraw/excalidraw

Check out our documentation for more details!

Contributing

• Missing something or found a bug? Report here.
• Want to contribute? Check out our contribution guide or let us know on Discord.
• Want to help with translations? See the translation guide.

Integrations

• VScode extension
• npm package

Who's integrating Excalidraw

Google Cloud • Meta • CodeSandbox • Obsidian Excalidraw • Replit • Slite • Notion • HackerRank • 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: