Git Product home page Git Product logo

behave.js's Introduction

What?

Behave.js is a lightweight library for adding IDE style behaviors to plain text areas, making it much more enjoyable to write code in.

  • Hard and Soft Tabs
  • Auto Open/Close Paranthesis, Brackets, Braces, Double and Single Quotes
  • Auto delete a paired character
  • Overwrite a paired character
  • Multi-line Indentation/Unindentation
  • Automatic Indentation

Usage

var editor = new Behave({
    textarea: document.getElementById('myTextarea')
});

Defaults and Options

var editor = new Behave({
    textarea: null,
    replaceTab: true,
    softTabs: true,
    softTabSize: 4,
    autoOpen: true,
    overwrite: true,
    autoStrip: true,
    autoIndent: true
});
  • textarea : Textarea element to apply the behaviors to
  • replaceTab : If set to true, replaceTab does three different things:

    • Pressing the tab key will insert a tab instead of cycle input focus.
    • If you are holding shift, and there is a full tab before your cursor (whatever your tab may be), it will unindent.
    • If you have a range selected, both of the above rules will apply to all lines selected (multi-line indent/unindent)
  • softTabs : If set to true, spaces will be used instead of a tab character
  • softTabSize : If softTabs is set to true, the number of spaces used is defined here
  • autoOpen : If any of the following characters are typed, their counterparts are automatically added:
    • ( adds )
    • { adds }
    • [ adds ]
    • " adds "
    • ' adds '
  • overwrite : If you type a closing character directly before an identical character, it will overwrite it instead of adding it. Best used with autoOpen set to true
  • autoStrip : If set to true, and your cursor is between two paired characters, pressing backspace will delete both instead of just the first
  • autoIndent : If set to true, automatic indentation of your code will be attempted. Best used with autoOpen set to true

Methods

editor.destroy();
  • destroy : Removes all event listeners from your textarea

ToDo

  • Add support for IE
  • Add multi-line indentation

License

MIT Licensing

Copyright (c) 2013 Jacob Kelley

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

behave.js's People

Contributors

jakiestfu avatar paulmillr avatar

Watchers

 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.