Skip to content

yaijs/yeh

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

11 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

YEH (Yai Event Hub)

⚠️ NOTICE: This repository is now archived for historical reference.

YEH has been integrated directly into @yaijs/core as of v1.1.0. This standalone repository remains available as a reference, but all active development, documentation, and support now happens in the main YaiJS repository.

Migration: Simply install @yaijs/core instead of @yaijs/yeh. All YEH functionality is included.

# Old (deprecated)
npm install @yaijs/yeh

# New (recommended)
npm install @yaijs/core

Documentation: https://yaijs.github.io/yai/docs/yeh/


A lightweight, flexible event handler for modern web applications. Simplifies event management by centralizing listeners and providing advanced routing options.

YEH is fundamentally designed around event delegation - the concept of using a single listener to handle multiple, or even dynamically added elements efficiently and lossless. This isn't just an optimization; it's the entire architectural foundation. Works on file:// with zero build tools.

NPM version License Documentation


✨ Features

  • Event Delegation Made Easy: One listener handles dynamic elements with scope-based routing.
  • Automatic Target Resolution: Handles nested elements (e.g., SVGs in buttons).
  • Throttle & Debounce Support: Built-in performance controls.
  • Dynamic Listener Management: Add/remove events at runtime.
  • Flexible Handler Resolution: Class methods, external maps, or globals.
  • Multi-Handler System: Closest-match resolution for nested components.
  • Performance Tracking: Optional metrics for optimization.
  • No Dependencies: ~5kB gzipped, enterprise-ready (729 LOC).

For advanced patterns (e.g., reactive state, super delegation), see README.USAGE.md. For internals, see README.TECHNICAL.md.


πŸš€ Quick Start

No setup, no build step, no server, just include the file.

Get started in 30 seconds – try it live on JSFiddle

<!DOCTYPE html>
<html>
<head><title>YEH Demo</title></head>
<body>
  <div id="app">
    <button data-action="save">Save</button>
    <button data-action="delete">Delete</button>
  </div>

  <script type="module">
    import YEH from 'https://cdn.jsdelivr.net/npm/@yaijs/yeh@1.0.4/+esm'

    class MyHandler extends YEH {
      constructor() {
        super({ '#app': ['click'] }); // Falls back to handleClick() = "handle + click"
      }

      handleClick(event, target, container) {
        const action = target.dataset.action;
        if (action && this[action]) this[action](target, event, container);
      }

      save(target)   { console.log('Saving...'); }
      delete(target) { console.log('Deleting...'); }
    }

    new MyHandler(); // Adding listeners Done
  </script>
</body>
</html>

30-second setup: Create app.html, copy & paste the above code, then double-click to run.

πŸ’‘ Universal Delegation Pattern

One listener on parent + custom-selector = handles unlimited elements within the parent


Installation

CDN (Instant Setup)

<!-- ESM (Recommended) -->
<script type="module">
  import { YEH } from 'https://cdn.jsdelivr.net/npm/@yaijs/yeh@1.0.4/yeh.js';
  new YEH({ '#app': ['click'] });
</script>

<!-- Or: Global script (legacy, no import needed) -->
<script src="https://cdn.jsdelivr.net/npm/@yaijs/yeh@1.0.4/yeh.js"></script>
<script>
  // YEH is now available globally
  new YEH({ '#app': ['click'] });
</script>

NPM (Build Tools)

npm install @yaijs/yeh
// In your code (ESM)
import { YEH } from '@yaijs/yeh';

Important: Package is ESM-only. Use import, not require().

Direct Download

Download yeh.js Download yeh.d.ts

Works with file:// protocol β€” no server needed.


βš™οΈ Configuration Options

Pass a third argument to the constructor to enable advanced features:

Option Type Default Description
enableStats boolean false Track performance metrics like event count and distance cache hits.
methods object null External method map for organizing handlers by event type.
enableGlobalFallback boolean false Fallback to global window functions when no method is found.
methodsFirst boolean false Check methods object before class methods during handler resolution.
passiveEvents array auto Override default passive events (scroll, touch, wheel, pointer).
abortController boolean false Enable AbortController support for programmatic listener removal.
enableDistanceCache boolean true Cache DOM distance calculations for performance (multi-handler scenarios).

Example: new YEH(events, aliases, { enableStats: true });


πŸ”— Fluent Chaining API

Chain operations for complex event orchestration:

App.on('data-ready', 'handleData')
    .on('user-login', 'handleLogin')
    .emit('init-complete', { loaded: true });

🧹 Cleanup

handler.destroy(); or handler.abort(); (if enabled).


πŸ“Š Performance Metrics

With enableStats: true: console.log(handler.getStats());


🌐 Browser Support

Opera | Chrome | Firefox | Safari | Edge - all modern versions

Works with legacy browsers via Webpack + Babel.


πŸ“Š Comparison vs Popular Libraries

Feature YEH EventEmitter3 Redux Toolkit jQuery
Bundle Size 5kB gzipped 7kB gzipped 12kB+ gzipped 30kB+ gzipped
Dependencies βœ… Zero βœ… Zero ❌ Many βœ… Zero
Event Delegation βœ… Advanced ❌ None ❌ None βœ… Basic
Multi-Handler System βœ… Unique ❌ None ❌ None ❌ None
Throttle/Debounce βœ… Built-in ❌ None ❌ None ❌ None
Native Browser API βœ… Yes ❌ No ❌ No ❌ No
Dynamic Element Support βœ… Zero-config ❌ None ❌ None βœ… Re-bind
TypeScript Support βœ… Full βœ… Partial βœ… Full ⚠️ Community
Memory Leak Prevention βœ… Automatic ⚠️ Manual βœ… Automatic ⚠️ Manual
Performance βœ… Native ⚠️ Synthetic ⚠️ Virtual ⚠️ Abstraction
Custom Event Dispatch βœ… Built-in βœ… Yes βœ… Yes βœ… Yes
Learning Curve βœ… Low βœ… Low ❌ Steep βœ… Familiar

Why YEH Stands Out

  • Smallest footprint with advanced features like multi-handler delegation.
  • Native performance using browser APIs, avoiding synthetic event overhead.
  • Zero dependencies and automatic memory management for scalability.
  • Built-in utilities (throttle, debounce, stats) eliminate external needs.

πŸš€ See It In Action

YaiTabs Tab Browser Demo ~ Advanced Tab System build on YEH

Interactive Examples Hub ~ Beautiful landing page with all examples organized by category

Feature Demonstrations ~ Interactive examples of specific capabilities


πŸ“‚ File Structure

/
β”œβ”€β”€ yeh.js               # Main library
β”œβ”€β”€ yeh.d.ts             # Main TypeScript
β”œβ”€β”€ README.md            # Quick start and core guide
β”œβ”€β”€ README.USAGE.md      # Advanced patterns and techniques
└── README.TECHNICAL.md  # Implementation details and architecture

License

MIT License – free to use in personal or commercial projects.

πŸ‘₯ Authors & Contributors
  • Claude Van DOM - Implementation and optimization
  • Engin Ypsilon - Original concept and architecture
  • The Y-Team - Sunny DeepSeek & Herr Von Grokk