在线测试 <<>> Github Code <<>> NPM

API 接口定义

以下的 API 接口只针对实例方式的使用；

• .build(text)

  • @param String text 需要进行处理的文本字符串；
  • @return Array(String) 入参 text 被分割成若干个行，每一行对应数组中的一个元素；

将文本 text 分割成若干行；如果出现截断、行数超出，会自动做截断、追加提示符 suffix；

• .destroy()

销毁 TextWrapPX 实例，如果确定不会再继续使用该实例，一定要手动销毁该实例，不然页面中会有残存的 DOM 标签；

• .setOptions(options)

  • @param Object options 新的一些需要更新的配置项；
  • @return Instance

更新现有实例中使用的配置，未收影响的配置项会继续保持上次的值；配置项参考：Options 配置项;

• .$width(text)

  • @param String text 一次性文本 text；
  • @return Number

该宽度可能受到 options.style 中定义的样式影响，请尽量避免使用如：max-width、width 等 CSS 样式来限制死宽度；配置项参考：Options 配置项;

参数 text 为一次性文本，不会写入到实例中，如果不传 text 参数，则使用当前实例中保存的 text （通过 .build 接口设置的）；

• .$height(text)

  • @param String text 一次性文本 text；
  • @return Number

该高度可能受到 options.style 中定义的样式影响，比如，强制使用 line-height 限制行高；配置项参考：Options 配置项;

参数 text 为一次性文本，不会写入到实例中，如果不传 text 参数，则使用当前实例中保存的 text （通过 .build 接口设置的）；