Browse files

Tooltip: Add option example values

  • Loading branch information...
1 parent 010a892 commit 5282d95322c31d79f1a7b5660413d7a586435328 @jzaefferer jzaefferer committed Oct 25, 2012
Showing with 7 additions and 7 deletions.
  1. +5 −5 entries/tooltip.xml
  2. +1 −1 includes/widget-option-hide.xml
  3. +1 −1 includes/widget-option-show.xml
@@ -18,7 +18,7 @@
<note id="functional-css"/>
- <option name="content" default="function returning the title attribute">
+ <option name="content" default="function returning the title attribute" example-value='"Awesome title!"'>
<p>The content of the tooltip.</p>
@@ -33,27 +33,27 @@
<xi:include href="../includes/widget-option-disabled.xml" xmlns:xi=""/>
<xi:include href="../includes/widget-option-hide.xml" xmlns:xi=""/>
- <option name="items" default="[title]">
+ <option name="items" default="[title]" example-value='"img[alt]"'>
<p>A selector indicating which items should show tooltips. Customize if you're using something other then the title attribute for the tooltip content, or if you need a different selector for event delegation.</p>
<p><em>When changing this option, you likely need to also change the <a href="#option-content"><code>content</code></a> option.</em></p>
<type name="Selector" />
- <option name="position" default='{ my: "left+15 center", at: "right center", collision: "flipfit" }'>
+ <option name="position" default='{ my: "left+15 center", at: "right center", collision: "flipfit" }' example-value='{ my: "center top", at: "center bottom+5" }'>
<desc>Configuration for the Position utility. The <code>of</code> property defaults to the target element, but can also be overriden.</desc>
<type name="Object" />
<xi:include href="../includes/widget-option-show.xml" xmlns:xi=""/>
- <option name="tooltipClass" default="null">
+ <option name="tooltipClass" default="null" example-value='"custom-tooltip-styling"'>
A class to add to the widget, can be used to display various tooltip types, like warnings or errors.
<p>This may get replaced by the <a href="">classes option</a>.</p>
<type name="String" />
- <option name="track" type="Boolean" default="false">
+ <option name="track" type="Boolean" default="false" example-value="true">
Whether the tooltip should track (follow) the mouse.
@@ -1,5 +1,5 @@
<?xml version="1.0"?>
-<option name="hide" default="null">
+<option name="hide" default="null" example-value='{ effect: "explode", duration: 1000 }'>
<desc>If and how to animate the hiding of the <placeholder name="animated-element"/>.</desc>
<type name="Boolean">
@@ -1,5 +1,5 @@
<?xml version="1.0"?>
-<option name="show" default="null">
+<option name="show" default="null" example-value='{ effect: "blind", duration: 800 }'>
<desc>If and how to animate the showing of the <placeholder name="animated-element"/>.</desc>
<type name="Boolean">

0 comments on commit 5282d95

Please sign in to comment.