Added comments to jquery.tinyscrollbar

This commit is contained in:
Christiaan Rakowski
2013-04-15 20:58:48 +02:00
parent 6ed385610a
commit bc2c67c6cf
2 changed files with 34 additions and 2 deletions

View File

@@ -7,16 +7,47 @@
module JQueryTinyScrollbar {
export interface JQueryTinyScrollbarOptions {
/**
* Enable mobile invert style scrolling. (default: false)
*/
invertscroll?: bool;
/**
* Vertical or horizontal scroller? 'x' or 'y'. (default: 'x')
*/
axis?: string;
/**
* How many pixels must the mouswheel scrolls at a time. (default: 40)
*/
wheel?: number;
/**
* Enable or disable the mousewheel. (default: true)
*/
scroll?: bool;
/**
* Return scrollwheel event to browser if there is no more content. (default: true)
*/
lockscroll?: bool;
size?: any; //string or number
sizethumb?: any; //string or number
/**
* Set the size of the scrollbar to auto or a fixed number. (default: 'auto')
*/
size?: any;
/**
* Set the size of the thumb to auto or a fixed number. (default: 'auto')
*/
sizethumb?: any;
}
}
interface JQuery {
/**
* Creates a new tinyscrollbar with the specified, or default, options.
*
* @param options The options
*/
tinyscrollbar(options?: JQueryTinyScrollbar.JQueryTinyScrollbarOptions): JQuery;
/**
* Updates an existing tinyscrollbar with the specified, or default, options.
*
* @param options The options
*/
tinyscrollbar_update(options?: any): JQuery;
}