Table API

API reference docs for the React Table component. Learn about the props, CSS, and other APIs of this exported module.

Demos

For examples and details on the usage of this React component, visit the component demo pages:

Table

Import

import Table from '@mui/joy/Table';
// or
import { Table } from '@mui/joy';

Learn about the difference by reading this guide on minimizing bundle size.

Props

Name	Type	Default	Description
borderAxis	'both' \| 'bothBetween' \| 'none' \| 'x' \| 'xBetween' \| 'y' \| 'yBetween' \| string	'xBetween'	The axis to display a border on the table cell.
children	node	-	Children of the table
color	'danger' \| 'neutral' \| 'primary' \| 'success' \| 'warning' \| string	'neutral'	The color of the component. It supports those theme colors that make sense for this component. To learn how to add your own colors, check out Themed components—Extend colors.
component	elementType	-	The component used for the root node. Either a string to use a HTML element or a component.
hoverRow	bool	false	If `true`, the table row will shade on hover.
noWrap	bool	false	If `true`, the body cells will not wrap, but instead will truncate with a text overflow ellipsis. Note: Header cells are always truncated with overflow ellipsis.
size	'sm' \| 'md' \| 'lg' \| string	'md'	The size of the component. It accepts theme values between 'sm' and 'lg'. To learn how to add custom sizes to the component, check out Themed components—Extend sizes.
slotProps	{ root?: func \| object }	{}	The props used for each slot inside.
slots	{ root?: elementType }	{}	The components used for each slot inside. See Slots API below for more details.
stickyFooter	bool	false	If `true`, the footer always appear at the bottom of the overflow table. ⚠️ It doesn't work with IE11.
stickyHeader	bool	false	If `true`, the header always appear at the top of the overflow table. ⚠️ It doesn't work with IE11.
stripe	'odd' \| 'even' \| string	-	The odd or even row of the table body will have subtle background color.
sx	Array<func \| object \| bool> \| func \| object	-	The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.
variant	'outlined' \| 'plain' \| 'soft' \| 'solid' \| string	'plain'	The global variant to use. To learn how to add your own variants, check out Themed components—Extend variants.

The ref is forwarded to the root element.

Theme default props

You can use JoyTable to change the default props of this component with the theme.

Slots

To learn how to customize the slot, check out the Overriding component structure guide.

Slot name	Class name	Default component	Description
root	.MuiTable-root	`'table'`	The component that renders the root.

CSS classes

These class names are useful for styling with CSS. They are applied to the component's slots when specific states are triggered.

Class name	Rule name	Description
.MuiTable-borderAxisBoth	borderAxisBoth	Class name applied to the root element if `borderAxis="both"`.
.MuiTable-borderAxisBothBetween	borderAxisBothBetween	Class name applied to the root element if `borderAxis="bothBetween"`.
.MuiTable-borderAxisNone	borderAxisNone	Class name applied to the root element if `borderAxis="none"`.
.MuiTable-borderAxisX	borderAxisX	Class name applied to the root element if `borderAxis="x"`.
.MuiTable-borderAxisXBetween	borderAxisXBetween	Class name applied to the root element if `borderAxis="xBetween"`.
.MuiTable-borderAxisY	borderAxisY	Class name applied to the root element if `borderAxis="y"`.
.MuiTable-borderAxisYBetween	borderAxisYBetween	Class name applied to the root element if `borderAxis="yBetween"`.
.MuiTable-colorContext	colorContext	Class name applied to the root element when color inversion is triggered.
.MuiTable-colorDanger	colorDanger	Class name applied to the root element if `color="danger"`.
.MuiTable-colorNeutral	colorNeutral	Class name applied to the root element if `color="neutral"`.
.MuiTable-colorPrimary	colorPrimary	Class name applied to the root element if `color="primary"`.
.MuiTable-colorSuccess	colorSuccess	Class name applied to the root element if `color="success"`.
.MuiTable-colorWarning	colorWarning	Class name applied to the root element if `color="warning"`.
.MuiTable-hoverRow	hoverRow	Class name applied to the root element if `hoverRow` is true.
.MuiTable-noWrap	noWrap	Class name applied to the root element if `noWrap` is true.
.MuiTable-sizeLg	sizeLg	Class name applied to the root element if `size="lg"`.
.MuiTable-sizeMd	sizeMd	Class name applied to the root element if `size="md"`.
.MuiTable-sizeSm	sizeSm	Class name applied to the root element if `size="sm"`.
.MuiTable-stickyFooter	stickyFooter	Class name applied to the root element if `stickyFooter` is true.
.MuiTable-stickyHeader	stickyHeader	Class name applied to the root element if `stickyHeader` is true.
.MuiTable-variantOutlined	variantOutlined	Class name applied to the root element if `variant="outlined"`.
.MuiTable-variantPlain	variantPlain	Class name applied to the root element if `variant="plain"`.
.MuiTable-variantSoft	variantSoft	Class name applied to the root element if `variant="soft"`.
.MuiTable-variantSolid	variantSolid	Class name applied to the root element if `variant="solid"`.

You can override the style of the component using one of these customization options:

With a global class name.
With a rule name as part of the component's styleOverrides property in a custom theme.