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

David Luzar 60e75406e0 refactor: remove unused env variable (#8457 )		5 months ago
..
actions	feat: subset font glyphs for SVG export (#8384 )	5 months ago
components	fix: PropertiesPopover maxWidth changing fixed units to relative units (#8456 )	5 months ago
context	…
css	fix: PropertiesPopover maxWidth changing fixed units to relative units (#8456 )	5 months ago
data	perf: improve new element drawing (#8340 )	6 months ago
element	feat: enable panning/zoom while in wysiwyg (#8437 )	5 months ago
fonts	feat: subset font glyphs for SVG export (#8384 )	5 months ago
hooks	feat: subset font glyphs for SVG export (#8384 )	5 months ago
locales	fix: fixed copy to clipboard button (#8426 )	6 months ago
renderer	perf: improve new element drawing (#8340 )	6 months ago
scene	feat: subset font glyphs for SVG export (#8384 )	5 months ago
tests	perf: improve new element drawing (#8340 )	6 months ago
.gitignore	…
.size-limit.json	…
CHANGELOG.md	feat: Stats popup style tweaks (#8361 )	6 months ago
README.md	…
align.ts	…
analytics.ts	feat: subset font glyphs for SVG export (#8384 )	5 months ago
animated-trail.ts	…
animation-frame-handler.ts	…
appState.ts	perf: improve new element drawing (#8340 )	6 months ago
binaryheap.ts	feat: Orthogonal (elbow) arrows for diagramming (#8299 )	6 months ago
change.ts	chore: Refactor and remove scene from elbow arrow generation (#8342 )	6 months ago
charts.test.ts	…
charts.ts	feat: Orthogonal (elbow) arrows for diagramming (#8299 )	6 months ago
clients.ts	…
clipboard.test.ts	…
clipboard.ts	…
colors.ts	…
constants.ts	feat: enable panning/zoom while in wysiwyg (#8437 )	5 months ago
css.d.ts	…
cursor.ts	…
deburr.ts	…
distribute.ts	…
emitter.ts	…
env.cjs	…
errors.ts	…
fractionalIndex.ts	fix: throttle fractional indices validation (#8306 )	6 months ago
frame.test.tsx	chore: bump `@testing-library/react` `12.1.5` -> `16.0.0` (#8322 )	6 months ago
frame.ts	feat: remove automatic frame naming (#8302 )	6 months ago
ga.ts	…
gadirections.ts	…
galines.ts	…
gapoints.ts	…
gatransforms.ts	…
gesture.ts	…
global.d.ts	feat: multiple fonts fallbacks (#8286 )	6 months ago
groups.ts	…
history.ts	chore: Refactor and remove scene from elbow arrow generation (#8342 )	6 months ago
i18n.ts	…
index-node.ts	…
index.tsx	feat: rewrite d2c to not require token (#8269 )	6 months ago
jotai.ts	…
keys.ts	…
laser-trails.ts	…
math.test.ts	feat: Orthogonal (elbow) arrows for diagramming (#8299 )	6 months ago
math.ts	feat: split `gridSize` from enabled state & support custom `gridStep` (#8364 )	6 months ago
mermaid.test.ts	…
mermaid.ts	…
package.json	feat: subset font glyphs for SVG export (#8384 )	5 months ago
points.ts	…
polyfill.ts	…
pwacompat.d.ts	…
queue.test.ts	…
queue.ts	…
random.ts	…
react-app-env.d.ts	…
reactUtils.ts	…
shapes.tsx	fix: linear elements not selected on pointer up from hitting its bound text (#8285 )	7 months ago
snapping.ts	fix: object snapping not working (#8381 )	6 months ago
store.ts	…
tsconfig.json	…
types.ts	perf: improve new element drawing (#8340 )	6 months ago
utility-types.ts	…
utils.ts	feat: rewrite d2c to not require token (#8269 )	6 months ago
visualdebug.ts	feat: Visual debugger (#8344 )	5 months ago
vite-env.d.ts	refactor: remove unused env variable (#8457 )	5 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