SheetXL - v0.8.0-beta.9+sites.210.e2d420901
    Preparing search index...

    Interface TouchThumbHandleProps

    interface TouchThumbHandleProps {
        backgroundColor?: string;
        borderColor?: string;
        borderWidth?: number;
        currentTouchAnchor?: string;
        fillColor?: string;
        fraction?: number;
        key?: string;
        onDraggingChange?: (event: ThumbDragEvent) => void;
        onEdgeHold?: (edge: -1 | 1, tick: TrackEdgeTick) => boolean;
        onScrollToFraction?: (fraction: number) => void;
        orientation: ScrollbarOrientation;
        ref?: Ref<TouchThumbHandleElement>;
        size?: number;
    }

    Hierarchy

    • HTMLAttributes<HTMLElement>
      • TouchThumbHandleProps
    Index
    backgroundColor? borderColor? borderWidth? currentTouchAnchor? fillColor? fraction? key? onDraggingChange? onEdgeHold? onScrollToFraction? orientation ref? size?
    backgroundColor?: string
    borderColor?: string
    borderWidth?: number
    currentTouchAnchor?: string

    Indicate that a touch handling is being used

    fillColor?: string
    fraction?: number

    The thumb's position along its track as a fraction [0, 1]. Comes from the scrollbar's thumb — a virtual scrollbar maps scroll → thumb non-linearly (elastic), so only the scrollbar knows this. The grip is literally a touch-sized rendering of the thumb.

    key?: string
    onDraggingChange?: (event: ThumbDragEvent) => void

    Drag lifecycle signal, carrying the grip ELEMENT (source: 'touch') — same event shape as the desktop thumb's (ScrollbarProps.onThumbDrag). A virtual scrollbar pins its elastic region while dragging; a client anchors drag UI (e.g. a tooltip) to the element.

    onEdgeHold?: (edge: -1 | 1, tick: TrackEdgeTick) => boolean

    Called on a repeating tick while the grip is dragged past a travel end and held there — the same contract as ScrollbarProps.onThumbEdgeHold (a virtual scrollbar extends its elastic region, accelerating with hold time). Return false to stop the ticking (parked at the real end). Leave unset for a linear scrollbar: its end is the end.

    onScrollToFraction?: (fraction: number) => void

    Called while dragging with the new position along the travel as a fraction [0, 1]. The scrollbar maps it back through its (possibly virtual) thumb space to a scroll offset.

    orientation: ScrollbarOrientation

    The orientation of the scrollbar.

    ref?: Ref<TouchThumbHandleElement>

    Ref for the TouchThumbHandle element

    size?: number

    Settings
    Member Visibility

    On This Page
    Properties