kuito.
Get started

keyboard.watch

Calls listener with each event: willShow, didShow, willHide, didHide, willChangeFrame or didChangeFrame. Both platforms send every one, Will events included (Android through WindowInsetsAnimation). In a component it stops when the component unmounts; elsewhere the returned subscription stops it.

function

Usage

Dismiss and observe the keyboard

tsx
import { Box, Button, Text, VStack, keyboard } from 'kuito';

export default function KeyboardState() {
  keyboard.frame.value; // { screenX, screenY, width, height } or null

  // In a component, until it unmounts; elsewhere, until remove().
  keyboard.watch('didShow', (event) => console.log(event.frame.height, event.duration));

  return (
    <VStack>
      <Text>{keyboard.visible.value ? 'typing' : ''}</Text>
      {/* Rides on the keyboard. */}
      <Box translateY={keyboard.height.map((height) => -height)} />
      <Button onPress={() => keyboard.dismiss()}>Done</Button>
    </VStack>
  );
}

Signatures

ts
(event: KeyboardEventName, listener: (event: KeyboardFrameEvent) => void): EventSubscription

Parameters

NameTypeRequiredDescription
eventKeyboardEventNameYes—
listener(event: KeyboardFrameEvent) => voidYes—

Returns

EventSubscription

Generated from the public TypeScript declarations: signatures, props and defaults come from the checked source, descriptions from its JSDoc. No defaults are invented.