Skip to content

Commit 8c3a059

Browse files
authored
Merge pull request #23 from NickGard/add-documentation
Add documentation for isRevealingMask
2 parents 92c259a + 71dab68 commit 8c3a059

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -181,6 +181,15 @@ An optional initial value for the mask.
181181

182182
An optional default selection - defaults to `{start: 0, end: 0}`, placing the cursor before the first character.
183183

184+
### `isRevealingMask` : `boolean`
185+
186+
An optional property that, if true, progressively shows the mask as input is entered. Defaults to `false`
187+
188+
Example:
189+
Given an input with a mask of '111-1111 x 111', a value of '47', and `isRevealingMask` set to `true`, then the input's value is formatted as '47'
190+
Given the same input but with a value of '476', then the input's value is formatted as '476-'
191+
Given the same input but with a value of '47 3191', then the input's value is formatted as '47_-3191 x '
192+
184193
## `InputMask` editing methods
185194

186195
Editing methods will not allow the string being edited to contain invalid values according to the mask's pattern.

0 commit comments

Comments
 (0)