spiegel-keyman/web/docs/engine/reference/interface/contextMatch.md at 1f82507730846f555468d1526f0d1e47e8ac049b

mirror of https://github.com/keymanapp/keyman.git synced 2026-08-16 05:39:24 +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.5 KiB

Raw Blame History

title
contextMatch (KCM) (Deprecated)

Summary

(Deprecated) Context matching: Returns true if context(n,ln,elem) == val.

Syntax

keyman.interface.contextMatch(n, Pelem, val, ln);

KeymanWeb.KCM(n, Pelem, val, ln); // Shorthand

Parameters

n: Type: number; Relative position of the caret for the context match attempt.
Pelem: Type: Element; The element being operated upon.
val: Type: string; The desired text value for context to match.
ln: Type: number; Number of characters of text context to match.

Return Value

boolean: true if the context matches the specified value val, otherwise false.

Description

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

"a" + "'" > "á"

a keyboard would check that the initial context ("a") matches by using

keyman.interface.contextMatch(1, Pelem, "a", 1)

which checks, starting at the first character to the left of the caret, a single character to see if it matches the value "a".

For versions 10.0 and later, please consider use of fullContextMatch() instead.

1.5 KiB Raw Blame History