我如何使用jQuery滚动到视图中?


169

我有一个HTML文档,其中包含使用网格格式的图像<ul><li><img...。浏览器窗口同时具有垂直和水平滚动。

问题: 单击图像时<img>,如何使整个文档滚动到我刚刚单击的图像所在的位置top:20px; left:20px

我在这里浏览过类似的文章...虽然我对JavaScript还是很陌生,但想了解如何自己实现。


Answers:


192

由于您想知道它是如何工作的,我将逐步解释它。

首先,您要将一个函数绑定为图像的单击处理程序:

$('#someImage').click(function () {
    // Code to do scrolling happens here
});

这会将点击处理程序应用于具有的图片id="someImage"。如果要对所有图像执行此操作,请替换'#someImage''img'

现在查看实际的滚动代码:

  1. 获取图像偏移量(相对于文档):

    var offset = $(this).offset(); // Contains .top and .left
  2. top和减去20 left

    offset.left -= 20;
    offset.top -= 20;
  3. 现在动画的滚动顶部和滚动左CSS属性<body><html>

    $('html, body').animate({
        scrollTop: offset.top,
        scrollLeft: offset.left
    });

3
这仅适用于简单的布局。.scrollIntoView当元素嵌套在多个溢出容器中时,它不能像W3C 方法那样处理所有情况。
natevw 2015年

2
为什么要重新发明轮子?Element.scrollIntoView()developer.mozilla.org/en-US/docs/Web/API/Element/scrollIntoView
Serge

@Serge,因为它是尚未在所有浏览器中实现的工作草案
John Smith,

@JohnSmith,请仔细阅读我发布的链接“浏览器兼容性”部分,您将看到没有浏览器不支持scrollIntoView
Serge

@Serge抱歉,我没有意识到,还有scrollIntoViewOption(该控件还不够广泛)。我想这已经足够了。
约翰·史密斯,

377

scrollIntoView所有主要浏览器都支持DOM方法,该方法将元素与视口的顶部/左侧(或尽可能靠近)对齐。

$("#myImage")[0].scrollIntoView();

在受支持的浏览器上,您可以提供以下选项:

$("#myImage")[0].scrollIntoView({
    behavior: "smooth", // or "auto" or "instant"
    block: "start" // or "end"
});

或者,如果所有元素都有唯一的ID,则只需更改对象的hash属性location即可支持后退/前进按钮:

$(document).delegate("img", function (e) {
    if (e.target.id)
        window.location.hash = e.target.id;
});

之后,只需将scrollTop/ scrollLeft属性调整为-20:

document.body.scrollLeft -= 20;
document.body.scrollTop -= 20;

2
谢谢!其他5条SO文章,您将其完美地钉了上去。我的用例是引导对话框中的一个容器,需要滚动到视图中。
Stephen Patten

10
注意:$("#myImage")[0].scrollIntoView(false);将元素在窗口底部对齐。
菲利普2014年

1
当心:“平滑”行为并未得到广泛支持,scrollIntoView对于没有某种动画效果的用户而言,这可能是一种令人困惑的体验。
科迪·杜瓦尔

1
@JohnHenckel:这是不正确的,即使IE 5.5都scrollIntoView具有boolean参数。稍后,我将尝试向caniuse.com发送拉取请求。
Andy E

1
注意:使用Chrome浏览器时,我无法将<td>元素滚动到视图中,而不得不滚动其父级(<tr>),并且可以正常工作。
CrazyTim

13

我见过的最简单的解决方案

var offset = $("#target-element").offset();
$('html, body').animate({
    scrollTop: offset.top,
    scrollLeft: offset.left
}, 1000);

教程在这里


冒着使它变得不那么简单的风险,我对其进行了编辑以支持水平滚动。
jpaugh

7

有一些方法可以将元素直接滚动到视图中,但是如果要滚动到元素的相对点,则必须手动进行操作:

在点击处理程序内,获取元素相对于文档的位置,减去20并使用window.scrollTo

var pos = $(this).offset();
var top = pos.top - 20;
var left = pos.left - 20;
window.scrollTo((left < 0 ? 0 : left), (top < 0 ? 0 : top));


4

这是一个快速的jQuery插件,可以很好地映射内置的浏览器功能:

$.fn.ensureVisible = function () { $(this).each(function () { $(this)[0].scrollIntoView(); }); };

...

$('.my-elements').ensureVisible();

3

经过反复试验,我想出了这个功能,也可以与iframe一起使用。

function bringElIntoView(el) {    
    var elOffset = el.offset();
    var $window = $(window);
    var windowScrollBottom = $window.scrollTop() + $window.height();
    var scrollToPos = -1;
    if (elOffset.top < $window.scrollTop()) // element is hidden in the top
        scrollToPos = elOffset.top;
    else if (elOffset.top + el.height() > windowScrollBottom) // element is hidden in the bottom
        scrollToPos = $window.scrollTop() + (elOffset.top + el.height() - windowScrollBottom);
    if (scrollToPos !== -1)
        $('html, body').animate({ scrollTop: scrollToPos });
}

2

只是一个小费。仅适用于Firefox

Element.scrollIntoView();


4
这适用于所有具有布尔参数或根本没有参数的浏览器。仅支持更高级的对象参数。
Risord


现在,仅Opera Mini就已经足够受支持了:caniuse.com/#search=scrollIntoView
John Magnolia

有很多非常轻巧的填充材料。
马丁·詹姆斯(James)

1

我的UI在拇指栏中有一个垂直滚动的拇指列表,目的是使当前拇指恰好位于拇指栏的中央。我从批准的答案开始,但是发现有一些调整可以使当前的拇指真正居中。希望这对其他人有帮助。

标记:

<ul id='thumbbar'>
    <li id='thumbbar-123'></li>
    <li id='thumbbar-124'></li>
    <li id='thumbbar-125'></li>
</ul>

jQuery的:

// scroll the current thumb bar thumb into view
heightbar   = $('#thumbbar').height();
heightthumb = $('#thumbbar-' + pageid).height();
offsetbar   = $('#thumbbar').scrollTop();


$('#thumbbar').animate({
    scrollTop: offsetthumb.top - heightbar / 2 - offsetbar - 20
});

0

简单的2个步骤即可向下滚动到结尾或底部。

步骤1:获取可滚动(会话)div的完整高度。

步骤2:使用在步骤1中获得的值在该scrollable(会话)div上应用scrollTop。

var fullHeight = $('#conversation')[0].scrollHeight;

$('#conversation').scrollTop(fullHeight);

以上步骤必须应用于对话div上的每个附加项。


0

在尝试找到一种能够处理所有情况的解决方案(用于动画滚动的选项,对象滚动到视图中后在其周围进行填充,甚至在诸如iframe等晦涩的情况下也可以使用)之后,我终于结束了为此编写自己的解决方案。由于当许多其他解决方案失败时它似乎可以工作,所以我想分享一下:

function scrollIntoViewIfNeeded($target, options) {

    var options = options ? options : {},
    $win = $($target[0].ownerDocument.defaultView), //get the window object of the $target, don't use "window" because the element could possibly be in a different iframe than the one calling the function
    $container = options.$container ? options.$container : $win,        
    padding = options.padding ? options.padding : 20,
    elemTop = $target.offset().top,
    elemHeight = $target.outerHeight(),
    containerTop = $container.scrollTop(),
    //Everything past this point is used only to get the container's visible height, which is needed to do this accurately
    containerHeight = $container.outerHeight(),
    winTop = $win.scrollTop(),
    winBot = winTop + $win.height(),
    containerVisibleTop = containerTop < winTop ? winTop : containerTop,
    containerVisibleBottom = containerTop + containerHeight > winBot ? winBot : containerTop + containerHeight,
    containerVisibleHeight = containerVisibleBottom - containerVisibleTop;

    if (elemTop < containerTop) {
        //scroll up
        if (options.instant) {
            $container.scrollTop(elemTop - padding);
        } else {
            $container.animate({scrollTop: elemTop - padding}, options.animationOptions);
        }
    } else if (elemTop + elemHeight > containerTop + containerVisibleHeight) {
        //scroll down
        if (options.instant) {
            $container.scrollTop(elemTop + elemHeight - containerVisibleHeight + padding);
        } else {
            $container.animate({scrollTop: elemTop + elemHeight - containerVisibleHeight + padding}, options.animationOptions);
        }
    }
}

$target 是一个jQuery对象,其中包含您希望在需要时滚动到视图中的对象。

options (可选)可以包含在对象中传递的以下选项:

options.$container-一个jQuery对象,指向$ target的包含元素(换句话说,带有滚动条的dom中的元素)。默认为包含$ target元素的窗口,并且足够聪明以选择iframe窗口。请记住在属性名称中包含$。

options.padding-滚动到视图中时对象上方或下方添加的像素填充。这样,它就不能紧贴窗口边缘。默认为20

options.instant-如果设置为true,则将不使用jQuery animate,并且滚动条将立即弹出到正确的位置。默认为false。

options.animationOptions-您希望传递给jQuery animate函数的任何jQuery选项(请参阅http://api.jquery.com/animate/)。这样,您可以更改动画的持续时间,或者在滚动完成后执行回调函数。这仅在options.instant设置为false时有效。如果您需要即时动画但需要回调,请设置,options.animationOptions.duration = 0而不要使用options.instant = true

By using our site, you acknowledge that you have read and understand our Cookie Policy and Privacy Policy.
Licensed under cc by-sa 3.0 with attribution required.