https://github.com/averagemarcus/truncatise
Provides the ability to truncate HTML strings down to excerpts based on character length, word length or paragraph length.
https://github.com/averagemarcus/truncatise
hacktoberfest
Last synced: over 1 year ago
JSON representation
Provides the ability to truncate HTML strings down to excerpts based on character length, word length or paragraph length.
- Host: GitHub
- URL: https://github.com/averagemarcus/truncatise
- Owner: AverageMarcus
- License: mit
- Created: 2013-10-29T21:45:57.000Z (over 12 years ago)
- Default Branch: master
- Last Pushed: 2019-06-12T18:47:42.000Z (about 7 years ago)
- Last Synced: 2025-03-27T09:46:23.734Z (over 1 year ago)
- Topics: hacktoberfest
- Language: JavaScript
- Homepage: https://npmjs.org/package/truncatise
- Size: 13.7 KB
- Stars: 17
- Watchers: 1
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Truncatise
## JavaScript module to truncate HTML strings.
### Description
Provides the ability to truncate HTML strings down to excerpts based on character length, word length or paragraph length.
**Features:**
* Truncate based on number of Characters, Words or Paragraphs.
* Strip HTML from returned string.
* Provides a strict flag to specify whether to cut-off mid word or not.
* Configurable suffix appended to the end of the returned excerpt.
### Install
npm install truncatise
### Options (with default values)
```javascript
{
TruncateBy: 'words', // Options are 'words', 'characters' or 'paragraphs'
TruncateLength: 50, // The count to be used with TruncatedBy
StripHTML: false, // Whether or not the truncated text should contain HTML tags
Strict: true, // If set to false the truncated text finish at the end of the word
Suffix: '...' // Text to be appended to the end of the truncated text
}
```
### Example Usage
```javascript
var options = {
TruncateLength: 4,
TruncateBy : "words",
Strict : false,
StripHTML : true,
Suffix : ' (Read More)'
};
var excerpt = truncatise("
This is a test of Truncatise
", options);
console.log(excerpt); // This is a test (Read More)
```