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

33 lines
618 B
Markdown

---
title: beep (KB)
---
## Summary
Flash body or element as substitute for an audible feedback [`beep`](/developer/language/reference/beep).
## Syntax
```c
keyman.interface.beep(Pelem);
```
or
```c
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`](/developer/language/reference/beep) command. The flashing feedback should last approximately 1/20 of a second.