mirror of
https://github.com/keymanapp/keyman.git
synced 2026-08-05 16:35:33 +00:00
6c145cb775
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
1.1 KiB
1.1 KiB
| title |
|---|
| output (KO) |
Summary
Outputs the specified string to an element, overwriting nd characters before the caret.
Syntax
keyman.interface.output(nd, Pelem, str);
or
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.