Interface ScrollbarRefProps

interface ScrollbarRefProps {
    createScrollEndButton?: ((props) => ReactElement<any, string | JSXElementConstructor<any>>);
    createScrollStartButton?: ((props) => ReactElement<any, string | JSXElementConstructor<any>>);
    offset: number;
    onScrollOffset: ((offset, viewportSize, totalSize) => void);
    orientation: ScrollbarOrientation;
    ref?: Ref<HTMLDivElement>;
    scrollButtonAdditionalRepeatDelay?: number;
    scrollButtonIncrement?: number;
    scrollButtonInitialRepeatDelay?: number;
    showCustomScrollButtons?: boolean;
    totalSize: number;
    viewportSize: number;
}

Hierarchy (view full)

Properties

createScrollEndButton? createScrollStartButton? offset onScrollOffset orientation ref? scrollButtonAdditionalRepeatDelay? scrollButtonIncrement? scrollButtonInitialRepeatDelay? showCustomScrollButtons? totalSize viewportSize

Properties

Optional createScrollEndButton

createScrollEndButton?: ((props) => ReactElement<any, string | JSXElementConstructor<any>>)

Type declaration

    • (props): ReactElement<any, string | JSXElementConstructor<any>>

    • Parameters

      Returns ReactElement<any, string | JSXElementConstructor<any>>

Optional createScrollStartButton

createScrollStartButton?: ((props) => ReactElement<any, string | JSXElementConstructor<any>>)

Type declaration

    • (props): ReactElement<any, string | JSXElementConstructor<any>>

    • Parameters

      Returns ReactElement<any, string | JSXElementConstructor<any>>

offset

offset: number

onScrollOffset

onScrollOffset: ((offset, viewportSize, totalSize) => void)

Type declaration

    • (offset, viewportSize, totalSize): void

    • Parameters

      • offset: number
      • viewportSize: number
      • totalSize: number

      Returns void

orientation

orientation: ScrollbarOrientation

Optional ref

ref?: Ref<HTMLDivElement>

Optional scrollButtonAdditionalRepeatDelay

scrollButtonAdditionalRepeatDelay?: number

Optional scrollButtonIncrement

scrollButtonIncrement?: number

Optional scrollButtonInitialRepeatDelay

scrollButtonInitialRepeatDelay?: number

Optional showCustomScrollButtons

showCustomScrollButtons?: boolean

This will add custom scrollButtons. This should only be set to true if you have used css styling to hide the default scrollButtons using: ::-webkit-scrollbar-button": { display: 'none' }

Default Value

false

totalSize

totalSize: number

viewportSize

viewportSize: number

Settings

Member Visibility

Theme

On This Page

createScrollEndButtoncreateScrollStartButtonoffsetonScrollOffsetorientationrefscrollButtonAdditionalRepeatDelayscrollButtonIncrementscrollButtonInitialRepeatDelayshowCustomScrollButtonstotalSizeviewportSize