开源个 react 多行缩略组件,支持自定义缩略符、尾文本过滤、缩略回调等

背景

入职头条快一年,平常工作中,不止一次听到 UI 反馈,头条 App 内的 h5 上偶尔会出现下面这样的体验 bug。

image-20210228170527346

在缩略符 “...” 前面会小概率出现标点符号,看起来很不雅观。这么长时间这个问题一直没解决,因为自己手头的业务有点多也就没去关注这个他人需求。

最近刚好弄完绩效评估处于需求真空期,刚好想起这个问题,就顺手给解决了,沉淀了个 react 的缩略组件。考虑到这是个很通用的需求,所以整理了一下开源出来。

先直接上干货吧,组件已经开源在 github 上,仓库地址: react-ellipsis (觉得有用可以给个 star)。

可能会有人疑惑,这么常见的需求真的没有可用的轮子吗?我一开始也带着这个疑惑,搜了一下 npm 和 github,发现还真没有能完全符合条件的...

那就自己来造一个吧 -。-

造轮子前

在准备动手解决问题前,我浏览了一下 npm 和 github 上已有的缩略组件,根据 star 数挑几个看看

react-lines-ellipsis

截止发文

  • stars 数 376
  • 未处理 issue 15
  • 上次功能更新 2 年前

问题:

  • 不支持结尾标点符号过滤,只能过滤空白符(可通过 pr 解决,但是作者很长时间未处理 pr 了)

  • 每个 ellipsis 组件都会生成一个隐藏的 div 去计算,性能损耗严重

    image
  • 不支持设置高度缩略

react-truncate

截止发文

  • stars 数 503
  • 未处理 issue 33
  • 上次功能更新 8 月前

问题:

  • 不支持结尾标点符号过滤,只能过滤空白符
  • 不支持按单词或字母切割
  • onResize 需要自行调用
  • 使用 canvas 实现,当元素较多时性能损耗严重

其他组件或多或少都有各自的问题导致无法满足我们的需求,所以动手自己撸吧。

轮子介绍

吭哧吭哧搞了一个下午就写完了,目前迭代到 0.5.2 版本。

先看个简单的示例

image

提示:容器拉伸是为了方便演示加的,实际组件不包含拉伸功能。

已经实现和计划中的功能:

已完成功能

  • 自定义缩略符
  • 自定义缩略符节点
  • 尾字符过滤
  • 缩略回调
  • 缩略符点击回调
  • 自适应

计划中

  • 按单词或字母分割
  • 支持内容换行
  • 支持收起符
  • ResizeObserver 不支持时用 window.onresize 兼容

具体功能和示例可以查看 react-ellipsis 文档

Q & A

  • 如何保障性能?

    切割算法上,其他组件大多是通过切割成字符数组后,一个个减少直到容器不再溢出,时间复杂度是 O(n)。react-ellipsis-component 使用二分切割将时间复杂度降到 O(logn)。

    计算时在原容器上计算,其他组件使用隐藏的 div 或者 canvas,当 ellipsis 组件很多时性能损耗严重。

    在自适应上,使用 ResizeObserver 实现,而其他组件使用 window.onresize(性能损耗比较大)。

  • 兼容性

    兼容性主要在于 ResizeObserver 实现的自适应缩略,如果不需要自适应缩略,可以覆盖绝大部分的现代浏览器。组件本身除了 react 不依赖其他库,兼容性有保证。

    后续会添加 window.onresize 的兼容逻辑进一步提高兼容性。

    附:ResizeObserver 兼容性表

    image
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 212,332评论 6 493
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,508评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 157,812评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,607评论 1 284
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,728评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,919评论 1 290
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,071评论 3 410
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,802评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,256评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,576评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,712评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,389评论 4 332
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,032评论 3 316
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,798评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,026评论 1 266
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,473评论 2 360
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,606评论 2 350

推荐阅读更多精彩内容