1 Editable elements

Aloha can be used with the following HTML text elements:

	[ 'a', 'abbr', 'address', 'article', 'aside',
	'b', 'bdo', 'blockquote',  'cite', 'code', 'command',
	'del', 'details', 'dfn', 'div', 'dl', 'em', 'footer',
	'h1', 'h2', 'h3', 'h4', 'h5', 'h6', 'header', 'i',
	'ins', 'menu', 'nav', 'p', 'pre', 'q', 'ruby',
	'section', 'small', 'span', 'strong', 'sub', 'sup',
	'textarea', 'var' ]

Not supported HTML elements:

	[ 'canvas', 'audio', 'br', 'embed', 'fieldset', 'hgroup', 'hr',
	'iframe', 'img', 'input', 'map', 'script', 'select', 'style',
	'svg', 'table', 'ul', 'video', 'ol', 'form', 'noscript' ]

Note if you are using a textarea with Aloha: If the textarea has a HTML ID (eg. mytxtarea) the ID of the Aloha editable will be “-aloha” suffixed (eg. mytxtarea-aloha).

2 Core files

• src/lib/aloha.js
• src/lib/aloha-bootstrap.js
• src/lib/aloha/core.js
• …

3 Initialization Process

When Aloha Editor is loading several steps are completed until the initialization process is finished.

// init process taken from core.js
Aloha.stage = 'loadPlugins';
Aloha.loadPlugins(function(){
	Aloha.stage = 'initAloha';
	Aloha.initAloha(function(){
		Aloha.stage = 'initPlugins';
		Aloha.initPlugins(function(){
			Aloha.stage = 'initGui';
			Aloha.initGui(function(){
				Aloha.stage = 'alohaReady';
				Aloha.trigger('aloha-ready');
			});
		});
	});
});

Aloha Editor will also add a CSS class to the html DOM node during it’s initAloha stage. The following classes will be used:

4 How to use require

5 Internationalization

6 Logging

7 Utilities

8 Events

see: Guides page: Events

9 Editables

10 HotKeys

Add and remove HotKey handler for keyboard events supporting almost any key combination.

The syntax is as follows:

    $(document).bind('keydown', 'ctrl+a', fn);

Example configuration for inserting a Link with the HotKey `Ctrl-u` (default: `Ctrl-l`)

Aloha.settings = {
	plugins: {
		link: {
			hotKey: { insertLink: 'ctrl+u' }
		}
	}
}

1. Types Supported types are `‘keydown’`, `‘keyup’` and `‘keypress’`

1. Addendum Firefox is the most liberal one in the manner of letting you capture all short-cuts even those that are built-in in the browser such as `Ctrl-t` for new tab, or `Ctrl-a` for selecting all text. You can always bubble them up to the browser by returning `true` in your handler.

Others, (IE) either let you handle built-in short-cuts, but will add their functionality after your code has executed. Or (Opera/Safari) will not pass those events to the DOM at all.

So, if you bind `Ctrl-Q` or `Alt-F4` and your Safari/Opera window is closed don’t be surprised.

Code from: https://github.com/jeresig/jquery.hotkeys

Chapters

1. Editable elements

2. Core files

3. Initialization Process

4. How to use require

5. Internationalization

6. Logging

7. Utilities

8. Events

9. Editables

10. HotKeys