ra-input-rich-text
ra-input-rich-text
npm i ra-input-rich-text
ra-input-rich-text

ra-input-rich-text

A frontend Framework for building B2B applications running in the browser on top of REST/GraphQL APIs, using ES6, React and Material Design

by marmelab

4.7.2 (see all)License:MITTypeScript:Built-In
npm i ra-input-rich-text
Readme

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 inputs:

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

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

Customizing the Toolbar

The <RichTextInput> component has a toolar 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 = (props) => (
    <Edit {...props}>
        <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 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.