spiegel-keyman/web/docs/engine/reference/core/disableControl.md at 1f82507730846f555468d1526f0d1e47e8ac049b

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

982 B

Raw Blame History

title
disableControl

Summary

Disables KeymanWeb input handling for the specified control.

Syntax

keyman.disableControl(Pelem)

Parameters

Pelem: Type: Element; Element to become KeymanWeb-disabled.

Return Value

undefined

Description

This function is used to explicitly disable KeymanWeb input handling for a previously-attached control, adding the class 'kmw-disabled' property to the element as necessary. It will not, however, detach KeymanWeb from the control, and any KeymanWeb-specific metadata will persist until KeymanWeb is explicitly detached from the element.

If 'kmw-disabled' is added to the control via other means, disableControl() will be called upon it automatically and non-recursively.

If called on an element in an unattached state, the 'kmw-disabled' tag will be added to the element.

982 B Raw Blame History