@empathyco/x-components/docs/API-reference/api/x-components.scrollstatepayload.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; [ScrollStatePayload](./x-components.scrollstatepayload.md)

## ScrollStatePayload interface

Payload object containing the identifier of the scroll and its position.

**Signature:**

```typescript
export interface ScrollStatePayload extends Identifiable<string> 
```
**Extends:** Identifiable&lt;string&gt;

## Properties

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

Property


</th><th>

Modifiers


</th><th>

Type


</th><th>

Description


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

[newState](./x-components.scrollstatepayload.newstate.md)


</td><td>


</td><td>

Partial&lt;[ScrollComponentState](./x-components.scrollcomponentstate.md)<!-- -->&gt;


</td><td>

A partial [ScrollComponentState](./x-components.scrollcomponentstate.md) update to perform to the targeted panel.


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