https://github.com/samiahmedsiddiqui/trim-characters
Trims text to a certain number of characters. You can define either to break word to maintain the number of characters limit or characters limit may decreases to avoid breaking words.
https://github.com/samiahmedsiddiqui/trim-characters
characters react react-trim-characters trim trim-characters trims-text
Last synced: 2 months ago
JSON representation
Trims text to a certain number of characters. You can define either to break word to maintain the number of characters limit or characters limit may decreases to avoid breaking words.
- Host: GitHub
- URL: https://github.com/samiahmedsiddiqui/trim-characters
- Owner: samiahmedsiddiqui
- License: mit
- Created: 2019-11-01T06:49:51.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2021-05-31T09:37:47.000Z (about 5 years ago)
- Last Synced: 2025-06-30T18:51:36.336Z (12 months ago)
- Topics: characters, react, react-trim-characters, trim, trim-characters, trims-text
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/trim-characters
- Size: 33.2 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# trim-characters
[![NPM version][npm-image]][npm-url] [![Downloads][downloads-image]][npm-url] [![Build Status][travis-image]][travis-url] [![AppVeyor Build Status][appveyor-image]][appveyor-url] [![Dependency Status][dependency-image]][dependency-url]
Trims text to a certain number of characters. You can define either to break-word to maintain the number of characters limit or characters limit may decrease to avoid breaking words.
## Install
Via `npm`
```bash
npm install trim-characters
```
Via Yarn
```bash
yarn add trim-characters
```
## Usage
## With CommonJS
```javascript
const trimCharacters = require('trim-characters');
```
## With React
```javascript
import trimCharacters from 'trim-characters';
```
## Example
### Trims text to a certain number of characters in `Node.js`
```javascript
const trimCharacters = require('trim-characters');
const text = '
What is Geostatistics?
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Duis tincidunt quam ut ligula ullamcorper interdum. Nulla malesuada purus tristique justo tristique, id posuere purus tristique. Pellentesque non magna ut libero elementum interdum vel vitae ante. Sed porta auctor urna eget venenatis. Mauris nec convallis metus. Sed at dui elit. Donec rhoncus justo neque, finibus commodo dui posuere ut. Maecenas in mi enim. Quisque maximus enim nunc.
Donec eu ultricies ipsum. Fusce eget pellentesque urna. Vestibulum lacinia laoreet mi nec posuere. Duis vel elit elementum, scelerisque eros a, sodales eros. Praesent hendrerit neque velit, nec pretium ipsum finibus facilisis. Proin ultricies sem in sapien consectetur dictum.
';
const trimmedChar1 = trimCharacters(text, 70, false, '...');
const trimmedChar2 = trimCharacters(text, 70, true, '...');
console.log('Trim Characters without breaking words: ', trimmedChar1);
console.log('Trim Characters with breaking words: ', trimmedChar2);
```
### Trims text to a certain number of characters in `React`
```javascript
import trimCharacters from 'trim-characters';
const text = '
What is Geostatistics?
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Duis tincidunt quam ut ligula ullamcorper interdum. Nulla malesuada purus tristique justo tristique, id posuere purus tristique. Pellentesque non magna ut libero elementum interdum vel vitae ante. Sed porta auctor urna eget venenatis. Mauris nec convallis metus. Sed at dui elit. Donec rhoncus justo neque, finibus commodo dui posuere ut. Maecenas in mi enim. Quisque maximus enim nunc.
Donec eu ultricies ipsum. Fusce eget pellentesque urna. Vestibulum lacinia laoreet mi nec posuere. Duis vel elit elementum, scelerisque eros a, sodales eros. Praesent hendrerit neque velit, nec pretium ipsum finibus facilisis. Proin ultricies sem in sapien consectetur dictum.
';
const trimmedChar1 = trimCharacters(text, 70, false, '...');
const trimmedChar2 = trimCharacters(text, 70, true, '...');
console.log('Trim Characters without breaking words: ', trimmedChar1);
console.log('Trim Characters with breaking words: ', trimmedChar2);
```
## Parameters
| Attributes | Type | Required | Default | Description |
|------------|:-------:|:--------:|:----------:|--------------------------------------------------------------------------------------------------------------------------|
| text | String | Yes | | Text to trim. |
| charLength | Integer | No | `155` | Number of characters. |
| breakWord | Boolean | No | `true` | Either to break words or not.
If it is set to `false` then `charLength` may decrease to **AVOID** breaking words. |
| more | String | No | `…` | What to append if the `text` needs to be trimmed. |
## Return
Trimmed text.
## Tested
This package is tested with the `Node.js` and `React` Application.
[npm-image]: https://img.shields.io/npm/v/trim-characters.svg
[npm-url]: https://www.npmjs.com/package/trim-characters
[downloads-image]: https://img.shields.io/npm/dm/trim-characters.svg
[travis-image]: https://img.shields.io/travis/com/samiahmedsiddiqui/trim-characters.svg?label=travis-ci
[travis-url]: https://travis-ci.com/samiahmedsiddiqui/trim-characters
[appveyor-url]: https://ci.appveyor.com/project/samiahmedsiddiqui/trim-characters
[appveyor-image]: https://img.shields.io/appveyor/ci/samiahmedsiddiqui/trim-characters.svg?label=appveyor
[dependency-image]: https://img.shields.io/david/samiahmedsiddiqui/trim-characters.svg
[dependency-url]: https://david-dm.org/samiahmedsiddiqui/trim-characters