Update vanilla docs

simonwep · Aug 29, 2021 · 5540eed · 5540eed
1 parent c9ee856
commit 5540eed
Showing 1 changed file with 18 additions and 0 deletions.
diff --git a/packages/vanilla/README.md b/packages/vanilla/README.md
@@ -210,4 +210,22 @@ selection.on('beforestart', evt => {
 });
 ```
 
+Every event comes with the following properties:
+
+```typescript
+{
+    selection: SelectionArea // Current instance
+    event: TouchEvent | MouseEvent | null // TouchEvent, MouseEvent or `null` if triggered manually
+    store: {
+        touched: Array<Element> // Touched elements
+        selected: Array<Element> // Elements currently selected
+        stored: Array<Element> // Elements from the previous selection / stored selection
+        changed: {
+            added: Array<Element> // Added elements since last change
+            removed: Array<Element> // Removed elements since last change
+        }
+    }
+}
+```
+
 > Common recipes can be found under [recipes](recipes.md).