Dot Grid

Presets

Installation

npm i @paper-design/shaders-react

Code

import { DotGrid } from '@paper-design/shaders-react';

<DotGrid
  width={1280}
  height={720}
  colorBack="#000000"
  colorFill="#ffffff"
  colorStroke="#ffaa00"
  size={2}
  gapX={32}
  gapY={32}
  strokeWidth={0}
  sizeRange={0}
  opacityRange={0}
  shape="circle"
/>

Shader Props

Name	Description	Type	Values
colorBack	Background color	`string`	Hex, RGB, or HSL color
colorFill	Shape fill color	`string`	Hex, RGB, or HSL color
colorStroke	Shape stroke color	`string`	Hex, RGB, or HSL color
shape	The shape type	`enum`	\| `"circle"` \| `"diamond"` \| `"square"` \| `"triangle"`
size	Base size of each shape, pixels	`number`	1 to 100
gapX	Pattern horizontal spacing, pixels	`number`	2 to 500
gapY	Pattern vertical spacing, pixels	`number`	2 to 500
strokeWidth	The outline stroke width, pixels	`number`	0 to 50
sizeRange	Random variation in shape size (0 = uniform size, higher = random value up to base size)	`number`	0 to 1
opacityRange	Random variation in shape opacity (0 = all shapes opaque, higher = semi-transparent dots)	`number`	0 to 1

Common Props

Name	Description	Type	Values
scale	Overall zoom level of the graphics	`number`	0.01 to 4
rotation	Overall rotation angle of the graphics	`number`	0 to 360
offsetX	Horizontal offset of the graphics center	`number`	-1 to 1
offsetY	Vertical offset of the graphics center	`number`	-1 to 1
width	CSS width style of the shader element	`number \| string`	—
height	CSS height style of the shader element	`number \| string`	—
fit	How to fit the rendered shader into the canvas dimensions	`enum`	\| `"contain"` \| `"cover"`
worldWidth	Virtual width of the graphic before it's scaled to fit the canvas	`number`	—
worldHeight	Virtual height of the graphic before it's scaled to fit the canvas	`number`	—
originX	Reference point for positioning world width in the canvas	`number`	0 to 1
originY	Reference point for positioning world height in the canvas	`number`	0 to 1
minPixelRatio	Minimum pixel ratio to use when rendering the shader	`number`	—
maxPixelCount	Maximum pixel count that the shader may process	`number`	—

Description

Static grid pattern made of circles, diamonds, squares or triangles.