1010
1111<p align =" center " >
1212 <a href =" https://jsdaddy.io " >
13- <img src="http://jsdaddy.io/assets/images/shared/logo.svg" alt="JSDaddy" width="250 ">
13+ <img src="http://jsdaddy.io/assets/images/shared/logo.svg" alt="JSDaddy" width="75 ">
1414 </a >
1515</p >
1616
3535 </a >
3636</p >
3737
38- ## 📖 Table of Contents
38+ ## Table of Contents
3939
4040- [ 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 )
4148- [ Demo] ( #demo )
4249- [ Installation] ( #installation )
4350- [ Version Compatibility] ( #version-compatibility )
4451- [ Quick Start] ( #quick-start )
4552 - [ For Angular 15+ (Standalone)] ( #for-angular-15-standalone )
4653 - [ For Angular Modules] ( #for-angular-modules )
47- - [ Documentation] ( #documentation )
4854- [ Related Projects] ( #related-projects )
4955- [ Contributing] ( #contributing )
5056
51- ## ✨ Features
57+ ## Features
5258
5359NGX-MASK is a feature-rich input mask directive for Angular applications that helps you:
5460
55- - Format input values according to predefined patterns
56- - Validate input against mask patterns
57- - Support custom validation rules
58- - Provide real-time input formatting
61+ ### Flexible Masking Patterns
5962
60- ## 🚀 Demo
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
67+
68+ ### Number Formatting
69+
70+ - Configurable thousand separators
71+ - Decimal marker customization
72+ - Negative numbers support
73+ - Leading zeros handling
74+
75+ ### Advanced Input Control
76+
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
83+
84+ ### Date and Time Formatting
85+
86+ - Leading zero handling for date/time
87+ - AM/PM support
88+ - Configurable separators
89+ - Multiple date formats
90+
91+ ### Customization Options
92+
93+ - Custom placeholder characters
94+ - Special characters handling
95+ - Input/Output transformation functions
96+ - Custom validation rules
97+
98+ ### Form Integration
99+
100+ - Works with Angular Reactive Forms
101+ - Implements ControlValueAccessor
102+ - Built-in form validation
103+ - Supports standalone and NgModule setups
104+
105+ ### User Experience
106+
107+ - IME composition support
108+ - Copy/paste handling
109+ - Cursor position management
110+ - Mobile-friendly input handling
111+
112+ ## Demo
61113
62114Check out our [ live documentation and examples] ( https://jsdaddy.github.io/ngx-mask/ )
63115
64- ## 📦 Installation
116+ ## Installation
65117
66118``` bash
67119# For Angular 17 and above
88140
89141> ** Package Manager Note** : You can use either npm or bun based on your preference. Both package managers will work equally well with ngx-mask.
90142
91- ## 🔄 Version Compatibility
143+ ## Version Compatibility
92144
93145NGX-MASK follows Angular's official support policy, supporting Active and LTS versions. Currently supported:
94146
@@ -97,7 +149,7 @@ NGX-MASK follows Angular's official support policy, supporting Active and LTS ve
97149
98150> ** Note** : Versions for Angular older than v17 will not receive new features or updates.
99151
100- ## 🚀 Quick Start
152+ ## Quick Start
101153
102154### For Angular 15+ (Standalone)
103155
@@ -163,3 +215,14 @@ import { NgxMaskModule } from 'ngx-mask';
163215@NgModule ({ imports: [NgxMaskModule .forChild ()] })
164216export class FeatureModule {}
165217```
218+
219+ ## Related Projects
220+
221+ Check out other projects by JSDaddy:
222+
223+ - [ ngx-copypaste] ( https://github.com/JsDaddy/ngx-copypaste )
224+ - [ ngx-loader-indicator] ( https://github.com/JsDaddy/ngx-loader-indicator )
225+
226+ ## Contributing
227+
228+ We welcome contributions! Please read our [ contributing guidelines] ( CONTRIBUTING.md ) to learn about our development process and how you can propose bugfixes and improvements.
0 commit comments