d126d04d17
* fix: Bind keyboard events to excalidraw container * fix cases around blurring * fix modal rendering so keyboard shortcuts work on modal as well * Revert "fix modal rendering so keyboard shortcuts work on modal as well" This reverts commit 2c8ec6be8eff7d308591467fe2c33cfbca16138f. * Attach keyboard event in react way so we need not handle portals separately (modals) * dnt propagate esc event when modal shown * focus the container when help dialog closed with shift+? * focus the help icon when help dialog on close triggered * move focusNearestTabbableParent to util * rename util to focusNearestParent and remove outline from excal and modal * Add prop bindKeyGlobally to decide if keyboard events should be binded to document and allow it in excal app, revert tests * fix * focus container after installing library, reset library and closing error dialog * fix tests and create util to focus container * Add excalidraw-container class to focus on the container * pass focus container to library to focus current instance of excal * update docs * remove util as it wont be used anywhere * fix propagation not being stopped for React keyboard handling * tweak reamde Co-authored-by: David Luzar <luzar.david@gmail.com> * tweak changelog * rename prop to handleKeyboardGlobally Co-authored-by: dwelle <luzar.david@gmail.com>
Virtual whiteboard for sketching hand-drawn like diagrams.
Collaborative and end-to-end encrypted.
Ask questions or hang out on our discord.gg/UexuTaE.
Try it now
Go to excalidraw.com to start sketching.
Read the latest news and updates on our blog. A good start is to see all the updates of One Year of Excalidraw.
Supporting Excalidraw
If you like the project, you can become a sponsor at Open Collective.
Last but not least, we're thankful to these companies for offering their services for free:
Documentation
Shortcuts
You can almost do anything with shortcuts. Click on the help icon on the bottom right corner to see them all.
Curved lines and arrows
Choose line or arrow and click click click instead of drag.
Charts
You can easily create charts by copy pasting data from Excel or just plain comma separated text.
Translating
To translate Excalidraw into other languages, please visit our Crowdin page. To add a new language, open an issue so we can get things set up on our end first.
Translations will be available on the app if they exceed a certain threshold of completion (currently 85%).
Create a collaboration session manually
In order to create a session manually, you just need to generate a link of this form:
https://excalidraw.com/#room=[0-9a-f]{20},[a-zA-Z0-9_-]{22}
Example
https://excalidraw.com/#room=91bd46ae3aa84dff9d20,pfLqgEoY1c2ioq8LmGwsFA
The first set of digits is the room. This is visible from the server that’s going to dispatch messages to everyone that knows this number.
The second set of digits is the encryption key. The Excalidraw server doesn’t know about it. This is what all the participants use to encrypt/decrypt the messages.
Shape libraries
Find a growing list of libraries containing assets for your drawings at libraries.excalidraw.com.
Embedding Excalidraw in your App?
Try out @excalidraw/excalidraw. This package allows you to easily embed Excalidraw as a React component into your apps.
Development
Code Sandbox
- Go to https://codesandbox.io/s/github/excalidraw/excalidraw
- You may need to sign in with GitHub and reload the page
- You can start coding instantly, and even send PRs from there!
Local Installation
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
Requirements
Clone the repo
git clone https://github.com/excalidraw/excalidraw.git
Commands
| Command | Description |
|---|---|
yarn |
Install the dependencies |
yarn start |
Run the project |
yarn fix |
Reformat all files with Prettier |
yarn test |
Run tests |
yarn test:update |
Update test snapshots |
yarn test:code |
Test for formatting with Prettier |
Docker Compose
You can use docker-compose to work on Excalidraw locally if you don't want to setup a Node.js env.
docker-compose up --build -d
Self-hosting
We publish a Docker image with the Excalidraw client at excalidraw/excalidraw. You can use it to self-host your own client under your own domain, on Kubernetes, AWS ECS, etc.
docker build -t excalidraw/excalidraw .
docker run --rm -dit --name excalidraw -p 5000:80 excalidraw/excalidraw:latest
The Docker image is free of analytics and other tracking libraries.
At the moment, self-hosting your own instance doesn't support sharing or collaboration features.
We are working towards providing a full-fledged solution for self-hosting your own Excalidraw.
Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
Notable used tools
And the main source of inspiration for starting the project is the awesome Zwibbler app.