<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [XEventsTypes](./x-components.xeventstypes.md) &gt; [UserClickedScrollToTop](./x-components.xeventstypes.userclickedscrolltotop.md)

## XEventsTypes.UserClickedScrollToTop property

The user has clicked the scroll to top button. Payload: The scroll id which has scrolled to top.

**Signature:**

```typescript
UserClickedScrollToTop: string;
```