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

[Select] Smaller demos #21642

Closed
ivanjeremic opened this issue Jul 1, 2020 · 13 comments · Fixed by #21792
Closed

[Select] Smaller demos #21642

ivanjeremic opened this issue Jul 1, 2020 · 13 comments · Fixed by #21792
Labels
component: select This is the name of the generic UI component, not the React module! docs Improvements or additions to the documentation ready to take Help wanted. Guidance available. There is a high chance the change will be accepted

Comments

@ivanjeremic
Copy link

ivanjeremic commented Jul 1, 2020

Can we have things like this removed from the docs? https://i.gyazo.com/93dc156541e3b7939022a4239747bd94.png

It makes it hard to find components that we need I would suggest 1 element per example.

@ivanjeremic ivanjeremic added the status: waiting for maintainer These issues haven't been looked at yet by a maintainer label Jul 1, 2020
@oliviertassinari
Copy link
Member

Your link is not working

@ivanjeremic
Copy link
Author

Your link is not working

fixed

@oliviertassinari
Copy link
Member

We had a first iteration on this page to reduce the number of components on each demo. Cc @joshwooding, do you see any simplification potential left?

@oliviertassinari oliviertassinari added component: text field This is the name of the generic UI component, not the React module! docs Improvements or additions to the documentation and removed status: waiting for maintainer These issues haven't been looked at yet by a maintainer labels Jul 1, 2020
@ivanjeremic
Copy link
Author

We had a first iteration on this page to reduce the number of components on each demo. Cc @joshwooding, do you see any simplification potential left?

Keep the number of examples the same only separate them, give every variation of for example this Select an own demo.

@oliviertassinari
Copy link
Member

Which URL did you use?

@ivanjeremic
Copy link
Author

ivanjeremic commented Jul 1, 2020

Which URL did you use?

https://material-ui.com/components/selects/

But it's the same with almost every component.

@oliviertassinari oliviertassinari added the ready to take Help wanted. Guidance available. There is a high chance the change will be accepted label Jul 1, 2020
@oliviertassinari
Copy link
Member

Thanks, agree, I think that we could simplify the demos :)

@oliviertassinari oliviertassinari changed the title Optimize Docs [Select] Smaller demos Jul 1, 2020
@oliviertassinari oliviertassinari added component: select This is the name of the generic UI component, not the React module! and removed component: text field This is the name of the generic UI component, not the React module! labels Jul 1, 2020
@oliviertassinari
Copy link
Member

Would you be interested in working on it?

@ivanjeremic
Copy link
Author

Would you be interested in working on it?

I would have time from September until then I can't say 100%

@cjoecker
Copy link
Contributor

cjoecker commented Jul 12, 2020

@oliviertassinari I can take this.

So, my idea would be to separate the demos in max. 4 components per demo.
I think one demo per variant will make the page too long.

Another option I like, is when the variants can be selected and the code will be generated based on that.
Similar to the popover.

What do you think @ivanjeremic and @oliviertassinari ?

@oliviertassinari
Copy link
Member

@cjoecker I don't know about a hard limit at 4, I think that we would benefit from creating smaller chunks, especially so that people spent less time scrolling the source of the demos. Playgrounds can be interesting, but only for the bottom of the page, I think that it makes it hard to discover the content.

@cjoecker
Copy link
Contributor

@oliviertassinari good point. I was not thinking about a hard limit. I was more thinking about a balance of not too much scrolling because of too many small demos but also not too much scrolling because the examples are too long.

I will experiment a bit...

@ivanjeremic
Copy link
Author

@cjoecker I don't know about a hard limit at 4, I think that we would benefit from creating smaller chunks, especially so that people spent less time scrolling the source of the demos. Playgrounds can be interesting, but only for the bottom of the page, I think that it makes it hard to discover the content.

I think people have no problem with scrolling, scrolling is easier than searching what belongs to the component you want in a big chunk of code example.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component: select This is the name of the generic UI component, not the React module! docs Improvements or additions to the documentation ready to take Help wanted. Guidance available. There is a high chance the change will be accepted
Projects
None yet
3 participants