Skip to main content

IsometricGrid

IsometricGrid renders a configurable isometric grid. It is useful for scene alignment, level layouts, and visual guides.

Import

import { IsometricGrid } from "isometric-react/isometric-grid";

Props

PropTypeRequiredDescription
sizenumber | stringYesBase grid size value.
sizeMultiplierSizeMultiplierNoMultiplier applied to grid size calculations.
colorstringNoGrid line color override.
lineweightnumberNoThickness of grid lines.
asReact.ElementTypeNoPolymorphic element type.
positionPositionNoOffsets and elevation values.
shadowShadowNoShadow distance and spacing settings.
shadowAnimationShadowAnimationNoAnimated shadow configuration.
rotationRotationNoRotation animation configuration.

Basic usage

import { IsometricGrid } from "isometric-react/isometric-grid";

export function BasicGrid() {
return <IsometricGrid size={10} />;
}

Rendered example

With optional props

import { IsometricGrid } from "isometric-react/isometric-grid";

export function StyledGrid() {
return (
<IsometricGrid
size={10}
sizeMultiplier={1}
color="#6f7f92"
lineweight={1}
as="section"
position={{ top: 0, left: 0, elevation: 0 }}
shadow={{ distance: 1, spacingX: 1, spacingY: 1 }}
/>
);
}

Supported shared props

IsometricGrid does not support border or edge.