Highlights · Before you use · Documentation · Demo · FAQ
Virtualform was designed from the bottom up to be fast. We chose O(1) algorithms and good caching management over Intersection Observers to guarantee lightning fast, consistent performance all around.
Virtualform aims to be thin and to leave a small footprint. Rest assured: the libraries you are consuming are dependency-free (despite React itself, of course) and monitored by size-limit, which imposes a hard limit to the size of the packages to be no more than 2 kB. To give you a glimpse, @virtualform/grid weighs a mere 1.16 kB, minified and gzipped.
Code once, works everywhere. Automatically. Yes, that's right: you don't have to worry about different screen sizes at all.
Thanks to its headless nature, Virtualform allows you to design your virtualized grid the way you want.
Virtualization is not simple. And because of that, we strived for an ergonomic API—we expect as much as you a smooth developer experience when working with Virtualform.
♾️ Infinite scrolling without abstractions →
The way you achieve infinite scrolling with Virtualform is up to you. It may sound boring, but in reality, this is us helping you in the long term. Virtualform gives you some tools to help you with it, but our intention is not crossing the line in your codebase.
What not to love about type safety and autocompletion?
Virtualform is currently pretty stable as is, but designed to satisfy our needs at Starchive. For example, it still does not virtualize plain, vertical lists or masonry-like grids. Also, it is fully responsive without the option to opt-out.
That said, at the time I'm writing this, I'd only suggest you to use Virtualform if you are specifically looking for a way to virtualize symmetrical, responsive grids. Otherwise, I'd suggest you to use react-window.
- Grid
- List (under development)
- Masonry (under development)
What is virtualization?
Virtualization, or windowing, is the concept of "unloading" content that's not visible to the human eye, hence making your application more performant.
Imagine Instagram's feed: you can spend a day scrolling down and you don't feel any lags or glitches. That's because anything you don't see, thanks to virtualization, is freed from CPU computation.
There are plenty of nuances here I don't want to dive into, but in a nutshell, that's how virtualization can be understood.
Is virtualization for me?
It depends. Virtualization is only useful when you are dealing with a great, or an unpredictable, amount of data.
To give you a sense of scale,
- I wouldn't bother if I had to render up to 100-200 pictures. Anything beyond that though, I'd definitely virtualize.
- I wouldn't bother to virtualize data that aren't paginated through infinite loading. I'd display 100 items per page and that's it.
Virtualization comes at a very expensive cost: complexity. It makes your codebase more difficult to maintain, more difficult to understand and if not done properly, it may lock you in a place where you become a hostage, really hard to get out.
Why Virtualform was created?
At Starchive, we render huge grids of files and the painting, loading and scrolling experience have to be fast and seamless. We already used other virtualization libraries that did a pretty good job, but we always had the feeling that either a feature was missing or proper developer experience was lacking.
Virtualform was built from scratch to address the two problems at the same time.
Why Virtualform instead of __________?
Components are not a bad thing per say, but hooks give you power at a greater scope than a component does.
Give us the components and we make them responsive.
No hidden wrapping divs or styles—you own the visuals and the DOM tree.
Check out the demo with 100k cells
We put great effort on making the documentation incredible. We expect both beginners and experienced devs to be able to read and understand the tidbits of Virtualform.
How stable is Virtualform right now?
As is, it's pretty stable—we are using it in production.
However, note that its API can change. And I say "can" instead of "should" or "may" because there are no plans for it. If needed though, it'll be changed.
Where's feature X?
Virtualform is an ongoing project that first has to satisfy the needs we have at Starchive. Everything it offers right now is based on our demands at the company. If it lacks a feature you need, feel free to submit a Pull Request or Create an Issue asking for it.
Will Virtualform support lists/tabular data other than grids?
Yes.
Will Virtualform support Masonry-like grids?
Very likely.
Will Virtualform support horizontal scrolling?
Very likely.
Brought to you by 🇧🇷 Guilherme "chiefGui" Oderdenge and Starchive.
The MIT License (MIT)
Copyright (c) 2022 Guilherme Oderdenge
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.