Commit 7c50859e authored by Chris Rebert's avatar Chris Rebert
Browse files

Document `template` option of tooltip & popover; fixes #13088

Also capitalize column titles and descriptions.
parent 1d618795
Showing with 41 additions and 18 deletions
+41 -18
...@@ -135,9 +135,9 @@ $('.popover-dismiss').popover({ ...@@ -135,9 +135,9 @@ $('.popover-dismiss').popover({
<thead> <thead>
<tr> <tr>
<th style="width: 100px;">Name</th> <th style="width: 100px;">Name</th>
<th style="width: 100px;">type</th> <th style="width: 100px;">Type</th>
<th style="width: 50px;">default</th> <th style="width: 50px;">Default</th>
<th>description</th> <th>Description</th>
</tr> </tr>
</thead> </thead>
<tbody> <tbody>
...@@ -145,7 +145,7 @@ $('.popover-dismiss').popover({ ...@@ -145,7 +145,7 @@ $('.popover-dismiss').popover({
<td>animation</td> <td>animation</td>
<td>boolean</td> <td>boolean</td>
<td>true</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>
<tr> <tr>
<td>html</td> <td>html</td>
...@@ -157,38 +157,50 @@ $('.popover-dismiss').popover({ ...@@ -157,38 +157,50 @@ $('.popover-dismiss').popover({
<td>placement</td> <td>placement</td>
<td>string | function</td> <td>string | function</td>
<td>'right'</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>
<tr> <tr>
<td>selector</td> <td>selector</td>
<td>string</td> <td>string</td>
<td>false</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>
<tr> <tr>
<td>trigger</td> <td>trigger</td>
<td>string</td> <td>string</td>
<td>'click'</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>
<tr> <tr>
<td>title</td> <td>title</td>
<td>string | function</td> <td>string | function</td>
<td>''</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>
<tr> <tr>
<td>content</td> <td>content</td>
<td>string | function</td> <td>string | function</td>
<td>''</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>
<tr> <tr>
<td>delay</td> <td>delay</td>
<td>number | object</td> <td>number | object</td>
<td>0</td> <td>0</td>
<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>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> <p>Object structure is: <code>delay: { show: 500, hide: 100 }</code></p>
</td> </td>
......
...@@ -74,9 +74,9 @@ $('#example').tooltip(options) ...@@ -74,9 +74,9 @@ $('#example').tooltip(options)
<thead> <thead>
<tr> <tr>
<th style="width: 100px;">Name</th> <th style="width: 100px;">Name</th>
<th style="width: 100px;">type</th> <th style="width: 100px;">Type</th>
<th style="width: 50px;">default</th> <th style="width: 50px;">Default</th>
<th>description</th> <th>Description</th>
</tr> </tr>
</thead> </thead>
<tbody> <tbody>
...@@ -84,7 +84,7 @@ $('#example').tooltip(options) ...@@ -84,7 +84,7 @@ $('#example').tooltip(options)
<td>animation</td> <td>animation</td>
<td>boolean</td> <td>boolean</td>
<td>true</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>
<tr> <tr>
<td>html</td> <td>html</td>
...@@ -96,7 +96,7 @@ $('#example').tooltip(options) ...@@ -96,7 +96,7 @@ $('#example').tooltip(options)
<td>placement</td> <td>placement</td>
<td>string | function</td> <td>string | function</td>
<td>'top'</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>
<tr> <tr>
<td>selector</td> <td>selector</td>
...@@ -104,24 +104,35 @@ $('#example').tooltip(options) ...@@ -104,24 +104,35 @@ $('#example').tooltip(options)
<td>false</td> <td>false</td>
<td>If a selector is provided, tooltip objects will be delegated to the specified targets.</td> <td>If a selector is provided, tooltip objects will be delegated to the specified targets.</td>
</tr> </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> <tr>
<td>title</td> <td>title</td>
<td>string | function</td> <td>string | function</td>
<td>''</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>
<tr> <tr>
<td>trigger</td> <td>trigger</td>
<td>string</td> <td>string</td>
<td>'hover focus'</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>
<tr> <tr>
<td>delay</td> <td>delay</td>
<td>number | object</td> <td>number | object</td>
<td>0</td> <td>0</td>
<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>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> <p>Object structure is: <code>delay: { show: 500, hide: 100 }</code></p>
</td> </td>
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment