@empathyco/x-components
Version:
Empathy X Components
78 lines (35 loc) • 1.03 kB
Markdown
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [ScrollVisibilityObserver](./x-components.scrollvisibilityobserver.md)
## ScrollVisibilityObserver interface
Methods to initialise and cease visibility observing.
**Signature:**
```typescript
export interface ScrollVisibilityObserver
```
## Properties
<table><thead><tr><th>
Property
</th><th>
Modifiers
</th><th>
Type
</th><th>
Description
</th></tr></thead>
<tbody><tr><td>
[observe](./x-components.scrollvisibilityobserver.observe.md)
</td><td>
</td><td>
(element: HTMLElement) => void
</td><td>
Starts observing the provided element.
</td></tr>
<tr><td>
[unobserve](./x-components.scrollvisibilityobserver.unobserve.md)
</td><td>
</td><td>
(element: HTMLElement) => void
</td><td>
Stops observing the provided element.
</td></tr>
</tbody></table>