spiegel-keyman/web/docs/engine/reference/interface/ifStore.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.3 KiB

Raw Blame History

title
ifStore (KIFS)

Summary

ifStore compares the content of a system store with a string value.

Syntax

keyman.interface.ifStore(systemId, strValue, Pelem);

KeymanWeb.KIFS(systemId, strValue, Pelem);

Parameters

systemId: Type: number; The ID of the system store to test.
strValue: Type: string; The string value to be used for comparison.
Pelem: Type: Element; The page element currently active. (This parameter exists for use by possible future extensions.)

Return Value

boolean: true if the value matches that of the system store, otherwise false.

Description

Only system IDs 31 (platform) and 33 (layer) are currently supported.

For platform, any combination of the following may be tested against the current device and browser:

Input method: : ['touch', 'hardware']
any combination of OS: : ['windows', 'android', 'ios', 'macosx', 'linux']
form factor: : ['desktop', 'tablet', 'phone']
browser: : ['native', 'web', 'ie', 'chrome', 'firefox', 'safari', 'opera']

Only one of each category may be matched at a time.

1.3 KiB Raw Blame History