` | Read all current options for a plugin. |\n| `getOption(plugin, key, ...args)` | `(plugin, key, ...args) => value` | Read one option or selector result. Missing stored keys report through `editor.api.debug.error`. |\n| `setOption(plugin, key, value)` | `(plugin, key, value) => void` | Update one option in the plugin store. |\n| `setOptions(plugin, options)` | `(plugin, partialOrRecipe) => void` | Merge a partial object or run a mutative recipe against the plugin state. |\n\n## Initialization\n\n`withPlate` wraps `withSlate` with React defaults. It uses `createZustandStore` for plugin option stores and prepends the React core plugins before user plugins.\n\n```tsx title=\"Create a typed editor\"\nimport { usePlateEditor } from 'platejs/react';\nimport { BoldPlugin } from '@platejs/basic-nodes/react';\n\nexport function useBasicEditor() {\n return usePlateEditor({\n plugins: [BoldPlugin],\n value: [\n {\n type: 'p',\n children: [{ text: 'Bold text is ready.' }],\n },\n ],\n });\n}\n```\n\n`withSlate` does the lower-level setup:\n\n| Step | Behavior |\n| --- | --- |\n| Editor identity | Sets `editor.id`, `editor.meta.key`, `editor.meta.isFallback`, `editor.meta.userId`, and `editor.dom`. |\n| Helper methods | Installs `getApi`, `getTransforms`, `getPlugin`, `getType`, option helpers, and injection helpers. |\n| Core plugins | Resolves core plugins, replaces core plugins with custom plugins that share the same key, and resolves the root plugin. |\n| Components | Merges `components` into root-plugin component overrides. |\n| Normalization guard | Wraps `normalizeNode` so `editor.api.shouldNormalizeNode(entry)` can skip a normalization pass. |\n| Initial value | Calls `editor.tf.init({ value, selection, autoSelect, shouldNormalizeEditor, onReady })` unless `skipInitialization` is `true`. |\n\n`value` accepts a Plate value, an HTML string, or a function that returns the value. `onReady` receives `{ editor, isAsync, value }` after initialization completes.\n\n## Core APIs\n\nThese APIs exist on every Plate editor because core plugins are always resolved before user plugins.\n\n\n\n void\">\n Log a debug message when debug logging is enabled.\n \n void\">\n Log an info message when the configured log level allows it.\n \n void\">\n Log a warning when the configured log level allows it.\n \n void\">\n Throw a `PlateError` by default in development. Configure `DebugPlugin` to change logging or `throwErrors`.\n \n Descendant[]\">\n Deserialize an HTML element into Plate nodes. The HTML parser plugin calls this for `text/html` paste data.\n \n void\">\n Trigger decoration refresh. The React extension warns through `editor.api.debug.warn` until an integration overrides it.\n \n NavigationFeedbackTarget | null\">\n Read the current navigation feedback target and clear it if the stored target no longer resolves.\n \n void\">\n Clear the current navigation feedback target.\n \n boolean\">\n Check whether a path matches the active navigation feedback target.\n \n\n\n\n## Core Transforms\n\nCore transforms live on `editor.tf` and `editor.transforms`. Plugin docs normally show the plugin-specific transform names, but the editor always includes these runtime transforms.\n\n\n\n void\">\n Initialize value, selection, optional normalization, optional auto-selection, and `onReady`.\n \n boolean | undefined\">\n Insert an exit break for plugins that route to the core exit-break transform.\n \n boolean | undefined\">\n Lift the selected block through Plate's block transform wrapper.\n \n boolean | undefined\">\n Reset the selected block to the requested type or default block type.\n \n void\">\n Replace editor children. Use controlled state patterns when React owns the value.\n \n void\">\n Clear navigation feedback state.\n \n boolean\">\n Store a target temporarily so components can render navigation feedback.\n \n boolean\">\n Navigate to a target and flash it through the navigation feedback plugin.\n \n void\">\n React extension wrapper. It restores focus to the editor when the editor was focused before reset.\n \n\n\n\n## Plugin Pipeline Effects\n\nSome core behavior is exposed by overriding existing Slate transforms rather than by adding named methods.\n\n| Plugin | Effect |\n| --- | --- |\n| `ParserPlugin` | Overrides `insertData` and scans plugin parsers in reverse plugin order. Matching parsers transform data, deserialize a fragment, transform the fragment, and insert it. |\n| `LengthPlugin` | Wraps `apply` in `withoutNormalizing` and trims overflow when `maxLength` is configured. |\n| `SlateExtensionPlugin` | Wraps `apply` so `onNodeChange` and `onTextChange` handlers can receive previous and next node or text state. |\n| `SlateReactExtensionPlugin` | Handles line movement, tab, untab, select-all, escape, `currentKeyboardEvent`, focus-preserving reset, and `_memo` cleanup during normalization. |\n| `HtmlPlugin` | Registers the `text/html` parser path and delegates HTML elements to `editor.api.html.deserialize`. |\n| `BaseParagraphPlugin` | Registers the default paragraph element under key `p` and maps HTML `` elements, excluding code-font paragraphs. |\n\n## Type Helpers\n\nUse `TPlateEditor` when you want an editor typed to a specific value and plugin union.\n\n```ts title=\"Typed editor helper\"\nimport type { TPlateEditor } from 'platejs/react';\nimport type { Value } from 'platejs';\nimport { BoldPlugin } from '@platejs/basic-nodes/react';\n\ntype BasicEditor = TPlateEditor;\n```\n\n| Type | Purpose |\n| --- | --- |\n| `PlateEditor` | Runtime editor type with the default Plate core plugin surface. |\n| `TPlateEditor` | Typed editor for a specific `Value` and plugin union. |\n| `KeyofPlugins` | String key union for Plate core plugins plus the supplied plugin config union. |\n\n## Related APIs\n\n- [Plate components](/docs/api/core/plate-components) covers `Plate`, `PlateContent`, `PlateView`, and component-layer runtime effects.\n- [PlateController](/docs/api/core/plate-controller) covers active, primary, and fallback editor lookup.\n- [Plate plugin](/docs/api/core/plate-plugin) covers plugin configuration, methods, options, handlers, and render hooks.\n- [Controlled Value](/docs/controlled) covers React-owned value patterns around `editor.tf.setValue`.\n",
"type": "registry:file",
"target": "content/docs/plate/api/core/plate-editor.mdx"
}
],
"type": "registry:file"
}