🥚 code-easter-eggs (eggify)

Add hidden easter eggs and cheat codes to your website with one line.

npm install code-easter-eggs

Features

• Lightweight (~1-2 KB gzipped)
• Browser-only (requires DOM and KeyboardEvent API)
• Custom cheat code patterns
• Optional key delay limit
• Works with AbortController
• Ignores input/textarea by default
• Works with modern bundlers (Webpack, Vite, etc.)

Platform Support

• ✅ Browsers (Chrome, Firefox, Safari, Edge)
• ✅ Electron apps
• ✅ Browser extensions
• ❌ Node.js (server-side)
• ❌ React Native
• ❌ Terminal applications

How to use it

ESM (Browser/Bundler)

import { onCheatCode } from "code-easter-eggs";

onCheatCode("↑↑↓↓←→←→BA", () => {
  alert("🥚 Secret unlocked!");
});

CJS (Bundler with CommonJS)

const { onCheatCode } = require("code-easter-eggs");
// Note: Still requires browser environment
onCheatCode("↑↑↓↓←→←→BA", () => {
  console.log("hi!");
});

Browser (UMD/IIFE)

<script src="https://unpkg.com/code-easter-eggs/dist/index.global.js"></script>
<script>

  Eggify.onCheatCode("↑↑↓↓←→←→BA", () => alert("🥚"));

  window.onCheatCode("↑↑↓↓←→←→BA", () => alert("🥚 (shim)"));
</script>

Global

import "code-easter-eggs";
window.onCheatCode!("↑↑↓↓←→←→BA", () => { /* ... */ });

Different ways to introduce codes

Secret code

onCheatCode("↑↑↓↓←→←→BA", () => {
  alert("🥚 Secret unlocked!");
});

Key code

onCheatCode('ArrowUp ArrowUp ArrowDown ArrowDown ArrowLeft ArrowRight ArrowLeft ArrowRight b a', () => {
  showEasterEgg('FAMOUS CODE!<br/>30 Lives Unlocked! 🎮', '🕹️');
});
// Secret code --> dev mode 
onCheatCode('KeyD keyE keyV Space KeyM KeyO KeyD KeyE', () => {
    showEasterEgg('Developer Mode ON<br/>Console access granted! 👨‍💻', '💻');
});

Simple word cheat code

onCheatCode('eggify', () => {
    showEasterEgg('You found the Eggify secret! 🥚✨', '🥚');
});

Number sequence

onCheatCode('1 2 3 4 5', () => {
    showEasterEgg('Numbers are magic! 🔢✨', '🔢');
});

Collaborate

# build
npm run build

# create local package
npm pack

# test in other project
mkdir ../eggify-test && cd ../eggify-test
npm init -y
npm install ../ruta/a/eggify-1.0.0.tgz

# link to dev
npm link
# in eggify-test/
npm link eggify

# serve html example
npx http-server ./local-browser-test -p 4000
# open http://localhost:4000

Size check

npm install -g gzip-size-cli

gzip-size dist/index.js dist/index.cjs dist/index.global.js

1.26 kB

🧠 AI Usage Notice

AI was used as a tool for assistance — for example, to write comments, extract certain types, or configure some options.
However, this is NOT an AI-driven coding project.

If you wish to contribute code that involves AI assistance, please add a comment at the end of the file stating:

// Contains AI-generated code

so it can be reviewed in more detail.

(Fragment created using AI)

I will add custom instructions for copilot in the near future

License

Beerware 🍺 — do whatever you want with it, but if we meet, buy me a beer. (This is essentially MIT-like. Use it freely, but if we meet, buy me a beer)