# yuruiyin/richeditor architecture

> Architecture diagram of the GitHub repository yuruiyin/richeditor, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-10-11). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/yuruiyin/richeditor
- Repository: https://github.com/yuruiyin/richeditor

## Overview

##### Project Type and Purpose
- This is an Android component library (“richeditor” module) plus a sample application (“app” module).
- Purpose: provide a fully functional rich-text editor based on a custom RichEditText view, leveraging Android’s native EditText + Span architecture.

##### File Structure Analysis
Top-level:
- settings.gradle – includes two modules: “app” (sample) and “richeditor” (library)
- build.gradle / gradle scripts – build configuration for multi-module project
- image/ – demo assets for README

“app” module:
- build.gradle, proguard-rules.pro – app-specific configuration
- src/main – sample application entry point (MainActivity), sample models (ImageVm, VideoVm, GameVm), utilities, layouts, resources
- src/androidTest, src/test – instrumentation and unit tests

“richeditor” module (core library):
- build.gradle, proguard-rules.pro – library configuration
- src/main/java/com/yuruiyin/richeditor – core code:
– RichEditText.java (custom view)
– RichInputConnectionWrapper.java, RichTextWatcher.java (input handling)
– span package: implementations of IInlineSpan/IBlockSpan for block and inline styling (BoldStyleSpan, InlineImageSpan, CustomQuoteSpan, etc.)
– model package: data models (RichEditorBlock, BlockImageSpanVm, InlineImageSpanVm, StyleBtnVm)
– callback, config, enumtype, utils, undoredo packages
- src/main/res – custom attributes (attrs.xml), layout for image spans, drawables, styles
- src/androidTest, src/test – tests

##### Key Insights from README
- The library interfaces through a single custom view (RichEditText) and exposes APIs to initialize style buttons, insert images/videos/custom Views, and retrieve a list of RichEditorBlock objects.
- Internally, it manages spans for styling, block insertion, undo/redo, keyboard handling.
- Sample app demonstrates builder pattern (StyleBtnVm), file-picker integration, custom layout insertion (GameVm), and content serialization.

##### Main Components
A. Sample Application (“app” module)
- UI Layer: MainActivity + XML layouts + style buttons
- Interaction Layer: file picker Intent, onActivityResult, FileUtil
- RichEditor API Usage: initStyleButton(), insertBlockImage(), content retrieval
B. RichEditor Library (“richeditor” module)
1. RichEditText (Custom View)
2. Input Handling
- RichInputConnectionWrapper – intercepts IME commands
- RichTextWatcher – monitors text changes to apply spans
3. Span Management
- Inline spans (BoldStyleSpan, ItalicStyleSpan, InlineImageSpan, etc.)
- Block spans (BlockImageSpan for images/videos/custom Views)
4. Model Layer
- RichEditorBlock – represents each paragraph block
- BlockImageSpanVm, InlineImageSpanVm, StyleBtnVm
5. Undo/Redo Engine (UndoRedoHelper)
6. Utilities & Config
- FileUtil, ClipboardUtil, ViewUtil, WindowUtil, BitmapUtil
- AppConfig, custom attributes in attrs.xml
7. Callbacks & Extensibility
- OnImageClickListener
- Public APIs to insert spans, register style buttons, retrieve content

##### Relationships and Data Flows
- User taps style button in Sample App → StyleBtnVm event → RichEditText.initStyleButton() registers watcher → onClick triggers RichEditText.applyInlineStyle() → RichTextWatcher updates Spannable
- User inserts image/video/custom View → Sample Activity picks file or inflates layout → passes path/bitmap + BlockImageSpanVm to richEditText.insertBlockImage() → RichEditText creates BlockImageSpan → SpanManagement attaches it to text, updates RichEditorBlock list
- Undo/redo operations triggered by keyboard or programmatic calls → UndoRedoHelper maintains action stack
- At any point, app calls richEditText.getContent() → returns List<RichEditorBlock>

##### Architectural Patterns & Principles
- Span-based styling (leveraging Android’s native text engine)
- Builder pattern for StyleBtnVm
- Custom View encapsulation (RichEditText) exposing a clear public API
- Separation of concerns: input handling, span management, model representation, utilities, and UI usage are neatly divided into packages
- Extensibility via callbacks and custom attributes

