Skip to content
Multi-line ellipsis made possible
JavaScript CSS
Branch: master
Clone or download
Latest commit f7f867e Aug 14, 2014
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
build Add ms vendor support Jul 31, 2013
examples Add ms vendor support Jul 31, 2013
lib Ensure that the size is set in px Aug 13, 2014
test Fix superagent breaking buster May 23, 2013
.gitignore Added component.json Dec 12, 2012
.npmignore - First commit Dec 11, 2012
.travis.yml Update .travis.yml Aug 21, 2013
GruntFile.js Fix readme generation (fixes #2) May 28, 2013
LICENSE-MIT Updated licence May 8, 2013
README.md Fix typo May 28, 2013
bower.json Remove version from bower.json as it add unnecessary release overhead Aug 14, 2014
package.json 0.2.3 Aug 14, 2014

README.md

FTEllipsis Build Status

Solves the problem of applying ellipsis (…) on a multi-line block of text at the point it overflows its container. Ellipsis will work in conjuction with CSS column-count if you wish.

Results are best in webkit browsers due to the availability of webkit-line-clamp. For non-webkit browsers FTEllipsis falls back to clamping text and positioning an element over the end of the overflowing line, allowing the developer to style this however they wish.

Getting Started

NPM
$ npm install ftellipsis
Bower
$ bower install ftellipsis

or download the production version or the development version.

Examples

Usage

var element = document.getElementById('my-element');
var ellipsis = new Ellipsis(element);

ellipsis.calc();
ellipsis.set();

Requirements:

  • The element must have a fixed height so that content overflows.
  • The element must have child elements (eg. <p>s).

Unsetting

Unsetting an ellipsis instance removes any styling.

ellipsis.unset();

Destroying

Destroying an ellipsis instance resets the instance back to it's original state, unsetting internal variables and state.

ellipsis.destroy();

Tests

$ npm install
$ npm test

API

Ellipsis();

Initialize a new Ellipsis instance with the given element.

Options:

  • container A parent container element
  • reRender Forces a redraw after ellipsis applied

Ellipsis#calc();

Measures the element and finds the overflowing child.

Ellipsis#set();

Clamps the overflowing child using the information acquired from #calc().

Ellipsis#unset();

Unclamps the overflowing child.

Ellipsis#destroy();

Clears any references

Credits and collaboration

The lead developer of FTEllipsis is Wilson Page at FT Labs. All open source code released by FT Labs is licenced under the MIT licence. We welcome comments, feedback and suggestions. Please feel free to raise an issue or pull request. Enjoy...

You can’t perform that action at this time.