mirror of
https://github.com/excalidraw/excalidraw.git
synced 2026-10-19 16:15:56 +00:00
David Luzar
a918648012
* feat(packages/excalidraw): add renderOverrides to allow overriding rendering of elements * refactor(renderer): centralize overrides and inherit label offsets * fix(renderer): preserve frame-name editing during visual overrides * perf(renderer): limit override culling to translated elements * fix(renderer): keep frame-title hit bounds at document positions * fix(renderer): skip clearing an already clear override snapshot `setElementRenderOverrides(null)` (or an empty map) on an editor whose snapshot is already empty no longer copies, derives offsets or schedules a render. Every other submission still repaints, equivalent ones included: a value comparison would cost about as much as the copy it saves on every changing frame, so hosts are told to submit only on change and to dedupe at their own level, where the snapshot's structure is known. Fable 5.1, medium reasoning * refactor(renderer): drop two override edge cases Culling no longer keeps an off-screen container alive because its bound label alone would be in view: the label follows its container, as it does for document culling, and the case needed a label wider than its (short arrow) container at the viewport edge during a translation. Frame clipping no longer tracks whether an element carries an explicit offset entry (`hasPositionOverride`); a non-zero offset is what matters. An explicit zero offset leaves the element at rest, where the ordinary overlap check already decides correctly. Fable 5.1, medium reasoning * perf(renderer): leave bound-label entries out of override culling A bound label is drawn with its container and its own entry in the visible list is skipped by the static renderer, so override culling has no reason to adjust that entry. Doing so made a visible container whose label is document-off-screen (a long arrow with its label past the viewport) report the label as newly visible on every translation, which rebuilt the visible set from the whole scene each frame. Translated elements now update only their own membership; the label lookup per translated element goes too. Fable 5.1, medium reasoning
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
.excalidrawjson 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
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:
