react-native-external-keyboard/src/types/BaseKeyboardView.ts

Toolkit for improving physical keyboard support in React Native

import type {
  View,
  ViewProps,
  NativeSyntheticEvent,
  ColorValue,
} from 'react-native';
import type { KeyPress } from '../nativeSpec/ExternalKeyboardViewNativeComponent';
import type { RefObject } from 'react';
import type { Int32 } from 'react-native/Libraries/Types/CodegenTypes';

export type OnKeyPress = NativeSyntheticEvent<KeyPress> & {
  nativeEvent?: { target?: number };
  currentTarget?: { _nativeTag?: number };
};

export type OnKeyPressFn = (e: OnKeyPress) => void;
export type KeyboardFocus = { focus: () => void };
export type BaseKeyboardViewType = Partial<View> & KeyboardFocus;

export enum LockFocusEnum {
  Up = 'up',
  Down = 'down',
  Right = 'right',
  Left = 'left',
  Forward = 'forward',
  Backward = 'backward',
  First = 'first',
  Last = 'last',
}

export type LockFocusType = `${LockFocusEnum}`;

export type BaseFocusViewProps = {
  viewRef?: RefObject<View>;
  group?: boolean;
  onFocusChange?: (isFocused: boolean, tag?: number) => void;
  onKeyUpPress?: OnKeyPressFn;
  onKeyDownPress?: OnKeyPressFn;
  onContextMenuPress?: () => void;
  onBubbledContextMenuPress?: () => void;
  haloEffect?: boolean;
  autoFocus?: boolean;
  canBeFocused?: boolean;
  focusable?: boolean;
  onFocus?: () => void;
  onBlur?: () => void;
  tintColor?: ColorValue;
  haloCornerRadius?: number;
  haloExpendX?: number;
  haloExpendY?: number;
  groupIdentifier?: string;
  ignoreGroupFocusHint?: boolean;
  exposeMethods?: string[];
  enableA11yFocus?: boolean;
  screenAutoA11yFocus?: boolean;
  screenAutoA11yFocusDelay?: number;
  orderGroup?: string;
  orderIndex?: Int32;
  lockFocus?: LockFocusType[];
  orderId?: string;
  orderLeft?: string;
  orderRight?: string;
  orderUp?: string;
  orderDown?: string;
  orderForward?: string;
  orderBackward?: string;
  orderFirst?: string | null;
  orderLast?: string | null;
};

export type BaseKeyboardViewProps = ViewProps & BaseFocusViewProps;