spiegel-keyman/web/docs/engine/reference/interface/output.md at 54d7423619be21acee9affb0abeab0aef5cca32c

mirror of https://github.com/keymanapp/keyman.git synced 2026-08-15 21:29:23 +00:00

Marc Durdin 1f82507730 docs(web): deprecate unused and obsolete API endpoints and docs cleanup

Deprecate the following obsolete functions and properties:
* `keyman.helpURL`
* `keyman.util.rgba`
* `keyman.util.toFloat`
* `keyman.util.toNumber`
* `keyman.util.toNzString`

Use correct language for code blocks in Keyman Engine for Web
documentation.

Test-bot: skip

2026-08-12 16:07:22 +02:00

1.1 KiB

Raw Blame History

title
output (KO)

Summary

Outputs the specified string to an element, overwriting nd characters before the caret.

Syntax

keyman.interface.output(nd, Pelem, str);

KeymanWeb.KO(nd, Pelem, str); // Shorthand

Parameters

nd: Type: number; The number of characters to overwrite. Passively ignores values less than zero.
Pelem: Type: Element; The input element to receive the output text.
str: Type: string; The output text to write to the input element.

Return Value

undefined

Description

This is a core element of keyboard input management within KeymanWeb, typically called automatically during keystroke processing events. For comparison with Developer 'rules' from keyboard source code, in the rule

"a" + "'" > "á"

a keyboard would, after checking that the initial context ("a") matches, use

keyman.interface.output(1, Pelem, "á");

to erase one character "a" and output one character "á", effectively performing the desired replacement.

1.1 KiB Raw Blame History