react-native-confirmation-code-field/index.d.ts

A react-native component to input confirmation code for both Android and IOS

import * as React from 'react';
import * as ReactNative from 'react-native';

declare module 'react-native-confirmation-code-field' {
  export type InputPositions = 'left' | 'right' | 'center' | 'full-width';

  export type VariantNames =
    | 'border-box'
    | 'border-circle'
    | 'border-b'
    | 'clear';

  export type CellPropsOptions = {
    index: number;
    isFocused: boolean;
    hasValue: boolean;
  };

  export type CellPropsFn = (
    options: CellPropsOptions,
  ) => ReactNative.TextInputProps | void | null;

  export interface ConfirmationCodeInputProps {
    onFulfill: (code: string) => void;

    codeLength?: number;
    defaultCode?: string;
    normalizeCode?: (code: string) => string;

    activeColor?: string;
    cellBorderWidth?: number;
    inactiveColor?: string;
    inputPosition?: InputPositions;
    size?: number;
    space?: number;
    variant?: VariantNames;
    keyboardType?: ReactNative.KeyboardTypeOptions;
    maskSymbol?: string;

    autoFocus?: boolean;

    cellProps?: ReactNative.TextInputProps | CellPropsFn;
    inputProps?: ReactNative.TextInputProps;
    containerProps?: ReactNative.ViewProps;

    testID?: any;
  }

  export interface ConfirmationCodeInputState {
    isFocused: boolean;
    codeValue: string;
  }

  export default class ConfirmationCodeInput extends React.Component<
    ConfirmationCodeInputProps,
    ConfirmationCodeInputState
  > {
    clear(): void;
    focus(): void;
    blur(): void;
    handlerOnTextChange(text: string): void;
  }
}