react-ellipsis

A wrapper component that adds an Ellipsis to the end of a single or multiline text.

Installation

$ npm install @moxy/react-ellipsis

This library is written in modern JavaScript and is published in both CommonJS and ES module transpiled variants. If you target older browsers please make sure to transpile accordingly.

Motivation

Truncating a text and appending an ellipsis (...) to the end of it is a very common use case. It's pretty straightforward to implement, by using CSS only, if we're talking single line. However, for multi-line texts, things get a little bit trickier. Even trickier when you don't really know how many lines of text you're going to have, as it all depends on the css properties you will set for the <div> your text will be in. This package aims to ease the pain of appending an ellipsis to any text, while also taking care of responsivity.

Usage

In the component where the truncated text is meant to be placed, import the Ellipsis component and just send the text as its child, in string format. Like so:

import React from 'react';
import Ellipsis from '@moxy/react-ellipsis';

import styles from '...';

const Home = () => (
    <div>
        <h1>react-ellipsis</h1>
        <Ellipsis className={ styles.text }>
            Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Vestibulum tortor quam, feugiat vitae, ultricies eget, tempor sit amet, ante. Donec eu libero sit amet quam egestas semper. Aenean ultricies mi vitae est. Mauris placerat eleifend leo. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Vestibulum tortor quam, feugiat vitae, ultricies eget, tempor sit amet, ante. Donec eu libero sit amet quam egestas semper. Aenean ultricies mi vitae est. Mauris placerat eleifend leo. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Vestibulum tortor quam, feugiat vitae, ultricies eget, tempor sit amet, ante. Donec eu libero sit amet quam egestas semper. Aenean ultricies mi vitae est. Mauris placerat eleifend leo.
        </Ellipsis>
    </div>
);

It works just fine if you pass a height and/or width as a style to the Ellipsis. The text will then appear truncated, with an ellipsis appended at the end.

API

These are the props available in @moxy/react-ellipsis. Besides these, additional props are spread to the component. This means you can also pass some useful callbacks (onMouseEnter, onMouseLeave, onClick, etc) if you want.

children

Type: string Required: true

A string to be truncated by the Ellipsis component.

tag

Type: string Default: p

A HTML tag to wrap the truncated text.

className

Type: string

A className to apply to the component.

throttleWaitTime

Type: Number Default: 250

The wait time, in milliseconds, to apply to the internal throttled function that handles window resizing.

Tests

$ npm test
$ npm test -- --watch # during development

Demo

A demo Next.js project is available in the /demo folder so you can try out this component.

First, build the react-ellipsis project with:

$ npm run build

To run the demo, do the following inside the demo's folder:

$ npm i
$ npm run dev

Note: Everytime a change is made to the package a rebuild is required to reflect those changes on the demo.

FAQ

I can't override the component's CSS, what's happening?

There is an ongoing next.js issue about the loading order of modules and global CSS in development mode. This has been fixed in v9.3.6-canary.0, so you can either update next.js to a version higher than v9.3.5, or simply increase the CSS specificity when overriding component's classes, as we did in the demo, e.g. having the page or section CSS wrap the component's one.

License

Released under the MIT License.