Interface VirtualScrollbarProps

interface VirtualScrollbarProps {
    createScrollEndButton?: ((props) => ReactElement<any, string | JSXElementConstructor<any>>);
    createScrollStartButton?: ((props) => ReactElement<any, string | JSXElementConstructor<any>>);
    endGap?: number;
    endScrollIncrement?: number;
    minSize?: number;
    offset: number;
    onScrollOffset: ((offset, viewportSize, totalSize) => void);
    orientation: ScrollbarOrientation;
    precisionFactor?: number;
    scaleFactor?: number;
    scaleLimit?: number;
    scrollButtonAdditionalRepeatDelay?: number;
    scrollButtonIncrement?: number;
    scrollButtonInitialRepeatDelay?: number;
    showCustomScrollButtons?: boolean;
    totalSize: number;
    viewportSize: number;
}

Hierarchy (view full)

Properties

createScrollEndButton? createScrollStartButton? endGap? endScrollIncrement? minSize? offset onScrollOffset orientation precisionFactor? scaleFactor? scaleLimit? 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>>

Optional endGap

endGap?: number

Amount of scrollbar between minSize and totalSize. This is mean to show that there is more scroll area.

Default Value

100

Optional endScrollIncrement

endScrollIncrement?: number

Determines the increment amount when the scrollbar has been dragged to the end but is not scrolled to total size.

Default Value

100;

Optional minSize

minSize?: number

If this is the minimum scrollbar size. By default this is the bottom of the viewport but can be extended.

Default Value

0

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 precisionFactor

precisionFactor?: number

The default precision. This is a factor of the scale factor.

Default Value

50

Optional scaleFactor

scaleFactor?: number

The factor amount for physical scaling

Default Value

100

Optional scaleLimit

scaleLimit?: number

The max size of the area before scaling is implemented.

Default Value

1000000

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

createScrollEndButtoncreateScrollStartButtonendGapendScrollIncrementminSizeoffsetonScrollOffsetorientationprecisionFactorscaleFactorscaleLimitscrollButtonAdditionalRepeatDelayscrollButtonIncrementscrollButtonInitialRepeatDelayshowCustomScrollButtonstotalSizeviewportSize