change scrollspy documentation to clarify javascript usage #6247
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
* add scrollspy 'target' option
fat
added a commit
that referenced
this pull request
Dec 22, 2012
change scrollspy documentation to clarify javascript usage
|
cool thanks! |
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.
The scrollspy documentation suggests calling a scrollspy instance in JavaScript with the following code:
$('#navbar').scrollspy();
This is wrong unless #navbar is what's scrolling. Scrollspy is invoked on what's being spied, not on the target. What I think the author means to say is:
$('body').scrollspy({ target: '#navbar' });
I've changed the documentation to reflect this, and to state that the scrollspy script is specifically looking for .nav li > a, which may be confusing for folks who tweak the standard nav component.
Mentioned in this bug:
#5553
This is my first pull request; holler (nicely, please) if I've done something incorrectly.