Class EventSystem<E>

Basic event emitter system used by Sortable.

Exposed via sortable.eventSystem so plugin authors can subscribe to and emit drag-and-drop lifecycle events. See the Plugin Development Guide (docs/plugin-development.md) for usage patterns.

Public

Type Parameters

E extends Record<string, unknown>
A record mapping event names to their payload types.

Index

Constructors

Methods

Constructors

constructor

new EventSystem<E extends Record<string, unknown>>(): EventSystem<E>
Type Parameters
- E extends Record<string, unknown>
Returns EventSystem<E>

Methods

on

on<K extends string | number | symbol>(
type: K,
listener: Listener<E[K]>,
): () => void
Register an event listener
Type Parameters
- K extends string | number | symbol
Parameters
- type: K
  Event name
- listener: Listener<E[K]>
  Callback to invoke
Returns () => void
Function to unregister the listener
- Defined in src/core/EventSystem.ts:32

off

off<K extends string | number | symbol>(type: K, listener: Listener<E[K]>): void
Remove a previously registered listener
Type Parameters
- K extends string | number | symbol
Parameters
- type: K
- listener: Listener<E[K]>
Returns void
- Defined in src/core/EventSystem.ts:42

emit

emit<K extends string | number | symbol>(type: K, event: E[K]): void
Emit an event to all registered listeners
Type Parameters
- K extends string | number | symbol
Parameters
- type: K
- event: E[K]
Returns void
- Defined in src/core/EventSystem.ts:52