react-truncate-list v1.0.3

react-truncate-list

Truncate a list of elements with a symbol or component of your choice.

• no opinionated styles - fully customizable
• < 1kb bundle size
• SSR friendly

Demo

A demo is worth a thousand words.

Purpose

Have you ever needed to make something like the design below?

This is surprisingly hard to accomplish, as there is no way to know ahead of time how many items can fit within the space available. This is a low-level library to give you the tools necessary to make this a breeze.

Installation

1. Add the react-truncate-list package

# npm
npm i react-truncate-list

# yarn
yarn add react-truncate-list

2. If your project does not already include it, add the resize-observer-polyfill package

# npm
npm i resize-observer-polyfill

# yarn
yarn add resize-observer-polyfill

3. Import the package and its required CSS and use it 🚀

import TruncatedList from "react-truncate-list";
import "react-trucate-list/dist/styles.css";

How to use

This library simply provides an unstyled <ul> that will render a component of your choice after the last item that fits within it before overflowing. It is up to you to provide a max-height or some other constraint on its dimensions so that it will experience overflow behaviour.

Please see the demo for concrete examples for how the library can be used. As this is a low-level library, it takes a little more work than you may be used to. However this will empower you to customise the list to look and behave exactly as you need.

API

Props

type RenderTruncator = ({
  hiddenItemsCount,
}: {
  hiddenItemsCount: number;
}) => React.ReactNode;

interface Props {
  renderTruncator: RenderTruncator;
  children?: React.ReactNode;
  alwaysShowTruncator?: boolean;
  className?: string;
  itemClassName?: string;
  style?: React.CSSProperties;
}

renderTruncator

A render function called to display a 'truncator' after the last item before overflowing the container.

renderTruncator={({ hiddenItemsCount }) => (
  <span>{hiddenItemsCount} more items...</span>
)}

children (optional)

Pass the list items as children. Each child will be automatically wrapped in an <li>.

alwaysShowTruncator (optional)

Always show the 'truncator', even when all items are visible. Useful for advanced use-cases such as an expanding list.

itemClassName (optional)

Class name to apply to the generated <li> tags wrapping each child of the list. Typically you will not need this and will instead apply a class name directly to the children.

SSR

Before hydration, the list will have overflow: auto applied to it so that it is scrollable. Once hydrated in the client, a layout effect will fire, shortening the list and inserting the 'truncator'.