refactor: scrollfollow -> scrollsync (#1052)

nhn · Dec 21, 2017 · 827e413 · 827e413
1 parent 3de2032
commit 827e413
Show file tree

Hide file tree

Showing 14 changed files with 82 additions and 82 deletions.
diff --git a/demo/demo-dev.html b/demo/demo-dev.html
@@ -41,7 +41,7 @@
         height: '100%',
         initialEditType: 'wysiwyg',
         useCommandShortcut: true,
-        exts: ['scrollFollow', 'colorSyntax', 'uml', 'chart', 'mark', 'table', 'taskCounter']
+        exts: ['scrollSync', 'colorSyntax', 'uml', 'chart', 'mark', 'table', 'taskCounter']
     });
 </script>
 </body>

diff --git a/demo/demo-scrollfollow.html → demo/demo-scrollsync.html b/demo/demo-scrollfollow.html → demo/demo-scrollsync.html
@@ -31,13 +31,13 @@
 <body>
 <div id="editSection"></div>
 <script src="../dist/tui-editor-Editor.js"></script>
-<script src="../dist/tui-editor-extScrollFollow.js"></script>
+<script src="../dist/tui-editor-extScrollSync.js"></script>
 <script>
     $('#editSection').tuiEditor({
         previewStyle: 'vertical',
         height: '400px',
         initialEditType: 'wysiwyg',
-        exts: ['scrollFollow']
+        exts: ['scrollSync']
     });
 </script>
 </body>

