Merge pull request #378 from SSShooter/feature/locale-refactor

SSShooter · web-flow · commit 70754d5bf37a · 2026-03-28T22:16:25.000+08:00
Feature/locale refactor
diff --git a/build.js b/build.js
@@ -30,6 +30,11 @@ const buildList = [
     enrty: __dirname + './src/utils/plaintextConverter.ts',
     formats: ['es'],
   },
+  {
+    name: 'i18n',
+    enrty: __dirname + './src/i18n.ts',
+    formats: ['es'],
+  },
 ]
 for (let i = 0; i < buildList.length; i++) {
   const info = buildList[i]
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "mind-elixir",
-  "version": "5.9.3",
+  "version": "5.10.0-beta.1",
   "type": "module",
   "description": "Mind elixir is a free open source mind map core.",
   "keywords": [
@@ -10,7 +10,6 @@
     "visualization"
   ],
   "scripts": {
-    "prepare": "husky install",
     "lint": "eslint --cache --max-warnings 0  \"src/**/*.{js,json,ts}\" --fix",
     "dev": "vite",
     "build": "node build.js && tsc",
@@ -28,21 +27,18 @@
   "exports": {
     ".": {
       "types": "./dist/types/index.d.ts",
-      "import": "./dist/MindElixir.js",
-      "require": "./dist/MindElixir.js"
+      "import": "./dist/MindElixir.js"
     },
     "./lite": {
       "import": "./dist/MindElixirLite.iife.js"
     },
     "./example": {
       "types": "./dist/types/exampleData/1.d.ts",
-      "import": "./dist/example.js",
-      "require": "./dist/example.js"
+      "import": "./dist/example.js"
     },
     "./LayoutSsr": {
       "types": "./dist/types/utils/LayoutSsr.d.ts",
-      "import": "./dist/LayoutSsr.js",
-      "require": "./dist/LayoutSsr.js"
+      "import": "./dist/LayoutSsr.js"
     },
     "./readme.md": "./readme.md",
     "./package.json": "./package.json",
@@ -51,13 +47,10 @@
     "./plaintextConverter": {
       "types": "./dist/types/utils/plaintextConverter.d.ts",
       "import": "./dist/PlaintextConverter.js"
-    }
-  },
-  "typesVersions": {
-    "*": {
-      "example": [
-        "./dist/types/exampleData/1.d.ts"
-      ]
+    },
+    "./i18n": {
+      "types": "./dist/types/i18n.d.ts",
+      "import": "./dist/i18n.js"
     }
   },
   "main": "dist/MindElixir.js",
diff --git a/readme.md b/readme.md
@@ -180,6 +180,7 @@ And in your CSS file:
 
 ```javascript
 import MindElixir from 'mind-elixir'
+import { en } from 'mind-elixir/i18n'
 import 'mind-elixir/style.css'
 import example from 'mind-elixir/dist/example1'
 
@@ -188,11 +189,10 @@ let options = {
   direction: MindElixir.LEFT,
   toolBar: true, // default true
   keypress: true, // default true
-  locale: 'en', // [zh_CN,zh_TW,en,ja,pt,ru,ro] waiting for PRs
   overflowHidden: false, // default false
-  mainLinkStyle: 2, // [1,2] default 1
   mouseSelectionButton: 0, // 0 for left button, 2 for right button, default 0
   contextMenu: {
+    locale: en, // [cn,zh_CN,zh_TW,en,ru,ja,pt,it,es,fr,ko,ro,da,fi,de,nl,nb,sv]
     focus: true,
     link: true,
     extend: [
diff --git a/readme/es.md b/readme/es.md
@@ -160,6 +160,7 @@ Y en tu archivo CSS:
 
 ```javascript
 import MindElixir from 'mind-elixir'
+import { es } from 'mind-elixir/i18n'
 import example from 'mind-elixir/dist/example1'
 
 let options = {
@@ -169,11 +170,10 @@ let options = {
   contextMenu: true, // por defecto true
   toolBar: true, // por defecto true
   keypress: true, // por defecto true
-  locale: 'en', // [zh_CN,zh_TW,en,ja,pt,ru,ro] esperando PRs
   overflowHidden: false, // por defecto false
-  mainLinkStyle: 2, // [1,2] por defecto 1
   mouseSelectionButton: 0, // 0 para botón izquierdo, 2 para botón derecho, por defecto 0
-  contextMenuOption: {
+  contextMenu: {
+    locale: es,
     focus: true,
     link: true,
     extend: [
diff --git a/readme/fr.md b/readme/fr.md
@@ -137,6 +137,7 @@ Et dans votre fichier CSS :
 
 ```javascript
 import MindElixir from 'mind-elixir'
+import { fr } from 'mind-elixir/i18n'
 import example from 'mind-elixir/dist/example1'
 
 let options = {
@@ -146,11 +147,10 @@ let options = {
   contextMenu: true, // par défaut true
   toolBar: true, // par défaut true
   keypress: true, // par défaut true
-  locale: 'en', // [zh_CN,zh_TW,en,ja,pt,ru,ro] en attente de PRs
   overflowHidden: false, // par défaut false
-  mainLinkStyle: 2, // [1,2] par défaut 1
   mouseSelectionButton: 0, // 0 pour le bouton gauche, 2 pour le bouton droit, par défaut 0
-  contextMenuOption: {
+  contextMenu: {
+    locale: fr,
     focus: true,
     link: true,
     extend: [
diff --git a/readme/ja.md b/readme/ja.md
@@ -160,6 +160,7 @@ CSSファイルに追加：
 
 ```javascript
 import MindElixir from 'mind-elixir'
+import { ja } from 'mind-elixir/i18n'
 import example from 'mind-elixir/dist/example1'
 
 let options = {
@@ -169,11 +170,10 @@ let options = {
   contextMenu: true, // デフォルトはtrue
   toolBar: true, // デフォルトはtrue
   keypress: true, // デフォルトはtrue
-  locale: 'ja', // [zh_CN,zh_TW,en,ja,pt,ru,ro] PRs募集中
   overflowHidden: false, // デフォルトはfalse
-  mainLinkStyle: 2, // [1,2] デフォルトは1
   mouseSelectionButton: 0, // 0は左クリック、2は右クリック、デフォルトは0
-  contextMenuOption: {
+  contextMenu: {
+    locale: ja,
     focus: true,
     link: true,
     extend: [
diff --git a/readme/ko.md b/readme/ko.md
@@ -137,20 +137,18 @@ import MindElixir from 'mind-elixir'
 
 ```javascript
 import MindElixir from 'mind-elixir'
+import { ko } from 'mind-elixir/i18n'
 import example from 'mind-elixir/dist/example1'
 
 let options = {
   el: '#map', // or HTMLDivElement
   direction: MindElixir.LEFT,
   draggable: true, // default true
-  contextMenu: true, // default true
-  toolBar: true, // default true
   keypress: true, // default true
-  locale: 'en', // [zh_CN,zh_TW,en,ja,pt,ru,ro] waiting for PRs
   overflowHidden: false, // default false
-  mainLinkStyle: 2, // [1,2] default 1
   mouseSelectionButton: 0, // 0 for left button, 2 for right button, default 0
-  contextMenuOption: {
+  contextMenu: {
+    locale: ko,
     focus: true,
     link: true,
     extend: [
diff --git a/readme/pt.md b/readme/pt.md
@@ -137,20 +137,19 @@ E no seu arquivo CSS:
 
 ```javascript
 import MindElixir from 'mind-elixir'
+import { pt } from 'mind-elixir/i18n'
 import example from 'mind-elixir/dist/example1'
 
 let options = {
   el: '#map', // ou HTMLDivElement
   direction: MindElixir.LEFT,
   draggable: true, // padrão true
-  contextMenu: true, // padrão true
   toolBar: true, // padrão true
   keypress: true, // padrão true
-  locale: 'pt', // [zh_CN,zh_TW,en,ja,pt,ru,ro] aguardando PRs
   overflowHidden: false, // padrão false
-  mainLinkStyle: 2, // [1,2] padrão 1
   mouseSelectionButton: 0, // 0 para botão esquerdo, 2 para botão direito, padrão 0
-  contextMenuOption: {
+  contextMenu: {
+    locale: pt,
     focus: true,
     link: true,
     extend: [
diff --git a/readme/ru.md b/readme/ru.md
@@ -137,20 +137,18 @@ import MindElixir from 'mind-elixir'
 
 ```javascript
 import MindElixir from 'mind-elixir'
+import { en } from 'mind-elixir/i18n'
 import example from 'mind-elixir/dist/example1'
 
 let options = {
   el: '#map', // or HTMLDivElement
   direction: MindElixir.LEFT,
   draggable: true, // default true
-  contextMenu: true, // default true
-  toolBar: true, // default true
   keypress: true, // default true
-  locale: 'en', // [zh_CN,zh_TW,en,ja,pt,ru,ro] waiting for PRs
   overflowHidden: false, // default false
-  mainLinkStyle: 2, // [1,2] default 1
   mouseSelectionButton: 0, // 0 for left button, 2 for right button, default 0
-  contextMenuOption: {
+  contextMenu: {
+    locale: en,
     focus: true,
     link: true,
     extend: [
diff --git a/readme/zh.md b/readme/zh.md
@@ -160,6 +160,7 @@ import MindElixir from 'mind-elixir'
 
 ```javascript
 import MindElixir from 'mind-elixir'
+import { en } from 'mind-elixir/i18n'
 import example from 'mind-elixir/dist/example1'
 
 let options = {
@@ -169,11 +170,10 @@ let options = {
   contextMenu: true, // 默认 true
   toolBar: true, // 默认 true
   keypress: true, // 默认 true
-  locale: 'en', // [zh_CN,zh_TW,en,ja,pt,ru,ro] 等待 PRs
   overflowHidden: false, // 默认 false
-  mainLinkStyle: 2, // [1,2] 默认 1
   mouseSelectionButton: 0, // 0 为左键，2 为右键，默认 0
   contextMenuOption: {
+    locale: en, // [cn,zh_CN,zh_TW,en,ru,ja,pt,it,es,fr,ko,ro,da,fi,de,nl,nb,sv]
     focus: true,
     link: true,
     extend: [
diff --git a/skills/integrate-mind-elixir/SKILL.md b/skills/integrate-mind-elixir/SKILL.md
@@ -56,6 +56,7 @@ Import and initialize Mind Elixir in your JavaScript/TypeScript file.
 
 ```javascript
 import MindElixir from 'mind-elixir'
+import { en } from 'mind-elixir/i18n'
 import 'mind-elixir/style.css'
 
 // 1. Define options
@@ -64,11 +65,28 @@ let options = {
   direction: MindElixir.LEFT,
   toolBar: true, // default true
   keypress: true, // default true
-  locale: 'en', // [zh_CN,zh_TW,en,ja,pt,ru,ro]
   overflowHidden: false, // default false
-  mainLinkStyle: 2, // [1,2] default 1
-  mouseSelectionButton: 0, // 0 for left button, 2 for right button
-  contextMenu: true, // default true
+  mouseSelectionButton: 0, // 0 for left button, 2 for right button, default 0
+  contextMenu: {
+    locale: en, // [cn,zh_CN,zh_TW,en,ru,ja,pt,it,es,fr,ko,ro,da,fi,de,nl,nb,sv]
+    focus: true,
+    link: true,
+    extend: [
+      {
+        name: 'Node edit',
+        onclick: () => {
+          alert('extend menu')
+        },
+      },
+    ],
+  }, // default true
+  before: {
+    insertSibling(type, obj) {
+      return true
+    },
+  },
+  // Custom markdown parser (optional)
+  // markdown: (text) => customMarkdownParser(text), // provide your own markdown parser function
 }
 
 // 2. Create instance
@@ -183,14 +201,20 @@ const options = {
   // ...
   theme: {
     name: 'Dark',
-    palette: ['#848FA0', '#748BE9', '#D2F9FE'], // colors for main lines
+    // main lines color palette
+    palette: ['#848FA0', '#748BE9', '#D2F9FE', '#4145A5', '#789AFA', '#706CF4', '#EF987F', '#775DD5', '#FCEECF', '#DA7FBC'],
+    // overwrite css variables
     cssVar: {
       '--main-color': '#ffffff',
       '--main-bgcolor': '#4c4f69',
       '--color': '#cccccc',
       '--bgcolor': '#252526',
+      '--panel-color': '255, 255, 255',
+      '--panel-bgcolor': '45, 55, 72',
     },
+    // all variables see /src/index.less
   },
+  // ...
 }
 ```
 
@@ -199,10 +223,12 @@ Change theme dynamically:
 ```javascript
 mind.changeTheme({
   name: 'Latte',
-  palette: ['#dd7878', '#ea76cb'],
+  palette: ['#dd7878', '#ea76cb', '#8839ef', '#e64553', '#fe640b', '#df8e1d', '#40a02b', '#209fb5', '#1e66f5', '#7287fd'],
   cssVar: {
     '--main-color': '#444446',
-    // ...
+    '--main-bgcolor': '#ffffff',
+    '--color': '#777777',
+    '--bgcolor': '#f6f6f6',
   },
 })
 ```
diff --git a/src/dev.ts b/src/dev.ts
@@ -15,6 +15,7 @@ import { md2html } from 'simple-markdown-to-html'
 import type { Arrow } from './arrow'
 import type { Summary } from './summary'
 import { mindElixirToPlaintext, plaintextExample, plaintextToMindElixir } from './utils/plaintextConverter'
+import { en } from './i18n'
 
 interface Window {
   m?: MindElixirInstance
@@ -34,7 +35,6 @@ const E = MindElixir.E
 const options: Options = {
   el: '#map',
   newTopicName: '子节点',
-  locale: 'en',
   // mouseSelectionButton: 2,
   editable: true,
   markdown: (text: string, obj: (NodeObj & { useMd?: boolean }) | (Arrow & { useMd?: boolean }) | (Summary & { useMd?: boolean })) => {
@@ -82,6 +82,7 @@ const options: Options = {
   // To disable markdown, simply omit the markdown option or set it to undefined
   // if you set contextMenu to false, you should handle contextmenu event by yourself, e.g. preventDefault
   contextMenu: {
+    locale: en,
     focus: true,
     link: true,
     extend: [
diff --git a/src/docs.ts b/src/docs.ts
@@ -4,7 +4,7 @@ import type { MindElixirMethods } from './methods'
 import type { Summary, SummarySvgGroup } from './summary'
 import type { MindElixirData, MindElixirInstance, NodeObj, NodeObjExport, Options, Theme, TagObj } from './types'
 import type { MainLineParams, SubLineParams } from './utils/generateBranch'
-import type { Locale } from './i18n'
+import type { LangPack } from './i18n'
 export {
   methods,
   Theme,
@@ -19,7 +19,7 @@ export {
   Arrow,
   MainLineParams,
   SubLineParams,
-  Locale,
+  LangPack,
   TagObj,
 }
 
diff --git a/src/i18n.ts b/src/i18n.ts
diff --git a/src/index.ts b/src/index.ts
diff --git a/src/interact.ts b/src/interact.ts
diff --git a/src/plugin/contextMenu.ts b/src/plugin/contextMenu.ts
diff --git a/src/types/index.ts b/src/types/index.ts
