jwymanm / jquery-console Goto Github PK

INTRODUCTION

See demo.html. Or here: http://chrisdone.com/jquery-console/

Options available:

 autofocus              bool      Autofocus the terminal, rather than
                                  having to click on it.

 promptHistory          bool      Provide history support (kind of crappy,
                                  needs doing properly.)

 historyPreserveColumn  bool      Preserve the column you were one when
                                  switching between history.

 welcomeMessage         string    Just a first message to display on the
                                  terminal.

 promptLabel            string    Prompt string like 'JavaScript> '.

 cols                   integer   the number of cols, this value is only
                                  used by the command completion to format
                                  the list of results.

 commandValidate        function  When user hits return, validate
                                  whether to trigger commandHandle and
                                  re-prompt.

 commandHandle          function  Handle the command line, return a
                                  string, boolean, or list
                                  of {msg:"foo",className:"my-css-class"}.
                                  commandHandle(line,report) is
                                  called. Report function is for you
                                  to report a result of the command
                                  asynchronously.

 commandComplete        function  Handle the command completion when the
                                  tab key is pressed. It returns a list
                                  of string completion suffixes.

 animateScroll          bool      Whether to animate the scroll to
                                  top. Currently disabled.

 charInsertTrigger      function  Predicate for whether to allow
                                  character insertion.
                                  charInsertTrigger(char,line) is called.

 cancelHandle           function  Handle a user-signaled interrupt.

 fadeOnReset            bool      Whether to trigger a fade in/out when
                                  the console is reset.  Defaults to true.

LICENSE

Copyright 2010 Chris Done, Simon David Pratt. All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:

   1. Redistributions of source code must retain the above
      copyright notice, this list of conditions and the following
      disclaimer.

   2. Redistributions in binary form must reproduce the above
      copyright notice, this list of conditions and the following
      disclaimer in the documentation and/or other materials
      provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
POSSIBILITY OF SUCH DAMAGE.