fix: tweak readme for syncable elements (#3444)

* fix: tweak readme for syncable elements * fix * tweak Co-authored-by: David Luzar <luzar.david@gmail.com>
excalidraw · Apr 13, 2021 · d5a270f · d5a270f · vercel · Apr 13, 2021
1 parent d126d04
commit d5a270f
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git a/src/packages/excalidraw/README.md b/src/packages/excalidraw/README.md
@@ -601,7 +601,7 @@ getSyncableElements(elements:  <a href="https://github.com/excalidraw/excalidraw
 import { getSyncableElements } from "@excalidraw/excalidraw";
 ```
 
-This function returns all the deleted elements of the scene.
+Returns all elements including deleted ones, excluding elements which are are invisibly small (e.g. width & height are zero). Useful when you want to sync elements during collaboration.
 
 #### `getElementMap`
 

diff --git a/src/packages/excalidraw/README_NEXT.md b/src/packages/excalidraw/README_NEXT.md
@@ -626,7 +626,7 @@ getSyncableElements(elements:  <a href="https://github.com/excalidraw/excalidraw
 import { getSyncableElements } from "@excalidraw/excalidraw";
 ```
 
-This function returns all the deleted elements of the scene.
+Returns all elements including deleted ones, excluding elements which are are invisibly small (e.g. width & height are zero). Useful when you want to sync elements during collaboration.
 
 #### `getElementMap`