@uiw/react-codemirror

What is @uiw/react-codemirror?

@uiw/react-codemirror is a React component for CodeMirror, a versatile text editor implemented in JavaScript for the browser. It provides a flexible and customizable code editor with support for various programming languages, themes, and extensions.

What are @uiw/react-codemirror's main functionalities?

Basic Usage

This code demonstrates the basic usage of @uiw/react-codemirror. It imports the necessary modules and sets up a simple CodeMirror editor with JavaScript syntax highlighting.

import React from 'react';
import CodeMirror from '@uiw/react-codemirror';
import { javascript } from '@codemirror/lang-javascript';

const App = () => {
  return (
    <CodeMirror
      value="console.log('Hello, world!');"
      height="200px"
      extensions={[javascript()]}
    />
  );
};

export default App;

Theming

This example shows how to apply a theme to the CodeMirror editor. The 'oneDark' theme is imported and added to the extensions array.

import React from 'react';
import CodeMirror from '@uiw/react-codemirror';
import { javascript } from '@codemirror/lang-javascript';
import { oneDark } from '@codemirror/theme-one-dark';

const App = () => {
  return (
    <CodeMirror
      value="console.log('Hello, world!');"
      height="200px"
      extensions={[javascript(), oneDark]}
    />
  );
};

export default App;

Handling Events

This code demonstrates how to handle change events in the CodeMirror editor. The 'handleChange' function logs the new value to the console whenever the content changes.

import React from 'react';
import CodeMirror from '@uiw/react-codemirror';
import { javascript } from '@codemirror/lang-javascript';

const App = () => {
  const handleChange = (value, viewUpdate) => {
    console.log('Value changed:', value);
  };

  return (
    <CodeMirror
      value="console.log('Hello, world!');"
      height="200px"
      extensions={[javascript()]}
      onChange={handleChange}
    />
  );
};

export default App;

Other packages similar to @uiw/react-codemirror

react-codemirror2

react-codemirror2 is another React wrapper for CodeMirror. It provides similar functionality to @uiw/react-codemirror but with a different API. It supports various CodeMirror features and is widely used in the React community.

react-ace

react-ace is a React component for the Ace editor. While it serves a similar purpose to @uiw/react-codemirror, it uses the Ace editor instead of CodeMirror. It offers a wide range of features and is known for its performance and flexibility.

react-monaco-editor

react-monaco-editor is a React component for the Monaco editor, which powers Visual Studio Code. It provides a highly customizable and feature-rich code editor experience, making it a strong alternative to @uiw/react-codemirror for more advanced use cases.

README

react-codemirror

CodeMirror component for React. demo @uiw-react.github.io/react-codemirror/

Install

npm install @uiw/react-codemirror --save

Usage

import CodeMirror from '@uiw/react-codemirror';
import 'codemirror/keymap/sublime';
import 'codemirror/theme/eclipse.css';

<CodeMirror
  value={code}
  options={{
    keyMap: 'sublime',
    mode: 'jsx',
  }}
/>

License

Licensed under the MIT License.