feat: add onUpdate props.

uiwjs · Sep 7, 2021 · 7e48152 · 7e48152
1 parent ea6ac0e
commit 7e48152
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 11 deletions.
diff --git a/src/index.tsx b/src/index.tsx
@@ -9,9 +9,7 @@ export * from "@codemirror/basic-setup";
 export * from "@codemirror/state";
 
 export interface ReactCodeMirrorProps extends Omit<EditorStateConfig, 'doc' | 'extensions'>, Omit<React.HTMLAttributes<HTMLDivElement>, 'onChange'> {
-  /**
-   * value of the auto created model in the editor.
-   */
+  /** value of the auto created model in the editor. */
   value?: string;
   height?: string;
   minHeight?: string;
@@ -22,10 +20,10 @@ export interface ReactCodeMirrorProps extends Omit<EditorStateConfig, 'doc' | 'e
   /** focus on the editor. */
   autoFocus?: boolean;
   theme?: 'light' | 'dark';
-  /**
-   * Fired whenever a change occurs to the document.
-   */
-  onChange?(value: string, viewUpdate: ViewUpdate): void;
+  /** Fired whenever a change occurs to the document. */
+  onChange? (value: string, viewUpdate: ViewUpdate): void;
+  /** Fired whenever a change occurs to the document. There is a certain difference with `onChange`. */
+  onUpdate? (viewUpdate: ViewUpdate): void
   /**
    * Extension values can be [provided](https://codemirror.net/6/docs/ref/#state.EditorStateConfig.extensions) when creating a state to attach various kinds of configuration and behavior information.
    * They can either be built-in extension-providing objects,
@@ -41,14 +39,14 @@ export interface ReactCodeMirrorRef {
   view?: EditorView;
 }
 
-export default React.forwardRef<ReactCodeMirrorRef, ReactCodeMirrorProps>((props, ref) => {
-  const { className, value, selection, extensions = [], onChange, autoFocus, theme, height, minHeight, maxHeight, width, minWidth, maxWidth, ...other } = props;
+const ReactCodeMirror = React.forwardRef<ReactCodeMirrorRef, ReactCodeMirrorProps>((props, ref) => {
+  const { className, value, selection, extensions = [], onChange, onUpdate, autoFocus, theme, height, minHeight, maxHeight, width, minWidth, maxWidth, ...other } = props;
   const editor = useRef<HTMLDivElement>(null);
   const { state, view, container, setContainer } = useCodeMirror({
     container: editor.current,
     value, autoFocus, theme, height, minHeight, maxHeight, width, minWidth, maxWidth,
     selection,
-    onChange,
+    onChange, onUpdate,
     extensions,
   });
   useImperativeHandle(ref, () => ({ editor: container, state, view }));
@@ -67,3 +65,7 @@ export default React.forwardRef<ReactCodeMirrorRef, ReactCodeMirrorProps>((props
     <div ref={editor} className={`cm-theme-${theme} ${className || ''}`} {...other}></div>
   );
 });
+
+ReactCodeMirror.displayName = 'CodeMirror';
+
+export default ReactCodeMirror;
diff --git a/src/useCodeMirror.ts b/src/useCodeMirror.ts
@@ -12,7 +12,7 @@ export interface UseCodeMirror extends ReactCodeMirrorProps {
 }
 
 export function useCodeMirror(props: UseCodeMirror) {
-  const { value, selection, onChange, extensions = [], autoFocus, theme = 'light', height = '', minHeight = '', maxHeight ='', width = '', minWidth = '', maxWidth = '' } = props;
+  const { value, selection, onChange, onUpdate, extensions = [], autoFocus, theme = 'light', height = '', minHeight = '', maxHeight ='', width = '', minWidth = '', maxWidth = '' } = props;
   const [container, setContainer] = useState(props.container);
   const [view, setView] = useState<EditorView>();
   const [state, setState] = useState<EditorState>();
@@ -32,6 +32,9 @@ export function useCodeMirror(props: UseCodeMirror) {
   });
   let getExtensions = [basicSetup, keymap.of([indentWithTab]), updateListener, defaultThemeOption];
   theme === 'light' ? getExtensions.push(defaultLightThemeOption) : getExtensions.push(oneDarkTheme);
+  if (onUpdate && typeof onUpdate === 'function') {
+    getExtensions.push(EditorView.updateListener.of(onUpdate));
+  }
   getExtensions = getExtensions.concat(extensions);
 
   useEffect(() => {