Browse Source

fix: tweak readme for syncable elements (#3444)

* fix: tweak readme for syncable elements

* fix

* tweak

Co-authored-by: David Luzar <luzar.david@gmail.com>
Aakansha Doshi 4 years ago
parent
commit
d5a270f643
2 changed files with 2 additions and 2 deletions
  1. 1 1
      src/packages/excalidraw/README.md
  2. 1 1
      src/packages/excalidraw/README_NEXT.md

+ 1 - 1
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`
 

+ 1 - 1
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`