Skip to content

Latest commit

 

History

History
93 lines (68 loc) · 3.07 KB

README.md

File metadata and controls

93 lines (68 loc) · 3.07 KB
Raw

jQuery.dotdotdot

A jQuery plugin for advanced cross-browser ellipsis on multiple line content.
Demo's and documentation: http://dotdotdot.frebsite.nl

Note:
Because its performance can not be improved, this plugin is no longer actively maintained.
Feel free to use it and submit pull requests though.

How to use the plugin

Integration to your page

Include all necessary .js-files inside the head-tag of the page.

<head>
    <script src="jquery.js" type="text/javascript"></script>
    <script src="jquery.dotdotdot.js" type="text/javascript"></script>
</head>

Then you can use either CSS or JS approach or use them both.

CSS approach

You can add one or several CSS classes to HTML elements to automatically invoke "jQuery.dotdotdot functionality" and some extra features. It allows to use jQuery.dotdotdot only by adding appropriate CSS classes without JS programming.

Available classes and their description:

  • dot-ellipsis - automatically invoke jQuery.dotdotdot to this element. This class must be included if you plan to use other classes below.
  • dot-resize-update - automatically update if window resize event occurs. It's equivalent to option watch:'window'.
  • dot-timer-update - automatically update if window resize event occurs. It's equivalent to option watch:true.
  • dot-load-update - automatically update after the window has beem completely rendered. Can be useful if your content is generated dynamically using JS and, hence, jQuery.dotdotdot can't correctly detect the height of the element before it's rendered completely.
  • dot-height-XXX - available height of content area in pixels, where XXX is a number, e.g. can be dot-height-35 if you want to set maximum height for 35 pixels. It's equivalent to option height:'XXX'.

Examples

Adding jQuery.dotdotdot to element:

<div class="dot-ellipsis">
	<p>Lorem Ipsum is simply dummy text.</p>
</div>

Adding jQuery.dotdotdot to element with update on window resize:

<div class="dot-ellipsis dot-resize-update">
	<p>Lorem Ipsum is simply dummy text.</p>
</div>

Adding jQuery.dotdotdot to element with predefined height of 50px:

<div class="dot-ellipsis dot-height-50">
	<p>Lorem Ipsum is simply dummy text.</p>
</div>

Javascript approach

Create a DOM element and put some text and other HTML markup in this "wrapper".

<div id="wrapper">
    <p>Lorem Ipsum is simply dummy text.</p>
</div>

Fire the plugin onDocumentReady using the wrapper-selector.

$(document).ready(function() {
    $("#wrapper").dotdotdot({
        // configuration goes here
    });
});

Authors and Contributors

More info

Please visit http://dotdotdot.frebsite.nl

Licence

The jQuery.dotdotdot plugin is licensed under the MIT license: http://en.wikipedia.org/wiki/MIT_License