Caret/js/ui
2015-04-11 19:11:42 -07:00
..
cli.js Fixes #292 2014-08-30 23:56:33 -07:00
contextMenus.js Fix a bug in context menus. 2014-07-11 20:33:49 -07:00
dialog.js Focus default dialog if you click away from it. 2014-05-12 21:17:55 -07:00
keys.js Match menus to keys under new system 2015-03-17 15:52:36 -07:00
menus.js Match menus to keys under new system 2015-03-17 15:52:36 -07:00
palette.js Localize some leftover palette messages. 2014-07-20 09:53:21 -07:00
projectManager.js Fix project restoration (where possible) 2014-09-12 07:42:35 -07:00
readme.rst Switch to reStructuredText for documentation. 2014-09-05 08:41:16 -07:00
statusbar.js Code cleanup and commenting. 2014-02-26 22:34:02 -08:00
theme.js Prefix comma-separated styles with .ace-caret 2015-04-11 19:11:42 -07:00

Module description - ui/\*
==========================

cli.js
------

Creates the UI and bindings for a "command line" that can run Caret
commands directly. Useful when testing a new command, since you don't
need to change keys.json or menu.json in order to run it.

contextMenus.js
---------------

Simplifies the process of adding Chrome context menus to page links,
including adding a basic REST-style router for getting parameters out of
the link URL. Exposes a ``register`` method for setting up the actual
menu and its callback, and a ``makeURL`` method to help with making
route URLs that correctly start with the app's extension ID.

dialog.js
---------

Exposes a function that will pop up a dialog box, since Chrome apps are
not allowed to use ``alert()``, ``confirm()``, or ``prompt()``.
Reasonably customizable.

keys.js
-------

Reads the local keyboard settings and registers on the document body to
convert them into commands. Also handles unbinding any Ace commands that
would otherwise collide. Exposes no external methods or data.

menus.js
--------

Generates the menu bar from the local menu settings file. Exposes no
external methods or data at this time.

palette.js
----------

Sets up the command palette and returns it as a singleton for any other
modules that might want to trigger it or alter its data, although it is
recommended that other modules simply send ``palette:*`` commands
instead.

projectManager.js
-----------------

Tracks any current project settings, files, and navigable directories.
Exposes the manager object to dependent modules, primarily so that the
palette can get the list of files for Go To File.

statusbar.js
------------

Sets the status text, and returns an interface with ``setMessage()``,
``clearMessage()``, and ``toast()`` methods. It's recommended to use the
``status:*`` commands instead of requiring this module directly.