--- productId: material-ui title: React Table component components: Table, TableBody, TableCell, TableContainer, TableFooter, TableHead, TablePagination, TableRow, TableSortLabel githubLabel: 'scope: table' waiAria: https://www.w3.org/WAI/ARIA/apg/patterns/table/ materialDesign: https://m2.material.io/components/data-tables githubSource: packages/mui-material/src/Table --- # Table Tables display sets of data. They can be fully customized. Tables display information in a way that's easy to scan, so that users can look for patterns and insights. They can be embedded in primary content, such as cards. They can include: - A corresponding visualization - Navigation - Tools to query and manipulate data ## Introduction Tables are implemented using a collection of related components: - ``: A wrapper that provides horizontally scrolling behavior for the `` component. - `
`: The main component for the table element. Renders as a `
` by default. - ``: The container for the header row(s) of `
`. Renders as a `` by default. - ``: The container for the body rows of `
`. Renders as a `` by default. - ``: A row in a table. Can be used in ``, ``, or ``. Renders as a `` by default. - ``: A cell in a table. Can be used in `` . Renders as a `` by default. - ``: A component that provides controls for paginating table data. See the ['Sorting & selecting' example](#sorting-selecting) and ['Custom Table Pagination Action' example](#custom-pagination-actions). - ``: A component used to display sorting controls for column headers, allowing users to sort data in ascending or descending order. See the ['Sorting & selecting' example](#sorting-selecting). ## Basic table A simple example with no frills. ```tsx import Table from '@mui/material/Table'; import TableBody from '@mui/material/TableBody'; import TableCell from '@mui/material/TableCell'; import TableContainer from '@mui/material/TableContainer'; import TableHead from '@mui/material/TableHead'; import TableRow from '@mui/material/TableRow'; import Paper from '@mui/material/Paper'; function createData( name: string, calories: number, fat: number, carbs: number, protein: number, ) { return { name, calories, fat, carbs, protein }; } const rows = [ createData('Frozen yoghurt', 159, 6.0, 24, 4.0), createData('Ice cream sandwich', 237, 9.0, 37, 4.3), createData('Eclair', 262, 16.0, 24, 6.0), createData('Cupcake', 305, 3.7, 67, 4.3), createData('Gingerbread', 356, 16.0, 49, 3.9), ]; export default function BasicTable() { return (
` in `` and `` in `` by default. - ``: An optional container for the footer row(s) of the table. Renders as a `
Dessert (100g serving) Calories Fat (g) Carbs (g) Protein (g) {rows.map((row) => ( {row.name} {row.calories} {row.fat} {row.carbs} {row.protein} ))}
); } ``` ## Data table The `Table` component has a close mapping to the native `` elements. This constraint makes building rich data tables challenging. The [`DataGrid` component](/x/react-data-grid/) is designed for use-cases that are focused on handling large amounts of tabular data. While it comes with a more rigid structure, in exchange, you gain more powerful features. ```tsx import { DataGrid, GridColDef } from '@mui/x-data-grid'; import Paper from '@mui/material/Paper'; const columns: GridColDef[] = [ { field: 'id', headerName: 'ID', width: 70 }, { field: 'firstName', headerName: 'First name', width: 130 }, { field: 'lastName', headerName: 'Last name', width: 130 }, { field: 'age', headerName: 'Age', type: 'number', width: 90, }, { field: 'fullName', headerName: 'Full name', description: 'This column has a value getter and is not sortable.', sortable: false, width: 160, valueGetter: (value, row) => `${row.firstName || ''} ${row.lastName || ''}`, }, ]; const rows = [ { id: 1, lastName: 'Snow', firstName: 'Jon', age: 35 }, { id: 2, lastName: 'Lannister', firstName: 'Cersei', age: 42 }, { id: 3, lastName: 'Lannister', firstName: 'Jaime', age: 45 }, { id: 4, lastName: 'Stark', firstName: 'Arya', age: 16 }, { id: 5, lastName: 'Targaryen', firstName: 'Daenerys', age: null }, { id: 6, lastName: 'Melisandre', firstName: null, age: 150 }, { id: 7, lastName: 'Clifford', firstName: 'Ferrara', age: 44 }, { id: 8, lastName: 'Frances', firstName: 'Rossini', age: 36 }, { id: 9, lastName: 'Roxie', firstName: 'Harvey', age: 65 }, ]; const paginationModel = { page: 0, pageSize: 5 }; export default function DataTable() { return ( ); } ``` ## Dense table A simple example of a dense table with no frills. ```tsx import Table from '@mui/material/Table'; import TableBody from '@mui/material/TableBody'; import TableCell from '@mui/material/TableCell'; import TableContainer from '@mui/material/TableContainer'; import TableHead from '@mui/material/TableHead'; import TableRow from '@mui/material/TableRow'; import Paper from '@mui/material/Paper'; function createData( name: string, calories: number, fat: number, carbs: number, protein: number, ) { return { name, calories, fat, carbs, protein }; } const rows = [ createData('Frozen yoghurt', 159, 6.0, 24, 4.0), createData('Ice cream sandwich', 237, 9.0, 37, 4.3), createData('Eclair', 262, 16.0, 24, 6.0), createData('Cupcake', 305, 3.7, 67, 4.3), createData('Gingerbread', 356, 16.0, 49, 3.9), ]; export default function DenseTable() { return (
Dessert (100g serving) Calories Fat (g) Carbs (g) Protein (g) {rows.map((row) => ( {row.name} {row.calories} {row.fat} {row.carbs} {row.protein} ))}
); } ``` ## Sorting & selecting This example demonstrates the use of `Checkbox` and clickable rows for selection, with a custom `Toolbar`. It uses the `TableSortLabel` component to help style column headings. The Table has been given a fixed width to demonstrate horizontal scrolling. In order to prevent the pagination controls from scrolling, the TablePagination component is used outside of the Table. (The ['Custom Table Pagination Action' example](#custom-pagination-actions) below shows the pagination within the TableFooter.) ```tsx import * as React from 'react'; import { alpha } from '@mui/material/styles'; import Box from '@mui/material/Box'; import Table from '@mui/material/Table'; import TableBody from '@mui/material/TableBody'; import TableCell from '@mui/material/TableCell'; import TableContainer from '@mui/material/TableContainer'; import TableHead from '@mui/material/TableHead'; import TablePagination from '@mui/material/TablePagination'; import TableRow from '@mui/material/TableRow'; import TableSortLabel from '@mui/material/TableSortLabel'; import Toolbar from '@mui/material/Toolbar'; import Typography from '@mui/material/Typography'; import Paper from '@mui/material/Paper'; import Checkbox from '@mui/material/Checkbox'; import IconButton from '@mui/material/IconButton'; import Tooltip from '@mui/material/Tooltip'; import FormControlLabel from '@mui/material/FormControlLabel'; import Switch from '@mui/material/Switch'; import DeleteIcon from '@mui/icons-material/Delete'; import FilterListIcon from '@mui/icons-material/FilterList'; import { visuallyHidden } from '@mui/utils'; interface Data { id: number; calories: number; carbs: number; fat: number; name: string; protein: number; } function createData( id: number, name: string, calories: number, fat: number, carbs: number, protein: number, ): Data { return { id, name, calories, fat, carbs, protein, }; } const rows = [ createData(1, 'Cupcake', 305, 3.7, 67, 4.3), createData(2, 'Donut', 452, 25.0, 51, 4.9), createData(3, 'Eclair', 262, 16.0, 24, 6.0), createData(4, 'Frozen yoghurt', 159, 6.0, 24, 4.0), createData(5, 'Gingerbread', 356, 16.0, 49, 3.9), createData(6, 'Honeycomb', 408, 3.2, 87, 6.5), createData(7, 'Ice cream sandwich', 237, 9.0, 37, 4.3), createData(8, 'Jelly Bean', 375, 0.0, 94, 0.0), createData(9, 'KitKat', 518, 26.0, 65, 7.0), createData(10, 'Lollipop', 392, 0.2, 98, 0.0), createData(11, 'Marshmallow', 318, 0, 81, 2.0), createData(12, 'Nougat', 360, 19.0, 9, 37.0), createData(13, 'Oreo', 437, 18.0, 63, 4.0), ]; function descendingComparator(a: T, b: T, orderBy: keyof T) { if (b[orderBy] < a[orderBy]) { return -1; } if (b[orderBy] > a[orderBy]) { return 1; } return 0; } type Order = 'asc' | 'desc'; function getComparator( order: Order, orderBy: Key, ): ( a: { [key in Key]: number | string }, b: { [key in Key]: number | string }, ) => number { return order === 'desc' ? (a, b) => descendingComparator(a, b, orderBy) : (a, b) => -descendingComparator(a, b, orderBy); } interface HeadCell { disablePadding: boolean; id: keyof Data; label: string; numeric: boolean; } const headCells: readonly HeadCell[] = [ { id: 'name', numeric: false, disablePadding: true, label: 'Dessert (100g serving)', }, { id: 'calories', numeric: true, disablePadding: false, label: 'Calories', }, { id: 'fat', numeric: true, disablePadding: false, label: 'Fat (g)', }, { id: 'carbs', numeric: true, disablePadding: false, label: 'Carbs (g)', }, { id: 'protein', numeric: true, disablePadding: false, label: 'Protein (g)', }, ]; interface EnhancedTableProps { numSelected: number; onRequestSort: (event: React.MouseEvent, property: keyof Data) => void; onSelectAllClick: (event: React.ChangeEvent) => void; order: Order; orderBy: string; rowCount: number; } function EnhancedTableHead(props: EnhancedTableProps) { const { onSelectAllClick, order, orderBy, numSelected, rowCount, onRequestSort } = props; const createSortHandler = (property: keyof Data) => (event: React.MouseEvent) => { onRequestSort(event, property); }; return ( 0 && numSelected < rowCount} checked={rowCount > 0 && numSelected === rowCount} onChange={onSelectAllClick} slotProps={{ input: { 'aria-label': 'select all desserts' }, }} /> {headCells.map((headCell) => ( {headCell.label} {orderBy === headCell.id ? ( {order === 'desc' ? 'sorted descending' : 'sorted ascending'} ) : null} ))} ); } interface EnhancedTableToolbarProps { numSelected: number; } function EnhancedTableToolbar(props: EnhancedTableToolbarProps) { const { numSelected } = props; return ( 0 && { bgcolor: (theme) => alpha(theme.palette.primary.main, theme.palette.action.activatedOpacity), }, ]} > {numSelected > 0 ? ( {numSelected} selected ) : ( Nutrition )} {numSelected > 0 ? ( ) : ( )} ); } export default function EnhancedTable() { const [order, setOrder] = React.useState('asc'); const [orderBy, setOrderBy] = React.useState('calories'); const [selected, setSelected] = React.useState([]); const [page, setPage] = React.useState(0); const [dense, setDense] = React.useState(false); const [rowsPerPage, setRowsPerPage] = React.useState(5); const handleRequestSort = ( event: React.MouseEvent, property: keyof Data, ) => { const isAsc = orderBy === property && order === 'asc'; setOrder(isAsc ? 'desc' : 'asc'); setOrderBy(property); }; const handleSelectAllClick = (event: React.ChangeEvent) => { if (event.target.checked) { const newSelected = rows.map((n) => n.id); setSelected(newSelected); return; } setSelected([]); }; const handleClick = (event: React.MouseEvent, id: number) => { const selectedIndex = selected.indexOf(id); let newSelected: readonly number[] = []; if (selectedIndex === -1) { newSelected = newSelected.concat(selected, id); } else if (selectedIndex === 0) { newSelected = newSelected.concat(selected.slice(1)); } else if (selectedIndex === selected.length - 1) { newSelected = newSelected.concat(selected.slice(0, -1)); } else if (selectedIndex > 0) { newSelected = newSelected.concat( selected.slice(0, selectedIndex), selected.slice(selectedIndex + 1), ); } setSelected(newSelected); }; const handleChangePage = (event: unknown, newPage: number) => { setPage(newPage); }; const handleChangeRowsPerPage = (event: React.ChangeEvent) => { setRowsPerPage(parseInt(event.target.value, 10)); setPage(0); }; const handleChangeDense = (event: React.ChangeEvent) => { setDense(event.target.checked); }; // Avoid a layout jump when reaching the last page with empty rows. const emptyRows = page > 0 ? Math.max(0, (1 + page) * rowsPerPage - rows.length) : 0; const visibleRows = React.useMemo( () => [...rows] .sort(getComparator(order, orderBy)) .slice(page * rowsPerPage, page * rowsPerPage + rowsPerPage), [order, orderBy, page, rowsPerPage], ); return ( {visibleRows.map((row, index) => { const isItemSelected = selected.includes(row.id); const labelId = `enhanced-table-checkbox-${index}`; return ( handleClick(event, row.id)} role="checkbox" aria-checked={isItemSelected} tabIndex={-1} key={row.id} selected={isItemSelected} sx={{ cursor: 'pointer' }} > {row.name} {row.calories} {row.fat} {row.carbs} {row.protein} ); })} {emptyRows > 0 && ( )}
} label="Dense padding" />
); } ``` ## Customization Here is an example of customizing the component. You can learn more about this in the [overrides documentation page](/material-ui/customization/how-to-customize/). ```tsx import { styled } from '@mui/material/styles'; import Table from '@mui/material/Table'; import TableBody from '@mui/material/TableBody'; import TableCell, { tableCellClasses } from '@mui/material/TableCell'; import TableContainer from '@mui/material/TableContainer'; import TableHead from '@mui/material/TableHead'; import TableRow from '@mui/material/TableRow'; import Paper from '@mui/material/Paper'; const StyledTableCell = styled(TableCell)(({ theme }) => ({ [`&.${tableCellClasses.head}`]: { backgroundColor: theme.palette.common.black, color: theme.palette.common.white, }, [`&.${tableCellClasses.body}`]: { fontSize: 14, }, })); const StyledTableRow = styled(TableRow)(({ theme }) => ({ '&:nth-of-type(odd)': { backgroundColor: theme.palette.action.hover, }, // hide last border '&:last-child td, &:last-child th': { border: 0, }, })); function createData( name: string, calories: number, fat: number, carbs: number, protein: number, ) { return { name, calories, fat, carbs, protein }; } const rows = [ createData('Frozen yoghurt', 159, 6.0, 24, 4.0), createData('Ice cream sandwich', 237, 9.0, 37, 4.3), createData('Eclair', 262, 16.0, 24, 6.0), createData('Cupcake', 305, 3.7, 67, 4.3), createData('Gingerbread', 356, 16.0, 49, 3.9), ]; export default function CustomizedTables() { return ( Dessert (100g serving) Calories Fat (g) Carbs (g) Protein (g) {rows.map((row) => ( {row.name} {row.calories} {row.fat} {row.carbs} {row.protein} ))}
); } ``` ### Custom pagination options It's possible to customize the options shown in the "Rows per page" select using the `rowsPerPageOptions` prop. You should either provide an array of: - **numbers**, each number will be used for the option's label and value. ```jsx ``` - **objects**, the `value` and `label` keys will be used respectively for the value and label of the option (useful for language strings such as 'All'). ```jsx ``` ### Custom pagination actions The `ActionsComponent` prop of the `TablePagination` component allows the implementation of custom actions. ```tsx import * as React from 'react'; import { useTheme } from '@mui/material/styles'; import Box from '@mui/material/Box'; import Table from '@mui/material/Table'; import TableBody from '@mui/material/TableBody'; import TableCell from '@mui/material/TableCell'; import TableContainer from '@mui/material/TableContainer'; import TableFooter from '@mui/material/TableFooter'; import TablePagination from '@mui/material/TablePagination'; import TableRow from '@mui/material/TableRow'; import Paper from '@mui/material/Paper'; import IconButton from '@mui/material/IconButton'; import FirstPageIcon from '@mui/icons-material/FirstPage'; import KeyboardArrowLeft from '@mui/icons-material/KeyboardArrowLeft'; import KeyboardArrowRight from '@mui/icons-material/KeyboardArrowRight'; import LastPageIcon from '@mui/icons-material/LastPage'; interface TablePaginationActionsProps { count: number; page: number; rowsPerPage: number; onPageChange: ( event: React.MouseEvent, newPage: number, ) => void; } function TablePaginationActions(props: TablePaginationActionsProps) { const theme = useTheme(); const { count, page, rowsPerPage, onPageChange } = props; const handleFirstPageButtonClick = ( event: React.MouseEvent, ) => { onPageChange(event, 0); }; const handleBackButtonClick = (event: React.MouseEvent) => { onPageChange(event, page - 1); }; const handleNextButtonClick = (event: React.MouseEvent) => { onPageChange(event, page + 1); }; const handleLastPageButtonClick = (event: React.MouseEvent) => { onPageChange(event, Math.max(0, Math.ceil(count / rowsPerPage) - 1)); }; return ( {theme.direction === 'rtl' ? : } {theme.direction === 'rtl' ? : } = Math.ceil(count / rowsPerPage) - 1} aria-label="next page" > {theme.direction === 'rtl' ? : } = Math.ceil(count / rowsPerPage) - 1} aria-label="last page" > {theme.direction === 'rtl' ? : } ); } function createData(name: string, calories: number, fat: number) { return { name, calories, fat }; } const rows = [ createData('Cupcake', 305, 3.7), createData('Donut', 452, 25.0), createData('Eclair', 262, 16.0), createData('Frozen yoghurt', 159, 6.0), createData('Gingerbread', 356, 16.0), createData('Honeycomb', 408, 3.2), createData('Ice cream sandwich', 237, 9.0), createData('Jelly Bean', 375, 0.0), createData('KitKat', 518, 26.0), createData('Lollipop', 392, 0.2), createData('Marshmallow', 318, 0), createData('Nougat', 360, 19.0), createData('Oreo', 437, 18.0), ].sort((a, b) => (a.calories < b.calories ? -1 : 1)); export default function CustomPaginationActionsTable() { const [page, setPage] = React.useState(0); const [rowsPerPage, setRowsPerPage] = React.useState(5); // Avoid a layout jump when reaching the last page with empty rows. const emptyRows = page > 0 ? Math.max(0, (1 + page) * rowsPerPage - rows.length) : 0; const handleChangePage = ( event: React.MouseEvent | null, newPage: number, ) => { setPage(newPage); }; const handleChangeRowsPerPage = ( event: React.ChangeEvent, ) => { setRowsPerPage(parseInt(event.target.value, 10)); setPage(0); }; return ( {(rowsPerPage > 0 ? rows.slice(page * rowsPerPage, page * rowsPerPage + rowsPerPage) : rows ).map((row) => ( {row.name} {row.calories} {row.fat} ))} {emptyRows > 0 && ( )}
); } ``` ## Sticky header Here is an example of a table with scrollable rows and fixed column headers. It leverages the `stickyHeader` prop. ```tsx import * as React from 'react'; import Paper from '@mui/material/Paper'; import Table from '@mui/material/Table'; import TableBody from '@mui/material/TableBody'; import TableCell from '@mui/material/TableCell'; import TableContainer from '@mui/material/TableContainer'; import TableHead from '@mui/material/TableHead'; import TablePagination from '@mui/material/TablePagination'; import TableRow from '@mui/material/TableRow'; interface Column { id: 'name' | 'code' | 'population' | 'size' | 'density'; label: string; minWidth?: number; align?: 'right'; format?: (value: number) => string; } const columns: readonly Column[] = [ { id: 'name', label: 'Name', minWidth: 170 }, { id: 'code', label: 'ISO\u00a0Code', minWidth: 100 }, { id: 'population', label: 'Population', minWidth: 170, align: 'right', format: (value: number) => value.toLocaleString('en-US'), }, { id: 'size', label: 'Size\u00a0(km\u00b2)', minWidth: 170, align: 'right', format: (value: number) => value.toLocaleString('en-US'), }, { id: 'density', label: 'Density', minWidth: 170, align: 'right', format: (value: number) => value.toFixed(2), }, ]; interface Data { name: string; code: string; population: number; size: number; density: number; } function createData( name: string, code: string, population: number, size: number, ): Data { const density = population / size; return { name, code, population, size, density }; } const rows = [ createData('India', 'IN', 1324171354, 3287263), createData('China', 'CN', 1403500365, 9596961), createData('Italy', 'IT', 60483973, 301340), createData('United States', 'US', 327167434, 9833520), createData('Canada', 'CA', 37602103, 9984670), createData('Australia', 'AU', 25475400, 7692024), createData('Germany', 'DE', 83019200, 357578), createData('Ireland', 'IE', 4857000, 70273), createData('Mexico', 'MX', 126577691, 1972550), createData('Japan', 'JP', 126317000, 377973), createData('France', 'FR', 67022000, 640679), createData('United Kingdom', 'GB', 67545757, 242495), createData('Russia', 'RU', 146793744, 17098246), createData('Nigeria', 'NG', 200962417, 923768), createData('Brazil', 'BR', 210147125, 8515767), ]; export default function StickyHeadTable() { const [page, setPage] = React.useState(0); const [rowsPerPage, setRowsPerPage] = React.useState(10); const handleChangePage = (event: unknown, newPage: number) => { setPage(newPage); }; const handleChangeRowsPerPage = (event: React.ChangeEvent) => { setRowsPerPage(+event.target.value); setPage(0); }; return ( {columns.map((column) => ( {column.label} ))} {rows .slice(page * rowsPerPage, page * rowsPerPage + rowsPerPage) .map((row) => { return ( {columns.map((column) => { const value = row[column.id]; return ( {column.format && typeof value === 'number' ? column.format(value) : value} ); })} ); })}
); } ``` ## Column grouping You can group column headers by rendering multiple table rows inside a table head: ```jsx ``` ```tsx import * as React from 'react'; import Paper from '@mui/material/Paper'; import Table from '@mui/material/Table'; import TableBody from '@mui/material/TableBody'; import TableCell from '@mui/material/TableCell'; import TableContainer from '@mui/material/TableContainer'; import TableHead from '@mui/material/TableHead'; import TablePagination from '@mui/material/TablePagination'; import TableRow from '@mui/material/TableRow'; interface Column { id: 'name' | 'code' | 'population' | 'size' | 'density'; label: string; minWidth?: number; align?: 'right'; format?: (value: number) => string; } const columns: Column[] = [ { id: 'name', label: 'Name', minWidth: 170 }, { id: 'code', label: 'ISO\u00a0Code', minWidth: 100 }, { id: 'population', label: 'Population', minWidth: 170, align: 'right', format: (value: number) => value.toLocaleString('en-US'), }, { id: 'size', label: 'Size\u00a0(km\u00b2)', minWidth: 170, align: 'right', format: (value: number) => value.toLocaleString('en-US'), }, { id: 'density', label: 'Density', minWidth: 170, align: 'right', format: (value: number) => value.toFixed(2), }, ]; interface Data { name: string; code: string; population: number; size: number; density: number; } function createData( name: string, code: string, population: number, size: number, ): Data { const density = population / size; return { name, code, population, size, density }; } const rows = [ createData('India', 'IN', 1324171354, 3287263), createData('China', 'CN', 1403500365, 9596961), createData('Italy', 'IT', 60483973, 301340), createData('United States', 'US', 327167434, 9833520), createData('Canada', 'CA', 37602103, 9984670), createData('Australia', 'AU', 25475400, 7692024), createData('Germany', 'DE', 83019200, 357578), createData('Ireland', 'IE', 4857000, 70273), createData('Mexico', 'MX', 126577691, 1972550), createData('Japan', 'JP', 126317000, 377973), createData('France', 'FR', 67022000, 640679), createData('United Kingdom', 'GB', 67545757, 242495), createData('Russia', 'RU', 146793744, 17098246), createData('Nigeria', 'NG', 200962417, 923768), createData('Brazil', 'BR', 210147125, 8515767), ]; export default function ColumnGroupingTable() { const [page, setPage] = React.useState(0); const [rowsPerPage, setRowsPerPage] = React.useState(10); const handleChangePage = (event: unknown, newPage: number) => { setPage(newPage); }; const handleChangeRowsPerPage = (event: React.ChangeEvent) => { setRowsPerPage(+event.target.value); setPage(0); }; return ( Country Details {columns.map((column) => ( {column.label} ))} {rows .slice(page * rowsPerPage, page * rowsPerPage + rowsPerPage) .map((row) => { return ( {columns.map((column) => { const value = row[column.id]; return ( {column.format && typeof value === 'number' ? column.format(value) : value} ); })} ); })}
); } ``` ## Collapsible table An example of a table with expandable rows, revealing more information. It utilizes the [`Collapse`](/material-ui/api/collapse/) component. ```tsx import * as React from 'react'; import Box from '@mui/material/Box'; import Collapse from '@mui/material/Collapse'; import IconButton from '@mui/material/IconButton'; import Table from '@mui/material/Table'; import TableBody from '@mui/material/TableBody'; import TableCell from '@mui/material/TableCell'; import TableContainer from '@mui/material/TableContainer'; import TableHead from '@mui/material/TableHead'; import TableRow from '@mui/material/TableRow'; import Typography from '@mui/material/Typography'; import Paper from '@mui/material/Paper'; import KeyboardArrowDownIcon from '@mui/icons-material/KeyboardArrowDown'; import KeyboardArrowUpIcon from '@mui/icons-material/KeyboardArrowUp'; function createData( name: string, calories: number, fat: number, carbs: number, protein: number, price: number, ) { return { name, calories, fat, carbs, protein, price, history: [ { date: '2020-01-05', customerId: '11091700', amount: 3, }, { date: '2020-01-02', customerId: 'Anonymous', amount: 1, }, ], }; } function Row(props: { row: ReturnType }) { const { row } = props; const [open, setOpen] = React.useState(false); return ( .MuiTableCell-root': { borderBottom: 'unset' } }}> setOpen(!open)} > {open ? : } {row.name} {row.calories} {row.fat} {row.carbs} {row.protein} History Date Customer Amount Total price ($) {row.history.map((historyRow) => ( {historyRow.date} {historyRow.customerId} {historyRow.amount} {Math.round(historyRow.amount * row.price * 100) / 100} ))}
); } const rows = [ createData('Frozen yoghurt', 159, 6.0, 24, 4.0, 3.99), createData('Ice cream sandwich', 237, 9.0, 37, 4.3, 4.99), createData('Eclair', 262, 16.0, 24, 6.0, 3.79), createData('Cupcake', 305, 3.7, 67, 4.3, 2.5), createData('Gingerbread', 356, 16.0, 49, 3.9, 1.5), ]; export default function CollapsibleTable() { return ( Dessert (100g serving) Calories Fat (g) Carbs (g) Protein (g) {rows.map((row) => ( ))}
); } ``` ## Spanning table A simple example with spanning rows & columns. ```tsx import Table from '@mui/material/Table'; import TableBody from '@mui/material/TableBody'; import TableCell from '@mui/material/TableCell'; import TableContainer from '@mui/material/TableContainer'; import TableHead from '@mui/material/TableHead'; import TableRow from '@mui/material/TableRow'; import Paper from '@mui/material/Paper'; const TAX_RATE = 0.07; function ccyFormat(num: number) { return `${num.toFixed(2)}`; } function priceRow(qty: number, unit: number) { return qty * unit; } function createRow(desc: string, qty: number, unit: number) { const price = priceRow(qty, unit); return { desc, qty, unit, price }; } interface Row { desc: string; qty: number; unit: number; price: number; } function subtotal(items: readonly Row[]) { return items.map(({ price }) => price).reduce((sum, i) => sum + i, 0); } const rows = [ createRow('Paperclips (Box)', 100, 1.15), createRow('Paper (Case)', 10, 45.99), createRow('Waste Basket', 2, 17.99), ]; const invoiceSubtotal = subtotal(rows); const invoiceTaxes = TAX_RATE * invoiceSubtotal; const invoiceTotal = invoiceTaxes + invoiceSubtotal; export default function SpanningTable() { return ( Details Price Desc Qty. Unit Sum {rows.map((row) => ( {row.desc} {row.qty} {row.unit} {ccyFormat(row.price)} ))} Subtotal {ccyFormat(invoiceSubtotal)} Tax {`${(TAX_RATE * 100).toFixed(0)} %`} {ccyFormat(invoiceTaxes)} Total {ccyFormat(invoiceTotal)}
); } ``` ## Virtualized table In the following example, we demonstrate how to use [react-virtuoso](https://github.com/petyosi/react-virtuoso) with the `Table` component. It renders 200 rows and can easily handle more. Virtualization helps with performance issues. ```tsx import * as React from 'react'; import Table from '@mui/material/Table'; import TableBody from '@mui/material/TableBody'; import TableCell from '@mui/material/TableCell'; import TableContainer from '@mui/material/TableContainer'; import TableHead from '@mui/material/TableHead'; import TableRow from '@mui/material/TableRow'; import Paper from '@mui/material/Paper'; import { TableVirtuoso, TableComponents } from 'react-virtuoso'; import Chance from 'chance'; interface Data { id: number; firstName: string; lastName: string; age: number; phone: string; state: string; } interface ColumnData { dataKey: keyof Data; label: string; numeric?: boolean; width?: number; } const chance = new Chance(42); function createData(id: number): Data { return { id, firstName: chance.first(), lastName: chance.last(), age: chance.age(), phone: chance.phone(), state: chance.state({ full: true }), }; } const columns: ColumnData[] = [ { width: 100, label: 'First Name', dataKey: 'firstName', }, { width: 100, label: 'Last Name', dataKey: 'lastName', }, { width: 50, label: 'Age', dataKey: 'age', numeric: true, }, { width: 110, label: 'State', dataKey: 'state', }, { width: 130, label: 'Phone Number', dataKey: 'phone', }, ]; const rows: Data[] = Array.from({ length: 200 }, (_, index) => createData(index)); const VirtuosoTableComponents: TableComponents = { Scroller: React.forwardRef((props, ref) => ( )), Table: (props) => ( ), TableHead: React.forwardRef((props, ref) => ( )), TableRow, TableBody: React.forwardRef((props, ref) => ( )), }; function fixedHeaderContent() { return ( {columns.map((column) => ( {column.label} ))} ); } function rowContent(_index: number, row: Data) { return ( {columns.map((column) => ( {row[column.dataKey]} ))} ); } export default function ReactVirtualizedTable() { return ( ); } ``` ## Accessibility (WAI tutorial: ) ### Caption A caption functions like a heading for a table. Most screen readers announce the content of captions. Captions help users to find a table and understand what it's about and decide if they want to read it. ```tsx import Table from '@mui/material/Table'; import TableBody from '@mui/material/TableBody'; import TableCell from '@mui/material/TableCell'; import TableContainer from '@mui/material/TableContainer'; import TableHead from '@mui/material/TableHead'; import TableRow from '@mui/material/TableRow'; import Paper from '@mui/material/Paper'; function createData( name: string, calories: number, fat: number, carbs: number, protein: number, ) { return { name, calories, fat, carbs, protein }; } const rows = [ createData('Frozen yoghurt', 159, 6.0, 24, 4.0), createData('Ice cream sandwich', 237, 9.0, 37, 4.3), createData('Eclair', 262, 16.0, 24, 6.0), ]; export default function AccessibleTable() { return (
Dessert (100g serving) Calories Fat (g) Carbs (g) Protein (g) {rows.map((row) => ( {row.name} {row.calories} {row.fat} {row.carbs} {row.protein} ))}
A basic table example with a caption
); } ``` # Table API ## Demos For examples and details on the usage of this React component, visit the component demo pages: - [Table](https://mui.com/material-ui/react-table/) ## Import ```jsx import Table from '@mui/material/Table'; // or import { Table } from '@mui/material'; ``` ## Props | Name | Type | Default | Required | Description | |------|------|---------|----------|-------------| | children | `node` | - | No | | | classes | `object` | - | No | Override or extend the styles applied to the component. | | component | `elementType` | - | No | | | padding | `'checkbox' \| 'none' \| 'normal'` | `'normal'` | No | | | size | `'medium' \| 'small' \| string` | `'medium'` | No | | | stickyHeader | `bool` | `false` | No | | | sx | `Array \| func \| object` | - | No | The system prop that allows defining system overrides as well as additional CSS styles. | > **Note**: The `ref` is forwarded to the root element (HTMLTableElement). > Any other props supplied will be provided to the root element (native element). ## Theme default props You can use `MuiTable` to change the default props of this component with the theme. ## CSS ### Rule name | Global class | Rule name | Description | |--------------|-----------|-------------| | - | root | Styles applied to the root element. | | - | stickyHeader | Styles applied to the root element if `stickyHeader={true}`. | ## Source code If you did not find the information on this page, consider having a look at the implementation of the component for more detail. - [/packages/mui-material/src/Table/Table.js](https://github.com/mui/material-ui/tree/HEAD/packages/mui-material/src/Table/Table.js) # TableBody API ## Demos For examples and details on the usage of this React component, visit the component demo pages: - [Table](https://mui.com/material-ui/react-table/) ## Import ```jsx import TableBody from '@mui/material/TableBody'; // or import { TableBody } from '@mui/material'; ``` ## Props | Name | Type | Default | Required | Description | |------|------|---------|----------|-------------| | children | `node` | - | No | | | classes | `object` | - | No | Override or extend the styles applied to the component. | | component | `elementType` | - | No | | | sx | `Array \| func \| object` | - | No | The system prop that allows defining system overrides as well as additional CSS styles. | > **Note**: The `ref` is forwarded to the root element (HTMLTableSectionElement). > Any other props supplied will be provided to the root element (native element). ## Theme default props You can use `MuiTableBody` to change the default props of this component with the theme. ## CSS ### Rule name | Global class | Rule name | Description | |--------------|-----------|-------------| | - | root | Styles applied to the root element. | ## Source code If you did not find the information on this page, consider having a look at the implementation of the component for more detail. - [/packages/mui-material/src/TableBody/TableBody.js](https://github.com/mui/material-ui/tree/HEAD/packages/mui-material/src/TableBody/TableBody.js) # TableCell API ## Demos For examples and details on the usage of this React component, visit the component demo pages: - [Table](https://mui.com/material-ui/react-table/) ## Import ```jsx import TableCell from '@mui/material/TableCell'; // or import { TableCell } from '@mui/material'; ``` ## Props | Name | Type | Default | Required | Description | |------|------|---------|----------|-------------| | align | `'center' \| 'inherit' \| 'justify' \| 'left' \| 'right'` | `'inherit'` | No | | | children | `node` | - | No | | | classes | `object` | - | No | Override or extend the styles applied to the component. | | component | `elementType` | - | No | | | padding | `'checkbox' \| 'none' \| 'normal'` | - | No | | | scope | `string` | - | No | | | size | `'medium' \| 'small' \| string` | - | No | | | sortDirection | `'asc' \| 'desc' \| false` | - | No | | | sx | `Array \| func \| object` | - | No | The system prop that allows defining system overrides as well as additional CSS styles. | | variant | `'body' \| 'footer' \| 'head' \| string` | - | No | | > **Note**: The `ref` is forwarded to the root element (HTMLTableCellElement). > Any other props supplied will be provided to the root element (native element). ## Theme default props You can use `MuiTableCell` to change the default props of this component with the theme. ## CSS ### Rule name | Global class | Rule name | Description | |--------------|-----------|-------------| | - | alignCenter | Styles applied to the root element if `align="center"`. | | - | alignJustify | Styles applied to the root element if `align="justify"`. | | - | alignLeft | Styles applied to the root element if `align="left"`. | | - | alignRight | Styles applied to the root element if `align="right"`. | | - | body | Styles applied to the root element if `variant="body"` or `context.table.body`. | | - | footer | Styles applied to the root element if `variant="footer"` or `context.table.footer`. | | - | head | Styles applied to the root element if `variant="head"` or `context.table.head`. | | - | paddingCheckbox | Styles applied to the root element if `padding="checkbox"`. | | - | paddingNone | Styles applied to the root element if `padding="none"`. | | - | root | Styles applied to the root element. | | - | sizeMedium | Styles applied to the root element if `size="medium"`. | | - | sizeSmall | Styles applied to the root element if `size="small"`. | | - | stickyHeader | Styles applied to the root element if `context.table.stickyHeader={true}`. | ## Source code If you did not find the information on this page, consider having a look at the implementation of the component for more detail. - [/packages/mui-material/src/TableCell/TableCell.js](https://github.com/mui/material-ui/tree/HEAD/packages/mui-material/src/TableCell/TableCell.js) # TableContainer API ## Demos For examples and details on the usage of this React component, visit the component demo pages: - [Table](https://mui.com/material-ui/react-table/) ## Import ```jsx import TableContainer from '@mui/material/TableContainer'; // or import { TableContainer } from '@mui/material'; ``` ## Props | Name | Type | Default | Required | Description | |------|------|---------|----------|-------------| | children | `node` | - | No | | | classes | `object` | - | No | Override or extend the styles applied to the component. | | component | `elementType` | - | No | | | sx | `Array \| func \| object` | - | No | The system prop that allows defining system overrides as well as additional CSS styles. | > **Note**: The `ref` is forwarded to the root element (HTMLDivElement). > Any other props supplied will be provided to the root element (native element). ## Theme default props You can use `MuiTableContainer` to change the default props of this component with the theme. ## CSS ### Rule name | Global class | Rule name | Description | |--------------|-----------|-------------| | - | root | Styles applied to the root element. | ## Source code If you did not find the information on this page, consider having a look at the implementation of the component for more detail. - [/packages/mui-material/src/TableContainer/TableContainer.js](https://github.com/mui/material-ui/tree/HEAD/packages/mui-material/src/TableContainer/TableContainer.js) # TableFooter API ## Demos For examples and details on the usage of this React component, visit the component demo pages: - [Table](https://mui.com/material-ui/react-table/) ## Import ```jsx import TableFooter from '@mui/material/TableFooter'; // or import { TableFooter } from '@mui/material'; ``` ## Props | Name | Type | Default | Required | Description | |------|------|---------|----------|-------------| | children | `node` | - | No | | | classes | `object` | - | No | Override or extend the styles applied to the component. | | component | `elementType` | - | No | | | sx | `Array \| func \| object` | - | No | The system prop that allows defining system overrides as well as additional CSS styles. | > **Note**: The `ref` is forwarded to the root element (HTMLTableSectionElement). > Any other props supplied will be provided to the root element (native element). ## Theme default props You can use `MuiTableFooter` to change the default props of this component with the theme. ## CSS ### Rule name | Global class | Rule name | Description | |--------------|-----------|-------------| | - | root | Styles applied to the root element. | ## Source code If you did not find the information on this page, consider having a look at the implementation of the component for more detail. - [/packages/mui-material/src/TableFooter/TableFooter.js](https://github.com/mui/material-ui/tree/HEAD/packages/mui-material/src/TableFooter/TableFooter.js) # TableHead API ## Demos For examples and details on the usage of this React component, visit the component demo pages: - [Table](https://mui.com/material-ui/react-table/) ## Import ```jsx import TableHead from '@mui/material/TableHead'; // or import { TableHead } from '@mui/material'; ``` ## Props | Name | Type | Default | Required | Description | |------|------|---------|----------|-------------| | children | `node` | - | No | | | classes | `object` | - | No | Override or extend the styles applied to the component. | | component | `elementType` | - | No | | | sx | `Array \| func \| object` | - | No | The system prop that allows defining system overrides as well as additional CSS styles. | > **Note**: The `ref` is forwarded to the root element (HTMLTableSectionElement). > Any other props supplied will be provided to the root element (native element). ## Theme default props You can use `MuiTableHead` to change the default props of this component with the theme. ## CSS ### Rule name | Global class | Rule name | Description | |--------------|-----------|-------------| | - | root | Styles applied to the root element. | ## Source code If you did not find the information on this page, consider having a look at the implementation of the component for more detail. - [/packages/mui-material/src/TableHead/TableHead.js](https://github.com/mui/material-ui/tree/HEAD/packages/mui-material/src/TableHead/TableHead.js) # TablePagination API ## Demos For examples and details on the usage of this React component, visit the component demo pages: - [Pagination](https://mui.com/material-ui/react-pagination/) - [Table](https://mui.com/material-ui/react-table/) ## Import ```jsx import TablePagination from '@mui/material/TablePagination'; // or import { TablePagination } from '@mui/material'; ``` ## Props | Name | Type | Default | Required | Description | |------|------|---------|----------|-------------| | count | `integer` | - | Yes | | | onPageChange | `function(event: React.MouseEvent \| null, page: number) => void` | - | Yes | | | page | `integer` | - | Yes | | | rowsPerPage | `integer` | - | Yes | | | ActionsComponent | `elementType` | `TablePaginationActions` | No | | | classes | `object` | - | No | Override or extend the styles applied to the component. | | component | `elementType` | - | No | | | disabled | `bool` | `false` | No | | | getItemAriaLabel | `function(type: string) => string` | `function defaultGetAriaLabel(type) { return `Go to ${type} page`; }` | No | | | labelDisplayedRows | `func` | `function defaultLabelDisplayedRows({ from, to, count }) { return `${formatNumber(from)}–${formatNumber(to)} of ${count !== -1 ? formatNumber(count) : `more than ${formatNumber(to)}`}`; }` | No | | | labelRowsPerPage | `node` | `'Rows per page:'` | No | | | onRowsPerPageChange | `function(event: React.ChangeEvent) => void` | - | No | | | rowsPerPageOptions | `Array` | `[10, 25, 50, 100]` | No | | | showFirstButton | `bool` | `false` | No | | | showLastButton | `bool` | `false` | No | | | slotProps | `{ actions?: { firstButton?: object, firstButtonIcon?: object, lastButton?: object, lastButtonIcon?: object, nextButton?: object, nextButtonIcon?: object, previousButton?: object, previousButtonIcon?: object }, displayedRows?: func \| object, menuItem?: func \| object, root?: func \| object, select?: object, selectLabel?: func \| object, spacer?: func \| object, toolbar?: func \| object }` | `{}` | No | | | slots | `{ actions?: { firstButton?: elementType, firstButtonIcon?: elementType, lastButton?: elementType, lastButtonIcon?: elementType, nextButton?: elementType, nextButtonIcon?: elementType, previousButton?: elementType, previousButtonIcon?: elementType }, displayedRows?: elementType, menuItem?: elementType, root?: elementType, select?: elementType, selectLabel?: elementType, spacer?: elementType, toolbar?: elementType }` | `{}` | No | | | sx | `Array \| func \| object` | - | No | The system prop that allows defining system overrides as well as additional CSS styles. | > **Note**: The `ref` is forwarded to the root element (HTMLTableCellElement). > Any other props supplied will be provided to the root element ([TableCell](https://mui.com/material-ui/api/table-cell/)). ## Inheritance While not explicitly documented above, the props of the [TableCell](https://mui.com/material-ui/api/table-cell/) component are also available on TablePagination. ## Theme default props You can use `MuiTablePagination` to change the default props of this component with the theme. ## Slots | Name | Default | Class | Description | |------|---------|-------|-------------| | root | `TableCell` | `.MuiTablePagination-root` | The component that renders the root slot. [Follow this guide](https://mui.com/material-ui/api/table-cell/#props) to learn more about the requirements for this component. | | toolbar | `Toolbar` | `.MuiTablePagination-toolbar` | The component that renders the toolbar slot. [Follow this guide](https://mui.com/material-ui/api/toolbar/#props) to learn more about the requirements for this component. | | spacer | `'div'` | `.MuiTablePagination-spacer` | The tag that renders the spacer slot. | | selectLabel | `'p'` | `.MuiTablePagination-selectLabel` | The tag that renders the selectLabel slot. | | select | `Select` | `.MuiTablePagination-select` | The component that renders the select slot. [Follow this guide](https://mui.com/material-ui/api/select/#props) to learn more about the requirements for this component. | | menuItem | `MenuItem` | `.MuiTablePagination-menuItem` | The component that renders the select slot. [Follow this guide](https://mui.com/material-ui/api/menu-item/#props) to learn more about the requirements for this component. | | displayedRows | `'p'` | `.MuiTablePagination-displayedRows` | The tag that renders the displayedRows slot. | | actions | `undefined` | `.MuiTablePagination-actions` | The slots that passed to the actions slot. | ## CSS ### Rule name | Global class | Rule name | Description | |--------------|-----------|-------------| | - | input | Styles applied to the Select component `root` element. | | - | selectIcon | Styles applied to the Select component `icon` class. | | - | selectRoot | Styles applied to the Select component `root` element. | ## Source code If you did not find the information on this page, consider having a look at the implementation of the component for more detail. - [/packages/mui-material/src/TablePagination/TablePagination.js](https://github.com/mui/material-ui/tree/HEAD/packages/mui-material/src/TablePagination/TablePagination.js) # TableRow API ## Demos For examples and details on the usage of this React component, visit the component demo pages: - [Table](https://mui.com/material-ui/react-table/) ## Import ```jsx import TableRow from '@mui/material/TableRow'; // or import { TableRow } from '@mui/material'; ``` ## Props | Name | Type | Default | Required | Description | |------|------|---------|----------|-------------| | children | `node` | - | No | | | classes | `object` | - | No | Override or extend the styles applied to the component. | | component | `elementType` | - | No | | | hover | `bool` | `false` | No | | | selected | `bool` | `false` | No | | | sx | `Array \| func \| object` | - | No | The system prop that allows defining system overrides as well as additional CSS styles. | > **Note**: The `ref` is forwarded to the root element (HTMLTableRowElement). > Any other props supplied will be provided to the root element (native element). ## Theme default props You can use `MuiTableRow` to change the default props of this component with the theme. ## CSS ### Rule name | Global class | Rule name | Description | |--------------|-----------|-------------| | - | footer | Styles applied to the root element if table variant="footer". | | - | head | Styles applied to the root element if table variant="head". | | - | hover | State class applied to the root element if `hover={true}`. | | - | root | Styles applied to the root element. | | `.Mui-selected` | - | State class applied to the root element if `selected={true}`. | ## Source code If you did not find the information on this page, consider having a look at the implementation of the component for more detail. - [/packages/mui-material/src/TableRow/TableRow.js](https://github.com/mui/material-ui/tree/HEAD/packages/mui-material/src/TableRow/TableRow.js) # TableSortLabel API ## Demos For examples and details on the usage of this React component, visit the component demo pages: - [Table](https://mui.com/material-ui/react-table/) ## Import ```jsx import TableSortLabel from '@mui/material/TableSortLabel'; // or import { TableSortLabel } from '@mui/material'; ``` ## Props | Name | Type | Default | Required | Description | |------|------|---------|----------|-------------| | active | `bool` | `false` | No | | | children | `node` | - | No | | | classes | `object` | - | No | Override or extend the styles applied to the component. | | direction | `'asc' \| 'desc'` | `'asc'` | No | | | hideSortIcon | `bool` | `false` | No | | | IconComponent | `elementType` | `ArrowDownwardIcon` | No | | | slotProps | `{ icon?: func \| object, root?: func \| object }` | `{}` | No | | | slots | `{ icon?: elementType, root?: elementType }` | `{}` | No | | | sx | `Array \| func \| object` | - | No | The system prop that allows defining system overrides as well as additional CSS styles. | > **Note**: The `ref` is forwarded to the root element (HTMLSpanElement). > Any other props supplied will be provided to the root element ([ButtonBase](https://mui.com/material-ui/api/button-base/)). ## Inheritance While not explicitly documented above, the props of the [ButtonBase](https://mui.com/material-ui/api/button-base/) component are also available on TableSortLabel. ## Theme default props You can use `MuiTableSortLabel` to change the default props of this component with the theme. ## Slots | Name | Default | Class | Description | |------|---------|-------|-------------| | root | `span` | `.MuiTableSortLabel-root` | The component that renders the root slot. | | icon | `ArrowDownwardIcon` | `.MuiTableSortLabel-icon` | The component that renders the icon slot. | ## CSS ### Rule name | Global class | Rule name | Description | |--------------|-----------|-------------| | `.Mui-active` | - | State class applied to the root element if `active={true}`. | | - | directionAsc | Styles applied to the root element if `direction="asc"`. | | - | directionDesc | Styles applied to the root element if `direction="desc"`. | ## Source code If you did not find the information on this page, consider having a look at the implementation of the component for more detail. - [/packages/mui-material/src/TableSortLabel/TableSortLabel.js](https://github.com/mui/material-ui/tree/HEAD/packages/mui-material/src/TableSortLabel/TableSortLabel.js)