• Stars
    star
    1,741
  • Rank 26,005 (Top 0.6 %)
  • Language
    JavaScript
  • Created over 11 years ago
  • Updated over 6 years ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

A lightweight, cross browser library for adding IDE style behaviors to plain text areas

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
});
  • 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
  • tabSize : If softTabs is set to true, the number of spaces used is defined here. If set to false, the CSS property tab-size will be used to define hard tab sizes.
  • 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
  • fence : If you do not want to add behaviors to an entire textarea, you may use a fence. A fence is a string, any set of characters you want to denote where behaviors should be added. The format is Fence, New Line, Code, New Line, Fence.

Methods

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

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.

hookName

The hook you want to add an event for. May be a string or an array of hook names

fn

The function you want to fire on the hook event

The following hook names are available for use:

init:before

Called before initializing Behave

init:after

Called after initializing Behave

<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.

More Repositories

1

Snap.js

A Library for creating beautiful mobile shelfs in Javascript (Facebook and Path style side menus)
JavaScript
5,990
star
2

Medium.js

A tiny JavaScript library for making contenteditable beautiful (Like Medium's editor)
JavaScript
4,388
star
3

himawari.js

Download real-time images of Earth from the Himawari-8 satellite
JavaScript
1,806
star
4

Blur.js

blur.js is a jQuery plugin that produces psuedo-transparent blurred elements over other elements.
JavaScript
926
star
5

Mention.js

Lightweight wrapper for adding @user mention functionality to Twitter Bootstraps Typeahead plugin
JavaScript
751
star
6

off-the-rip

Downloads audio, artwork, and metadata from Soundcloud
JavaScript
455
star
7

Ripple.js

Adds Material style ripple to anything
JavaScript
277
star
8

AppScroll.js

AppScroll is a tiny (< 100 lines) JS library that fixes the "website dragging" issue caused on iDevices
JavaScript
251
star
9

Context.js

Contextual Menus with Twitters Bootstrap.css
JavaScript
249
star
10

Youtube-TV

A small, slick, library independent YouTube User/Playlist player
JavaScript
203
star
11

Sparky.js

Sparky.js is an idea about client-side Javascript organization.
JavaScript
197
star
12

Submodal

Add submodals to Bootstrap 3.x modals
JavaScript
184
star
13

stability-ts

DreamStudio Client written in TypeScript
TypeScript
156
star
14

Bits

Bits Editor is your personal playground to develop in HTML, CSS, and Javascript, all from your own server.
JavaScript
87
star
15

Github-Mobile

GitHub Mobile
79
star
16

Ratchet-Vine

A Ratchet template that attempts to recreat the beautiful Vine app
JavaScript
59
star
17

Shadow

An internal analytics engine used to track meta data and user relations for objects in your application
PHP
55
star
18

Blur.js-II

Javascript library for blurring HTML content with CSS and SVG
JavaScript
50
star
19

Throttle

A PHP function that can be used to throttle any actions you want, as to prevent flooding.
PHP
30
star
20

WebFontGenerator

This is a class to generate CSS3 web fonts with Font Forge and PHP
PHP
25
star
21

iTunes-Colors

Recreates the color-effect used in iTunes
25
star
22

Scenario.js

A lightweight A/B Testing library for use with MixPanel
JavaScript
21
star
23

Slow.js

slow.js is a small script used to slow down CSS transition durations by a predefined factor on a key press event.
JavaScript
21
star
24

Repo-Downloader

A small PHP class to download repo zipballs from GitHub
PHP
20
star
25

Architect.js

A simple scaffold for your client side JavaScript.
JavaScript
17
star
26

Formula.js

Turn hyperlinks into ajax requests, making links as powerful as forms.
JavaScript
14
star
27

Gift.js

A Javascript library for wrapping your websites up as a present
JavaScript
10
star
28

Rap

A wicked simple comment system
JavaScript
8
star
29

ParseObject.js

Simple function to parse a string and compare it against an object.
JavaScript
8
star
30

Hatchet

Hatchet is a mobile client for Y Combinator Hacker News, and was built with Ratchet. Currently, it is tailored for iOS devices.
JavaScript
7
star
31

stfu

Tools and scripts used to broaden my reach online
CSS
5
star
32

Sparky.js-Website

This is the website for Sparky.js
PHP
4
star
33

Brazzed

Add the Brazzers logo to any image for intensity...
PHP
4
star
34

sams-calendar-program

My Grandfathers Calendar Program read from two floppy disks.
Batchfile
3
star
35

stemmy

An experimental Typescript wrapper for demucs
TypeScript
2
star
36

Thought.js

Create a beautiful message for someone you care about.
JavaScript
2
star
37

trill

A multi-resource html5 audio player
1
star
38

Not-Enough-Juans

We need more Juans
JavaScript
1
star