You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
王厅 539a1f95cc vue + ant-design + vxe-table 3 weeks ago
..
LICENSE vue + ant-design + vxe-table 3 weeks ago
README.hbs vue + ant-design + vxe-table 3 weeks ago
README.md vue + ant-design + vxe-table 3 weeks ago
index.js vue + ant-design + vxe-table 3 weeks ago
package.json vue + ant-design + vxe-table 3 weeks ago

README.md

view on npm npm module downloads Gihub repo dependents Gihub package dependents Build Status js-standard-style

wordwrapjs

Word wrapping, with a few features.

  • force-break option
  • wraps hypenated words
  • multilingual - wraps any language that uses whitespace for word separation.

Synopsis

Wrap some text in a 20 character column.

> wordwrap = require('wordwrapjs')

> text = 'Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.'

> result = wordwrap.wrap(text, { width: 20 })

result now looks like this:

Lorem ipsum dolor
sit amet,
consectetur
adipiscing elit, sed
do eiusmod tempor
incididunt ut labore
et dolore magna
aliqua.

By default, long words will not break. Unless you set the break option.

> url = 'https://github.com/75lb/wordwrapjs'

> wrap.lines(url, { width: 18 })
[ 'https://github.com/75lb/wordwrapjs' ]

> wrap.lines(url, { width: 18, break: true })
[ 'https://github.com', '/75lb/wordwrapjs' ]

API Reference

WordWrap ⏏

Kind: Exported class

WordWrap.wrap(text, [options]) ⇒ string

Kind: static method of WordWrap

Param Type Description
text string the input text to wrap
[options] object optional configuration
[options.width] number the max column width in characters (defaults to 30).
[options.break] boolean if true, words exceeding the specified width will be forcefully broken
[options.noTrim] boolean By default, each line output is trimmed. If noTrim is set, no line-trimming occurs - all whitespace from the input text is left in.

WordWrap.lines(text, options)

Wraps the input text, returning an array of strings (lines).

Kind: static method of WordWrap

Param Type Description
text string input text
options object Accepts same options as constructor.

WordWrap.isWrappable(text) ⇒ boolean

Returns true if the input text would be wrapped if passed into .wrap().

Kind: static method of WordWrap

Param Type Description
text string input text

WordWrap.getChunks(text) ⇒ Array.<string>

Splits the input text into an array of words and whitespace.

Kind: static method of WordWrap

Param Type Description
text string input text

© 2015-21 Lloyd Brookes <75pound@gmail.com>. Documented by jsdoc-to-markdown.