Code Monkey home page Code Monkey logo

react-ace's Introduction

#React-Ace

npm version

Build Status

A react component for Ace / Brace

##Install

npm install react-ace

##Usage

var React = require('react');
var brace  = require('brace');
var AceEditor  = require('react-ace');

require('brace/mode/java')
require('brace/theme/github')

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

// render a first
React.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 this example :

React-Ace Webpack Example 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
maxLines Maximum number of lines to be displayed
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

Modes and Themes

All modes and themes should be required through brace directly. Browserify will grab these modes / themes 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

react-ace's People

Contributors

securingsincity avatar chentsulin avatar schloerke avatar okjake avatar brokenalarms avatar evansolomon avatar davejacobs avatar maxcnunes avatar nickretallack avatar tannerlyons avatar tomitrescak avatar travisperson avatar zanesterling avatar azazdeaz avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.