excalidraw/packages/excalidraw
Aashir Israr 2409c091ff
feat: support roundness for images (#7558)
Co-authored-by: dwelle <5153846+dwelle@users.noreply.github.com>
2024-01-29 15:27:07 +01:00
..
actions fix: make getBoundTextElement and related helpers pure (#7601) 2024-01-26 11:29:07 +05:30
assets build: decouple package deps and introduce yarn workspaces (#7415) 2023-12-12 11:32:51 +05:30
components fix: frame name field (#7457) 2024-01-29 10:57:22 +01:00
context build: decouple package deps and introduce yarn workspaces (#7415) 2023-12-12 11:32:51 +05:30
css build: Welcome ESM and Bye Bye UMD (#7441) 2024-01-01 20:18:44 +05:30
data fix: make getBoundTextElement and related helpers pure (#7601) 2024-01-26 11:29:07 +05:30
element feat: support roundness for images (#7558) 2024-01-29 15:27:07 +01:00
hooks feat: move utils to utils package and make @excalidraw/utils a workspace (#7432) 2023-12-13 21:51:27 +05:30
locales feat: update X brand logo & tweak labels (#7518) 2024-01-04 14:57:31 +01:00
renderer feat: support roundness for images (#7558) 2024-01-29 15:27:07 +01:00
scene feat: support roundness for images (#7558) 2024-01-29 15:27:07 +01:00
tests feat: support roundness for images (#7558) 2024-01-29 15:27:07 +01:00
.gitignore docs: add next js with app router example (#7552) 2024-01-24 17:07:54 +05:30
.size-limit.json build: decouple package deps and introduce yarn workspaces (#7415) 2023-12-12 11:32:51 +05:30
align.ts fix: make getBoundTextElement and related helpers pure (#7601) 2024-01-26 11:29:07 +05:30
analytics.ts build: decouple package deps and introduce yarn workspaces (#7415) 2023-12-12 11:32:51 +05:30
animated-trail.ts feat: add eraser tool trail (#7511) 2024-01-11 16:10:15 +00:00
animation-frame-handler.ts feat: add eraser tool trail (#7511) 2024-01-11 16:10:15 +00:00
appState.ts feat: follow mode (#6848) 2023-12-15 00:07:11 +01:00
CHANGELOG.md feat: remove ExcalidrawEmbeddableElement.validated flag (#7539) 2024-01-11 17:42:51 +01:00
charts.test.ts build: decouple package deps and introduce yarn workspaces (#7415) 2023-12-12 11:32:51 +05:30
charts.ts build: decouple package deps and introduce yarn workspaces (#7415) 2023-12-12 11:32:51 +05:30
clients.ts build: decouple package deps and introduce yarn workspaces (#7415) 2023-12-12 11:32:51 +05:30
clipboard.test.ts build: decouple package deps and introduce yarn workspaces (#7415) 2023-12-12 11:32:51 +05:30
clipboard.ts build: decouple package deps and introduce yarn workspaces (#7415) 2023-12-12 11:32:51 +05:30
colors.ts build: decouple package deps and introduce yarn workspaces (#7415) 2023-12-12 11:32:51 +05:30
constants.ts docs: add next js with app router example (#7552) 2024-01-24 17:07:54 +05:30
css.d.ts build: decouple package deps and introduce yarn workspaces (#7415) 2023-12-12 11:32:51 +05:30
cursor.ts build: decouple package deps and introduce yarn workspaces (#7415) 2023-12-12 11:32:51 +05:30
distribute.ts fix: make getBoundTextElement and related helpers pure (#7601) 2024-01-26 11:29:07 +05:30
emitter.ts feat: support pen erasing (#7496) 2024-01-01 13:27:03 +01:00
env.cjs build: Welcome ESM and Bye Bye UMD (#7441) 2024-01-01 20:18:44 +05:30
errors.ts build: decouple package deps and introduce yarn workspaces (#7415) 2023-12-12 11:32:51 +05:30
frame.test.tsx build: decouple package deps and introduce yarn workspaces (#7415) 2023-12-12 11:32:51 +05:30
frame.ts fix: frame name field (#7457) 2024-01-29 10:57:22 +01:00
ga.ts build: decouple package deps and introduce yarn workspaces (#7415) 2023-12-12 11:32:51 +05:30
gadirections.ts build: decouple package deps and introduce yarn workspaces (#7415) 2023-12-12 11:32:51 +05:30
galines.ts build: decouple package deps and introduce yarn workspaces (#7415) 2023-12-12 11:32:51 +05:30
gapoints.ts build: decouple package deps and introduce yarn workspaces (#7415) 2023-12-12 11:32:51 +05:30
gatransforms.ts build: decouple package deps and introduce yarn workspaces (#7415) 2023-12-12 11:32:51 +05:30
gesture.ts build: decouple package deps and introduce yarn workspaces (#7415) 2023-12-12 11:32:51 +05:30
global.d.ts refactor: editor events sub/unsub refactor (#7483) 2023-12-30 11:12:38 +01:00
groups.ts fix: make getBoundTextElement and related helpers pure (#7601) 2024-01-26 11:29:07 +05:30
history.ts build: decouple package deps and introduce yarn workspaces (#7415) 2023-12-12 11:32:51 +05:30
i18n.ts build: Welcome ESM and Bye Bye UMD (#7441) 2024-01-01 20:18:44 +05:30
index-node.ts build: decouple package deps and introduce yarn workspaces (#7415) 2023-12-12 11:32:51 +05:30
index.tsx docs: add next js with app router example (#7552) 2024-01-24 17:07:54 +05:30
jotai.ts build: decouple package deps and introduce yarn workspaces (#7415) 2023-12-12 11:32:51 +05:30
keys.ts build: decouple package deps and introduce yarn workspaces (#7415) 2023-12-12 11:32:51 +05:30
laser-trails.ts feat: add eraser tool trail (#7511) 2024-01-11 16:10:15 +00:00
math.test.ts build: decouple package deps and introduce yarn workspaces (#7415) 2023-12-12 11:32:51 +05:30
math.ts build: decouple package deps and introduce yarn workspaces (#7415) 2023-12-12 11:32:51 +05:30
package.json fix: move default to last so its compatible with nextjs (#7561) 2024-01-15 14:52:04 +05:30
points.ts build: decouple package deps and introduce yarn workspaces (#7415) 2023-12-12 11:32:51 +05:30
polyfill.ts build: decouple package deps and introduce yarn workspaces (#7415) 2023-12-12 11:32:51 +05:30
pwacompat.d.ts build: decouple package deps and introduce yarn workspaces (#7415) 2023-12-12 11:32:51 +05:30
random.ts build: decouple package deps and introduce yarn workspaces (#7415) 2023-12-12 11:32:51 +05:30
react-app-env.d.ts build: decouple package deps and introduce yarn workspaces (#7415) 2023-12-12 11:32:51 +05:30
reactUtils.ts fix: decouple react and react-dom imports from utils and make it treeshakeable (#7527) 2024-01-08 21:01:47 +05:30
README.md build: decouple package deps and introduce yarn workspaces (#7415) 2023-12-12 11:32:51 +05:30
shapes.tsx build: decouple package deps and introduce yarn workspaces (#7415) 2023-12-12 11:32:51 +05:30
snapping.ts fix: make getBoundTextElement and related helpers pure (#7601) 2024-01-26 11:29:07 +05:30
tsconfig.json docs: add next js with app router example (#7552) 2024-01-24 17:07:54 +05:30
types.ts feat: remove ExcalidrawEmbeddableElement.validated flag (#7539) 2024-01-11 17:42:51 +01:00
utility-types.ts refactor: decoupling global Scene state part-1 (#7577) 2024-01-22 00:23:02 +01:00
utils.ts refactor: decoupling global Scene state part-1 (#7577) 2024-01-22 00:23:02 +01:00
vite-env.d.ts build: decouple package deps and introduce yarn workspaces (#7415) 2023-12-12 11:32:51 +05:30
zindex.ts build: decouple package deps and introduce yarn workspaces (#7415) 2023-12-12 11:32:51 +05:30

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