TableCell API
The API documentation of the TableCell React component. Learn more about the props and the CSS customization points.
Import
import TableCell from '@material-ui/core/TableCell';
// or
import { TableCell } from '@material-ui/core';
You can learn more about the difference by reading this guide.
The component renders a <th>
element when the parent context is a header
or otherwise a <td>
element.
Component name
The MuiTableCell
name can be used for providing default props or style overrides at the theme level.
Props
Name | Type | Default | Description |
---|---|---|---|
align | 'center' | 'inherit' | 'justify' | 'left' | 'right' |
'inherit' | Set the text-align on the table cell content. Monetary or generally number fields should be right aligned as that allows you to add them up quickly in your head without having to worry about decimals. |
children | node | The table cell contents. | |
classes | object | Override or extend the styles applied to the component. See CSS API below for more details. | |
component | elementType | The component used for the root node. Either a string to use a HTML element or a component. | |
padding | 'checkbox' | 'default' | 'none' |
Sets the padding applied to the cell. The prop defaults to the value ('default' ) inherited from the parent Table component. |
|
scope | string | Set scope attribute. | |
size | 'medium' | 'small' |
Specify the size of the cell. The prop defaults to the value ('medium' ) inherited from the parent Table component. |
|
sortDirection | 'asc' | 'desc' | false |
Set aria-sort direction. | |
variant | 'body' | 'footer' | 'head' |
Specify the cell type. The prop defaults to the value inherited from the parent TableHead, TableBody, or TableFooter components. |
The ref
is forwarded to the root element.
Any other props supplied will be provided to the root element (native element).
CSS
Rule name | Global class | Description |
---|---|---|
root | .MuiTableCell-root | Styles applied to the root element. |
head | .MuiTableCell-head | Styles applied to the root element if variant="head" or context.table.head . |
body | .MuiTableCell-body | Styles applied to the root element if variant="body" or context.table.body . |
footer | .MuiTableCell-footer | Styles applied to the root element if variant="footer" or context.table.footer . |
sizeSmall | .MuiTableCell-sizeSmall | Styles applied to the root element if size="small" . |
paddingCheckbox | .MuiTableCell-paddingCheckbox | Styles applied to the root element if padding="checkbox" . |
paddingNone | .MuiTableCell-paddingNone | Styles applied to the root element if padding="none" . |
alignLeft | .MuiTableCell-alignLeft | Styles applied to the root element if align="left" . |
alignCenter | .MuiTableCell-alignCenter | Styles applied to the root element if align="center" . |
alignRight | .MuiTableCell-alignRight | Styles applied to the root element if align="right" . |
alignJustify | .MuiTableCell-alignJustify | Styles applied to the root element if align="justify" . |
stickyHeader | .MuiTableCell-stickyHeader | Styles applied to the root element if context.table.stickyHeader={true} . |
You can override the style of the component thanks to one of these customization points:
- With a rule name of the
classes
object prop. - With a global class name.
- With a theme and an
overrides
property.
If that's not sufficient, you can check the implementation of the component for more detail.