Skip to content

Variable: CROWS_NEST_KEYBOARD_EVENT

ts
const CROWS_NEST_KEYBOARD_EVENT: "crowsnest:keyboard" = "crowsnest:keyboard";

The name of the window CustomEvent a consumer can dispatch to push the keyboard state into Crows Nest manually. This is an escape hatch for environments (e.g. a Capacitor / native shell) that can detect the on-screen keyboard more reliably than the browser APIs allow.

The event's detail must be a CrowsNestKeyboardEventDetail:

ts
window.dispatchEvent(
  new CustomEvent(CROWS_NEST_KEYBOARD_EVENT, { detail: { state: "open" } }),
);