Package detail

ngx-clamp

MSubhan01126ISC1.0.10

This library was generated with Angular CLI version 12.2.0.

clamp, ng-clamp, ngx-clamp, html-clamp, line-clamp, text-clamp, angular-clamp

readme

ngx-clamp

Angular (12+) directive that clamps the content of an element by adding an ellipsis to it if the content inside is too long.

version on NPM bundle size license

It uses clamp.ts library behind the scene to apply the ellipsis.

It automatically re-clamps itself when the element or the browser window change size.

Installation

For Angular 12, use version latest.

You can install ngx-clamp using NPM or Yarn:

npm install ngx-clamp

yarn add ngx-clamp

Usage

You can use it by just adding the directive selector to the element and it will clamp that element's content to two lines. Example:

<p ngx-clamp>
...
</p>

You can also change the options by adding the input of "ngxClampOptions" on the element. Example:

<p ngx-clamp [ngxClampOptions]="{ clamp: 3, // options here, read below for more info }">
...
</p>

You can also listen to 'ngxClampResponse' event which is emitting the original value upon clamping. This can be useful if you want to display the original content in a tooltip for instance. Example:

<p ngx-clamp (ngxClampResponse)="getTooltipContent($event)">
...
</p>

ngxClampOptions

Option	Type	Default	Description
clamp	`number	string	‘auto’`
useNativeClamp	boolean	`true`	Enables or disables using the native `-webkit-line-clamp` in a supported browser (ie. Webkit). It defaults to true if you're using Webkit, but it can behave wonky sometimes so you can set it to false to use the JavaScript-based solution.
truncationChar	string	`…`	The character to insert at the end of the HTML element after truncation is performed. This defaults to an ellipsis (…).
truncationHTML	string	\| A string of HTML to insert before the truncation character. This is useful if you'd like to add a "Read more" link or some such thing at the end of your clamped node.
splitOnChars	Array	`['.', '-', '–', '—', ' ']`	Determines what characters to use to chunk an element into smaller pieces. you have an option to pass a list of characters it can use. For example, it you pass an array of `['.', ',', ' ']` then it will first remove sentences, then remove comma-phrases, and remove words, and finally remove individual characters to try and find the correct height. This will lead to increased performance and less looping when removing larger pieces of text (such as in paragraphs). The default is set to remove sentences (periods), hypens, en-dashes, em-dashes, and finally words (spaces). Removing by character is always enabled as the last attempt no matter what is submitted in the array.
animate	Boolean	`false`	Silly little easter-egg that, when set to true, will animate removing individual characters from the end of the element until the content fits. Defaults to `false`.