[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [ScrollXEvents](./x-components.scrollxevents.md) ## ScrollXEvents interface Dictionary of the events of Scroll XModule, where each key is the event name, and the value is the event payload type or `void` if it has no payload. **Signature:** ```typescript export interface ScrollXEvents ``` ## Properties

Property	Modifiers	Type	Description
[ScrollRestoreFailed](./x-components.scrollxevents.scrollrestorefailed.md)		void	The scroll position has failed to be restored. Payload: none.
[ScrollRestoreSucceeded](./x-components.scrollxevents.scrollrestoresucceeded.md)		void	The scroll position has been restored successfully. Payload: none.
[UserAlmostReachedScrollEnd](./x-components.scrollxevents.useralmostreachedscrollend.md)		boolean	The user has almost reached the scroll end. Payload: True if the user has almost reached the scroll end, false if it is no longer close to the end.
[UserChangedScrollDirection](./x-components.scrollxevents.userchangedscrolldirection.md)		[ScrollDirection](./x-components.scrolldirection.md)	The user has changed the direction of scroll. Payload: The new [ScrollDirection](./x-components.scrolldirection.md) when user changes scroll direction.
[UserReachedScrollEnd](./x-components.scrollxevents.userreachedscrollend.md)		boolean	The user has reached the scroll end. Payload: True if the user has reached the ending position of the scroll. False if he is no longer in that position.
[UserReachedScrollStart](./x-components.scrollxevents.userreachedscrollstart.md)		boolean	The user has reached the scroll start. Payload: True if the user has reached the starting position of the scroll. False if he is no longer in that position.
[UserScrolled](./x-components.scrollxevents.userscrolled.md)		number	The user has scrolled. Payload: The new position of scroll.
[UserScrolledToElement](./x-components.scrollxevents.userscrolledtoelement.md)		string	The user has scrolled to an element with the given id. Payload: The scroll identifier of the element.