@empathyco/x-components
Version:
Empathy X Components
25 lines (16 loc) • 1.24 kB
Markdown
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [ScrollComponentState](./x-components.scrollcomponentstate.md)
## ScrollComponentState interface
Contains all the state of a scroll component.
**Signature:**
```typescript
export interface ScrollComponentState
```
## Properties
| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [direction](./x-components.scrollcomponentstate.direction.md) | | [ScrollDirection](./x-components.scrolldirection.md) | The direction the user is scrolling. |
| [hasAlmostReachedEnd](./x-components.scrollcomponentstate.hasalmostreachedend.md) | | boolean | True if the user has almost reached the end of the scroll panel. |
| [hasReachedEnd](./x-components.scrollcomponentstate.hasreachedend.md) | | boolean | True if the user has already reached the end of the scroll panel. |
| [hasReachedStart](./x-components.scrollcomponentstate.hasreachedstart.md) | | boolean | True if the scroll position is 0. |
| [position](./x-components.scrollcomponentstate.position.md) | | number | The position in pixels the user has scrolled down. |