Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
simonwep committed Dec 19, 2021
1 parent 01d781e commit 56b941c
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 2 deletions.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,7 @@ Check out the documentation for the package you want to use:
* @viselect/angular - TBA (planned).

> Check out [recipes](packages/vanilla/recipes.md) for commonly asked questions and how to solve them using the standart library!
> For information about events and more check out the [vanilla readme](packages/vanilla/README.md)!
### Browser support

Expand Down
5 changes: 3 additions & 2 deletions packages/vanilla/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -220,6 +220,7 @@ selection.on('beforestart', evt => {
});
```

### Event properties
Every event comes with the following properties:

```typescript
Expand All @@ -228,8 +229,8 @@ Every event comes with the following properties:
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
selected: Array<Element> // Elements from the currently active selection (each click, drag counts as a single "selection")
stored: Array<Element> // Elements currently selected (in total, not just an instant)
changed: {
added: Array<Element> // Added elements since last change
removed: Array<Element> // Removed elements since last change
Expand Down

0 comments on commit 56b941c

Please sign in to comment.