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][material-ui] TableContainer not well documented #42836

Closed
ZebraFlesh opened this issue Jul 3, 2024 · 6 comments · Fixed by #43756
Closed

[docs][material-ui] TableContainer not well documented #42836

ZebraFlesh opened this issue Jul 3, 2024 · 6 comments · Fixed by #43756
Labels
docs Improvements or additions to the documentation package: material-ui Specific to @mui/material ready to take Help wanted. Guidance available. There is a high chance the change will be accepted support: docs-feedback Feedback from documentation page

Comments

@ZebraFlesh
Copy link

ZebraFlesh commented Jul 3, 2024

Related page

https://mui.com/material-ui/api/table-container/

Kind of issue

Missing information

Issue description

It's not clear to me what a TableContainer is and when I would/wouldn't want to use it. The demos say "see Table", but the Table demos don't really explain it -- searching for TableContainer on https://mui.com/material-ui/react-table/ only turns up one hit, the link back to the TableContainer API.

Context

I'm trying to construct my first HTML table with MUI. Do I need a TableContainer? Why? Can I do without it? What's the tradeoff for using vs. not using?

Search keywords: TableContainer

@ZebraFlesh ZebraFlesh added status: waiting for maintainer These issues haven't been looked at yet by a maintainer support: docs-feedback Feedback from documentation page labels Jul 3, 2024
@ZeeshanTamboli
Copy link
Member

This is related to #39952 and is being tracked here. Would you like to create a pull request?

@ZeeshanTamboli ZeeshanTamboli added docs Improvements or additions to the documentation package: material-ui Specific to @mui/material ready to take Help wanted. Guidance available. There is a high chance the change will be accepted and removed status: waiting for maintainer These issues haven't been looked at yet by a maintainer labels Jul 4, 2024
@ZeeshanTamboli ZeeshanTamboli changed the title [docs] TableContainer not well documented [docs][material-ui] TableContainer not well documented Jul 4, 2024
@ZebraFlesh
Copy link
Author

Unfortunately I don't know the answers to the questions I posed, so I am unable to make a PR.

@ZeeshanTamboli
Copy link
Member

ZeeshanTamboli commented Jul 5, 2024

Unfortunately I don't know the answers to the questions I posed

That's what we need to document.

@mi-na-bot
Copy link

Does it provide a horizontally scrollable 100% width container (for mobile devices and too-wide tables) and not much more?

https://github.com/mui/material-ui/blob/master/packages/mui-material/src/TableContainer/TableContainer.js#L20-L27

@ZeeshanTamboli
Copy link
Member

Does it provide a horizontally scrollable 100% width container (for mobile devices and too-wide tables) and not much more?

https://github.com/mui/material-ui/blob/master/packages/mui-material/src/TableContainer/TableContainer.js#L20-L27

Yes, that's correct, and it also allows you to change the root container, like to the Paper component, as shown in the demos.

Copy link

This issue has been closed. If you have a similar problem but not exactly the same, please open a new issue.
Now, if you have additional information related to this issue or things that could help future readers, feel free to leave a comment.

Note

We value your feedback @ZebraFlesh! How was your experience with our support team?
If you could spare a moment, we'd love to hear your thoughts in this brief Support Satisfaction survey. Your insights help us improve!

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 package: material-ui Specific to @mui/material ready to take Help wanted. Guidance available. There is a high chance the change will be accepted support: docs-feedback Feedback from documentation page
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants