mirror of
https://github.com/keymanapp/keyman.git
synced 2026-08-16 05:39:24 +00:00
1f82507730
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
32 lines
563 B
Markdown
32 lines
563 B
Markdown
---
|
|
title: getOption
|
|
---
|
|
|
|
## Summary
|
|
|
|
Get a KeymanWeb, On-Screen Keyboard or User Interface option value.
|
|
|
|
## Syntax
|
|
|
|
```js
|
|
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()`](setOption).
|