##### Essential Elements
- Component names and boundaries
- Technology annotations (Android EditText, Spannable, IME, Kotlin/Java)

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Sample App Layer
    subgraph "Sample App (app module)" 
        style SampleApp fill:#D0E8FF,stroke:#3B82F6,stroke-width:2px
        MainActivity["MainActivity"]:::ui
        Layout["activity_main.xml"]:::ui
        StyleBtnVm["StyleBtnVm / ImageVm / VideoVm / GameVm"]:::ui
        ImageUtil["ImageUtil & Other Utils"]:::utils
    end

    %% RichEditor Library Layer
    subgraph "RichEditor Library (richeditor module)"
        style RichEditorLib fill:#E0FFE0,stroke:#10B981,stroke-width:2px

        RichEditText["RichEditText"]:::core
        subgraph "Input Handling"
            RichInputConnectionWrapper["RichInputConnectionWrapper"]:::core
            RichTextWatcher["RichTextWatcher"]:::core
        end

        subgraph "Span Management"
            InlineSpans["Inline & Block Spans\n(BoldStyleSpan, InlineImageSpan, BlockImageSpan, etc.)"]:::core
        end

        subgraph "Model Layer"
            ModelLayer["RichEditorBlock, BlockImageSpanVm,\nInlineImageSpanVm, StyleBtnVm"]:::model
            DataList["List<RichEditorBlock>"]:::data
        end

        UndoRedo["UndoRedoHelper"]:::core
        subgraph "Utils & Config"
            AppConfig["AppConfig & attrs.xml"]:::utils
            UtilsLib["BitmapUtil, FileUtil, ClipboardUtil,\nViewUtil, WindowUtil, SoftKeyboardUtil,\nLogUtil, RichEditorGlobalHelper"]:::utils
        end

        Callbacks["OnImageClickListener"]:::core
        subgraph "Resources"
            ImgLayout["rich_editor_image.xml"]:::resource
            DrawableRes["bg_gif_mark.xml"]:::resource
        end
    end

    %% Flows & Relationships
    MainActivity -->|"inflates UI from"| Layout
    MainActivity -->|"uses builder"| StyleBtnVm
    StyleBtnVm -->|"initStyleButton()"| RichEditText
    MainActivity -->|"picks image/video"| ImageUtil
    ImageUtil -->|"insertBlockImage(path, BlockImageSpanVm)"| RichEditText

    RichEditText -->|"wraps IME"| RichInputConnectionWrapper
    RichEditText -->|"adds watcher"| RichTextWatcher
    RichTextWatcher -->|"applyInlineStyle()/onTextChanged"| InlineSpans
    RichEditText -->|"create BlockImageSpan"| InlineSpans
    InlineSpans -->|"updates model"| ModelLayer
    ModelLayer --> DataList
    RichEditText -->|"undo()/redo()"| UndoRedo
    MainActivity -->|"getContent() returns"| DataList

    RichEditText -->|"uses config"| AppConfig
    RichEditText -->|"uses utils"| UtilsLib
    RichEditText -->|"register callback"| Callbacks
    RichEditText -->|"inflate image layout"| ImgLayout
    RichEditText -->|"use drawable"| DrawableRes

    %% Click Events
    click MainActivity "https://github.com/yuruiyin/richeditor/blob/master/app/src/main/java/com/yuruiyin/richeditor/sample/MainActivity.kt"
    click Layout "https://github.com/yuruiyin/richeditor/blob/master/app/src/main/res/layout/activity_main.xml"
    click StyleBtnVm "https://github.com/yuruiyin/richeditor/blob/master/app/src/main/java/com/yuruiyin/richeditor/sample/model/DividerVm.kt"
    click ImageUtil "https://github.com/yuruiyin/richeditor/blob/master/app/src/main/java/com/yuruiyin/richeditor/sample/utils/ImageUtil.kt"
    click RichEditText "https://github.com/yuruiyin/richeditor/blob/master/richeditor/src/main/java/com/yuruiyin/richeditor/RichEditText.java"
    click RichInputConnectionWrapper "https://github.com/yuruiyin/richeditor/blob/master/richeditor/src/main/java/com/yuruiyin/richeditor/RichInputConnectionWrapper.java"
    click RichTextWatcher "https://github.com/yuruiyin/richeditor/blob/master/richeditor/src/main/java/com/yuruiyin/richeditor/RichTextWatcher.java"
    click InlineSpans "https://github.com/yuruiyin/richeditor/tree/master/richeditor/src/main/java/com/yuruiyin/richeditor/span/"
    click ModelLayer "https://github.com/yuruiyin/richeditor/tree/master/richeditor/src/main/java/com/yuruiyin/richeditor/model/"
    click UndoRedo "https://github.com/yuruiyin/richeditor/blob/master/richeditor/src/main/java/com/yuruiyin/richeditor/undoredo/UndoRedoHelper.java"
    click AppConfig "https://github.com/yuruiyin/richeditor/blob/master/richeditor/src/main/java/com/yuruiyin/richeditor/config/AppConfig.java"
    click UtilsLib "https://github.com/yuruiyin/richeditor/tree/master/richeditor/src/main/java/com/yuruiyin/richeditor/utils/"
    click Callbacks "https://github.com/yuruiyin/richeditor/blob/master/richeditor/src/main/java/com/yuruiyin/richeditor/callback/OnImageClickListener.java"
    click ImgLayout "https://github.com/yuruiyin/richeditor/blob/master/richeditor/src/main/res/layout/rich_editor_image.xml"
    click DrawableRes "https://github.com/yuruiyin/richeditor/blob/master/richeditor/src/main/res/drawable/bg_gif_mark.xml"

    %% Classes
    classDef ui fill:#D0E8FF,stroke:#3B82F6,color:#1E3A8A
    classDef core fill:#E0FFE0,stroke:#10B981,color:#065F46
    classDef model fill:#FFF4E5,stroke:#F59E0B,color:#78350F
    classDef utils fill:#F3F4F6,stroke:#6B7280,color:#374151
    classDef data stroke-dasharray: 5 5,stroke:#6B7280
    classDef resource fill:#F9FAFB,stroke:#9CA3AF,color:#4B5563
```
