squirrel-ellipsis

an Expandable Multiline Text Component designed for React

:sparkles: inspired by react-lines-ellipsis

squirrel-ellipsis

an Expandable Multiline Text Component designed for React

Preview

import SquirrelEllipsis from "squirrel-ellipsis";

...

const EXAMPLE_TEXT =
  "Roughly a year ago I moved into my new apartment. One of the reasons I picked this apartment was age of the building. The construction was finished in 2015, which ensured pretty good thermal isolation for winters as well as small nice things like Ethernet ports in each room. However, there was one part of my apartment that was too new and too smart for me. ";

<SquirrelEllipsis
  text={EXAMPLE_TEXT}
  maxLine={2}
  action={
    <a
      style={{
        fontWeight: 400,
        color: "#5b5b5b",
        textDecorationLine: "underline",
      }}
    >
      More
    </a>
  }
  basedOn="words"
  onReflow={handleReflow}
/>;

Features

• :fax: Multiline Text Ellipsis: Supports the display of multiline text and allows customization of the maximum number of lines shown.

• :pencil: Automatic Punctuation Removal at Ellipsis: When text is truncated, the component automatically removes any punctuation marks at the end of the visible text.

• :ghost: Expandable Content with Customizable Ellipsis and Button: Users can expand the text to view the full content. The component supports customization of both the ellipsis indicator and the expand button.

• :mushroom: Responsive Design: Implemented using ResizeObserver for responsive behavior, ensuring the component adjusts to varying container sizes.

• :paw_prints: Reflow Callback: On reaching its final display state, the component calls a reflow function. This feature can be integrated with react-virtualized's CellMeasurer to achieve a virtual list with variable row heights.

Options

| key | desc | type | defaultValue | | ----------- | ----------------------------------------------------------------- | ------------------------------------------------- | ------------------- | | text | just text | string | - | | maxLine | max count of lines allowed, ”null“ for no ellipsis | number | - | | basedOn | "word" or "letter", the default value is based on text | string | - | | ellipsis | the ellipsis indicator | ReactNode | string |  ...  | | action | the expend button | ReactNode | string | more | | trimEndPunc | remove any punctuation marks at the end of the text when ellipsis | boolean | true | | onReflow | the callback func when the final state is determined | (clamped: boolean, displayedText: string) => void | - |

Install

With yarn:

yarn add squirrel-ellipsis

With npm:

npm install --save squirrel-ellipsis

Examples

SquirrelEllipsis Example

Development

For dependencies,

yarn run bootstrap

Then

yarn run start
cd site
yarn run dev

Preview

import SquirrelEllipsis from "squirrel-ellipsis";

...

const EXAMPLE_TEXT =
  "Roughly a year ago I moved into my new apartment. One of the reasons I picked this apartment was age of the building. The construction was finished in 2015, which ensured pretty good thermal isolation for winters as well as small nice things like Ethernet ports in each room. However, there was one part of my apartment that was too new and too smart for me. ";

const handleReflow = (clamped, displayedText) => {
   console.log(clamped, displayedText)
}

<SquirrelEllipsis
  text={EXAMPLE_TEXT}
  maxLine={2}
  action={
    <a
      style={{
        fontWeight: 400,
        color: "#5b5b5b",
        textDecorationLine: "underline",
      }}
    >
      More
    </a>
  }
  basedOn="words"
  onReflow={handleReflow}
/>;

Features

• :fax: Multiline Text Ellipsis: Supports the display of multiline text and allows customization of the maximum number of lines shown.

• :pencil: Automatic Punctuation Removal at Ellipsis: When text is truncated, the component automatically removes any punctuation marks at the end of the visible text.

• :hamburger: Expandable Content with Customizable Ellipsis and Button: Users can expand the text to view the full content. The component supports customization of both the ellipsis indicator and the expand button.

• :mushroom: Responsive Design: Implemented using ResizeObserver for responsive behavior, ensuring the component adjusts to varying container sizes.

• :ghost: Reflow Callback: On reaching its final display state, the component calls a reflow function. This feature can be integrated with react-virtualized's CellMeasurer to achieve a virtual list with variable row heights.

Options

| key | desc | type | defaultValue | | ----------- | ----------------------------------------------------------------- | ------------------------------------------------- | ------------------- | | text | just text | string | - | | maxLine | max count of lines allowed, ”null“ for no ellipsis | number | - | | basedOn | "word" or "letter", the default value is based on text | string | - | | ellipsis | the ellipsis indicator | ReactNode | string |  ...  | | action | the expend button | ReactNode | string | more | | trimEndPunc | remove any punctuation marks at the end of the text when ellipsis | boolean | true | | onReflow | the callback func when the final state is determined | (clamped: boolean, displayedText: string) => void | - |

Install

With yarn:

yarn add squirrel-ellipsis

With npm:

npm install --save squirrel-ellipsis

Examples

Development

For dependencies,

yarn run bootstrap

Then

yarn run start
cd site
yarn run dev