aplitax/keyboard-visualiser

Sample project for JavaScript tools workshop

Keyboard Visualizer

Simple JS library that visualises selected keystrokes.

Documentation

Table of Contents

• getImageByKey
  • Parameters
• createWrapperElement
  • Parameters
• createImageElement
  • Parameters
• handleEvent
  • Parameters
• createKeyboardVisualiser

getImageByKey

Returns link to image for specific key.

Parameters

• key string?

Returns string

createWrapperElement

Creates wrapper element

Parameters

• parent_node Node? (optional, default document.body)

Returns HTMLElement

createImageElement

Creates image element with default source.

Parameters

• parent_node Node

Returns HTMLElement

handleEvent

Reacts to key press.

Parameters

• event Object
• image_element HTMLElement

createKeyboardVisualiser

Initializes keyboard visualizer.

Bug reports

If you encounter bugs, send them as issues at Github.