From 86bf2d697d5824c22be9945f875722efc8b96041 Mon Sep 17 00:00:00 2001 From: Aakansha Doshi Date: Sun, 21 Mar 2021 19:19:09 +0530 Subject: [PATCH] =?UTF-8?q?docs:=20Release=20@excalidraw/excalidraw@0.5.0?= =?UTF-8?q?=20=F0=9F=8E=89=20=20(#3289)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * docs: Release @excalidraw/excalidraw@0.5.0 * update changelog * update readme * remove styles since github strips the styles in markdown --- src/packages/excalidraw/CHANGELOG.md | 20 +++++++++++++++++++- src/packages/excalidraw/README.md | 23 +++++++++++++++++++---- src/packages/excalidraw/package.json | 2 +- 3 files changed, 39 insertions(+), 6 deletions(-) diff --git a/src/packages/excalidraw/CHANGELOG.md b/src/packages/excalidraw/CHANGELOG.md index 027702cb..1e4b54f5 100644 --- a/src/packages/excalidraw/CHANGELOG.md +++ b/src/packages/excalidraw/CHANGELOG.md @@ -12,7 +12,7 @@ The change should be grouped under one of the below section and must contain PR Please add the latest change on the top under the correct section. --> -## Unreleased +## 0.5.0 (2021-03-21) ## Excalidraw API @@ -37,6 +37,24 @@ Please add the latest change on the top under the correct section. - The class `Appearance_dark` is renamed to `theme--dark`. - The class `Appearance_dark-background-none` is renamed to `theme--dark-background-none`. +## Excalidraw Library + +### Features + +- Support pasting file contents & always prefer system clip [#3257](https://github.com/excalidraw/excalidraw/pull/3257) +- Add label for name field and use input when editable in export dialog [#3286](https://github.com/excalidraw/excalidraw/pull/3286) +- Implement the Web Share Target API [#3230](https://github.com/excalidraw/excalidraw/pull/3230). + +### Fixes + +- Don't show export and delete when library is empty [#3288](https://github.com/excalidraw/excalidraw/pull/3288) +- Overflow in textinput in export dialog [#3284](https://github.com/excalidraw/excalidraw/pull/3284). +- Bail on noop updates for newElementWith [#3279](https://github.com/excalidraw/excalidraw/pull/3279). +- Prevent State continuously updated when holding ctrl/cmd #3283 +- Debounce flush not invoked if lastArgs not defined [#3281](https://github.com/excalidraw/excalidraw/pull/3281). +- Stop preventing canvas pointerdown/tapend events [#3207](https://github.com/excalidraw/excalidraw/pull/3207). +- Double scrollbar on modals [#3226](https://github.com/excalidraw/excalidraw/pull/3226). + --- ## 0.4.3 (2021-03-12) diff --git a/src/packages/excalidraw/README.md b/src/packages/excalidraw/README.md index 8f25491f..59c04671 100644 --- a/src/packages/excalidraw/README.md +++ b/src/packages/excalidraw/README.md @@ -28,7 +28,8 @@ If you want to load assets from a different path you can set a variable `window. [Try here](https://codesandbox.io/s/excalidraw-ehlz3). -### Usage +
+Usage 1. If you are using a Web bundler (for instance, Webpack), you can import it as an ES6 module as shown below @@ -163,6 +164,8 @@ export default function App() { } ``` +To view the full example visit :point_down: + [![Edit excalidraw](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/excalidraw-ehlz3?fontsize=14&hidenavigation=1&theme=dark) 2. To use it in a browser directly: @@ -341,6 +344,8 @@ const excalidrawWrapper = document.getElementById("app"); ReactDOM.render(React.createElement(App), excalidrawWrapper); ``` +To view the full example visit :point_down: + [![Edit excalidraw-in-browser](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/excalidraw-in-browser-tlqom?fontsize=14&hidenavigation=1&theme=dark) Since Excalidraw doesn't support server side rendering yet so you will have to make sure the component is rendered once host is mounted. @@ -356,7 +361,10 @@ export default function IndexPage() { } ``` -### Props +
+ +
+Props | Name | Type | Default | Description | | --- | --- | --- | --- | @@ -539,7 +547,10 @@ This prop controls Excalidraw's theme. When supplied, the value takes precedence This prop sets the name of the drawing which will be used when exporting the drawing. When supplied, the value takes precedence over `intialData.appState.name`, the `name` will be fully controlled by host app and the users won't be able to edit from within Excalidraw. -### Extra API's +
+ +
+Extra API's #### `getSceneVersion` @@ -584,6 +595,9 @@ import { getElementsMap } from "@excalidraw/excalidraw"; This function returns an object where each element is mapped to its id. +
+Restore utilities + #### `restoreAppState` **_Signature_** @@ -632,7 +646,7 @@ import { restore } from "@excalidraw/excalidraw"; This function makes sure elements and state is set to appropriate values and set to default value if not present. It is combination of [restoreElements](#restoreElements) and [restoreAppState](#restoreAppState) -**_The below APIs will be available in [next version](https://github.com/excalidraw/excalidraw/blob/master/src/packages/excalidraw/CHANGELOG.md#unreleased)_** +
Export utilities @@ -721,3 +735,4 @@ This function returns a svg with the exported elements. | exportWithDarkMode | boolean | false | Indicates whether to export with dark mode |
+
diff --git a/src/packages/excalidraw/package.json b/src/packages/excalidraw/package.json index ae1b7c33..af76511d 100644 --- a/src/packages/excalidraw/package.json +++ b/src/packages/excalidraw/package.json @@ -1,6 +1,6 @@ { "name": "@excalidraw/excalidraw", - "version": "0.4.3", + "version": "0.5.0", "main": "dist/excalidraw.min.js", "files": [ "dist/*"