feat(mind):为编辑器添加插入思维导图功能 by shenyaofeng · Pull Request #293 · opentiny/tiny-editor

shenyaofeng · 2025-07-29T10:01:42Z

PR

PR Checklist

Please check if your PR fulfills the following requirements:

The commit message follows our Commit Message Guidelines
Tests for the changes have been added (for bug fixes / features)
Docs have been added / updated (for bug fixes / features)

PR Type

What kind of change does this PR introduce?

Bugfix
Feature
Code style update (formatting, local variables)
Refactoring (no functional changes, no api changes)
Build related changes
CI related changes
Documentation content changes
Other... Please describe: 添加插入思维导图功能

What is the current behavior?

添加插入思维导图功能：

Issue Number: N/A

What is the new behavior?

Does this PR introduce a breaking change?

Yes
No

Other information

coderabbitai · 2025-07-29T10:01:52Z

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

✨ Finishing Touches

🧪 Generate unit tests

Create PR with unit tests
Post copyable unit tests in a comment

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Explain this complex logic.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai explain this code block.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and explain its main purpose.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR.
@coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
@coderabbitai generate unit tests to generate unit tests for this PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

…y-editor into ospp-2025/flowchart

CatsAndMice · 2025-07-31T00:51:45Z

国际化只有这么点吗？思维导图扩展增加子节点、导出导入等之类的不国际化吗 @shenyaofeng

我改一下

CatsAndMice · 2025-07-31T00:54:09Z

+    backBtn.style.cursor = isStart ? 'not-allowed' : 'pointer'
+    backBtn.style.opacity = isStart ? '0.5' : '1'
+    forwardBtn.style.cursor = isEnd ? 'not-allowed' : 'pointer'
+    forwardBtn.style.opacity = isEnd ? '0.5' : '1'


0.5、1 这个文件中反复出现，是不是应该不要硬编码

kagol · 2025-08-01T06:09:41Z

+      background-color: #f5f5f5;
+    }
+  }
+}


@shenyaofeng
把思维导图当成一个独立的 Quill 模块来写，不要作为内置模块，不要耦合到了 tiny-editor 项目里，样式应该放在这个模块里面，不要放在这里。参考下 quill-header-list: https://github.com/opentiny/quill-header-list

kagol · 2025-08-01T06:11:44Z

  'file'?: boolean
  'mathlive'?: boolean
  'image'?: boolean | Partial<BlotFormatterOptionsInput>
+  'mind'?: boolean


所有地方的名字需要统一成一个：mind-map（根据不同场合可能是 MindMap 或者别的），不要简写成 mind

kagol · 2025-08-01T06:14:05Z

 export * from './link'
 export * from './mathlive'
 export * from './mention'
+export * from './mind/index'


Suggested change

export * from './mind/index'

export * from './mind'

kagol · 2025-08-04T11:41:47Z

  'strike': 'Strikethrough',
  'image': 'Image',
  'file': 'File',
+  'mind': 'Mind Map',


Suggested change

'mind': 'Mind Map',

'mind-map': 'Mind Map',

kagol · 2025-08-04T11:42:06Z

 import { LinkBlot } from './modules/link' // 超链接
 import { MathliveModule } from './modules/mathlive' // latex公式
 import { Mention } from './modules/mention' // @提醒
+import { MindModule } from './modules/mind-map' // 思维导图


Suggested change

import { MindModule } from './modules/mind-map' // 思维导图

import { MindMapModule } from './modules/mind-map' // 思维导图

kagol · 2025-08-04T11:42:24Z

+import type { BlockEmbed as TypeBlockEmbed } from 'quill/blots/block'
+import type FluentEditor from '../../../core/fluent-editor'
+import Quill from 'quill'
+import MindMap from 'simple-mind-map'


Suggested change

import MindMap from 'simple-mind-map'

import SimpleMindMap from 'simple-mind-map'

kagol · 2025-08-04T11:42:40Z

