Type 'bigint' is not assignable to type 'Key | null | undefined' when trying to use virtualItem.key as react component key
Maintainers usually reply within 1 day
Assessment
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 45/100
- Issue type
- Bug
- Clarity
- Clearly specified
- Activity status
- Stale
- Tech stack
- react, typescript
- Domain
- frontend
Research direction
Start with the generated type declaration at index.d.ts line 98 and reproduce the error in main.tsx from the linked StackBlitz example. Compare the exposed virtualItem.key type with the React key type under TypeScript 4.9.5; done means key={virtualItem.key} type-checks without requiring the String workaround.
Written by the indexing model from the issue text.
Description
Describe the bug
<SomeItem key={virtualItem.key} />
results in:
Type 'Key' is not assignable to type 'Key | null | undefined'.
Type 'bigint' is not assignable to type 'Key | null | undefined'.ts(2322)
index.d.ts(98, 9): The expected type comes from property 'key' which is declared here on type 'IntrinsicAttributes'
I suspect this may be due to being on an older version of React than what the Key type is targeting? But I don't think this should matter.
const key = String(virtualItem.key); works fine as a workaround, but it'd be nice if either:
Keytype from installed version of React is usedKeytype is inferred fromgetItemKeyKeytype could be passed to useVirtualizer, likeuseVirtualizer<TItemKey>(...)
As always, great job with this library. I love it! ❤
Your minimal, reproducible example
https://stackblitz.com/edit/tanstack-virtual-pksf2gfh?file=src%2Fmain.tsx
Steps to reproduce
- Open StackBlitz link
- In main.tsx, scroll down to
key={virtualRow.key}and see the type error
Expected behavior
Shouldn't get a type error
How often does this bug happen?
Every time
Screenshots or Videos
No response
Platform
- MacOS 14.4
- VSCode 1.98.2
- TypeScript 4.9.5
tanstack-virtual version
@tanstack/[email protected]
TypeScript version
4.9.5
Additional context
No response
Terms & Code of Conduct
- I agree to follow this project's Code of Conduct
- I understand that if my bug cannot be reliable reproduced in a debuggable environment, it will probably not be fixed and this issue may even be closed.
- Dominant language
- TypeScript
- Stars
- 7.2k
- Forks
- 495
- Avg merge
- 23h 16m
- Merged PRs (30d)
- 19
Getting set up
- No Dockerfile or Docker Compose file
- Has a pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from TanStack/virtual
-
Difficulty 3/5 1-2 days Newbie friendliness 55/100
Maintainers usually reply within 1 day
-
With `useScrollendEvent`, scrollToIndex and scrollToEnd stop short when the target moves while they settlePossibly taken @Darkatse claimed this 8 days ago. Open
Difficulty 4/5 3-5 days Newbie friendliness 25/100
Maintainers usually reply within 1 day
-
svelte-virtual renders no rows when the scroll element is bound after the store subscribesPossibly taken @clean99 claimed this 13 days ago. Open
Difficulty 4/5 1-2 days Newbie friendliness 35/100
Maintainers usually reply within 1 day
-
anchorTo: 'end' does not keep the reading position when only paddingStart changesPossibly taken @duongynhi000001-crypto claimed this 12 days ago. Open
Difficulty 3/5 1-2 days Newbie friendliness 30/100
Maintainers usually reply within 1 day
-
anchorTo: 'end' loses the end when the scroll element shrinksPossibly taken @langleyd claimed this 41 days ago. Open
Difficulty 3/5 1-2 days Newbie friendliness 68/100
Maintainers usually reply within 1 day
All issues in TanStack/virtual
Similar issues
-
Difficulty 1/5 1-3 hours Newbie friendliness 83/100
gofish-graphics/gofish-graphics#1384 ·
Maintainers usually reply within 1 day
-
adapter bug
Difficulty 2/5 1-3 hours Newbie friendliness 83/100
Olanetsoft/agent-lookout#353 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
vicharanashala/vibe#1542 ·
Maintainers usually reply within 1 day
-
bug chore P2 size:XS
Difficulty 2/5 1-3 hours Newbie friendliness 77/100
josephfung/curia#2666 ·
Maintainers usually reply within 1 day
-
bug good first issue
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
devarshishimpi/codra#178 ·
Maintainers usually reply within 1 day