从入门到精通:trunk8公共方法全攻略
【免费下载链接】trunk8jQuery Truncation Plugin -- THIS PROJECT IS NO LONGER MAINTAINED项目地址: https://gitcode.com/gh_mirrors/tr/trunk8
trunk8是一款轻量级的jQuery文本截断插件,能够帮助开发者轻松实现文本内容的智能截断,保持页面整洁美观。本文将详细介绍trunk8的核心公共方法,帮助新手快速掌握使用技巧。
📌 核心功能概览
trunk8作为一款专注于文本截断的jQuery插件,主要提供以下核心能力:
- 自动根据容器宽度或指定行数截断文本
- 支持左、中、右三种截断位置
- 可自定义省略符号和提示效果
- 保留HTML标签结构的智能截断
🔧 基础初始化方法
init:初始化插件
init方法是使用trunk8的入口,用于对目标元素应用文本截断功能。通过传递配置参数,可以自定义截断行为。
基本用法:
$('.truncate-element').trunk8({ lines: 2, // 显示行数 fill: '...', // 省略符号 side: 'right' // 截断位置 });该方法在trunk8.js中定义,会为每个元素创建trunk8实例并存储原始文本,然后执行截断逻辑。
🔄 内容更新方法
update:更新文本内容
当需要动态更新元素文本时,update方法可以在保持截断配置的同时刷新内容。
使用场景:
- 异步加载新内容后
- 用户交互导致文本变化时
示例代码:
// 更新为新文本 $('.truncate-element').trunk8('update', '这是新的文本内容...'); // 仅重新截断现有文本 $('.truncate-element').trunk8('update');实现逻辑位于trunk8.js,会更新存储的原始文本并重新执行截断过程。
🔙 恢复原始内容
revert:取消截断效果
revert方法用于恢复元素的原始文本内容,取消所有截断效果。
适用情况:
- 需要展示完整文本时
- 用户点击"查看更多"按钮后
调用方式:
$('.truncate-element').trunk8('revert');该方法实现于trunk8.js,直接将元素内容恢复为初始化时保存的原始文本。
⚙️ 获取配置信息
getSettings:获取当前配置
getSettings方法用于获取元素当前使用的trunk8配置参数,非链式调用。
使用示例:
var settings = $('.truncate-element').trunk8('getSettings'); console.log('当前显示行数:', settings.lines); console.log('截断位置:', settings.side);方法定义在trunk8.js,返回存储在元素数据中的配置对象。
🎛️ 配置参数详解
trunk8提供丰富的配置选项,通过这些参数可以精确控制截断效果:
| 参数名 | 类型 | 默认值 | 说明 |
|---|---|---|---|
| fill | string | '…' | 截断后的省略符号 |
| lines | number | 1 | 显示的最大行数 |
| side | string | 'right' | 截断位置:'left'、'center'或'right' |
| tooltip | boolean | true | 是否显示完整文本的提示 |
| width | string/number | 'auto' | 容器宽度,'auto'表示自动适应 |
| parseHTML | boolean | false | 是否保留HTML标签结构 |
| onTruncate | function | ()=>{} | 截断完成后的回调函数 |
默认配置在trunk8.js中定义,可以在初始化时通过参数覆盖。
💡 实用技巧与最佳实践
- 响应式截断:结合窗口 resize 事件动态调整截断效果
$(window).resize(function() { $('.truncate-element').trunk8('update'); });HTML内容处理:当需要截断包含HTML标签的内容时,设置
parseHTML: true自定义省略符号:使用HTML实体或自定义样式的省略符号
$('.truncate-element').trunk8({ fill: '<span class="ellipsis">...</span>' });- 性能优化:对于大量元素,建议分批初始化以避免阻塞UI
📝 总结
trunk8通过简洁的API提供了强大的文本截断功能,主要公共方法包括:
init:初始化插件并应用截断update:更新文本内容并重新截断revert:恢复原始文本getSettings:获取当前配置
合理使用这些方法可以轻松实现各种文本截断需求,提升页面美观度和用户体验。虽然该项目已不再维护,但其轻量级设计和稳定功能仍使其成为文本截断场景的理想选择。
要开始使用trunk8,只需克隆仓库并引入到项目中:
git clone https://gitcode.com/gh_mirrors/tr/trunk8然后在页面中引入jQuery和trunk8.js文件,即可开始体验高效的文本截断功能。
【免费下载链接】trunk8jQuery Truncation Plugin -- THIS PROJECT IS NO LONGER MAINTAINED项目地址: https://gitcode.com/gh_mirrors/tr/trunk8
创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考