Skip to content

Commit ea327ec

Browse files
committed
chore(readme): update examples and debug props
1 parent 16efb94 commit ea327ec

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Try it in the [Svelte REPL](https://svelte.dev/repl/47fe04909fd14ee5ad5d02390cc1
2828
## Usage
2929
```svelte
3030
<script>
31-
import Viewable from "@svelte-plugins/viewable";
31+
import { Viewable } from "@svelte-plugins/viewable";
3232
3333
const immediately = (definition) => {
3434
console.log('element has crossed the viewport');
@@ -69,7 +69,7 @@ Try the basic example in [Svelte REPL](https://svelte.dev/repl/c97c9abb9c944647a
6969
| rootMargin | Margin offset of the containing element | `string` (default: `"0px"`) |
7070
| intersecting | `true` if the observed element is intersecting | `boolean` (default: `false`) |
7171
| observer | IntersectionObserver instance | [`IntersectionObserver`](https://developer.mozilla.org/en-US/docs/Web/API/IntersectionObserver) |
72-
| entry | Observed element metadata | [`IntersectionObserverEntry`](https://developer.mozilla.org/en-US/docs/Web/API/IntersectionObserverEntry) |
72+
| entry | IntersectionObserver Entry | [`IntersectionObserverEntry`](https://developer.mozilla.org/en-US/docs/Web/API/IntersectionObserverEntry) |
7373
| debug | If `true`, debug ouput will be logged to console | `boolean` (default: `false`) |
7474

7575
#### rules
@@ -103,7 +103,8 @@ The properties below can be used to assist with debugging any issues you might h
103103
| percent | Percentage of total viewable area (X+Y) | `number` (default: `0`) |
104104
| percentX | Percentage of horizontal viewable area | `number` (default: `0`) |
105105
| percentY | Percentage of vertical viewable area | `number` (default: `0`) |
106-
106+
| entry | IntersectionObserver Entry | `object` (default: `null`) |
107+
| observer | IntersectionObserver | `object` (default: `null`) |
107108

108109
### Events
109110

0 commit comments

Comments
 (0)