# GuppyOSK

To enable the on-screen keyboard, ensure all Guppy instances have been initialised and then create a new GuppyOSK object with `new GuppyOSK()`. This will cause any instances of the editor to, when focused, create an on-screen keyboard at the bottom of the screen with tabs for the various groups of symbols.

## Constructor

#### new GuppyOSK(configopt)

Source:
  - osk.js, line 23

##### Parameters:

Name | Type | Attributes | Description
--- | --- | --- | ---
`config` | Object | <optional> | Configuration options for the on-screen keyboard ###### Properties
Name | Type | Attributes | Description
--- | --- | --- | ---
`goto_tab` | string | <optional> | The name of the group whose tab the keyboard should jump to every time a key is pressed. For example, the value `"abc"` will cause the keyboard to revert to the lower-case alphanumeric tab every time a key is pressed.
`attach` | string | <optional> | A string describing how the keyboard should be attached to the editor. Currently, the only supported value is `"focus"`, meaning the keyboard will be attached when the editor is focused and detached when unfocused. If this value is absent, the OSK button in the editor will be the only way to trigger it.

### Methods

#### attach(guppyopt)

Source:
  - osk.js, line 86

Attach the keyboard to a Guppy instance and display it.

##### Parameters:

Name | Type | Attributes | Description
--- | --- | --- | ---
`guppy` | Guppy | <optional> | The instance of Guppy to which the keyboard will attach.

#### detach()

Source:
  - osk.js, line 70

Detach the keyboard from the currently attached editor (if any) and hide it.