erabo/spiegel-keyman
1
0
Fork 0
mirror of https://github.com/keymanapp/keyman.git synced 2026-08-15 21:29:23 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2
spiegel-keyman/web/docs/engine/reference/util/getOption.md
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

563 B
Raw Blame History

title
getOption

Summary

Get a KeymanWeb, On-Screen Keyboard or User Interface option value.

Syntax

keyman.util.getOption(optionName, dflt);

Parameters

optionName
Type: string
The named initialization option.
dflt
Type: string|Object optional
The value to return if the option is not set.

Return Value

string|Object
The value of the option (if set). If not set and no value is provided for dflt, returns the empty string.

Description

See also keyman.util.setOption().