2.0.0 • Published 8 months ago

react-ace-cdn v2.0.0

Weekly downloads
122
License
MIT
Repository
github
Last release
8 months ago

react-ace-cdn

A react component for Ace that loads the Ace files from https://cdnjs.cloudflare.com/ajax/libs/ace/1.2.5/ on demand.

Install

npm install react-ace-cdn

Usage

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

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')
);

Available Props

PropDefaultDescription
name'ace-editor'Unique Id to be used for the editor
mode''Language for parsing and code highlighting
theme''theme to use
height'500px'CSS value for height
width'500px'CSS value for width
classNamecustom className
fontSize12pixel value for font-size
showGuttertrueboolean
showPrintMargintrueboolean
highlightActiveLinetrueboolean
focusfalseboolean
cursorStart1number
wrapEnabledfalseWrapping lines
readOnlyfalseboolean
minLinesMinimum number of lines to be displayed
maxLinesMaximum number of lines to be displayed
enableBasicAutocompletionfalseEnable basic autocompletion
enableLiveAutocompletionfalseEnable live autocompletion
tabSize4tabSize number
value''String value you want to populate in the code highlighter
defaultValue''Default value of the editor
onLoadFunction onLoad
onBeforeLoadfunction that trigger before editor setup
onChangefunction that occurs on document change it has 1 argument value. see the example above
onCopyfunction that trigger by editor copy event, and pass text as argument
onPastefunction that trigger by editor paste event, and pass text as argument
onFocusfunction that trigger by editor focus event
onBlurfunction that trigger by editor blur event
onScrollfunction that trigger by editor scroll event
editorPropsObject of properties to apply directly to the Ace editor instance
setOptionsObject of options to apply directly to the Ace editor instance
keyboardHandlerString corresponding to the keybinding mode to set (such as vim)
commandsArray of new commands to add to the editor
annotationsArray of annotations to show in the editor i.e. [{ row: 0, column: 2, type: 'error', text: 'Some error.'}], displayed in the gutter
markersArray 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 will be requested from CDN on-demand. 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
2.0.0

8 months ago

1.0.4

3 years ago

1.0.3

7 years ago

1.0.2

7 years ago

1.0.1

7 years ago

1.0.0

7 years ago