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.
- Supports Partial IE6, IE7+, Firefox 8+, Safari 4+, Chrome X+, Opera 12
- No Dependencies
- Custom Code/Behavior Fencing
- 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,
tabSize: 4,
autoOpen: true,
overwrite: true,
autoStrip: true,
autoIndent: true,
fence: false
});
Methods
editor.destroy();
Hooks
Hooks are fired at different times through Behave. To add your own hooks to extend the functionality of Behave, use the BehaveHooks function.
BehaveHooks.add('keydown', function(data){
// Your Code
});
The add function accepts two parameters, the hook name, and the function.
The following hook names are available for use:
<dt><span>enter:before</span></dt>
<dd><p>Called before inserting the text triggered by the enter key</p></dd>
<dt><span>enter:after</span></dt>
<dd><p>Called after inserting the text triggered by the enter key</p></dd>
<dt><span>delete:before</span></dt>
<dd><p>Called before deleting the text triggered by the delete key</p></dd>
<dt><span>delete:after</span></dt>
<dd><p>Called after deleting the text triggered by the delete key</p></dd>
<dt><span>tab:before</span></dt>
<dd><p>Called before inserting the text triggered by the tab key</p></dd>
<dt><span>tab:after</span></dt>
<dd><p>Called after inserting the text triggered by the tab key</p></dd>
<dt><span>keyup</span></dt>
<dd><p>Called before modifying the text triggered by the keyup event</p></dd>
<dt><span>keydown</span></dt>
<dd><p>Called after modifying the text triggered by the keydown event</p></dd>
Each hook excluding the init hooks accept a single parameter, an object with the following information:
{
caret: {
pos: 5
},
editor: {
element: textarea
levelsDeep: 1,
text: 'foo{}'
},
lines: {
current: 1,
total: 1
}
}
In the Wild
If your website u ses Behave.js, let me know on Twitter @jakiestfu
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.