Heatmap

Presets

Installation

npm i @paper-design/shaders-react

Code

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

<Heatmap
  colors={["#cc3333", "#cc9933", "#99cc33", "#33cc33", "#33cc99", "#3399cc", "#3333cc"]}
>
  <div className="demo">
    <style>{`.demo { display: grid; align-content: center; justify-items: start; gap: 48px; height: 100%; padding: 0 8%; color: #222 }
    .demo p { margin: 0; font: 300 120px/1.1 Matter, system-ui; font-feature-settings: "ss01"; word-spacing: 0.1em; text-transform: lowercase }
    .demo button { display: flex; align-items: center; height: 128px; padding: 0 40px; border: 3px solid rgb(0 0 0 / 20%); border-radius: 24px; font: 44px 'Paper Mono', ui-monospace, monospace; color: #222; background: #fff; transition: background-color 150ms cubic-bezier(0.685, 0.89, 0.315, 0.995) }
    .demo button:hover { background: #f0efe4 }
    .demo button:active { background: #e9e8e0 }
    .demo .logos { display: flex; align-items: center; gap: 40px }
    .demo .logos img { height: 80px; width: auto }`}</style>
    <p>Select this text</p>
    <div className="logos">
      <img src="/images/logos/paper-logo-only.svg" alt="Paper logo" />
      <img src="/apple-touch-icon.png" alt="Paper icon" />
    </div>
    <button
      onClick={(event) => {
        const clicks = Number(event.currentTarget.dataset.clicks ?? 0) + 1;
        event.currentTarget.dataset.clicks = String(clicks);
        event.currentTarget.textContent = `clicked ${clicks} time${clicks === 1 ? '' : 's'}`;
      }}
    >
      hover and click me
    </button>
  </div>
</Heatmap>

Shader Props

Name	Description	Type	Values
image	The image to use for the effect	`HTMLImageElement \| string`	Image object or URL
colors	Up to 10 colors used to color the heatmap	`string[]`	Hex, RGB, or HSL color
colorBack	Background color	`string`	Hex, RGB, or HSL color
contour	The heat intensity near the edges of the input shape	`number`	0 to 1
angle	The direction of the heatwaves (angle relative to the shape), needs innerGlow or outerGlow > 0	`number`	0 to 360
noise	Grain applied across the entire graphic	`number`	0 to 1
innerGlow	The size of the heated area inside the input shape	`number`	0 to 1
outerGlow	The size of the heated area outside the input shape	`number`	0 to 1

Common Props

Name	Description	Type	Values
speed	Controls how fast the animation runs. speed=0 stops the animation loop, and speed=1 defines frame prop as timestamp in milliseconds	`number`	—
frame	Starting point of the animation. When speed=1, this value is treated as start time in milliseconds (try large frame values to see the difference). When speed=0 frame fully defines the state of static shader	`number`	—
scale	Overall zoom level of the graphics	`number`	0.1 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"`
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 (default is 2 for double resolution)	`number`	—
maxPixelCount	Maximum pixel count that the shader may process	`number`	—

Description

A glowing gradient of colors flowing through an input shape. The effect creates a smoothly animated wave of intensity across the image. With default colors, it shifts from cool blues to hot reds, like thermal energy radiating through the shape.