Skip to content
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

[docs] Mention Virtuoso as a possible virtualization integration #15934

Merged
merged 1 commit into from
May 30, 2019
Merged

[docs] Mention Virtuoso as a possible virtualization integration #15934

merged 1 commit into from
May 30, 2019

Conversation

petyosi
Copy link
Contributor

@petyosi petyosi commented May 29, 2019

Adds a simplified endless scrolling example to the list documentation page, using React Virtuoso.

For a live (more complex) example and step-by-step explanations, check this blog post.

Thanks for your hard work!

@mui-pr-bot
Copy link

mui-pr-bot commented May 29, 2019

No bundle size changes comparing 831c6cc...8ba4ca8

Generated by 🚫 dangerJS against 8ba4ca8

@oliviertassinari
Copy link
Member

@petyosi Thanks for sharing, I wish we talked about it before as it's not obvious to me that we should accept the change. Our users value the fact that we make educated decisions for them regarding what the go-to solution for their problem is. Proposing too many options creates friction: What the best option for my use case? Will I miss out if I go with the wrong option? That's the paradox of choice.

So here is my question, why should we document react-virtuoso? We already document react-window and react-virtualized.

@petyosi
Copy link
Contributor Author

petyosi commented May 29, 2019

These are valid concerns. Of course, you are not obliged to accept this pull request. react-window is very popular solution.

My motivation for the Virtuoso project is to make a virtualization engine that's easy to use, figures out as much as possible for you and does not require a bunch of manual component assembly for common use cases. Good examples for that are automatic item height, native keyboard navigation, and endless scrolling - all of those come out of the box or super easy to configure.

This PR documents scenario which I consider interesting (without being overly complex) while being a common use case when dealing with Lists. It complements the existing react-window one. Can it increase ambiguity or confuse users? I hope not.

I would love to get some suggestions on how this can be helpful to the Material-UI community. Thank you for your time!

@stunaz
Copy link
Contributor

stunaz commented May 29, 2019

When it comes to integration with third-parties, I don't think that Material-UI should be that opinionated. the choice should be left to end-users. Out-of-the-box solution from material-ui/core/lab/styles ..., should be opinionated, they shouldn't be friction there.

So maybe, the list Demo is not the right place to put it, maybe in an integrated demo section or something...

just my 2 cents...

@oliviertassinari
Copy link
Member

I would be fine with the following: we link react virtualized at the end of the react-window demo, explaning that it's better suites for advanced use cases. We link virtuoso as a possible alternative, we don't add any live demo.

What do you think?

@petyosi
Copy link
Contributor Author

petyosi commented May 29, 2019

@oliviertassinari Thanks for the consideration! I have removed the live demo and the section header. Let me know if this is what you had in mind.

@oliviertassinari oliviertassinari added the docs Improvements or additions to the documentation label May 29, 2019
@oliviertassinari oliviertassinari changed the title [docs] add Virtuoso endless scrolling example to list [docs] Add Virtuoso endless scrolling example to list May 29, 2019
Copy link
Member

@oliviertassinari oliviertassinari left a comment

Choose a reason for hiding this comment

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

I have rephrased the content a bit to emphasize the order people should try the different modules.

docs/src/pages/components/lists/lists.md Outdated Show resolved Hide resolved
docs/src/pages/components/lists/lists.md Outdated Show resolved Hide resolved
@oliviertassinari oliviertassinari changed the title [docs] Add Virtuoso endless scrolling example to list [docs] Mention Virtuoso as a possible virtualization integration May 30, 2019
@oliviertassinari oliviertassinari merged commit 0ffe293 into mui:master May 30, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to the documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants