]> git.ipfire.org Git - thirdparty/bootstrap.git/commitdiff
Document `template` option of tooltip & popover; fixes #13088 13184/head
authorChris Rebert <code@rebertia.com>
Wed, 26 Mar 2014 02:12:16 +0000 (19:12 -0700)
committerChris Rebert <code@rebertia.com>
Wed, 26 Mar 2014 19:40:23 +0000 (12:40 -0700)
Also capitalize column titles and descriptions.

docs/_includes/js/popovers.html
docs/_includes/js/tooltips.html

index 56e3600aa45a7d518dcf7d2c8ea1065ada7a53b0..739d86bce7eb77cb2be29a59f7ea84d0b0b1d4b4 100644 (file)
@@ -135,9 +135,9 @@ $('.popover-dismiss').popover({
       <thead>
         <tr>
           <th style="width: 100px;">Name</th>
-          <th style="width: 100px;">type</th>
-          <th style="width: 50px;">default</th>
-          <th>description</th>
+          <th style="width: 100px;">Type</th>
+          <th style="width: 50px;">Default</th>
+          <th>Description</th>
         </tr>
       </thead>
       <tbody>
@@ -145,7 +145,7 @@ $('.popover-dismiss').popover({
           <td>animation</td>
           <td>boolean</td>
           <td>true</td>
-          <td>apply a CSS fade transition to the popover</td>
+          <td>Apply a CSS fade transition to the popover</td>
         </tr>
         <tr>
           <td>html</td>
@@ -157,38 +157,50 @@ $('.popover-dismiss').popover({
           <td>placement</td>
           <td>string | function</td>
           <td>'right'</td>
-          <td>how to position the popover - top | bottom | left | right | auto.<br> When "auto" is specified, it will dynamically reorient the popover. For example, if placement is "auto left", the popover will display to the left when possible, otherwise it will display right.</td>
+          <td>How to position the popover - top | bottom | left | right | auto.<br> When "auto" is specified, it will dynamically reorient the popover. For example, if placement is "auto left", the popover will display to the left when possible, otherwise it will display right.</td>
         </tr>
         <tr>
           <td>selector</td>
           <td>string</td>
           <td>false</td>
-          <td>if a selector is provided, popover objects will be delegated to the specified targets. In practice, this is used to enable dynamic HTML content to have popovers added. See <a href="https://github.com/twbs/bootstrap/issues/4215">this</a> and <a href="http://jsfiddle.net/fScua/">an informative example</a>.</td>
+          <td>If a selector is provided, popover objects will be delegated to the specified targets. In practice, this is used to enable dynamic HTML content to have popovers added. See <a href="https://github.com/twbs/bootstrap/issues/4215">this</a> and <a href="http://jsfiddle.net/fScua/">an informative example</a>.</td>
         </tr>
         <tr>
           <td>trigger</td>
           <td>string</td>
           <td>'click'</td>
-          <td>how popover is triggered - click | hover | focus | manual</td>
+          <td>How popover is triggered - click | hover | focus | manual</td>
         </tr>
         <tr>
           <td>title</td>
           <td>string | function</td>
           <td>''</td>
-          <td>default title value if <code>title</code> attribute isn't present</td>
+          <td>Default title value if <code>title</code> attribute isn't present</td>
+        </tr>
+        <tr>
+          <td>template</td>
+          <td>string</td>
+          <td><code>'&lt;div class="popover"&gt;&lt;div class="arrow"&gt;&lt;/div&gt;&lt;h3 class="popover-title"&gt;&lt;/h3&gt;&lt;div class="popover-content"&gt;&lt;/div&gt;&lt;/div&gt;'</code></td>
+          <td>
+           <p>Base HTML to use when creating the popover.</p>
+           <p>The popover's <code>title</code> will be injected into the <code>.popover-title</code>.</p>
+           <p>The popover's <code>content</code> will be injected into the <code>.popover-content</code>.</p>
+           <p><code>.arrow</code> will become the popover's arrow.</p>
+           <p>The outermost wrapper element should have the <code>.popover</code> class.</p>
+          </td>
         </tr>
         <tr>
           <td>content</td>
           <td>string | function</td>
           <td>''</td>
-          <td>default content value if <code>data-content</code> attribute isn't present</td>
+          <td>Default content value if <code>data-content</code> attribute isn't present</td>
         </tr>
         <tr>
           <td>delay</td>
           <td>number | object</td>
           <td>0</td>
           <td>
-           <p>delay showing and hiding the popover (ms) - does not apply to manual trigger type</p>
+           <p>Delay showing and hiding the popover (ms) - does not apply to manual trigger type</p>
            <p>If a number is supplied, delay is applied to both hide/show</p>
            <p>Object structure is: <code>delay: { show: 500, hide: 100 }</code></p>
           </td>
index b952e85040224adffc7aad5d82b61b463be30d9e..83ef82e06c76dfb0b9d60e2ffbe9e79e00b95e44 100644 (file)
@@ -74,9 +74,9 @@ $('#example').tooltip(options)
       <thead>
        <tr>
          <th style="width: 100px;">Name</th>
-         <th style="width: 100px;">type</th>
-         <th style="width: 50px;">default</th>
-         <th>description</th>
+         <th style="width: 100px;">Type</th>
+         <th style="width: 50px;">Default</th>
+         <th>Description</th>
        </tr>
       </thead>
       <tbody>
@@ -84,7 +84,7 @@ $('#example').tooltip(options)
          <td>animation</td>
          <td>boolean</td>
          <td>true</td>
-         <td>apply a CSS fade transition to the tooltip</td>
+         <td>Apply a CSS fade transition to the tooltip</td>
        </tr>
        <tr>
          <td>html</td>
@@ -96,7 +96,7 @@ $('#example').tooltip(options)
          <td>placement</td>
          <td>string | function</td>
          <td>'top'</td>
-         <td>how to position the tooltip - top | bottom | left | right | auto. <br> When "auto" is specified, it will dynamically reorient the tooltip. For example, if placement is "auto left", the tooltip will display to the left when possible, otherwise it will display right.</td>
+         <td>How to position the tooltip - top | bottom | left | right | auto. <br> When "auto" is specified, it will dynamically reorient the tooltip. For example, if placement is "auto left", the tooltip will display to the left when possible, otherwise it will display right.</td>
        </tr>
        <tr>
          <td>selector</td>
@@ -104,24 +104,35 @@ $('#example').tooltip(options)
          <td>false</td>
          <td>If a selector is provided, tooltip objects will be delegated to the specified targets.</td>
        </tr>
+       <tr>
+         <td>template</td>
+         <td>string</td>
+         <td><code>'&lt;div class="tooltip" role="tooltip"&gt;&lt;div class="tooltip-arrow"&gt;&lt;/div&gt;&lt;div class="tooltip-inner"&gt;&lt;/div&gt;&lt;/div&gt;'</code></td>
+         <td>
+          <p>Base HTML to use when creating the tooltip.</p>
+          <p>The tooltip's <code>title</code> will be injected into the <code>.tooltip-inner</code>.</p>
+          <p><code>.tooltip-arrow</code> will become the tooltip's arrow.</p>
+          <p>The outermost wrapper element should have the <code>.tooltip</code> class.</p>
+        </td>
+       </tr>
        <tr>
          <td>title</td>
          <td>string | function</td>
          <td>''</td>
-         <td>default title value if <code>title</code> attribute isn't present</td>
+         <td>Default title value if <code>title</code> attribute isn't present</td>
        </tr>
        <tr>
          <td>trigger</td>
          <td>string</td>
          <td>'hover focus'</td>
-         <td>how tooltip is triggered - click | hover | focus | manual. You may pass multiple triggers; separate them with a space.</td>
+         <td>How tooltip is triggered - click | hover | focus | manual. You may pass multiple triggers; separate them with a space.</td>
        </tr>
        <tr>
          <td>delay</td>
          <td>number | object</td>
          <td>0</td>
          <td>
-          <p>delay showing and hiding the tooltip (ms) - does not apply to manual trigger type</p>
+          <p>Delay showing and hiding the tooltip (ms) - does not apply to manual trigger type</p>
           <p>If a number is supplied, delay is applied to both hide/show</p>
           <p>Object structure is: <code>delay: { show: 500, hide: 100 }</code></p>
          </td>