use-mask-input 3.3.8 → 3.4.0

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+# [3.4.0](https://github.com/eduardoborges/use-mask-input/compare/3.3.8...3.4.0) (2024-07-23)
+
+
+### Features
+
+* update mask type to match the avaliable types. ([#88](https://github.com/eduardoborges/use-mask-input/issues/88)) ([2e17b79](https://github.com/eduardoborges/use-mask-input/commit/2e17b794ec2290dde1a911e632ee0090663602a7))
+
 ## [3.3.8](https://github.com/eduardoborges/use-mask-input/compare/3.3.7...3.3.8) (2024-06-18)
 
 

package/README.md

@@ -1,6 +1,6 @@
 <div align="center">
   <h1>🥸 use-mask-input</h1>
-  <h4>A React Hook for build elegant and simple input masks.</h4>
+  <h4>A React Hook for building elegant and simple input masks.</h4>
 
   ![npm](https://img.shields.io/npm/v/use-mask-input) ![npm package minimized gzipped size (select exports)](https://img.shields.io/bundlejs/size/use-mask-input?color=green-light) ![npm](https://img.shields.io/npm/dw/use-mask-input)
 
@@ -103,7 +103,7 @@ function App() {
 
 ## Masking types
 
-The `mask` params cabe be
+The `mask` params can be
 
 ### Static Masking Type
 
@@ -160,7 +160,7 @@ By example:
 ```
 ### Alias Masking Type
 
-A Lot of common default "alises" presets, you can use like that:
+A Lot of common default "aliases" presets, you can use like that:
 ```tsx
 <input                         // the alias
   {...registerWithMask("date", "datetime", {
@@ -170,7 +170,7 @@ A Lot of common default "alises" presets, you can use like that:
 />
 ```
 
-You can use together with options like  `inputFormat`, `prefix`, `sufix`, etc. Checkout [API docs](#api)
+You can use together with options like  `inputFormat`, `prefix`, `suffix`, etc. Checkout [API docs](#api)
 
 The avaliable ones is:
 

package/dist/index.d.ts

@@ -577,7 +577,7 @@ interface CommandObject {
     rewritePosition?: number | undefined;
 }
 
-type Mask = 'email' | 'cpf' | 'datetime' | 'numeric' | 'currency' | 'decimal' | 'integer' | (string & {}) | (string[] & {}) | null;
+type Mask = 'datetime' | 'email' | 'numeric' | 'currency' | 'decimal' | 'integer' | 'percentage' | 'url' | 'ip' | 'mac' | 'ssn' | 'brl-currency' | 'cpf' | 'cnpj' | (string & {}) | (string[] & {}) | null;
 type Options = Options$1;
 type Input = HTMLInputElement | HTMLTextAreaElement | HTMLElement | HTMLInputElement | null;
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "use-mask-input",
-  "version": "3.3.8",
+  "version": "3.4.0",
   "description": "A react Hook for build elegant input masks. Compatible with React Hook Form",
   "author": "Eduardo Borges<euduardoborges@gmail.com>",
   "type": "module",

package/src/types.ts

@@ -2,6 +2,6 @@ import { Options as MaskOptions } from './inputmask.types';
 
 export type { UseFormRegister, UseFormRegisterReturn } from 'react-hook-form';
 
-export type Mask = 'email' | 'cpf' | 'datetime' | 'numeric' | 'currency' | 'decimal' | 'integer' | (string & {}) | (string[] & {}) | null;
+export type Mask = 'datetime' | 'email' | 'numeric' | 'currency' | 'decimal' | 'integer' | 'percentage' | 'url' | 'ip' | 'mac' | 'ssn' | 'brl-currency' | 'cpf' | 'cnpj' | (string & {}) | (string[] & {}) | null;
 export type Options = MaskOptions;
 export type Input = HTMLInputElement | HTMLTextAreaElement | HTMLElement | HTMLInputElement | null;