{"id":21706341,"url":"https://github.com/samiahmedsiddiqui/trim-characters","last_synced_at":"2026-04-12T18:22:42.455Z","repository":{"id":50751022,"uuid":"218929468","full_name":"samiahmedsiddiqui/trim-characters","owner":"samiahmedsiddiqui","description":"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.","archived":false,"fork":false,"pushed_at":"2021-05-31T09:37:47.000Z","size":34,"stargazers_count":0,"open_issues_count":1,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-06-30T18:51:36.336Z","etag":null,"topics":["characters","react","react-trim-characters","trim","trim-characters","trims-text"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/trim-characters","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/samiahmedsiddiqui.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-11-01T06:49:51.000Z","updated_at":"2021-05-31T09:37:50.000Z","dependencies_parsed_at":"2022-09-02T22:11:47.989Z","dependency_job_id":null,"html_url":"https://github.com/samiahmedsiddiqui/trim-characters","commit_stats":null,"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"purl":"pkg:github/samiahmedsiddiqui/trim-characters","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/samiahmedsiddiqui%2Ftrim-characters","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/samiahmedsiddiqui%2Ftrim-characters/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/samiahmedsiddiqui%2Ftrim-characters/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/samiahmedsiddiqui%2Ftrim-characters/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/samiahmedsiddiqui","download_url":"https://codeload.github.com/samiahmedsiddiqui/trim-characters/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/samiahmedsiddiqui%2Ftrim-characters/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":267944595,"owners_count":24170205,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-07-30T02:00:09.044Z","response_time":70,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["characters","react","react-trim-characters","trim","trim-characters","trims-text"],"created_at":"2024-11-25T22:12:30.753Z","updated_at":"2026-04-12T18:22:37.407Z","avatar_url":"https://github.com/samiahmedsiddiqui.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# trim-characters\n\n[![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]\n\nTrims 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.\n\n## Install\n\nVia `npm`\n```bash\nnpm install trim-characters\n```\n\nVia Yarn\n```bash\nyarn add trim-characters\n```\n\n## Usage\n\n## With CommonJS\n\n```javascript\nconst trimCharacters = require('trim-characters');\n```\n\n## With React\n\n```javascript\nimport trimCharacters from 'trim-characters';\n```\n\n## Example\n\n### Trims text to a certain number of characters in `Node.js`\n\n```javascript\nconst trimCharacters = require('trim-characters');\n\nconst text = '\u003ch1\u003eWhat is Geostatistics?\u003c/h1\u003e \u003cp\u003eLorem 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.\u003c/p\u003e \u003cp\u003eDonec 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.\u003c/p\u003e';\n\nconst trimmedChar1 = trimCharacters(text, 70, false, '...');\nconst trimmedChar2 = trimCharacters(text, 70, true, '...');\n\nconsole.log('Trim Characters without breaking words: ', trimmedChar1);\nconsole.log('Trim Characters with breaking words: ', trimmedChar2);\n```\n\n### Trims text to a certain number of characters in `React`\n\n```javascript\nimport trimCharacters from 'trim-characters';\n\nconst text = '\u003ch1\u003eWhat is Geostatistics?\u003c/h1\u003e \u003cp\u003eLorem 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.\u003c/p\u003e \u003cp\u003eDonec 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.\u003c/p\u003e';\n\nconst trimmedChar1 = trimCharacters(text, 70, false, '...');\nconst trimmedChar2 = trimCharacters(text, 70, true, '...');\n\nconsole.log('Trim Characters without breaking words: ', trimmedChar1);\nconsole.log('Trim Characters with breaking words: ', trimmedChar2);\n```\n\n## Parameters\n\n| Attributes |   Type  | Required |   Default  | Description                                                                                                              |\n|------------|:-------:|:--------:|:----------:|--------------------------------------------------------------------------------------------------------------------------|\n| text       |  String |    Yes   |            | Text to trim.                                                                                                            |\n| charLength | Integer |    No    |    `155`   | Number of characters.                                                                                                    |\n| breakWord  | Boolean |    No    |   `true`   | Either to break words or not.\u003cbr\u003e\u003cbr\u003eIf it is set to `false` then `charLength` may decrease to **AVOID** breaking words. |\n| more       |  String |    No    | `\u0026hellip;` | What to append if the `text` needs to be trimmed.                                                                        |\n\n## Return\n\nTrimmed text.\n\n## Tested\n\nThis package is tested with the `Node.js` and `React` Application.\n\n[npm-image]: https://img.shields.io/npm/v/trim-characters.svg\n[npm-url]: https://www.npmjs.com/package/trim-characters\n[downloads-image]: https://img.shields.io/npm/dm/trim-characters.svg\n\n[travis-image]: https://img.shields.io/travis/com/samiahmedsiddiqui/trim-characters.svg?label=travis-ci\n[travis-url]: https://travis-ci.com/samiahmedsiddiqui/trim-characters\n\n[appveyor-url]: https://ci.appveyor.com/project/samiahmedsiddiqui/trim-characters\n[appveyor-image]: https://img.shields.io/appveyor/ci/samiahmedsiddiqui/trim-characters.svg?label=appveyor\n\n[dependency-image]: https://img.shields.io/david/samiahmedsiddiqui/trim-characters.svg\n[dependency-url]: https://david-dm.org/samiahmedsiddiqui/trim-characters\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsamiahmedsiddiqui%2Ftrim-characters","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsamiahmedsiddiqui%2Ftrim-characters","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsamiahmedsiddiqui%2Ftrim-characters/lists"}