Skip to main content
Version: Next

ConveyerOptions

Type: TSInterface

PROPERTYTYPEDEFAULTDESCRIPTION
horizontalbooleantrue

scroll direction. (true: Horizontal Scroll, false: Vertical Scroll)

itemSelectorstring""

selector to find items inside.

useDragbooleantrue

Whether to use drag.

useSideWheelbooleanfalse

Whether to use the mouse wheel in a direction aside from the scroll direction.

boundaryMarginnumber0

The minimum margin space for reachStart, leaveStart, reachEnd, and leaveEnd events to be triggered at the beginning and end of the scroll area.

scrollDebouncenumber100

The maximum amount of time the scroll event does not fire for the finishScroll event to be triggered.

preventDefaultbooleantrue

Whether to prevent being selected.

preventClickOnDragbooleanfalse

Whether to prevent click event when dragging.

preventDefaultOnDragbooleanfalse

Whether to use the preventDefault when the user starts dragging.

autoInitbooleantrue

Whether to automatically initialize when an instance is created. If set to false, initialization is possible while calling the init method.

nestedbooleanfalse

If this option is enabled on a Conveyer placed inside an egjs component that has the same scroll direction including the Conveyer itself. The parent component moves in the same direction after the Conveyer reaches the first/last scroll position.

useResizeObserverbooleanfalse

Whether to use the ResizeObserver when resizing the Conveyer element and ConveyerItem elements.