Electricity
Branching blue lightning follows the visible shape.

Hover to inspectZoom to inspect Focus the preview: + and − zoom, arrows pan, 0 resets. Drag to pan on touchscreens.
Live preview needs JavaScript and WebGPU.
import { attachElectricity } from '@domfx/browser';
const effect = attachElectricity(target, {
host,
clock: 'auto',
intensity: 0.8,
seed: 314,
contourSpread: 0.1,
});
// On unmount: effect.dispose();- Category
- Energy
- Function
attachElectricity- Options
ElectricityOptions- Package
@domfx/browser
Usage
attachElectricity(target: Element, options: ElectricityOptions): ColorEffectHandle
Returns an effect instance immediately. Imports are safe during server rendering; call the function in the browser after the elements are mounted. The Standalone guide includes the required HTML and CSS.
import { attachElectricity } from '@domfx/browser';
import type { ElectricityOptions } from '@domfx/browser';
// Run after mount; host contains target and has position: relative.
const options: ElectricityOptions = {
host, clock: 'auto', intensity: 0.8,
contourSpread: 0.1,
};
const effect = attachElectricity(target, options);
// Also call effect.dispose() on component unmount.
window.addEventListener('pagehide', () => effect.dispose(), { once: true });
await effect.ready;
if (effect.lifecycle !== 'active') {
console.info(effect.reason, effect.reasonDetail);
}Effect options
Creation options: finite nonnegative numeric fractions of the untransformed border box, excluding capture padding. Transparent margins count. Resolved again on capture after resize; supported translation and positive scale change placement only.
| Property | Type and unit | Example |
|---|---|---|
contourSpreadContour spread | number · fraction of the shorter local side | 0.1 = 10% |
Omitting the option keeps the Default appearance. An explicit value enables relative mode: intensity scales premultiplied output without changing geometry or fine detail. Zero hides the entire effect. Changing extent requires disposing and creating another instance; there is no geometric setter.
contourSpread bounds exterior strand spread from the visible shape, including its holes. The inward rim is 2.5 CSS px. Noise, strand widths, sparks and 18px emission cells keep their local size. Spread is an envelope, not a guaranteed visible tip. In the Default appearance, intensity also changes energy without moving strands.
Requires contained descendant boxes and paint within the border box plus 2 CSS px; shadows, filters, outlines and generated pseudo-elements are unsupported. Every captured alpha sample and the full free margin are checked. Pixel, memory and device limits still apply: a request that does not fit leaves the effect unavailable without trimming or reducing quality. Original content stays usable.
Shared options
Use the exported AttachmentOptions type. Only host is required. Every effect except Burned paper extends it with ColorAttachmentOptions.
| Property | Type | Default |
|---|---|---|
hostThe effect container: an HTML element already on the page, with CSS position other than static. It must contain the target in the same document; it cannot be the target itself. | HTMLElement | Required |
clockUse manual for your code or GSAP to control time; auto advances time automatically. | 'manual' | 'auto' | 'manual' |
motionrespect suppresses output under reduced motion. static always renders a still effect at time zero, under either preference. | 'respect' | 'static' | 'respect' |
seedFixed random seed. Keeps the pattern repeatable for the same time, settings and captured target. It does not set the amount of randomness or guarantee identical pixels across devices. | number | 0 |
timeInitial effect time in seconds. Negative values are accepted. | number | 0 |
intensityInitial effect strength. Accepted values clamp to 0–1; the visual response depends on the effect. | number | 1 |
colorOptional main decorative color for every effect except Burned paper. Accepts #RGB, #RRGGBB, rgb(...) and rgba(..., 1). Omit it to keep the effect’s original colors; assign undefined to restore them. | string | undefined | Omitted (original colors) |
All numeric values must be finite. time, seed, intensity and creation-only controls must fit float32. Writable artistic controls, including their initial values, accept any finite number and clamp to 0–1; invalid values for other options throw before clamping. To change a creation option other than time or intensity, dispose the attachment and create a replacement.
Only one effect can use a target at a time. Invalid host relationships and overlapping targets throw synchronously. Dispose the existing effect before attaching to the same target, its ancestor or a descendant. This restriction describes the element tree, not arbitrary visual overlap.
Controls
Changes electrical strength and brightness; it does not move the strands. With contourSpread, scales premultiplied output independently of spread and detail.
Read and write these properties on the effect instance. Writes are immediately readable. When output is available, they render on the next frame without recapturing the target.
| Property | Type |
|---|---|
timeEffect time in seconds. Supports forward and backward seeking, including negative time. | number |
intensityEffect strength, clamped to 0–1 after validation. It is not a universal height or opacity setting. | number |
colorOptional main decorative color. Every effect except Burned paper supports it; assign undefined to restore the original colors. | string | undefined |
All numeric values must be finite. time and intensity must fit float32. intensity and effect-specific controls clamp to 0–1; the latter accept any finite number. An invalid assignment throws and preserves the previous value. Use one writer per property: direct assignments, a timeline or another animation driver.
See automatic animation and external control and the GSAP guide. The effect instance reference documents state, capture updates and cleanup.
Limits
The effect follows the captured visible shape, including holes and disconnected regions. An opaque image has a rectangular shape. The decorative layer leaves the original content intact.
Only the listed options are public. Every effect except Burned paper permits one main decorative color; gradients, particle counts and whole-element processing are not configurable. Keep the original content usable when output is unavailable. For WebGPU, capture and composition limits, see browser support and troubleshooting.
More energy effects
- FireWarm flames and sparks rise from the visible shape.
attachFire - Kinetic bloomA bright pulse travels around the shape with a violet wake and geometric fragments.
attachKinetic
Compare every effect side by side in the gallery.