Skip to content
This repository was archived by the owner on Feb 11, 2023. It is now read-only.
This repository was archived by the owner on Feb 11, 2023. It is now read-only.

Add horizontal scroll support #1

Open

Description

@markcellus

Vertical scroll is nice but what about horizontal scroll?

Activity

  1. jvgomg commented on Jan 4, 2016

    @jvgomg

    @mkay581 isn't the first param the X scroll?

  2. markcellus commented on Jan 4, 2016

    @markcellus
    OwnerAuthor

    The first param to Scrolls .to() method is x, which is the horizontal scroll on the x axis, yes. But its not currently being used. I made the decision to include it so that future horizontal support will be easy. the API has since been changed. See updated README.

  3. svensson-david commented on Mar 20, 2019

    @svensson-david

    Is horizontal scroll still not supported?

  4. markcellus commented on Mar 22, 2019

    @markcellus
    OwnerAuthor

    No it isn't unfortunately. 😞 Just haven't had time to get to it. But do a lot of people need this? Horizontal scrolling seems rare when compared to vertical scrolling and haven't really seen this ticket gain as much popularity. I am open to accepting PRs though if you think its something you can tackle.

  5. svensson-david commented on Mar 22, 2019

    @svensson-david

    No worries! Needed it for a Netflix type navigation with a lot of titles being shown horizontally. Trying to get it working with the the browser native scrolling behavior: smooth for now but I'll revisit this if we cannot get it to work reliably.

    We're already using this library for some other scrolling and it's been really great this far 😃
    Thanks!

  6. omonk commented on Aug 4, 2020

    @omonk

    I've hacked together some changes for scrollTo to accept x and y scrolling. This just works for the scrollTo function, it can be translated to the other methods but would require a bit more consideration to update all methods etc.

    async function scrollTo(el = window, options = {}) {
      const scroll = ({
        from,
        to,
        startTime,
        duration = 400,
        easeFunc,
        resolve,
      }) => {
        window.requestAnimationFrame(() => {
          const currentTime = Date.now();
          const time = Math.min(1, (currentTime - startTime) / duration);
    
          if (from.top === to.top && from.left === to.left) {
            return resolve ? resolve() : null;
          }
    
          setScrollPosition(el, {
            top: easeFunc(time) * (to.top - from.top) + from.top,
            left: easeFunc(time) * (to.left - from.left) + from.left,
          });
    
          /* prevent scrolling, if already there, or at end */
          if (time < 1) {
            scroll({ from, to, startTime, duration, easeFunc, resolve });
          } else if (resolve) {
            resolve();
          }
        });
      };
    
      const currentScrollPosition = getScrollPosition(el);
    
      return new Promise(resolve => {
        scroll({
          from: currentScrollPosition,
          to: { top: options.top, left: options.left },
          startTime: Date.now(),
          duration: options.duration,
          easeFunc: t => {
            return t * (2 - t);
          },
          resolve,
        });
      });
    }
    
    function getScrollPosition(el) {
      if (
        el === document.body ||
        el === document.documentElement ||
        el instanceof Window
      ) {
        return {
          top: document.body.scrollTop || document.documentElement.scrollTop,
          left: document.body.scrollLeft || document.documentElement.scrollLeft,
        };
      } else {
        return {
          top: el.scrollTop || el.scrollTop,
          left: el.scrollLeft || el.scrollLeft,
        };
      }
    }
    
    function setScrollPosition(el, { top, left }) {
      if (
        el === document.body ||
        el === document.documentElement ||
        el instanceof Window
      ) {
        document.body.scrollTop = top;
        document.documentElement.scrollTop = top;
    
        document.body.scrollLeft = left;
        document.documentElement.scrollLeft = left;
      } else {
        el.scrollTop = top;
        el.scrollLeft = left;
      }
    }
  7. markcellus commented on Aug 5, 2020

    @markcellus
    OwnerAuthor

    Awesome @omonk! You mind submitting a PR? So I can better evaluate, run tests, etc?

  8. omonk commented on Aug 5, 2020

    @omonk

    I can have a look at some point! I hacked this together quickly for a small personal project I'm working on but would be happy to contribute for others to use also

  9. brandonmcconnell commented on Jul 20, 2022

    @brandonmcconnell

    Would also be excited to see this added ☝🏼 @markcellus @omonk

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions