jQuery & jQuery UI Documentation

jQuery & jQuery UI

previous page next page

.scrollLeft()

Categories: CSS | Offset | Manipulation > Style Properties

Contents:

.scrollLeft() Returns: Integer

Description: Get the current horizontal position of the scroll bar for the first element in the set of matched elements.

  • version added: 1.2.6.scrollLeft()

The horizontal scroll position is the same as the number of pixels that are hidden from view above the scrollable area. If the scroll bar is at the very left, or if the element is not scrollable, this number will be 0.

Note: .scrollLeft(), when called directly or animated as a property using .animate() will not work if the element(s) it is being applied to are hidden.

Example:

Get the scrollLeft of a paragraph.

<!DOCTYPE html>
<html>
<head>
  <style>
    p { margin:10px;padding:5px;border:2px solid #666; }
    </style>
  <script src="http://code.jquery.com/jquery-1.7rc2.js"></script>
</head>
<body>
  <p>Hello</p><p></p>
<script>var p = $("p:first");
			$("p:last").text( "scrollLeft:" + p.scrollLeft() );

			</script>

</body>
</html>

.scrollLeft( value ) Returns: jQuery

Description: Set the current horizontal position of the scroll bar for each of the set of matched elements.

  • version added: 1.2.6.scrollLeft( value )

    valueAn integer indicating the new position to set the scroll bar to.

The horizontal scroll position is the same as the number of pixels that are hidden from view above the scrollable area. Setting the scrollLeft positions the horizontal scroll of each matched element.

Example:

Set the scrollLeft of a div.

<!DOCTYPE html>
<html>
<head>
  <style>
  div.demo {
  background:#CCCCCC none repeat scroll 0 0;
  border:3px solid #666666;
  margin:5px;
  padding:5px;
  position:relative;
  width:200px;
  height:100px;
  overflow:auto;
  }
  p { margin:10px;padding:5px;border:2px solid #666;width:1000px;height:1000px; }
	</style>
  <script src="http://code.jquery.com/jquery-1.7rc2.js"></script>
</head>
<body>
  <div class="demo"><h1>lalala</h1><p>Hello</p></div>
<script>$("div.demo").scrollLeft(300);
</script>

</body>
</html>
previous page start next page