SheetXL - v1.0.2
    Preparing search index...

    Interface MovableRendererOptions<M>

    How a renderer is registered: what the layer needs to know before the kind's module has loaded.

    interface MovableRendererOptions<M = MovableRenderer | MovableRendererModule> {
        fallback?: ReactNode;
        hitArea?: "content" | "frame";
        prefetch?: boolean;
        select?: (module: M) => MovableRendererModule | MovableRenderer;
        selectionShadow?: boolean;
    }

    Type Parameters

    Index
    fallback? hitArea? prefetch? select? selectionShadow?
    fallback?: ReactNode

    What is drawn while the renderer loads.

    nothing — the movable's frame is there already.
    hitArea?: "content" | "frame"

    What a press on the movable hits.

    • 'frame': the whole frame, as a plain div is. The renderer draws whatever it likes inside a box that fills the frame and takes the presses.
    • 'content': only what the renderer marks. It applies props.style to its root, which carries the layer's pointerEvents, and may set none on the parts a press should pass through, as an unfilled shape does for its interior.

    'frame'

    prefetch?: boolean

    Whether the kind may be loaded ahead of use (LazyModules.prefetch in @sheetxl/utils).

    true
    select?: (module: M) => MovableRendererModule | MovableRenderer

    Picks the kind's renderer, or its renderer and control together (MovableRendererModule), from the imported module.

    the module itself, for a loader that resolves to the renderer or the record
    selectionShadow?: boolean

    Whether the layer shades a selected movable of the kind with a shadow on its frame. A kind that shades what it paints itself, as a shape does along its outline, says false.

    true

    Settings
    Member Visibility

    On This Page
    Properties