MCPcopy Create free account
hub / github.com/bvaughn/react-window / measureScrollElementViewport

Function measureScrollElementViewport

lib/utils/scrollElement.ts:93–165  ·  view source on GitHub ↗
({
  containerElement,
  direction,
  isRtl,
  scrollTarget
}: {
  containerElement: HTMLElement;
  direction: Direction;
  isRtl: boolean;
  scrollTarget: ScrollTarget;
})

Source from the content-addressed store, hash-verified

91 * - viewportSize is the size of the scroll element's viewport
92 */
93export function measureScrollElementViewport({
94 containerElement,
95 direction,
96 isRtl,
97 scrollTarget
98}: {
99 containerElement: HTMLElement;
100 direction: Direction;
101 isRtl: boolean;
102 scrollTarget: ScrollTarget;
103}): {
104 offset: number;
105 size: number;
106 viewportOffset: number;
107 viewportSize: number;
108} {
109 const isVertical = direction === "vertical";
110
111 let viewStart: number;
112 let viewportSize: number;
113 if (isWindow(scrollTarget)) {
114 const { documentElement } = scrollTarget.document;
115 viewStart = 0;
116 viewportSize = isVertical
117 ? documentElement.clientHeight
118 : documentElement.clientWidth;
119 } else {
120 const rect = scrollTarget.getBoundingClientRect();
121 viewStart = isVertical
122 ? rect.top + scrollTarget.clientTop
123 : rect.left + scrollTarget.clientLeft;
124 viewportSize = isVertical
125 ? scrollTarget.clientHeight
126 : scrollTarget.clientWidth;
127 }
128 const viewEnd = viewStart + viewportSize;
129
130 // Positions are measured in client (physical) coordinates, so they don't depend on RTL scroll offset types
131 const rect = containerElement.getBoundingClientRect();
132 const elementStart = isVertical
133 ? rect.top + containerElement.clientTop
134 : rect.left + containerElement.clientLeft;
135 const elementSize = isVertical
136 ? containerElement.clientHeight
137 : containerElement.clientWidth;
138 const elementEnd = elementStart + elementSize;
139
140 // The container may also scroll its own content (e.g. a grid's columns)
141 const ownScrollOffset = adjustScrollOffsetForRtl({
142 containerElement,
143 direction,
144 isRtl,
145 scrollOffset: isVertical
146 ? containerElement.scrollTop
147 : containerElement.scrollLeft
148 });
149
150 const isReversed = !isVertical && isRtl;

Callers 1

useVirtualizerFunction · 0.90

Calls 2

adjustScrollOffsetForRtlFunction · 0.90
isWindowFunction · 0.85

Tested by

no test coverage detected