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

    Interface SheetCellEditorLayerProps

    clean value type.

    dirty value type.

    commit args.

    interface SheetCellEditorLayerProps {
        alignment?: EditorAlignment;
        alignWidth?: number;
        bounds?: Bounds;
        clipInsets?: number;
        coverGridlines?: boolean;
        darkMode?: boolean;
        disableAlign?: boolean;
        editable: SheetEditable;
        fill?: boolean;
        keepMounted?: boolean;
        range?: RangeCoords;
        sheet: ISheet;
        zIndex?: number;
    }

    Hierarchy

    • VirtualDivProps
      • SheetCellEditorLayerProps
    Index
    alignment?: EditorAlignment

    Horizontal anchor used when the editor grows past its cell (Excel-style overflow). Overrides the default, which follows the edited cell's rendered alignment (formulas always grow to the right).

    alignWidth?: number

    Render an aligned border of this many DEVICE px instead of a fill. The edges are placed on the boundary centerline (edgeCenter, leading straddles / trailing grows outward) — the same rule as gridlines and RectangleSVG — so the border lines up with the selection rectangle exactly. The box is border-box; set the color via style.borderColor.

    This is the HTML-border-box counterpart of RectangleSVG's stroke. Use it for a content-hosting box that needs a matching border (the cell editor: the content auto-insets inside the border). For a pure outline/fill overlay, prefer RectangleSVG/RangeRect.

    bounds?: Bounds

    Explicit absolute bounds to place at (already resolved). Provide this OR range OR fill.

    clipInsets?: number

    View-pixel slack for the off-screen cull. A negative value extends outside the viewport, keeping a just-off-screen box visible.

    coverGridlines?: boolean

    Extend the right/bottom edges by 1 device px so the box covers all four of its gridline pixels (a gridline paints the boundary PIXEL [B, B+1]). Adjacent boxes then overlap by 1px at the shared boundary — intended, like Excel cell fills.

    false
    
    darkMode?: boolean

    The grid's light/dark intent — drives the box background resolution (resolveCellBackground, which bakes a concrete color). The input's own font/token colors are theme-adaptive (light-dark()) and need no flag.

    disableAlign?: boolean

    Skip device-pixel edge alignment. By default the box edges are snapped to the device grid (so content stays crisp and adjacent boxes sharing an edge resolve to the same pixel — no seam). Turn off for a raw, unaligned box.

    false
    
    editable: SheetEditable

    The editable (UI model) — anchor + the single current edit. Shared with peers (the formula bar).

    fill?: boolean

    Size to the view (the pane), never culled. For full-view content: a background wash, a canvas host, a pointer-capture surface, a container that needs real CSS (overflow, opacity, filter, a scroll-carrying transform) applied to a whole group. Provide this OR range OR bounds.

    keepMounted?: boolean

    Keep the element mounted (positioned off-screen) instead of culling to null when off-screen. For always-mounted content such as the cell editor, whose input must never unmount.

    false
    
    range?: RangeCoords

    The range to place at. Resolved to absolute bounds via the current pane. Provide this OR bounds OR fill.

    sheet: ISheet

    The sheet — its selection drives the input's leave-key nav, its active cell the edit-session commands.

    zIndex?: number

    Stacking override, read by the grid's sorter off this element when the editor is a grid child (law 1: z belongs to Layers; the editor's Layer takes its slot from the sorted order).