# vue-truncate-filter

> A filter for VueJs to truncate string

Latest version **1.1.7** (published 2017-08-25) · MIT license · 0 weekly downloads

## Install

```sh
npm install vue-truncate-filter
pnpm add vue-truncate-filter
yarn add vue-truncate-filter
bun add vue-truncate-filter
```

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.7 |
| Published | 2017-08-25 |
| First published | 2016-08-16 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 56 |
| Author | Nguyen Quoc Anh |
| Maintainers | imcvampire, pexea12 |
| Keywords | VueJS, truncate, filter |

## Links

- npm: https://www.npmjs.com/package/vue-truncate-filter
- Repository: https://github.com/imcvampire/vue-truncate-filter
- Homepage: https://github.com/imcvampire/vue-truncate-filter#readme
- Issues: https://github.com/imcvampire/vue-truncate-filter/issues
- npm.io page: https://npm.io/package/vue-truncate-filter

## Alternatives

- [@mce/gif](https://npm.io/package/@mce/gif.md) — 2.6K weekly downloads
- [cleanse](https://npm.io/package/cleanse.md) — 173 weekly downloads
- [str](https://npm.io/package/str.md) — 127 weekly downloads
- [naming](https://npm.io/package/naming.md) — 95 weekly downloads
- [tap-telco-api](https://npm.io/package/tap-telco-api.md) — 19 weekly downloads

## Recent versions

- 1.1.7 (latest) — 2017-08-25
- 1.1.6 — 2017-02-21
- 1.1.5 — 2016-11-14
- 1.1.4 — 2016-11-14
- 1.1.3 — 2016-11-14
- 1.1.1 — 2016-11-12
- 1.1.0 — 2016-11-11
- 1.0.0 — 2016-11-03
- 0.1.6 — 2016-08-18
- 0.1.5 — 2016-08-17
- 0.1.4 — 2016-08-16
- 0.1.3 — 2016-08-16
- 0.1.2 — 2016-08-16
- 0.1.1 — 2016-08-16
- 0.1.0 — 2016-08-16

## README

# vue-truncate-filter

[![Greenkeeper badge](https://badges.greenkeeper.io/imcvampire/vue-truncate-filter.svg)](https://greenkeeper.io/)

A filter for Vuejs to truncate string

## Install:

### CommonJS

 Available through npm as `vue-truncate-filter`: `npm install vue-truncate-filter --save`

  ``` js
  var VueTruncate = require('vue-truncate-filter')
  Vue.use(VueTruncate)
  ```

### Direct include

 - You can also directly include it with a `<script>` tag when you have Vue already included globally. It will automatically install itself, and will add a global `VueTruncate`.

## Usage:

### Vue 1.x
 ```html
  {{ text | truncate 100 '....' }}
 ```
### Vue 2.x
 ```html
  {{ text | truncate(100) }}
 ```
## Params:
- length (Number): Text will be truncated if it's length is more than this param.
  
- clamp (String) (default: `...`): It will be added to end of text if it's truncated.
  
## License

[MIT](http://opensource.org/licenses/MIT)

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