ScrollContainerController

Purpose

Controller to be used on a scrollable container element, to enable control over the scroll height of the container.

Actions

Action	Purpose
scrollTop	Scroll to the very top of the element
scrollBottom	Scroll to the very bottom of the element
scrollLeft	Scroll to the very left of the element
scrollRight	Scroll to the very right of the element
up	Scroll up by incrementAmount in 'px'
down	Scroll down by incrementAmount in 'px'
left	Scroll left by incrementAmount in 'px'
right	Scroll right by incrementAmount in 'px'

Targets

Target	Purpose	Default
-	-	-

Classes

Class	Purpose	Default
-	-	-

Values

See ScrollToOptions documentation for possible values for behaviour

Value	Type	Description	Default
behaviour	String	One of auto, smooth. Note: If the user's browser does not support smooth scrolling, the browser will ignore these values and scroll using the browser default.	auto
increment	Number	The amount to scroll by when using up, down, left, right actions	50

Events

Event	When	Dispatched on	event.detail
-	-	-	-

Side Effects

None

How to Use

See Also

Scroll To Controller Scroll To Top Controller Scroll To Bottom Controller Scroll Into Focus Controller