Code Monkey home page Code Monkey logo

fuckmyscroll.js's Introduction

FuckMyScroll

Animated scrolling to certain point or anchor.

You can see a demo here.

Installing

Install via npm

$ npm install --save fuckmyscroll

Usage

In your script, create an instance of FuckMyScroll

const fms = new FuckMyScroll();
fms.init();

Working with anchors

Truly is not necessary be an anchor, but have href and fmscroll attributes.

<button href="#about" fmscroll>About</button>

<!-- Goes to -->
<article id="about">
  <!-- ... -->
</article>

Going to page points

Scroll by cordenates

let X = 0,
  Y = 1200;

fms.scrollTo(X, Y);

Options

const fms = new FuckMyScroll({
  speed: 14, // 14px/ms,
  init: () => {},
  end: () => {}
});
  • speed It is possible determine the speed, measured in pixels/milliseconds. Default is 7px/ms.
{
  speed: 20 // 20px/ms
}
  • init Callback executed on proccess initiation.
{
  init: () => { // ... }
}
  • end Callback executed on proccess finalization.
{
  end: () => { // ... }
}

Events

It is possible execute specific events for each anchors using fms-init and fms-end attributes with global functions:

<a href="#about" fmsscroll fms-init="prepareAbout" fms-end="showAbout">About</a>

<script>
  /* Global scope */
  function prepareAbout() {
    //...
  }

  function showAbout() { 
    // ...
  }

  window.onload = () => {
    // ...
  }
</script>

fuckmyscroll.js's People

Contributors

gabrieljmj avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar

Forkers

perfettiful

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.