Save Tools' order in the Toolbox (#1113)

Resolves #1073
codex-team · Apr 25, 2020 · 7eb642d · 7eb642d
1 parent 4a81699
commit 7eb642d
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 15 deletions.
diff --git a/dist/editor.js b/dist/editor.js
diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md
@@ -9,6 +9,7 @@
 - `Fix` - Editor's styles won't be appended to the `<head>` when another instance have already do that [#1079](https://github.com/codex-team/editor.js/issues/1079)
 - `New` *I18n API* — Ability to provide internalization for Editor.js core and tools. [#751](https://github.com/codex-team/editor.js/issues/751)
 - `Fix` - Fixed wrong toolbar icon centering in Firefox [#1120](https://github.com/codex-team/editor.js/pull/1120)
+- `Fix` - Toolbox: Tool's order in Toolbox now saved in accordance with `tools` object keys order [#1073](https://github.com/codex-team/editor.js/issues/1073)
 
 ### 2.17
 

diff --git a/src/components/modules/tools.ts b/src/components/modules/tools.ts
@@ -430,21 +430,21 @@ export default class Tools extends Module {
     for (const toolName in this.toolsClasses) {
       if (Object.prototype.hasOwnProperty.call(this.toolsClasses, toolName)) {
         const toolClass = this.toolsClasses[toolName];
+        const toolConfig = this.toolsSettings[toolName][this.USER_SETTINGS.CONFIG];
 
-        if (typeof toolClass.prepare === 'function') {
-          toolPreparationList.push({
-            function: toolClass.prepare,
-            data: {
-              toolName,
-              config: this.toolsSettings[toolName][this.USER_SETTINGS.CONFIG],
-            },
-          });
-        } else {
-          /**
-           * If Tool hasn't a prepare method, mark it as available
-           */
-          this.toolsAvailable[toolName] = toolClass;
-        }
+        /**
+         * If Tool hasn't a prepare method,
+         * still push it to tool preparation list to save tools order in Toolbox.
+         * As Tool's prepare method might be async, _.sequence util helps to save the order.
+         */
+        toolPreparationList.push({
+          // eslint-disable-next-line @typescript-eslint/no-empty-function
+          function: typeof toolClass.prepare === 'function' ? toolClass.prepare : (): void => {},
+          data: {
+            toolName,
+            config: toolConfig,
+          },
+        });
       }
     }