package
A re-implementation of splitting.js (a text segmenter for animation) for React supporting SSR/SSG.
npm install react-splittingGitHub-flavored package documentation.
Across all versions.
Download trend unavailable.
Runtime metadata.
Tagged topics.
Estimated unpacked size across 3 packages.
750.1 kB
Includes dependencies.
Latest published Apr 7, 2026
rc20
An (incomplete) re-implementation of splitting.js (a text segmenter for animation) for React supporting SSR/SSG.
This is a re-implementation because the original works with real DOM nodes. Converting ReactNodes to such then back again might preserve most--if not all--attributes, but will definitely lose all React event handlers.
[!WARNING]
- Only "chars" and "words" are supported for the
byproperty.<script>and<style>elements are property ignored.- The
keyoption was renamed tocssKeyto avoid a conflict with React's ownkeyproperty.
- It is properly prefixed.
[!NOTE]
- This library comes in two variants: one with "meta" and one without. The "meta" variant is a drop-in replacement for the original library as it replicates its CSS classes, CSS variables,
data-*attributes, lack of proper multilingual support and some quirky whitespace handling.- Each variant can be used as a component--which offers nothing additional--or as a function--which adds segment counts and access to segment nodes before they're rendered.
npm install react-splitting<Splitting /> / splitting()Lightweight and completely customizable.
import { Segmentation, Splitting } from 'react-splitting';
export default () => (
<>
<p>
<Splitting by={Segmentation.WORDS}>
Text <strong>split</strong> by <em>words</em>.
</Splitting>
</p>
<p>
<Splitting by={Segmentation.CHARS}>
Text <strong>split</strong>
import { Segmentation, splitting } from 'react-splitting';
export default () => {
const { charCount, segments, wordCount } = splitting(
<>
Text <strong>split</strong> by <em>words</em>.
</>,
{
by: Segmentation.WORDS,
charProps: i => ({ className: 'char', style: { '--char-index': i } }),
wordProps: i => ({ className: 'word', style: { '--word-index': i } }),
}
);
<SplittingWithMeta /> / splittingWithMeta()Drop-in replacement.
import { SplittingWithMeta } from 'react-splitting/with-meta';
export default () => (
<SplittingWithMeta as="div">
Text with <strong>added metadata</strong>, split by <em>characters</em>.
</SplittingWithMeta>
);import { splittingWithMeta } from 'react-splitting/with-meta';
export default () => {
const { charCount, container, wordCount } = splittingWithMeta(
<>
Text with <strong>added metadata</strong>, split by <em>characters</em>.
</>,
{ as: 'div' }
);
return container;
};npm run buildThe test suite can perform a single run:
npm test… or indefinitely as files are changed:
npm run test:watchrewriteRelativeImportExtensions with allowImportingTsExtensions when possible.