react-codemirror2 vs react-codemirror
Code Editor Components for React Comparison
1 Year
react-codemirror2react-codemirrorSimilar Packages:
What's Code Editor Components for React?

Code editor components for React are libraries that provide a rich text editing experience with features like syntax highlighting, code completion, and customizable themes. These components are built on top of existing text editor technologies and are designed to integrate seamlessly into React applications, allowing developers to create interactive and user-friendly coding environments within their web apps. They are commonly used in applications like online coding platforms, IDEs, and documentation tools. react-codemirror is a React wrapper for the CodeMirror 5 editor, offering a simple API for integrating the popular code editor into React applications. It supports syntax highlighting, themes, and customizable key bindings, making it a versatile choice for adding code editing functionality. react-codemirror2 is a fork of react-codemirror that provides a more React-friendly API and better support for functional components. It offers similar features as react-codemirror but with improved performance and a focus on leveraging React's capabilities, making it a great choice for modern React applications. Meanwhile, react-codemirror is the original library, which may lack updates or optimizations for recent React features.

NPM Package Downloads Trend
Github Stars Ranking
Stat Detail
Package
Downloads
Stars
Size
Issues
Publish
License
react-codemirror267,6581,66771.2 kB909 months agoMIT
react-codemirror39,6551,559-688 years agoMIT
Feature Comparison: react-codemirror2 vs react-codemirror

React Integration

  • react-codemirror2:

    react-codemirror2 is designed with React in mind, offering a more idiomatic API that works well with functional components and hooks. This makes it a better choice for modern React applications that prioritize functional programming.

  • react-codemirror:

    react-codemirror provides a simple wrapper around CodeMirror 5, allowing for easy integration into React applications. However, it may not fully leverage React's capabilities, especially in functional components.

Customization

  • react-codemirror2:

    react-codemirror2 offers similar customization capabilities but with a more flexible API that makes it easier to implement both basic and advanced customizations. It also supports controlled components, allowing for better integration with React's state management.

  • react-codemirror:

    react-codemirror allows for basic customization of the CodeMirror editor, including themes, key bindings, and modes. However, it may require more effort to implement advanced customizations.

Performance

  • react-codemirror2:

    react-codemirror2 is optimized for performance, especially in functional components. It minimizes unnecessary re-renders and provides better handling of large files, making it a more efficient choice for performance-sensitive applications.

  • react-codemirror:

    react-codemirror is performant for most use cases, but it may not be optimized for large files or complex editing scenarios, as it does not fully utilize React's rendering optimizations.

Documentation and Community

  • react-codemirror2:

    react-codemirror2 has a growing community and is actively maintained, with a focus on improving the library based on user feedback. Its modern approach and React-centric design make it a popular choice among developers.

  • react-codemirror:

    react-codemirror has good documentation and a supportive community, but it is not as actively maintained as some other projects, which may limit its long-term viability.

Ease of Use: Code Examples

  • react-codemirror2:

    Basic usage of react-codemirror2

    import React from 'react';
    import { Controlled as CodeMirror } from 'react-codemirror2';
    import 'codemirror/lib/codemirror.css';
    import 'codemirror/theme/monokai.css';
    import 'codemirror/mode/python/python';
    
    const MyEditor = () => {
      const [code, setCode] = React.useState('print("Hello, World!")');
    
      return (
        <CodeMirror
          value={code}
          options={{
            mode: 'python',
            theme: 'monokai',
            lineNumbers: true,
          }}
          onBeforeChange={(editor, data, value) => {
            setCode(value);
          }}
        />
      );
    };
    
    export default MyEditor;
    
  • react-codemirror:

    Basic usage of react-codemirror

    import React from 'react';
    import { Controlled as CodeMirror } from 'react-codemirror2';
    import 'codemirror/lib/codemirror.css';
    import 'codemirror/theme/material.css';
    import 'codemirror/mode/javascript/javascript';
    
    const MyEditor = () => {
      const [code, setCode] = React.useState('// Your code here...');
    
      return (
        <CodeMirror
          value={code}
          options={{
            mode: 'javascript',
            theme: 'material',
            lineNumbers: true,
          }}
          onBeforeChange={(editor, data, value) => {
            setCode(value);
          }}
        />
      );
    };
    
    export default MyEditor;
    
How to Choose: react-codemirror2 vs react-codemirror
  • react-codemirror2:

    Choose react-codemirror2 if you are looking for a more React-centric implementation with better support for functional components, hooks, and a more modern API. It is ideal for projects that leverage React's features and require a more flexible and performant code editor.

  • react-codemirror:

    Choose react-codemirror if you need a straightforward integration of CodeMirror 5 into your React app with basic features and good documentation. It is suitable for projects that require a simple code editor without extensive customization.

README for react-codemirror2

Coverage Downloads NPM Version

react-codemirror2

demo @ scniro.github.io/react-codemirror2

Install

npm install react-codemirror2 codemirror --save

react-codemirror2 ships with the notion of an uncontrolled and controlled component. UnControlled consists of a simple wrapper largely powered by the inner workings of codemirror itself, while Controlled will demand state management from the user, preventing codemirror changes unless properly handled via value. The latter will offer more control and likely be more appropriate with redux heavy apps.

