Skip to content

Commit d7dfe7c

Browse files
committed
refactor: Rename "items" to "virtualItems"
BREAKING CHANGE: The virtualizer.items array has been renamed to virtualizer.virtualItems
1 parent 126951c commit d7dfe7c

File tree

6 files changed

+19
-21
lines changed

6 files changed

+19
-21
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -228,7 +228,7 @@ function RowVirtualizerFixed() {
228228
position: 'relative',
229229
}}
230230
>
231-
{rowVirtualizer.items.map(virtualRow => (
231+
{rowVirtualizer.virtualItems.map(virtualRow => (
232232
<div
233233
key={virtualRow.index}
234234
className={virtualRow.index % 2 ? 'ListItemOdd' : 'ListItemEven'}

examples/sandbox/src/Dynamic.js

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ function RowVirtualizerDynamic({ rows }) {
5555
position: "relative"
5656
}}
5757
>
58-
{rowVirtualizer.items.map(virtualRow => (
58+
{rowVirtualizer.virtualItems.map(virtualRow => (
5959
<div
6060
key={virtualRow.index}
6161
ref={virtualRow.measureRef}
@@ -107,7 +107,7 @@ function ColumnVirtualizerDynamic({ columns }) {
107107
position: "relative"
108108
}}
109109
>
110-
{columnVirtualizer.items.map(virtualColumn => (
110+
{columnVirtualizer.virtualItems.map(virtualColumn => (
111111
<div
112112
key={virtualColumn.index}
113113
ref={virtualColumn.measureRef}
@@ -168,9 +168,9 @@ function GridVirtualizerDynamic({ rows, columns }) {
168168
position: "relative"
169169
}}
170170
>
171-
{rowVirtualizer.items.map(virtualRow => (
171+
{rowVirtualizer.virtualItems.map(virtualRow => (
172172
<React.Fragment key={virtualRow.index}>
173-
{columnVirtualizer.items.map(virtualColumn => (
173+
{columnVirtualizer.virtualItems.map(virtualColumn => (
174174
<div
175175
key={virtualColumn.index}
176176
ref={el => {

examples/sandbox/src/Fixed.js

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ function RowVirtualizerFixed() {
4747
position: "relative"
4848
}}
4949
>
50-
{rowVirtualizer.items.map(virtualRow => (
50+
{rowVirtualizer.virtualItems.map(virtualRow => (
5151
<div
5252
key={virtualRow.index}
5353
className={virtualRow.index % 2 ? "ListItemOdd" : "ListItemEven"}
@@ -98,7 +98,7 @@ function ColumnVirtualizerFixed() {
9898
position: "relative"
9999
}}
100100
>
101-
{columnVirtualizer.items.map(virtualColumn => (
101+
{columnVirtualizer.virtualItems.map(virtualColumn => (
102102
<div
103103
key={virtualColumn.index}
104104
className={
@@ -158,9 +158,9 @@ function GridVirtualizerFixed() {
158158
position: "relative"
159159
}}
160160
>
161-
{rowVirtualizer.items.map(virtualRow => (
161+
{rowVirtualizer.virtualItems.map(virtualRow => (
162162
<React.Fragment key={virtualRow.index}>
163-
{columnVirtualizer.items.map(virtualColumn => (
163+
{columnVirtualizer.virtualItems.map(virtualColumn => (
164164
<div
165165
key={virtualColumn.index}
166166
className={

examples/sandbox/src/Variable.js

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ function RowVirtualizerVariable({ rows }) {
5555
position: "relative"
5656
}}
5757
>
58-
{rowVirtualizer.items.map(virtualRow => (
58+
{rowVirtualizer.virtualItems.map(virtualRow => (
5959
<div
6060
key={virtualRow.index}
6161
className={virtualRow.index % 2 ? "ListItemOdd" : "ListItemEven"}
@@ -106,7 +106,7 @@ function ColumnVirtualizerVariable({ columns }) {
106106
position: "relative"
107107
}}
108108
>
109-
{columnVirtualizer.items.map(virtualColumn => (
109+
{columnVirtualizer.virtualItems.map(virtualColumn => (
110110
<div
111111
key={virtualColumn.index}
112112
className={
@@ -166,9 +166,9 @@ function GridVirtualizerVariable({ rows, columns }) {
166166
position: "relative"
167167
}}
168168
>
169-
{rowVirtualizer.items.map(virtualRow => (
169+
{rowVirtualizer.virtualItems.map(virtualRow => (
170170
<React.Fragment key={virtualRow.index}>
171-
{columnVirtualizer.items.map(virtualColumn => (
171+
{columnVirtualizer.virtualItems.map(virtualColumn => (
172172
<div
173173
key={virtualColumn.index}
174174
className={

src/index.js

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,6 @@ export function useVirtual({
99
overscan = 1,
1010
parentRef,
1111
horizontal,
12-
// pinnedIndices,
13-
// stickyIndices,
1412
}) {
1513
const sizeKey = horizontal ? 'width' : 'height'
1614
const scrollKey = horizontal ? 'scrollLeft' : 'scrollTop'
@@ -71,8 +69,8 @@ export function useVirtual({
7169
startIndex = Math.max(startIndex - 1 - overscan, 0)
7270
endIndex = Math.min(endIndex + 1 + overscan, size - 1)
7371

74-
const items = React.useMemo(() => {
75-
const items = []
72+
const virtualItems = React.useMemo(() => {
73+
const virtualItems = []
7674

7775
for (let i = startIndex; i <= endIndex; i++) {
7876
const measurement = measurements[i]
@@ -93,10 +91,10 @@ export function useVirtual({
9391
},
9492
}
9593

96-
items.push(item)
94+
virtualItems.push(item)
9795
}
9896

99-
return items
97+
return virtualItems
10098
}, [startIndex, endIndex, measurements, sizeKey])
10199

102100
const scrollToOffset = React.useCallback(
@@ -119,7 +117,7 @@ export function useVirtual({
119117
)
120118

121119
return {
122-
items,
120+
virtualItems,
123121
totalSize: total,
124122
scrollToOffset,
125123
scrollToIndex,

src/tests/index.test.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ describe('useVirtual', () => {
3333
position: 'relative',
3434
}}
3535
>
36-
{rowVirtualizer.items.map(virtualRow => (
36+
{rowVirtualizer.virtualItems.map(virtualRow => (
3737
<div
3838
key={virtualRow.index}
3939
className={

0 commit comments

Comments
 (0)