📝 Entur Rich Text Editor

A rich text editor component for React, built on Tiptap.

Maintained by Entur.

Installation

npm install @entur-partner/rich-text-editor
# or
yarn add @entur-partner/rich-text-editor

Usage

import { RichTextEditor } from '@entur-partner/rich-text-editor'
import '@entur-partner/rich-text-editor/styles.css'

<RichTextEditor
  label="Description"
  initialValue="Hello **world**!"
  onChange={(value) => console.log(value)}
  contentType="markdown"
  maxNumberOfCharacters={5000}
/>

Props

| Prop | Type | Default | Description | |---|---|---|---| | initialValue | string | — | Initial content (markdown or HTML) | | onChange | (value: string) => void | — | Called on every content change | | contentType | 'markdown' \| 'html' | 'html' | Format of the content | | label | string | '' | Label displayed above the editor | | maxNumberOfCharacters | number | 0 | Character limit (0 = no limit) | | className | string | '' | Extra CSS class on the container |

🛠️ Working on this package? See DEVELOPMENT.md.