react-native-avoid-softinput/src/types.ts

Native logic for avoiding covering text inputs by soft input views

import type { NativeSyntheticEvent, ViewProps } from 'react-native';

export interface SoftInputEventData {
  softInputHeight: number;
}

export interface SoftInputAppliedOffsetEventData {
  appliedOffset: number;
}

export type SoftInputEvent = NativeSyntheticEvent<SoftInputEventData>;

export type SoftInputAppliedOffsetEvent = NativeSyntheticEvent<SoftInputAppliedOffsetEventData>;

export type SoftInputEasing = 'easeIn' | 'easeInOut' | 'easeOut' | 'linear';

export interface AvoidSoftInputNativeModuleType {
  addListener: (eventType: string) => void;
  removeListeners: (count: number) => void;
  setAdjustNothing(): void;
  setAdjustPan(): void;
  setAdjustResize(): void;
  setAdjustUnspecified(): void;
  setAvoidOffset(offset: number): void;
  setDefaultAppSoftInputMode(): void;
  setEasing(easing: SoftInputEasing): void;
  setEnabled(enabled: boolean): void;
  setHideAnimationDelay(delay?: number): void;
  setHideAnimationDuration(duration?: number): void;
  setShouldMimicIOSBehavior(shouldMimic: boolean): void;
  setShowAnimationDelay(delay?: number): void;
  setShowAnimationDuration(duration?: number): void;
}

export interface AvoidSoftInputViewProps extends Omit<ViewProps, 'pointerEvents'> {
  /**
   * @default 0
   */
  avoidOffset?: number;
  /**
   * @default 'linear'
   */
  easing?: SoftInputEasing;
  /**
   * @default true
   */
  enabled?: boolean;
  /**
   * @default (300/0) ms (iOS/Android)
   */
  hideAnimationDelay?: number;
  /**
   * @default 220 ms
   */
  hideAnimationDuration?: number;
  /**
   * @default 0 ms
   */
  showAnimationDelay?: number;
  /**
   * @default 660 ms
   */
  showAnimationDuration?: number;
  onSoftInputAppliedOffsetChange?: (e: SoftInputAppliedOffsetEvent) => void;
  onSoftInputHeightChange?: (e: SoftInputEvent) => void;
  onSoftInputHidden?: (e: SoftInputEvent) => void;
  onSoftInputShown?: (e: SoftInputEvent) => void;
}