Skip to content
This repository has been archived by the owner on May 1, 2024. It is now read-only.

sodenn/react-fluent-edit

Repository files navigation

react-fluent-edit

CI status CodeQL status

Brings easy-to-use mentions, markdown and DnD (WIP) features to Slate.

Examples and code snippets: https://react-fluent-edit.vercel.app

Installation

Install the core package in your project directory:

// with npm
npm install @react-fluent-edit/core

// with yarn
yarn add @react-fluent-edit/core

Since react-fluent-edit is based on Slate, the following dependencies also need to be installed:

// with npm
npm install slate slate-history slate-react

// with yarn
yarn add slate slate-history slate-react

Packages

Install additional packages of your choice:

  • @react-fluent-edit/mentions
    Screenshot
  • @react-fluent-edit/markdown
    Markdown autocompletion and highlighting.
    Screenshot
  • @react-fluent-edit/dnd
    Allows dragging HTML elements into the editor.
    Screenshot
  • @react-fluent-edit/mui
    Bindings for using MUI (Material UI) with react-fluent-edit.
    Screenshot