TiddlyWiki5/editions/tw5.com/tiddlers/widgets/KeyboardWidget.tid

created: 20140302192136805
modified: 20140302192935781
tags: Widgets
title: KeyboardWidget
type: text/vnd.tiddlywiki
caption: keyboard

! Introduction

The keyboard widget allows [[Messages]] to be generated in response to key presses.

! Content and Attributes

The content of the `<$keyboard>` widget is rendered normally. The keyboard shortcut only takes effect within the contained content.

|!Attribute |!Description |
|message |The title of the [[WidgetMessage|Messages]] to generate |
|param |The parameter to be passed with the [[WidgetMessage|Messages]] |
|key |Key string identifying the key to be trapped (see below) |
|class |A CSS class to be assigned to the generated HTML DIV element |

! Key Strings

Key strings are made up of zero or more of the modifiers ''alt'', ''shift'' or ''ctrl'' followed by the name of a key, all joined with "+" plus 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
```
Add docs for keyboard widget 2014-03-02 19:30:13 +00:00			`created: 20140302192136805`
			`modified: 20140302192935781`
More mangling of reference docs 2014-09-10 23:06:19 +00:00			`tags: Widgets`
Add docs for keyboard widget 2014-03-02 19:30:13 +00:00			`title: KeyboardWidget`
			`type: text/vnd.tiddlywiki`
More mangling of reference docs 2014-09-10 23:06:19 +00:00			`caption: keyboard`
Add docs for keyboard widget 2014-03-02 19:30:13 +00:00
			`! Introduction`

More reference docs mangling 2014-09-11 14:52:47 +00:00			`The keyboard widget allows [[Messages]] to be generated in response to key presses.`
Add docs for keyboard widget 2014-03-02 19:30:13 +00:00
			`! Content and Attributes`

			The content of the `<$keyboard>` widget is rendered normally. The keyboard shortcut only takes effect within the contained content.

			`\|!Attribute \|!Description \|`
Fix bad links 2014-10-10 20:06:48 +00:00			`\|message \|The title of the [[WidgetMessage\|Messages]] to generate \|`
			`\|param \|The parameter to be passed with the [[WidgetMessage\|Messages]] \|`
Add docs for keyboard widget 2014-03-02 19:30:13 +00:00			`\|key \|Key string identifying the key to be trapped (see below) \|`
			`\|class \|A CSS class to be assigned to the generated HTML DIV element \|`

			`! Key Strings`

			`Key strings are made up of zero or more of the modifiers ''alt'', ''shift'' or ''ctrl'' followed by the name of a key, all joined with "+" plus 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`
			```