Pulsing Border

Presets

Installation

npm i @paper-design/shaders-react

Code

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

<PulsingBorder
  width={1280}
  height={720}
  colors={["#cc3333", "#cc9933", "#99cc33"]}
  colorBack="#000000"
  roundness={0.25}
  thickness={0.1}
  softness={0.75}
  aspectRatio="auto"
  intensity={0.2}
  bloom={0.25}
  spots={4}
  spotSize={0.5}
  pulse={0.25}
  smoke={0.3}
  smokeSize={0.6}
  speed={1}
  scale={0.6}
  marginLeft={0}
  marginRight={0}
  marginTop={0}
  marginBottom={0}
/>

Shader Props

Name	Description	Type	Values
colors	Up to 5 colors	`string[]`	Hex, RGB, or HSL color
colorBack	Background color	`string`	Hex, RGB, or HSL color
roundness	The border radius	`number`	0 to 1
thickness	The border base width	`number`	0 to 1
softness	Border edge sharpness (0 = hard edge, 1 = smooth gradient)	`number`	0 to 1
aspectRatio	Aspect ratio of the effect	`enum`	\| `"auto"` \| `"square"`
intensity	Thickness of individual color spots	`number`	0 to 1
bloom	The power of glow (0 = normal color blending, 1 = fully additive blending)	`number`	0 to 1
spots	Number of spots added for each color	`number`	1 to 20 (integer)
spotSize	Angular size of spots	`number`	0 to 1
pulse	Optional pulsing animation	`number`	0 to 1
smoke	Optional noisy shape extending the border shape	`number`	0 to 1
smokeSize	The size of the smoke effect (effective with smoke > 0)	`number`	0 to 1
margin	Distance from canvas edges to the effect	`number`	0 to 1
marginLeft	Distance from the left edge to the effect	`number`	0 to 1
marginRight	Distance from the right edge to the effect	`number`	0 to 1
marginTop	Distance from the top edge to the effect	`number`	0 to 1
marginBottom	Distance from the bottom edge to the effect	`number`	0 to 1

Common Props

Name	Description	Type	Values
speed	Animation speed	`number`	—
frame	Starting animation frame	`number`	—
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

Luminous trails of color merging into a glowing gradient frame.