docs: Release @excalidraw/excalidraw@0.5.0 🎉 (#3289)
* docs: Release @excalidraw/excalidraw@0.5.0 * update changelog * update readme * remove styles since github strips the styles in markdown
This commit is contained in:
parent
7ee8de0a46
commit
86bf2d697d
@ -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.
|
Please add the latest change on the top under the correct section.
|
||||||
-->
|
-->
|
||||||
|
|
||||||
## Unreleased
|
## 0.5.0 (2021-03-21)
|
||||||
|
|
||||||
## Excalidraw API
|
## 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` is renamed to `theme--dark`.
|
||||||
- The class `Appearance_dark-background-none` is renamed to `theme--dark-background-none`.
|
- 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)
|
## 0.4.3 (2021-03-12)
|
||||||
|
@ -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).
|
[Try here](https://codesandbox.io/s/excalidraw-ehlz3).
|
||||||
|
|
||||||
### Usage
|
<details id="usage">
|
||||||
|
<summary><strong>Usage</strong></summary>
|
||||||
|
|
||||||
1. If you are using a Web bundler (for instance, Webpack), you can import it as an ES6 module as shown below
|
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)
|
[![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:
|
2. To use it in a browser directly:
|
||||||
@ -341,6 +344,8 @@ const excalidrawWrapper = document.getElementById("app");
|
|||||||
ReactDOM.render(React.createElement(App), excalidrawWrapper);
|
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)
|
[![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.
|
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
|
</details>
|
||||||
|
|
||||||
|
<details id="props">
|
||||||
|
<summary><strong>Props</strong></summary>
|
||||||
|
|
||||||
| Name | Type | Default | Description |
|
| 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.
|
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
|
</details>
|
||||||
|
|
||||||
|
<details id="extra-apis">
|
||||||
|
<summary><strong>Extra API's</strong></summary>
|
||||||
|
|
||||||
#### `getSceneVersion`
|
#### `getSceneVersion`
|
||||||
|
|
||||||
@ -584,6 +595,9 @@ import { getElementsMap } from "@excalidraw/excalidraw";
|
|||||||
|
|
||||||
This function returns an object where each element is mapped to its id.
|
This function returns an object where each element is mapped to its id.
|
||||||
|
|
||||||
|
<details id="restore-utils">
|
||||||
|
<summary><strong>Restore utilities</strong></summary>
|
||||||
|
|
||||||
#### `restoreAppState`
|
#### `restoreAppState`
|
||||||
|
|
||||||
**_Signature_**
|
**_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)
|
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)_**
|
</details>
|
||||||
|
|
||||||
<details id="export-utils">
|
<details id="export-utils">
|
||||||
<summary><strong>Export utilities</strong></summary>
|
<summary><strong>Export utilities</strong></summary>
|
||||||
@ -721,3 +735,4 @@ This function returns a svg with the exported elements.
|
|||||||
| exportWithDarkMode | boolean | false | Indicates whether to export with dark mode |
|
| exportWithDarkMode | boolean | false | Indicates whether to export with dark mode |
|
||||||
|
|
||||||
</details>
|
</details>
|
||||||
|
</details>
|
||||||
|
@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "@excalidraw/excalidraw",
|
"name": "@excalidraw/excalidraw",
|
||||||
"version": "0.4.3",
|
"version": "0.5.0",
|
||||||
"main": "dist/excalidraw.min.js",
|
"main": "dist/excalidraw.min.js",
|
||||||
"files": [
|
"files": [
|
||||||
"dist/*"
|
"dist/*"
|
||||||
|
Loading…
x
Reference in New Issue
Block a user