keyboard.KeyboardEventName — Kuito Documentation

Usage

Dismiss and observe the keyboard

This type is used by keyboard.watch

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>
  );
}

Type declaration

export type KeyboardEventName =
  | 'willShow'
  | 'didShow'
  | 'willHide'
  | 'didHide'
  | 'willChangeFrame'
  | 'didChangeFrame';

Type

"willShow" | "didShow" | "willHide" | "didHide" | "willChangeFrame" | "didChangeFrame"

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