weseek__growi/resource/js/components/PageEditor/Editor.js

import React from 'react';
import PropTypes from 'prop-types';

import emojione from 'emojione';
import emojiStrategy from 'emojione/emoji_strategy.json';
import * as codemirror from 'codemirror';

import { UnControlled as ReactCodeMirror } from 'react-codemirror2';
require('codemirror/lib/codemirror.css');
require('codemirror/addon/display/autorefresh');
require('codemirror/addon/edit/matchbrackets');
require('codemirror/addon/edit/matchtags');
require('codemirror/addon/edit/closetag');
require('codemirror/addon/edit/continuelist');
require('codemirror/addon/hint/show-hint');
require('codemirror/addon/hint/show-hint.css');
require('codemirror/addon/search/searchcursor');
require('codemirror/addon/search/match-highlighter');
require('codemirror/addon/scroll/annotatescrollbar');
require('codemirror/mode/gfm/gfm');
require('codemirror/theme/eclipse.css');

export default class Editor extends React.Component {

  constructor(props) {
    super(props);

    // https://regex101.com/r/7BN2fR/2
    this.indentAndMarkPattern = /^([ \t]*)(?:>|\-|\+|\*|\d+\.) /;

    this.state = {
      value: this.props.value,
    };

    this.initEmojiImageMap = this.initEmojiImageMap.bind(this);
    this.getCodeMirror = this.getCodeMirror.bind(this);
    this.setCaretLine = this.setCaretLine.bind(this);
    this.forceToFocus = this.forceToFocus.bind(this);
    this.dispatchSave = this.dispatchSave.bind(this);
    this.pasteHandler = this.pasteHandler.bind(this);
    this.pasteText = this.pasteText.bind(this);
    this.autoCompleteEmoji = this.autoCompleteEmoji.bind(this);

    this.initEmojiImageMap()
  }

  componentDidMount() {
    // initialize caret line
    this.setCaretLine(0);
    // set save handler
    codemirror.commands.save = this.dispatchSave;
  }

  initEmojiImageMap() {
    this.emojiShortnameImageMap = {};
    for (let unicode in emojiStrategy) {
      const data = emojiStrategy[unicode];
      const shortname = data.shortname;
      // add image tag
      this.emojiShortnameImageMap[shortname] = emojione.shortnameToImage(shortname);
    }
  }

  getCodeMirror() {
    return this.refs.cm.editor;
  }

  forceToFocus() {
    const editor = this.getCodeMirror();
    // use setInterval with reluctance -- 2018.01.11 Yuki Takei
    const intervalId = setInterval(() => {
      this.getCodeMirror().focus();
      if (editor.hasFocus()) {
        clearInterval(intervalId);
      }
    }, 100);
  }

  /**
   * set caret position of codemirror
   * @param {string} number
   */
  setCaretLine(line) {
    const editor = this.getCodeMirror();
    editor.setCursor({line: line-1});   // leave 'ch' field as null/undefined to indicate the end of line
  }

  /**
   * try to find emoji terms and show hint
   */
  autoCompleteEmoji() {
    const cm = this.getCodeMirror();

    // see https://regex101.com/r/gy3i03/1
    const pattern = /:[^:\s]+/

    const currentPos = cm.getCursor();
    // find previous ':shortname'
    const sc = cm.getSearchCursor(pattern, currentPos, { multiline: false });
    if (sc.findPrevious()) {
      const isInputtingEmoji = (currentPos.line === sc.to().line && currentPos.ch === sc.to().ch);
      // return if it isn't inputting emoji
      if (!isInputtingEmoji) {
        return;
      }
    }
    else {
      return;
    }

    // see https://codemirror.net/doc/manual.html#addon_show-hint
    cm.showHint({
      completeSingle: false,
      // closeOnUnfocus: false,  // for debug
      hint: () => {
        const matched = cm.getDoc().getRange(sc.from(), sc.to());
        const term = matched.replace(':', '');  // remove ':' in the head

        // get a list of shortnames
        const shortnames = this.searchEmojiShortnames(term);
        if (shortnames.length >= 1) {
          return {
            list: this.generateEmojiRenderer(shortnames),
            from: sc.from(),
            to: sc.to(),
          };
        }
      },
    });
  }

  /**
   * see https://codemirror.net/doc/manual.html#addon_show-hint
   * @param {any}
   */
  generateEmojiRenderer(emojiShortnames) {
    return emojiShortnames.map((shortname) => {
      return {
        text: shortname,
        className: 'crowi-emoji-autocomplete',
        render: (element) => {
          element.innerHTML =
            `<div class="img-container">${this.emojiShortnameImageMap[shortname]}</div>` +
            `<span class="shortname-container">${shortname}</span>`;
        }
      }
    });
  }

