• Version 5.4.7
  • Published
  • 4.29 kB
  • 1 dependency
  • MIT license


npm i @types/react-text-mask
yarn add @types/react-text-mask
pnpm add @types/react-text-mask


TypeScript definitions for react-text-mask



function conformToMask

conformToMask: (
text: string,
mask: maskArray | ((value: string) => maskArray),
config?: any
) => conformToMaskResult;


    class MaskedInput

    class MaskedInput extends React.Component<MaskedInputProps, any> {}

      property inputElement

      inputElement: HTMLElement;


        interface conformToMaskResult

        interface conformToMaskResult {}

          property conformedValue

          conformedValue: string;

            property meta

            meta: {
            someCharsRejected: boolean;

              interface MaskedInputProps

              interface MaskedInputProps extends React.InputHTMLAttributes<HTMLInputElement> {}

                property guide

                guide?: boolean;

                  property keepCharPositions

                  keepCharPositions?: boolean;

                    property mask

                    mask?: maskArray | ((value: string) => maskArray);

                      property pipe

                      pipe?: (
                      conformedValue: string,
                      config: any
                      ) => false | string | { value: string; indexesOfPipedChars: number[] };

                        property placeholderChar

                        placeholderChar?: string;

                          property render

                          render?: (ref: (inputElement: HTMLElement) => void, props: any) => any;

                            property showMask

                            showMask?: boolean;

                              Type Aliases

                              type maskArray

                              type maskArray = Array<string | RegExp> | boolean;

                                Package Files (1)

                                Dependencies (1)

                                Dev Dependencies (0)

                                No dev dependencies.

                                Peer Dependencies (0)

                                No peer dependencies.


                                To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

                                You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/@types/react-text-mask.

                                • Markdown
                                • HTML
                                  <a href="https://www.jsdocs.io/package/@types/react-text-mask"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>