U
udecode/plate
ai-api
AIai-docsAI-powered writing assistance.
cnapi-cn-docsAPI reference for @udecode/cn.
Plate Coreapi-core-docsAPI reference for @platejs/core.
Plate Componentsapi-core-plate-components-docsAPI reference for Plate React components.
Plate Controllerapi-core-plate-controller-docsAPI reference for PlateController.
Plate Editorapi-core-plate-editor-docsAPI reference for the Plate editor runtime.
Plate Pluginapi-core-plate-plugin-docsAPI reference for Plate plugins.
Storeapi-core-plate-store-docsAPI reference for Plate store.
Floatingapi-floating-docsAPI reference for @platejs/floating.
Plateapi-plate-docsAPI reference for the platejs package.
React Utilsapi-react-utils-docsAPI reference for @udecode/react-utils.
Resizableapi-resizable-docsAPI reference for @platejs/resizable.
Slateapi-slate-docsAPI reference for @platejs/slate.
Editor APIapi-slate-editor-api-docsAPI reference for the Editor API.
Editor Transformsapi-slate-editor-transforms-docsAPI reference for editor transformation operations in Plate.
Elementapi-slate-element-docsAPI reference for elements in Slate.
Locationapi-slate-location-docsAPI reference for locations in Plate.
Location Refapi-slate-location-ref-docsAPI reference for location references in Plate.
Nodeapi-slate-node-docsAPI reference for nodes in Plate.
Operationapi-slate-operation-docsAPI reference for operations in Plate.
Pathapi-slate-path-docsAPI reference for paths in Plate.
Pointapi-slate-point-docsAPI reference for points in Plate.
Rangeapi-slate-range-docsAPI reference for ranges in Plate.
Textapi-slate-text-docsAPI reference for text nodes in Plate.
Plate Utilsapi-utils-docsAPI reference for @platejs/utils.
Autoformatautoformat-docsMarkdown shortcuts and text substitutions powered by input rules.
Basic Blocksbasic-blocks-docsParagraphs, headings, blockquotes, and horizontal rules.
Basic Marksbasic-marks-docsCommon inline text formatting marks.
Block Menublock-menu-docsContext-menu actions for selected editor blocks.
Block Placeholderblock-placeholder-docsPlaceholder text for the active empty block.
Block Selectionblock-selection-docsDocumentation for Block Selection
Blockquoteblockquote-docsDocumentation for Blockquote
Boldbold-docsAdd strong inline text formatting.
Calloutcallout-docsDocumentation for Callout
Captioncaption-docsAdd captions to media elements like images, videos, and files.
Code Blockcode-block-docsDocumentation for Code Block
Codecode-docsAdd inline code formatting.
Code Drawingcode-drawing-docsDocumentation for Code Drawing
Columncolumn-docsDocumentation for Column
Comboboxcombobox-docsDocumentation for Combobox
Commentcomment-docsDocumentation for Comment
Controlled Editor Valuecontrolled-docsControl initial values, persistence, replacement, and async initialization.
copilot-api
Copilotcopilot-docsAI-powered text completion suggestions.
Serializing CSVcsv-docsDocumentation for Serializing CSV
Cursor Overlaycursor-overlay-docsVisual feedback for selections and cursor positions when editor loses focus.
Datedate-docsInline void date elements with canonical and raw date storage.
Debuggingdebugging-docsDebugging in Plate.
Discussiondiscussion-docsDocumentation for Discussion
Drag & Dropdnd-docsDrag and drop blocks to reorganize content within the editor.
DocumentationdocsAll documentation files for plate
Documentation metadatadocs-metaFumadocs metadata for plate documentation
DOCX Pastedocx-docsPaste content from Microsoft Word with automatic formatting.
DOCX Import/Exportdocx-io-docsImport DOCX files and export Plate content to Word documents.
Editing Behaviorediting-behavior-docsHow Plate handles Enter, Backspace, merge, normalize, and selection behavior.
Editor Configurationeditor-docsLearn how to configure and customize the Plate editor.
Editor Methodseditor-methods-docsRead, mutate, and configure a Plate editor instance.
Emojiemoji-docsInline emoji search and toolbar emoji picking.
Equationequation-docsBlock and inline LaTeX equation nodes rendered with KaTeX.
Collaboration Demoexamples-collaboration-example-docsReal-time Plate collaboration example with Yjs providers and remote cursors.
Editable Voidsexamples-editable-voids-docsNest editable controls and a Plate editor inside a void element.
Exportexamples-export-docsExport a Plate document to HTML, PDF, image, Markdown, or Word.
Huge Documentexamples-huge-document-docsDocumentation for Huge Document
Hundreds Editorsexamples-hundreds-editors-docsRender many independent Plate editors on one page.
Preview Markdownexamples-preview-markdown-docsDecorate text ranges so Markdown syntax previews inline.
Version Historyexamples-version-history-docsSave Plate value snapshots and render a diff against the live editor.
Excalidrawexcalidraw-docsVoid Excalidraw drawing blocks stored inside Plate values.
Exit Breakexit-break-docsDocumentation for Exit Break
Feature Kitsfeature-kits-docsUse registry kits to add groups of Plate plugins and UI wiring.
Findfind-replace-docsHighlight search matches in editable text.
Fontfont-docsProvide extended formatting options for document content.
Footnotefootnote-docsDocumentation for Footnote
Forced Layoutforced-layout-docsPath-based normalization for required document structure.
Formform-docsHow to integrate Plate editor with react-hook-form.
Fumadocs appfumadocsFumadocs app for plate
Headingheading-docsH1 through H6 block elements with shortcuts, input rules, and static renderers.
Highlighthighlight-docsAdd marked inline text.
Horizontal Rulehorizontal-rule-docsVoid divider blocks rendered as horizontal rules.
HTMLhtml-docsConvert Plate content to HTML and vice-versa.
Indentindent-docsDocumentation for Indent
Introductionindex-docsBuild rich-text editors with Plate, Plate UI, AI, MCP, and shadcn/ui.
Getting Startedinstallation-docsChoose the right Plate installation path for your React project.
Local Docsinstallation-docs-docsSet up Plate's documentation locally for version-controlled, AI-enhanced development.
Manual Installationinstallation-manual-docsInstall and configure Plate in your React project without relying on UI component libraries.
MCP Serverinstallation-mcp-docsUse the Model Context Protocol with Plate.
Next.jsinstallation-next-docsInstall and configure Plate UI for Next.js
Node.jsinstallation-node-docsInstall and configure Plate for Node.js.
Plate UIinstallation-plate-ui-docsInstall, customize, and sync copied Plate UI components.
Reactinstallation-react-docsInstall and configure Plate UI for React
RSCinstallation-rsc-docsInstall and configure Plate for React Server Components.
Italicitalic-docsAdd emphasized inline text.
Keyboard Inputkbd-docsStyle keyboard shortcuts and key names.
Line Heightline-height-docsSet block line height.
Linklink-docsDocumentation for Link
List Classiclist-classic-docsDocumentation for List Classic
Listlist-docsDocumentation for List
Markdownmarkdown-docsConvert Plate content to Markdown and vice-versa.
Mediamedia-docsDocumentation for Media
media-uploadthing-api
Mentionmention-docsInline markable void mentions backed by trigger combobox input.
From Slate to Platemigration-slate-to-plate-docsMove a Slate React editor to Plate's editor, plugin, and rendering model.
Major Releases up to v48migration-v48-docsHistorical upgrade notes for Plate apps on v48 and earlier.
Multi Selectmulti-select-docsDocumentation for Multi Select
Navigation Feedbacknavigation-feedback-docsFlash a landed target after TOC, footnote, search, or custom navigation jumps.
Performanceperformance-docsLatest Plate vs Slate large-document benchmark snapshot and how to rerun it locally.
Playwright Testingplaywright-docsLearn how to write Playwright tests that integrate with Plate.
Plugin Componentsplugin-components-docsRender Plate plugin nodes with React components.
Plugin Contextplugin-context-docsUse editor, plugin, option, API, and transform context inside Plate plugins.
Plugin Configurationplugin-docsHow to configure and customize Plate plugins.
Plugin Input Rulesplugin-input-rules-docsTyped editor rules for markdown shortcuts, block fences, autolinks, and text substitutions.
Plugin Methodsplugin-methods-docsConfigure, extend, and override Plate plugins.
Plugin Rulesplugin-rules-docsConfigure common editing behaviors.
Plugin Shortcutsplugin-shortcuts-docsConfigure keyboard shortcuts on Plate plugins.
Releasesreleases-index-docsDocumentation for Releases
Single Blocksingle-block-docsRestrict an editor to one root block or one line of text.
Slash Commandslash-command-docsDocumentation for Slash Command
Static Renderingstatic-docsA minimal, memoized, read-only version of Plate with RSC/SSR support.
Strikethroughstrikethrough-docsStrike through inline text.
Subscriptsubscript-docsFormat inline text below the baseline.
Suggestionsuggestion-docsDocumentation for Suggestion
Superscriptsuperscript-docsFormat inline text above the baseline.
Tabbabletabbable-docsDocumentation for Tabbable
Tabletable-docsDocumentation for Table
Text Aligntext-align-docsAlign block content.
Table of Contentstoc-docsDocumentation for Table of Contents
Toggletoggle-docsDocumentation for Toggle
Toolbartoolbar-docsFixed and floating toolbars for your editor.
Trailing Blocktrailing-block-docsKeep a required block at the end of an editor or nested level.
Troubleshootingtroubleshooting-docsDiagnose common Plate setup and runtime issues.
TypeScripttypescript-docsConfigure TypeScript (tsconfig) for using Plate, including module resolution solutions.
Underlineunderline-docsAdd underlined inline text.
Unit Testing Plateunit-testing-docsLearn how to unit test Plate editor and plugins.
Collaborationyjs-docsReal-time collaboration with Yjs