Home

Library goog.style.bidi

Function Summary
getOffsetStart(?Element element) ⇒ number

Returns the "offsetStart" of an element, analagous to offsetLeft but normalized for right-to-left environments and various browser inconsistencies. This value returned can always be passed to setScrollOffset to scroll to an element's left edge in a left-to-right offsetParent or right edge in a right-to-left offsetParent. For example, here offsetStart is 10px in an LTR environment and 5px in RTL:

|          xxxxxxxxxx     |
^^^^^^^^^^   ^^^^   ^^^^^
10px      elem    5px
If an element is positioned before the start of its offsetParent, the startOffset may be negative. This can be used with setScrollOffset to reliably scroll to an element:
var scrollOffset = goog.style.bidi.getOffsetStart(element);
goog.style.bidi.setScrollOffset(element.offsetParent, scrollOffset);

getScrollLeft(?Element element) ⇒ number

Returns the normalized scrollLeft position for a scrolled element.

setScrollOffset(?Element element, number offsetStart)

Sets the element's scrollLeft attribute so it is correctly scrolled by offsetStart pixels. This takes into account whether the element is RTL and the nuances of different browsers. To scroll to the "beginning" of an element use getOffsetStart to obtain the element's offsetStart value and then pass the value to setScrollOffset.