You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

History

Mark Tolmacs e86d36820d [skip ci] fix rectanguloid intersection box Signed-off-by: Mark Tolmacs <mark@lazycat.hu>		2 weeks ago
..
actions	[skip ci] Fix arc intersect detection	3 weeks ago
components	fix: do not refocus element link input on unrelated updates (#9037 )	3 weeks ago
context	feat: update jotai (#9015 )	4 weeks ago
css	feat: canvas search (#8438 )	5 months ago
data	feat: allow installing libs from excal github (#9041 )	3 weeks ago
element	[skip ci] fix rectanguloid intersection box	2 weeks ago
fonts	chore: simplify line-break regexes, separate text wrapping (#8715 )	4 months ago
hooks	feat: update jotai (#9015 )	4 weeks ago
locales	feat: add action to wrap selected items in a frame (#9005 )	1 month ago
renderer	perf: reduce unnecessary frame clippings (#8980 )	3 weeks ago
scene	[skip ci] Refactor	2 weeks ago
subset	fix: Comic Shanns issues, new fonts structure (#8641 )	4 months ago
tests	Bezier curve line intersection implementation + test	3 weeks ago
.gitignore	…
.size-limit.json	…
CHANGELOG.md	feat: add first-class support for CJK (#8530 )	4 months ago
README.md	…
align.ts	fix: align arrows bound to elements excalidraw#8833 (#8998 )	3 weeks ago
analytics.ts	feat: subset font glyphs for SVG export (#8384 )	6 months ago
animated-trail.ts	…
animation-frame-handler.ts	…
appState.ts	feat: in canvas links between shapes (#8812 )	3 months ago
binaryheap.ts	feat: Orthogonal (elbow) arrows for diagramming (#8299 )	7 months ago
change.ts	feat: image cropping (#8613 )	4 months ago
charts.test.ts	…
charts.ts	refactor: `point()` -> `pointFrom()` to fix compiler issue (#8578 )	5 months ago
clients.ts	…
clipboard.test.ts	…
clipboard.ts	fix: right-click paste for images in clipboard (Issue #8826 ) (#8845 )	2 months ago
colors.ts	…
constants.ts	fix: right-click paste for images in clipboard (Issue #8826 ) (#8845 )	2 months ago
css.d.ts	…
cursor.ts	…
deburr.ts	…
distribute.ts	…
editor-jotai.ts	feat: update jotai (#9015 )	4 weeks ago
emitter.ts	…
env.cjs	…
errors.ts	feat: export scene to e+ on workspace creation/redemption (#8514 )	3 months ago
fractionalIndex.ts	feat: Elbow arrow segment fixing & positioning (#8952 )	4 weeks ago
frame.test.tsx	chore: bump `@testing-library/react` `12.1.5` -> `16.0.0` (#8322 )	6 months ago
frame.ts	fix: adding partial group to frame (#9014 )	3 weeks ago
gesture.ts	…
global.d.ts	feat: multiple fonts fallbacks (#8286 )	7 months ago
groups.ts	feat: do not delete frame children on frame delete (#9011 )	1 month ago
history.ts	chore: Refactor and remove scene from elbow arrow generation (#8342 )	6 months ago
i18n.ts	feat: update jotai (#9015 )	4 weeks ago
index-node.ts	…
index.tsx	feat: update jotai (#9015 )	4 weeks ago
keys.test.ts	fix: undo/redo action for international keyboard layouts (#8649 )	4 months ago
keys.ts	fix: undo/redo action for international keyboard layouts (#8649 )	4 months ago
laser-trails.ts	…
mermaid.test.ts	feat: improve mermaid detection on paste (#8287 )	7 months ago
mermaid.ts	feat: improve mermaid detection on paste (#8287 )	7 months ago
package.json	feat: Elbow arrow segment fixing & positioning (#8952 )	4 weeks ago
points.ts	chore: Unify math types, utils and functions (#8389 )	5 months ago
polyfill.ts	…
pwacompat.d.ts	…
queue.test.ts	…
queue.ts	…
random.ts	…
react-app-env.d.ts	…
reactUtils.ts	…
shapes.tsx	refactor: `point()` -> `pointFrom()` to fix compiler issue (#8578 )	5 months ago
snapping.ts	refactor: `point()` -> `pointFrom()` to fix compiler issue (#8578 )	5 months ago
store.ts	feat: image cropping (#8613 )	4 months ago
tsconfig.json	…
types.ts	feat: in canvas links between shapes (#8812 )	3 months ago
utility-types.ts	…
utils.ts	feat: make HTML attribute sanitization stricter (#8977 )	1 month ago
visualdebug.ts	[skip ci] Fix arc intersect detection	3 weeks ago
vite-env.d.ts	refactor: remove unused env variable (#8457 )	6 months ago
workers.ts	fix: Comic Shanns issues, new fonts structure (#8641 )	4 months ago
zindex.ts	fix: z-index change by one causes app to freeze (#8314 )	6 months ago

README.md

Excalidraw

Excalidraw is exported as a component to directly embed in your projects.

Installation

You can use npm

npm install react react-dom @excalidraw/excalidraw

or via yarn

yarn add react react-dom @excalidraw/excalidraw

After installation you will see a folder excalidraw-assets and excalidraw-assets-dev in dist directory which contains the assets needed for this app in prod and dev mode respectively.

Move the folder excalidraw-assets and excalidraw-assets-dev to the path where your assets are served.

By default it will try to load the files from https://unpkg.com/@excalidraw/excalidraw/dist/

If you want to load assets from a different path you can set a variable window.EXCALIDRAW_ASSET_PATH depending on environment (for example if you have different URL's for dev and prod) to the url from where you want to load the assets.

Note

If you don't want to wait for the next stable release and try out the unreleased changes you can use @excalidraw/excalidraw@next.

Dimensions of Excalidraw

Excalidraw takes 100% of width and height of the containing block so make sure the container in which you render Excalidraw has non zero dimensions.

Demo

Try here.

Integration

Head over to the docs

API

Head over to the docs

Contributing

Head over to the docs