69 KiB
Changelog
Unreleased
Excalidraw API
Features
-
Export API to set and reset mouse cursor on the canvas #5215.
-
Export
sceneCoordsToViewportCoords
andviewportCoordsToSceneCoords
utilities #5187. -
Added
useHandleLibrary
hook to automatically handle importing of libraries when#addLibrary
URL hash key is present, and potentially for initializing library as well #5115.Also added
parseLibraryTokensFromUrl
to help in manually importing library from URL if desired.BREAKING CHANGE
- Libraries are no longer automatically initialized from URL when
#addLibrary
hash key is present. Host apps now need to handle this themselves with the help of either of the above APIs (useHandleLibrary
is recommended).
- Libraries are no longer automatically initialized from URL when
-
Added
updateLibrary
API to update (replace/merge) the library #5115.BREAKING CHANGE
updateScene
API no longer supports passinglibraryItems
. Instead, use theupdateLibrary
API.
-
Add support for integrating custom elements #5164.
- Add
onPointerDown
callback which gets triggered on pointer down events. - Add
onScrollChange
callback which gets triggered when scrolling the canvas. - Add API
setActiveTool
which host can call to set the active tool.
- Add
-
Exported
loadSceneOrLibraryFromBlob
function #5057. -
Export
MIME_TYPES
supported by Excalidraw #5135. -
Support
avatarUrl
for collaborators. Now onwards host can passavatarUrl
to render the customized avatar for collaborators #5114, renamed in #5177. -
Support
libraryItems
argument ininitialData.libraryItems
andupdateScene({ libraryItems })
to be a Promise resolving toLibraryItems
, and support functional update oflibraryItems
inupdateScene({ libraryItems })
. #5101. -
Expose util
mergeLibraryItems
#5101. -
Expose util
exportToClipboard
which allows to copy the scene contents to clipboard assvg
,png
orjson
#5103. -
Expose
window.EXCALIDRAW_EXPORT_SOURCE
which you can use to overwrite thesource
field in exported data #5095. -
The
exportToBlob
utility now supports theexportEmbedScene
option when generating a png image #5047. -
Exported
restoreLibraryItems
API #4995.
Fixes
- Use
window.EXCALIDRAW_ASSET_PATH
for fonts when exporting to svg #5065. - Library menu now properly rerenders if open when library is updated using
updateScene({ libraryItems })
#4995.
Refactor
- Rename
appState.elementLocked
toappState.activeTool.locked
#4983. - Expose
serializeLibraryAsJSON
helper that we use when saving Excalidraw Library to a file.
BREAKING CHANGE
You will need to pass activeTool.locked
instead of elementType
from now onwards in appState
.
- Rename
appState.elementType
toappState.activeTool
which is now an object #4698.
BREAKING CHANGE
You will need to pass activeTool
instead of elementType
from now onwards in appState
Build
- Use only named exports #5045.
BREAKING CHANGE
You will need to import the named export from now onwards to use the component
Using bundler 👇
import { Excalidraw } from "@excalidraw/excalidraw";
In Browser 👇
React.createElement(ExcalidrawLib.Excalidraw, opts);
0.11.0 (2022-02-17)
Excalidraw API
Features
-
Add
onLinkOpen
prop which will be triggered when clicked on element hyperlink if present #4694. -
Support updating library using
updateScene
API #4546. -
Introduced primary colors to the app. The colors can be overridden. Check readme on how to do so #4387.
-
exportToBlob
now automatically setsappState.exportBackground
totrue
if exporting toimage/jpeg
MIME type (to ensure that alpha channel is not compressed to black color) #4342.BREAKING CHANGE
Remove
getElementMap
util #4306. -
Changes to
exportToCanvas
util function #4321:- Add
maxWidthOrHeight?: number
attribute. scale
returned fromgetDimensions()
is now optional (default to1
).
- Add
-
Image support added for host PR
General notes:
- File data are encoded as DataURLs (base64) for portability reasons.
- added
getFiles()
to get currentBinaryFiles
(Record<FileId, BinaryFileData>
). It may contain files that aren't referenced by any element, so if you're persisting the files to a storage, you should compare them against stored elements.
Excalidraw app props:
- added
generateIdForFile(file: File)
optional prop so you can generate your own ids for added files. onChange(elements, appState, files)
prop callback is now passedBinaryFiles
as third argument.onPaste(data, event)
data prop should containdata.files
(BinaryFiles
) if the elements pasted are referencing new files.initialData
object now supports additionalfiles
(BinaryFiles
) attribute.
Other notes:
.excalidraw
files may now contain top-levelfiles
key in format ofRecord<FileId, BinaryFileData>
when exporting any (image) elements.- Changes were made to various export utilities exported from the package so that they take
files
, you can refer to the docs for the same.
-
Export
isLinearElement
andgetNonDeletedElements
#4072. -
Support
renderTopRightUI
in mobile UI #4065. -
Export
THEME
constant from the package so host can use this when passing the theme #4055.BREAKING CHANGE
The
Appearance
type is now removed and renamed toTheme
soTheme
type needs to be used.
Fixes
- Reset
unmounted
state on the component once component mounts to fix the mounting/unmounting repeatedly when used withuseEffect
#4682. - Panning the canvas using
mousewheel-drag
andspace-drag
now prevents the browser from scrolling the container/page #4489. - Scope drag and drop events to Excalidraw container to prevent overriding host application drag and drop events #4445.
Build
- Release preview package @excalidraw/excalidraw-preview when triggered via comment
@excalibot trigger release
-
Added an example to test and develop the package locally using
yarn start
#4488 -
Remove
file-loader
so font assets are not duplicated by webpack and use webpack asset modules for font generation #4380. -
We're now compiling to
es2017
target. Notably,async/await
is not compiled down to generators. #4341.
Excalidraw Library
This section lists the updates made to the excalidraw library and will not affect the integration.
Features
-
Show group/group and link action in mobile #4795
-
Support background fill for freedraw shapes #4610
-
Keep selected tool on canvas reset #4728
-
Make whole element clickable in view mode when it has hyperlink #4735
-
Allow any precision when zooming #4730
-
Throttle
pointermove
events per framerate #4727 -
Support hyperlinks 🔥 #4620
-
Added penMode for palm rejection #4657
-
Support unbinding bound text #4686
-
Sync local storage state across tabs when out of sync #4545
-
Support contextMenuLabel to be of function type to support dynamic labels #4654
-
Support decreasing/increasing
fontSize
via keyboard #4553 -
Link to new LP for excalidraw plus #4549
-
Update stroke color of bounded text along with container #4541
-
Hints and shortcuts help around deep selection #4502
-
Support updating text properties by clicking on container #4499
-
Bind text to shapes when pressing enter and support sticky notes 🎉 #4343
-
Change
boundElementIds
→boundElements
#4404 -
Support selecting multiple points when editing line #4373
-
Horizontally center toolbar menu commit link
-
Add support for rounded corners in diamond #4369
-
Allow zooming up to 3000% #4358
-
Stop discarding precision when rendering #4357
-
Support Image binding #4347
-
Add
element.updated
#4070 -
Compress shareLink data when uploading to json server #4225
-
Supply
version
param when installing libraries #4305 -
Log FS abortError to console #4279
-
Add validation for website and remove validation for library item name #4269
-
Allow publishing libraries from UI #4115
-
Create confirm dialog to use instead of window.confirm #4256
-
Allow letters in IDs for storing files in backend #4224
-
Remove support for V1 unencrypted backend #4189
-
Use separate backend for local storage #4187
-
Add hint around canvas panning #4159
-
Stop using production services for development #4113
-
Add triangle arrowhead #4024
-
Add rewrite to webex landing page #4102
-
Switch collab server #4092
-
Use dialog component for clear canvas instead of window confirm #4075
Fixes
-
Rename --color-primary-chubb to --color-primary-contrast-offset and fallback to primary color if not present #4803
-
Add commits directly pushed to master in changelog #4798
-
Don't bump element version when adding files data #4794
-
Mobile link click #4742
-
ContextMenu timer & pointers not correctly reset on iOS #4765
-
Use absolute coords when rendering link popover #4753
-
Changing font size when text is not selected or edited #4751
-
Disable contextmenu on non-secondary
pen
events ortouch
#4675 -
Mobile context menu won't show on long press #4741
-
Do not open links twice #4738
-
Make link icon clickable in mobile #4736
-
Apple Pen missing strokes #4705
-
Freedraw slow movement jittery lines #4726
-
Disable three finger pinch zoom in penMode #4725
-
Remove click listener for opening popup #4700
-
Link popup position not accounting for offsets #4695
-
PenMode darkmode style #4692
-
Typing
_+
in wysiwyg not working #4681 -
Keyboard-zooming in wysiwyg should zoom canvas #4676
-
SceneCoordsToViewportCoords, jumping text when there is an offset #4413 (#4630)
-
Right-click object menu displays partially off-screen #4572 (#4631)
-
Support collaboration in bound text #4573
-
Cmd/ctrl native browser behavior blocked in inputs #4589
-
Use cached width when calculating min width during resize #4585
-
Support collaboration in bounded text #4580
-
Port for collab server and update docs #4569
-
Don't mutate the bounded text if not updated when submitted #4543
-
Prevent canvas drag while editing text #4552
-
Support shift+P for freedraw #4550
-
Prefer spreadsheet data over image #4533
-
Show text properties button states correctly for bounded text #4542
-
Rotate bounded text when container is rotated before typing #4535
-
Undo should work when selecting bounded textr #4537
-
Reduce padding to 5px for bounded text #4530
-
Bound text doesn't inherit container #4521
-
Check if process is defined before using so it works in browser #4497
-
Pending review fixes for sticky notes #4493
-
Pasted elements except binded text once paste action is complete #4472
-
Don't select binded text when ungrouping #4470
-
Set height correctly when text properties updated while editing in container until first submit #4469
-
Align and distribute binded text in container and cleanup #4468
-
Move binded text when moving container using keyboard #4466
-
Support dragging binded text in container selected in a group #4462
-
Vertically align single line when deleting text in bounded container #4460
-
Update height correctly when updating text properties in binded text #4459
-
Align library item previews to center #4447
-
Vertically center align text when text deleted #4457
-
Vertically center the first line as user starts typing in container #4454
-
Switch cursor to center of container when adding text when dimensions are too small #4452
-
Vertically center align the bounded text correctly when zoomed #4444
-
Support updating stroke color for text by typing in color picker input #4415
-
Bound text not atomic with container when changing z-index #4414
-
Update viewport coords correctly when editing text #4416
-
Use word-break break-word only and update text editor height only when binded to container #4410
-
Husky not able to execute pre-commit on windows #4370
-
Make firebase config parsing not fail on undefined env #4381
-
Adding to library via contextmenu when no image is selected #4356
-
Export scale quality regression #4316
-
Remove
100%
height from tooltip container to fix layout issues #3980 -
Inline ENV variables when building excalidraw package #4311
-
SVG export in dark mode with embedded bitmap image #4285
-
New FS API not working on Linux #4280
-
Url -> URL for consistency #4277
-
Prevent adding images to library via contextMenu #4264
-
Account for libraries v2 when prompting #4263
-
Skia rendering issues #4200
-
Ellipse roughness when
0
#4194 -
Proper string for invalid SVG #4191
-
Images not initialized correctly #4157
-
Image-related fixes #4147
-
Rewrite collab element reconciliation to fix z-index issues #4076
-
Redirect excalidraw.com/about to for-webex.excalidraw.com #4104
-
Redirect to webex LP instead of rewrite to fix SW #4103
-
Clear image/shape cache of affected elements when adding files #4089
-
Clear
LibraryUnit
DOM on unmount #4084 -
Pasting images on firefox #4085
Refactor
Performance
- Cache approx line height in textwysiwg #4651
Build
-
Rename release command to 'release package' #4783
-
Deploy excalidraw package example #4762
-
Allow package.json changes when autoreleasing next #4068
0.10.0 (2021-10-13)
Excalidraw API
Fixes
-
Don't show save file to disk button in export dialog when
saveFileToDisk
passed asfalse
inUIOptions.canvasActions.export
#4073. -
onPaste
prop should return false to prevent the native excalidraw paste action #3974.BREAKING CHANGE
- Earlier the paste action was prevented when the prop
onPaste
returned true, but now it should return false to prevent the paste action. This was done to make it semantically more correct and intuitive.
- Earlier the paste action was prevented when the prop
Build
- Enable jsx transform in webpack #4049
Docs
- Correct exportToBackend in README to onExportToBackend #3952
Excalidraw Library
This section lists the updates made to the excalidraw library and will not affect the integration.
Features
-
Improve freedraw shape #3984
-
Make color ARIA labels better #3871
-
Add origin trial tokens #3853
-
Re-order zoom buttons #3837
-
Add undo/redo buttons & tweak footer #3832
-
Resave to png/svg with metadata if you loaded your scene from a png/svg file #3645
Fixes
-
Abstract and fix legacy fs #4032
-
Context menu positioning #4025
-
Added alert for bad encryption key #3998
-
OnPaste should return false to prevent paste action #3974
-
Help-icon now visible on Safari #3939
-
Permanent zoom mode #3931
-
Undo/redo buttons gap in Safari #3836
-
Prevent gradual canvas misalignment #3833
-
Color picker shortcuts not working when elements selected #3817
0.9.0 (2021-07-10)
Excalidraw API
Features
-
restore(data, localAppState, localElements)
andrestoreElements(elements, localElements)
now takelocalElements
argument which will be used to ensure existing elements' versions are used and incremented. This fixes an issue where importing the same file would resolve to elements with older versions, potentially causing issues when reconciling #3797.BREAKING CHANGE
localElements
argument is mandatory (can benull
/undefined
) if using TypeScript.
-
Support
appState.exportEmbedScene
attribute inexportToSvg
which allows to embed the scene data #3777.BREAKING CHANGE
- The attribute
metadata
is now removed asmetadata
was only used to embed scene data which is now supported with theappState.exportEmbedScene
attribute. exportToSvg
now resolves to a promise which resolves tosvg
of the exported drawing.
- The attribute
-
Expose
loadLibraryFromBlob
,loadFromBlob
, andgetFreeDrawSvgPath
#3764. -
Expose
FONT_FAMILY
so that consumer can use when passinginitialData.appState.currentItemFontFamily
#3710. -
Added prop
autoFocus
to focus the excalidraw component on page load when enabled, defaults to false #3691.Note: Earlier Excalidraw component was focused by default on page load, you need to enable
autoFocus
prop to retain the same behaviour. -
Added prop
UIOptions.canvasActions.export.renderCustomUI
to support Custom UI rendering inside export dialog #3666. -
Added prop
UIOptions.canvasActions.saveAsImage
to show/hide the Save as image button in the canvas actions. Defaults totrue
hence the Save as Image button is rendered #3662. -
Export dialog can be customised with
UiOptions.canvasActions.export
#3658.Also,
UIOptions
is now memoized to avoid unnecessary rerenders.BREAKING CHANGE
UIOptions.canvasActions.saveAsScene
is now renamed toUiOptions.canvasActions.export.saveFileToDisk
. Defaults totrue
hence the save file to disk button is rendered inside the export dialog.exportToBackend
is now renamed toUIOptions.canvasActions.export.exportToBackend
. If this prop is not passed, the shareable-link button will not be rendered, same as before.
Fixes
- Use excalidraw Id in elements so every element has unique id #3696.
Refactor
-
BREAKING CHANGE
- Rename
UIOptions.canvasActions.saveScene
toUIOptions.canvasActions.saveToActiveFile
#3657. - Removed
shouldAddWatermark: boolean
attribute from options for export APIs #3639. - Removed
appState.shouldAddWatermark
so in case you were passingshouldAddWatermark
in initialData.AppState it will not work anymore.
- Rename
Excalidraw Library
This section lists the updates made to the excalidraw library and will not affect the integration.
Features
-
Switch to selection tool on library item insert #3773
-
Show active file name when saving to current file #3733
-
Add hint around text editing #3708
-
Change library icon to be more clear #3583
-
Pass current
theme
when installing libraries #3701 -
Update virgil font #3692
-
Support exporting json to excalidraw plus #3678
-
Save exportScale in AppState #3580
-
Add shortcuts for stroke and background color picker #3318
-
Exporting redesign #3613
-
Auto-position tooltip and support overflowing container #3631
-
Auto release @excalidraw/excalidraw-next on every change #3614
-
Allow inner-drag-selecting with cmd/ctrl #3603
Fixes
-
view mode cursor adjustments #3809.
-
Pass next release to updatePackageVersion & replace ## unreleased with new version #3806
-
Include deleted elements when passing to restore #3802
-
Import React before using jsx #3804
-
Ensure
s
andg
shortcuts work on no selection #3800 -
Keep binding for attached arrows after changing text #3754
-
Deselect elements on viewMode toggle #3741
-
Allow pointer events for disable zen mode button #3743
-
Use rgba instead of shorthand alpha #3688
-
Color pickers not opening on mobile #3676
-
On contextMenu, use selected element regardless of z-index #3668
-
SelectedGroupIds not being stored in history #3630
-
Overscroll on touch devices #3663
-
Small UI issues around image export dialog #3642
-
Normalize linear element points on restore #3633
-
Disable pointer-events on footer-center container #3629
Refactor
Performance
- Improve arrow head sizing #3480
Build
-
Add release script to update relevant files and commit for next release #3805
-
Add script to update changelog before a stable release #3784
-
Add script to update readme before stable release #3781
0.8.0 (2021-05-15)
Excalidraw API
These section lists the updates which may affect your integration, so it is recommended to go through this when upgrading the version.
Features
-
Support updating any
appState
properties inupdateScene
API. Earlier onlyappState.viewBackgroundColor
was supported, now any attribute can be updated with this API. -
Expose
serializeAsJSON
helper that we use when saving Excalidraw scene to a file #3538. -
Add support to render custom UI in the top right corner via
renderTopRightUI
prop #3539, #3572 .This also removes the GitHub icon, keeping it local to the https://excalidraw.com app.
Fixes
-
The encryption shield icon is now removed from excalidraw package as it was specific to excalidraw app and is now rendered via
renderFooter
prop. In case you were hiding this icon earlier, you need not do that anymore #3577.Now
appState
is also passed torenderFooter
prop.
Excalidraw Library
These section lists the updates made to the excalidraw library and will not affect the integration.
Features
- Shortcut key for nerd stats #3552.
- Better rendering of curved rectangles #3562.
- Improved freedraw #3512.
- Add shortcut for dark mode #3543.
- Adds rounded icons, joins and caps.#3521.
Fixes
- Exporting freedraw with color to svg #3565.
- Handle render errors #3557.
- Restore on paste or lib import #3558.
- Improve mobile user experience #3508.
- Prevent selecting
.visually-hidden
elements #3501.
Perf
- Reduce SVG export size by more than half by reducing precision to 2 decimal places #3567.
- Remove
backdrop-filter
to improve perf #3506
0.7.0 (2021-04-26)
Excalidraw API
Features
-
scrollToContent
API now supports passing just a single Excalidraw element, or none at all (which will default to current elements on the scene) #3482.BREAKING CHANGE
- Renamed
setScrollToContent
toscrollToContent
.
- Renamed
-
Make library local to given excalidraw instance (previously, all instances on the same page shared one global library) #3451.
-
Added prop onLibraryChange which if supplied will be called when library is updated.
-
Added attribute
libraryItems
to prop initialData which can be used to load excalidraw with existing library items. -
Assign a unique id to the excalidraw component. The id can be accessed via
ref
.
BREAKING CHANGE
- From now on the host application is responsible for persisting the library to LocalStorage (or elsewhere), and importing it on mount.
-
-
Bind the keyboard events to component and added a prop
handleKeyboardGlobally
which if set to true will bind the keyboard events to document #3430.BREAKING CHANGE
- Earlier keyboard events were bind to document but now its bind to Excalidraw component by default. So you will need to set
handleKeyboardGlobally
to true if you want the previous behaviour (bind the keyboard events to document).
- Earlier keyboard events were bind to document but now its bind to Excalidraw component by default. So you will need to set
-
Recompute offsets on
scroll
of the nearest scrollable container #3408. This can be disabled by settingdetectScroll
tofalse
. -
Add
onPaste
prop to handle custom clipboard behaviours #3420.
Fixes
-
Changing z-index of elements (sorting them below/above other elements) now updates their
version
andversionNonce
(only applies to the selected elements). This fix will allow you account for z-index changes if you're syncing just the elements that changed (and not the whole scene) #3483. -
Only handle cut/paste events inside excalidraw #3484.
-
Make history local to a given Excalidraw instance. This fixes a case where history was getting shared when you have multiple Excalidraw components on the same page #3481.
-
Use active Excalidraw component when editing text. This fixes a case where text editing was not working when you have multiple Excalidraw components on the same page #3478.
-
Fix library being pasted off-center #3462.
-
When switching theme, apply it only to the active Excalidraw component. This fixes a case where the theme was getting applied to the first Excalidraw component if you had multiple Excalidraw components on the same page #3446.
Refactor
-
BREAKING CHANGE
-
Removed exposing
getSyncableElements
helper which was specific to excalidraw app collab implementation #3471. If you happened to use it, you can easily reimplement it yourself using the newly exposed isInvisiblySmallElement helper:const getSyncableElements = (elements: readonly ExcalidrawElement[]) => elements.filter((el) => el.isDeleted || !isInvisiblySmallElement(el));
-
Build
- Add vendor prefixes to css rules #3476.
Types
- Renamed the following types in case you depend on them (via #3427):
DataState
→ExportedDataState
LibraryData
→ExportedLibraryData
Excalidraw Library
Features
-
Support tab-to-indent when editing text #3411.
-
App now breaks into mobile view using the component dimensions, not viewport dimensions. This fixes a case where the app would break sooner than necessary when the component's size is smaller than viewport #3414.
-
Add screenshots to manifest.json #3369.
-
Enable drop event on the whole component #3406.
Fixes
-
Focus on last active element when dialog closes #3447.
-
Fix incorrectly caching png file handle #3407.
-
Fix popover position incorrect on Safari for non-zero offsets/scroll #3399.
0.6.0 (2021-04-04)
Excalidraw API
Features
- Add
UIOptions
prop to customisecanvas actions
which includes customisingbackground color picker
,clear canvas
,export
,load
,save
,save as
&theme toggle
#3364. Check the readme for more details. - Calculate
width/height
of canvas based on excalidraw component (".excalidraw" selector) & also resize and update offsets whenever the dimensions of excalidraw component gets updated #3379. You also don't need to add a resize handler anymore for excalidraw as its handled now in excalidraw itself.BREAKING CHANGE
width/height
props have been removed. Instead now it takes100%
ofwidth
andheight
of the container so you need to make sure the container in which you are rendering Excalidraw has non zero dimensions (It should have non zero width and height so Excalidraw can match the dimensions of containing block)
- Calculate offsets when excalidraw container resizes using resize observer api #3374.
- Export types for the package so now it can be used with typescript #3337. The types are available at
@excalidraw/excalidraw/types
. - Add
renderCustomStats
prop to render extra stats on host, and exposesetToastMessage
API via refs which can be used to show toast with custom message #3360. - Support passing a CSRF token when importing libraries to prevent prompting before installation. The token is passed from https://libraries.excalidraw.com using the
token
URL key #3329. -
BREAKING CHANGE
Uselocation.hash
when importing libraries to fix installation issues. This will require host apps to add ahashchange
listener and call the newly exposedexcalidrawAPI.importLibrary(url)
API when applicable #3320. Check the readme for more details. - Append
location.pathname
tolibraryReturnUrl
default url #3325. - Support image elements #3424.
Build
- Expose separate builds for dev and prod and support source maps in dev build #3330. Check the readme for more details.
BREAKING CHANGE
- If you are using script tag to embed excalidraw then the name of the file will have to be updated to
excalidraw.production.min.js
instead ofexcalidraw.min.js
. If you want to use dev build you can useexcalidraw.development.js
- If you are using script tag to embed excalidraw then the name of the file will have to be updated to
Refactor
BREAKING CHANGE
Excalidraw Library
Features
- Reopen library menu on import from file #3383.
- Don't unnecessarily prompt when installing libraries #3329.
- Add option to flip single element on the context menu #2520.
- Replace fontSize and fontFamily text with icons #2857.
Fixes
- Export dialog canvas positioning #3397.
- Don't share collab types with core #3353.
- Support d&d of files without extension #3168.
- Positions stats for linear elements #3331.
- Debounce.flush invokes func even if never queued before #3326.
- State selection state on opening contextMenu #3333.
- Add unique key for library header to resolve dev warnings #3316.
- disallow create text in viewMode on mobile #3219.
- Make help toggle tabbable #3310
- Show Windows share icon for Windows users #3306.
- Don't scroll to content on INIT websocket message #3291.
Refactor
- Use arrow function where possible #3315.
0.5.0 (2021-03-21)
Excalidraw API
Features
- Set the target to
window.name
if present during excalidraw libraries installation so it opens in same tab for the host. Ifwindow.name
is not set it will open in a new tab #3299. - Add
name
prop to indicate the name of the drawing which will be used when exporting the drawing. When supplied, the value takes precedence overintialData.appState.name
, thename
will be fully controlled by host app and the users won't be able to edit from within Excalidraw #3273. - Export API
setCanvasOffsets
viaref
to set the offsets for Excalidraw#3265.BREAKING CHANGE
offsetLeft
andoffsetTop
props have been removed now so you have to use thesetCanvasOffsets
viaref
to achieve the same.
- Export API to export the drawing to canvas, svg and blob #3258. For more info you can check the readme
- Add a
theme
prop to indicate Excalidraw's theme. #3228. When this prop is passed, the theme is fully controlled by host app. - Support
libraryReturnUrl
prop to indicate what URL to install libraries to #3227.
Refactor
-
BREAKING CHANGE
- Rename prop
initialData.scrollToCenter
andsetScrollToCenter
API exposed via ref toinitialData.scrollToContent
andsetScrollToContent
respectively#3261.
- Rename prop
- Rename appearance to theme #3237.
BREAKING CHANGE
- Since
appState.appearance
is renamed toappState.theme
so whereverappState.appearance
includinginitialData.appState.appearance
should be renamed toappState.theme
andinitialData.appState.theme
respectively. If theappearance
was persisted earlier, now it needs to passed astheme
. - The class
Appearance_dark
is renamed totheme--dark
. - The class
Appearance_dark-background-none
is renamed totheme--dark-background-none
.
- Since
Excalidraw Library
Features
- Support pasting file contents & always prefer system clip #3257
- Add label for name field and use input when editable in export dialog #3286
- Implement the Web Share Target API #3230.
Fixes
- Don't show export and delete when library is empty #3288
- Overflow in textinput in export dialog #3284.
- Bail on noop updates for newElementWith #3279.
- Prevent State continuously updated when holding ctrl/cmd #3283
- Debounce flush not invoked if lastArgs not defined #3281.
- Stop preventing canvas pointerdown/tapend events #3207.
- Double scrollbar on modals #3226.
0.4.3 (2021-03-12)
Excalidraw API
Fixes
- Allow copy of excalidraw elements only when inside excalidraw #3206.
- Position text editor absolute and fix the offsets so it doesn't remain fixed when the container is scrolled #3200.
- Scope CSS variables so that host CSS vars don't clash with excalidraw #3199.
Excalidraw Library
- Apply correct translation when text editor overflows when zoom not 100% #3225
- Don't overflow text beyond width of Excalidraw #3215.
0.4.2
Excalidraw API
Fixes
- Wrap excalidraw in position relative so host need not do it anymore & hide scrollbars in zen mode #3174.
- Reduce the scroll debounce timeout to
100ms
sooffsets
gets updated faster if changed when container scrolled #3182. - Rerender UI on
renderFooter
prop change #3183
Excalidraw Library
Fixes
- Temporarily downgrade browser-fs-access to fix legacy FS API #3172
0.4.1
Excalidraw API
Fixes
- Use
Array.from
when spreading over set so that typescript transpiles correctly in the umd build#3165.
Excalidraw Library
Features
- Add export info on copy PNG to clipboard toast message #3159.
- Use the latest version of Virgil #3124.
- Support exporting with dark mode #3046.
Fixes
0.4.0
Excalidraw API
Features
-
Expose
window.EXCALIDRAW_ASSET_PATH
which host can use to load assets from a different URL. By default it will be loaded fromhttps://unpkg.com/@excalidraw/excalidraw{currentVersion}/dist/
#3068.Also now the assets will have a hash in filename so cache bursting can easily happen with version bump.
-
Add support for
scrollToCenter
in initialData so host can control whether to scroll to center on mount #3070. -
Export
restore
,restoreAppState
andrestoreElements
to host #3049
Fixes
Excalidraw Library
Features
- Adjust line-confirm-threshold based on zoom #2884
Fixes
- Hide scrollbars on mobile #3044
0.3.1
Excalidraw API
Fixes
- Support Excalidraw inside scrollable container #3018
Excalidraw Library
Fixes
- Allow to toggle between modes when view only mode to make UI consistent #3009
0.3.0
Excalidraw API
Features
- Allow host to pass color for collaborator #2943. The unused prop
user
is now removed. - Add
zenModeEnabled
andgridModeEnabled
prop which enables zen mode and grid mode respectively #2901. When this prop is used, the zen mode / grid mode will be fully controlled by the host app. - Allow host to pass userState for collaborator to show the current user state #2877.
- Add
viewModeEnabled
prop which enabled the view mode #2840. When this prop is used, the view mode will not show up in context menu is so it is fully controlled by host. - Expose
getAppState
onexcalidrawRef
#2834.
Build
- Remove publicPath so host can use
__webpack_public_path__
to host the assets#2835
Excalidraw Library
Features
- Add the ability to clear library #2997
- Updates to Collaboration and RTL UX #2994
- Show toast when saving to existing file #2988
- Support supplying custom scale when exporting canvas #2904
- Show version in the stats dialog #2908
- Add idle detection to collaboration feature #2877
- Add view mode in Excalidraw #2840
- Increase max zoom #2881
- Remove copy & paste from context menu on desktop #2872
- Add separators on context menu #2659
- Add ctrl-y to redo #2831
- Add view mode #2840.
- Remove
copy
,cut
, andpaste
actions from contextmenu #2872 - Support
Ctrl-Y
shortcut to redo on Windows #2831.
Fixes
- Refresh wysiwyg position on canvas resize #3008
- Update the
lang
attribute with the current lang. #2995 - Rename 'Grid mode' to 'Show grid' #2944
- Deal with users on systems that don't handle emoji #2941
- Mobile toolbar tooltip regression #2939
- Hide collaborator list on mobile if empty #2938
- Toolbar unnecessarily eats too much width #2924
- Mistakenly hardcoding scale #2925
- Text editor not visible in dark mode #2920
- Incorrect z-index of text editor #2914
- Make scrollbars draggable when offsets are set #2916
- Pointer-events being disabled on free-draw #2912
- Track zenmode and grid mode usage #2900
- Disable UI pointer-events on canvas drag #2856
- Stop flooring scroll positions #2883
- Apply initialData appState for zenmode and grid stats and refactor check param for actions #2871
- Show correct state of Nerd stats in context menu when nerd stats dialog closed #2874
- Remote pointers not accounting for offset #2855
- Toggle help dialog when "shift+?" is pressed #2828
- Add safe check for process so Excalidraw can be loaded via script #2824
- Fix UI pointer-events not disabled when dragging on canvas #2856.
- Fix remote pointers not accounting for offset #2855.
Refactor
- Remove duplicate key handling #2878
- Reuse scss variables in js for SSOT #2867
- Rename browser-nativefs to browser-fs-access #2862
- Rewrite collabWrapper to remove TDZs and simplify #2834
Chore
- Use
Sentence case
forLive collaboration
0.2.1
Excalidraw API
Build
- Bundle css files with js #2819. The host would not need to import css files separately.
0.2.0
Excalidraw API
Features
-
Exported few Extra API's which can be used by the host to communicate with Excalidraw.
-
Remove language picker, and add
langCode
,renderFooter
#2644:- BREAKING: removed the language picker from UI. It is now the host app's responsibility to implement a language picker if desirable, using the newly added
renderFooter
prop. The reasoning is that the i18n should be controlled by the app itself, not by the nested Excalidraw component. - Added
langCode
prop to control the UI language.
- BREAKING: removed the language picker from UI. It is now the host app's responsibility to implement a language picker if desirable, using the newly added
-
Add support for
exportToBackend
prop to allow host apps to implement shareable links #2612
Fixes
- Hide collaboration button when the prop
onCollabButtonClick
is not provided #2598
Excalidraw Library
Features
- Add toast #2772
- Add
cmd+o
shortcut to load scene #2732 - Require use of a preset dialog size; adjust dialog sizing #2684
- Add line chart and paste dialog selection #2670
- Tweak editing behavior #2668
- Change title to Excalidraw after a timeout
- Checkmark to toggle context-menu-items #2645
- Add zoom to selection #2522
- Insert Library items in the middle of the screen #2527
- Show shortcut context menu #2501
- Aligns arrowhead schemas #2517
- Add Cut to menus #2511
- More Arrowheads: dot, bar #2486
- Support CSV graphs and improve the look and feel #2495
Fixes
- Fix compile error #2685
- Center zoom on iPhone and iPad #2642
- Allow text-selecting in dialogs & reset cursor #2783
- Don't render due to zoom after unmount #2779
- Track the chart type correctly #2773
- Fix late-render due to debounced zoom #2779
- Fix initialization when browser tab not focused #2677
- Consistent case for export locale strings #2622
- Remove unnecessary console.error as it was polluting Sentry #2637
- Fix scroll-to-center on init for non-zero canvas offsets #2445
- Fix resizing the pasted charts #2586
- Fix element visibility and zoom on cursor when canvas offset isn't 0. #2534
- Fix Library Menu Layout #2502
- Support number with commas in charts #2636
- Don't break zoom when zooming in on UI #2638
Improvements
- Added Zen Mode to the context menu #2734
- Do not reset to selection for draw tool [#2721]((https://github.com/excalidraw/excalidraw/pull/2721)
- Make dialogs look more like dialogs #2686
- Browse libraries styles fixed #2694
- Change hint for 2-point lines on resize #2655
- Align items in context menu #2640
- Do not reset to selection when using the draw tool #2721
- Display proper tooltip for 2-point lines during resize, and normalize modifier key labels in hints #2655
- Improve error message around importing images #2619
- Add tooltip with icon for embedding scenes #2532
- RTL support for the stats dialog #2530
- Expand canvas padding based on zoom. #2515
- Hide shortcuts on pickers for mobile #2508
- Hide stats and scrollToContent-button when mobile menus open #2509
Refactor
- refactor: Converting span to kbd tag #2774
- Media queries #2680
- Remove duplicate entry from en.json#2654
- Remove the word toggle from labels #2648
Docs
- Document some of the more exotic element props #2673
0.1.1
Fix
- Update the homepage URL so it redirects to correct readme #2498
0.1.0
First release of @excalidraw/excalidraw