use-mask-input 3.7.4 → 3.9.0

package/CHANGELOG.md

@@ -1,5 +1,39 @@
 ## [3.6.0](https://github.com/eduardoborges/use-mask-input/compare/3.5.2...3.6.0) (2026-01-13)
 
+## 3.9.0
+
+### Minor Changes
+
+- 99e7a0a: Add TanStack Form integration: `useTanStackFormMask` and `withTanStackFormMask`, with types `TanStackFormInputProps` and `UseTanStackFormMaskReturn`. Documentation and a `tanstack-form-project` demo app were added; examples favor international-friendly masks (phone, email, postal).
+
+## 3.8.0
+
+### Minor Changes
+
+- eacce0f: feat: add Brazilian banking masks (br-bank-account and br-bank-agency)
+
+  Added two new mask aliases for Brazilian banking information:
+
+  - `br-bank-account`: Supports multiple Brazilian bank account formats including Bradesco, Itaú, Banco do Brasil, Caixa Econômica, Nubank, and more
+  - `br-bank-agency`: Handles Brazilian bank agency numbers with optional check digits
+
+  These masks automatically adapt to different account number formats used by major Brazilian banks, making it easier to handle banking data in forms.
+
+  Example usage:
+
+  ```tsx
+  const accountMask = useMaskInput({ mask: "br-bank-account" });
+  const agencyMask = useMaskInput({ mask: "br-bank-agency" });
+  ```
+
+### Patch Changes
+
+- a614d93: fix: sync DOM value after react-hook-form `reset()` in `useHookFormMask`
+
+  `reset()` in react-hook-form clears its internal field registry before re-rendering. On the subsequent render it returns a new ref callback that, when called, syncs the DOM to the reset value. Because `useHookFormMask` caches a stable ref, React never calls that new callback — leaving masked inputs stale after `reset()`.
+
+  Fixed by using a `useLayoutEffect` queue that replays the latest RHF ref callback against the stored element after each render. RHF's own guard makes this a no-op on normal re-renders; it only does real work after `reset()` clears the registry.
+
 ## 3.7.4
 
 ### Patch Changes

package/README.md

@@ -1,62 +1,138 @@
 <div align="center">
   <h1>🥸 use-mask-input</h1>
