Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/oe/truncate-html

truncate html and keep tag in safe
https://github.com/oe/truncate-html

html truncate truncate-html truncate-words

Last synced: 6 days ago
JSON representation

truncate html and keep tag in safe

Awesome Lists containing this project

README

        

truncate-html

Truncate html string(even contains emoji chars) and keep tags in safe. You can custom ellipsis sign, ignore unwanted elements and truncate html by words.



Github Actions


code with typescript


npm version


npm downloads


**Notice** This is a node module depends on [cheerio](https://github.com/cheeriojs/cheerio) _can only run on nodejs_. If you need a browser version, you may consider [truncate](https://github.com/pathable/truncate) or [nodejs-html-truncate](https://github.com/huang47/nodejs-html-truncate).

```javascript
const truncate = require('truncate-html')
truncate('

Hello from earth!

', 2, { byWords: true })
// =>

Hello from ...


```

## Installation

`npm install truncate-html`

or

`yarn add truncate-html`

## Try it online

Click **** to try.

## API

```javascript
/**
* truncate html
* @method truncate(html, [length], [options])
* @param {String|CheerioStatic} html html string to truncate, or existing cheerio instance(aka cheerio $)
* @param {Object|number} length how many letters(words if `byWords` is true) you want reserve
* @param {Object|null} options
* @param {Boolean} [options.stripTags] remove all tags, default false
* @param {String} [options.ellipsis] ellipsis sign, default '...'
* @param {Boolean} [options.decodeEntities] decode html entities(e.g. convert `&` to `&`) before
* counting length, default false
* @param {String|Array} [options.excludes] elements' selector you want ignore
* @param {Number} [options.length] how many letters(words if `byWords` is true)
* you want reserve
* @param {Boolean} [options.byWords] if true, length means how many words to reserve
* @param {Boolean|Number} [options.reserveLastWord] how to deal with when truncate in the middle of a word
* 1. by default, just cut at that position.
* 2. set it to true, with max exceed 10 letters can exceed to reserver the last word
* 3. set it to a positive number decide how many letters can exceed to reserve the last word
* 4. set it to negetive number to remove the last word if cut in the middle.
* @param {Boolean} [options.trimTheOnlyWord] whether to trim the only word when `reserveLastWord` < 0
* if reserveLastWord set to negetive number, and there is only one word in the html string,
* when trimTheOnlyWord set to true, the extra letters will be cutted if word's length longer
* than `length`.
* see issue #23 for more details
* @param {Boolean} [options.keepWhitespaces] keep whitespaces, by default continuous
* spaces will be replaced with one space
* set it true to reserve them, and continuous spaces will count as one
* @return {String}
*/
truncate(html, [length], [options])
// and truncate.setup to change default options
truncate.setup(options)
```

### Default options

```js
{
stripTags: false,
ellipsis: '...',
decodeEntities: false,
excludes: '',
byWords: false,
reserveLastWord: false,
trimTheOnlyWord: false,
keepWhitespaces: false
}
```

You can change default options by using `truncate.setup`

e.g.

```js
truncate.setup({ stripTags: true, length: 10 })
truncate('

Hello from earth!

')
// => Hello from
```

or use existing [cheerio instance](https://github.com/cheeriojs/cheerio#loading)

```js
import * as cheerio from 'cheerio'
truncate.setup({ stripTags: true, length: 10 })
// truncate option `decodeEntities` will not work
// you should config it in cheerio options by yourself
const $ = cheerio.load('

Hello from earth!

', {
/** set decodeEntities if you need it */
decodeEntities: true
/* any cheerio instance options*/
}, false) // third parameter is for `isDocument` option, set to false to get rid of extra wrappers, see cheerio's doc for details
truncate($)
// => Hello from
```

## Notice

### Typescript support

This lib is written with typescript and has a type definition file along with it. ~~You may need to update your `tsconfig.json` by adding `"esModuleInterop": true` to the `compilerOptions` if you encounter some typing errors, see [#19](https://github.com/oe/truncate-html/issues/19).~~

### About final string length

If the html string content's length is shorter than `options.length`, then no ellipsis will be appended to the final html string. If longer, then the final string length will be `options.length` + `options.ellipsis`. And if you set `reserveLastWord` to true or none zero number, the final string will be various.

### About html comments

All html comments `` will be removed

### About dealing with none alphabetic languages

When dealing with none alphabetic languages, such as Chinese/Japanese/Korean, they don't separate words with whitespaces, so options `byWords` and `reserveLastWord` should only works well with alphabetic languages.

And the only dependency of this project `cheerio` has an issue when dealing with none alphabetic languages, see [Known Issues](#known-issues) for details.

### Using existing cheerio instance

If you want to use existing cheerio instance, truncate option `decodeEntities` will not work, you should set it in your own cheerio instance:

```js
var html = '

This is a string

for test.'
const $ = cheerio.load(`${html}`, {
decodeEntities: true
/** other cheerio options */
}, false) // third parameter is for `isDocument` option, set to false to get rid of extra wrappers, see cheerio's doc for details
truncate($, 10)

```

## Examples

```javascript
var truncate = require('truncate-html')

// truncate html
var html = '

This is a string

for test.'
truncate(html, 10)
// returns:

This is a ...

// truncate string with emojis
var string = '

poo 💩💩💩💩💩

'
truncate(string, 6)
// returns:

poo 💩💩...

// with options, remove all tags
var html = '

This is a string

for test.'
truncate(html, 10, { stripTags: true })
// returns: This is a ...

// with options, truncate by words.
// if you try to truncate none alphabet language(like CJK)
// it will not act as you wish
var html = '

This is a string

for test.'
truncate(html, 3, { byWords: true })
// returns:

This is a ...

// with options, keep whitespaces
var html = '

This is a string

for test.'
truncate(html, 10, { keepWhitespaces: true })
// returns:

This is a ...

// combine length and options
var html = '

This is a string

for test.'
truncate(html, {
length: 10,
stripTags: true
})
// returns: This is a ...

// custom ellipsis sign
var html = '

This is a string

for test.'
truncate(html, {
length: 10,
ellipsis: '~'
})
// returns:

This is a ~

// exclude some special elements(by selector), they will be removed before counting content's length
var html = '

This is a string

for test.'
truncate(html, {
length: 10,
ellipsis: '~',
excludes: 'img'
})
// returns:

This is a ~

// exclude more than one category elements
var html =
'

This is a string

unwanted string inserted ( ´•̥̥̥ω•̥̥̥` )
for test.'
truncate(html, {
length: 20,
stripTags: true,
ellipsis: '~',
excludes: ['img', '.something-unwanted']
})
// returns: This is a string for~

// handing encoded characters
var html = '

 test for <p> encoded string

'
truncate(html, {
length: 20,
decodeEntities: true
})
// returns:

test for <p> encode...

// when set decodeEntities false
var html = '

 test for <p> encoded string

'
truncate(html, {
length: 20,
decodeEntities: false // this is the default value
})
// returns:

 test for <p...

// and there may be a surprise by setting `decodeEntities` to true when handing CJK characters
var html = '

 test for <p> 中文 string

'
truncate(html, {
length: 20,
decodeEntities: true
})
// returns:

test for <p> 中文 str...


// to fix this, see below for instructions
```

for More usages, check [truncate.spec.ts](./test/truncate.spec.ts)

## Credits

Thanks to:

- [@calebeno](https://github.com/calebeno) es6 support and unit tests
- [@aaditya-thakkar](https://github.com/aaditya-thakkar) emoji truncating support