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

1.3 KiB

title
ifStore (KIFS)

Summary

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

Syntax

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

or

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.

See also