Updates docs to match Tooltip type checking #22342
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
gareth
force-pushed
the
fix-tooltip-documentation
branch
2 times, most recently
from
0c4614e
to
99e82eb
Compare
samjewell
reviewed
Apr 4, 2017
docs/components/popovers.md
Outdated
| @@ -181,7 +181,7 @@ Options can be passed via data attributes or JavaScript. For data attributes, ap | |||
| </tr> | |||
| <tr> | |||
| <td>container</td> | |||
| <td>string | false</td> | |||
| <td>string | element | boolean</td> | |||
There was a problem hiding this comment.
If you felt like it, you could also change false to boolean on the tooltip container docs too:
From:
<td>container</td>
<td>string | element | false</td>
to:
<td>container</td>
<td>string | element | boolean</td>
There was a problem hiding this comment.
Interestingly, if you actually set container: true then the tooltip/popover won't work properly, because of this line:
var container = this.config.container === false ? document.body : $(this.config.container);
I'm actually going to change these updates back to false to make that clear. The important thing for this PR is that element is added.
|
@gareth you have conflicts in your issue can you update your branch please ? |
Documentation now matches the types defined in the DefaultType constant in js/src/tooltip.js
gareth
force-pushed
the
fix-tooltip-documentation
branch
from
d7ce9e7
to
0d8ae6d
Compare
|
@Johann-S Rebased |
Johann-S
approved these changes
Oct 3, 2017
Closed
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Spotted when looking up documentation for Popups, and wondering why a raw element couldn't be passed in as a
containeraccording to the documentation - I looked in the source and saw that it could – whatever's incontainer(if truthy) gets passed into jQuery's appendTo!I also spotted that the Tooltip type checking explicitly allows for an element to be passed, it's literally just that the documentation is out of sync.
With this change, the documentation for Tooltip and Popover now matches the types defined in the DefaultType constant in js/src/tooltip.js