spiegel-keyman/web/docs/engine/reference/core/removeKeyboards.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

574 B

title
removeKeyboards

Summary

Removes keyboards (by ID) from KeymanWeb.

Syntax

keyman.removeKeyboards(id[, id2, ...])

Parameters

id
Type: string
keyboard name string

Return Value

boolean
true if all keyboards were successfully removed, otherwise false.

Description

Allows a web page designer to dynamically remove keyboards from KeymanWeb by their ID(s).

If the value false is returned, it is most likely that at least one specified keyboard was not actively loaded in KeymanWeb at the time of the call.