mirror of
https://github.com/keymanapp/keyman.git
synced 2026-08-15 21:29:23 +00:00
1f82507730
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
36 lines
759 B
Markdown
36 lines
759 B
Markdown
---
|
|
title: isKeypress (KIK)
|
|
---
|
|
|
|
## Summary
|
|
|
|
Returns `true` if the input event corresponds to a keypress event resulting in character output.
|
|
|
|
## Syntax
|
|
|
|
```js
|
|
keyman.interface.isKeypress(e);
|
|
```
|
|
|
|
or
|
|
|
|
```js
|
|
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`](/developer/language/reference/nomatch) rule.
|