Deprecation warning

This package has been moved to @yellowspot/ng-truncate

ng2-truncate


This project is a Angular 4+ pipe to truncate text to a set of characters or words.

CI Status

!CI Status

Installation

To install this library, run:

``bash
$ npm install ng2-truncate --save
`

Example

By default, the pipe will truncate text after 40 characters. You could override this using the first argument:

`TypeScript
import { Component } from '@angular/core';
import { TruncateModule } from 'ng2-truncate';

@Component({
selector: 'my-component',
template: '

{{ "123456789" | truncate : 3 }}

'
})
export class MyComponent {

}

@NgModule({
imports: [ TruncateModule ],
declarations: [ MyComponent ]
})
export class MyApp { }
`

This will produce the following html

`HTML


123…


`

There is a second argument which allow to override the suffix used:

`TypeScript
@Component({
...
template: '

{{ "123456789" | truncate : 3 : "xxx" }}

',
...
})
`

This will produce the following html

`HTML


123xxx


`

You can also truncate left side by using negative limit

`TypeScript
@Component({
...
template: '

{{ "123456789" | truncate : -4 : "…" }}

',
...
})
`

This will produce the following html

`HTML


…6789


`

Truncate by words

Using TruncateModule also enable truncating by words

`TypeScript
import { Component } from '@angular/core';
import { TruncateModule } from 'ng2-truncate';

@Component({
selector: 'my-component',
template: '

{{ "1234 567 89" | words : 2 }}

'
})
export class MyComponent {

}

@NgModule({
imports: [ TruncateModule ],
declarations: [ MyComponent ]
})
export class MyApp { }
`

This will produce the following html

`HTML


1234 567…


`

This pipe has also a second parameter to override the suffix used

Demo

Check out the Live demo

...Or modify on Plunker here

...Or clone the demo app built using angular-cli: https://github.com/yellowspot/ng2-truncate-demo

Development

To generate all .js, .js.map and *.d.ts files:

`bash
$ npm run tsc
`

To lint all *.ts files:

`bash
$ npm run lint
`

To execute all test via via Karma:

`bash
$ npm run test
``