erabo/spiegel-keyman
1
0
Fork 0
mirror of https://github.com/keymanapp/keyman.git synced 2026-08-05 16:35:33 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 11
spiegel-keyman/web/docs/engine/reference/core/BuildVisualKeyboard.md
Marc Durdin 6c145cb775 refactor(web): move web engine help to app repo 
Note: build.sh updated to make sure that test:help build action:target
doesn't also call test.sh by adding `:_all` meta-target.

Note: CI will need a new help-keyman-com.sh build step to deploy web
engine help.

Fixes: #12347
2024-10-31 11:00:06 +07:00

1 KiB
Raw Blame History

title
BuildVisualKeyboard

Summary

Create a copy of the OSK for embedding in documentation or help page.

Syntax

keyman.BuildVisualKeyboard(keyboardID, staticFlag, layoutFormFactor, layerID)

Parameters

keyboardID
Type: string
Identifying name of the keyboard.
staticFlag
Type: number
Deprecated parameter; should be set to 1.
layoutFormFactor
Type: string optional
A string describing the layout to use for the generated keyboard. Should be one of the following:
  • 'desktop'
  • 'phone'
  • 'tablet'

Defaults to 'desktop'.

layerID
Type: string|number optional
Name or index of the layer to be shown. If not specified, defaults to 'default', the base layer.

Return Value

Element
A non-interactive DIV object will filled keyboard layer content.

Description

Generates a non-interactive <div> element with the complete structure of the specified layer of an on-screen keyboard (OSK) that the user can then utilize for documentation or other purposes.