plate-handler
使用 Plate.js 实现富文本编辑器。支持创建简单(评论/聊天)和详细(文档/博客)编辑器。
📖 中文导读:使用 Plate.js 实现富文本编辑器。支持创建简单(评论/聊天)和详细(文档/博客)编辑器。 以下正文为该技能的原始 SKILL.md 内容(英文),上方安装命令可直接使用。
name: plate-handler description: Implement rich text editors using Plate.js. Supports creating both simple (comment/chat) and detailed (document/blog) editors. tools: run_terminal_cmd, read_file, write model: inherit
Plate.js Editor Handler
Instructions
1. Installation & Setup
Use the shadcn CLI to install Plate components.
- Core Installation:
pnpm dlx shadcn@latest add @plate/editor - Basic Nodes:
pnpm dlx shadcn@latest add @plate/basic-nodes-kit @plate/fixed-toolbar @plate/mark-toolbar-button - Preset (Optional): For a quick comprehensive setup, use
pnpm dlx shadcn@latest add @plate/editor-basic.
2. Choosing an Editor Type
Decide based on the user's requirement:
A. Small Editor (Comments, Chat, Bio)
- Goal: Minimal distraction, basic formatting.
- Plugins: Bold, Italic, Underline, maybe Link.
- UI: Simple
FixedToolbaror no toolbar (shortcuts only). - Location:
src/components/plate-editor/simple-editor.tsx
B. Detailed Editor (Blog, Documents, CMS)
- Goal: Full content creation capabilities.
- Plugins: Headings (H1-H3), Blockquote, Lists, Images, Media, Tables.
- UI: Full
FixedToolbarwith multiple groups, Floating Toolbar. - Location:
src/components/plate-editor/detailed-editor.tsx
3. Implementation Steps
- Scaffold Components: Ensure the base UI components (
Editor,EditorContainer,Toolbar) are installed in@/components/ui. - Create Editor Component: Create the wrapper component using
usePlateEditorand<Plate>. - Configure Plugins: Import and add plugins to the
pluginsarray. - Bind UI: Add
FixedToolbarand buttons (MarkToolbarButton,ToolbarButton) inside the<Plate>provider. - State Management: Use
valueandonChangeprops on<Plate>to handle content. Sync withlocalStorageor form state as needed.
4. Reference & Docs
See reference.md for code snippets, CLI commands, and configuration details.