erabo/spiegel-keyman
1
0
Fork 0
mirror of https://github.com/keymanapp/keyman.git synced 2026-08-05 16:35:33 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 13
spiegel-keyman/web/docs/engine/reference/core/disableControl.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

981 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.

See also: