如何知道滚动到元素是在Javascript中完成的?

时间:2017-10-17 17:34:37

标签: javascript scroll js-scrollintoview

我正在使用Javascript方法Element.scrollIntoView()
https://developer.mozilla.org/en-US/docs/Web/API/Element/scrollIntoView

滚动结束时有什么方法可以让我知道。假设有动画,或者我设置了{behavior: smooth}

我假设滚动是异步的,并想知道是否有任何类似回调的回调。

6 个答案:

答案 0 :(得分:10)

您可以使用IntersectionObserver,检查IntersectionObserver回调函数中的元素.isIntersecting是否

const element = document.getElementById("box");

const intersectionObserver = new IntersectionObserver((entries) => {
  let [entry] = entries;
  if (entry.isIntersecting) {
    setTimeout(() => alert(`${entry.target.id} is visible`), 100)
  }
});
// start observing
intersectionObserver.observe(box);

element.scrollIntoView({behavior: "smooth"});
body {
  height: calc(100vh * 2);
}

#box {
  position: relative;
  top:500px;
}
<div id="box">
box
</div>

答案 1 :(得分:4)

没有scrollEnd事件,但是您可以监听scroll事件并检查它是否仍在滚动窗口:

var scrollTimeout;
addEventListener('scroll', function(e) {
    clearTimeout(scrollTimeout);
    scrollTimeout = setTimeout(function() {
        console.log('Scroll ended');
    }, 100);
});

答案 2 :(得分:2)

对于这种“平稳”行为,所有the specs的发言都是

  

当用户代理要对滚动框进行平滑滚动以定位时,它必须以用户代理定义的方式在用户上更新框的滚动位置 -agent定义的时间量

(强调我的)

因此,不仅没有单个事件一旦完成便会触发,而且我们甚至无法假设不同浏览器之间的任何稳定行为。

事实上,当前的Firefox和Chrome的行为已经有所不同:

  • Firefox似乎设置了固定的持续时间,无论滚动距离有多远,它都会在此固定的持续时间内(〜500ms)进行操作
  • 另一方面,
  • Chrome将使用速度,也就是说,操作持续时间将根据滚动距离而变化,硬限制为3s。

因此,这已经使所有基于超时的解决方案都无法解决该问题。

现在,这里的答案之一是建议使用MutationObserver,这不是一个很糟糕的解决方案,但它不是太可移植,并且不采用inlineblock选项考虑在内。

所以最好的办法可能是定期检查是否停止滚动。为此,我们可以启动requestAnimationFrame供电循环,这样我们的检查每帧仅执行一次。

这里有一个这样的实现,它将返回一个Promise,一旦滚动操作完成,该Promise将得到解决。
注意:该代码缺少一种检查操作是否成功的方法,因为如果页面上发生了其他滚动操作,则所有当前滚动操作都将被取消,但是我将其作为练习供读者阅读

const buttons = [ ...document.querySelectorAll( 'button' ) ];

document.addEventListener( 'click', ({ target }) => {
  // handle delegated event
  target = target.closest('button');
  if( !target ) { return; }
  // find where to go next
  const next_index =  (buttons.indexOf(target) + 1) % buttons.length;
  const next_btn = buttons[next_index];
  const block_type = target.dataset.block;

  // make it red
  document.body.classList.add( 'scrolling' );
  
  smoothScroll( next_btn, { block: block_type })
    .then( () => {
      // remove the red
      document.body.classList.remove( 'scrolling' );
    } )
});


/* 
 *
 * Promised based scrollIntoView( { behavior: 'smooth' } )
 * @param { Element } elem
 **  ::An Element on which we'll call scrollIntoView
 * @param { object } [options]
 **  ::An optional scrollIntoViewOptions dictionary
 * @return { Promise } (void)
 **  ::Resolves when the scrolling ends
 *
 */
function smoothScroll( elem, options ) {
  return new Promise( (resolve) => {
    if( !( elem instanceof Element ) ) {
      throw new TypeError( 'Argument 1 must be an Element' );
    }
    let same = 0; // a counter
    let lastPos = null; // last known Y position
    // pass the user defined options along with our default
    const scrollOptions = Object.assign( { behavior: 'smooth' }, options );

    // let's begin
    elem.scrollIntoView( scrollOptions );
    requestAnimationFrame( check );
    
    // this function will be called every painting frame
    // for the duration of the smooth scroll operation
    function check() {
      // check our current position
      const newPos = elem.getBoundingClientRect().top;
      
      if( newPos === lastPos ) { // same as previous
        if(same ++ > 2) { // if it's more than two frames
/* @todo: verify it succeeded
 * if(isAtCorrectPosition(elem, options) {
 *   resolve();
 * } else {
 *   reject();
 * }
 * return;
 */
          return resolve(); // we've come to an halt
        }
      }
      else {
        same = 0; // reset our counter
        lastPos = newPos; // remember our current position
      }
      // check again next painting frame
      requestAnimationFrame(check);
    }
  });
}
p {
  height: 400vh;
  width: 5px;
  background: repeat 0 0 / 5px 10px
    linear-gradient(to bottom, black 50%, white 50%);
}
body.scrolling {
  background: red;
}
<button data-block="center">scroll to next button <code>block:center</code></button>
<p></p>
<button data-block="start">scroll to next button <code>block:start</code></button>
<p></p>
<button data-block="nearest">scroll to next button <code>block:nearest</code></button>
<p></p>
<button>scroll to top</button>

答案 3 :(得分:1)

我不是JavaScript方面的专家,但是我使用jQuery做到了这一点。希望对您有帮助

$("#mybtn").click(function() {
    $('html, body').animate({
        scrollTop: $("div").offset().top
    }, 2000);
});

$( window ).scroll(function() {
  $("div").html("scrolling");
  if($(window).scrollTop() == $("div").offset().top) {
    $("div").html("Ended");
  }
})
body { height: 2000px; }
<script src="https://ajax.googleapis.com/ajax/libs/jquery/2.1.1/jquery.min.js"></script>

<button id="mybtn">Scroll to Text</button>
<br><br><br><br><br><br><br><br>
<div>example text</div>

答案 4 :(得分:0)

以上这些答案即使在滚动完成后仍将事件处理程序保留在原处(以便用户滚动时,其方法将继续被调用)。如果不需要滚动,他们也不会通知您。这是一个更好的答案:

$("#mybtn").click(function() {
    $('html, body').animate({
        scrollTop: $("div").offset().top
    }, 2000);

    $("div").html("Scrolling...");

    callWhenScrollCompleted(() => {
        $("div").html("Scrolling is completed!");
    });
});

// Wait for scrolling to stop.
function callWhenScrollCompleted(callback, checkTimeout = 200, parentElement = $(window)) {
  const scrollTimeoutFunction = () => {
    // Scrolling is complete
    parentElement.off("scroll");
    callback();
  };
  let scrollTimeout = setTimeout(scrollTimeoutFunction, checkTimeout);

  parentElement.on("scroll", () => {
    clearTimeout(scrollTimeout);
    scrollTimeout = setTimeout(scrollTimeoutFunction, checkTimeout);
  });
}
body { height: 2000px; }
<script src="https://ajax.googleapis.com/ajax/libs/jquery/2.1.1/jquery.min.js"></script>

<button id="mybtn">Scroll to Text</button>
<br><br><br><br><br><br><br><br>
<div>example text</div>

答案 5 :(得分:0)

适用于rxjs的解决方案

lang:打字稿

scrollToElementRef(
    element: HTMLElement,
    options?: ScrollIntoViewOptions,
    emitFinish = false,
  ): void | Promise<boolean> {
    element.scrollIntoView(options);
    if (emitFinish) {
      return fromEvent(window, 'scroll')
        .pipe(debounceTime(100), first(), mapTo(true)).toPromise();
    }
  }

用法:

const element = document.getElementById('ELEM_ID');
scrollToElementRef(elment, {behavior: 'smooth'}, true).then(() => {
  // scroll finished do something
})