@cyriacbr/react-split-text

中文文档
1.0.0发布于 2020/06/13MITTypeScriptESM + CJS零依赖近 30 天下载 3821

CI

原始使用文档

React Split Text

CI

This component lets you split your text, and wrap each line, word or letter with a custom element. The lines and words are correctly split according to how they fit in the layout. The component doesn't change that behavior, it justs analyze the text and wrap each line, word and letter in a custom element. This lib is useful when trying to make text animations or special effects with texts.

Features

  • Zero-dependency 1.3 KB minified and gzipped
  • Wrap your letters, words or lines with custom elements
  • Respect and keep your layout integrity
  • Readjust on resize
  • Support dynamic text

Usage

import { Playground, Props } from 'docz'; import { SplitText, LineWrapper, WordWrapper, LetterWrapper } from '../../src/index.ts';

To use this library, simply wrap your text with the SplitText component. The text will automatically be wrapped, by default with span elements, and will be readjusted on resize. You can inspect the bellow result to see how each line, word and letter are wrapped with a span.

<SplitText>
  Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat
</SplitText>

版本与发布记录

@cyriacbr/react-split-text 共发布 1 个版本,首次发布于 2020/06/13;过去 12 个月发布了 0 个版本。

版本发布日期距今
1.0.0latest2020/06/136 年前

关于 @cyriacbr/react-split-text 的常见问题

如何安装 @cyriacbr/react-split-text?

在项目目录运行 npm install @cyriacbr/react-split-text,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:react(>=16)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@cyriacbr/react-split-text 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@cyriacbr/react-split-text 支持 ESM 还是 CommonJS?

同时提供 ES Module 与 CommonJS 入口,import 和 require() 都可以使用,打包工具会自动选择合适的版本。

@cyriacbr/react-split-text 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >=10。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@cyriacbr/react-split-text 可以商用吗?

@cyriacbr/react-split-text 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@cyriacbr/react-split-text 的下载量有多少?

根据 npm 官方下载统计,@cyriacbr/react-split-text 在 2026/10/11 – 2026/11/09 这 30 天内被下载 3,821 次,日均约 127 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@cyriacbr/react-split-text 还在维护吗?

最新版本 1.0.0 发布于 2020/06/13(6 年前);至今共发布 1 个版本,其中过去 12 个月发布了 0 个;首次发布于 2020/06/13。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。