https://github.com/darrentaytay/jquery-character-counter
A simple, Twitter style character counter for HTML input fields.
https://github.com/darrentaytay/jquery-character-counter
character-counter javascript
Last synced: 16 days ago
JSON representation
A simple, Twitter style character counter for HTML input fields.
- Host: GitHub
- URL: https://github.com/darrentaytay/jquery-character-counter
- Owner: darrentaytay
- Created: 2013-02-14T08:09:21.000Z (over 12 years ago)
- Default Branch: master
- Last Pushed: 2017-08-31T15:04:40.000Z (over 7 years ago)
- Last Synced: 2025-04-09T03:04:40.589Z (about 1 month ago)
- Topics: character-counter, javascript
- Language: HTML
- Size: 26.4 KB
- Stars: 51
- Watchers: 4
- Forks: 31
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# jquery-character-counter
A simple, Twitter style character counter for HTML input fields. Based on your specified limit, the plugin simply adds a span ( by default ) after your HTML input and updates it as you type.
__Features:__
* Ctrl & V paste support
* Right click & paste support
* Customizable wrapper and css classes
* Customizable counter format
* Callbacks for exceeding and deceeding the specified limit
## Getting Started
To get started with the character counter, simply reference jQuery and the jQuery Character Counter plugin in your page.
```html
```
### Examples
#### Default Usage
__HTML:__
```html
```
__Javascript:__
```javascript
$("#count_me").characterCounter();
```
#### Custom Limit
__HTML:__
```html
```
__Javascript:__
```javascript
$("#count_me").characterCounter({
limit: '250'
});
```
***
### Options
The following options are currently available:
```javascript
{
limit: 150,
counterWrapper: 'span',
counterCssClass: 'counter',
counterFormat: '%1',
counterExceededCssClass: 'exceeded',
onExceed: function(count){},
onDeceed: function(count){},
customFields: {}
}
```
__limit__ - the number of characters you wish to limit.
__counterWrapper__ - the element you wish to wrap your counter in.
__counterCssClass__ - the CSS class to apply to your counter.
__counterFormat__ - the format of your counter text where '%1' will be replaced with the remaining character count.
__newLineSymbolCount__ - count new lines
__counterExceededCssClass__ - the CSS class to apply when your limit has been exceeded.
__onExceed__ - this function is called when the limit is breached
__onDeceed__ - this function is called when the limit, having previously been exceeded, is now deceeded
__customFields__ - key value pairs of custom options to be added to the counter such as class, data attributes etc.