uncontrolled usage

import {UnControlled as CodeMirror} from 'react-codemirror2'

<CodeMirror
  value='<h1>I ♥ react-codemirror2</h1>'
  options={{
    mode: 'xml',
    theme: 'material',
    lineNumbers: true
  }}
  onChange={(editor, data, value) => {
  }}
/>

controlled usage

import {Controlled as CodeMirror} from 'react-codemirror2'

<CodeMirror
  value={this.state.value}
  options={options}
  onBeforeChange={(editor, data, value) => {
    this.setState({value});
  }}
  onChange={(editor, data, value) => {
  }}
/>

requiring codemirror resources

codemirror comes as a peer dependency, meaning you'll need to require it in your project in addition to react-codemirror2. This prevents any versioning conflicts that would arise if codemirror came as a dependency through this wrapper. It's been observed that version mismatches can cause difficult to trace issues such as syntax highlighting disappearing without any explicit errors/warnings

  • additional

Since codemirror ships mostly unconfigured, the user is left with the responsibility for requiring any additional resources should they be necessary. This is often the case when specifying certain language modes and themes. How to import/require these assets will vary according to the specifics of your development environment. Below is a sample to include the assets necessary to specify a mode of xml (HTML) and a material theme.

note that the base codemirror.css file is required in all use cases

@import 'codemirror/lib/codemirror.css';
@import 'codemirror/theme/material.css';
import CodeMirror from 'react-codemirror2';
require('codemirror/mode/xml/xml');
require('codemirror/mode/javascript/javascript');

props

| prop | type default | components | description | |--------------|------------------------|-----------------------------------|-----------------------------------------------------------------------------------------------------------------------| | autoCursor | boolean true | Controlled UnControlled | should component cursor position correct when value changed | | | autoScroll | boolean true | Controlled UnControlled | should component scroll cursor position into view when value changed | | className | string | Controlled UnControlled | pass through class class="react-codemirror2 className" | | defineMode | object | Controlled UnControlled | pass a custom mode via {name: 'custom', fn: myModeFn} | | detach | boolean | UnControlled | should component ignore new props | | options | object | Controlled UnControlled | codemirror configuration | | value | string | *Controlled UnControlled | * component value must be managed for controlled components |

props cont. (wrapped codemirror programming api)

will programmatically set cursor to the position specified

<CodeMirror
  [...]
  cursor={{
    line: 5,
    ch: 10
  }}
  onCursor={(editor, data) => {}}
/>

will programmatically scroll to the specified coordinate

<CodeMirror
  [...]
  scroll={{
    x: 50,
    y: 50
  }}
  onScroll={(editor, data) => {}}
/>
  • selection={{ranges: array<{anchor, head}>, focus?: boolean} - setSelections

will programmatically select the ranges specified

<CodeMirror
  [...]
  selection={{
    ranges: [{
      anchor: {ch: 8, line: 5},
      head: {ch: 37, line: 5}
    }],
    focus: true // defaults false if not specified
  }}
  onSelection={(editor, data) => {}}
/>

events

| event | components | description | |------------------------------------------------------------------|----------------------------------|-------------------------------------------------------------------------------------------------------------| | editorDidAttach(editor) | UnControlled | component is now responding to new props | | editorDidConfigure(editor) | Controlled UnControlled | component configuration has been set | | editorDidDetach(editor) | UnControlled | component is now ignoring new props | | editorDidMount(editor, [next]) | Controlled UnControlled | * invoking optional next will trigger editorDidConfigure | | editorWillUnmount(editor) | Controlled UnControlled | invoked before componentWillUnmount | | onBeforeChange(editor, data, value, [next]) | Controlled UnControlled | * if used, next is returned via UnControlled and must be invoked to trigger onChange | | onChange(editor, data, value) | Controlled UnControlled | the component value has been changed |

events cont. wrapped codemirror events

FAQ

  • Is server side rendering supported?

Yes. react-codemirror2 will prevent rendering in absence of navigator. You can also force the component to not render via a PREVENT_CODEMIRROR_RENDER global.

  • How can I get the instance?

The recommended technique to get the instance is to persist the editor returned via event callbacks. There is no static method to get it on demand, e.g. CodeMirror.getInstance(). Example...

constructor() {
  this.instance = null;
}

render() {
  <CodeMirror editorDidMount={editor => { this.instance = editor }}/>
}
  • How can I have a resizable editor?

Check out bokuweb/re-resizable. Wrapping your component with <Resizable/>'s works well

Contributing

Pull Requests are welcome. Be mindful of the available scripts below to help submitting a well-received contribution.

  • npm run start to run the app on localhost:8000
  • npm run test to ensure tests continue to pass
  • npm run build to generate the demo bundle

note that it's necessary to bump the package.json version prior to final npm run build so we can grab the proposed new version as seen in the demo header. Also note, the core changes are to be made in src/index.tsx as ./index.js and ./index.d.ts are generated

MIT © 2020 scniro