Interface BorderOverlayProps

interface BorderOverlayProps {
    borderRenderer?: ((props) => ReactNode);
    darkMode?: boolean;
    defaultColor?: string;
    forceThinBorder?: boolean;
    getBorderAt: ((value, index) => ICellBorder);
    getVisibleCells: ((view) => {
        coords: CellCoords;
        range?: CellRangeCoords;
        value?: any;
    }[]);
    shiftIfWide?: boolean;
}

Properties

borderRenderer? darkMode? defaultColor? forceThinBorder? getBorderAt getVisibleCells shiftIfWide?

Properties

Optional borderRenderer

borderRenderer?: ((props) => ReactNode)

Allow users to customize border rendering. Note - This is wrapped in a single SVG so must be an SVG Element type (like a path).

Type declaration

Optional darkMode

darkMode?: boolean

Optional defaultColor

defaultColor?: string

Optional forceThinBorder

forceThinBorder?: boolean

Force all rendering to be a single border line. Use for previews.

getBorderAt

getBorderAt: ((value, index) => ICellBorder)

For finding the border. The value is the value returned from getVisibleCells and the index is the index found

Type declaration

Returns

getVisibleCells

getVisibleCells: ((view) => {
    coords: CellCoords;
    range?: CellRangeCoords;
    value?: any;
}[])

Returns a list of visible cells.

Type declaration

Returns

Optional shiftIfWide

shiftIfWide?: boolean

A special flag to shift large borders

Settings

Member Visibility

Theme

On This Page

borderRendererdarkModedefaultColorforceThinBordergetBorderAtgetVisibleCellsshiftIfWide