Interface ScrollPaneProps

interface ScrollPaneProps {
    createHorizontalScrollbar?: ((props) => ReactNode);
    createScrollCorner?: ((size) => ReactNode);
    createVerticalScrollbar?: ((props) => ReactNode);
    disableTouch?: boolean;
    onScrollViewport?: ((scrollPoint) => void);
    showHorizontalScrollbar?: boolean;
    showVerticalScrollbar?: boolean;
    touchElement?: HTMLElement;
    viewport: ScrollableViewport;
}

Hierarchy (view full)

Properties

createHorizontalScrollbar? createScrollCorner? createVerticalScrollbar? disableTouch? onScrollViewport? showHorizontalScrollbar? showVerticalScrollbar? touchElement? viewport

Properties

Optional createHorizontalScrollbar

createHorizontalScrollbar?: ((props) => ReactNode)

Type declaration

Optional createScrollCorner

createScrollCorner?: ((size) => ReactNode)

Type declaration

    • (size): ReactNode

    • Parameters

      Returns ReactNode

Optional createVerticalScrollbar

createVerticalScrollbar?: ((props) => ReactNode)

Type declaration

Optional disableTouch

disableTouch?: boolean

If touch is disabled.

Default Value

false unless no touch events are detected

Optional onScrollViewport

onScrollViewport?: ((scrollPoint) => void)

Type declaration

    • (scrollPoint): void

    • Parameters

      Returns void

Optional showHorizontalScrollbar

showHorizontalScrollbar?: boolean

Optional showVerticalScrollbar

showVerticalScrollbar?: boolean

Optional touchElement

touchElement?: HTMLElement

By default the ScrollPane will listen for events on all of the children of the ScrollPane but this allows for a custom element to be specified. This is useful when the ScrollPane has some elements that should not be touch enabled (for example headers)

viewport

viewport: ScrollableViewport

Settings

Member Visibility

Theme

On This Page

createHorizontalScrollbarcreateScrollCornercreateVerticalScrollbardisableTouchonScrollViewportshowHorizontalScrollbarshowVerticalScrollbartouchElementviewport