4c5408263c
chore: correct typos Co-authored-by: wuzhiqing <wuzhiqing@linklogis.com> |
6 months ago | |
|---|---|---|
| .. | ||
| actions | 7 months ago | |
| components | 7 months ago | |
| context | 9 months ago | |
| css | 8 months ago | |
| data | 8 months ago | |
| element | 7 months ago | |
| hooks | 9 months ago | |
| locales | 8 months ago | |
| renderer | 6 months ago | |
| scene | 7 months ago | |
| tests | 7 months ago | |
| .gitignore | 1 year ago | |
| .size-limit.json | 1 year ago | |
| CHANGELOG.md | 7 months ago | |
| README.md | 1 year ago | |
| align.ts | 9 months ago | |
| analytics.ts | 7 months ago | |
| animated-trail.ts | 9 months ago | |
| animation-frame-handler.ts | 1 year ago | |
| appState.ts | 8 months ago | |
| change.ts | 9 months ago | |
| charts.test.ts | 9 months ago | |
| charts.ts | 9 months ago | |
| clients.ts | 9 months ago | |
| clipboard.test.ts | 1 year ago | |
| clipboard.ts | 9 months ago | |
| colors.ts | 9 months ago | |
| constants.ts | 7 months ago | |
| css.d.ts | 1 year ago | |
| cursor.ts | 9 months ago | |
| deburr.ts | 10 months ago | |
| distribute.ts | 1 year ago | |
| emitter.ts | 9 months ago | |
| env.cjs | 1 year ago | |
| errors.ts | 10 months ago | |
| fractionalIndex.ts | 6 months ago | |
| frame.test.tsx | 9 months ago | |
| frame.ts | 9 months ago | |
| ga.ts | 1 year ago | |
| gadirections.ts | 9 months ago | |
| galines.ts | 9 months ago | |
| gapoints.ts | 9 months ago | |
| gatransforms.ts | 9 months ago | |
| gesture.ts | 9 months ago | |
| global.d.ts | 9 months ago | |
| groups.ts | 8 months ago | |
| history.ts | 9 months ago | |
| i18n.ts | 9 months ago | |
| index-node.ts | 1 year ago | |
| index.tsx | 9 months ago | |
| jotai.ts | 9 months ago | |
| keys.ts | 10 months ago | |
| laser-trails.ts | 9 months ago | |
| math.test.ts | 1 year ago | |
| math.ts | 8 months ago | |
| mermaid.ts | 8 months ago | |
| package.json | 7 months ago | |
| points.ts | 9 months ago | |
| polyfill.ts | 1 year ago | |
| pwacompat.d.ts | 1 year ago | |
| queue.test.ts | 11 months ago | |
| queue.ts | 9 months ago | |
| random.ts | 1 year ago | |
| react-app-env.d.ts | 1 year ago | |
| reactUtils.ts | 1 year ago | |
| shapes.tsx | 7 months ago | |
| snapping.ts | 8 months ago | |
| store.ts | 9 months ago | |
| tsconfig.json | 1 year ago | |
| types.ts | 7 months ago | |
| utility-types.ts | 11 months ago | |
| utils.ts | 9 months ago | |
| vite-env.d.ts | 7 months ago | |
| zindex.ts | 9 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
Integration
Head over to the docs
API
Head over to the docs
Contributing
Head over to the docs