Plate
PlateEditorsTemplates
GitHub16kGitHub
DiscordDiscord
    • Overview
    • Why This Fork
    • Examples
    • Installing Plite
    • Adding Event Handlers
    • Defining Custom Elements
    • Applying Custom Formatting
    • Executing Commands
    • Saving to a Database
    • Canonical Change Substrate
    • Improving Performance
    • Interfaces
    • Nodes
    • Locations
    • Transforms
    • Document Changes
    • Commands
    • Editor
    • Plugins
    • Rendering
    • Serializing
    • Normalizing
    • Using TypeScript
    • Roots
    • Document State
    • Editing Behavior
    • Selection And DOM
    • Clipboard And Paste
    • Decorations, annotations, and widgets
    • Schema
    • Anchor API
    • Location API
    • Path API
    • PointEntry API
    • Point API
    • Range API
    • Selection API
    • Location Types APIs
    • Span API
    • Editor
    • Element API
    • NodeEntry API
    • Node API
    • Node Types APIs
    • Text API
    • Debug Value Scrubbing
    • Transforms API
    • Plite DOM
    • History Editor API
    • History Plugin Setup
    • History
    • Plite History
    • Plite Hyperscript
    • Plite PaginationExperimental
    • Annotations
    • DOM Coverage Boundaries
    • Editable Component
    • External Text Views
    • Plite React Event Handling
    • Virtualized Rendering
    • Plite React Hooks
    • React Editor Setup
    • React Editor
    • Plite React
    • Plite Component
    • Plite Yjs
    • Plite
    • Migration
    • Contributing
    • FAQ
    • Resources

Plite React Event Handling

PreviousNext

Customize Editable browser events without replacing Plite's default editing runtime.

Editable owns the default browser event handlers for rich-text editing, including copy, paste, drop, keyboard, native input, selection, focus, and drag events.

Pass event handlers to Editable when app UI needs to run before Plite's default behavior.

Use Editing Behavior when the behavior belongs in transactions or a typed plugin command handler instead of one Editable event prop.

Handler return values

Handler return values control whether Plite continues with its own handling:

  • Return true to mark the event handled and skip Plite's default handler.
  • Return false to force Plite's default handler to run.
  • Return nothing to let Plite continue unless the event is default-prevented or propagation-stopped.
import type { DragEvent, MouseEvent } from "react";
import { Editable } from "plitejs/react";
 
const MyEditor = () => {
  const onClick = (event: MouseEvent<HTMLDivElement>) => {
    trackEditorClick(event);
 
    // Plite runs its click handler unless this handler prevents default,
    // stops propagation, or returns true.
  };
 
  const onDrop = (event: DragEvent<HTMLDivElement>) => {
    if (!isAppOwnedDrop(event)) return false;

Editor-aware handlers

Use onKeyDown and onDOMBeforeInput when a handler needs editor context:

<Editable
  onDOMBeforeInput={(event, { editor, inputType }) => {
    if (inputType !== "formatBold") return false;
 
    editor.update.marks.toggle("bold");
 
    return true;
  }}
  onKeyDown={(event, { editor }) => {
    if (!(event.metaKey && event.key === "k")) return false;
 
    editor.update((tx) => {
External Text ViewsVirtualized Rendering

On This Page

Handler return valuesEditor-aware handlers
Build your editor
Production-ready AI template and reusable components.
Get all-access
insertAppOwnedDrop(event);
return true;
};
const onDragStart = (event: DragEvent<HTMLDivElement>) => {
annotateDragPayload(event);
return false;
};
return (
<Editable onClick={onClick} onDrop={onDrop} onDragStart={onDragStart} />
);
};
import type { DragEvent, MouseEvent } from "react";
import { Editable } from "plitejs/react";
 
const MyEditor = () => {
  const onClick = (event: MouseEvent<HTMLDivElement>) => {
    trackEditorClick(event);
 
    // Plite runs its click handler unless this handler prevents default,
    // stops propagation, or returns true.
  };
 
  const onDrop = (event: DragEvent<HTMLDivElement>) => {
    if (!isAppOwnedDrop(event)) return false;
 
    insertAppOwnedDrop(event);
 
    return true;
  };
 
  const onDragStart = (event: DragEvent<HTMLDivElement>) => {
    annotateDragPayload(event);
 
    return false;
  };
 
  return (
    <Editable onClick={onClick} onDrop={onDrop} onDragStart={onDragStart} />
  );
};
tx.text.
insert
(
"link"
);
});
return true;
}}
/>
<Editable
  onDOMBeforeInput={(event, { editor, inputType }) => {
    if (inputType !== "formatBold") return false;
 
    editor.update.marks.toggle("bold");
 
    return true;
  }}
  onKeyDown={(event, { editor }) => {
    if (!(event.metaKey && event.key === "k")) return false;
 
    editor.update((tx) => {
      tx.text.insert("link");
    });
 
    return true;
  }}
/>