Skip to content

Fix flash of content on initialization #717

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Mar 4, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 14 additions & 5 deletions core/src/index.tsx
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import React, { useRef, forwardRef, useImperativeHandle } from 'react';
import React, { useRef, forwardRef, useImperativeHandle, useCallback } from 'react';
import type { EditorState, EditorStateConfig, Extension, StateField } from '@codemirror/state';
import type { EditorView, ViewUpdate } from '@codemirror/view';
import { type BasicSetupOptions } from '@uiw/codemirror-extensions-basic-setup';
Expand Down Expand Up @@ -116,9 +116,8 @@ const ReactCodeMirror = forwardRef<ReactCodeMirrorRef, ReactCodeMirrorProps>((pr
initialState,
...other
} = props;
const editor = useRef<HTMLDivElement>(null);
const { state, view, container } = useCodeMirror({
container: editor.current,
const editor = useRef<HTMLDivElement | null>(null);
const { state, view, container, setContainer } = useCodeMirror({
root,
value,
autoFocus,
Expand Down Expand Up @@ -150,13 +149,23 @@ const ReactCodeMirror = forwardRef<ReactCodeMirrorRef, ReactCodeMirrorProps>((pr
view,
]);

const setEditorRef = useCallback(
(el: HTMLDivElement) => {
editor.current = el;
setContainer(el);
},
[setContainer],
);

// check type of value
if (typeof value !== 'string') {
throw new Error(`value must be typeof string but got ${typeof value}`);
}

const defaultClassNames = typeof theme === 'string' ? `cm-theme-${theme}` : 'cm-theme';
return <div ref={editor} className={`${defaultClassNames}${className ? ` ${className}` : ''}`} {...other}></div>;
return (
<div ref={setEditorRef} className={`${defaultClassNames}${className ? ` ${className}` : ''}`} {...other}></div>
);
});

ReactCodeMirror.displayName = 'CodeMirror';
Expand Down
10 changes: 7 additions & 3 deletions core/src/useCodeMirror.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { useEffect, useState } from 'react';
import { useEffect, useLayoutEffect, useState } from 'react';
import { Annotation, EditorState, StateEffect, type Extension } from '@codemirror/state';
import { EditorView, type ViewUpdate } from '@codemirror/view';
import { getDefaultExtensions } from './getDefaultExtensions';
Expand Down Expand Up @@ -85,7 +85,7 @@ export function useCodeMirror(props: UseCodeMirror) {
}
getExtensions = getExtensions.concat(extensions);

useEffect(() => {
useLayoutEffect(() => {
if (container && !state) {
const config = {
doc: value,
Expand Down Expand Up @@ -114,7 +114,11 @@ export function useCodeMirror(props: UseCodeMirror) {
};
}, [container, state]);

useEffect(() => setContainer(props.container), [props.container]);
useEffect(() => {
if (props.container) {
setContainer(props.container);
}
}, [props.container]);

useEffect(
() => () => {
Expand Down
9 changes: 4 additions & 5 deletions www/src/pages/home/Example.tsx
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { useEffect, useState } from 'react';
import { useState } from 'react';
import MarkdownPreview from '@uiw/react-markdown-preview';
import { color } from '@uiw/codemirror-extensions-color';
import DocumentStr from '@uiw/react-codemirror/README.md';
Expand All @@ -10,6 +10,7 @@ import { langs } from '@uiw/codemirror-extensions-langs';
import { Select } from './Select';
import { Options } from '../extensions/basic-setup/example';
import { useTheme } from '../../utils/useTheme';
import javascriptExample from 'code-example/txt/sample.javascript.txt';

const themeOptions = ['dark', 'light']
.concat(Object.keys(alls))
Expand Down Expand Up @@ -61,7 +62,7 @@ export default function Example() {
const [autofocus, setAutofocus] = useState(false);
const [editable, setEditable] = useState(true);
const { theme, setTheme } = useTheme();
const [code, setCode] = useState('');
const [code, setCode] = useState(javascriptExample);
const [extensions, setExtensions] = useState<Extension[]>();
const [height, setHeight] = useState('500px');
const [basicSetup, setBasicSetup] = useState<BasicSetupOptions>({
Expand Down Expand Up @@ -91,9 +92,7 @@ export default function Example() {
}
} catch (error) {}
}
useEffect(() => {
handleLangChange('javascript');
}, []);

return (
<Warpper className="wmde-markdown-var">
<CodemirrorWarpper>
Expand Down