Labs/Jetpack/JEP/16: Difference between revisions

← Older edit

Labs/Jetpack/JEP/16 (view source)

Revision as of 23:32, 24 June 2009

211 bytes added , 24 June 2009

slideBar.append and callback updates

Mardak

383

edits

@@ Line 22: / Line 22: @@
 Where <tt>options</tt> is a property hash:
-* <tt>icon</tt> - icon to show in the SlideBar
+* <tt>icon</tt> <i>uri</i> - icon to show in the SlideBar
-* <tt>html</tt> - html content for the feature
+* <tt>html</tt> <i>text/xml</i> - html content for the feature
-* <tt>url</tt> - url to load content for the feature
+* <tt>url</tt> <i>uri</i> - url to load content for the feature
-* <tt>width</tt> - width of the content area and default size to slide to
+* <tt>width</tt> <i>num</i> - width of the content area and selected slide size
-* <tt>persist</tt> - default slide behavior when being selected
+* <tt>persist</tt> <i>bool</i> - default slide behavior when being selected
-* <tt>onClick</tt> - callback when the icon is clicked
+* <tt>autoReload</tt> <i>bool</i> - automatically reload content on select
-* <tt>onSelect</tt> - callback when the feature is selected
+* <tt>onClick</tt> <i>func</i> - callback when the icon is clicked
-* <tt>onReady</tt> - callback when the feature is loaded
+* <tt>onSelect</tt> <i>func</i> - callback when the feature is selected
+* <tt>onReady</tt> <i>func</i> - callback when the feature is loaded
 The callbacks are passed a property hash:
 * <tt>icon</tt> - node representing the icon in the SlideBar
-* <tt>doc</tt> - document element of the content area
+** <tt>icon.reload()</tt> - reload icon to original icon
-* <tt>reset()</tt> - reset the icon and content to the original values
+* <tt>contentDocument</tt> - document element of the content area
+** <tt>contentDocument.reload()</tt> - reload content to original url/html
 * <tt>close()</tt> - slide close the SlideBar
+* <tt>notify()</tt> - slide open (if necessary) and animate icon in the SlideBar
-The object passed to the callback is actually a function, <tt>slide(options)</tt>, where <tt>options</tt> is a property hash:
+* <tt>slide(num, { persist: <i>bool</i> })</tt> - slide to the provided size and optionally persist the SlideBar
-* <tt>size</tt> - number of pixels to slide
-* <tt>persist</tt> - true to keep the SlideBar open
 === Example ===