探索 Tiptap V3 的最新功能

添加切换块级节点的按钮

一个用于在您的 Tiptap 编辑器中切换引用块的按钮。

安装

您可以通过 Tiptap CLI(适用于 Vite 或 Next.js)添加此组件:

npx @tiptap/cli add blockquote-button

手动集成

对于除 Vite 或 Next.js 之外的框架,请从开源仓库手动添加该组件。

导入样式

此组件需要您导入我们添加到 styles/keyframe-animation.scssstyles/_variables.scss 的样式。

使用方法

import { EditorContent, EditorContext, useEditor } from '@tiptap/react'
import { StarterKit } from '@tiptap/starter-kit'
import { BlockQuoteButton } from '@/components/tiptap-ui/blockquote-button'

import '@/components/tiptap-node/paragraph-node/paragraph-node.scss'

export default function MyEditor() {
  const editor = useEditor({
    immediatelyRender: false,
    extensions: [StarterKit],
    content: `
        <blockquote>
            <p>"预测未来的最好方法就是发明未来."</p><p>— Alan Kay</p>
        </blockquote>
        `,
  })

  return (
    <EditorContext.Provider value={{ editor }}>
      <div className="tiptap-button-group" data-orientation="horizontal">
        <BlockQuoteButton />
      </div>

      <EditorContent editor={editor} role="presentation" />
    </EditorContext.Provider>
  )
}

属性

名称类型默认值说明
editorEditor | nullnullTiptap 编辑器实例
hideWhenUnavailablebooleanfalse按钮不可用时是否隐藏
textstring-与图标一起显示的文本

要求

使用的参考组件

  • use-tiptap-editor(hook)
  • tiptap-utils(库)
  • button(基础组件)
  • block-quote-icon(图标)