  /**
   * transplanted from https://github.com/emojione/emojione/blob/master/examples/OTHER.md
   * @param {string} term
   * @returns {string[]} a list of shortname
   */
  searchEmojiShortnames(term) {
    const maxLength = 12;

    let results1 = [], results2 = [], results3 = [], results4 = [];
    const countLen1 = () => { results1.length; }
    const countLen2 = () => { countLen1() + results2.length; }
    const countLen3 = () => { countLen2() + results3.length; }
    const countLen4 = () => { countLen3() + results4.length; }
    // TODO performance tune
    // when total length of all results is less than `maxLength`
    for (let unicode in emojiStrategy) {
      const data = emojiStrategy[unicode];

      if (maxLength <= countLen1()) { break; }
      // prefix match to shortname
      else if (data.shortname.indexOf(`:${term}`) > -1) {
        results1.push(data.shortname);
        continue;
      }
      else if (maxLength <= countLen2()) { continue; }
      // partial match to shortname
      else if (data.shortname.indexOf(term) > -1) {
        results2.push(data.shortname);
        continue;
      }
      else if (maxLength <= countLen3()) { continue; }
      // partial match to elements of aliases
      else if ((data.aliases != null) && data.aliases.find(elem => elem.indexOf(term) > -1)) {
        results3.push(data.shortname);
        continue;
      }
      else if (maxLength <= countLen4()) { continue; }
      // partial match to elements of keywords
      else if ((data.keywords != null) && data.keywords.find(elem => elem.indexOf(term) > -1)) {
        results4.push(data.shortname);
      }
    };

    let results = results1.concat(results2).concat(results3).concat(results4);
    results = results.slice(0, maxLength);

    return results;
  }

  /**
   * CodeMirror paste event handler
   * see: https://codemirror.net/doc/manual.html#events
   * @param {any} editor
   * @param {any} event
   */
  pasteHandler(editor, event) {
    if (event.clipboardData.types.includes('text/plain') > -1) {
      this.pasteText(editor, event);
    }
  }
  /**
   * paste text
   * @param {any} editor
   * @param {any} event
   */
  pasteText(editor, event) {
    // get data in clipboard
    let text = event.clipboardData.getData('text/plain');

    if (text.length == 0) { return; }

    const curPos = editor.getCursor();
    // calc BOL (beginning of line)
    const bol = { line: curPos.line, ch: 0 };
    // get strings from BOL(beginning of line) to current position
    const strFromBol = editor.getDoc().getRange(bol, curPos);

    const matched = strFromBol.match(this.indentAndMarkPattern);
    // when match completely to pattern
    // (this means the current position is the beginning of the list item)
    if (matched && matched[0] == strFromBol) {
      const adjusted = this.adjustPastedData(strFromBol, text);

      // replace
      if (adjusted != null) {
        event.preventDefault();
        this.getCodeMirror().getDoc().replaceRange(adjusted, bol, curPos);
      }
    }
  }
  /**
   * return adjusted pasted data by indentAndMark
   *
   * @param {string} indentAndMark
   * @param {string} text
   * @returns adjusted pasted data
   *      returns null when adjustment is not necessary
   */
  adjustPastedData(indentAndMark, text) {
    let adjusted = null;

    // e.g. '-item ...'
    if (text.match(this.indentAndMarkPattern)) {
      const indent = indentAndMark.match(this.indentAndMarkPattern)[1];

      const lines = text.match(/[^\r\n]+/g);
      const replacedLines = lines.map((line) => {
        return indent + line;
      })

      adjusted = replacedLines.join('\n');
    }

    return adjusted;
  }


  /**
   * dispatch onSave event
   */
  dispatchSave() {
    if (this.props.onSave != null) {
      this.props.onSave();
    }
  }

  render() {
    return (
      <ReactCodeMirror
        ref="cm"
        editorDidMount={(editor) => {
          editor.on('paste', this.pasteHandler);
        }}
        value={this.state.value}
        options={{
          mode: 'gfm',
          theme: 'eclipse',
          lineNumbers: true,
          tabSize: 4,
          indentUnit: 4,
          lineWrapping: true,
          autoRefresh: true,
          autoCloseTags: true,
          matchBrackets: true,
          matchTags: {bothTags: true},
          // match-highlighter, matchesonscrollbar, annotatescrollbar options
          highlightSelectionMatches: {annotateScrollbar: true},
          // markdown mode options
          highlightFormatting: true,
          // continuelist, indentlist
          extraKeys: {
            "Enter": "newlineAndIndentContinueMarkdownList",
            "Tab": "indentMore",
            "Shift-Tab": "indentLess",
          }
        }}
        onScroll={(editor, data) => {
          if (this.props.onScroll != null) {
            this.props.onScroll(data);
          }
        }}
        onChange={(editor, data, value) => {
          if (this.props.onChange != null) {
            this.props.onChange(value);
          }

          // Emoji AutoComplete
          this.autoCompleteEmoji(editor);
        }}
      />
    )
  }

}

Editor.propTypes = {
  value: PropTypes.string,
  onChange: PropTypes.func,
  onScroll: PropTypes.func,
  onSave: PropTypes.func,
};