https://github.com/samiahmedsiddiqui/trim-words
Trims text to a certain number of words.
https://github.com/samiahmedsiddiqui/trim-words
react trim trims-text wordpress wp-trim-words
Last synced: 4 months ago
JSON representation
Trims text to a certain number of words.
- Host: GitHub
- URL: https://github.com/samiahmedsiddiqui/trim-words
- Owner: samiahmedsiddiqui
- License: mit
- Created: 2019-10-24T18:45:01.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2021-05-31T09:37:14.000Z (about 5 years ago)
- Last Synced: 2024-04-24T07:25:26.929Z (over 2 years ago)
- Topics: react, trim, trims-text, wordpress, wp-trim-words
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/trim-words
- Size: 89.8 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# trim-words
[![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 words.
## Install
Via `npm`
```bash
npm install trim-words
```
Via Yarn
```bash
yarn add trim-words
```
## Usage
## With CommonJS
```javascript
var trimWords = require('trim-words').default;
```
## With React
```javascript
import trimWords from 'trim-words';
```
## Example
### Trims text to a certain number of words in `Node.js`
```javascript
const trimWords = require('trim-words').default;
const text = `
What is Geostatistics?
var a = 1; b = 2;p { color: red; }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 trimmedText = trimWords(text, 60, '...');
console.log('Trimmed Text is: ', trimmedText);
```
### Trims text to a certain number of words in `React`
```javascript
import trimWords from 'trim-words';
const text = `
What is Geostatistics?
var a = 1; b = 2;p { color: red; }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 trimmedText = trimWords(text, 60, '...');
console.log('Trimmed Text is: ', trimmedText);
```
## Parameters
| Attributes | Type | Required | Default | Description |
|------------|:-------:|:--------:|:----------:|---------------------------------------------------|
| text | String | Yes | | Text to trim. |
| numWords | Integer | No | `55` | Number of words. |
| more | String | No | `ahellip;` | 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-words.svg
[npm-url]: https://www.npmjs.com/package/trim-words
[downloads-image]: https://img.shields.io/npm/dm/trim-words.svg
[travis-image]: https://img.shields.io/travis/com/samiahmedsiddiqui/trim-words.svg?label=travis-ci
[travis-url]: https://travis-ci.com/samiahmedsiddiqui/trim-words
[appveyor-url]: https://ci.appveyor.com/project/samiahmedsiddiqui/trim-words
[appveyor-image]: https://img.shields.io/appveyor/ci/samiahmedsiddiqui/trim-words.svg?label=appveyor
[dependency-image]: https://img.shields.io/david/samiahmedsiddiqui/trim-words.svg
[dependency-url]: https://david-dm.org/samiahmedsiddiqui/trim-words