https://github.com/tecfu/breakword
Get index of character after which variable 'word' must be broken given variable 'length' (accounts for wide characters). https://www.npmjs.com/package/breakword
https://github.com/tecfu/breakword
Last synced: about 1 year ago
JSON representation
Get index of character after which variable 'word' must be broken given variable 'length' (accounts for wide characters). https://www.npmjs.com/package/breakword
- Host: GitHub
- URL: https://github.com/tecfu/breakword
- Owner: tecfu
- License: mit
- Created: 2017-05-12T23:58:17.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2023-05-30T07:49:38.000Z (about 3 years ago)
- Last Synced: 2024-11-28T22:15:28.600Z (over 1 year ago)
- Language: JavaScript
- Homepage:
- Size: 479 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# breakword
Get index i.e. 0,1,2,... of the character where a word must be broken given it must
be wrapped within a certain length of spaces.
Useful because javascript's String.length does not reflect the true width of emojis and wide characters.
## Installation
```
npm install breakword
```
## Examples
1. To find the index of the character to break after if we want to limit our characters fit on a line 3 spaces wide.
```js
const Breakword = require ("breakword");
const word = "打破我的角色三";
const breakIndex = Breakword(word,3);
console.log(breakIndex) //0
```
The result here - 0 - means all the characters before index 0 (in this case only the character 打) can fit in a line 3 spaces long.
## Test
```bash
npm test
```
- Save new test results to test/test.json
```bash
npm --save run test
```
- Display test outputs only
```bash
npm --display run test
```
## Build
```bash
npm run-script build
```