Skip to content
This repository has been archived by the owner on Dec 1, 2021. It is now read-only.

Add live paragraph-, word- and character-counting to an HTML element.

License

Notifications You must be signed in to change notification settings

stephenburgess8/FreqCountable

 
 

Repository files navigation

FreqCountable

License

FreqCountable is a JavaScript function to add live paragraph-, word- and character-counting to an HTML element.

=> <textarea id="text"></textarea>, { all: 0, characters: 0, paragraphs: 0, words: 0 }
Property Meaning
paragraphs The number of paragraphs. Paragraphs can be separated by either a soft or a hard (two line breaks) return. To use hard returns, set the corresponding option (hardReturns).
words The number of words. Words are split using spaces.
characters The number of characters (without spaces). This contains all non-whitespace characters.
all The number of characters including whitespace. This is the total number of all characters in the element.

Options

Countable.live() and Countable.once() both accept a third argument, an options object that allows you to change how Countable treats certain aspects of your element's text.

{
  hardReturns: false,
  stripTags: false,
  ignoreReturns: false
}

By default, paragraphs are split by a single return (a soft return). By setting hardReturns to true, Countable splits paragraphs after two returns.

Depending on your application and audience, you might need to strip HTML tags from the text before counting it. You can do this by setting stripTags to true.

In most cases, returns should be counted as part of the all property. Set ignoreReturns to false to remove them from the counter.

Browser Support

FreqCountable supports all modern browsers. Internet Explorer is supported down to version 7. Note that some browsers don't implement the oninput event consistently so there might be differences in the way FreqCountable works in different browsers.

About

Add live paragraph-, word- and character-counting to an HTML element.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • HTML 61.8%
  • JavaScript 38.2%