Skip to content

Latest commit

 

History

History
116 lines (79 loc) · 2.62 KB

README_CN.md

File metadata and controls

116 lines (79 loc) · 2.62 KB

Overflow

生成符合HTML元素高度的文本工具

安装

npm:

npm install overflowjs --save-dev

示例

示例

使用

文本输入

import Overflow from 'overflowjs'
new Overflow(document.querySelector('#overflow'), {
  str:
    'Fame,wealth and knowledge are merely worldly possessions that are withinthe reach of anybodyFame,wealth and knowledge are merely worldly possessions that are withinthe reach of anybodyFame',
  callback: function(res) {
    console.log(res)
    // output:Fame,wealth and knowledge are merely worldly possessions that are withinthe reach of anybodyFame,wealth and knowled
  }
})

你可以用它去生成带省略号的字符串

new Overflow(document.querySelector('#overflow'), {
  str:
    "You'll pass the churchyard, Mr Lockwood, on your way back to the Grange, and you'll see the three graverestones close to the moor. Catherine's",
  callback: function(res) {
    console.log(this.dotdotdot())
    // output:You'll pass the churchyard, Mr Lockwood, on your way back to the Grange, and you'll see the three grave...
  }
})

example

Overflow API

选项

new Overflow(HTMLElement, {
  str: String,
  row: Number,
  scrollTop: Number, // 偏移量
  callback: function(res) {}
})

方法

overflow.reCompute(str,callback)

重新计算文本

overflow.dotdotdot(ellipsis = "...", str)

提示

EllipsisText使用画布确定近似的文本数量

如果传入的是HTML的话，EllipsisText将会逐个删除DOM节点，这会浪费一部分时间

方法 dotdotdot仅仅是将最后的三个字符替换为... 你也可以使用 dotdotdot.js 进行接下来的替换操作 或者 重写 dotdotdot方法

性能

下面是性能展示（ms） str X 10 代表循环某一段文字累加10次

Development setup

npm install

npm run dev

npm run test

Release History

  • 1.0.17
    • add scrollTop property
  • 1.0.0
    • The first release

Meta

Mater1996 – bxh8640@gmail.com

Distributed under the MIT license. See LICENSE for more information.

LICENSE

Contributing

  1. Fork it (https://github.com/Mater1996/overflow.js)
  2. Create your feature branch (git checkout -b feature/fooBar)
  3. Commit your changes (git commit -am 'Add some fooBar')
  4. Push to the branch (git push origin feature/fooBar)
  5. Create a new Pull Request