Code Monkey home page Code Monkey logo

react-truncatable's Introduction

React Truncatable

NPM Publish

Deploy storybook via chromatic

Overview

A React component that truncates text based on available space and supports multiline. Perfect for creating article previews, blog snippets, product card descriptions and many more.

Compatible with Next 13

Install

It can be installed with npm, yarn or pnpm

npm

  npm install react-truncatable

yarn

  yarn add react-truncatable

pnpm

  pnpm install react-truncatable

Usage

Include the css in _app.(tsx|jsx|js) or index.(tsx|jsx|js)or app.(tsx|jsx|js), or whatever is the root jsx file.

import "react-truncatable/style.css"

Include the import at the top, where the Truncatable will be used:

import Truncatable from "react-truncatable";

and use like so

<Truncatable content="Lorem ipsum dolor sit amet consectetur adipisicing elit. Dolore quae quas fugit repudiandae. A cumque dicta expedita, omnis ex voluptatibus eum quaerat ipsum molestiae id qui cum saepe labore inventore voluptas ipsam necessitatibus mollitia. Libero eum aliquam officiis sit reiciendis nihil hic suscipit delectus doloremque doloribus magnam, eligendi sequi!" />

You can also import the types, and use them if you need them (TS only)

import Truncatable, { ToggleProps } from "react-truncatable";

const b: Omit<ToggleProps, "togglerRef"> = {
  showAll: true,
  toggle() {

  },
};

console.log(b);

Help and Questions

Raise an issue here

Support the project

Don't forget to star the repository if it was helpful to you.

react-truncatable's People

Contributors

github-actions[bot] avatar irene-24 avatar

Stargazers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.