-  <h4>A React Hook for building elegant and simple input masks.</h4>
+  <p>Input masks for React. Works with React Hook Form, <strong>TanStack Form</strong>, Ant Design, and plain inputs.</p>
 
   [![npm](https://img.shields.io/npm/v/use-mask-input)](https://www.npmjs.com/package/use-mask-input)
   [![npm downloads](https://img.shields.io/npm/dw/use-mask-input)](https://www.npmjs.com/package/use-mask-input)
-  [![npm package minimized gzipped size (select exports)](https://img.shields.io/bundlejs/size/use-mask-input?color=green-light)](https://bundlejs.com/?q=use-mask-input)
+  [![bundle size](https://img.shields.io/bundlejs/size/use-mask-input?color=green-light)](https://bundlejs.com/?q=use-mask-input)
   [![codecov](https://codecov.io/gh/eduardoborges/use-mask-input/branch/main/graph/badge.svg?token=8ORAOAUZTP)](https://codecov.io/gh/eduardoborges/use-mask-input)
+
+  [![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/E1E71VQENQ)
 </div>
 
-## [Full Documentation](http://use-mask-input.eduardoborges.dev) | [Sponsor this project](https://github.com/eduardoborges?tab=sponsors)
+---
+
+**[Documentation](http://use-mask-input.eduardoborges.dev)** · **[API Reference](http://use-mask-input.eduardoborges.dev/api-reference)** · **[TanStack Form](http://use-mask-input.eduardoborges.dev/tanstack-form)** · **[Sponsor](https://ko-fi.com/E1E71VQENQ)**
 
-## Features
-- 🎯  Simple API
-- 💎  Works like a charm with *Next.js*
-- ✨  Compatible with [React Hook Form](https://github.com/react-hook-form/react-hook-form)
-- 🏁  Compatible with [React Final Form](https://github.com/final-form/react-final-form)
 ## Install
 
 ```sh
-npm i use-mask-input
+npm install use-mask-input
 ```
 
-## Quickstart
+## Usage
 
-```jsx
-import React from 'react'
+```tsx
 import { useMaskInput } from 'use-mask-input';
 
-const App = () => {
-  return (
-    <input type="text" ref={withMask('9999-9999')} />
-  )
+function PhoneInput() {
+  const ref = useMaskInput({ mask: '(99) 99999-9999' });
+  return <input ref={ref} />;
 }
 ```
 
-### Usage with React Hook Forms
+### With React Hook Form
 
-```jsx
-import React from 'react';
+```tsx
 import { useForm } from 'react-hook-form';
 import { useHookFormMask } from 'use-mask-input';
 
-function App() {
+function MyForm() {
   const { register, handleSubmit } = useForm();
   const registerWithMask = useHookFormMask(register);
 
-  ...
-
   return (
-    <form onSubmit={onSubmit}>
-      <input
-        {...registerWithMask("phone", ['99 9999-9999', '99999-9999'], {
-          required: true
-        })}
-        type="text"
-      />
+    <form onSubmit={handleSubmit(console.log)}>
+      <input {...registerWithMask('phone', '(99) 99999-9999')} />
+      <input {...registerWithMask('email', 'email')} />
       <button type="submit">Submit</button>
     </form>
   );
 }
 ```
+
+### With TanStack Form
+
+```tsx
+import { useForm } from '@tanstack/react-form';
+import { useTanStackFormMask } from 'use-mask-input';
+
+function MyForm() {
+  const maskField = useTanStackFormMask();
+  const form = useForm({
+    defaultValues: {
+      phone: '',
+    },
+    onSubmit: async ({ value }) => {
+      console.log(value);
+    },
+  });
+
+  return (
+    <form
+      onSubmit={(event) => {
+        event.preventDefault();
+        event.stopPropagation();
+        void form.handleSubmit();
+      }}
+    >
+      <form.Field name="phone">
+        {(field) => {
+          const inputProps = maskField(
+            '(99) 99999-9999',
+            {
+              name: field.name,
+              value: field.state.value,
+              onBlur: field.handleBlur,
+              onChange: (event) => field.handleChange(event.target.value),
+            },
+          );
+
+          return <input {...inputProps} placeholder="(00) 00000-0000" />;
+        }}
+      </form.Field>
+    </form>
+  );
+}
+```
+
+### With Ant Design
+
+```tsx
+import { Input } from 'antd';
+import { useMaskInputAntd } from 'use-mask-input/antd';
+
+function EmailInput() {
+  const ref = useMaskInputAntd({ mask: 'email' });
+  return <Input ref={ref} />;
+}
+```
+
+## APIs
+
+| API | Description |
+|-----|-------------|
+| `useMaskInput` | Hook. Returns a ref callback. Default choice. |
+| `useHookFormMask` | Hook. Wraps React Hook Form's `register`. |
+| `useTanStackFormMask` | Hook. Adds mask to TanStack Form field input props. |
+| `withMask` | Function. Ref callback. Requires `React.memo`. |
+| `withHookFormMask` | Function. Mask for registered fields. Requires `React.memo`. |
+| `withTanStackFormMask` | Function. Mask for TanStack input props. Requires `React.memo`. |
+| `useMaskInputAntd` | Hook. `useMaskInput` for Ant Design. |
+| `useHookFormMaskAntd` | Hook. `useHookFormMask` for Ant Design. |
+
+## Built-in Aliases
+
+`cpf` · `cnpj` · `br-bank-account` · `br-bank-agency` · `currency` · `brl-currency` · `datetime` · `email` · `numeric` · `decimal` · `integer` · `percentage` · `url` · `ip` · `mac` · `ssn`
+
+## Works With
+
+- **TanStack Form** (`useTanStackFormMask`, `withTanStackFormMask`). See the [TanStack Form guide](http://use-mask-input.eduardoborges.dev/tanstack-form).
+- React Hook Form
+- Ant Design (`use-mask-input/antd`)
+- React Final Form
+- Next.js / SSR
+
+## License
+
+MIT

package/dist/antd.cjs

@@ -1,6 +1,6 @@
 'use strict';
 
-var chunkVK6LQ75W_cjs = require('./chunk-VK6LQ75W.cjs');
+var chunkX5SEJVSB_cjs = require('./chunk-X5SEJVSB.cjs');
 var react = require('react');
 
 function useHookFormMaskAntd(registerFn) {
@@ -10,11 +10,11 @@ function useHookFormMaskAntd(registerFn) {
       if (!registerFn) throw new Error("registerFn is required");
       const registerReturn = registerFn(fieldName, options);
       const { ref } = registerReturn;
-      const cacheKey = chunkVK6LQ75W_cjs.makeMaskCacheKey(fieldName, mask);
+      const cacheKey = chunkX5SEJVSB_cjs.makeMaskCacheKey(fieldName, mask);
       if (!refCache.has(cacheKey)) {
         const refWithMask = (inputRef) => {
-          const element = inputRef ? chunkVK6LQ75W_cjs.resolveInputRef(inputRef.input) : null;
-          if (element) chunkVK6LQ75W_cjs.applyMaskToElement(element, mask, options);
+          const element = inputRef ? chunkX5SEJVSB_cjs.resolveInputRef(inputRef.input) : null;
+          if (element) chunkX5SEJVSB_cjs.applyMaskToElement(element, mask, options);
           if (ref) ref(element);
         };
         refCache.set(cacheKey, refWithMask);
@@ -23,7 +23,7 @@ function useHookFormMaskAntd(registerFn) {
         ...registerReturn,
         ref: refCache.get(cacheKey)
       };
-      chunkVK6LQ75W_cjs.setPrevRef(result, ref);
+      chunkX5SEJVSB_cjs.setPrevRef(result, ref);
       return result;
     };
   }, [registerFn]);
@@ -41,17 +41,17 @@ function useMaskInputAntd(props) {
       ref.current = null;
       return;
     }
-    ref.current = chunkVK6LQ75W_cjs.resolveInputRef(input.input);
+    ref.current = chunkX5SEJVSB_cjs.resolveInputRef(input.input);
     if (ref.current && ref.current !== maskedElementRef.current) {
-      chunkVK6LQ75W_cjs.withMask(maskRef.current, optionsRef.current)(ref.current);
+      chunkX5SEJVSB_cjs.withMask(maskRef.current, optionsRef.current)(ref.current);
       maskedElementRef.current = ref.current;
     }
   }, []);
   react.useEffect(() => {
-    if (chunkVK6LQ75W_cjs.isServer_default || !ref.current || !register) return;
+    if (chunkX5SEJVSB_cjs.isServer_default || !ref.current || !register) return;
     register(ref.current);
   }, [register]);
-  if (chunkVK6LQ75W_cjs.isServer_default) {
+  if (chunkX5SEJVSB_cjs.isServer_default) {
     return () => {
     };
   }

package/dist/antd.d.cts

@@ -1,7 +1,7 @@
 import { InputRef } from 'antd';
 import { RefCallback } from 'react';
 import { FieldValues, RegisterOptions, UseFormRegister, Path } from 'react-hook-form';
-import { U as UseHookFormMaskReturn, M as Mask, O as Options } from './index-F3rlTTTe.cjs';
+import { U as UseHookFormMaskReturn, M as Mask, O as Options } from './index-BoaVtWUr.cjs';
 
 type UseHookFormMaskAntdReturn<T extends FieldValues> = Omit<UseHookFormMaskReturn<T>, 'ref'> & {
     ref: RefCallback<InputRef | null>;

package/dist/antd.d.ts

@@ -1,7 +1,7 @@
 import { InputRef } from 'antd';
 import { RefCallback } from 'react';
 import { FieldValues, RegisterOptions, UseFormRegister, Path } from 'react-hook-form';
-import { U as UseHookFormMaskReturn, M as Mask, O as Options } from './index-F3rlTTTe.js';
+import { U as UseHookFormMaskReturn, M as Mask, O as Options } from './index-BoaVtWUr.js';
 
 type UseHookFormMaskAntdReturn<T extends FieldValues> = Omit<UseHookFormMaskReturn<T>, 'ref'> & {
     ref: RefCallback<InputRef | null>;

package/dist/antd.js

@@ -1,4 +1,4 @@
-import { makeMaskCacheKey, setPrevRef, resolveInputRef, withMask, isServer_default, applyMaskToElement } from './chunk-QCWLMMDI.js';
+import { makeMaskCacheKey, setPrevRef, resolveInputRef, withMask, isServer_default, applyMaskToElement } from './chunk-ICLWBMH4.js';
 import { useMemo, useRef, useCallback, useEffect } from 'react';
 
 function useHookFormMaskAntd(registerFn) {

package/dist/{chunk-QCWLMMDI.js → chunk-ICLWBMH4.js}

@@ -3704,6 +3704,25 @@ var ALIAS_MASKS = {
   cnpj: {
     mask: ["A|9{2}.A|9{3}.A|9{3}/A|9{4}-9{2}"],
     placeholder: "__.___.___/____-__"
+  },
+  "br-bank-account": {
+    mask: [
+      "9{4,10}[-]9",
+      // Most common formats: 1234567-9, 12345678-9, 123456789-9, 1234567890-1
+      "999999[-][9]",
+      // Optional separator: 123456-7 or 1234567
+      "[999]9{7,8}[-]9",
+      // Caixa and Nu Pagamentos: (001)12345678-9 or (001)1234567-9
+      "[9999]9{8}[-]9"
+      // Caixa longer: (0001)12345678-9
+    ],
+    placeholder: "",
+    greedy: false
+  },
+  "br-bank-agency": {
+    mask: "9{1,5}[-][9]",
+    // Agency numbers: 1234, 12345, 1234-5
+    placeholder: ""
   }
 };
 function getMaskOptions(mask, _options) {
@@ -3842,5 +3861,5 @@ inputmask/dist/inputmask.js:
 */
 
 export { applyMaskToElement, flow, isServer_default, makeMaskCacheKey, resolveInputRef, setPrevRef, withMask };
-//# sourceMappingURL=chunk-QCWLMMDI.js.map
-//# sourceMappingURL=chunk-QCWLMMDI.js.map
+//# sourceMappingURL=chunk-ICLWBMH4.js.map
+//# sourceMappingURL=chunk-ICLWBMH4.js.map