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

Raw Blame History

title
saveStore (KSAVE)

Summary

Save an option store value to a cookie for the active keyboard.

Syntax

keyman.interface.saveStore(storeName, value);

KeymanWeb.KSAVE(storeName, value); // Shorthand

Parameters

storeName: Type: string; The option store name, which will be embedded in the cookie's name.
value: Type: string; The option value to save.

Return Value

boolean: true if the operation is successful, otherwise false.

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.

1 KiB Raw Blame History