From 5da320763347e6a9cf8f68a5141aed868ae2a33f Mon Sep 17 00:00:00 2001 From: Pim Otte Date: Mon, 30 Aug 2021 10:46:44 +0200 Subject: [PATCH] docs: correct exportToBackend to onExportToBackend in README (#3952) * docs: correct exportToBackend to onExportToBackend in README * Update changelog with link to PR * Add Excalidraw API title to changelog section Co-authored-by: Aakansha Doshi Co-authored-by: Aakansha Doshi --- src/packages/excalidraw/CHANGELOG.md | 6 ++++++ src/packages/excalidraw/README.md | 2 +- src/packages/excalidraw/README_NEXT.md | 2 +- 3 files changed, 8 insertions(+), 2 deletions(-) diff --git a/src/packages/excalidraw/CHANGELOG.md b/src/packages/excalidraw/CHANGELOG.md index 177f0ed4..b3ba79f8 100644 --- a/src/packages/excalidraw/CHANGELOG.md +++ b/src/packages/excalidraw/CHANGELOG.md @@ -19,6 +19,12 @@ Please add the latest change on the top under the correct section. - Prevent gradual misalignment of the canvas due to floating point rounding errors [#3833](https://github.com/excalidraw/excalidraw/pull/3833). +## Excalidraw API + +### Docs + +- Correct exportToBackend in README to onExportToBackend [#3952](https://github.com/excalidraw/excalidraw/pull/3952) + ## 0.9.0 (2021-07-10) ## Excalidraw API diff --git a/src/packages/excalidraw/README.md b/src/packages/excalidraw/README.md index dce5de1c..bfa35b81 100644 --- a/src/packages/excalidraw/README.md +++ b/src/packages/excalidraw/README.md @@ -591,7 +591,7 @@ The below attributes can be set in `UIOptions.canvasActions.export` to customize | Attribute | Type | Default | Description | | --- | --- | --- | --- | | `saveFileToDisk` | boolean | true | Implies if save file to disk button should be shown | -| `exportToBackend` | 
 (exportedElements: readonly NonDeletedExcalidrawElement[],appState: AppState,canvas: HTMLCanvasElement | null) => void
| | This callback is triggered when the shareable-link button is clicked in the export dialog. The link button will only be shown if this callback is passed. | +| `onExportToBackend` | 
 (exportedElements: readonly NonDeletedExcalidrawElement[],appState: AppState,canvas: HTMLCanvasElement | null) => void
| | This callback is triggered when the shareable-link button is clicked in the export dialog. The link button will only be shown if this callback is passed. | | `renderCustomUI` | 
 (exportedElements: readonly NonDeletedExcalidrawElement[],appState: AppState,canvas: HTMLCanvasElement | null) => void
| | This callback should be supplied if you want to render custom UI in the export dialog. | #### `onPaste` diff --git a/src/packages/excalidraw/README_NEXT.md b/src/packages/excalidraw/README_NEXT.md index 6f19f077..b210a7cb 100644 --- a/src/packages/excalidraw/README_NEXT.md +++ b/src/packages/excalidraw/README_NEXT.md @@ -597,7 +597,7 @@ The below attributes can be set in `UIOptions.canvasActions.export` to customize | Attribute | Type | Default | Description | | --- | --- | --- | --- | | `saveFileToDisk` | boolean | true | Implies if save file to disk button should be shown | -| `exportToBackend` | 
 (exportedElements: readonly NonDeletedExcalidrawElement[],appState: AppState,canvas: HTMLCanvasElement | null) => void
| | This callback is triggered when the shareable-link button is clicked in the export dialog. The link button will only be shown if this callback is passed. | +| `onExportToBackend` | 
 (exportedElements: readonly NonDeletedExcalidrawElement[],appState: AppState,canvas: HTMLCanvasElement | null) => void
| | This callback is triggered when the shareable-link button is clicked in the export dialog. The link button will only be shown if this callback is passed. | | `renderCustomUI` | 
 (exportedElements: readonly NonDeletedExcalidrawElement[],appState: AppState,canvas: HTMLCanvasElement | null) => void
| | This callback should be supplied if you want to render custom UI in the export dialog. | #### `onPaste`