@mdcrty/bees
v0.1.2
Published
A performant, canvas-based animated bee swarm for React. Designed as a decorative background effect with full-page support, cross-browser fixes, and configurable layering.
Maintainers
Readme
@mdcrty/bees 🐝
A performant, canvas-based animated bee swarm for React.
@mdcrty/bees renders a decorative, full-page bee animation using the HTML canvas.
It is designed for use as a background or ambient visual effect and includes
cross-browser fixes, configurable layering, and sensible defaults for modern React apps.
Features
- 🐝 Animated bee swarm rendered on canvas
- ⚡ Optimised for performance (requestAnimationFrame, idle handling)
- 🧠 Cross-browser fixes (Chrome / Safari / Windows quirks handled)
- 🧩 Works anywhere in the React tree
- 🎚 Configurable density, timing, and animation behaviour
- 🧱 Adjustable
zIndexfor flexible layering - 🧼 No UI framework dependencies
Installation
npm install @mdcrty/beesPeer dependencies:
- react >= 18
- react-dom >= 18
Basic Usage
import { Bees } from "@mdcrty/bees";
export default function Page() {
return <Bees />;
}By default, the animation will start immediately and run as a decorative background.
Props
type BeesProps = {
playAnimation?: boolean;
pause?: boolean;
fps?: number;
beeSize?: number;
beeDensityRatio?: number;
targetHoneycombCoverage?: number;
idleDelaySec?: number;
clusterRampStartSec?: number;
clusterRampStepSec?: number;
zIndex?: number;
};Notable Props
zIndex
Controls how the canvas layers relative to other content.
<Bees zIndex={0} /> // blended with page elements
<Bees zIndex={1} /> // neutral (default)
<Bees zIndex={-1} /> // background
<Bees zIndex={1000} /> // overlayidleDelaySec
Delay (in seconds) before the animation starts or returns after x button press.
<Bees idleDelaySec={30} />Notes on Rendering
- The animation uses a full-document canvas internally.
- Canvas sizing includes defensive fixes for browser scrollbar and sub-pixel rounding issues.
- A small 1px width adjustment is applied intentionally to prevent horizontal overflow on Chrome on Windows.
These behaviours are deliberate and tested across environments.
License
MIT © mdcrty
Links
- GitHub: https://github.com/mdcrty/mdcrty-packages
- npm: https://www.npmjs.com/package/@mdcrty/bees
