feat: add common highlight entry #704

#704

Author: jaywcjlove

core/README.md

@@ -256,6 +256,36 @@ export default function App() {
 }
 ```
 
+### Common Code Highlight
+
+Use `@uiw/react-md-editor/common` to keep syntax highlighting while only including the `rehype-prism-plus/common` language subset. This is a middle ground between the default full-language build and `nohighlight`.
+
+```jsx mdx:preview
+import React from "react";
+import MDEditor from '@uiw/react-md-editor/common';
+
+const code = `**Hello world!!!**
+\`\`\`js
+function greet(name) {
+  console.log('hello', name);
+}
+\`\`\`
+`
+
+export default function App() {
+  const [value, setValue] = React.useState(code);
+  return (
+    <div className="container">
+      <MDEditor
+        value={value}
+        onChange={setValue}
+      />
+      <MDEditor.Markdown source={value} style={{ whiteSpace: 'pre-wrap' }} />
+    </div>
+  );
+}
+```
+
 ### Placeholder & maxLength
 
 "Below is an example that sets the `placeholder` for the editor and defines the maximum input character length as `10` characters."

core/common.d.ts

@@ -0,0 +1,17 @@
+declare module '@uiw/react-md-editor/common' {
+  import MDEditor from '@uiw/react-md-editor/esm/Editor.common';
+  import * as commands from '@uiw/react-md-editor/esm/commands';
+  import * as MarkdownUtil from '@uiw/react-md-editor/esm/utils/markdownUtils';
+  export { headingExecute } from '@uiw/react-md-editor/esm/commands/title';
+  export * from '@uiw/react-md-editor/esm/commands';
+  export * from '@uiw/react-md-editor/esm/commands/group';
+  export * from '@uiw/react-md-editor/esm/utils/markdownUtils';
+  export * from '@uiw/react-md-editor/esm/utils/InsertTextAtPosition';
+  export * from '@uiw/react-md-editor/esm/Editor.common';
+  export * from '@uiw/react-md-editor/esm/Context';
+  export * from '@uiw/react-md-editor/esm/Types';
+  export { default as handleKeyDown } from '@uiw/react-md-editor/esm/components/TextArea/handleKeyDown';
+  export { default as shortcuts } from '@uiw/react-md-editor/esm/components/TextArea/shortcuts';
+  export { MarkdownUtil, commands };
+  export default MDEditor;
+}

core/package.json

@@ -16,6 +16,11 @@
       "types": "./lib/index.d.ts",
       "require": "./lib/index.js"
     },
+    "./common": {
+      "import": "./esm/index.common.js",
+      "types": "./lib/index.common.d.ts",
+      "require": "./lib/index.common.js"
+    },
     "./nohighlight": {
       "import": "./esm/index.nohighlight.js",
       "types": "./lib/index.nohighlight.d.ts",
@@ -53,6 +58,7 @@
   },
   "files": [
     "markdown-editor.css",
+    "common.d.ts",
     "nohighlight.d.ts",
     "commands.d.ts",
     "commands-cn.d.ts",
@@ -68,7 +74,7 @@
   },
   "dependencies": {
     "@babel/runtime": "^7.14.6",
-    "@uiw/react-markdown-preview": "^5.0.6",
+    "@uiw/react-markdown-preview": "^5.2.0",
     "rehype": "~13.0.0",
     "rehype-prism-plus": "~2.0.0"
   },

core/src/Editor.common.tsx

@@ -0,0 +1,276 @@
+import React, { useEffect, useReducer, useMemo, useRef, useImperativeHandle } from 'react';
+import MarkdownPreview from '@uiw/react-markdown-preview/common';
+import { ToolbarVisibility } from './components/Toolbar/';
+import TextArea from './components/TextArea/index.common';
+import DragBar from './components/DragBar/';
+import { getCommands, getExtraCommands, type ICommand, type TextState, TextAreaCommandOrchestrator } from './commands/';
+import { reducer, EditorContext, type ContextStore } from './Context';
+import type { MDEditorProps } from './Types';
+
+function setGroupPopFalse(data: Record<string, boolean> = {}) {
+  Object.keys(data).forEach((keyname) => {
+    data[keyname] = false;
+  });
+  return data;
+}
+
+export interface RefMDEditor extends ContextStore {}
+
+const InternalMDEditor = React.forwardRef<RefMDEditor, MDEditorProps>(
+  (props: MDEditorProps, ref: React.ForwardedRef<RefMDEditor>) => {
+    const {
+      prefixCls = 'w-md-editor',
+      className,
+      value: propsValue,
+      commands = getCommands(),
+      commandsFilter,
+      direction,
+      extraCommands = getExtraCommands(),
+      height = 200,
+      enableScroll = true,
+      visibleDragbar = typeof props.visiableDragbar === 'boolean' ? props.visiableDragbar : true,
+      highlightEnable = true,
+      preview: previewType = 'live',
+      fullscreen = false,
+      overflow = true,
+      previewOptions = {},
+      textareaProps,
+      maxHeight = 1200,
+      minHeight = 100,
+      autoFocus,
+      autoFocusEnd = false,
+      tabSize = 2,
+      defaultTabEnable = false,
+      onChange,
+      onStatistics,
+      onHeightChange,
+      hideToolbar,
+      toolbarBottom = false,
+      components,
+      renderTextarea,
+      ...other
+    } = props || {};
+    const cmds = commands
+      .map((item) => (commandsFilter ? commandsFilter(item, false) : item))
+      .filter(Boolean) as ICommand[];
+    const extraCmds = extraCommands
+      .map((item) => (commandsFilter ? commandsFilter(item, true) : item))
+      .filter(Boolean) as ICommand[];
+    let [state, dispatch] = useReducer(reducer, {
+      markdown: propsValue,
+      preview: previewType,
+      components,
+      height,
+      minHeight,
+      highlightEnable,
+      tabSize,
+      defaultTabEnable,
+      scrollTop: 0,
+      scrollTopPreview: 0,
+      commands: cmds,
+      extraCommands: extraCmds,
+      fullscreen,
+      barPopup: {},
+    });
+    const container = useRef<HTMLDivElement>(null);
+    const previewRef = useRef<HTMLDivElement>(null);
+    const enableScrollRef = useRef(enableScroll);
+
+    useImperativeHandle(ref, () => ({ ...state, container: container.current, dispatch }));
+    useMemo(() => (enableScrollRef.current = enableScroll), [enableScroll]);
+    useEffect(() => {
+      const stateInit: ContextStore = {};
+      if (container.current) {
+        stateInit.container = container.current || undefined;
+      }
+      stateInit.markdown = propsValue || '';
+      stateInit.barPopup = {};
+      if (dispatch) {
+        dispatch({ ...state, ...stateInit });
+      }
+      // eslint-disable-next-line react-hooks/exhaustive-deps
+    }, []);
+
+    const cls = [
+      className,
+      'wmde-markdown-var',
+      direction ? `${prefixCls}-${direction}` : null,
+      prefixCls,
+      state.preview ? `${prefixCls}-show-${state.preview}` : null,
+      state.fullscreen ? `${prefixCls}-fullscreen` : null,
+    ]
+      .filter(Boolean)
+      .join(' ')
+      .trim();
+
+    useMemo(
+      () => propsValue !== state.markdown && dispatch({ markdown: propsValue || '' }),
+      [propsValue, state.markdown],
+    );
+    // eslint-disable-next-line react-hooks/exhaustive-deps
+    useMemo(() => previewType !== state.preview && dispatch({ preview: previewType }), [previewType]);
+    // eslint-disable-next-line react-hooks/exhaustive-deps
+    useMemo(() => tabSize !== state.tabSize && dispatch({ tabSize }), [tabSize]);
+    useMemo(
+      () => highlightEnable !== state.highlightEnable && dispatch({ highlightEnable }),
+      // eslint-disable-next-line react-hooks/exhaustive-deps
+      [highlightEnable],
+    );
+    // eslint-disable-next-line react-hooks/exhaustive-deps
+    useMemo(() => autoFocus !== state.autoFocus && dispatch({ autoFocus: autoFocus }), [autoFocus]);
+    useMemo(() => autoFocusEnd !== state.autoFocusEnd && dispatch({ autoFocusEnd: autoFocusEnd }), [autoFocusEnd]);
+    useMemo(
+      () => fullscreen !== state.fullscreen && dispatch({ fullscreen: fullscreen }),
+      // eslint-disable-next-line react-hooks/exhaustive-deps
+      [fullscreen],
+    );
+    // eslint-disable-next-line react-hooks/exhaustive-deps
+    useMemo(() => height !== state.height && dispatch({ height: height }), [height]);
+    useMemo(
+      () => height !== state.height && onHeightChange && onHeightChange(state.height, height, state),
+      [height, onHeightChange, state],
+    );
+    // eslint-disable-next-line react-hooks/exhaustive-deps
+    useMemo(() => commands !== state.commands && dispatch({ commands: cmds }), [props.commands]);
+    // eslint-disable-next-line react-hooks/exhaustive-deps
+    useMemo(
+      () => extraCommands !== state.extraCommands && dispatch({ extraCommands: extraCmds }),
+      [props.extraCommands],
+    );
+
+    const textareaDomRef = useRef<HTMLDivElement>();
+    const active = useRef<'text' | 'preview'>('preview');
+    const initScroll = useRef(false);
+
+    useMemo(() => {
+      textareaDomRef.current = state.textareaWarp;
+      if (state.textareaWarp) {
+        state.textareaWarp.addEventListener('mouseover', () => {
+          active.current = 'text';
+        });
+        state.textareaWarp.addEventListener('mouseleave', () => {
+          active.current = 'preview';
+        });
+      }
+    }, [state.textareaWarp]);
+
+    const handleScroll = (e: React.UIEvent<HTMLDivElement>, type: 'text' | 'preview') => {
+      if (!enableScrollRef.current) return;
+      const textareaDom = textareaDomRef.current;
+      const previewDom = previewRef.current ? previewRef.current : undefined;
+      if (!initScroll.current) {
+        active.current = type;
+        initScroll.current = true;
+      }
+      if (textareaDom && previewDom) {
+        const scale =
+          (textareaDom.scrollHeight - textareaDom.offsetHeight) / (previewDom.scrollHeight - previewDom.offsetHeight);
+        if (e.target === textareaDom && active.current === 'text') {
+          previewDom.scrollTop = textareaDom.scrollTop / scale;
+        }
+        if (e.target === previewDom && active.current === 'preview') {
+          textareaDom.scrollTop = previewDom.scrollTop * scale;
+        }
+        let scrollTop = 0;
+        if (active.current === 'text') {
+          scrollTop = textareaDom.scrollTop || 0;
+        } else if (active.current === 'preview') {
+          scrollTop = previewDom.scrollTop || 0;
+        }
+        dispatch({ scrollTop });
+      }
+    };
+
+    const previewClassName = `${prefixCls}-preview ${previewOptions.className || ''}`;
+    const handlePreviewScroll = (e: React.UIEvent<HTMLDivElement, UIEvent>) => handleScroll(e, 'preview');
+    let mdPreview = useMemo(
+      () => (
+        <div ref={previewRef} className={previewClassName}>
+          <MarkdownPreview {...previewOptions} onScroll={handlePreviewScroll} source={state.markdown || ''} />
+        </div>
+      ),
+      [previewClassName, previewOptions, state.markdown],
+    );
+    const preview = components?.preview && components?.preview(state.markdown || '', state, dispatch);
+    if (preview && React.isValidElement(preview)) {
+      mdPreview = (
+        <div className={previewClassName} ref={previewRef} onScroll={handlePreviewScroll}>
+          {preview}
+        </div>
+      );
+    }
+
+    const containerStyle = { ...other.style, height: state.height || '100%' };
+    const containerClick = () => dispatch({ barPopup: { ...setGroupPopFalse(state.barPopup) } });
+    const dragBarChange = (newHeight: number) => dispatch({ height: newHeight });
+
+    const changeHandle = (evn: React.ChangeEvent<HTMLTextAreaElement>) => {
+      onChange && onChange(evn.target.value, evn, state);
+      if (textareaProps && textareaProps.onChange) {
+        textareaProps.onChange(evn);
+      }
+      if (state.textarea && state.textarea instanceof HTMLTextAreaElement && onStatistics) {
+        const obj = new TextAreaCommandOrchestrator(state.textarea!);
+        const objState = (obj.getState() || {}) as TextState;
+        onStatistics({
+          ...objState,
+          lineCount: evn.target.value.split('\n').length,
+          length: evn.target.value.length,
+        });
+      }
+    };
+    return (
+      <EditorContext.Provider value={{ ...state, dispatch }}>
+        <div ref={container} className={cls} {...other} onClick={containerClick} style={containerStyle}>
+          <ToolbarVisibility
+            hideToolbar={hideToolbar}
+            toolbarBottom={toolbarBottom}
+            prefixCls={prefixCls}
+            overflow={overflow}
+            placement="top"
+          />
+          <div className={`${prefixCls}-content`}>
+            {/(edit|live)/.test(state.preview || '') && (
+              <TextArea
+                className={`${prefixCls}-input`}
+                prefixCls={prefixCls}
+                autoFocus={autoFocus}
+                {...textareaProps}
+                onChange={changeHandle}
+                renderTextarea={components?.textarea || renderTextarea}
+                onScroll={(e) => handleScroll(e, 'text')}
+              />
+            )}
+            {/(live|preview)/.test(state.preview || '') && mdPreview}
+          </div>
+          {visibleDragbar && !state.fullscreen && (
+            <DragBar
+              prefixCls={prefixCls}
+              height={state.height as number}
+              maxHeight={maxHeight!}
+              minHeight={minHeight!}
+              onChange={dragBarChange}
+            />
+          )}
+          <ToolbarVisibility
+            hideToolbar={hideToolbar}
+            toolbarBottom={toolbarBottom}
+            prefixCls={prefixCls}
+            overflow={overflow}
+            placement="bottom"
+          />
+        </div>
+      </EditorContext.Provider>
+    );
+  },
+);
+
+type EditorComponent = typeof InternalMDEditor & {
+  Markdown: typeof MarkdownPreview;
+};
+
+const Editor = InternalMDEditor as EditorComponent;
+Editor.Markdown = MarkdownPreview;
+Editor.displayName = 'MDEditor';
+
+export default Editor;