docs: update docs

Author: SSShooter

.gitignore

@@ -27,3 +27,5 @@ yarn-error.log*
 /playwright-report/
 /blob-report/
 /playwright/.cache/
+
+/md

api/mind-elixir.api.json

@@ -1,7 +1,7 @@
 {
   "metadata": {
     "toolPackage": "@microsoft/api-extractor",
-    "toolVersion": "7.39.1",
+    "toolVersion": "7.47.0",
     "schemaVersion": 1011,
     "oldestForwardsCompatibleVersion": 1001,
     "tsdocConfig": {
@@ -717,6 +717,32 @@
             }
           ]
         },
+        {
+          "kind": "TypeAlias",
+          "canonicalReference": "mind-elixir!Locale:type",
+          "docComment": "",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export type Locale = "
+            },
+            {
+              "kind": "Content",
+              "text": "'cn' | 'zh_CN' | 'zh_TW' | 'en' | 'ru' | 'ja' | 'pt' | 'it' | 'es'"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "dist/types/i18n.d.ts",
+          "releaseTag": "Public",
+          "name": "Locale",
+          "typeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 2
+          }
+        },
         {
           "kind": "TypeAlias",
           "canonicalReference": "mind-elixir!MainLineParams:type",
@@ -728,7 +754,7 @@
             },
             {
               "kind": "Content",
-              "text": "{\n    x1: number;\n    y1: number;\n    x2: number;\n    y2: number;\n    direction: 'lhs' | 'rhs';\n}"
+              "text": "{\n    pT: number;\n    pL: number;\n    pW: number;\n    pH: number;\n    cT: number;\n    cL: number;\n    cW: number;\n    cH: number;\n    direction: 'lhs' | 'rhs';\n    containerHeight: number;\n}"
             },
             {
               "kind": "Content",
@@ -781,7 +807,25 @@
             },
             {
               "kind": "Content",
-              "text": " | undefined;\n    exportSvg: (this: "
+              "text": " | undefined;\n    destroy(this: "
+            },
+            {
+              "kind": "Reference",
+              "text": "Partial",
+              "canonicalReference": "!Partial:type"
+            },
+            {
+              "kind": "Content",
+              "text": "<"
+            },
+            {
+              "kind": "Reference",
+              "text": "MindElixirInstance",
+              "canonicalReference": "mind-elixir!MindElixirInstance:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ">): void;\n    exportSvg: (this: "
             },
             {
               "kind": "Reference",
@@ -1744,7 +1788,16 @@
             },
             {
               "kind": "Content",
-              "text": ", locale: string) => void;\n    expandNode: (this: "
+              "text": ", locale: import(\"./i18n\")."
+            },
+            {
+              "kind": "Reference",
+              "text": "Locale",
+              "canonicalReference": "mind-elixir!Locale:type"
+            },
+            {
+              "kind": "Content",
+              "text": ") => void;\n    expandNode: (this: "
             },
             {
               "kind": "Reference",
@@ -2041,7 +2094,7 @@
           "name": "methods",
           "variableTypeTokenRange": {
             "startIndex": 1,
-            "endIndex": 286
+            "endIndex": 292
           }
         },
         {
@@ -2504,6 +2557,38 @@
                 "endIndex": 2
               }
             },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "mind-elixir!MindElixirInstance#disposable:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "disposable: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Array",
