Skip to content

MouseApi

API Functions

createHotspot

Create a mouse screen edge hotspot, usually used for edge-hiding windows.

Params:

Param NameDescription
rect-

Signature:

typescript
createHotspot: (rect: Rectangle) => Promise<void>

removeHotspot

Remove the mouse screen edge hotspot.

Signature:

typescript
removeHotspot: () => Promise<void>

API Events

Event NameValueDescription
HOTSPOT_ACTIVE'event::cn.widgetjs.core.mouse.hotspot.active'Triggered when the mouse enters the hotspot area.

API Constants

No constants available.