Skip to content

Commit 43ee4c3

Browse files
authored
Merge pull request #4 from matthargett/patch-1
Mention specific React Native version
2 parents 78171f1 + cd4fe12 commit 43ee4c3

File tree

1 file changed

+10
-3
lines changed

1 file changed

+10
-3
lines changed

README.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<img src="https://raw.githubusercontent.com/jsdotlua/branding/main/Logo.png" align="right" height="128"/>
22

33
# VirtualizedList Lua
4-
### High-performance virtualized scrolling lists for [react-lua](https://github.com/jsdotlua/react-lua).
4+
### High-performance scrolling lists ported from React Native for [react-lua](https://github.com/jsdotlua/react-lua).
55

66
<a href="https://github.com/jsdotlua/virtualized-list-lua/blob/main/LICENSE.md">
77
<img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="license" height="18">
@@ -25,8 +25,9 @@ A collection of virtual list components, supporting the most handy features:
2525
- Scroll loading
2626
- ScrollToIndex support
2727
- Multiple column support
28+
- Animation suppot
2829

29-
Virtualization massively improves memory consumption and performance of large lists by maintaining a finite render window of active items and replacing all items outside of the render window with appropriately sized blank space. The window adapts to scrolling behavior, and items are rendered incrementally with low-pri (after any running interactions) if they are far from the visible area, or with hi-pri otherwise to minimize the potential of seeing blank space.
30+
Virtualization massively improves memory consumption and performance of large lists by maintaining a finite render window of active items and replacing all items outside of the render window with appropriately sized blank space. The window adapts to scrolling behavior, and items are rendered incrementally with low-priority (after any running interaction responses) if they are far from the visible area, or with high-priority otherwise to minimize the potential of seeing blank space.
3031

3132
## Caveats
3233

@@ -105,8 +106,14 @@ root:render(ReactRoblox.createPortal(e(App), Players.LocalPlayer.PlayerGui))
105106

106107
## Documentation
107108

108-
More information on the provided list components can be found at:
109+
These components are directly ported from React Native 0.68, so most documentation and articles should apply (modulo Lua syntax). More information on the provided list components can be found at:
109110

110111
- `VirtualizedList` - https://reactnative.dev/docs/virtualizedlist
111112
- `FlatList` - https://reactnative.dev/docs/flatlist
112113
- `SectionList` - https://reactnative.dev/docs/sectionlist
114+
115+
## TODO
116+
117+
- Add unit tests from upstream React Native
118+
- Use `darklua` bundler to allow more files to easily run outside of Roblox
119+
- Add performance benchmarks

0 commit comments

Comments
 (0)