react-ace

What is react-ace?

The react-ace package is a React component for the Ace editor, which is a powerful code editor written in JavaScript. It allows you to embed the Ace editor into your React applications, providing a rich set of features for code editing, syntax highlighting, and more.

What are react-ace's main functionalities?

Basic Usage

This code demonstrates the basic usage of the react-ace package. It imports the necessary modules and sets up an Ace editor with JavaScript mode and the GitHub theme.

import React from 'react';
import AceEditor from 'react-ace';
import 'ace-builds/src-noconflict/mode-javascript';
import 'ace-builds/src-noconflict/theme-github';

function MyEditor() {
  return (
    <AceEditor
      mode="javascript"
      theme="github"
      name="editor"
      editorProps={{ $blockScrolling: true }}
    />
  );
}

export default MyEditor;

Customizing Editor Options

This code sample shows how to customize various options of the Ace editor, such as font size, print margin, gutter, active line highlighting, and enabling autocompletion and snippets.

import React from 'react';
import AceEditor from 'react-ace';
import 'ace-builds/src-noconflict/mode-javascript';
import 'ace-builds/src-noconflict/theme-github';

function MyEditor() {
  return (
    <AceEditor
      mode="javascript"
      theme="github"
      name="editor"
      fontSize={14}
      showPrintMargin={true}
      showGutter={true}
      highlightActiveLine={true}
      setOptions={{
        enableBasicAutocompletion: true,
        enableLiveAutocompletion: true,
        enableSnippets: true,
        showLineNumbers: true,
        tabSize: 2,
      }}
    />
  );
}

export default MyEditor;

Handling Editor Events

This example demonstrates how to handle events in the Ace editor. The onChange event is used to log the new value of the editor whenever it changes.

import React from 'react';
import AceEditor from 'react-ace';
import 'ace-builds/src-noconflict/mode-javascript';
import 'ace-builds/src-noconflict/theme-github';

function MyEditor() {
  const onChange = (newValue) => {
    console.log('change', newValue);
  };

  return (
    <AceEditor
      mode="javascript"
      theme="github"
      name="editor"
      onChange={onChange}
    />
  );
}

export default MyEditor;

Other packages similar to react-ace

react-codemirror2

The react-codemirror2 package is a React component for the CodeMirror editor. It provides similar functionalities to react-ace, such as syntax highlighting, code folding, and customizable themes. However, CodeMirror is known for its flexibility and extensive list of supported languages and modes.

react-monaco-editor

The react-monaco-editor package is a React component for the Monaco editor, which is the code editor that powers Visual Studio Code. It offers advanced features like IntelliSense, parameter hints, and a rich API for extensions. Compared to react-ace, react-monaco-editor provides a more feature-rich and modern editing experience.

react-simple-code-editor

The react-simple-code-editor package is a lightweight code editor component for React. It is built on top of the Prism syntax highlighter and is designed to be simple and easy to use. While it lacks some of the advanced features of react-ace, it is a good choice for basic code editing needs.

README

React-Ace

A react component for Ace / Brace

Install

npm install react-ace

Usage

import React from 'react';
import { render } from 'react-dom';
import brace from 'brace';
import AceEditor from 'react-ace';

import 'brace/mode/java';
import 'brace/theme/github';

function onChange(newValue) {
  console.log('change',newValue);
}

// Render editor
render(
  <AceEditor
    mode="java"
    theme="github"
    onChange={onChange}
    name="UNIQUE_ID_OF_DIV"
    editorProps={{$blockScrolling: true}}
  />,
  document.getElementById('example')
);

Looking for a way to set it up using webpack? Checkout example directory for a working example using webpack.

Available Props

Prop	Description
name	Unique Id to be used for the editor
mode	Language for parsing and code highlighting
theme	theme to use
height	CSS value for height
width	CSS value for width
className	custom className
fontSize	pixel value for font-size
showGutter	boolean
showPrintMargin	boolean
highlightActiveLine	boolean
readOnly	boolean
minLines	Minimum number of lines to be displayed
maxLines	Maximum number of lines to be displayed
enableBasicAutocompletion	Enable basic autocompletion
enableSnippets	Enable snippets
enableLiveAutocompletion	Enable live autocompletion
tabSize	tabSize number
value	String value you want to populate in the code highlighter
onLoad	Function onLoad
onBeforeLoad	function that trigger before editor setup
onChange	function that occurs on document change it has 1 argument value. see the example above
onCopy	function that trigger by editor copy event, and pass text as argument
onPaste	function that trigger by editor paste event, and pass text as argument
onFocus	function that trigger by editor focus event
onBlur	function that trigger by editor blur event
editorProps	Object of properties to apply directly to the Ace editor instance
setOptions	Object of options to apply directly to the Ace editor instance
keyboardHandler	String corresponding to the keybinding mode to set (such as vim)
commands	Array of new commands to add to the editor
annotations	Array of annotations to show in the editor i.e. [{ row: 0, column: 2, type: 'error', text: 'Some error.'}], displayed in the gutter
markers	Array of markers to show in the editor, i.e. [{ startRow: 0, startCol: 2, endRow: 1, endCol: 20, className: 'error-marker', type: 'background' }]

Modes, Themes, and Keyboard Handlers

All modes, themes, and keyboard handlers should be required through brace directly. Browserify will grab these modes / themes / keyboard handlers through brace and will be available at run time. See the example above. This prevents bloating the compiled javascript with extra modes and themes for your application.

Example Modes

• javascript
• java
• python
• xml
• ruby
• sass
• markdown
• mysql
• json
• html
• handlebars
• golang
• csharp
• coffee
• css

Example Themes

• monokai
• github
• tomorrow
• kuroir
• twilight
• xcode
• textmate
• solarized dark
• solarized light
• terminal

Example Keyboard Handlers

• vim
• emacs