Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added Feature: backgroundGrid #513

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Added Feature: backgroundGrid #513

wants to merge 2 commits into from

Conversation

EtBLh
Copy link

@EtBLh EtBLh commented Nov 4, 2024

backgroundGrid

I wanted to add a background grid in my existing project that is using react-d3-grid and I found the easiest way is to modify the package itself.

implementation

I used svg <pattern> and and a background <rect fill="url(#grid-pattern)"/> to implement the grid.

usage

there's a new props in <Tree />

backgroundGrid?: {
    type: "dot" | "line" | "custom",
    thickness?: number,
    color?: string,
    gridCellSize?: {width: number, height: number},
    gridCellFunc?: (options?: BackgroundGrid) => ReactElement
}

when backgroundGrid is undefined, grid will not be rendered.
there's 2 default type of grid: dot and line

  • color: color of each line / dot
  • thickness: thickness of each line / radius of the each dot
  • gridCellSize: the space take place by each dot / cross / customRenderFunction

type: custom allows customizing content inside by
passing gridCellFunc a function that return a ReactElement(svg elements)

testing

I added unit testing for <BackgroundGrid /> but haven't added testing for zooming, dragging

screenshots

  • line grid
    image
  • dot grid
    image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant