Skip to content

Table API

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

Demos

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

NameTypeDefaultDescription
borderAxis'both'
| 'bothBetween'
| 'none'
| 'x'
| 'xBetween'
| 'y'
| 'yBetween'
| string
'xBetween'

The axis to display a border on the table cell.

childrennode-

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.

componentelementType-

The component used for the root node. Either a string to use a HTML element or a component.

hoverRowboolfalse

If true, the table row will shade on hover.

noWrapboolfalse

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.

stickyFooterboolfalse

If true, the footer always appear at the bottom of the overflow table.

stickyHeaderboolfalse

If true, the header always appear at the top of the overflow table.

stripe'odd'
| 'even'
| string
-

The odd or even row of the table body will have subtle background color.

sxArray<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 nameClass nameDefault componentDescription
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 nameRule nameDescription
.MuiTable-borderAxisBothborderAxisBothClass name applied to the root element if borderAxis="both".
.MuiTable-borderAxisBothBetweenborderAxisBothBetweenClass name applied to the root element if borderAxis="bothBetween".
.MuiTable-borderAxisNoneborderAxisNoneClass name applied to the root element if borderAxis="none".
.MuiTable-borderAxisXborderAxisXClass name applied to the root element if borderAxis="x".
.MuiTable-borderAxisXBetweenborderAxisXBetweenClass name applied to the root element if borderAxis="xBetween".
.MuiTable-borderAxisYborderAxisYClass name applied to the root element if borderAxis="y".
.MuiTable-borderAxisYBetweenborderAxisYBetweenClass name applied to the root element if borderAxis="yBetween".
.MuiTable-colorContextcolorContextClass name applied to the root element when color inversion is triggered.
.MuiTable-colorDangercolorDangerClass name applied to the root element if color="danger".
.MuiTable-colorNeutralcolorNeutralClass name applied to the root element if color="neutral".
.MuiTable-colorPrimarycolorPrimaryClass name applied to the root element if color="primary".
.MuiTable-colorSuccesscolorSuccessClass name applied to the root element if color="success".
.MuiTable-colorWarningcolorWarningClass name applied to the root element if color="warning".
.MuiTable-hoverRowhoverRowClass name applied to the root element if hoverRow is true.
.MuiTable-noWrapnoWrapClass name applied to the root element if noWrap is true.
.MuiTable-sizeLgsizeLgClass name applied to the root element if size="lg".
.MuiTable-sizeMdsizeMdClass name applied to the root element if size="md".
.MuiTable-sizeSmsizeSmClass name applied to the root element if size="sm".
.MuiTable-stickyFooterstickyFooterClass name applied to the root element if stickyFooter is true.
.MuiTable-stickyHeaderstickyHeaderClass name applied to the root element if stickyHeader is true.
.MuiTable-variantOutlinedvariantOutlinedClass name applied to the root element if variant="outlined".
.MuiTable-variantPlainvariantPlainClass name applied to the root element if variant="plain".
.MuiTable-variantSoftvariantSoftClass name applied to the root element if variant="soft".
.MuiTable-variantSolidvariantSolidClass name applied to the root element if variant="solid".

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