|
1 | | -# NGX-MASK |
| 1 | +<h1 align="center">NGX-MASK</h1> |
2 | 2 |
|
3 | 3 | <p align="center"> |
4 | | - A powerful Angular directive for input masking with customizable patterns |
| 4 | +A powerful Angular directive for input masking with customizable patterns |
5 | 5 | </p> |
6 | 6 |
|
7 | 7 | <p align="center"> |
|
38 | 38 | ## Table of Contents |
39 | 39 |
|
40 | 40 | - [Features](#features) |
41 | | - - [Flexible Masking Patterns](#flexible-masking-patterns) |
42 | | - - [Number Formatting](#number-formatting) |
43 | | - - [Advanced Input Control](#advanced-input-control) |
44 | | - - [Date and Time Formatting](#date-and-time-formatting) |
45 | | - - [Customization Options](#customization-options) |
46 | | - - [Form Integration](#form-integration) |
47 | | - - [User Experience](#user-experience) |
48 | 41 | - [Demo](#demo) |
49 | 42 | - [Installation](#installation) |
50 | 43 | - [Version Compatibility](#version-compatibility) |
|
56 | 49 |
|
57 | 50 | ## Features |
58 | 51 |
|
59 | | -NGX-MASK is a feature-rich input mask directive for Angular applications that helps you: |
| 52 | +NGX-MASK is a feature-rich input mask directive for Angular applications that provides: |
60 | 53 |
|
61 | | -### Flexible Masking Patterns |
| 54 | +<table> |
| 55 | +<tr> |
| 56 | +<td width="33%" valign="top"> |
62 | 57 |
|
63 | | -- Support for custom mask patterns and expressions |
64 | | -- Multiple mask patterns using OR operator (|) |
65 | | -- Built-in patterns for common use cases (dates, numbers, etc.) |
66 | | -- Custom prefix and suffix support |
| 58 | +### 🎯 Masking Patterns |
67 | 59 |
|
68 | | -### Number Formatting |
| 60 | +• Custom patterns & expressions |
69 | 61 |
|
70 | | -- Configurable thousand separators |
71 | | -- Decimal marker customization |
72 | | -- Negative numbers support |
73 | | -- Leading zeros handling |
| 62 | +• Multiple mask patterns (|) |
74 | 63 |
|
75 | | -### Advanced Input Control |
| 64 | +• Built-in common patterns |
76 | 65 |
|
77 | | -- Real-time input validation |
78 | | -- Clear on non-match option |
79 | | -- Show/hide mask typing |
80 | | -- Keep character positions feature |
81 | | -- Instant prefix application |
82 | | -- Hidden input support |
| 66 | +• Prefix & suffix support |
83 | 67 |
|
84 | | -### Date and Time Formatting |
| 68 | +</td> |
| 69 | +<td width="33%" valign="top"> |
85 | 70 |
|
86 | | -- Leading zero handling for date/time |
87 | | -- AM/PM support |
88 | | -- Configurable separators |
89 | | -- Multiple date formats |
| 71 | +### 🔢 Number Formatting |
90 | 72 |
|
91 | | -### Customization Options |
| 73 | +• Thousand separators |
92 | 74 |
|
93 | | -- Custom placeholder characters |
94 | | -- Special characters handling |
95 | | -- Input/Output transformation functions |
96 | | -- Custom validation rules |
| 75 | +• Decimal markers |
97 | 76 |
|
98 | | -### Form Integration |
| 77 | +• Negative numbers |
99 | 78 |
|
100 | | -- Works with Angular Reactive Forms |
101 | | -- Implements ControlValueAccessor |
102 | | -- Built-in form validation |
103 | | -- Supports standalone and NgModule setups |
| 79 | +• Leading zeros |
104 | 80 |
|
105 | | -### User Experience |
| 81 | +</td> |
| 82 | +<td width="33%" valign="top"> |
106 | 83 |
|
107 | | -- IME composition support |
108 | | -- Copy/paste handling |
109 | | -- Cursor position management |
110 | | -- Mobile-friendly input handling |
| 84 | +### ⚡ Input Control |
| 85 | + |
| 86 | +• Real-time validation |
| 87 | + |
| 88 | +• Clear on non-match |
| 89 | + |
| 90 | +• Show/hide mask typing |
| 91 | + |
| 92 | +• Keep character positions |
| 93 | + |
| 94 | +</td> |
| 95 | +</tr> |
| 96 | +<tr> |
| 97 | +<td width="33%" valign="top"> |
| 98 | + |
| 99 | +### 📅 Date & Time |
| 100 | + |
| 101 | +• Leading zero handling |
| 102 | + |
| 103 | +• AM/PM support |
| 104 | + |
| 105 | +• Custom separators |
| 106 | + |
| 107 | +• Multiple formats |
| 108 | + |
| 109 | +</td> |
| 110 | +<td width="33%" valign="top"> |
| 111 | + |
| 112 | +### 🛠️ Customization |
| 113 | + |
| 114 | +• Custom placeholders |
| 115 | + |
| 116 | +• Special characters |
| 117 | + |
| 118 | +• Transform functions |
| 119 | + |
| 120 | +• Custom validation |
| 121 | + |
| 122 | +</td> |
| 123 | +<td width="33%" valign="top"> |
| 124 | + |
| 125 | +### 📋 Form Integration |
| 126 | + |
| 127 | +• Reactive Forms |
| 128 | + |
| 129 | +• ControlValueAccessor |
| 130 | + |
| 131 | +• Built-in validation |
| 132 | + |
| 133 | +• Standalone support |
| 134 | + |
| 135 | +</td> |
| 136 | +</tr> |
| 137 | +</table> |
111 | 138 |
|
112 | 139 | ## Demo |
113 | 140 |
|
|
0 commit comments