提及用户的下拉菜单

Available in Start plan

一个完全集成可访问性的提及用户下拉菜单,适用于 Tiptap 编辑器。支持键盘快捷键,且可灵活定制,轻松提及用户。

安装

通过 Tiptap CLI 添加该组件:

npx @tiptap/cli@latest add mention-dropdown-menu

组件

<MentionDropdownMenu />

一个预构建的 React 组件,提供在 Tiptap 编辑器中提及用户的下拉菜单。

使用示例

import { EditorContent, EditorContext, useEditor } from '@tiptap/react'

// --- Tiptap 核心扩展 ---
import { StarterKit } from '@tiptap/starter-kit'
import { Mention } from '@tiptap/extension-mention'

// --- Tiptap UI ---
import { MentionDropdownMenu } from '@/components/tiptap-ui/mention-dropdown-menu'

// --- Tiptap 节点 ---
import '@/components/tiptap-node/code-block-node/code-block-node.scss'
import '@/components/tiptap-node/paragraph-node/paragraph-node.scss'

export const MentionDropdownMenuExample = () => {
  const editor = useEditor({
    immediatelyRender: false,
    extensions: [StarterKit, Mention],
    content: `
        <p>尝试输入 <code>@</code> 来打开提及下拉菜单。</p>
        `,
  })

  return (
    <EditorContext.Provider value={{ editor }}>
      <MentionDropdownMenu />
      <EditorContent editor={editor} role="presentation" />
    </EditorContext.Provider>
  )
}

属性

MentionDropdownMenu 继承自 SuggestionMenuProps 的所有属性。