Skip to content
/ chop-lines Public

ChopLines is a React component which truncates lines of HTML.

Notifications You must be signed in to change notification settings

dw2/chop-lines

Repository files navigation

ChopLines

ChopLines is a lightweight React component which truncates multiple lines of HTML markup.

CircleCI Codecov

choplines-responsive

Installation

Add the dependency:

yarn add chop-lines

And then in your component(s):

import ChopLines from 'chop-lines';

Props

Prop Type Requirement
lines number required if maxHeight is not set
lineHeight number required if maxHeight is not set
maxHeight number required if lines & linesHeight are not set
ellipsis ReactNode or ReactElement<any> Optional (default: "…")
children ReactNode or ReactElement<any> required

Requirements

  • React 16.9+

Contributing

ChopLines follows semantic release versioning with Commitizen.

Committing

Install commitizen globally, if you have not already.

npm install -g commitizen

When you are ready to commit your changes…

git add .
git cz

Then, follow the CLI wizard.

Note: Choosing 'feat' or adding 'BREAKING CHANGE' in the commit will result in a major version bump during the release.

Testing

nvm use
yarn
yarn test

Additional Commands

Keep things tidy

yarn lint

Test that your changes compile

yarn build

License

MIT

About

ChopLines is a React component which truncates lines of HTML.

Resources

Stars

Watchers

Forks

Packages

No packages published