@nhtio/crows-nest
Classes
| Class | Description |
|---|---|
| CrowsNest | CrowsNest is a class which provides the "safe" full screen area that can be used without being cut off by the shape of the display or browser UI elements. including whether or not a virtual keyboard is open. |
Interfaces
| Interface | Description |
|---|---|
| CrowsNestEvents | Describes the events and the signatures of the callbacks which can be registered for each event. |
| CrowsNestKeyboardEventDetail | The detail payload for a CROWS_NEST_KEYBOARD_EVENT custom event. |
| CrowsNestOptions | Options for configuring a CrowsNest instance. |
| Offset | Describes the offset of a surface from the window's viewport i.e. the css fixed position offsets |
| Surface | Describes a rectangular surface |
Type Aliases
| Type Alias | Description |
|---|---|
| KeyboardState | Describes the possible states of the virtual keyboard |
Variables
| Variable | Description |
|---|---|
| CROWS_NEST_KEYBOARD_EVENT | 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. |
| CROWS_NEST_MIN_KEYBOARD_BOTTOM | The minimum value for a keyboard bottom offset to be considered open |