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

618 B

title
beep (KB)

Summary

Flash body or element as substitute for an audible feedback beep.

Syntax

keyman.interface.beep(Pelem);

or

KeymanWeb.KB(Pelem); // Shorthand

Parameters

Pelem
Type: Element
The page element to be temporarily set flashing.

Return Value

undefined

Description

This function is designed to implement feedback for erroneous input sequences, as with the keyboard language beep command. The flashing feedback should last approximately 1/20 of a second.