spiegel-keyman/web/docs/engine/reference/interface/isKeypress.md at b28dd088257ceca33d113b37eb373f62650f94fc

mirror of https://github.com/keymanapp/keyman.git synced 2026-08-05 16:35:33 +00:00

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

757 B

Raw Blame History

title
isKeypress (KIK)

Summary

Returns true if the input event corresponds to a keypress event resulting in character output.

Syntax

keyman.interface.isKeypress(e);

KeymanWeb.KIK(e); // Shorthand

Parameters

e: Type: Object; The event object to be evaluated.

Return Value

boolean: true if the event would produce text output, otherwise false.

Description

This function is designed to facilitate filtering of keystrokes, allowing custom-coded keyboards to ignore function-oriented keystroke events that should never be used for text generation, such as for F1-F12.

The logic corresponds to that for the keyboard language nomatch rule.

757 B Raw Blame History