@uiw/react-codemirror
v4.25.4TypeScript
CodeMirror component for React.
0/weekUpdated 1 months agoMITUnpacked: 807.1 KB
Published by kenny wong
npm install @uiw/react-codemirror
react-codemirror
CodeMirror component for React. Demo Preview: @uiwjs.github.io/react-codemirror
Features:
🚀 Quickly and easily configure the API.
🌱 Versions after @uiw/react-codemirror@v4 use codemirror 6. #88.
⚛️ Support the features of React Hook(requires React 16.8+).
📚 Use Typescript to write, better code hints.
🌐 The bundled version supports use directly in the browser #267.
🌎 There are better sample previews.
🎨 Support theme customization, provide theme editor.
🧑💻 SwiftUI wrapper for CodeMirror 6.
Install
Not dependent on uiw.
``bash`
npm install @uiw/react-codemirror --save
All Packages
| Name | NPM Version |
| :-------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| @uiw/react-codemirror |   |
| react-codemirror-merge |   |
| @uiw/codemirror-extensions-basic-setup |   |
| @uiw/codemirror-extensions-color |   |
| @uiw/codemirror-extensions-classname |   |
| @uiw/codemirror-extensions-events |   |
| @uiw/codemirror-extensions-hyper-link |   |
| @uiw/codemirror-extensions-langs |   |
| @uiw/codemirror-extensions-line-numbers-relative |   |
| @uiw/codemirror-extensions-mentions |   |
| @uiw/codemirror-extensions-zebra-stripes |   |
| @uiw/codemirror-themes |   |
| Name | NPM Version |
| :----------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| @uiw/codemirror-themes-all |   |
| @uiw/codemirror-theme-abcdef |   |
| @uiw/codemirror-theme-abyss |   |
| @uiw/codemirror-theme-androidstudio |   |
| @uiw/codemirror-theme-andromeda |   |
| @uiw/codemirror-theme-atomone |   |
| @uiw/codemirror-theme-aura |   |
| @uiw/codemirror-theme-basic |   |
| @uiw/codemirror-theme-bbedit |   |
| @uiw/codemirror-theme-bespin |   |
| @uiw/codemirror-theme-console |   |
| @uiw/codemirror-theme-copilot |   |
| @uiw/codemirror-theme-duotone |   |
| @uiw/codemirror-theme-dracula |   |
| @uiw/codemirror-theme-darcula |   |
| @uiw/codemirror-theme-eclipse |   |
| @uiw/codemirror-theme-github |   |
| @uiw/codemirror-theme-gruvbox-dark |   |
| @uiw/codemirror-theme-kimbie |   |
| @uiw/codemirror-theme-kimbie |   |
| @uiw/codemirror-theme-material |   |
| @uiw/codemirror-theme-monokai |   |
| @uiw/codemirror-theme-noctis-lilac |   |
| @uiw/codemirror-theme-nord |   |
| @uiw/codemirror-theme-okaidia |   |
| @uiw/codemirror-theme-quietlight |   |
| @uiw/codemirror-theme-red |   |
| @uiw/codemirror-theme-solarized |   |
| @uiw/codemirror-theme-sublime |   |
| @uiw/codemirror-theme-tokyo-night |   |
| @uiw/codemirror-theme-tokyo-night-storm |   |
| @uiw/codemirror-theme-tokyo-night-day |   |
| @uiw/codemirror-theme-vscode |   |
| @uiw/codemirror-theme-white |   |
| @uiw/codemirror-theme-tomorrow-night-blue |   |
| @uiw/codemirror-theme-xcode |   |
Usage
`jsx
import React from 'react';
import CodeMirror from '@uiw/react-codemirror';
import { javascript } from '@codemirror/lang-javascript';
function App() {
const [value, setValue] = React.useState("console.log('hello world!');");
const onChange = React.useCallback((val, viewUpdate) => {
console.log('val:', val);
setValue(val);
}, []);
return
}
export default App;
`
Support Language
`jsx
import CodeMirror from '@uiw/react-codemirror';
import { StreamLanguage } from '@codemirror/language';
import { go } from '@codemirror/legacy-modes/mode/go';
const goLang = package main
import "fmt"
func main() {
fmt.Println("Hello, 世界")
};
export default function App() {
return
}
`
- ~~@codemirror/legacy-modes/mode/cpp~~ => @codemirror/lang-cpp
- ~~~~ => @codemirror/lang-html
- ~~~~ => @codemirror/lang-java
- ~~~~ => @codemirror/lang-go
- ~~~~ => @codemirror/lang-javascript
- ~~~~ => @codemirror/lang-json
- ~~~~ => @codemirror/lang-lezer
- ~~~~ => @codemirror/lang-markdown
- ~~~~ => @codemirror/lang-php
- ~~~~ => @codemirror/lang-python
- ~~~~ => @codemirror/lang-rust
- ~~~~ => @codemirror/lang-sql
- ~~~~ => @codemirror/lang-xml
- ~~~~ => @codemirror/lang-less
- ~~~~ => @codemirror/lang-sass
- ~~~~ => @nextjournal/lang-clojure
- ~~~~ => @replit/codemirror-lang-csharp
$3
Markdown language code is automatically highlighted.
`jsx
import CodeMirror from '@uiw/react-codemirror';
import { markdown, markdownLanguage } from '@codemirror/lang-markdown';
import { languages } from '@codemirror/language-data';
const code = ## Title
\\\jsx\
function Demo() {
return demo
}
\\
\\\bash\Not dependent on uiw.
npm install @codemirror/lang-markdown --save
npm install @codemirror/language-data --save
\\
\\\go\
package main
import "fmt"
func main() {
fmt.Println("Hello, 世界")
}
\\;
export default function App() {
return
}
`
Codemirror Merge
A component that highlights the changes between two versions of a file in a side-by-side view, highlighting added, modified, or deleted lines of code.
`bash`
npm install react-codemirror-merge --save
`jsx
import CodeMirrorMerge from 'react-codemirror-merge';
import { EditorView } from 'codemirror';
import { EditorState } from '@codemirror/state';
const Original = CodeMirrorMerge.Original;
const Modified = CodeMirrorMerge.Modified;
let doc = one
two
three
four
five;
export const Example = () => {
return (
extensions={[EditorView.editable.of(false), EditorState.readOnly.of(true)]}
/>
);
};
`
Support Hook
`jsx
import { useEffect, useMemo, useRef } from 'react';
import { useCodeMirror } from '@uiw/react-codemirror';
import { javascript } from '@codemirror/lang-javascript';
const code = "console.log('hello world!');\n\n\n";
// Define the extensions outside the component for the best performance.
// If you need dynamic extensions, use React.useMemo to minimize reference changes
// which cause costly re-renders.
const extensions = [javascript()];
export default function App() {
const editor = useRef();
const { setContainer } = useCodeMirror({
container: editor.current,
extensions,
value: code,
});
useEffect(() => {
if (editor.current) {
setContainer(editor.current);
}
}, [editor.current]);
return
;}
`
Using Theme
where you can define your own theme. We have also defined some themes ourselves, which can be installed and used directly. Below is a usage example:`jsx
import CodeMirror from '@uiw/react-codemirror';
import { javascript } from '@codemirror/lang-javascript';
import { okaidia } from '@uiw/codemirror-theme-okaidia';const extensions = [javascript({ jsx: true })];
export default function App() {
return
}
`Using custom theme
jsx
import CodeMirror from '@uiw/react-codemirror';
import { createTheme } from '@uiw/codemirror-themes';
import { javascript } from '@codemirror/lang-javascript';
import { tags as t } from '@lezer/highlight';const myTheme = createTheme({
theme: 'light',
settings: {
background: '#ffffff',
backgroundImage: '',
foreground: '#75baff',
caret: '#5d00ff',
selection: '#036dd626',
selectionMatch: '#036dd626',
lineHighlight: '#8a91991a',
gutterBackground: '#fff',
gutterForeground: '#8a919966',
},
styles: [
{ tag: t.comment, color: '#787b8099' },
{ tag: t.variableName, color: '#0080ff' },
{ tag: [t.string, t.special(t.brace)], color: '#5c6166' },
{ tag: t.number, color: '#5c6166' },
{ tag: t.bool, color: '#5c6166' },
{ tag: t.null, color: '#5c6166' },
{ tag: t.keyword, color: '#5c6166' },
{ tag: t.operator, color: '#5c6166' },
{ tag: t.className, color: '#5c6166' },
{ tag: t.definition(t.typeName), color: '#5c6166' },
{ tag: t.typeName, color: '#5c6166' },
{ tag: t.angleBracket, color: '#5c6166' },
{ tag: t.tagName, color: '#5c6166' },
{ tag: t.attributeName, color: '#5c6166' },
],
});
const extensions = [javascript({ jsx: true })];
export default function App() {
const onChange = React.useCallback((value, viewUpdate) => {
console.log('value:', value);
}, []);
return (
height="200px"
theme={myTheme}
extensions={extensions}
onChange={onChange}
/>
);
}
`Use
to restore state from JSON-serialized representationCodeMirror allows to serialize editor state to JSON representation with toJSON function for persistency or other needs. This JSON representation can be later used to recreate ReactCodeMirror component with the same internal state.
For example, this is how undo history can be saved in the local storage, so that it remains after the page reloads
`jsx
import CodeMirror from '@uiw/react-codemirror';
import { historyField } from '@codemirror/commands';// When custom fields should be serialized, you can pass them in as an object mapping property names to fields.
// See toJSON documentation for more details
const stateFields = { history: historyField };
export function EditorWithInitialState() {
const serializedState = localStorage.getItem('myEditorState');
const value = localStorage.getItem('myValue') || '';
return (
initialState={
serializedState
? {
json: JSON.parse(serializedState || ''),
fields: stateFields,
}
: undefined
}
onChange={(value, viewUpdate) => {
localStorage.setItem('myValue', value);
const state = viewUpdate.state.toJSON(stateFields);
localStorage.setItem('myEditorState', JSON.stringify(state));
}}
/>
);
}
`Props
-
value of the auto created model in the editor.
- width?: string width of editor. Defaults to auto.
- height?: string height of editor. Defaults to auto.
- theme?: 'light' / 'dark' / Extension Defaults to 'light'.`ts
import React from 'react';
import { EditorState, EditorStateConfig, Extension } from '@codemirror/state';
import { EditorView, ViewUpdate } from '@codemirror/view';
export * from '@codemirror/view';
export * from '@codemirror/basic-setup';
export * from '@codemirror/state';
export declare const ExternalChange: import('@codemirror/state').AnnotationType;
export interface UseCodeMirror extends ReactCodeMirrorProps {
container?: HTMLDivElement | null;
}
export declare function useCodeMirror(props: UseCodeMirror): {
state: EditorState | undefined;
setState: import('react').Dispatch>;
view: EditorView | undefined;
setView: import('react').Dispatch>;
container: HTMLDivElement | null | undefined;
setContainer: import('react').Dispatch>;
};
export interface ReactCodeMirrorProps
extends Omit,
Omit, 'onChange' | 'placeholder'> {
/* value of the auto created model in the editor. /
value?: string;
height?: string;
minHeight?: string;
maxHeight?: string;
width?: string;
minWidth?: string;
maxWidth?: string;
/* focus on the editor. /
autoFocus?: boolean;
/* Enables a placeholder—a piece of example content to show when the editor is empty. /
placeholder?: string | HTMLElement;
/**
* light / dark / Extension Defaults to light.
* @default light
*/
theme?: 'light' | 'dark' | Extension;
/**
* Whether to optional basicSetup by default
* @default true
*/
basicSetup?: boolean | BasicSetupOptions;
/**
* This disables editing of the editor content by the user.
* @default true
*/
editable?: boolean;
/**
* This disables editing of the editor content by the user.
* @default false
*/
readOnly?: boolean;
/**
* Controls whether pressing the Tab key inserts a tab character and indents the text (true)
* or behaves according to the browser's default behavior (false).
* @default true
*/
indentWithTab?: boolean;
/* Fired whenever a change occurs to the document. /
onChange?(value: string, viewUpdate: ViewUpdate): void;
/* Some data on the statistics editor. /
onStatistics?(data: Statistics): void;
/* The first time the editor executes the event. /
onCreateEditor?(view: EditorView, state: EditorState): void;
/* Fired whenever any state change occurs within the editor, including non-document changes like lint results. /
onUpdate?(viewUpdate: ViewUpdate): void;
/**
* Extension values can be provided when creating a state to attach various kinds of configuration and behavior information.
* They can either be built-in extension-providing objects,
* such as state fields or facet providers,
* or objects with an extension in its extension property. Extensions can be nested in arrays arbitrarily deep—they will be flattened when processed.
*/
extensions?: Extension[];
/**
* If the view is going to be mounted in a shadow root or document other than the one held by the global variable document (the default), you should pass it here.
* Originally from the config of EditorView
*/
root?: ShadowRoot | Document;
/**
* Create a state from its JSON representation serialized with toJSON function
*/
initialState?: {
json: any;
fields?: Record<'string', StateField>;
};
}
export interface ReactCodeMirrorRef {
editor?: HTMLDivElement | null;
state?: EditorState;
view?: EditorView;
}
declare const ReactCodeMirror: React.ForwardRefExoticComponent<
ReactCodeMirrorProps & React.RefAttributes
>;
export default ReactCodeMirror;
export interface BasicSetupOptions {
lineNumbers?: boolean;
highlightActiveLineGutter?: boolean;
highlightSpecialChars?: boolean;
history?: boolean;
foldGutter?: boolean;
drawSelection?: boolean;
dropCursor?: boolean;
allowMultipleSelections?: boolean;
indentOnInput?: boolean;
syntaxHighlighting?: boolean;
bracketMatching?: boolean;
closeBrackets?: boolean;
autocompletion?: boolean;
rectangularSelection?: boolean;
crosshairCursor?: boolean;
highlightActiveLine?: boolean;
highlightSelectionMatches?: boolean;
closeBracketsKeymap?: boolean;
defaultKeymap?: boolean;
searchKeymap?: boolean;
historyKeymap?: boolean;
foldKeymap?: boolean;
completionKeymap?: boolean;
lintKeymap?: boolean;
}
`ts
import { EditorSelection, SelectionRange } from '@codemirror/state';
import { ViewUpdate } from '@codemirror/view';
export interface Statistics {
/* Get the number of lines in the editor. /
lineCount: number;
/* total length of the document /
length: number;
/* Get the proper line-break string for this state. /
lineBreak: string;
/* Returns true when the editor is configured to be read-only. /
readOnly: boolean;
/* The size (in columns) of a tab in the document, determined by the tabSize facet. /
tabSize: number;
/* Cursor Position /
selection: EditorSelection;
/* Make sure the selection only has one range. /
selectionAsSingle: SelectionRange;
/* Retrieves a list of all current selections. /
ranges: readonly SelectionRange[];
/* Get the currently selected code. /
selectionCode: string;
/**
* The length of the given array should be the same as the number of active selections.
* Replaces the content of the selections with the strings in the array.
*/
selections: string[];
/* Return true if any text is selected. /
selectedText: boolean;
}
export declare const getStatistics: (view: ViewUpdate) => Statistics;
`Development
1. Install dependencies
bash
$ npm install # Installation dependencies
$ npm run build # Compile all package
`2. Development
package:`bash
$ cd core
listen to the component compile and output the .js file
listen for compilation output type .d.ts file
$ npm run watch # Monitor the compiled package @uiw/react-codemirror
3. Launch documentation site
bash
npm run start
``Related
- @uiw/react-textarea-code-editor: A simple code editor with syntax highlighting.
- @uiw/react-md-editor: A simple markdown editor with preview, implemented with React.js and TypeScript.
- @uiw/react-monacoeditor: Monaco Editor component for React.
- @uiw/react-markdown-editor: A markdown editor with preview, implemented with React.js and TypeScript.
- @uiw/react-markdown-preview: React component preview markdown text in web browser.
- Online JSON Viewer Online JSON Viewer, JSON Beautifier to beautify and tree view of JSON data - It works as JSON Pretty Print to pretty print JSON data.
Contributors
As always, thanks to our amazing contributors!
Made with contributors.
License
Licensed under the MIT License.