spiegel-keyman/web/docs/engine/reference/interface/insertText.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

857 B

title
insertText (KT)

Summary

Inserts a text string and optional deadkey into the active output element.

Syntax

keyman.interface.insertText(text, dk);

or

KeymanWeb.KT(text, dk); // Shorthand

Parameters

text
Type: string
The text to insert.
dk
Type: number optional
The deadkey's id, if one is to be inserted.

Return Value

boolean
true if the operation is successful, otherwise false.

Description

This function is designed to allow custom UI elements or custom OSK displays (as for the EuroLatin keyboard) to directly insert input into a control without losing the current input state due to loss of focus for the control. It is safe for use outside of keyboard code.