diff --git a/demo/demo-uml-viewer.html b/demo/demo-uml-viewer.html
@@ -60,7 +60,7 @@
     ].join('\n');
     $('#editSection').tuiEditorViewer({
         initialValue: content,
-        exts: ['scrollFollow', {
+        exts: ['scrollSync', {
             name: 'uml', // enable plant uml plugin
             rendererURL: 'http://www.plantuml.com/plantuml/png/'
         }]

diff --git a/src/css/tui-editor.css b/src/css/tui-editor.css
@@ -300,22 +300,22 @@
     margin-right: 0;
 }
 
-.tui-editor-defaultUI-toolbar button.tui-scrollfollow {
+.tui-editor-defaultUI-toolbar button.tui-scrollsync {
     width: auto;
     color: #777777;
     border: 0;
 }
 
-.tui-editor-defaultUI button.tui-scrollfollow:after {
+.tui-editor-defaultUI button.tui-scrollsync:after {
     content: "Scroll off";
 } 
 
-.tui-editor-defaultUI button.tui-scrollfollow.active {
+.tui-editor-defaultUI button.tui-scrollsync.active {
     color: #125de6;
     font-weight: bold;
 }
 
-.tui-editor-defaultUI button.tui-scrollfollow.active:after {
+.tui-editor-defaultUI button.tui-scrollsync.active:after {
     content: "Scroll on";
 }
 
@@ -1112,16 +1112,16 @@
     overflow-y: auto;
 }
 
-.tui-split-scroll button.tui-scrollfollow {
+.tui-split-scroll button.tui-scrollsync {
     top: 10px;
     opacity: 0.2;
 }
 
-.tui-split-scroll button.tui-scrollfollow::after {
+.tui-split-scroll button.tui-scrollsync::after {
     content: "scroll off";
 }
 
-.tui-split-scroll.scroll-sync button.tui-scrollfollow {
+.tui-split-scroll.scroll-sync button.tui-scrollsync {
     opacity: 0.5;
 }
 
@@ -1131,7 +1131,7 @@
     overflow: initial;
 }
 
-.tui-split-scroll.scroll-sync button.tui-scrollfollow::after {
+.tui-split-scroll.scroll-sync button.tui-scrollsync::after {
     content: "scroll on";
 }
 
@@ -1151,7 +1151,7 @@
     display: none;
 }
 
-.tui-split-scroll.single-content button.tui-scrollfollow {
+.tui-split-scroll.single-content button.tui-scrollsync {
     display: none;
 }
 

diff --git a/src/js/codemirror/markdown.js b/src/js/codemirror/markdown.js
@@ -35,7 +35,7 @@ CodeMirror.defineMode("markdown", function(cmCfg, modeCfg) {
     modeCfg.underscoresBreakWords = true;
 
 // TUI.EDITOR MODIFICATION START
-// scrollFollow prototype
+// scrollSync prototype
 // https://github.nhnent.com/fe/tui.editor/commit/f63d6ae79078923d369e6c170d07485f05c42fd7
 // Use `fencedCodeBlocks` to configure fenced code blocks. false to
 // disable, string to specify a precise regexp that the fence should
@@ -76,7 +76,7 @@ CodeMirror.defineMode("markdown", function(cmCfg, modeCfg) {
   ,   olRE = /^[0-9]+([.)])\s+/
   ,   taskListRE = /^\[(x| )\](?=\s)/ // Must follow ulRE or olRE
 // TUI.EDITOR MODIFICATION START
-// scrollFollow prototype
+// scrollSync prototype
 // https://github.nhnent.com/fe/tui.editor/commit/f63d6ae79078923d369e6c170d07485f05c42fd7
   ,   atxHeaderRE = modeCfg.allowAtxHeaderWithoutSpace ? /^(#+)/ : /^(#+)(?: |$)/
   ,   setextHeaderRE = /^ *(?:\={1,}|-{1,})\s*$/
@@ -99,7 +99,7 @@ CodeMirror.defineMode("markdown", function(cmCfg, modeCfg) {
   }
 
 // TUI.EDITOR MODIFICATION START
-// scrollFollow prototype
+// scrollSync prototype
 // https://github.nhnent.com/fe/tui.editor/commit/f63d6ae79078923d369e6c170d07485f05c42fd7
   function lineIsEmpty(line) {
     return !line || !/\S/.test(line.string)
@@ -129,7 +129,7 @@ CodeMirror.defineMode("markdown", function(cmCfg, modeCfg) {
     state.trailingSpace = 0;
     state.trailingSpaceNewLine = false;
 // TUI.EDITOR MODIFICATION START
-// scrollFollow prototype
+// scrollSync prototype
 // https://github.nhnent.com/fe/tui.editor/commit/f63d6ae79078923d369e6c170d07485f05c42fd7
     // Mark this line as blank
     state.prevLine = state.thisLine
@@ -176,7 +176,7 @@ CodeMirror.defineMode("markdown", function(cmCfg, modeCfg) {
     if (state.indentationDiff >= 4) {
       stream.skipToEnd();
 // TUI.EDITOR MODIFICATION START
-// scrollFollow prototype
+// scrollSync prototype
 // https://github.nhnent.com/fe/tui.editor/commit/f63d6ae79078923d369e6c170d07485f05c42fd7
       if (prevLineIsIndentedCode || lineIsEmpty(state.prevLine)) {
       // if (prevLineIsIndentedCode || !state.prevLineHasContent) {
@@ -195,7 +195,7 @@ CodeMirror.defineMode("markdown", function(cmCfg, modeCfg) {
       state.f = state.inline;
       return getType(state);
 // TUI.EDITOR MODIFICATION START
-// scrollFollow prototype
+// scrollSync prototype
 // https://github.nhnent.com/fe/tui.editor/commit/f63d6ae79078923d369e6c170d07485f05c42fd7
     } else if (!lineIsEmpty(state.prevLine) && !state.quote && !prevLineIsList &&
                !prevLineIsIndentedCode && (match = stream.match(setextHeaderRE))) {
@@ -216,7 +216,7 @@ CodeMirror.defineMode("markdown", function(cmCfg, modeCfg) {
       state.hr = true;
       return hr;
 // TUI.EDITOR MODIFICATION START
-// scrollFollow prototype
+// scrollSync prototype
 // https://github.nhnent.com/fe/tui.editor/commit/f63d6ae79078923d369e6c170d07485f05c42fd7
     } else if ((lineIsEmpty(state.prevLine) || prevLineIsList) && (stream.match(ulRE, false) || stream.match(olRE, false))) {
     // } else if ((!state.prevLineHasContent || prevLineIsList) && (stream.match(ulRE, false) || stream.match(olRE, false))) {
@@ -229,7 +229,7 @@ CodeMirror.defineMode("markdown", function(cmCfg, modeCfg) {
         listType = 'ol';
       }
 // TUI.EDITOR MODIFICATION START
-// scrollFollow prototype
+// scrollSync prototype
 // https://github.nhnent.com/fe/tui.editor/commit/f63d6ae79078923d369e6c170d07485f05c42fd7
 // Roll back to original #1002
 // https://github.nhnent.com/fe/tui.editor/issues/1002
@@ -250,7 +250,7 @@ CodeMirror.defineMode("markdown", function(cmCfg, modeCfg) {
       if (modeCfg.highlightFormatting) state.formatting = ["list", "list-" + listType];
       return getType(state);
 // TUI.EDITOR MODIFICATION START
-// scrollFollow prototype
+// scrollSync prototype
 // https://github.nhnent.com/fe/tui.editor/commit/f63d6ae79078923d369e6c170d07485f05c42fd7
     } else if (modeCfg.fencedCodeBlocks && (match = stream.match(fencedCodeRE, true))) {
       state.fencedChars = match[1]
@@ -284,7 +284,7 @@ CodeMirror.defineMode("markdown", function(cmCfg, modeCfg) {
 
   function local(stream, state) {
 // TUI.EDITOR MODIFICATION START
-// scrollFollow prototype
+// scrollSync prototype
 // https://github.nhnent.com/fe/tui.editor/commit/f63d6ae79078923d369e6c170d07485f05c42fd7
     if (stream.sol() && state.fencedChars && stream.match(state.fencedChars, false)) {
     // if (stream.sol() && stream.match("```", false)) {
@@ -302,7 +302,7 @@ CodeMirror.defineMode("markdown", function(cmCfg, modeCfg) {
 
   function leavingLocal(stream, state) {
 // TUI.EDITOR MODIFICATION START
-// scrollFollow prototype
+// scrollSync prototype
 // https://github.nhnent.com/fe/tui.editor/commit/f63d6ae79078923d369e6c170d07485f05c42fd7
     stream.match(state.fencedChars);
     state.block = blockNormal;
@@ -750,7 +750,7 @@ CodeMirror.defineMode("markdown", function(cmCfg, modeCfg) {
       return {
         f: blockNormal,
 // TUI.EDITOR MODIFICATION START
-// scrollFollow prototype
+// scrollSync prototype
 // https://github.nhnent.com/fe/tui.editor/commit/f63d6ae79078923d369e6c170d07485f05c42fd7
         prevLine: null,
         thisLine: null,
@@ -786,7 +786,7 @@ CodeMirror.defineMode("markdown", function(cmCfg, modeCfg) {
         trailingSpaceNewLine: false,
         strikethrough: false,
 // TUI.EDITOR MODIFICATION START
-// scrollFollow prototype
+// scrollSync prototype
 // https://github.nhnent.com/fe/tui.editor/commit/f63d6ae79078923d369e6c170d07485f05c42fd7
         fencedChars: null
 // TUI.EDITOR MODIFICATION END
@@ -798,7 +798,7 @@ CodeMirror.defineMode("markdown", function(cmCfg, modeCfg) {
         f: s.f,
 
 // TUI.EDITOR MODIFICATION START
-// scrollFollow prototype
+// scrollSync prototype
 // https://github.nhnent.com/fe/tui.editor/commit/f63d6ae79078923d369e6c170d07485f05c42fd7
         prevLine: s.prevLine,
         thisLine: s.this,
@@ -818,7 +818,7 @@ CodeMirror.defineMode("markdown", function(cmCfg, modeCfg) {
         formatting: false,
         linkTitle: s.linkTitle,
 // TUI.EDITOR MODIFICATION START
-// scrollFollow prototype
+// scrollSync prototype
 // https://github.nhnent.com/fe/tui.editor/commit/f63d6ae79078923d369e6c170d07485f05c42fd7
         code: s.code,
 // TUI.EDITOR MODIFICATION END
@@ -841,7 +841,7 @@ CodeMirror.defineMode("markdown", function(cmCfg, modeCfg) {
         trailingSpaceNewLine: s.trailingSpaceNewLine,
         md_inside: s.md_inside,
 // TUI.EDITOR MODIFICATION START
-// scrollFollow prototype
+// scrollSync prototype
 // https://github.nhnent.com/fe/tui.editor/commit/f63d6ae79078923d369e6c170d07485f05c42fd7
         fencedChars: s.fencedChars
 // TUI.EDITOR MODIFICATION END
@@ -854,7 +854,7 @@ CodeMirror.defineMode("markdown", function(cmCfg, modeCfg) {
       state.formatting = false;
 
 // TUI.EDITOR MODIFICATION START
-// scrollFollow prototype
+// scrollSync prototype
 // https://github.nhnent.com/fe/tui.editor/commit/f63d6ae79078923d369e6c170d07485f05c42fd7
       if (stream != state.thisLine) {
         var forceBlankLine = state.header || state.hr;
@@ -868,7 +868,7 @@ CodeMirror.defineMode("markdown", function(cmCfg, modeCfg) {
 
         if (stream.match(/^\s*$/, true) || forceBlankLine) {
 // TUI.EDITOR MODIFICATION START
-// scrollFollow prototype
+// scrollSync prototype
 // https://github.nhnent.com/fe/tui.editor/commit/f63d6ae79078923d369e6c170d07485f05c42fd7
           blankLine(state);
           if (!forceBlankLine) return null

diff --git a/src/js/extensions/scrollFollow/scrollSync.js → ...js/extensions/scrollSync/scrollManager.js b/src/js/extensions/scrollFollow/scrollSync.js → ...js/extensions/scrollSync/scrollManager.js
@@ -1,5 +1,5 @@
 /**
- * @fileoverview Implements Scroll Follow Extension ScrollSync Module
+ * @fileoverview Implements Scroll Follow Extension ScrollManager Module
  * @author Sungho Kim(sungho-kim@nhnent.com) FE Development Team/NHN Ent.
  */
 import util from 'tui-code-snippet';
@@ -9,16 +9,16 @@ const SCROLL_TOP_PADDING = 20;
 const SCROLL_BOCKING_RESET_DELAY = 15;
 
 /**
- * Class ScrollSync
+ * Class ScrollManager
  * manage scroll sync between markdown editor and preview
  */
-class ScrollSync {
+class ScrollManager {
     /**
-     * Creates an instance of ScrollSync.
+     * Creates an instance of ScrollManager.
      * @param {SectionManager} sectionManager - sectionManager
      * @param {CodeMirror} cm - CodeMirror
      * @param {jQuery} $previewContainerEl - preview container
-     * @memberof ScrollSync
+     * @memberof ScrollManager
      */
     constructor(sectionManager, cm, $previewContainerEl) {
         this.sectionManager = sectionManager;
@@ -327,7 +327,7 @@ class ScrollSync {
 
     /**
      * Save Codemirror's scrollInfo for alternative use
-     * memberOf ScrollSync
+     * memberOf ScrollManager
      */
     saveScrollInfo() {
         this._savedScrollInfo = this.cm.getScrollInfo();
@@ -351,4 +351,4 @@ class ScrollSync {
     }
 }
 
-export default ScrollSync;
+export default ScrollManager;
diff --git a/...s/extensions/scrollFollow/scrollFollow.js → src/js/extensions/scrollSync/scrollSync.js b/...s/extensions/scrollFollow/scrollFollow.js → src/js/extensions/scrollSync/scrollSync.js
@@ -4,13 +4,13 @@
  */
 import $ from 'jquery';
 import Editor from '../editor';
-import ScrollSync from './scrollSync';
+import ScrollManager from './scrollManager';
 import SectionManager from './sectionManager';
 
 const {Button} = Editor;
 
-function scrollFollowExtension(editor) {
-    const className = 'tui-scrollfollow';
+function scrollSyncExtension(editor) {
+    const className = 'tui-scrollsync';
     const i18n = editor.i18n;
     const TOOL_TIP = {
         active: i18n.get('Auto scroll enabled'),
@@ -23,7 +23,7 @@ function scrollFollowExtension(editor) {
 
     const cm = editor.getCodeMirror();
     const sectionManager = new SectionManager(cm, editor.preview);
-    const scrollSync = new ScrollSync(sectionManager, cm, editor.preview.$el);
+    const scrollManager = new ScrollManager(sectionManager, cm, editor.preview.$el);
 
     let isScrollable = false;
     let isActive = true;
@@ -35,7 +35,7 @@ function scrollFollowExtension(editor) {
         // init button
         button = new Button({
             className,
-            command: 'scrollFollowToggle',
+            command: 'scrollSyncToggle',
             tooltip: TOOL_TIP.active,
             $el: $(`<button class="active ${className}" type="button"></button>`)
         });
@@ -50,7 +50,7 @@ function scrollFollowExtension(editor) {
 
         // Commands
         editor.addCommand('markdown', {
-            name: 'scrollFollowToggle',
+            name: 'scrollSyncToggle',
             exec() {
                 isActive = !isActive;
                 button._onOut();
@@ -87,7 +87,7 @@ function scrollFollowExtension(editor) {
 
     editor.on('previewRenderAfter', () => {
         sectionManager.sectionMatch();
-        scrollSync.syncPreviewScrollTopToMarkdown();
+        scrollManager.syncPreviewScrollTopToMarkdown();
         isScrollable = true;
     });
 
@@ -97,17 +97,17 @@ function scrollFollowExtension(editor) {
         }
 
         if (isScrollable && editor.preview.isVisible()) {
-            if (event.source === 'markdown' && !scrollSync.isMarkdownScrollEventBlocked) {
-                scrollSync.syncPreviewScrollTopToMarkdown();
-            } else if (event.source === 'preview' && !scrollSync.isPreviewScrollEventBlocked) {
-                scrollSync.syncMarkdownScrollTopToPreview();
+            if (event.source === 'markdown' && !scrollManager.isMarkdownScrollEventBlocked) {
+                scrollManager.syncPreviewScrollTopToMarkdown();
+            } else if (event.source === 'preview' && !scrollManager.isPreviewScrollEventBlocked) {
+                scrollManager.syncMarkdownScrollTopToPreview();
             }
         } else {
-            scrollSync.saveScrollInfo();
+            scrollManager.saveScrollInfo();
         }
     });
 }
 
-Editor.defineExtension('scrollFollow', scrollFollowExtension);
+Editor.defineExtension('scrollSync', scrollSyncExtension);
 
-export default scrollFollowExtension;
+export default scrollSyncExtension;
diff --git a/...extensions/scrollFollow/sectionManager.js → ...s/extensions/scrollSync/sectionManager.js b/...extensions/scrollFollow/sectionManager.js → ...s/extensions/scrollSync/sectionManager.js
diff --git a/src/js/indexAll.js b/src/js/indexAll.js
@@ -2,7 +2,7 @@ const Editor = require('./index');
 
 import './extensions/chart/chart';
 import './extensions/mark/mark';
-import './extensions/scrollFollow/scrollFollow';
+import './extensions/scrollSync/scrollSync';
 import './extensions/table/table';
 import './extensions/colorSyntax';
 import './extensions/taskCounter';