Added dotdotdot definitions.

2026-09-09 11:13:57 +08:00 · 2014-11-13 00:21:12 +01:00
parent bbbca02b99
commit 6e4aec7eea
2 changed files with 130 additions and 0 deletions
@@ -0,0 +1,76 @@
+// Type definitions for dotdotdot v1.6.16
+// Project: http://dotdotdot.frebsite.nl/
+// Definitions by: Milan Jaros <https://github.com/milanjaros>
+// Definitions: https://github.com/borisyankov/DefinitelyTyped
+
+interface JQuery {
+    /**
+      * jQuery.dotdotdot is an advanced cross-browser ellipsis for multiple line content plugin.
+      * @param options settings that could modify a behaviour. 
+      */
+    dotdotdot(options?: JQueryDotDotDot.IDotDotDotOptions): JQuery;
+}
+
+declare module JQueryDotDotDot {
+    interface IDotDotDotOptions {
+        /**	The text to add as ellipsis. 
+          * Default: '... '
+          */
+        ellipsis?: string;
+
+        /** How to cut off the text/html: 'word'/'letter'/'children' 
+          * Default: 'word'
+          */
+        wrap?: string;
+
+        /** Wrap-option fallback to 'letter' for long words 
+          * Default: true
+          */
+        fallbackToLetter?: boolean;
+
+        /** jQuery-selector for the element to keep and put after the ellipsis. 
+          * Default: null
+          */
+        after?: JQuery;
+
+        /** Whether to update the ellipsis: true/'window' 
+          * Default: false
+          */
+        watch?: boolean;
+
+        /** Optionally set a max-height, if null, the height will be measured. 
+          * Default: null
+          */
+        height?: number;
+
+        /** Deviation for the height-option.
+          * Default: 0 
+          */
+        tolerance?: number; // 
+
+        /** Callback function that is fired after the ellipsis is added,
+          * receives two parameters:
+          * @param isTruncated (boolean)
+          * @param orgContent (string) Documentation says it is string but it is object
+          *        which has e.g. 
+          *                 context: HTMLHtmlElement; 
+          *                 length: number; // seems to be always 1  
+          *                 [index] // this contains the text: orgContent[0].data
+          */
+        callback? (isTruncated: boolean, orgContent: any): void;
+
+        lastCharacter?: IDotDotDotOptionsLastCharacter;
+    }
+
+    interface IDotDotDotOptionsLastCharacter {
+        /** Remove these characters from the end of the truncated text. 
+          * Default: [' ', ',', ';', '.', '!', '?']
+          */
+        remove?: string[];
+        /** Don't add an ellipsis if this array contains 
+          * the last character of the truncated text. 
+          * Default:  []
+          */
+        noEllipsis?: string[];
+    }
+}