Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support dynamic startMargin #459

Merged
merged 1 commit into from
Jun 24, 2024
Merged

Support dynamic startMargin #459

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions src/core/store.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -140,12 +140,12 @@ export const createVirtualStore = (
itemSize: number = 40,
ssrCount: number = 0,
cacheSnapshot?: CacheSnapshot | undefined,
shouldAutoEstimateItemSize: boolean = false,
startSpacerSize: number = 0
shouldAutoEstimateItemSize: boolean = false
): VirtualStore => {
let isSSR = !!ssrCount;
let stateVersion: StateVersion = [];
let viewportSize = 0;
let startSpacerSize = 0;
let scrollOffset = 0;
let jumpCount = 0;
let jump = 0;
Expand Down
9 changes: 6 additions & 3 deletions src/react/Virtualizer.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
SCROLL_IDLE,
UPDATE_SCROLL_END_EVENT,
getScrollSize,
ACTION_START_OFFSET_CHANGE,
} from "../core/store";
import { useIsomorphicLayoutEffect } from "./useIsomorphicLayoutEffect";
import { createScroller } from "../core/scroller";
Expand Down Expand Up @@ -178,7 +179,7 @@
shift,
horizontal: horizontalProp,
cache,
startMargin,
startMargin = 0,
ssrCount,
as: Element = "div",
item: ItemElement = "div",
Expand Down Expand Up @@ -207,8 +208,7 @@
itemSize,
ssrCount,
cache,
!itemSize,
startMargin
!itemSize
);
return [
_store,
Expand All @@ -222,6 +222,9 @@
if (count !== store._getItemsLength()) {
store._update(ACTION_ITEMS_LENGTH_CHANGE, [count, shift]);
}
if (startMargin !== store._getStartSpacerSize()) {
store._update(ACTION_START_OFFSET_CHANGE, startMargin);
}

const rerender = useRerender(store);

Expand Down Expand Up @@ -309,7 +312,7 @@
if (!onRangeChangeProp) return;

onRangeChangeProp(startIndex, endIndex);
}, [startIndex, endIndex]);

Check warning on line 315 in src/react/Virtualizer.tsx

View workflow job for this annotation

GitHub Actions / check 

React Hook useEffect has a missing dependency: 'onRangeChangeProp'. Either include it or remove the dependency array. If 'onRangeChangeProp' changes too often, find the parent component that defines it and wrap that definition in useCallback

useImperativeHandle(
ref,
Expand All @@ -333,7 +336,7 @@
scrollBy: scroller._scrollBy,
};
},
[]

Check warning on line 339 in src/react/Virtualizer.tsx

View workflow job for this annotation

GitHub Actions / check 

React Hook useImperativeHandle has missing dependencies: 'scroller._scrollBy', 'scroller._scrollTo', 'scroller._scrollToIndex', and 'store'. Either include them or remove the dependency array
);

for (let i = overscanedRangeStart, j = overscanedRangeEnd; i <= j; i++) {
Expand Down
12 changes: 9 additions & 3 deletions src/vue/Virtualizer.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ import {
createVirtualStore,
ACTION_ITEMS_LENGTH_CHANGE,
getScrollSize,
ACTION_START_OFFSET_CHANGE,
} from "../core/store";
import { createResizer } from "../core/resizer";
import { createScroller } from "../core/scroller";
Expand Down Expand Up @@ -93,7 +94,7 @@ const props = {
/**
* If you put an element before virtualizer, you have to define its height with this prop.
*/
startMargin: Number,
startMargin: { type: Number, default: 0 },
/**
* A prop for SSR. If set, the specified amount of items will be mounted in the initial rendering regardless of the container size until hydrated.
*/
Expand All @@ -117,8 +118,7 @@ export const Virtualizer = /*#__PURE__*/ defineComponent({
props.itemSize ?? 40,
props.ssrCount,
undefined,
!props.itemSize,
props.startMargin
!props.itemSize
);
const resizer = createResizer(store, isHorizontal);
const scroller = createScroller(store, isHorizontal);
Expand Down Expand Up @@ -168,6 +168,12 @@ export const Virtualizer = /*#__PURE__*/ defineComponent({
store._update(ACTION_ITEMS_LENGTH_CHANGE, [count, props.shift]);
}
);
watch(
() => props.startMargin,
(value) => {
store._update(ACTION_START_OFFSET_CHANGE, value);
}
);

watch(
[rerender, store._getJumpCount],
Expand Down
Loading