@erexstudio/react-read-more-text
TypeScript icon, indicating that this package has built-in type declarations

1.0.2 • Public • Published

Read More/Show Less Button

A versatile React component for seamlessly implementing "Read More/Show Less" functionality with customizable styles.

NPM Version npm bundle size NPM License

Read More/Show Less Button

Why Use @erexstudio/react-read-more-text?

The @erexstudio/react-read-more-text package provides a convenient and customizable solution for implementing "Read More/Show Less" functionality in your React applications. Here are some reasons why you should consider using this package:

1. Easy Integration:

  • Seamlessly integrate the "Read More/Show Less" button into your React components with just a few lines of code.

2. Customizable Styles:

  • Customize the appearance of the button to match your application's design by providing a JavaScript object with CSS properties.

3. Efficient Text Handling:

  • Efficiently handle long blocks of text by displaying a specified number of lines initially and allowing users to reveal more content at their convenience.

4. User-Friendly Experience:

  • Enhance the user experience by providing a clear and interactive way to manage lengthy text content, improving readability and user engagement.

5. Versatile Use Cases:

  • Use the @erexstudio/react-read-more-text component in various scenarios, such as user profiles, article previews, or any other content-heavy sections where a "Read More" feature is beneficial.

Installation

Install the npm i @erexstudio/react-read-more-text package using npm:

npm install @erexstudio/react-read-more-text

Usage

import React from "react";
import ReadMoreButton from "@erexstudio/react-read-more-text";

const MyComponent: React.FC = () => {
  const bioText = `...`; // Provide your text here

  const buttonStyles = {
    color: "blue", // Customize the button color
    // Add any other CSS styles as needed
  };

  return (
    <div>
      <ReadMoreButton text={bioText} linesToShow={5} styles={buttonStyles} />
    </div>
  );
};

export default MyComponent;

Props

  • text (string, required): The text to display.

  • `linesToShow (number, optional, default: 5): The number of lines to show initially before the "Read More" link.

  • `styles (object, optional): Custom styles for the button. You can pass a JavaScript object with CSS properties.

Example

import React from "react";
import ReadMoreButton from "@erexstudio/react-read-more-text";

const bioText = `...`;

const buttonStyles = {
  color: "green",
  fontSize: "16px",
  // Add any other CSS styles as needed
};

const UserProfile: React.FC = () => {
  return (
    <div>
      <ReadMoreButton text={bioText} linesToShow={5} styles={buttonStyles} />
    </div>
  );
};

export default UserProfile;

License

This project is licensed under the ISC License - see the LICENSE file for details.

Package Sidebar

Install

npm i @erexstudio/react-read-more-text

Weekly Downloads

1

Version

1.0.2

License

ISC

Unpacked Size

8.09 kB

Total Files

6

Last publish

Collaborators

  • erexstudio