SheetXL - v1.0.2
    Preparing search index...

    Interface ScrollPaneProps

    Properties for the ScrollPane

    interface ScrollPaneProps {
        disableMouseWheel?: boolean;
        disableTouch?: boolean;
        onWheelScroll?: (event: WheelEvent) => boolean | void;
        ref?: Ref<IScrollPaneElement>;
        renderScrollbarHorizontal?: RenderSlotFn<ScrollbarProps> | null;
        renderScrollbarVertical?: RenderSlotFn<ScrollbarProps> | null;
        renderScrollCorner?: RenderSlotFn<ScrollCornerProps> | null;
        showHorizontalScrollbar?: boolean;
        showVerticalScrollbar?: boolean;
        viewport?: IViewport;
        zoomable?: boolean;
    }

    Hierarchy

    • HTMLAttributes<HTMLDivElement>
      • ScrollPaneProps
    Index
    disableMouseWheel? disableTouch? onWheelScroll? ref? renderScrollbarHorizontal? renderScrollbarVertical? renderScrollCorner? showHorizontalScrollbar? showVerticalScrollbar? viewport? zoomable?
    disableMouseWheel?: boolean

    Disable mouse-wheel scrolling. Wheel (which drives the ScrollPaneProps.viewport) is on by default; set this to turn it off.

    false
    disableTouch?: boolean

    If touch is disabled.

    false unless no touch events are detected.
    onWheelScroll?: (event: WheelEvent) => boolean | void

    Wheel intercept. Return false to consume the event (skip scrolling).

    ref?: Ref<IScrollPaneElement>

    Reference to the scroll pane element

    renderScrollbarHorizontal?: RenderSlotFn<ScrollbarProps> | null

    null for no horizontal scrollbar, the gutter kept.

    renderScrollbarVertical?: RenderSlotFn<ScrollbarProps> | null

    null for no vertical scrollbar, the gutter kept.

    renderScrollCorner?: RenderSlotFn<ScrollCornerProps> | null

    The corner where the two scrollbars meet. null leaves it empty.

    showHorizontalScrollbar?: boolean
    showVerticalScrollbar?: boolean
    viewport?: IViewport

    The scroll viewport — an IViewport (a Viewport, or an AxisViewport for per-axis sharing). The ScrollPane subscribes to it for position + sizes and drives scroll into it (scrollbar/wheel/touch → setTarget).

    zoomable?: boolean

    Enable the zoom gesture (ctrl/⌘+wheel; pinch). The ScrollPane's scroller owns the gesture — the proportional factor, the clamp, the continuous level — and requests each step on the ScrollPaneProps.viewport (requestZoom), exactly as it drives scroll into it; whoever owns the zoom's model listens there (subscribeZoom) and commits.

    false

    Settings
    Member Visibility

    On This Page
    Properties