mirror of
https://github.com/keymanapp/keyman.git
synced 2026-08-05 08:25:32 +00:00
6c145cb775
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
1.2 KiB
1.2 KiB
| title |
|---|
| loadStore (KLOAD) |
Summary
Load an option store value from a cookie or default value if no prior stored value exists.
Syntax
keyman.interface.loadStore(kbdName, storeName, value);
or
KeymanWeb.KLOAD(kbdName, storeName, value); // Shorthand
Parameters
kbdName- Type:
string - The keyboard's identifying internal name.
storeName- Type:
string - The option
storename that is embedded in the cookie's name. value- Type:
string - A value for the store to use as default if no prior value exists.
Return Value
string- The current value of the store, or the default
valueprovided if the store's value isundefined.
Description
keyman.interface.loadStore() and keyman.interface.saveStore() provide API-based functionality similar to that of the keyboard language's option store. Values will persist across multiple visits to the site by use of cookies. However, these functions cannot interact with stores from existing compiled keyboards due to compilation optimizations. As such, they are most useful for custom-coded web-oriented keyboards.