feat: Virtualised list for search results #3722
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Removed vultr server and associated DNS entries |
DafyddLlyr
force-pushed
the
dp/virtualised-search-list
branch
4 times, most recently
from
5272805 to
c547ad9
Compare
DafyddLlyr
force-pushed
the
dp/virtualised-search-list
branch
from
c547ad9 to
b718db7
Compare
DafyddLlyr
force-pushed
the
dp/virtualised-search-list
branch
from
b718db7 to
53b2db7
Compare
DafyddLlyr
force-pushed
the
dp/virtualised-search-list
branch
from
76efb27 to
84cad19
Compare
DafyddLlyr
commented
Sep 30, 2024
Comment on lines
+104
to
+108
| components={{ | ||
| Footer: ExternalPortalList, | ||
| List: ListComponent, | ||
| Item: ListItemComponent, | ||
| Header: SearchHeader, |
There was a problem hiding this comment.
Child components are passed in via the components prop (docs).
DafyddLlyr
commented
Sep 30, 2024
Comment on lines
+40
to
+49
| const ListComponent = React.forwardRef<HTMLUListElement>((props, ref) => ( | ||
| <List {...props} ref={ref} sx={{ mx: 3 }} /> | ||
| )) as Components<Data, Context>["List"]; | ||
|
|
||
| /** | ||
| * Accessibility - Render the Virtuoso item as a HTMLLiElement, not a HTMLDivElement | ||
| */ | ||
| const ListItemComponent = React.forwardRef<HTMLLIElement>((props, ref) => ( | ||
| <ListItem disablePadding sx={{ pb: 2 }} {...props} ref={ref} /> | ||
| )) as Components<Data, Context>["Item"]; |
There was a problem hiding this comment.
I couldn't find a way to set this up without casting to Virtuoso types.
DafyddLlyr
commented
Sep 30, 2024
| @@ -81,6 +81,7 @@ | |||
| "react-navi-helmet-async": "^0.15.0", | |||
| "react-toastify": "^9.1.3", | |||
| "react-use": "^17.5.0", | |||
| "react-virtuoso": "^4.10.4", | |||
There was a problem hiding this comment.
Why react-virtuoso?
- Recommended in MUI docs
- I tried the more basic react-window first and quickly found myself having a lot of CSS and layout issues - Virtuoso "just worked"
- Good score on socket.dev
- Docs were solid and clear
DafyddLlyr
changed the title
jessicamcinchak
approved these changes
Oct 1, 2024
|
Thanks @jessicamcinchak - working my way through those comments now 👍 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What does this PR do?
SearchNodeResultcomponent - this is now just an item within the list (code)SearchHeaderSearchWhat's changed?
Previously, performance felt sluggish when a large number of search results were returned. Scrolling was slow, and the text input would frequently freeze. This is mitigated by using a debounce for the search term, but still noticeable.
Please see this example flow, with search term "user" (215 results) - https://editor.planx.dev/opensystemslab/prior-approval-scope-check
On the Pizza, this should feel a fair bit quicker - we can see in the video below that only a small number of result cards are being rendered at any given moment.
Screen.Recording.2024-09-30.at.17.01.02.mov