Thanks to visit codestin.com
Credit goes to github.com

Skip to content

fix(useVirtualList): allow readonly arrays as input #4504

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.

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

Merged
merged 2 commits into from
Jan 22, 2025

Conversation

RebeccaStevens
Copy link
Contributor

Before submitting the PR, please make sure you do the following

  • Read the Contributing Guidelines.
  • Read the Pull Request Guidelines.
  • Check that there isn't already a PR that solves the problem the same way to avoid creating a duplicate.
  • Provide a description in this PR that addresses what the PR is solving, or reference the issue that it solves (e.g. fixes #123).
  • Ideally, include relevant tests that fail without this PR but pass with it.
⚠️ Slowing down new functions

Warning: Slowing down new functions

As the VueUse audience continues to grow, we have been inundated with an overwhelming number of feature requests and pull requests. As a result, maintaining the project has become increasingly challenging and has stretched our capacity to its limits. As such, in the near future, we may need to slow down our acceptance of new features and prioritize the stability and quality of existing functions. Please note that new features for VueUse may not be accepted at this time. If you have any new ideas, we suggest that you first incorporate them into your own codebase, iterate on them to suit your needs, and assess their generalizability. If you strongly believe that your ideas are beneficial to the community, you may submit a pull request along with your use cases, and we would be happy to review and discuss them. Thank you for your understanding.


Description

Fix #4503

Allow passing a ReadonlyArray to useVirtualList.

@RebeccaStevens RebeccaStevens changed the title fix: allow readonly arrays as input fix(useVirtualList): allow readonly arrays as input Jan 17, 2025
@dosubot dosubot bot added the size:S This PR changes 10-29 lines, ignoring generated files. label Jan 17, 2025

it('allows a readonly array as input', () => {
const input = ['a', 'b', 'c', 'd', 'e', 'f'] as const
const { list } = useVirtualList(ref(input), { itemHeight: () => 50, overscan: 1 })
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why ref this here?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was just copying the other tests.

OrbisK
OrbisK previously requested changes Jan 17, 2025
Copy link
Collaborator

@OrbisK OrbisK left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

not sure if this is right.

tests are failing too btw 😄

@@ -42,7 +42,7 @@ export interface UseVirtualListItem<T> {
}

export interface UseVirtualListReturn<T> {
list: Ref<UseVirtualListItem<T>[]>
list: Ref<readonly UseVirtualListItem<T>[]>
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this will only return a readonly, no?

image

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, I'll fix this up.

@RebeccaStevens RebeccaStevens force-pushed the useVirtualList-readonly-array branch from 039e839 to 3da46e8 Compare January 19, 2025 08:47
@dosubot dosubot bot added size:M This PR changes 30-99 lines, ignoring generated files. and removed size:S This PR changes 10-29 lines, ignoring generated files. labels Jan 19, 2025
@RebeccaStevens RebeccaStevens force-pushed the useVirtualList-readonly-array branch from 3da46e8 to 9a55d4d Compare January 19, 2025 08:50
@RebeccaStevens
Copy link
Contributor Author

I reworked this PR. It should be good now.

@RebeccaStevens RebeccaStevens requested a review from OrbisK January 19, 2025 08:57
@43081j
Copy link
Collaborator

43081j commented Jan 21, 2025

i'm not sure you need to go this far. a writable array is assignable to a readonly array

because of this, it should be as simple as changing useVirtualList to always deal with readonly T[]

see this playground

importantly, the writable ones are what we have now and the readonly ones are what im suggesting

@RebeccaStevens
Copy link
Contributor Author

@43081j My original commit did that, but @OrbisK pointed out some issues with that approach, hence this approach.

@43081j
Copy link
Collaborator

43081j commented Jan 21, 2025

Interesting. Do you have a link to where those issues were mentioned? I couldn't find them unless I'm being blind

Would be good to understand for future references why we wouldn't use readonly

@dosubot dosubot bot added size:S This PR changes 10-29 lines, ignoring generated files. and removed size:M This PR changes 30-99 lines, ignoring generated files. labels Jan 22, 2025
@RebeccaStevens RebeccaStevens force-pushed the useVirtualList-readonly-array branch from af1ac06 to ed7cdf8 Compare January 22, 2025 01:20
@RebeccaStevens RebeccaStevens force-pushed the useVirtualList-readonly-array branch from ed7cdf8 to e7a7f80 Compare January 22, 2025 01:22
@dosubot dosubot bot added the lgtm This PR has been approved by a maintainer label Jan 22, 2025
@antfu antfu enabled auto-merge January 22, 2025 07:57
@antfu antfu added this pull request to the merge queue Jan 22, 2025
Merged via the queue into vueuse:main with commit f3cc7ec Jan 22, 2025
9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
lgtm This PR has been approved by a maintainer size:S This PR changes 10-29 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

BUG | useVirtualList | doesn't allow readonly arrays as input
4 participants