Skip to content

Pulse Grid API

PulseGrid

Extends Effect.

Factory Function

typescript
createPulseGrid(config?: PulseGridConfig): Effect<PulseGridConfig>

Methods

See Effect for the full method reference.


PulseGridConfig

typescript
interface PulseGridConfig {
    readonly spacing?: number;
    readonly speed?: number;
    readonly color?: string;
    readonly dotSize?: number;
    readonly waveCount?: number;
    readonly waveSpeed?: number;
    readonly scale?: number;
}
PropertyTypeDefaultDescription
spacingnumber30Distance in pixels between grid dots.
speednumber1Overall animation speed multiplier.
colorstring'#4488ff'Base color of the dots.
dotSizenumber2Radius of each dot.
waveCountnumber3Number of simultaneous ripple waves.
waveSpeednumber100Expansion speed of waves in pixels per second.
scalenumber1Scales all sizes proportionally.

PulseWave

typescript
interface PulseWave {
    readonly x: number;
    readonly y: number;
    readonly radius: number;
    readonly maxRadius: number;
}
PropertyTypeDescription
xnumberX coordinate of the wave origin.
ynumberY coordinate of the wave origin.
radiusnumberCurrent radius of the expanding wave.
maxRadiusnumberMaximum radius before the wave resets.