Editor.tsx 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363
  1. import React, {
  2. useState, useRef, useImperativeHandle, useCallback, useMemo,
  3. } from 'react';
  4. import Dropzone from 'react-dropzone';
  5. import { useTranslation } from 'react-i18next';
  6. import {
  7. Modal, ModalHeader, ModalBody,
  8. } from 'reactstrap';
  9. import { toastError } from '~/client/util/apiNotification';
  10. import { useDefaultIndentSize } from '~/stores/context';
  11. import { useEditorSettings } from '~/stores/editor';
  12. import { useIsMobile } from '~/stores/ui';
  13. import { IEditorMethods } from '../../interfaces/editor-methods';
  14. import Cheatsheet from './Cheatsheet';
  15. import CodeMirrorEditor from './CodeMirrorEditor';
  16. import pasteHelper from './PasteHelper';
  17. import TextAreaEditor from './TextAreaEditor';
  18. type EditorPropsType = {
  19. value?: string,
  20. isGfmMode?: boolean,
  21. noCdn?: boolean,
  22. isUploadable?: boolean,
  23. isUploadableFile?: boolean,
  24. onChange?: () => void,
  25. onUpload?: (file) => void,
  26. indentSize?: number,
  27. onScrollCursorIntoView?: (line: number) => void,
  28. onSave?: () => Promise<void>,
  29. onPasteFiles?: (event: Event) => void,
  30. onCtrlEnter?: (event: Event) => void,
  31. }
  32. type DropzoneRef = {
  33. open: () => void
  34. }
  35. const Editor = React.forwardRef((props: EditorPropsType, ref): JSX.Element => {
  36. const {
  37. onUpload, isUploadable, isUploadableFile, indentSize, isGfmMode = true,
  38. } = props;
  39. const [dropzoneActive, setDropzoneActive] = useState(false);
  40. const [isUploading, setIsUploading] = useState(false);
  41. const [isCheatsheetModalShown, setIsCheatsheetModalShown] = useState(false);
  42. const { t } = useTranslation();
  43. const { data: editorSettings } = useEditorSettings();
  44. const { data: defaultIndentSize } = useDefaultIndentSize();
  45. const { data: isMobile } = useIsMobile();
  46. const dropzoneRef = useRef<DropzoneRef>(null);
  47. const cmEditorRef = useRef<CodeMirrorEditor>(null);
  48. const taEditorRef = useRef<TextAreaEditor>(null);
  49. const editorSubstance = isMobile ? taEditorRef.current : cmEditorRef.current;
  50. const methods: Partial<IEditorMethods> = useMemo(() => {
  51. return {
  52. forceToFocus: () => {
  53. if (editorSubstance == null) { return }
  54. editorSubstance.forceToFocus();
  55. },
  56. setValue: (newValue: string) => {
  57. if (editorSubstance == null) { return }
  58. editorSubstance.setValue(newValue);
  59. },
  60. setGfmMode: (bool: boolean) => {
  61. if (editorSubstance == null) { return }
  62. editorSubstance.setGfmMode(bool);
  63. },
  64. setCaretLine: (line: number) => {
  65. if (editorSubstance == null) { return }
  66. editorSubstance.setCaretLine(line);
  67. },
  68. setScrollTopByLine: (line: number) => {
  69. if (editorSubstance == null) { return }
  70. editorSubstance.setScrollTopByLine(line);
  71. },
  72. insertText: (text: string) => {
  73. if (editorSubstance == null) { return }
  74. editorSubstance.insertText(text);
  75. },
  76. getNavbarItems: (): JSX.Element[] => {
  77. if (editorSubstance == null) { return [] }
  78. // concat common items and items specific to CodeMirrorEditor or TextAreaEditor
  79. const navbarItems = editorSubstance.getNavbarItems() ?? [];
  80. return navbarItems;
  81. },
  82. };
  83. }, [editorSubstance]);
  84. // methods for ref
  85. useImperativeHandle(ref, () => ({
  86. forceToFocus: methods.forceToFocus,
  87. setValue: methods.setValue,
  88. setGfmMode: methods.setGfmMode,
  89. setCaretLine: methods.setCaretLine,
  90. setScrollTopByLine: methods.setScrollTopByLine,
  91. insertText: methods.insertText,
  92. /**
  93. * remove overlay and set isUploading to false
  94. */
  95. terminateUploadingState: () => {
  96. setDropzoneActive(false);
  97. setIsUploading(false);
  98. },
  99. }));
  100. /**
  101. * dispatch onUpload event
  102. */
  103. const dispatchUpload = useCallback((files) => {
  104. if (onUpload != null) {
  105. onUpload(files);
  106. }
  107. }, [onUpload]);
  108. /**
  109. * get acceptable(uploadable) file type
  110. */
  111. const getAcceptableType = useCallback(() => {
  112. let accept = 'null'; // reject all
  113. if (isUploadable) {
  114. if (!isUploadableFile) {
  115. accept = 'image/*'; // image only
  116. }
  117. else {
  118. accept = ''; // allow all
  119. }
  120. }
  121. return accept;
  122. }, [isUploadable, isUploadableFile]);
  123. const pasteFilesHandler = useCallback((event) => {
  124. const items = event.clipboardData.items || event.clipboardData.files || [];
  125. toastError(t('toaster.file_upload_failed'));
  126. // abort if length is not 1
  127. if (items.length < 1) {
  128. return;
  129. }
  130. for (let i = 0; i < items.length; i++) {
  131. try {
  132. const file = items[i].getAsFile();
  133. // check file type (the same process as Dropzone)
  134. if (file != null && pasteHelper.isAcceptableType(file, getAcceptableType())) {
  135. dispatchUpload(file);
  136. setIsUploading(true);
  137. }
  138. }
  139. catch (e) {
  140. toastError(t('toaster.file_upload_failed'));
  141. }
  142. }
  143. }, [dispatchUpload, getAcceptableType, t]);
  144. const dragEnterHandler = useCallback((event) => {
  145. const dataTransfer = event.dataTransfer;
  146. // do nothing if contents is not files
  147. if (!dataTransfer.types.includes('Files')) {
  148. return;
  149. }
  150. setDropzoneActive(true);
  151. }, []);
  152. const dropHandler = useCallback((accepted) => {
  153. // rejected
  154. if (accepted.length !== 1) { // length should be 0 or 1 because `multiple={false}` is set
  155. setDropzoneActive(false);
  156. return;
  157. }
  158. const file = accepted[0];
  159. dispatchUpload(file);
  160. setIsUploading(true);
  161. }, [dispatchUpload]);
  162. const addAttachmentHandler = useCallback(() => {
  163. if (dropzoneRef.current == null) { return }
  164. dropzoneRef.current.open();
  165. }, []);
  166. const getDropzoneClassName = useCallback((isDragAccept: boolean, isDragReject: boolean) => {
  167. let className = 'dropzone';
  168. if (!isUploadable) {
  169. className += ' dropzone-unuploadable';
  170. }
  171. else {
  172. className += ' dropzone-uploadable';
  173. if (isUploadableFile) {
  174. className += ' dropzone-uploadablefile';
  175. }
  176. }
  177. // uploading
  178. if (isUploading) {
  179. className += ' dropzone-uploading';
  180. }
  181. if (isDragAccept) {
  182. className += ' dropzone-accepted';
  183. }
  184. if (isDragReject) {
  185. className += ' dropzone-rejected';
  186. }
  187. return className;
  188. }, [isUploadable, isUploading, isUploadableFile]);
  189. const renderDropzoneOverlay = useCallback(() => {
  190. return (
  191. <div className="overlay overlay-dropzone-active">
  192. {isUploading
  193. && (
  194. <span className="overlay-content">
  195. <div className="speeding-wheel d-inline-block"></div>
  196. <span className="sr-only">Uploading...</span>
  197. </span>
  198. )
  199. }
  200. {!isUploading && <span className="overlay-content"></span>}
  201. </div>
  202. );
  203. }, [isUploading]);
  204. const renderNavbar = useCallback(() => {
  205. return (
  206. <div className="m-0 navbar navbar-default navbar-editor" style={{ minHeight: 'unset' }}>
  207. <ul className="pl-2 nav nav-navbar">
  208. { methods.getNavbarItems?.().map((item, idx) => {
  209. // eslint-disable-next-line react/no-array-index-key
  210. return <li key={`navbarItem-${idx}`}>{item}</li>;
  211. }) }
  212. </ul>
  213. </div>
  214. );
  215. }, [methods]);
  216. const renderCheatsheetModal = useCallback(() => {
  217. const hideCheatsheetModal = () => {
  218. setIsCheatsheetModalShown(false);
  219. };
  220. return (
  221. <Modal isOpen={isCheatsheetModalShown} toggle={hideCheatsheetModal} className="modal-gfm-cheatsheet">
  222. <ModalHeader tag="h4" toggle={hideCheatsheetModal} className="bg-primary text-light">
  223. <i className="icon-fw icon-question" />Markdown help
  224. </ModalHeader>
  225. <ModalBody>
  226. <Cheatsheet />
  227. </ModalBody>
  228. </Modal>
  229. );
  230. }, [isCheatsheetModalShown]);
  231. if (editorSettings == null) {
  232. return <></>;
  233. }
  234. const flexContainer: React.CSSProperties = {
  235. height: '100%',
  236. display: 'flex',
  237. flexDirection: 'column',
  238. };
  239. return (
  240. <>
  241. <div style={flexContainer} className="editor-container">
  242. <Dropzone
  243. ref={dropzoneRef}
  244. accept={getAcceptableType()}
  245. noClick
  246. noKeyboard
  247. multiple={false}
  248. onDragLeave={() => { setDropzoneActive(false) }}
  249. onDrop={dropHandler}
  250. >
  251. {({
  252. getRootProps,
  253. getInputProps,
  254. isDragAccept,
  255. isDragReject,
  256. }) => {
  257. return (
  258. <div className={getDropzoneClassName(isDragAccept, isDragReject)} {...getRootProps()}>
  259. { dropzoneActive && renderDropzoneOverlay() }
  260. { renderNavbar() }
  261. {/* for PC */}
  262. { !isMobile && (
  263. // eslint-disable-next-line arrow-body-style
  264. <CodeMirrorEditor
  265. ref={cmEditorRef}
  266. indentSize={indentSize ?? defaultIndentSize}
  267. onPasteFiles={pasteFilesHandler}
  268. onDragEnter={dragEnterHandler}
  269. onMarkdownHelpButtonClicked={() => { setIsCheatsheetModalShown(true) }}
  270. onAddAttachmentButtonClicked={addAttachmentHandler}
  271. editorSettings={editorSettings}
  272. isGfmMode={isGfmMode}
  273. {...props}
  274. />
  275. )}
  276. {/* for mobile */}
  277. { isMobile && (
  278. <TextAreaEditor
  279. ref={taEditorRef}
  280. onPasteFiles={pasteFilesHandler}
  281. onDragEnter={dragEnterHandler}
  282. {...props}
  283. />
  284. )}
  285. <input {...getInputProps()} />
  286. </div>
  287. );
  288. }}
  289. </Dropzone>
  290. { isUploadable
  291. && (
  292. <button
  293. type="button"
  294. className="btn btn-outline-secondary btn-block btn-open-dropzone"
  295. onClick={addAttachmentHandler}
  296. >
  297. <i className="icon-paper-clip" aria-hidden="true"></i>&nbsp;
  298. Attach files
  299. <span className="d-none d-sm-inline">
  300. &nbsp;by dragging &amp; dropping,&nbsp;
  301. <span className="btn-link">selecting them</span>,&nbsp;
  302. or pasting from the clipboard.
  303. </span>
  304. </button>
  305. )
  306. }
  307. { renderCheatsheetModal() }
  308. </div>
  309. </>
  310. );
  311. });
  312. Editor.displayName = 'Editor';
  313. export default Editor;