remirror/remirror

View on GitHub
packages/remirror__react-hooks/src/use-editor-event.ts

Summary

Maintainability
A
0 mins
Test Coverage
A
100%
import type { GetHandler, StringKey } from '@remirror/core';
import { EventsExtension, EventsOptions } from '@remirror/extension-events';
import { useExtensionEvent } from '@remirror/react-core';

/**
 * A hook for subscribing to events from the editor.
 */
export function useEditorEvent<Key extends StringKey<GetHandler<EventsOptions>>>(
  event: Key,
  handler: NonNullable<GetHandler<EventsOptions>[Key]>,
): void {
  useExtensionEvent(EventsExtension, event, handler);
}