Skip to content

Commit

Permalink
chore: make prop descriptions consistent with the docs
Browse files Browse the repository at this point in the history
  • Loading branch information
metonym committed Dec 29, 2021
1 parent ba6c235 commit 5944a6b
Showing 1 changed file with 20 additions and 12 deletions.
32 changes: 20 additions & 12 deletions src/IntersectionObserver.svelte
Original file line number Diff line number Diff line change
@@ -1,41 +1,49 @@
<script>
/**
* The HTML Element to observe
* The HTML Element to observe.
* @type {null | HTMLElement}
*/
export let element = null;
/**
* Set to `true` to unobserve the element after it intersects the viewport
* Set to `true` to unobserve the element
* after it intersects the viewport.
* @type {boolean}
*/
export let once = false;
/**
* Containing element
* Defaults to the browser viewport
* `true` if the observed element
* is intersecting the viewport.
*/
export let intersecting = false;
/**
* Specify the containing element.
* Defaults to the browser viewport.
* @type {null | HTMLElement}
*/
export let root = null;
/** Margin offset of the containing element */
/** Margin offset of the containing element. */
export let rootMargin = "0px";
/**
* Percentage of element visibility to trigger an event
* Value must be between 0 and 1
* Percentage of element visibility to trigger an event.
* Value must be between 0 and 1.
*/
export let threshold = 0;
/** @type {null | IntersectionObserverEntry} */
/**
* Observed element metadata.
* @type {null | IntersectionObserverEntry}
*/
export let entry = null;
/**
* `true` is the observed element is intersecting the element
* `IntersectionObserver` instance.
* @type {null | IntersectionObserver}
*/
export let intersecting = false;
/** @type {null | IntersectionObserver} */
export let observer = null;
import { tick, createEventDispatcher, afterUpdate, onMount } from "svelte";
Expand Down

0 comments on commit 5944a6b

Please sign in to comment.