+                  "canonicalReference": "!Array:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": "<() => void>"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "disposable",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 3
+              }
+            },
             {
               "kind": "PropertySignature",
               "canonicalReference": "mind-elixir!MindElixirInstance#draggable:member",
@@ -2876,8 +2961,9 @@
                   "text": "locale: "
                 },
                 {
-                  "kind": "Content",
-                  "text": "string"
+                  "kind": "Reference",
+                  "text": "Locale",
+                  "canonicalReference": "mind-elixir!Locale:type"
                 },
                 {
                   "kind": "Content",
@@ -3742,7 +3828,16 @@
             },
             {
               "kind": "Content",
-              "text": ";\n    direction?: number;\n    locale?: string;\n    draggable?: boolean;\n    editable?: boolean;\n    contextMenu?: boolean;\n    contextMenuOption?: any;\n    toolBar?: boolean;\n    keypress?: boolean;\n    mouseSelectionButton?: 0 | 2;\n    before?: "
+              "text": ";\n    direction?: number;\n    locale?: "
+            },
+            {
+              "kind": "Reference",
+              "text": "Locale",
+              "canonicalReference": "mind-elixir!Locale:type"
+            },
+            {
+              "kind": "Content",
+              "text": ";\n    draggable?: boolean;\n    editable?: boolean;\n    contextMenu?: boolean;\n    contextMenuOption?: any;\n    toolBar?: boolean;\n    keypress?: boolean;\n    mouseSelectionButton?: 0 | 2;\n    before?: "
             },
             {
               "kind": "Reference",
@@ -3826,7 +3921,7 @@
           "name": "Options",
           "typeTokenRange": {
             "startIndex": 1,
-            "endIndex": 20
+            "endIndex": 22
           }
         },
         {

api/mind-elixir.api.md

@@ -62,18 +62,27 @@ export interface Expander extends HTMLElement {
     previousSibling: Topic;
 }
 
+// @public (undocumented)
+export type Locale = 'cn' | 'zh_CN' | 'zh_TW' | 'en' | 'ru' | 'ja' | 'pt' | 'it' | 'es';
+
 // @public (undocumented)
 export type MainLineParams = {
-    x1: number;
-    y1: number;
-    x2: number;
-    y2: number;
+    pT: number;
+    pL: number;
+    pW: number;
+    pH: number;
+    cT: number;
+    cL: number;
+    cW: number;
+    cH: number;
     direction: 'lhs' | 'rhs';
+    containerHeight: number;
 };
 
 // @public
 export const methods: {
     init(this: MindElixirInstance, data: MindElixirData): Error | undefined;
+    destroy(this: Partial<MindElixirInstance>): void;
     exportSvg: (this: MindElixirInstance, noForeignObject?: boolean, injectCss?: string | undefined) => Blob;
     exportPng: (this: MindElixirInstance, noForeignObject?: boolean, injectCss?: string | undefined) => Promise<Blob | null>;
     createSummary: (this: MindElixirInstance) => void;
@@ -89,7 +98,7 @@ export const methods: {
     removeArrow: (this: MindElixirInstance, linkSvg?: CustomSvg | undefined) => void;
     selectArrow: (this: MindElixirInstance, link: CustomSvg) => void;
     unselectArrow: (this: MindElixirInstance) => void;
-    mainToSub: (this: MindElixirInstance, tpc: Topic) => Promise<void>;
+    rmSubline: (this: MindElixirInstance, tpc: Topic) => Promise<void>;
     reshapeNode: (this: MindElixirInstance, tpc: Topic, patchData: NodeObj) => Promise<void>;
     insertSibling: (this: MindElixirInstance, type: "before" | "after", el?: Topic | undefined, node?: NodeObj | undefined) => Promise<void>;
     insertParent: (this: MindElixirInstance, el?: Topic | undefined, node?: NodeObj | undefined) => Promise<void>;
@@ -123,7 +132,7 @@ export const methods: {
     initLeft: (this: MindElixirInstance) => void;
     initRight: (this: MindElixirInstance) => void;
     initSide: (this: MindElixirInstance) => void;
-    setLocale: (this: MindElixirInstance, locale: string) => void;
+    setLocale: (this: MindElixirInstance, locale: Locale) => void;
     expandNode: (this: MindElixirInstance, el: Topic, isExpand?: boolean | undefined) => void;
     refresh: (this: MindElixirInstance, data?: MindElixirData | undefined) => void;
     getObjById: (id: string, data: NodeObj) => NodeObj | null;
@@ -187,6 +196,8 @@ export interface MindElixirInstance extends MindElixirMethods {
     // (undocumented)
     direction: number;
     // (undocumented)
+    disposable: Array<() => void>;
+    // (undocumented)
     draggable: boolean;
     // (undocumented)
     editable: boolean;
@@ -221,7 +232,7 @@ export interface MindElixirInstance extends MindElixirMethods {
     // (undocumented)
     linkSvgGroup: SVGElement;
     // (undocumented)
-    locale: string;
+    locale: Locale;
     // (undocumented)
     mainBranchStyle: number;
     // (undocumented)
@@ -311,7 +322,7 @@ export type NodeObjExport = Omit<NodeObj, 'parent'>;
 export type Options = {
     el: string | HTMLElement;
     direction?: number;
-    locale?: string;
+    locale?: Locale;
     draggable?: boolean;
     editable?: boolean;
     contextMenu?: boolean;
@@ -441,7 +452,7 @@ export interface Wrapper extends HTMLElement {
 // Warnings were encountered during analysis:
 //
 // dist/types/arrow.d.ts:6:5 - (ae-forgotten-export) The symbol "Uid" needs to be exported by the entry point docs.d.ts
-// dist/types/methods.d.ts:18:5 - (ae-forgotten-export) The symbol "summary" needs to be exported by the entry point docs.d.ts
+// dist/types/methods.d.ts:19:5 - (ae-forgotten-export) The symbol "summary" needs to be exported by the entry point docs.d.ts
 
 // (No @packageDocumentation comment for this package)
 

readme.md

@@ -368,6 +368,17 @@ pnpm build
 pnpm link ./
 ```
 
+Update docs:
+
+```
+# Install api-extractor
+pnpm install -g @microsoft/api-extractor
+# Maintain /src/docs.ts
+# Generate docs
+pnpm doc
+pnpm doc:md
+```
+
 ## Thanks
 
 - [@viselect/vanilla](https://github.com/simonwep/selection/tree/master/packages/vanilla)

src/docs.ts

@@ -4,6 +4,7 @@ import type { MindElixirMethods } from './methods'
 import type { Summary, SummarySvgGroup } from './summary'
 import type { MindElixirData, MindElixirInstance, NodeObj, NodeObjExport, Options, Theme } from './types'
 import type { MainLineParams, SubLineParams } from './utils/generateBranch'
+import type { Locale } from './i18n'
 
 export {
   methods,
@@ -19,6 +20,7 @@ export {
   Arrow,
   MainLineParams,
   SubLineParams,
+  Locale,
 }
 
 export * from './types/dom'

src/interact.ts

@@ -1,3 +1,4 @@
+import type { Locale } from './i18n'
 import { rmSubline } from './nodeOperation'
 import type { Topic } from './types/dom'
 import type { MindElixirData, MindElixirInstance, NodeObj } from './types/index'
@@ -265,7 +266,7 @@ export const initSide = function (this: MindElixirInstance) {
  * @name setLocale
  * @memberof MapInteraction
  */
-export const setLocale = function (this: MindElixirInstance, locale: string) {
+export const setLocale = function (this: MindElixirInstance, locale: Locale) {
   this.locale = locale
   this.refresh()
 }