@cyriacbr/react-split-text
TypeScript icon, indicating that this package has built-in type declarations

1.0.0 • Public • Published

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>

Readme

Keywords

none

Package Sidebar

Install

npm i @cyriacbr/react-split-text

Weekly Downloads

324

Version

1.0.0

License

MIT

Unpacked Size

81.4 kB

Total Files

28

Last publish

Collaborators

  • cyriac_br