UncontrolledCodeMirror.tsx 2.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101
  1. import React, {
  2. useCallback, useRef, MutableRefObject,
  3. } from 'react';
  4. import codemirror, { commands, Editor } from 'codemirror';
  5. import { type ICodeMirror, UnControlled as CodeMirror } from 'react-codemirror2';
  6. declare global {
  7. // eslint-disable-next-line vars-on-top, no-var
  8. var CodeMirror: ICodeMirror;
  9. }
  10. // set save handler
  11. // CommandActions in @types/codemirror does not include 'save' but actualy exists
  12. // https://codemirror.net/5/doc/manual.html#commands
  13. (commands as any).save = (instance) => {
  14. if (instance.codeMirrorEditor != null) {
  15. instance.codeMirrorEditor.dispatchSave();
  16. }
  17. };
  18. window.CodeMirror = codemirror;
  19. require('codemirror/addon/display/placeholder');
  20. require('~/client/util/codemirror/gfm-growi.mode');
  21. export interface UncontrolledCodeMirrorProps extends ICodeMirror {
  22. value: string;
  23. isGfmMode?: boolean;
  24. lineNumbers?: boolean;
  25. onSave?: () => Promise<void>;
  26. onCtrlEnter?: (event: Event) => void;
  27. onPasteFiles?: (editor: any, event: Event) => void;
  28. onScrollCursorIntoView?: (editor: any, event: Event) => void;
  29. }
  30. export const UncontrolledCodeMirror = React.forwardRef<CodeMirror|null, UncontrolledCodeMirrorProps>((props, forwardedRef): JSX.Element => {
  31. const {
  32. value, lineNumbers, options,
  33. onPasteFiles, onScrollCursorIntoView,
  34. ...rest
  35. } = props;
  36. const editorRef = useRef<Editor>();
  37. const wrapperRef = useRef<CodeMirror|null>();
  38. const editorDidMountHandler = useCallback((editor: Editor): void => {
  39. editorRef.current = editor;
  40. if (onPasteFiles != null) {
  41. editor.on('paste', onPasteFiles);
  42. }
  43. if (onScrollCursorIntoView != null) {
  44. editor.on('scrollCursorIntoView', onScrollCursorIntoView);
  45. }
  46. }, [onPasteFiles, onScrollCursorIntoView]);
  47. const editorWillUnmountHandler = useCallback((): void => {
  48. // workaround to fix editor duplicating by https://github.com/scniro/react-codemirror2/issues/284#issuecomment-1155928554
  49. if (editorRef.current != null) {
  50. (editorRef.current as any).display.wrapper.remove();
  51. }
  52. if (wrapperRef.current != null) {
  53. (wrapperRef.current as any).hydrated = false;
  54. }
  55. }, []);
  56. // default true
  57. const isGfmMode = rest.isGfmMode ?? true;
  58. return (
  59. <CodeMirror
  60. ref={(elem) => {
  61. // register to wrapperRef
  62. wrapperRef.current = elem;
  63. // register to forwardedRef
  64. if (forwardedRef != null) {
  65. if (typeof forwardedRef === 'function') {
  66. forwardedRef(elem);
  67. }
  68. else {
  69. (forwardedRef as MutableRefObject<CodeMirror|null>).current = elem;
  70. }
  71. }
  72. }}
  73. value={value}
  74. options={{
  75. lineNumbers: lineNumbers ?? true,
  76. mode: isGfmMode ? 'gfm-growi' : undefined,
  77. tabSize: 4,
  78. ...options,
  79. }}
  80. editorDidMount={editorDidMountHandler}
  81. editorWillUnmount={editorWillUnmountHandler}
  82. {...rest}
  83. />
  84. );
  85. });
  86. UncontrolledCodeMirror.displayName = 'UncontrolledCodeMirror';