@empathyco/x-components/docs/API-reference/api/x-components.scrollcomponentstate.md

Empathy X Components

<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [ScrollComponentState](./x-components.scrollcomponentstate.md)

## ScrollComponentState interface

Contains all the state of a scroll component.

**Signature:**

```typescript
export interface ScrollComponentState 
```

## Properties

<table><thead><tr><th>

Property


</th><th>

Modifiers


</th><th>

Type


</th><th>

Description


</th></tr></thead>
<tbody><tr><td>

[direction](./x-components.scrollcomponentstate.direction.md)


</td><td>


</td><td>

[ScrollDirection](./x-components.scrolldirection.md)


</td><td>

The direction the user is scrolling.


</td></tr>
<tr><td>

[hasAlmostReachedEnd](./x-components.scrollcomponentstate.hasalmostreachedend.md)


</td><td>


</td><td>

boolean


</td><td>

True if the user has almost reached the end of the scroll panel.


</td></tr>
<tr><td>

[hasReachedEnd](./x-components.scrollcomponentstate.hasreachedend.md)


</td><td>


</td><td>

boolean


</td><td>

True if the user has already reached the end of the scroll panel.


</td></tr>
<tr><td>

[hasReachedStart](./x-components.scrollcomponentstate.hasreachedstart.md)


</td><td>


</td><td>

boolean


</td><td>

True if the scroll position is 0.


</td></tr>
<tr><td>

[position](./x-components.scrollcomponentstate.position.md)


</td><td>


</td><td>

number


</td><td>

The position in pixels the user has scrolled down.


</td></tr>
</tbody></table>