4f0a2a9593
* move the existing example to with-script-in-browser * Add example with next js app router * disable ssr for excalidraw client comp * typo * update output dir * don't include nextjs example in tsconfig * remove meta.json * lint * remove example.ts * port * move the examples outside packages and use the deps as workspaces in examples * update gitignore * fix example * update path of build dir * fix * fix scripts * try local path * fix * update commands * fix * fix * fix script * skip ts * disable ts * add vercel.json * install * update tsconfig * fix lint * remove console.log * lets see if this works * revert * remove ts nocheck * add types and some utils in nextjs example * fix types * updatw example and remove nextjs dynamic syntax so we don't import excal twice * move both examples to workspaces and create generic example to be used by browser and next js both * copy the static assets to nextjs * fix ts config * render custom menu items * fix custom footer * fix types in browser example * use regular imports for importing excal and import it using dynamic next js in app router instead * Add example for pages router * fix css discrepancies * fix css * configure output dir * fix * fix css * rename to with-nextjs * move components to examples/excalidraw/components |
1 year ago | |
|---|---|---|
| .. | ||
| actions | 1 year ago | |
| assets | 1 year ago | |
| components | 1 year ago | |
| context | 1 year ago | |
| css | 1 year ago | |
| data | 1 year ago | |
| element | 1 year ago | |
| hooks | 1 year ago | |
| locales | 1 year ago | |
| renderer | 1 year ago | |
| scene | 1 year ago | |
| tests | 1 year ago | |
| .gitignore | 1 year ago | |
| .size-limit.json | 1 year ago | |
| CHANGELOG.md | 1 year ago | |
| README.md | 1 year ago | |
| align.ts | 1 year ago | |
| analytics.ts | 1 year ago | |
| animated-trail.ts | 1 year ago | |
| animation-frame-handler.ts | 1 year ago | |
| appState.ts | 1 year ago | |
| charts.test.ts | 1 year ago | |
| charts.ts | 1 year ago | |
| clients.ts | 1 year ago | |
| clipboard.test.ts | 1 year ago | |
| clipboard.ts | 1 year ago | |
| colors.ts | 1 year ago | |
| constants.ts | 1 year ago | |
| css.d.ts | 1 year ago | |
| cursor.ts | 1 year ago | |
| distribute.ts | 1 year ago | |
| emitter.ts | 1 year ago | |
| env.cjs | 1 year ago | |
| errors.ts | 1 year ago | |
| frame.test.tsx | 1 year ago | |
| frame.ts | 1 year ago | |
| ga.ts | 1 year ago | |
| gadirections.ts | 1 year ago | |
| galines.ts | 1 year ago | |
| gapoints.ts | 1 year ago | |
| gatransforms.ts | 1 year ago | |
| gesture.ts | 1 year ago | |
| global.d.ts | 1 year ago | |
| groups.ts | 1 year ago | |
| history.ts | 1 year ago | |
| i18n.ts | 1 year ago | |
| index-node.ts | 1 year ago | |
| index.tsx | 1 year ago | |
| jotai.ts | 1 year ago | |
| keys.ts | 1 year ago | |
| laser-trails.ts | 1 year ago | |
| math.test.ts | 1 year ago | |
| math.ts | 1 year ago | |
| package.json | 1 year ago | |
| points.ts | 1 year ago | |
| polyfill.ts | 1 year ago | |
| pwacompat.d.ts | 1 year ago | |
| random.ts | 1 year ago | |
| react-app-env.d.ts | 1 year ago | |
| reactUtils.ts | 1 year ago | |
| shapes.tsx | 1 year ago | |
| snapping.ts | 1 year ago | |
| tsconfig.json | 1 year ago | |
| types.ts | 1 year ago | |
| utility-types.ts | 1 year ago | |
| utils.ts | 1 year ago | |
| vite-env.d.ts | 1 year ago | |
| zindex.ts | 1 year 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