+
+const BlockEmbed = Quill.import('blots/embed') as typeof TypeBlockEmbed
+
+class MindmapPlaceholderBlot extends BlockEmbed {


Suggested change

class MindmapPlaceholderBlot extends BlockEmbed {

class MindMapPlaceholderBlot extends BlockEmbed {

kagol · 2025-08-04T11:42:49Z

+const BlockEmbed = Quill.import('blots/embed') as typeof TypeBlockEmbed
+
+class MindmapPlaceholderBlot extends BlockEmbed {
+  static blotName = 'mindmap-placeholder'


Suggested change

static blotName = 'mindmap-placeholder'

static blotName = 'mind-map-placeholder'

kagol · 2025-08-04T11:43:18Z

+  static blotName = 'mindmap-placeholder'
+  static tagName = 'div'
+  static className = 'ql-mindmap'
+  mm: MindMap | null = null


Suggested change

mm: MindMap | null = null

mindMap: MindMap | null = null

kagol · 2025-08-04T11:43:26Z

+class MindmapPlaceholderBlot extends BlockEmbed {
+  static blotName = 'mindmap-placeholder'
+  static tagName = 'div'
+  static className = 'ql-mindmap'


Suggested change

static className = 'ql-mindmap'

static className = 'ql-mind-map'

kagol · 2025-08-04T11:43:58Z

@@ -0,0 +1,28 @@
+export const MIND_EN_US = {
+  'mindmap.contextMenu.copy': 'Copy',


Suggested change

'mindmap.contextMenu.copy': 'Copy',

'mind-map.contextMenu.copy': 'Copy',

kagol · 2025-08-04T11:44:16Z

+
+export function registerMindI18N(I18N: any) {
+  I18N.register({
+    'en-US': MIND_EN_US,


Suggested change

'en-US': MIND_EN_US,

'en-US': MIND_MAP_EN_US,

kagol · 2025-08-04T11:44:27Z

+import { MIND_EN_US } from './en-us'
+import { MIND_ZH_CN } from './zh-cn'
+
+export function registerMindI18N(I18N: any) {


Suggested change

export function registerMindI18N(I18N: any) {

export function registerMindMapI18N(I18N: any) {

kagol · 2025-08-04T11:44:44Z

+export class MindModule {
+  quill: Quill
+  toolbar: any
+  mmContainer: HTMLElement | null = null


Suggested change

mmContainer: HTMLElement | null = null

mindMapContainer: HTMLElement | null = null

kagol · 2025-08-04T11:44:54Z

+import type Quill from 'quill'
+import './formats/mind-blot'
+
+export class MindModule {


Suggested change

export class MindModule {

export class MindMapModule {

kagol · 2025-08-04T11:45:02Z

@@ -0,0 +1,51 @@
+import type Quill from 'quill'
+import './formats/mind-blot'


Suggested change

import './formats/mind-blot'

import './formats/mind-map-blot'

kagol · 2025-08-04T11:47:51Z

@shenyaofeng 统一下 Mind Map 的命名，目前一会儿是 mind，一会是 mm / mindmap，Mind 和 Map 是两个单词，烤串写法是：mind-map，大驼峰是 MindMap，小驼峰是 mindMap，以下写法请仔细对比（仅举部分例子，需要自行排查和修改不一致的代码），除了注意变量、函数、类等的命名，也要注意文件、文件夹的命名，保持统一命名风格。

- 'mind': 'Mind Map',
+ 'mind-map': 'Mind Map',

- import { MindModule } from './modules/mind-map'
+ import { MindMapModule } from './modules/mind-map'

- class MindmapPlaceholderBlot extends BlockEmbed {
+ class MindMapPlaceholderBlot extends BlockEmbed {

- static blotName = 'mindmap-placeholder'
+ static blotName = 'mind-map-placeholder'

- static className = 'ql-mindmap'
+ static className = 'ql-mind-map'

- mm: MindMap | null = null
+ mindMap: MindMap | null = null

- 'mindmap.contextMenu.copy': 'Copy',
+ 'mind-map.contextMenu.copy': 'Copy',

- export function registerMindI18N(I18N: any) {
+ export function registerMindMapI18N(I18N: any) {

- 'en-US': MIND_EN_US,
+ 'en-US': MIND_MAP_EN_US,

写法不一致很容易导致 bug，注意细节，养成良好的编码习惯。

kagol · 2025-08-04T11:55:20Z

@shenyaofeng 老的文件没有删除

kagol · 2025-08-04T11:56:49Z

+        name: 'sldt',
+        alias: ['mind'],
+        icon: icons.mind,
+        title: this.quill.getLangText('mind'),


Suggested change

title: this.quill.getLangText('mind'),

title: this.quill.getLangText('mind-map'),

kagol · 2025-08-04T11:57:04Z

+        title: this.quill.getLangText('mind'),
+        onClick(this: Quill, range: Range | null, _: any) {
+          if (!range) return
+          const mindModule = this.getModule('mind')


Suggested change

const mindModule = this.getModule('mind')

const mindMapModule = this.getModule('mind-map')

shenyaofeng added 13 commits July 16, 2025 20:09

feat: add insert flowChart and mindChart

d9b8b61

fix: update mindmap style

c2a1639

fix: update mindmap ability

52e7239

fix: update mindmap node error

f225469

fix:flow content delete and edit

2fb6c36

fix: add mindmap adjust size

13db14b

fix:node content delete

2f4d886

fix(mind): 调整思维导图文件结构

ef86d9a

fix:删除防抖函数

2f84edb

fix:更新mind

ab00d0e

fix：添加右键删除节点内容

ad953be

fix：快捷键添加思维导图

3e4e33f

fix：删除工具栏

e34b6d6

shenyaofeng changed the title ~~Ospp 2025/flowchart~~ fix(mind):为编辑器添加插入思维导图功能 Jul 30, 2025

github-actions Bot added the bug Something isn't working label Jul 30, 2025

shenyaofeng added 2 commits July 30, 2025 15:39

Merge branch 'ospp-2025/flowchart' of https://github.com/opentiny/tin…

7e02c27

…y-editor into ospp-2025/flowchart

fix(mind)：更新快捷键插入思维导图图标

c9e4343

CatsAndMice reviewed Jul 31, 2025

View reviewed changes

shenyaofeng changed the title ~~fix(mind):为编辑器添加插入思维导图功能~~ feat(mind):为编辑器添加插入思维导图功能 Jul 31, 2025

github-actions Bot added enhancement New feature or request and removed bug Something isn't working labels Jul 31, 2025

fix(mind)：取消硬编码

d5829b1

kagol reviewed Jul 31, 2025

View reviewed changes

Comment thread packages/docs/package.json

shenyaofeng added 2 commits July 31, 2025 10:50

fix：更新依赖包

7227b2a

fix(mind):完善国际化

ce3d2de

kagol reviewed Aug 1, 2025

View reviewed changes

fix(mind-map):更新模块名称与将国际化和样式放入mind-map文件夹中

ad38183

kagol reviewed Aug 4, 2025

View reviewed changes

Comment thread packages/fluent-editor/src/assets/mindmap.scss Outdated

kagol Aug 4, 2025

Copy link
Copy Markdown

Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@shenyaofeng 老的文件没有删除

kagol reviewed Aug 4, 2025

View reviewed changes

shenyaofeng added 7 commits August 4, 2025 22:43

fix(mind-map):规范思维导图相关变量名称

9450055

fix(mind-map):删除思维导图多余样式文件

5ee0db1

fix(mind-map):规范思维导图相关变量名称

f4aacc5

fix(mind-map):规范思维导图相关类名称

a7c759a

fix(mind-map):删除打印

df69f4f

fix(mind-map):规范思维导图样式文件名称

f127b1b

fix(mind-map):调整思维导图控制面板图标与样式

369af95

This comment was marked as resolved.

Sign in to view

kagol approved these changes Aug 7, 2025

View reviewed changes

kagol merged commit 3270589 into opentiny:ospp-2025/flowchart Aug 7, 2025

	import { MindModule } from './modules/mind-map' // 思维导图
	import { MindMapModule } from './modules/mind-map' // 思维导图

	import MindMap from 'simple-mind-map'
	import SimpleMindMap from 'simple-mind-map'


		const BlockEmbed = Quill.import('blots/embed') as typeof TypeBlockEmbed

		class MindmapPlaceholderBlot extends BlockEmbed {

	static blotName = 'mindmap-placeholder'
	static blotName = 'mind-map-placeholder'

	static className = 'ql-mindmap'
	static className = 'ql-mind-map'

		@@ -0,0 +1,28 @@
		export const MIND_EN_US = {
		'mindmap.contextMenu.copy': 'Copy',

	'mindmap.contextMenu.copy': 'Copy',
	'mind-map.contextMenu.copy': 'Copy',

	export function registerMindI18N(I18N: any) {
	export function registerMindMapI18N(I18N: any) {

	mmContainer: HTMLElement \| null = null
	mindMapContainer: HTMLElement \| null = null

		@@ -0,0 +1,51 @@
		import type Quill from 'quill'
		import './formats/mind-blot'

	import './formats/mind-blot'
	import './formats/mind-map-blot'

	title: this.quill.getLangText('mind'),
	title: this.quill.getLangText('mind-map'),

	const mindModule = this.getModule('mind')
	const mindMapModule = this.getModule('mind-map')

Uh oh!

Conversation

shenyaofeng commented Jul 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR

PR Checklist

PR Type

What is the current behavior?

What is the new behavior?

Does this PR introduce a breaking change?

Other information

Uh oh!

coderabbitai Bot commented Jul 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Review skipped

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

kagol Aug 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

kagol Aug 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

kagol Aug 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

kagol commented Aug 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

This comment was marked as resolved.

Uh oh!

Reviewers

Assignees

shenyaofeng commented Jul 29, 2025 •

edited

Loading

coderabbitai Bot commented Jul 29, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

kagol Aug 1, 2025 •

edited

Loading

kagol Aug 1, 2025 •

edited

Loading

kagol Aug 1, 2025 •

edited

Loading

kagol commented Aug 4, 2025 •

edited

Loading