Skip to content

@nhtio/crows-nest

Classes

ClassDescription
CrowsNestCrowsNest 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

InterfaceDescription
CrowsNestEventsDescribes the events and the signatures of the callbacks which can be registered for each event.
OffsetDescribes the offset of a surface from the window's viewport i.e. the css fixed position offsets
SurfaceDescribes a rectangular surface

Type Aliases

Type AliasDescription
KeyboardStateDescribes the possible states of the virtual keyboard

Variables

VariableDescription
CROWS_NEST_MIN_KEYBOARD_BOTTOMThe minimum value for a keyboard bottom offset to be considered open