spiegel-keyman/web/docs/engine/reference/util/index.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.9 KiB

title
Utility Module

The KeymanWeb Utility Function module is exposed to the developer as window.keyman.util.

addStyleSheet Function
Add or override default On-Screen Keyboard styles.
alert Function
Customized alert window.
attachDOMEvent Function
Attach user-defined event handler for any DOM event for an element.
createElement Function
Create an unselectable HTML element for the KeymanWeb On-Screen keyboard and User Interfaces.
detachDOMEvent Function
Detach DOM event handler from element to prevent memory leaks.
getAbsolute Function
Get the absolute position of an element.
getAbsoluteX Function
Get the absolute y-coordinate of an element.
getAbsoluteY Function
Get the absolute y-coordinate of an element.
getOption Function
Get a KeymanWeb, On-Screen Keyboard or User Interface option value.
isTouchDevice Function
Allow external callers (such as UIs) to detect if the active device is touch sensitive.
linkStyleSheet Function
Add a reference to an external stylesheet file.
loadCookie Function
Get a document cookie, or an array of all document cookies.
removeStyleSheet Function
Remove user-defined style sheet.
rgba Function
Browser-independent alpha-channel management.
saveCookie Function
Save document variables as a cookie.
setOption Function
Set a KeymanWeb, On-Screen Keyboard or User Interface option value.
toFloat Function
Floating conversion with default.
toNumber Function
Integer conversion with default.
toNzString Function
Returns default string value if argument is null, false, an empty string, or undefined.