Skip to content
Mottie edited this page Sep 27, 2011 · 26 revisions

Wiki Pages: Home | FAQ | Setup | Options ( Layout, Language, Useability, Actions ) | Methods | Theme | Log

actionClass - [String] Class name used to make keys a different color

  • This varibale contains the class that is only added to the Accept and cancel buttons to give them a different color from the normal keys.
  • It was originally set to 'ui-state-highlight' which looks good in some themes, but not others.
  • This class name can also be a custom one that you set up for these keys as well.
  • Default is 'ui-state-active'.

display - [Object] Button language / symbol options

  • Change the displayed button text by modifying the value, in the key:value pair, with the text or symbol you want to use.

  • The default values are shown in the following list. The abbreviated names contain only a symbol so as to fit the layout style as desired:

    • 'a' : '\u2714' - Alternate accept button - unicode for check mark symbol
    • 'accept' : 'Accept' - Accept button text
    • 'alt' : 'AltGr' - Alt button text (AltGr is for international key sets)
    • 'b' : '\u2190' - Alternate backspace button - unicode for left arrow. Same as ←
    • 'bksp' : 'Bksp' - Backspace button text
    • 'c' : '\u2716' - Alternate cancel button - unicode for big X
    • 'cancel' : 'Cancel - Cancel button text
    • 'clear' : 'C' - Clear window content (used in num pad)
    • 'combo' : '\u00f6' - Toggle combo (diacritic) key
    • 'dec' : '.' - Decimal point for num pad (optional), change '.' to ',' for European format
    • 'e' : '\u21b5' - Alternate enter button - unicode for down, then left arrow (enter symbol)
    • 'enter' : 'Enter' - Enter button text
    • 's' : '\u21e7' - Alternate shift button - unicode for a thick up arrow
    • 'shift' : 'Shift' - Shift button text
    • 'sign' : '\u00b1' - Change sign (used in num pad) - unicode for a +- symbol
    • 'space' : 'Space' - Space button text
    • 't' : '\u21e5' - Alternate tab button - unicode for right arrow to bar (used since only one directional tabs available)
    • 'tab' : '\u21e5 Tab' - Tab button text (Note: \u21b9 is the true tab symbol (left & right arrows) but not used here)

stayOpen - [Boolean] Keyboard remains open when input loses focus.

  • When true, the keyboard will not automatically close when the input loses focus. It will close when another keyboard is opened or if the user presses accept, cancel or escape.
  • If false, the keyboard will automatically close when the input loses focus, or the user presses accept, cancel or escape.
  • Default is false.

usePreview - [Boolean] Include a preview input or use the original.

  • When true, a preview input (clone of the original input) will be included above the virtual keyboard and the entire keyboard will overlay the original input (if the default position is used).
  • When false, the keyboard will position itself under the original input, if the default positioning is used, so the user is typing directly into the original input.
  • Default is true.

wheelMessage - [String] Message to tell users about the hidden feature

  • This message is only added when a key on the keyboard is hovered over.
  • The text is added to the title attribute of the key, so if you want to have a tooltip attached to it. You will probably need a 'live' tooltip that targets the 'ui-keyboard-button' class.
  • Default message is 'Use mousewheel to see other keys'.
Clone this wiki locally