Underline

Underline selected text or text typed after enabling the mark.

Setup

Start with the packages in Getting Started. This complete example registers the feature and renders its UI. In an existing editor, merge the imports and extension entries into your setup, and place the controls inside your existing RichTextProvider.

tsx

'use client';

import { EditorContent, useEditor } from '@tiptap/react';
import { Document } from '@tiptap/extension-document';
import { Paragraph } from '@tiptap/extension-paragraph';
import { Text } from '@tiptap/extension-text';
import { RichTextProvider } from 'reactjs-tiptap-editor';
import { TextUnderline, RichTextUnderline } from 'reactjs-tiptap-editor/textunderline';
import 'reactjs-tiptap-editor/style.css';

const extensions = [Document, Paragraph, Text, TextUnderline];

export default function TextUnderlineExample() {
  const editor = useEditor({
    extensions,
    content: '<p>Try this feature here.</p>',
    immediatelyRender: false,
  });

  if (!editor) return null;

  return (
    <RichTextProvider editor={editor}>
      <RichTextUnderline />
      <EditorContent editor={editor} />
    </RichTextProvider>
  );
}