# @clampy-js/clampy

> Clamps an HTML element by adding ellipsis to it if the content inside is too long.

Latest version **1.0.10** (published 2019-06-05) · MIT license · 0 weekly downloads

## Install

```sh
npm install @clampy-js/clampy
pnpm add @clampy-js/clampy
yarn add @clampy-js/clampy
bun add @clampy-js/clampy
```

## Health

**Score 30/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.10 |
| Published | 2019-06-05 |
| First published | 2017-09-19 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Node | >=6.0.0 |
| Dependencies | 0 |
| Unpacked size | 2.8 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 12 |
| Author | Alexandre Moore |
| Maintainers | alexandre.moore |
| Keywords | clamp, ellipsis, clampy-js, clampy |

## Links

- npm: https://www.npmjs.com/package/@clampy-js/clampy
- Repository: https://github.com/clampy-js/clampy
- Homepage: https://github.com/clampy-js/clampy#readme
- Issues: https://github.com/clampy-js/clampy/issues
- npm.io page: https://npm.io/package/@clampy-js/clampy

## Recent versions

- 1.0.10 (latest) — 2019-06-05
- 1.0.9 — 2018-05-14
- 1.0.8 — 2018-04-25
- 1.0.7 — 2018-01-16
- 1.0.6 — 2017-11-08
- 1.0.5 — 2017-09-20
- 1.0.4 — 2017-09-20
- 1.0.3 — 2017-09-20
- 1.0.2 — 2017-09-19
- 1.0.1 — 2017-09-19
- 1.0.0 — 2017-09-19

## README

# clampy

### Clamps an HTML element by adding ellipsis to it if the content inside is too long.
[![Build Status](https://img.shields.io/travis/clampy-js/clampy.svg)](https://travis-ci.org/clampy-js/clampy)
[![GitHub issues](https://img.shields.io/github/issues/clampy-js/clampy.svg)](https://github.com/clampy-js/clampy/issues)
[![GitHub license](https://img.shields.io/github/license/clampy-js/clampy.svg)](https://github.com/clampy-js/clampy/blob/master/LICENSE)
[![npm](https://img.shields.io/npm/dt/@clampy-js/clampy.svg)]()

This is basically a fork of the (unfortunately abandoned) project [Clamp.js](https://github.com/josephschmitt/Clamp.js) partially converted to Typescript and bundled using the excellent [Typescript library starter](https://github.com/alexjoverm/typescript-library-starter) from [Alex Jover](https://github.com/alexjoverm).

Most fixes from pull requests on the original project were included.

*Note that the following options were removed from the original library:

 - useNativeClamp
 - animate


## Documentation
Documentation is available [here](./dist/docs/).

## Examples
A demo is available [here](./demo/).

---
_Source: https://npm.io/package/@clampy-js/clampy · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._