React Textflux

🚀 What's New

• Production ready: All major bugs fixed, UX polished
• Mention dropdown: Keyboard navigation auto-scrolls, dark/light theme highlight, visible text always
• Media skeleton loader: Shows animated skeleton while uploading/inserting images/videos
• Unified media handling: Paste, drag-and-drop, and toolbar all use the same upload logic
• Accessibility: All dropdowns and toolbars are keyboard accessible
• CSS isolation: All classes prefixed with tf- (no conflicts)

A minimal, modular, and customizable React rich text editor component with:

• Basic formatting (bold, italic, underline, strikethrough, blockquote, lists)
• @mention with profile pic/initials
• Emoji picker (hundreds of emojis)
• Media rendering (image/video)
• Dark/light theme support
• Custom upload logic via callback
• No CSS framework dependency (pure CSS, all classes prefixed with tf- for isolation)

Install

npm install react-textflux

Usage

// Only default import is supported:
import Editor from 'react-textflux';
import 'react-textflux/dist/index.css';
function App() {
  // Example: custom upload logic (S3, base64, etc.)
  const handleMediaUpload = async (file, type) => {
    // Upload file to your server or S3, return { url, type, name }
    // Or fallback to base64:
    const toBase64 = file => new Promise((res, rej) => {
      const reader = new FileReader();
      reader.onload = () => res(reader.result);
      reader.onerror = rej;
      reader.readAsDataURL(file);
    });
    const url = await toBase64(file);
    return { url, type, name: file.name };
  };

  // Example: mention data
  const mentions = [
    { id: 1, name: 'John Doe', profile_pic: 'https://example.com/john.jpg' },
    { id: 2, name: 'Jane Smith', profile_pic: 'https://example.com/jane.jpg' },
    { id: 3, name: 'Bob Johnson' } // without profile_pic
  ];

  return (
    <Editor
      theme="light" // or "dark"
      mentions={mentions}
      onMediaUpload={handleMediaUpload}
    />
  );
}

Note: Only default import is supported. Use import Editor from 'react-textflux'. Named import (import { Editor } from 'react-textflux') is not supported.

Mentions (@mention)

You can pass your own mention data as a prop:

const mentions = [
  { id: 1, name: 'John Doe', profile_pic: 'https://example.com/john.jpg' },
  { id: 2, name: 'Jane Smith', profile_pic: 'https://example.com/jane.jpg' },
  { id: 3, name: 'Bob Johnson' } // without profile_pic
];

<Editor mentions={mentions} />

• id: unique user id (number or string)
• name: user's display name (used for search and display)
• profile_pic: (optional) image URL for avatar. If missing or image fails, initials will be shown automatically.

How it works:

• When you type @, a dropdown appears with user suggestions.
• You can navigate with up/down keys and select with Enter. Dropdown auto-scrolls to keep selection visible.
• The mention inserted in the editor will include the user's name and id (and profile_pic if present).

Features

• Formatting: Bold, Italic, Underline, Strikethrough, Blockquote, Lists
• @Mention: User list with profile pic/initials, keyboard navigation, auto-scroll
• Emoji Picker: 200+ emojis, fast search, outside click to close
• Media: Render images/videos (upload logic is up to you)
• Media Skeleton: Animated skeleton loader while uploading/inserting
• Theme: Light & dark mode (prop)
• Keyboard Shortcuts: Tooltips show shortcuts (e.g. Ctrl+B)
• Custom CSS: No Tailwind/Bootstrap required
• CSS Isolation: All classes prefixed with tf- (no conflicts with other frameworks)
• Dark Theme Polish: Selected toolbar/mention is deep blue for better contrast
• Emoji/Mention Scrollbar: Thin, theme-aware, and modern
• Accessibility: All dropdowns and toolbars are keyboard accessible

Props

Customization

• Mentions: Pass your user list as mentions prop
• Emoji List: Edit Toolbar.jsx emojis array
• CSS: Edit src/index.css for full style control (all classes use tf- prefix)
• Toolbar/Theme: Update colors in src/index.css for your brand

License

MIT