Skip to content
GitLab
Projects Groups Snippets
  • /
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Sign in / Register
  • B bootstrap
  • Project information
    • Project information
    • Activity
    • Labels
    • Members
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributors
    • Graph
    • Compare
  • Issues 263
    • Issues 263
    • List
    • Boards
    • Service Desk
    • Milestones
  • Merge requests 114
    • Merge requests 114
  • CI/CD
    • CI/CD
    • Pipelines
    • Jobs
    • Schedules
  • Deployments
    • Deployments
    • Environments
    • Releases
  • Packages and registries
    • Packages and registries
    • Package Registry
    • Infrastructure Registry
  • Monitor
    • Monitor
    • Incidents
  • Analytics
    • Analytics
    • Value stream
    • CI/CD
    • Repository
  • Wiki
    • Wiki
  • Snippets
    • Snippets
  • Activity
  • Graph
  • Create a new issue
  • Jobs
  • Commits
  • Issue Boards
Collapse sidebar
  • Bootstrap
  • bootstrap
  • Merge requests
  • !6247

change scrollspy documentation to clarify javascript usage

  • Review changes

  • Download
  • Email patches
  • Plain diff
Merged Administrator requested to merge github/fork/jimwebb/scrollspy-documentation-clarify into 3.0.0-wip Dec 12, 2012
  • Overview 0
  • Commits 1
  • Pipelines 0
  • Changes 1

Created by: jimwebb

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: https://github.com/twitter/bootstrap/issues/5553

This is my first pull request; holler (nicely, please) if I've done something incorrectly.

Assignee
Assign to
Reviewers
Request review from
Time tracking
Source branch: github/fork/jimwebb/scrollspy-documentation-clarify