README.md

mui-tiptap-editor

A customizable and easy to use Tiptap styled WYSIWYG rich text editor, using Material UI.

Table of Contents

• mui-tiptap-editor
  • Table of Contents
  • Demo
  • Installation
  • Get started
    • Simple usage
    • Using mentions
    • Image upload
    • Read only
  • Customization
    • Toolbar
    • Override labels
    • Styles
      • Root styles
      • Each element styles
  • Props
    • ImageUploadOptions
  • New features
  • Contributing

Demo

• CodeSandbox demo
• Live demo
• Demo video

Installation

npm install mui-tiptap-editor

or

yarn add mui-tiptap-editor

Please note that @mui/material (and their @emotion/ peers) are peer dependencies, meaning you should ensure they are installed before installing mui-tiptap-editor.

npm install @mui/material @emotion/react @emotion/styled

or

yarn add @mui/material @emotion/react @emotion/styled

Get started

Simple usage

import { TextEditor, TextEditorReadOnly } from 'mui-tiptap-editor';
import { useState } from "react";

function App() {
  const [value, setValue] = useState<string>("");

  const handleChange = (newValue: string) => setValue(newValue);

  return (
    <div>
      <TextEditor value={value} onChange={handleChange} />
      {value && <TextEditorReadOnly value={value} />}
    </div>
  );
}

Using mentions

import { TextEditor, ITextEditorOption } from 'mui-tiptap-editor';

const mentions: ITextEditorOption[] = [
  { label: "Lea Thompson", value: "id1" },
  { label: "Cyndi Lauper", value: "id2" },
  { label: "Tom Cruise", value: "id3" },
];

const currentUser: ITextEditorOption = mentions[0];

function App() {
  return (
    <TextEditor mentions={mentions} user={currentUser} userPathname="/profile" />
  );
}

Image upload

Here is the corrected English version:

<ul>
  <li>The image can be uploaded to the server via an API call or inserted directly into the content as a base64 string.</li>
  <li>The image can be uploaded using the upload button, or pasted or dropped.</li>
  <li>Add or modify the alt text and the caption (title) of the image.</li>
  <li>Delete the selected image using the `Delete` key on the keyboard.</li>
</ul>

// Example of an API upload using fetch
// The returned data must be the image URL (string) or image attributes (object) such as src, alt, id, title, etc.
const uploadFile = async (file: File) => {
  const formData = new FormData();
  formData.append("file", file);
  const response = await fetch("https://api.escuelajs.co/api/v1/files/upload", {
    method: "POST",
    body: formData,
  });
  const data = await response.json();
  // or return data.location
  return { id: data.filename, src: data.location };
};

function App() {
  return (
    <TextEditor
      uploadFileOptions={{
        uploadFile, // the image is stored and used as base64 string if not specified
        maxSize: 5, // max size to 10MB if not specified
        maxFilesNumber: 2,  // max 5 files if not specified
        allowedMimeTypes: ['image/jpeg', 'image/png', 'image/jpg'], // all image types if not specified
        imageMaxWidth: 400, // default to 1920
        imageMaxHeight: 400, // default to 1080
      }}
    />
  );
}

See here for more examples that use TextEditor.

Read only

1. If using the editor

import { TextEditorReadOnly } from 'mui-tiptap-editor';

<TextEditorReadOnly value="<h1>Hello word!</h1>" />

2. If you only need to display the value without using the editor, you can use this library: tiptap-parser. Example: The editor is used in the back office, but the content must be displayed on the website.

<TiptapParser content="<h1>Hello world</h1>" />

Customization

Toolbar

Can display the menus as required.

  <TextEditor toolbar={['bold', 'italic', 'underline']} />

Override labels

  <TextEditor
    labels={{
      editor: {
        editor: "Editeur",
        preview: "Aperçu"
      },
      toolbar: {
        bold: "Gras",
        upload: "Ajouter une image",
        // ...
      },
      headings: {
        h1: "En-tête 1",
        // ...
      },
      table: {
        table: "Tableau",
        deleteColumn: "Supprimer la colonne",
        // ....
      },
      link: {
        link: "Lien",
        // ...
      },
      youtube: {
        link: "Lien",
        insert: "Insérer la vidéo Youtube",
        title: "Insérer une vidéo Youtube",
      },
      upload: {
        fileTooLarge: "Fichier trop volumineux",
        // ...
      }
    }}
  />

Styles

Root styles

import './index.css';

<TextEditor
  value="<p>Hello word!</p>"
  rootClassName="root"
/>

/* ./index.css */
.root {
  background-color: #fff;
}
.root  .MuiTab-root.Mui-selected {
  background-color: yellow;
}

Each element styles

<TextEditor
  value="<p>Hello word!</p>"
  label="Content"
  tabClassName="bg-black"
  labelClassName="text-sm"
  inputClassName="border border-gray-200"
  toolbarClassName="bg-gray-500"
/>
}

Props

props	type	Default value	Description
toolbar	string[]	heading, bold, italic, strike, link, underline, image, code, orderedList, bulletList, align, codeBlock, blockquote, table, history, youtube, color, mention	The list of the menu buttons to be displayed
placeholder	string	empty	input placeholder
label	string	empty	input label
error	string	empty	Error message to display
withFloatingMenu	boolean	false	Show or hide the floating menu
withBubbleMenu	boolean	true	Show or hide the bubble menu
inputClassName	string	empty	Override input styles
toolbarClassName	string	empty	Override the toolbar menu styles
tabsClassName	string	empty	Override the tabs (preview, editor) styles
tabClassName	string	empty	Override the tab (preview or editor) styles
errorClassName	string	empty	Override the error message styles
rootClassName	string	empty	Override the main container styles
labelClassName	string	empty	Override the label styles
bubbleMenuToolbar	string[]	['bold', 'italic', 'underline', 'link']	Similar to toolbar props
floatingMenuToolbar	string[]	['bold', 'italic', 'underline', 'link']	Similar to toolbar props
mentions	ITextEditorOption[]	undefined	List of users to be mentioned when entering or selecting @
user	ITextEditorOption	undefined	Current user
value	string	empty	Value of the input
onChange	(value: string) => void	-	Function to call when the input change
userPathname	string	/user	URL pathname for the mentioned user (eg: /user/user_id)
labels	ILabels	null	Override labels, for example using i18n
disableTabs	boolean	false	If true, the Editor/Preview tabs are hidden.
toolbarPosition	top or bottom	bottom	Position of the toolbar
id	string	empty	Used if using multiple editors on the same page, to identify uniquely each editor
uploadFileOptions	ImageUploadOptions	null	Override image upload default options like max size, max file number, ...
...all tiptap features	EditorOptions	empty	Can access to all tiptap useEditor props

See here how to use all the TextEditor props.

ImageUploadOptions

props	type	Default value	Description
uploadFile	function	undefined	an API call to your server to handle and store the image
maxSize	number	10	maximum size of the image in MB
maxFilesNumber	number	5	maximum number of files to be uploaded at once
allowedMimeTypes	string[]	null	all image types
imageMaxWidth	number	1920	maximum width of the image
imageMaxHeight	number	1080	maximum height of the image
maxMediaLegendLength	number	100	maximum character length of the image legend

New features

Versions	Features
v0.11.0	Can use both inline code and code blocks.
v0.10.0	Can position the toolbar at the top or bottom.
v0.09.33	Can show or hide Editor/Preview tabs.
v0.9.29	Compatible with Next.js (v13+). See example
v0.9.19	Copy the code block
v0.9.11	Upload image via drop, paste or upload button Add or edit the image alt text and legend Reorder toolbar menus

Contributing

Get started here.