use-mask-input 3.7.3 → 3.8.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +34 -0
- package/README.md +58 -30
- package/dist/antd.cjs +15 -9
- package/dist/antd.cjs.map +1 -1
- package/dist/antd.d.cts +1 -1
- package/dist/antd.d.ts +1 -1
- package/dist/antd.js +8 -2
- package/dist/antd.js.map +1 -1
- package/dist/{chunk-QCWLMMDI.js → chunk-ICLWBMH4.js} +21 -2
- package/dist/{chunk-QCWLMMDI.js.map → chunk-ICLWBMH4.js.map} +1 -1
- package/dist/{chunk-VK6LQ75W.cjs → chunk-X5SEJVSB.cjs} +21 -2
- package/dist/{chunk-VK6LQ75W.cjs.map → chunk-X5SEJVSB.cjs.map} +1 -1
- package/dist/{index-F3rlTTTe.d.cts → index-S8txl6uK.d.cts} +3 -3
- package/dist/{index-F3rlTTTe.d.ts → index-S8txl6uK.d.ts} +3 -3
- package/dist/index.cjs +41 -21
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +30 -10
- package/dist/index.js.map +1 -1
- package/package.json +15 -25
- package/src/antd/useHookFormMaskAntd.spec.ts +2 -0
- package/src/antd/useMaskInputAntd.spec.tsx +3 -3
- package/src/antd/useMaskInputAntd.ts +10 -2
- package/src/api/useHookFormMask.spec.ts +52 -5
- package/src/api/useHookFormMask.ts +49 -9
- package/src/api/useMaskInput.spec.tsx +11 -11
- package/src/api/withHookFormMask.spec.ts +7 -7
- package/src/api/withMask.spec.ts +6 -6
- package/src/core/maskConfig.spec.ts +24 -0
- package/src/core/maskConfig.ts +14 -0
- package/src/types/index.ts +2 -0
- package/src/types/inputmask.types.ts +2 -2
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,39 @@
|
|
|
1
1
|
## [3.6.0](https://github.com/eduardoborges/use-mask-input/compare/3.5.2...3.6.0) (2026-01-13)
|
|
2
2
|
|
|
3
|
+
## 3.8.0
|
|
4
|
+
|
|
5
|
+
### Minor Changes
|
|
6
|
+
|
|
7
|
+
- eacce0f: feat: add Brazilian banking masks (br-bank-account and br-bank-agency)
|
|
8
|
+
|
|
9
|
+
Added two new mask aliases for Brazilian banking information:
|
|
10
|
+
|
|
11
|
+
- `br-bank-account`: Supports multiple Brazilian bank account formats including Bradesco, Itaú, Banco do Brasil, Caixa Econômica, Nubank, and more
|
|
12
|
+
- `br-bank-agency`: Handles Brazilian bank agency numbers with optional check digits
|
|
13
|
+
|
|
14
|
+
These masks automatically adapt to different account number formats used by major Brazilian banks, making it easier to handle banking data in forms.
|
|
15
|
+
|
|
16
|
+
Example usage:
|
|
17
|
+
|
|
18
|
+
```tsx
|
|
19
|
+
const accountMask = useMaskInput({ mask: "br-bank-account" });
|
|
20
|
+
const agencyMask = useMaskInput({ mask: "br-bank-agency" });
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
### Patch Changes
|
|
24
|
+
|
|
25
|
+
- a614d93: fix: sync DOM value after react-hook-form `reset()` in `useHookFormMask`
|
|
26
|
+
|
|
27
|
+
`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()`.
|
|
28
|
+
|
|
29
|
+
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.
|
|
30
|
+
|
|
31
|
+
## 3.7.4
|
|
32
|
+
|
|
33
|
+
### Patch Changes
|
|
34
|
+
|
|
35
|
+
- 7f85587: (antd) prevent unnecessary masking function calls by tracking the current masked element reference
|
|
36
|
+
|
|
3
37
|
## 3.7.3
|
|
4
38
|
|
|
5
39
|
### Patch Changes
|
package/README.md
CHANGED
|
@@ -1,62 +1,90 @@
|
|
|
1
1
|
<div align="center">
|
|
2
|
-
<h1
|
|
3
|
-
<
|
|
2
|
+
<h1>use-mask-input</h1>
|
|
3
|
+
<p>Input masks for React. Simple, lightweight, and framework-friendly.</p>
|
|
4
4
|
|
|
5
5
|
[](https://www.npmjs.com/package/use-mask-input)
|
|
6
6
|
[](https://www.npmjs.com/package/use-mask-input)
|
|
7
|
-
[](https://bundlejs.com/?q=use-mask-input)
|
|
8
8
|
[](https://codecov.io/gh/eduardoborges/use-mask-input)
|
|
9
|
+
|
|
10
|
+
[](https://ko-fi.com/E1E71VQENQ)
|
|
9
11
|
</div>
|
|
10
12
|
|
|
11
|
-
|
|
13
|
+
---
|
|
14
|
+
|
|
15
|
+
**[Documentation](http://use-mask-input.eduardoborges.dev)** · **[API Reference](http://use-mask-input.eduardoborges.dev/api-reference)** · **[Sponsor](https://ko-fi.com/E1E71VQENQ)**
|
|
12
16
|
|
|
13
|
-
## Features
|
|
14
|
-
- 🎯 Simple API
|
|
15
|
-
- 💎 Works like a charm with *Next.js*
|
|
16
|
-
- ✨ Compatible with [React Hook Form](https://github.com/react-hook-form/react-hook-form)
|
|
17
|
-
- 🏁 Compatible with [React Final Form](https://github.com/final-form/react-final-form)
|
|
18
17
|
## Install
|
|
19
18
|
|
|
20
19
|
```sh
|
|
21
|
-
npm
|
|
20
|
+
npm install use-mask-input
|
|
22
21
|
```
|
|
23
22
|
|
|
24
|
-
##
|
|
23
|
+
## Usage
|
|
25
24
|
|
|
26
|
-
```
|
|
27
|
-
import React from 'react'
|
|
25
|
+
```tsx
|
|
28
26
|
import { useMaskInput } from 'use-mask-input';
|
|
29
27
|
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
)
|
|
28
|
+
function PhoneInput() {
|
|
29
|
+
const ref = useMaskInput({ mask: '(99) 99999-9999' });
|
|
30
|
+
return <input ref={ref} />;
|
|
34
31
|
}
|
|
35
32
|
```
|
|
36
33
|
|
|
37
|
-
###
|
|
34
|
+
### With React Hook Form
|
|
38
35
|
|
|
39
|
-
```
|
|
40
|
-
import React from 'react';
|
|
36
|
+
```tsx
|
|
41
37
|
import { useForm } from 'react-hook-form';
|
|
42
38
|
import { useHookFormMask } from 'use-mask-input';
|
|
43
39
|
|
|
44
|
-
function
|
|
40
|
+
function MyForm() {
|
|
45
41
|
const { register, handleSubmit } = useForm();
|
|
46
42
|
const registerWithMask = useHookFormMask(register);
|
|
47
43
|
|
|
48
|
-
...
|
|
49
|
-
|
|
50
44
|
return (
|
|
51
|
-
<form onSubmit={
|
|
52
|
-
<input
|
|
53
|
-
|
|
54
|
-
required: true
|
|
55
|
-
})}
|
|
56
|
-
type="text"
|
|
57
|
-
/>
|
|
45
|
+
<form onSubmit={handleSubmit(console.log)}>
|
|
46
|
+
<input {...registerWithMask('phone', '(99) 99999-9999')} />
|
|
47
|
+
<input {...registerWithMask('cpf', 'cpf')} />
|
|
58
48
|
<button type="submit">Submit</button>
|
|
59
49
|
</form>
|
|
60
50
|
);
|
|
61
51
|
}
|
|
62
52
|
```
|
|
53
|
+
|
|
54
|
+
### With Ant Design
|
|
55
|
+
|
|
56
|
+
```tsx
|
|
57
|
+
import { Input } from 'antd';
|
|
58
|
+
import { useMaskInputAntd } from 'use-mask-input/antd';
|
|
59
|
+
|
|
60
|
+
function CPFInput() {
|
|
61
|
+
const ref = useMaskInputAntd({ mask: 'cpf' });
|
|
62
|
+
return <Input ref={ref} />;
|
|
63
|
+
}
|
|
64
|
+
```
|
|
65
|
+
|
|
66
|
+
## APIs
|
|
67
|
+
|
|
68
|
+
| API | Description |
|
|
69
|
+
|-----|-------------|
|
|
70
|
+
| `useMaskInput` | Hook. Returns a ref callback. Default choice. |
|
|
71
|
+
| `useHookFormMask` | Hook. Wraps React Hook Form's `register`. |
|
|
72
|
+
| `withMask` | Function. Ref callback. Requires `React.memo`. |
|
|
73
|
+
| `withHookFormMask` | Function. Mask for registered fields. Requires `React.memo`. |
|
|
74
|
+
| `useMaskInputAntd` | Hook. `useMaskInput` for Ant Design. |
|
|
75
|
+
| `useHookFormMaskAntd` | Hook. `useHookFormMask` for Ant Design. |
|
|
76
|
+
|
|
77
|
+
## Built-in Aliases
|
|
78
|
+
|
|
79
|
+
`cpf` · `cnpj` · `br-bank-account` · `br-bank-agency` · `currency` · `brl-currency` · `datetime` · `email` · `numeric` · `decimal` · `integer` · `percentage` · `url` · `ip` · `mac` · `ssn`
|
|
80
|
+
|
|
81
|
+
## Works With
|
|
82
|
+
|
|
83
|
+
- React Hook Form
|
|
84
|
+
- Ant Design
|
|
85
|
+
- React Final Form
|
|
86
|
+
- Next.js / SSR
|
|
87
|
+
|
|
88
|
+
## License
|
|
89
|
+
|
|
90
|
+
MIT
|
package/dist/antd.cjs
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
'use strict';
|
|
2
2
|
|
|
3
|
-
var
|
|
3
|
+
var chunkX5SEJVSB_cjs = require('./chunk-X5SEJVSB.cjs');
|
|
4
4
|
var react = require('react');
|
|
5
5
|
|
|
6
6
|
function useHookFormMaskAntd(registerFn) {
|
|
@@ -10,11 +10,11 @@ function useHookFormMaskAntd(registerFn) {
|
|
|
10
10
|
if (!registerFn) throw new Error("registerFn is required");
|
|
11
11
|
const registerReturn = registerFn(fieldName, options);
|
|
12
12
|
const { ref } = registerReturn;
|
|
13
|
-
const cacheKey =
|
|
13
|
+
const cacheKey = chunkX5SEJVSB_cjs.makeMaskCacheKey(fieldName, mask);
|
|
14
14
|
if (!refCache.has(cacheKey)) {
|
|
15
15
|
const refWithMask = (inputRef) => {
|
|
16
|
-
const element = inputRef ?
|
|
17
|
-
if (element)
|
|
16
|
+
const element = inputRef ? chunkX5SEJVSB_cjs.resolveInputRef(inputRef.input) : null;
|
|
17
|
+
if (element) chunkX5SEJVSB_cjs.applyMaskToElement(element, mask, options);
|
|
18
18
|
if (ref) ref(element);
|
|
19
19
|
};
|
|
20
20
|
refCache.set(cacheKey, refWithMask);
|
|
@@ -23,7 +23,7 @@ function useHookFormMaskAntd(registerFn) {
|
|
|
23
23
|
...registerReturn,
|
|
24
24
|
ref: refCache.get(cacheKey)
|
|
25
25
|
};
|
|
26
|
-
|
|
26
|
+
chunkX5SEJVSB_cjs.setPrevRef(result, ref);
|
|
27
27
|
return result;
|
|
28
28
|
};
|
|
29
29
|
}, [registerFn]);
|
|
@@ -33,19 +33,25 @@ function useMaskInputAntd(props) {
|
|
|
33
33
|
const ref = react.useRef(null);
|
|
34
34
|
const maskRef = react.useRef(mask);
|
|
35
35
|
const optionsRef = react.useRef(options);
|
|
36
|
+
const maskedElementRef = react.useRef(null);
|
|
37
|
+
maskRef.current = mask;
|
|
38
|
+
optionsRef.current = options;
|
|
36
39
|
const refCallback = react.useCallback((input) => {
|
|
37
40
|
if (!input) {
|
|
38
41
|
ref.current = null;
|
|
39
42
|
return;
|
|
40
43
|
}
|
|
41
|
-
ref.current =
|
|
42
|
-
|
|
44
|
+
ref.current = chunkX5SEJVSB_cjs.resolveInputRef(input.input);
|
|
45
|
+
if (ref.current && ref.current !== maskedElementRef.current) {
|
|
46
|
+
chunkX5SEJVSB_cjs.withMask(maskRef.current, optionsRef.current)(ref.current);
|
|
47
|
+
maskedElementRef.current = ref.current;
|
|
48
|
+
}
|
|
43
49
|
}, []);
|
|
44
50
|
react.useEffect(() => {
|
|
45
|
-
if (
|
|
51
|
+
if (chunkX5SEJVSB_cjs.isServer_default || !ref.current || !register) return;
|
|
46
52
|
register(ref.current);
|
|
47
53
|
}, [register]);
|
|
48
|
-
if (
|
|
54
|
+
if (chunkX5SEJVSB_cjs.isServer_default) {
|
|
49
55
|
return () => {
|
|
50
56
|
};
|
|
51
57
|
}
|
package/dist/antd.cjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/antd/useHookFormMaskAntd.ts","../src/antd/useMaskInputAntd.ts"],"names":["useMemo","makeMaskCacheKey","resolveInputRef","applyMaskToElement","setPrevRef","useRef","useCallback","withMask","useEffect","isServer_default"],"mappings":";;;;;AA6Be,SAAR,oBAEL,UAAA,EAC6D;AAE7D,EAAA,OAAOA,cAAQ,MAAM;AACnB,IAAA,MAAM,QAAA,uBAAe,GAAA,EAA0C;AAE/D,IAAA,OAAO,CAAC,SAAA,EAAoB,IAAA,EAAY,OAAA,KACuB;AAC7D,MAAA,IAAI,CAAC,UAAA,EAAY,MAAM,IAAI,MAAM,wBAAwB,CAAA;AAEzD,MAAA,MAAM,cAAA,GAAiB,UAAA,CAAW,SAAA,EAAW,OAAkB,CAAA;AAC/D,MAAA,MAAM,EAAE,KAAI,GAAI,cAAA;AAEhB,MAAA,MAAM,QAAA,GAAWC,kCAAA,CAAiB,SAAA,EAAW,IAAI,CAAA;AAEjD,MAAA,IAAI,CAAC,QAAA,CAAS,GAAA,CAAI,QAAQ,CAAA,EAAG;AAC3B,QAAA,MAAM,WAAA,GAA4C,CAAC,QAAA,KAAa;AAC9D,UAAA,MAAM,OAAA,GAAU,QAAA,GAAWC,iCAAA,CAAgB,QAAA,CAAS,KAAK,CAAA,GAAI,IAAA;AAC7D,UAAA,IAAI,OAAA,EAASC,oCAAA,CAAmB,OAAA,EAAS,IAAA,EAAM,OAAkB,CAAA;AACjE,UAAA,IAAI,GAAA,MAAS,OAAO,CAAA;AAAA,QACtB,CAAA;AACA,QAAA,QAAA,CAAS,GAAA,CAAI,UAAU,WAAW,CAAA;AAAA,MACpC;AAEA,MAAA,MAAM,MAAA,GAAS;AAAA,QACb,GAAG,cAAA;AAAA,QACH,GAAA,EAAK,QAAA,CAAS,GAAA,CAAI,QAAQ;AAAA,OAC5B;AAEA,MAAAC,4BAAA,CAAW,QAAQ,GAAG,CAAA;AAEtB,MAAA,OAAO,MAAA;AAAA,IACT,CAAA;AAAA,EACF,CAAA,EAAG,CAAC,UAAU,CAAC,CAAA;AACjB;ACxCe,SAAR,iBAAkC,KAAA,EAE/B;AACR,EAAA,MAAM,EAAE,IAAA,EAAM,QAAA,EAAU,OAAA,EAAQ,GAAI,KAAA;AACpC,EAAA,MAAM,GAAA,GAAMC,aAAgC,IAAI,CAAA;AAChD,EAAA,MAAM,OAAA,GAAUA,aAAO,IAAI,CAAA;AAC3B,EAAA,MAAM,UAAA,GAAaA,aAAO,OAAO,CAAA;
|
|
1
|
+
{"version":3,"sources":["../src/antd/useHookFormMaskAntd.ts","../src/antd/useMaskInputAntd.ts"],"names":["useMemo","makeMaskCacheKey","resolveInputRef","applyMaskToElement","setPrevRef","useRef","useCallback","withMask","useEffect","isServer_default"],"mappings":";;;;;AA6Be,SAAR,oBAEL,UAAA,EAC6D;AAE7D,EAAA,OAAOA,cAAQ,MAAM;AACnB,IAAA,MAAM,QAAA,uBAAe,GAAA,EAA0C;AAE/D,IAAA,OAAO,CAAC,SAAA,EAAoB,IAAA,EAAY,OAAA,KACuB;AAC7D,MAAA,IAAI,CAAC,UAAA,EAAY,MAAM,IAAI,MAAM,wBAAwB,CAAA;AAEzD,MAAA,MAAM,cAAA,GAAiB,UAAA,CAAW,SAAA,EAAW,OAAkB,CAAA;AAC/D,MAAA,MAAM,EAAE,KAAI,GAAI,cAAA;AAEhB,MAAA,MAAM,QAAA,GAAWC,kCAAA,CAAiB,SAAA,EAAW,IAAI,CAAA;AAEjD,MAAA,IAAI,CAAC,QAAA,CAAS,GAAA,CAAI,QAAQ,CAAA,EAAG;AAC3B,QAAA,MAAM,WAAA,GAA4C,CAAC,QAAA,KAAa;AAC9D,UAAA,MAAM,OAAA,GAAU,QAAA,GAAWC,iCAAA,CAAgB,QAAA,CAAS,KAAK,CAAA,GAAI,IAAA;AAC7D,UAAA,IAAI,OAAA,EAASC,oCAAA,CAAmB,OAAA,EAAS,IAAA,EAAM,OAAkB,CAAA;AACjE,UAAA,IAAI,GAAA,MAAS,OAAO,CAAA;AAAA,QACtB,CAAA;AACA,QAAA,QAAA,CAAS,GAAA,CAAI,UAAU,WAAW,CAAA;AAAA,MACpC;AAEA,MAAA,MAAM,MAAA,GAAS;AAAA,QACb,GAAG,cAAA;AAAA,QACH,GAAA,EAAK,QAAA,CAAS,GAAA,CAAI,QAAQ;AAAA,OAC5B;AAEA,MAAAC,4BAAA,CAAW,QAAQ,GAAG,CAAA;AAEtB,MAAA,OAAO,MAAA;AAAA,IACT,CAAA;AAAA,EACF,CAAA,EAAG,CAAC,UAAU,CAAC,CAAA;AACjB;ACxCe,SAAR,iBAAkC,KAAA,EAE/B;AACR,EAAA,MAAM,EAAE,IAAA,EAAM,QAAA,EAAU,OAAA,EAAQ,GAAI,KAAA;AACpC,EAAA,MAAM,GAAA,GAAMC,aAAgC,IAAI,CAAA;AAChD,EAAA,MAAM,OAAA,GAAUA,aAAO,IAAI,CAAA;AAC3B,EAAA,MAAM,UAAA,GAAaA,aAAO,OAAO,CAAA;AACjC,EAAA,MAAM,gBAAA,GAAmBA,aAAgC,IAAI,CAAA;AAE7D,EAAA,OAAA,CAAQ,OAAA,GAAU,IAAA;AAClB,EAAA,UAAA,CAAW,OAAA,GAAU,OAAA;AAErB,EAAA,MAAM,WAAA,GAAcC,iBAAA,CAAY,CAAC,KAAA,KAAiC;AAChE,IAAA,IAAI,CAAC,KAAA,EAAO;AACV,MAAA,GAAA,CAAI,OAAA,GAAU,IAAA;AACd,MAAA;AAAA,IACF;AAEA,IAAA,GAAA,CAAI,OAAA,GAAUJ,iCAAA,CAAgB,KAAA,CAAM,KAAK,CAAA;AAEzC,IAAA,IAAI,GAAA,CAAI,OAAA,IAAW,GAAA,CAAI,OAAA,KAAY,iBAAiB,OAAA,EAAS;AAC3D,MAAAK,0BAAA,CAAS,QAAQ,OAAA,EAAS,UAAA,CAAW,OAAO,CAAA,CAAE,IAAI,OAAO,CAAA;AACzD,MAAA,gBAAA,CAAiB,UAAU,GAAA,CAAI,OAAA;AAAA,IACjC;AAAA,EACF,CAAA,EAAG,EAAE,CAAA;AAEL,EAAAC,eAAA,CAAU,MAAM;AACd,IAAA,IAAIC,kCAAA,IAAY,CAAC,GAAA,CAAI,OAAA,IAAW,CAAC,QAAA,EAAU;AAC3C,IAAA,QAAA,CAAS,IAAI,OAAO,CAAA;AAAA,EACtB,CAAA,EAAG,CAAC,QAAQ,CAAC,CAAA;AAEb,EAAA,IAAIA,kCAAA,EAAU;AACZ,IAAA,OAAO,MAAY;AAAA,IAEnB,CAAA;AAAA,EACF;AAEA,EAAA,OAAO,WAAA;AACT","file":"antd.cjs","sourcesContent":["import { useMemo } from 'react';\n\nimport { applyMaskToElement, resolveInputRef } from '../core';\nimport { makeMaskCacheKey, setPrevRef } from '../utils';\n\nimport type { InputRef } from 'antd';\nimport type { RefCallback } from 'react';\nimport type {\n FieldValues, Path,\n RegisterOptions,\n UseFormRegister,\n} from 'react-hook-form';\n\nimport type { Mask, Options, UseHookFormMaskReturn } from '../types';\n\nexport type UseHookFormMaskAntdReturn<T extends FieldValues> = Omit<\n UseHookFormMaskReturn<T>,\n 'ref'\n> & { ref: RefCallback<InputRef | null> };\n\n/**\n * Ant Design version of useHookFormMask.\n * Creates a masked register that works with Ant Design Input (ref receives InputRef).\n *\n * @template T - The form data type\n * @template D - The register options type\n * @param registerFn - The register function from useForm hook\n * @returns A function that registers a field with mask support for Ant Design Input\n */\nexport default function useHookFormMaskAntd<\n T extends FieldValues, D extends RegisterOptions,\n>(registerFn: UseFormRegister<T>): ((fieldName: Path<T>, mask: Mask, options?: (\n D & Options) | Options | D) => UseHookFormMaskAntdReturn<T>) {\n //\n return useMemo(() => {\n const refCache = new Map<string, RefCallback<InputRef | null>>();\n\n return (fieldName: Path<T>, mask: Mask, options?: (\n D & Options) | Options | D): UseHookFormMaskAntdReturn<T> => {\n if (!registerFn) throw new Error('registerFn is required');\n\n const registerReturn = registerFn(fieldName, options as Options);\n const { ref } = registerReturn as UseHookFormMaskReturn<T>;\n\n const cacheKey = makeMaskCacheKey(fieldName, mask);\n\n if (!refCache.has(cacheKey)) {\n const refWithMask: RefCallback<InputRef | null> = (inputRef) => {\n const element = inputRef ? resolveInputRef(inputRef.input) : null;\n if (element) applyMaskToElement(element, mask, options as Options);\n if (ref) ref(element);\n };\n refCache.set(cacheKey, refWithMask);\n }\n\n const result = {\n ...registerReturn,\n ref: refCache.get(cacheKey),\n } as UseHookFormMaskAntdReturn<T>;\n\n setPrevRef(result, ref);\n\n return result;\n };\n }, [registerFn]);\n}\n","import { useCallback, useEffect, useRef } from 'react';\n\nimport withMask from '../api/withMask';\nimport { resolveInputRef } from '../core';\nimport isServer from '../utils/isServer';\n\nimport type { InputRef } from 'antd';\n\nimport type { Mask, Options } from '../types';\n\ninterface UseMaskInputOptions {\n mask: Mask;\n register?: (element: HTMLElement) => void;\n options?: Options;\n}\n\n/**\n * React hook for applying input masks to Ant Design form elements.\n *\n * @param props - Configuration object\n * @param props.mask - The mask pattern to apply\n * @param props.register - Optional callback that receives the element\n * @param props.options - Optional mask configuration options\n * @returns A ref callback function to attach to the Ant Design Input element\n */\nexport default function useMaskInputAntd(props: UseMaskInputOptions): (\n input: InputRef | null\n) => void {\n const { mask, register, options } = props;\n const ref = useRef<HTMLInputElement | null>(null);\n const maskRef = useRef(mask);\n const optionsRef = useRef(options);\n const maskedElementRef = useRef<HTMLInputElement | null>(null);\n\n maskRef.current = mask;\n optionsRef.current = options;\n\n const refCallback = useCallback((input: InputRef | null): void => {\n if (!input) {\n ref.current = null;\n return;\n }\n\n ref.current = resolveInputRef(input.input);\n\n if (ref.current && ref.current !== maskedElementRef.current) {\n withMask(maskRef.current, optionsRef.current)(ref.current);\n maskedElementRef.current = ref.current;\n }\n }, []);\n\n useEffect(() => {\n if (isServer || !ref.current || !register) return;\n register(ref.current);\n }, [register]);\n\n if (isServer) {\n return (): void => {\n // server doesn't have dom, so just do nothing\n };\n }\n\n return refCallback;\n}\n"]}
|
package/dist/antd.d.cts
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { InputRef } from 'antd';
|
|
2
2
|
import { RefCallback } from 'react';
|
|
3
3
|
import { FieldValues, RegisterOptions, UseFormRegister, Path } from 'react-hook-form';
|
|
4
|
-
import { U as UseHookFormMaskReturn, M as Mask, O as Options } from './index-
|
|
4
|
+
import { U as UseHookFormMaskReturn, M as Mask, O as Options } from './index-S8txl6uK.cjs';
|
|
5
5
|
|
|
6
6
|
type UseHookFormMaskAntdReturn<T extends FieldValues> = Omit<UseHookFormMaskReturn<T>, 'ref'> & {
|
|
7
7
|
ref: RefCallback<InputRef | null>;
|
package/dist/antd.d.ts
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { InputRef } from 'antd';
|
|
2
2
|
import { RefCallback } from 'react';
|
|
3
3
|
import { FieldValues, RegisterOptions, UseFormRegister, Path } from 'react-hook-form';
|
|
4
|
-
import { U as UseHookFormMaskReturn, M as Mask, O as Options } from './index-
|
|
4
|
+
import { U as UseHookFormMaskReturn, M as Mask, O as Options } from './index-S8txl6uK.js';
|
|
5
5
|
|
|
6
6
|
type UseHookFormMaskAntdReturn<T extends FieldValues> = Omit<UseHookFormMaskReturn<T>, 'ref'> & {
|
|
7
7
|
ref: RefCallback<InputRef | null>;
|
package/dist/antd.js
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { makeMaskCacheKey, setPrevRef, resolveInputRef, withMask, isServer_default, applyMaskToElement } from './chunk-
|
|
1
|
+
import { makeMaskCacheKey, setPrevRef, resolveInputRef, withMask, isServer_default, applyMaskToElement } from './chunk-ICLWBMH4.js';
|
|
2
2
|
import { useMemo, useRef, useCallback, useEffect } from 'react';
|
|
3
3
|
|
|
4
4
|
function useHookFormMaskAntd(registerFn) {
|
|
@@ -31,13 +31,19 @@ function useMaskInputAntd(props) {
|
|
|
31
31
|
const ref = useRef(null);
|
|
32
32
|
const maskRef = useRef(mask);
|
|
33
33
|
const optionsRef = useRef(options);
|
|
34
|
+
const maskedElementRef = useRef(null);
|
|
35
|
+
maskRef.current = mask;
|
|
36
|
+
optionsRef.current = options;
|
|
34
37
|
const refCallback = useCallback((input) => {
|
|
35
38
|
if (!input) {
|
|
36
39
|
ref.current = null;
|
|
37
40
|
return;
|
|
38
41
|
}
|
|
39
42
|
ref.current = resolveInputRef(input.input);
|
|
40
|
-
|
|
43
|
+
if (ref.current && ref.current !== maskedElementRef.current) {
|
|
44
|
+
withMask(maskRef.current, optionsRef.current)(ref.current);
|
|
45
|
+
maskedElementRef.current = ref.current;
|
|
46
|
+
}
|
|
41
47
|
}, []);
|
|
42
48
|
useEffect(() => {
|
|
43
49
|
if (isServer_default || !ref.current || !register) return;
|
package/dist/antd.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/antd/useHookFormMaskAntd.ts","../src/antd/useMaskInputAntd.ts"],"names":[],"mappings":";;;AA6Be,SAAR,oBAEL,UAAA,EAC6D;AAE7D,EAAA,OAAO,QAAQ,MAAM;AACnB,IAAA,MAAM,QAAA,uBAAe,GAAA,EAA0C;AAE/D,IAAA,OAAO,CAAC,SAAA,EAAoB,IAAA,EAAY,OAAA,KACuB;AAC7D,MAAA,IAAI,CAAC,UAAA,EAAY,MAAM,IAAI,MAAM,wBAAwB,CAAA;AAEzD,MAAA,MAAM,cAAA,GAAiB,UAAA,CAAW,SAAA,EAAW,OAAkB,CAAA;AAC/D,MAAA,MAAM,EAAE,KAAI,GAAI,cAAA;AAEhB,MAAA,MAAM,QAAA,GAAW,gBAAA,CAAiB,SAAA,EAAW,IAAI,CAAA;AAEjD,MAAA,IAAI,CAAC,QAAA,CAAS,GAAA,CAAI,QAAQ,CAAA,EAAG;AAC3B,QAAA,MAAM,WAAA,GAA4C,CAAC,QAAA,KAAa;AAC9D,UAAA,MAAM,OAAA,GAAU,QAAA,GAAW,eAAA,CAAgB,QAAA,CAAS,KAAK,CAAA,GAAI,IAAA;AAC7D,UAAA,IAAI,OAAA,EAAS,kBAAA,CAAmB,OAAA,EAAS,IAAA,EAAM,OAAkB,CAAA;AACjE,UAAA,IAAI,GAAA,MAAS,OAAO,CAAA;AAAA,QACtB,CAAA;AACA,QAAA,QAAA,CAAS,GAAA,CAAI,UAAU,WAAW,CAAA;AAAA,MACpC;AAEA,MAAA,MAAM,MAAA,GAAS;AAAA,QACb,GAAG,cAAA;AAAA,QACH,GAAA,EAAK,QAAA,CAAS,GAAA,CAAI,QAAQ;AAAA,OAC5B;AAEA,MAAA,UAAA,CAAW,QAAQ,GAAG,CAAA;AAEtB,MAAA,OAAO,MAAA;AAAA,IACT,CAAA;AAAA,EACF,CAAA,EAAG,CAAC,UAAU,CAAC,CAAA;AACjB;ACxCe,SAAR,iBAAkC,KAAA,EAE/B;AACR,EAAA,MAAM,EAAE,IAAA,EAAM,QAAA,EAAU,OAAA,EAAQ,GAAI,KAAA;AACpC,EAAA,MAAM,GAAA,GAAM,OAAgC,IAAI,CAAA;AAChD,EAAA,MAAM,OAAA,GAAU,OAAO,IAAI,CAAA;AAC3B,EAAA,MAAM,UAAA,GAAa,OAAO,OAAO,CAAA;
|
|
1
|
+
{"version":3,"sources":["../src/antd/useHookFormMaskAntd.ts","../src/antd/useMaskInputAntd.ts"],"names":[],"mappings":";;;AA6Be,SAAR,oBAEL,UAAA,EAC6D;AAE7D,EAAA,OAAO,QAAQ,MAAM;AACnB,IAAA,MAAM,QAAA,uBAAe,GAAA,EAA0C;AAE/D,IAAA,OAAO,CAAC,SAAA,EAAoB,IAAA,EAAY,OAAA,KACuB;AAC7D,MAAA,IAAI,CAAC,UAAA,EAAY,MAAM,IAAI,MAAM,wBAAwB,CAAA;AAEzD,MAAA,MAAM,cAAA,GAAiB,UAAA,CAAW,SAAA,EAAW,OAAkB,CAAA;AAC/D,MAAA,MAAM,EAAE,KAAI,GAAI,cAAA;AAEhB,MAAA,MAAM,QAAA,GAAW,gBAAA,CAAiB,SAAA,EAAW,IAAI,CAAA;AAEjD,MAAA,IAAI,CAAC,QAAA,CAAS,GAAA,CAAI,QAAQ,CAAA,EAAG;AAC3B,QAAA,MAAM,WAAA,GAA4C,CAAC,QAAA,KAAa;AAC9D,UAAA,MAAM,OAAA,GAAU,QAAA,GAAW,eAAA,CAAgB,QAAA,CAAS,KAAK,CAAA,GAAI,IAAA;AAC7D,UAAA,IAAI,OAAA,EAAS,kBAAA,CAAmB,OAAA,EAAS,IAAA,EAAM,OAAkB,CAAA;AACjE,UAAA,IAAI,GAAA,MAAS,OAAO,CAAA;AAAA,QACtB,CAAA;AACA,QAAA,QAAA,CAAS,GAAA,CAAI,UAAU,WAAW,CAAA;AAAA,MACpC;AAEA,MAAA,MAAM,MAAA,GAAS;AAAA,QACb,GAAG,cAAA;AAAA,QACH,GAAA,EAAK,QAAA,CAAS,GAAA,CAAI,QAAQ;AAAA,OAC5B;AAEA,MAAA,UAAA,CAAW,QAAQ,GAAG,CAAA;AAEtB,MAAA,OAAO,MAAA;AAAA,IACT,CAAA;AAAA,EACF,CAAA,EAAG,CAAC,UAAU,CAAC,CAAA;AACjB;ACxCe,SAAR,iBAAkC,KAAA,EAE/B;AACR,EAAA,MAAM,EAAE,IAAA,EAAM,QAAA,EAAU,OAAA,EAAQ,GAAI,KAAA;AACpC,EAAA,MAAM,GAAA,GAAM,OAAgC,IAAI,CAAA;AAChD,EAAA,MAAM,OAAA,GAAU,OAAO,IAAI,CAAA;AAC3B,EAAA,MAAM,UAAA,GAAa,OAAO,OAAO,CAAA;AACjC,EAAA,MAAM,gBAAA,GAAmB,OAAgC,IAAI,CAAA;AAE7D,EAAA,OAAA,CAAQ,OAAA,GAAU,IAAA;AAClB,EAAA,UAAA,CAAW,OAAA,GAAU,OAAA;AAErB,EAAA,MAAM,WAAA,GAAc,WAAA,CAAY,CAAC,KAAA,KAAiC;AAChE,IAAA,IAAI,CAAC,KAAA,EAAO;AACV,MAAA,GAAA,CAAI,OAAA,GAAU,IAAA;AACd,MAAA;AAAA,IACF;AAEA,IAAA,GAAA,CAAI,OAAA,GAAU,eAAA,CAAgB,KAAA,CAAM,KAAK,CAAA;AAEzC,IAAA,IAAI,GAAA,CAAI,OAAA,IAAW,GAAA,CAAI,OAAA,KAAY,iBAAiB,OAAA,EAAS;AAC3D,MAAA,QAAA,CAAS,QAAQ,OAAA,EAAS,UAAA,CAAW,OAAO,CAAA,CAAE,IAAI,OAAO,CAAA;AACzD,MAAA,gBAAA,CAAiB,UAAU,GAAA,CAAI,OAAA;AAAA,IACjC;AAAA,EACF,CAAA,EAAG,EAAE,CAAA;AAEL,EAAA,SAAA,CAAU,MAAM;AACd,IAAA,IAAI,gBAAA,IAAY,CAAC,GAAA,CAAI,OAAA,IAAW,CAAC,QAAA,EAAU;AAC3C,IAAA,QAAA,CAAS,IAAI,OAAO,CAAA;AAAA,EACtB,CAAA,EAAG,CAAC,QAAQ,CAAC,CAAA;AAEb,EAAA,IAAI,gBAAA,EAAU;AACZ,IAAA,OAAO,MAAY;AAAA,IAEnB,CAAA;AAAA,EACF;AAEA,EAAA,OAAO,WAAA;AACT","file":"antd.js","sourcesContent":["import { useMemo } from 'react';\n\nimport { applyMaskToElement, resolveInputRef } from '../core';\nimport { makeMaskCacheKey, setPrevRef } from '../utils';\n\nimport type { InputRef } from 'antd';\nimport type { RefCallback } from 'react';\nimport type {\n FieldValues, Path,\n RegisterOptions,\n UseFormRegister,\n} from 'react-hook-form';\n\nimport type { Mask, Options, UseHookFormMaskReturn } from '../types';\n\nexport type UseHookFormMaskAntdReturn<T extends FieldValues> = Omit<\n UseHookFormMaskReturn<T>,\n 'ref'\n> & { ref: RefCallback<InputRef | null> };\n\n/**\n * Ant Design version of useHookFormMask.\n * Creates a masked register that works with Ant Design Input (ref receives InputRef).\n *\n * @template T - The form data type\n * @template D - The register options type\n * @param registerFn - The register function from useForm hook\n * @returns A function that registers a field with mask support for Ant Design Input\n */\nexport default function useHookFormMaskAntd<\n T extends FieldValues, D extends RegisterOptions,\n>(registerFn: UseFormRegister<T>): ((fieldName: Path<T>, mask: Mask, options?: (\n D & Options) | Options | D) => UseHookFormMaskAntdReturn<T>) {\n //\n return useMemo(() => {\n const refCache = new Map<string, RefCallback<InputRef | null>>();\n\n return (fieldName: Path<T>, mask: Mask, options?: (\n D & Options) | Options | D): UseHookFormMaskAntdReturn<T> => {\n if (!registerFn) throw new Error('registerFn is required');\n\n const registerReturn = registerFn(fieldName, options as Options);\n const { ref } = registerReturn as UseHookFormMaskReturn<T>;\n\n const cacheKey = makeMaskCacheKey(fieldName, mask);\n\n if (!refCache.has(cacheKey)) {\n const refWithMask: RefCallback<InputRef | null> = (inputRef) => {\n const element = inputRef ? resolveInputRef(inputRef.input) : null;\n if (element) applyMaskToElement(element, mask, options as Options);\n if (ref) ref(element);\n };\n refCache.set(cacheKey, refWithMask);\n }\n\n const result = {\n ...registerReturn,\n ref: refCache.get(cacheKey),\n } as UseHookFormMaskAntdReturn<T>;\n\n setPrevRef(result, ref);\n\n return result;\n };\n }, [registerFn]);\n}\n","import { useCallback, useEffect, useRef } from 'react';\n\nimport withMask from '../api/withMask';\nimport { resolveInputRef } from '../core';\nimport isServer from '../utils/isServer';\n\nimport type { InputRef } from 'antd';\n\nimport type { Mask, Options } from '../types';\n\ninterface UseMaskInputOptions {\n mask: Mask;\n register?: (element: HTMLElement) => void;\n options?: Options;\n}\n\n/**\n * React hook for applying input masks to Ant Design form elements.\n *\n * @param props - Configuration object\n * @param props.mask - The mask pattern to apply\n * @param props.register - Optional callback that receives the element\n * @param props.options - Optional mask configuration options\n * @returns A ref callback function to attach to the Ant Design Input element\n */\nexport default function useMaskInputAntd(props: UseMaskInputOptions): (\n input: InputRef | null\n) => void {\n const { mask, register, options } = props;\n const ref = useRef<HTMLInputElement | null>(null);\n const maskRef = useRef(mask);\n const optionsRef = useRef(options);\n const maskedElementRef = useRef<HTMLInputElement | null>(null);\n\n maskRef.current = mask;\n optionsRef.current = options;\n\n const refCallback = useCallback((input: InputRef | null): void => {\n if (!input) {\n ref.current = null;\n return;\n }\n\n ref.current = resolveInputRef(input.input);\n\n if (ref.current && ref.current !== maskedElementRef.current) {\n withMask(maskRef.current, optionsRef.current)(ref.current);\n maskedElementRef.current = ref.current;\n }\n }, []);\n\n useEffect(() => {\n if (isServer || !ref.current || !register) return;\n register(ref.current);\n }, [register]);\n\n if (isServer) {\n return (): void => {\n // server doesn't have dom, so just do nothing\n };\n }\n\n return refCallback;\n}\n"]}
|
|
@@ -3704,6 +3704,25 @@ var ALIAS_MASKS = {
|
|
|
3704
3704
|
cnpj: {
|
|
3705
3705
|
mask: ["A|9{2}.A|9{3}.A|9{3}/A|9{4}-9{2}"],
|
|
3706
3706
|
placeholder: "__.___.___/____-__"
|
|
3707
|
+
},
|
|
3708
|
+
"br-bank-account": {
|
|
3709
|
+
mask: [
|
|
3710
|
+
"9{4,10}[-]9",
|
|
3711
|
+
// Most common formats: 1234567-9, 12345678-9, 123456789-9, 1234567890-1
|
|
3712
|
+
"999999[-][9]",
|
|
3713
|
+
// Optional separator: 123456-7 or 1234567
|
|
3714
|
+
"[999]9{7,8}[-]9",
|
|
3715
|
+
// Caixa and Nu Pagamentos: (001)12345678-9 or (001)1234567-9
|
|
3716
|
+
"[9999]9{8}[-]9"
|
|
3717
|
+
// Caixa longer: (0001)12345678-9
|
|
3718
|
+
],
|
|
3719
|
+
placeholder: "",
|
|
3720
|
+
greedy: false
|
|
3721
|
+
},
|
|
3722
|
+
"br-bank-agency": {
|
|
3723
|
+
mask: "9{1,5}[-][9]",
|
|
3724
|
+
// Agency numbers: 1234, 12345, 1234-5
|
|
3725
|
+
placeholder: ""
|
|
3707
3726
|
}
|
|
3708
3727
|
};
|
|
3709
3728
|
function getMaskOptions(mask, _options) {
|
|
@@ -3842,5 +3861,5 @@ inputmask/dist/inputmask.js:
|
|
|
3842
3861
|
*/
|
|
3843
3862
|
|
|
3844
3863
|
export { applyMaskToElement, flow, isServer_default, makeMaskCacheKey, resolveInputRef, setPrevRef, withMask };
|
|
3845
|
-
//# sourceMappingURL=chunk-
|
|
3846
|
-
//# sourceMappingURL=chunk-
|
|
3864
|
+
//# sourceMappingURL=chunk-ICLWBMH4.js.map
|
|
3865
|
+
//# sourceMappingURL=chunk-ICLWBMH4.js.map
|