This page is part of a static HTML representation of the TiddlyWiki at https://tiddlywiki.com/

KeyboardWidget

3rd October 2016 at 12:46pm
Widgets

Introduction

The keyboard widget allows ActionWidgets to be triggered by specific key combinations. There is also a shorthand for generating Messages via the message and param attributes.

Content and Attributes

The content of the <$keyboard> widget is rendered normally. The keyboard shortcuts only take effect when the focus is within the contained content.

AttributeDescription
actionsA string containing ActionWidgets to be triggered when the key combination is detected
messageThe title of the WidgetMessage to generate
paramThe parameter to be passed with the WidgetMessage
keyKey string identifying the key(s) to be trapped (see below)
classA CSS class to be assigned to the generated HTML DIV element
tag New in 5.1.14 The html element the widget creates to capture the keyboard event, defaults to:
» span when parsed in inline-mode
» div when parsed in block-mode

Key Strings

Key strings are made up of one or more key specifiers separated by spaces. Each key specifier is zero or more of the modifiers alt, shift, ctrl or meta followed by the name of a key, all joined with "+" plus or "-" minus symbols. Key names are either the letter or digit printed on the key (eg "a" or "1"), or one of the special keys backspace, tab, enter or escape.

For example:

A
shift+A
shift+escape
ctrl+enter
ctrl+shift+alt+A