Git Product home page Git Product logo

scroll-spy's Introduction

Scroll Spy

What Is It?

Hi! By incorporating this little bit of code into your project, you will be able to afford your users a little pleasure when navigating to a link on the same page! Just plug it in give it a whirl!

Get It By

Forking and cloning from this repository

Usage

Plug It In

<script src="/path/to/scrollspy.js"></script>

Initialize triggers

Add the class "scroll-spy-trigger" and the attribute data-target(which will receive the id preceded by a hashsymbol of the element you would like to scroll to) to the elements you would like to activate the smooth scrolling feature

Set Targets

For whichever element you want to be shown at the top of your page, set the id that corresponds with it triggers data-target attribute.

Example

<a class="scroll-spy-trigger" data-target="#welcome">Welcome</a>
...
<div id="welcome">
...
</div>

Summary

That's really all there is to it! Go out there and enjoy!

Caveats

Not yet cross-browser compliant. If your desire is to target <= IE 9, I would recommend you to not use this project in production.

scroll-spy's People

Contributors

gikuyunderitu avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.