SheetXL - v1.0.2
    Preparing search index...

    Interface ContentControlProps

    Props of a control a content kind registers in place of the generic one (see registerMovableRenderer): the generic control's, and what a control of its own needs.

    interface ContentControlProps {
        children?: ReactNode;
        context?: boolean;
        directions: readonly ResizeDirectionName[];
        flip: Flip;
        gesture: MovableGestureHost;
        isDragging?: boolean;
        movable: IMovable;
        onMoveStart?: (e: PointerEvent) => void;
        onResize: (
            direction: ResizeDirection,
            delta: readonly [number, number],
            keepAspect: boolean,
        ) => void;
        onResizeCancel: () => void;
        onResizeEnd: () => void;
        onResizeStart: () => boolean;
        rotation: number;
    }

    Hierarchy (View Summary)

    Index
    children? context? directions flip gesture isDragging? movable onMoveStart? onResize onResizeCancel onResizeEnd onResizeStart rotation
    children?: ReactNode

    Drawn first in the control, so it hides with the handles and paints under them: the rotate handle.

    context?: boolean

    Draw the control as context: the frame of a group a selected member is inside, as Excel draws it (a dotted outline and hollow neutral handles). Its handles still resize that group.

    directions: readonly ResizeDirectionName[]

    Compass names of the handles to draw (nw, n, … se).

    flip: Flip

    How the frame is mirrored: the gesture's while one is in flight, else the movable's.

    gesture: MovableGestureHost
    isDragging?: boolean

    Fade the control, as during a gesture. It stays mounted: the handle being dragged holds the pointer capture.

    movable: IMovable
    onMoveStart?: (e: PointerEvent) => void

    A press on the move grip a frame too small for its handles shows in their place. Omit when the frame cannot be moved.

    onResize: (
        direction: ResizeDirection,
        delta: readonly [number, number],
        keepAspect: boolean,
    ) => void

    The pointer moved. delta is how far it is from the press, in screen pixels; keepAspect is whether Shift is held.

    onResizeCancel: () => void

    The gesture was lost (pointercancel).

    onResizeEnd: () => void

    The pointer was released.

    onResizeStart: () => boolean

    A press on a handle. Return false to refuse the gesture.

    rotation: number

    Degrees clockwise the frame is turned; only the cursors use it, the box turns itself.

    Settings
    Member Visibility

    On This Page
    Properties