smig/excalidraw
1
0
Fork 0
mirror of https://github.com/excalidraw/excalidraw.git synced 2025-05-03 10:00:07 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

refactor: rename renderTopRight prop to renderTopRightUI (#3572)

Browse source 
* refactor: rename renderTopRight prop to renderTopRightUI

* update

* fix

* update
This commit is contained in:
Aakansha Doshi 2021-05-13 21:02:59 +05:30 • committed by GitHub
parent bec34f2d57
commit 3b9290831a
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
7 changed files with 13 additions and 13 deletions
Download patch file Download diff file Expand all files Collapse all files

2
src/packages/excalidraw/CHANGELOG.md
View file

@ -18,7 +18,7 @@ Please add the latest change on the top under the correct section.
### Features
- Expose [`serializeAsJSON`](https://github.com/excalidraw/excalidraw/blob/master/src/packages/excalidraw/README.md#serializeAsJSON) helper that we use when saving Excalidraw scene to a file [#3538](https://github.com/excalidraw/excalidraw/pull/3538).
- Add support to render custom UI in the top right corner via [`renderTopRight`](https://github.com/excalidraw/excalidraw/blob/master/src/packages/excalidraw/README.md#renderTopRight) prop [#3539](https://github.com/excalidraw/excalidraw/pull/3539).
- Add support to render custom UI in the top right corner via [`renderTopRightUI`](https://github.com/excalidraw/excalidraw/blob/master/src/packages/excalidraw/README.md#renderTopRightUI) prop [#3539](https://github.com/excalidraw/excalidraw/pull/3539), [#3572](https://github.com/excalidraw/excalidraw/pull/3572) .
This also removes the GitHub icon, keeping it local to the https://excalidraw.com app.

4
src/packages/excalidraw/README_NEXT.md
View file

@ -355,7 +355,7 @@ To view the full example visit :point_down:
| [`onPointerUpdate`](#onPointerUpdate) | Function | | Callback triggered when mouse pointer is updated. |
| [`onExportToBackend`](#onExportToBackend) | Function | | Callback triggered when link button is clicked on export dialog |
| [`langCode`](#langCode) | string | `en` | Language code string |
| [`renderTopRight `](#renderTopRight) | Function | | Function that renders custom UI in top right corner |
| [`renderTopRightUI`](#renderTopRightUI) | Function | | Function that renders custom UI in top right corner |
| [`renderFooter `](#renderFooter) | Function | | Function that renders custom UI footer |
| [`renderCustomStats`](#renderCustomStats) | Function | | Function that can be used to render custom stats on the stats dialog. |
| [`viewModeEnabled`](#viewModeEnabled) | boolean | | This implies if the app is in view mode. |
@ -503,7 +503,7 @@ import { defaultLang, languages } from "@excalidraw/excalidraw";
| defaultLang | string |
| languages | [Language[]](https://github.com/excalidraw/excalidraw/blob/master/src/i18n.ts#L8) |
#### `renderTopRight`
#### `renderTopRightUI`
A function returning JSX to render custom UI in the top right corner of the app.

4
src/packages/excalidraw/index.tsx
View file

@ -20,7 +20,7 @@ const Excalidraw = (props: ExcalidrawProps) => {
isCollaborating,
onPointerUpdate,
onExportToBackend,
renderTopRight,
renderTopRightUI,
renderFooter,
langCode = defaultLang.code,
viewModeEnabled,
@ -73,7 +73,7 @@ const Excalidraw = (props: ExcalidrawProps) => {
isCollaborating={isCollaborating}
onPointerUpdate={onPointerUpdate}
onExportToBackend={onExportToBackend}
renderTopRight={renderTopRight}
renderTopRightUI={renderTopRightUI}
renderFooter={renderFooter}
langCode={langCode}
viewModeEnabled={viewModeEnabled}