jQuery-Slithery/README at master · Goosk/jQuery-Slithery · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
=== jQuery Slithery ===
Current version: 0.2.1
Author: Goosk
Contact: admin@goosk.se


=== How to use ===
	See example.html

	Arguments available:
		(optional) Position:		The position of the element, valid arguments: top, right, left, bottom. (default: top).
		(optional) Easing:			Animation to use when the object is shown/hidden, by default only linear and swing are
									available. If you want more effects you can download jQuery.ui for example:
									(http://jqueryui.com/demos/effect/easing.html)
		(optional) Top:				The amount of pixels from the top of the page before the element will be displayed.
		(optional) Speed:			The time (in milliseconds) it takes for the element to be fully displayed.
		(optional) onShow:			Function to be run each time the element starts to show.
		(optional) onFullyShown:	Function to be run each time the element is fully shown.
		(optional) onHide:			Function to be run each time the element starts to hide.
		(optional) onFullyHidden:	Function to be run each time the element is fully hidden.


=== Changelog ===
# Legend:
	+ New feature
	~ Bugfix/change
	- Removed feature

# 0.2.1 [2012-08-25]
	~ Altered the code a bit
	+ Added new hooks (onFullyHidden and onFullyShown) which are run when the element has fully
	  finished animating and altered the old ones (onHide, onShow) to trigger when the element
	  begins animating.


# 0.2 [2012-03-17]
	+ Elements can now be positioned on every side of the browser and not just on the top.
	+ Added ability to define which easing effect to be used, can be extended using jQuery.ui
	~ Fixed where the element would not hide if it had not finished animating and the user
	  scrolled back up above the threshold.


# 0.1-dev [2012-03-16]
	+ First release