extras
/
excalidraw
mirror of https://github.com/excalidraw/excalidraw.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
excalidraw/packages/excalidraw
History
Guillaume Grossetie 79257a1923
fix: correctly resolve the package version (#8016) 
The property name is `VITE_PKG_VERSION` (not `PKG_VERSION`)

Resolves #7984
 		2024-05-14 13:31:02 +05:30
..
actions build: enable consistent type imports eslint rule (#7992) 2024-05-08 14:21:50 +05:30
components fix: font not rendered correctly on init (#8002) 2024-05-10 16:37:46 +02:00
context build: enable consistent type imports eslint rule (#7992) 2024-05-08 14:21:50 +05:30
css feat: tweak a few icons & add line editor button to side panel (#7990) 2024-05-07 13:18:39 +02:00
data build: enable consistent type imports eslint rule (#7992) 2024-05-08 14:21:50 +05:30
element fix: re-introduce wysiwyg width offset (#8014) 2024-05-13 17:38:21 +02:00
hooks build: enable consistent type imports eslint rule (#7992) 2024-05-08 14:21:50 +05:30
locales feat: add install-PWA to command palette (#7935) 2024-05-08 22:02:28 +02:00
renderer build: enable consistent type imports eslint rule (#7992) 2024-05-08 14:21:50 +05:30
scene fix: correctly resolve the package version (#8016) 2024-05-14 13:31:02 +05:30
tests fix: re-introduce wysiwyg width offset (#8014) 2024-05-13 17:38:21 +02: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
CHANGELOG.md feat: expose `StoreAction` in relation to multiplayer history (#7898) 2024-04-22 09:22:25 +00:00
README.md build: decouple package deps and introduce yarn workspaces (#7415) 2023-12-12 11:32:51 +05:30
align.ts build: enable consistent type imports eslint rule (#7992) 2024-05-08 14:21:50 +05:30
analytics.ts fix: command palette tweaks and fixes (#7876) 2024-04-11 11:39:19 +02:00
animated-trail.ts build: enable consistent type imports eslint rule (#7992) 2024-05-08 14:21:50 +05:30
animation-frame-handler.ts feat: add eraser tool trail (#7511) 2024-01-11 16:10:15 +00:00
appState.ts build: enable consistent type imports eslint rule (#7992) 2024-05-08 14:21:50 +05:30
change.ts build: enable consistent type imports eslint rule (#7992) 2024-05-08 14:21:50 +05:30
charts.test.ts build: enable consistent type imports eslint rule (#7992) 2024-05-08 14:21:50 +05:30
charts.ts build: enable consistent type imports eslint rule (#7992) 2024-05-08 14:21:50 +05:30
clients.ts build: enable consistent type imports eslint rule (#7992) 2024-05-08 14:21:50 +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: enable consistent type imports eslint rule (#7992) 2024-05-08 14:21:50 +05:30
colors.ts build: enable consistent type imports eslint rule (#7992) 2024-05-08 14:21:50 +05:30
constants.ts build: enable consistent type imports eslint rule (#7992) 2024-05-08 14:21:50 +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: enable consistent type imports eslint rule (#7992) 2024-05-08 14:21:50 +05:30
deburr.ts feat: command palette (#7804) 2024-03-28 16:16:32 +00:00
distribute.ts fix: make getBoundTextElement and related helpers pure (#7601) 2024-01-26 11:29:07 +05:30
emitter.ts build: enable consistent type imports eslint rule (#7992) 2024-05-08 14:21:50 +05:30
env.cjs build: Welcome ESM and Bye Bye UMD (#7441) 2024-01-01 20:18:44 +05:30
errors.ts feat: fractional indexing (#7359) 2024-04-04 13:51:11 +01:00
fractionalIndex.ts build: enable consistent type imports eslint rule (#7992) 2024-05-08 14:21:50 +05:30
frame.test.tsx build: enable consistent type imports eslint rule (#7992) 2024-05-08 14:21:50 +05:30
frame.ts build: enable consistent type imports eslint rule (#7992) 2024-05-08 14:21:50 +05:30
ga.ts build: decouple package deps and introduce yarn workspaces (#7415) 2023-12-12 11:32:51 +05:30
gadirections.ts build: enable consistent type imports eslint rule (#7992) 2024-05-08 14:21:50 +05:30
galines.ts build: enable consistent type imports eslint rule (#7992) 2024-05-08 14:21:50 +05:30
gapoints.ts build: enable consistent type imports eslint rule (#7992) 2024-05-08 14:21:50 +05:30
gatransforms.ts build: enable consistent type imports eslint rule (#7992) 2024-05-08 14:21:50 +05:30
gesture.ts build: enable consistent type imports eslint rule (#7992) 2024-05-08 14:21:50 +05:30
global.d.ts build: enable consistent type imports eslint rule (#7992) 2024-05-08 14:21:50 +05:30
groups.ts build: enable consistent type imports eslint rule (#7992) 2024-05-08 14:21:50 +05:30
history.ts build: enable consistent type imports eslint rule (#7992) 2024-05-08 14:21:50 +05:30
i18n.ts build: enable consistent type imports eslint rule (#7992) 2024-05-08 14:21:50 +05:30
index-node.ts build: decouple package deps and introduce yarn workspaces (#7415) 2023-12-12 11:32:51 +05:30
index.tsx build: enable consistent type imports eslint rule (#7992) 2024-05-08 14:21:50 +05:30
jotai.ts build: enable consistent type imports eslint rule (#7992) 2024-05-08 14:21:50 +05:30
keys.ts feat: command palette (#7804) 2024-03-28 16:16:32 +00:00
laser-trails.ts build: enable consistent type imports eslint rule (#7992) 2024-05-08 14:21:50 +05:30
math.test.ts build: decouple package deps and introduce yarn workspaces (#7415) 2023-12-12 11:32:51 +05:30
math.ts build: enable consistent type imports eslint rule (#7992) 2024-05-08 14:21:50 +05:30
package.json feat: fractional indexing (#7359) 2024-04-04 13:51:11 +01:00
points.ts build: enable consistent type imports eslint rule (#7992) 2024-05-08 14:21:50 +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
queue.test.ts feat: store library to IndexedDB & support storage adapters (#7655) 2024-03-08 22:29:19 +01:00
queue.ts build: enable consistent type imports eslint rule (#7992) 2024-05-08 14:21:50 +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
shapes.tsx build: decouple package deps and introduce yarn workspaces (#7415) 2023-12-12 11:32:51 +05:30
snapping.ts build: enable consistent type imports eslint rule (#7992) 2024-05-08 14:21:50 +05:30
store.ts build: enable consistent type imports eslint rule (#7992) 2024-05-08 14:21:50 +05:30
tsconfig.json docs: add next js with app router example (#7552) 2024-01-24 17:07:54 +05:30
types.ts build: enable consistent type imports eslint rule (#7992) 2024-05-08 14:21:50 +05:30
utility-types.ts feat: store library to IndexedDB & support storage adapters (#7655) 2024-03-08 22:29:19 +01:00
utils.ts build: enable consistent type imports eslint rule (#7992) 2024-05-08 14:21:50 +05:30
vite-env.d.ts build: decouple package deps and introduce yarn workspaces (#7415) 2023-12-12 11:32:51 +05:30
zindex.ts build: enable consistent type imports eslint rule (#7992) 2024-05-08 14:21:50 +05:30

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