Skip to content

Commit 15e611a

Browse files
authored
docs: clarify dock.bounce usage (electron#20458)
1 parent 3176e32 commit 15e611a

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

docs/api/app.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1285,14 +1285,16 @@ you exactly what went wrong
12851285
* `type` String (optional) - Can be `critical` or `informational`. The default is
12861286
`informational`
12871287

1288+
Returns `Integer` an ID representing the request.
1289+
12881290
When `critical` is passed, the dock icon will bounce until either the
12891291
application becomes active or the request is canceled.
12901292

12911293
When `informational` is passed, the dock icon will bounce for one second.
12921294
However, the request remains active until either the application becomes active
12931295
or the request is canceled.
12941296

1295-
Returns `Integer` an ID representing the request.
1297+
**Nota Bene:** This method can only be used while the app is not focused; when the app is focused it will return -1.
12961298

12971299
### `app.dock.cancelBounce(id)` _macOS_
12981300

0 commit comments

Comments
 (0)