ra-input-rich-text

ra-input-rich-text

A rich text editor for React Admin, based on TipTap.

Installation

npm install ra-input-rich-text
# or
yarn add ra-input-rich-text

Usage

Use it as you would any react-admin input:

import { Edit, SimpleForm, TextInput } from 'react-admin';
import { RichTextInput } from 'ra-input-rich-text';

export const PostEdit = () => (
  <Edit>
    <SimpleForm>
      <TextInput source="title" />
      <RichTextInput source="body" />
    </SimpleForm>
  </Edit>
);

Customizing the Toolbar

The <RichTextInput> component has a toolbar prop that accepts a ReactNode.

You can leverage this to change the buttons size:

import { Edit, SimpleForm, TextInput } from 'react-admin';
import { RichTextInput, RichTextInputToolbar } from 'ra-input-rich-text';

export const PostEdit = () => (
  <Edit>
    <SimpleForm>
      <TextInput source="title" />
      <RichTextInput source="body" toolbar={<RichTextInputToolbar size="large" />} />
    </SimpleForm>
  </Edit>
);

Or to remove some prebuilt components like the <AlignmentButtons>:

import {
  RichTextInput,
  RichTextInputToolbar,
  LevelSelect,
  FormatButtons,
  ListButtons,
  LinkButtons,
  QuoteButtons,
  ClearButtons,
} from 'ra-input-rich-text';

const MyRichTextInput = ({ size, ...props }) => (
  <RichTextInput
    toolbar={
      <RichTextInputToolbar>
        <LevelSelect size={size} />
        <FormatButtons size={size} />
        <ListButtons size={size} />
        <LinkButtons size={size} />
        <QuoteButtons size={size} />
        <ClearButtons size={size} />
      </RichTextInputToolbar>
    }
    label="Body"
    source="body"
    {...props}
  />
);

Customizing the editor

You might want to add more TipTap extensions. The <RichTextInput> component accepts an editorOptions prop, which is the object passed to the TipTap Editor.

If you just want to add extensions, don't forget to include those needed by default for our implementation. Here's an example to add the HorizontalRule node:

import {
  DefaultEditorOptions,
  RichTextInput,
  RichTextInputToolbar,
  LevelSelect,
  FormatButtons,
  AlignmentButtons,
  ListButtons,
  LinkButtons,
  QuoteButtons,
  ClearButtons,
} from 'ra-input-rich-text';
import HorizontalRule from '@tiptap/extension-horizontal-rule';
import Remove from '@mui/icons-material/Remove';

const MyRichTextInput = ({ size, ...props }) => (
  <RichTextInput
    editorOptions={MyEditorOptions}
    toolbar={
      <RichTextInputToolbar>
        <LevelSelect size={size} />
        <FormatButtons size={size} />
        <AlignmentButtons {size} />
        <ListButtons size={size} />
        <LinkButtons size={size} />
        <QuoteButtons size={size} />
        <ClearButtons size={size} />
        <ToggleButton
          aria-label="Add an horizontal rule"
          title="Add an horizontal rule"
          onClick={() => editor.chain().focus().setHorizontalRule().run()}
          selected={editor && editor.isActive('horizontalRule')}
        >
          <Remove fontSize="inherit" />
      </ToggleButton>
      </RichTextInputToolbar>
    }
    label="Body"
    source="body"
    {...props}
  />
);

export const MyEditorOptions = {
  ...DefaultEditorOptions,
  extensions: [
    ...DefaultEditorOptions.extensions,
        HorizontalRule,
  ],
};

License

This data provider is licensed under the MIT License, and sponsored by Marmelab.

Changelog

5.8.0

• Add <InPlaceEditor> for edit-in-place (#10690) (fzaninotto)
• Add <DataTable> component (#10597) (fzaninotto)
• Add <AuthLayout> to share layout of login page with register & forgot password pages (#10640) (djhi)
• Add support for defaultProps override via theme (#10655) (djhi)
• Add support for MUI v7 (#10639) (djhi)
• Add ability to configure <Loading> timeout (#10689) (WiXSL)
• Improve <DeleteButton> and <UpdateButton> confirmation wording using record representation (#10654) (djhi)
• [Doc] Rewrite <AutocompleteArrayInput> create doc example (#10700) (Cimanel)
• [chore] create-react-admin: Remove sourcemaps from production build (#10693) (slax57)
• Bump json-graphql-server to 3.2.0 (#10713) (fzaninotto)
• Bump react-router from 7.1.1 to 7.5.3 (#10712) (fzaninotto)