nosir/cleave.js
Cleave.js
Cleave.js is a JavaScript library that applies real-time visual formatting to form fields as users type. It provides specialized utilities to enforce visual patterns for credit cards, phone numbers, dates, times, and large numerals.
The library includes predefined formatting rules for common data types, such as detecting credit card issuers to apply correct spacing and managing country-specific regional patterns for international phone numbers. It also supports large numeral grouping using Western, Indian, and Chinese numbering systems.
Users can define custom input patterns using specific block lengths, delimiters, and prefixes to create specialized text constraints. The toolset also covers input management, allowing for the retrieval of both formatted and raw field values, programmatic value updates, and the cleanup of active event listeners.
Features
- Real-time Input Formatting - Provides a JavaScript library for applying real-time visual formatting to form fields as users type.
- Date Formatting Utilities - Implements real-time date formatting and pattern enforcement for consistent user entry in form fields.
- Configuration-Driven Logic - Uses configuration schemas to determine how different input types should be formatted with delimiters and blocks.
- State Mapping - Maintains a separation between the raw user input and the formatted display string to ensure data integrity.
- String Tokenization - Breaks input strings into discrete blocks of predefined lengths to insert delimiters at specific intervals.
- Credit Card Formatters - Provides real-time credit card number formatting with automatic issuer detection and appropriate spacing.
- Phone Number Formatting - Applies country-specific regional patterns and spacing to phone number inputs in real-time.
- Temporal Input Patterns - Enforces standardized time patterns as users type to ensure consistent data entry.
- Event Interception Utilities - Intercepts DOM input events to apply visual formatting patterns before the text is rendered to the screen.
- Numeric Formatting - Applies locale-specific thousands separators and numeric formatting for large numerals during user input.
- Input Masking - Enforces consistent visual patterns for dates and times in form fields to prevent user entry errors.
- Date and Time Utilities - Enforces standardized date and time patterns in text inputs to ensure consistent data entry.
- Input Masking - Constrains text entry using specific block lengths, custom delimiters, and prefixes to create specialized patterns.
- Card Issuer Detection - Automatically detects credit card issuers using bank prefixes to switch to the correct spacing and formatting rules.
- Formatters - Detects card issuers and applies correct spacing and delimiters to credit card input fields.
- Formatting - Applies correct spacing and formatting to credit card number inputs based on detected issuers.
- Field Customization - Provides tools to create strict visual structures and constraints for text inputs using custom block lengths and delimiters.
- Input Value Extractors - Enables extraction of either the formatted display string or the raw underlying value from input fields.
- Numeric Grouping - Inserts thousands separators using Western, Indian, and Chinese numbering systems for better readability of large numerals.
- Numeric Inputs - Provides a specialized tool for inserting thousands separators using various international numbering styles in numeric inputs.
- Programmatic Input Formatters - Automatically applies configured formatting patterns when the raw value of a field is programmatically set.
Star history
How this analysis was created: This summary and feature list were written by an AI model that read the project's README and public documentation pages. Each feature links to the documentation it came from; stars, license and language come straight from the GitHub API. The model does not read the source code, and the analysis is refreshed when the project is re-analysed. Learn more on our About page.
